Oracle® Secure Enterprise Search Administration API Guide 11g Release 2 (11.2.2) Part Number E23428-01 |
|
|
PDF · Mobi · ePub |
A document service manager identifies the parameters for one or more document service instances.
Object Type
Creatable
Object Key
jarFilePath managerClassName
Object Key Command Syntax
--JAR_FILE=jarfile_name --MANAGER_CLASS=class
State Properties
None
Supported Operations
export exportAll exportList getAllObjectKeys
Administration GUI Page
Global Settings - Document Services - Service Managers
XML Description
The <search:docServiceManagers>
element describes all document service managers:
<search:docServiceManagers> <search:docServiceManager> <search:managerClassName> <search:jarFilePath> <search:name> <search:description> <search:parameterInfos> <search:parameterInfo> <search:defaultValue> <search:encrypted> <search:description>
Element Descriptions
Describes all document service managers. It contains one or more <search:docServiceManager>
elements, each defining a document service manager.
Describes a document service manager. It contains these elements:
<search:managerClassName> <search:jarFilePath> <search:name> <search:description> <search:parameterInfo>
Contains the class name of the manager plug-in.
Contains the qualified name of the jar file. Paths can be absolute or relative path to the ORACLE_HOME/search/lib/plugins/doc directory.
Contains the name of the document service manager. (Read only)
Contains a description of the object. (Read only)
Contains one or more <search:parameterInfo>
elements, each describing a parameter of the document service manager. (Read only)
Describes a parameter. (Read only)
This element contains these child elements:
<search:defaultValue> <search:encrypted> <search:description>
Attribute | Value |
---|---|
name |
Name of the parameter. (Read only) |
Contains the default value of the parameter. (Read only)
Indicates whether the parameter represents a value that should be encrypted. (Read only)
Example
This XML document describes the Image Document Service Manager.
<?xml version="1.0" encoding="UTF-8"?> <search:config productVersion="11.2.1.0.0" xmlns:search="http://xmlns.oracle.com/search"> <search:docServiceManager> <search:managerClassName> oracle.search.plugin.doc.ordim.ImageDocumentServiceManager </search:managerClassName> <search:jarFilePath>ordim/ordimses.jar</search:jarFilePath> <search:name>ImageDocumentService</search:name> <search:description> document service that processes JPEG, GIF, TIFF, JPEG 2000 andDICOM image metadata for search </search:description> <search:parameterInfos> <search:parameterInfo name="attributes configuration file"> <search:defaultValue>attr-config.xml</search:defaultValue> <search:encrypted>false</search:encrypted> <search:description> name of the configuration file that defined search attributes for image documents. The file must exist at search/lib/plugins/doc/ordim/config. </search:description> </search:parameterInfo> </search:parameterInfos> </search:docServiceManager> </search:docServiceManagers> </search:config>