Skip navigation links

oracle.search.sdk.crawler
Interface DocumentServiceManager

public interface DocumentServiceManager

Field Summary

static int	ALWAYS_INVOKE
static int	INVOKE_WHEN_NO_ERROR
static int	INVOKE_WHEN_NON_FATAL
static String	VERSION

Method Summary

void	cleanup() Cleans up plug-in manager.
String	getBaseAPIVersion() Gets the version string of the plug-in API.
DocumentService	getDocumentServicePlugin()
int	getInvokeConditionWhenException() Gets the condition code that controls whether the crawler invokes this service after another plug-in throws an exception.
String	getPluginDescription() Gets the description of the plug-in.
String	getPluginName() Gets the name of the document service plug-in.
List	getPluginParameters() Gets the parameters of the plug-in.
String	getPluginVersion() Gets the version string of the plug-in.
void	init(ParameterValues params, int threadCount, Logger log) Initializes the plug-in manager.
boolean	isOnlyInvoke4IndexDoc() Only invokes this plug-in when the document is to be indexed.
void	setLocale(Locale locale) Set the locale to be used for this plug-in manager and all the plug-ins created by it.

Field Detail

VERSION

static final String VERSION

See Also:

Constant Field Values

ALWAYS_INVOKE

static final int ALWAYS_INVOKE

See Also:

Constant Field Values

INVOKE_WHEN_NON_FATAL

static final int INVOKE_WHEN_NON_FATAL

See Also:

Constant Field Values

INVOKE_WHEN_NO_ERROR

static final int INVOKE_WHEN_NO_ERROR

See Also:

Constant Field Values

Method Detail

cleanup

void cleanup()
             throws DocumentServiceException

Cleans up plug-in manager.

Throws:

DocumentServiceException

getBaseAPIVersion

String getBaseAPIVersion()

Gets the version string of the plug-in API.

getDocumentServicePlugin

DocumentService getDocumentServicePlugin()

getInvokeConditionWhenException

int getInvokeConditionWhenException()

Gets the condition code that controls whether the crawler invokes this service after another plug-in throws an exception.

Returns:

The INVOKE condition code:

• ALWAYS_INVOKE: invokes this plug-in regardless of any error
• INVOKE_WHEN_NON_FATAL: invokes it when there is no fatal error
• INVOKE_WHEN_NO_ERROR: invokes it when there is no severe or fatal error

isOnlyInvoke4IndexDoc

boolean isOnlyInvoke4IndexDoc()

Only invokes this plug-in when the document is to be indexed.

Returns:

true if yes, false if not

getPluginDescription

String getPluginDescription()

Gets the description of the plug-in.

Returns:

The description of the plug-in.

getPluginName

String getPluginName()

Gets the name of the document service plug-in.

Returns:

The name of the document service.

getPluginParameters

List getPluginParameters()

Gets the parameters of the plug-in.

Returns:

The list of oracle.search.sdk.crawler.ParameterInfo objects.

getPluginVersion

String getPluginVersion()

Gets the version string of the plug-in.

Returns:

The version of the plug-in

init

void init(ParameterValues params,
          int threadCount,
          Logger log)
          throws DocumentServiceException

Initializes the plug-in manager.

Parameters:

params - - the parameters

threadCount - - number of plug-in instances required

log - - the logger to the crawler log

Throws:

DocumentServiceException - if unable to initialize the plug-in

setLocale

void setLocale(Locale locale)

Set the locale to be used for this plug-in manager and all the plug-ins created by it.

Parameters:

locale - the locale

Skip navigation links