Oracle® Secure Enterprise Search Administration API Guide 11g Release 1 (11.1.2.2) Part Number E21606-01 |
|
|
PDF · Mobi · ePub |
A source type identifies where the information for a source is stored, such as on a Web site or in a database table. Oracle SES provides several built-in source types.
Creatable
name
--NAME=object_name -n object_name
None
create createAll delete deleteAll deleteList export exportAll exportList getAllObjectKeys update updateAll
Global Settings - Source Types - Create or Update Source Type
The <search:sourceTypes>
element describes the source types:
<search:sourceTypes> <search:sourceType> <search:name> <search:managerClassName> <search:jarFilePath> <search:description> <search:securityCapability> <search:parameterInfos> <search:parameterInfo> <search: defaultValue> <search:encrypted> <search:description>
Element Descriptions
Describes all source types. It contains one or more <search:sourceType>
elements, each defining a source type.
Describes a source type. It contains these elements:
<search:name> <search:managerClassName> <search:jarFilePath> <search:description> <search:securityCapability> <search:parameterInfos>
Contains the name of the source type.
Contains the name of the plug-in manager Java class.
Contains the qualified name of the jar file. Paths can be absolute or relative to the ORACLE_HOME/search/lib/plugins directory.
Contains a description of the source type.
Contains one of these values from the plug-in: IDENTITY_BASED
, USER_DEFINED
, or UNKNOWN
. (Read only)
Contains one or more <search:parameterInfo>
elements, each describing a parameter of the source type.
Describes a parameter. It contains these elements:
<search:defaultValue> <search:encrypted> <search:description>
Attribute | Value |
---|---|
Name |
Name of the parameter. (Required) |
Default value of the parameter.
Indicates whether the parameter represents a value that should be encrypted. Set to true
to encrypt the value, or set to false
otherwise. The default value is false
. (Optional)
This XML document describes the Oracle Content Database
source type:
<?xml version="1.0" encoding="UTF-8"?> <search:config productVersion="11.1.2.2.0" xmlns:search="http://xmlns.oracle.com/search"> <search:sourceTypes> <search:sourceType> <search:name>Oracle Content Database</search:name> <search:managerClassName> oracle.search.plugin.ocs.cservices.OCSCSPluginMgr </search:managerClassName> <search:jarFilePath>cservices/ocscsrvV2.jar</search:jarFilePath> <search:description> Oracle Content Database crawler plug-in </search:description> <search:securityCapability>USER_DEFINED</search:securityCapability> <search:parameterInfos> <search:parameterInfo name="CDB Server public key alias"> <search:encrypted>false</search:encrypted> <search:description> Oracle Content Database Server public key alias </search:description> </search:parameterInfo> <search:parameterInfo name="Crawl only"> <search:defaultValue>false</search:defaultValue> <search:encrypted>false</search:encrypted> <search:description> True will perform a crawl without indexing the documents </search:description> </search:parameterInfo> <search:parameterInfo name="Depth"> <search:defaultValue>-1</search:defaultValue> <search:encrypted>false</search:encrypted> <search:description> Depth from starting paths ("-1" for no limit) </search:description> </search:parameterInfo> <search:parameterInfo name="Entity name"> <search:encrypted>false</search:encrypted> <search:description> Name of the trusted entity in Oracle Internet Directory (OID) </search:description> </search:parameterInfo> <search:parameterInfo name="Entity password"> <search:encrypted>true</search:encrypted> <search:description> Password of the trusted entity in OID </search:description> </search:parameterInfo> <search:parameterInfo name="Oracle Content Database URL"> <search:encrypted>false</search:encrypted> <search:description>Oracle Content Database Web services endpoint; for example, "http://contentserver:7777/content"</search:description> </search:parameterInfo> <search:parameterInfo name="Oracle Content Database Version"> <search:defaultValue>10.1.2.3.0</search:defaultValue> <search:encrypted>false</search:encrypted> <search:description>Oracle Content Database version; for example, "10.1.2.3.0"</search:description> </search:parameterInfo> <search:parameterInfo name="Oracle Content Database admin user"> <search:encrypted>false</search:encrypted> <search:description>Name of administrator user for Oracle Content Database; for example, orcladmin</search:description> </search:parameterInfo> <search:parameterInfo name="SES keystore location"> <search:encrypted>false</search:encrypted> <search:description> SES keystore location for WS security </search:description> </search:parameterInfo> <search:parameterInfo name="SES keystore password"> <search:encrypted>true</search:encrypted> <search:description>SES keystore password</search:description> </search:parameterInfo> <search:parameterInfo name="SES keystore type"> <search:encrypted>false</search:encrypted> <search:description>SES keystore type</search:description> </search:parameterInfo> <search:parameterInfo name="SES private key alias"> <search:encrypted>false</search:encrypted> <search:description> SES client private key alias </search:description> </search:parameterInfo> <search:parameterInfo name="SES private key password"> <search:encrypted>true</search:encrypted> <search:description> SES client private key password </search:description> </search:parameterInfo> <search:parameterInfo name="Starting paths"> <search:defaultValue>/</search:defaultValue> <search:encrypted>false</search:encrypted> <search:description> Paths (not encoded) to start crawling (separated by ";" ) </search:description> </search:parameterInfo> <search:parameterInfo name="Use e-mail for authorization"> <search:defaultValue>false</search:defaultValue> <search:encrypted>false</search:encrypted> <search:description>Use e-mail to resolve the user privilege. Set this to true if the Oracle Internet Directory has been configured to use "mail" as the nickname attribute.</search:description> </search:parameterInfo> </search:parameterInfos> </search:sourceType> </search:sourceTypes> </search:config>