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() plug-in manager cleanup
String	getBaseAPIVersion() Get the version string of the plug-in API - this method should always return DocumentServiceManager.VERSION
DocumentService	getDocumentServicePlugin() provide a DocumentService instance
int	getInvokeConditionWhenException() Inform the crawler on whether to invoke this service when there is exception from other plug-in before it.
String	getPluginDescription() Get the description of the plug-in
String	getPluginName() Get the name of the document service plug-in
List	getPluginParameters() Get the parameters of the plug-in
String	getPluginVersion() Get the version string of the plug-in
void	init(ParameterValues params, int threadCount, Logger log) Initialize the plug-in manager
boolean	isOnlyInvoke4IndexDoc() Only invoke 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

public static final String VERSION

See Also:

Constant Field Values

ALWAYS_INVOKE

public static final int ALWAYS_INVOKE

See Also:

Constant Field Values

INVOKE_WHEN_NON_FATAL

public static final int INVOKE_WHEN_NON_FATAL

See Also:

Constant Field Values

INVOKE_WHEN_NO_ERROR

public static final int INVOKE_WHEN_NO_ERROR

See Also:

Constant Field Values

Method Detail

cleanup

public void cleanup()
             throws DocumentServiceException

plug-in manager cleanup

Throws:

DocumentServiceException

getBaseAPIVersion

public String getBaseAPIVersion()

Get the version string of the plug-in API - this method should always return DocumentServiceManager.VERSION

Returns:

the plug-in API version string

getDocumentServicePlugin

public DocumentService getDocumentServicePlugin()

provide a DocumentService instance

getInvokeConditionWhenException

public int getInvokeConditionWhenException()

Inform the crawler on whether to invoke this service when there is exception from other plug-in before it. The possible values are:

• 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/fatal error

Returns:

invoke condition code

isOnlyInvoke4IndexDoc

public boolean isOnlyInvoke4IndexDoc()

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

Returns:

true if yes, false if not

getPluginDescription

public String getPluginDescription()

Get the description of the plug-in

Returns:

description of the plug-in

getPluginName

public String getPluginName()

Get the name of the document service plug-in

Returns:

name of the document service

getPluginParameters

public List getPluginParameters()

Get the parameters of the plug-in

Returns:

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

getPluginVersion

public String getPluginVersion()

Get the version string of the plug-in

Returns:

version of the plug-in

init

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

Initialize the plug-in manager

Parameters:

params - the parameters

threadCount - number of plug-in required

log - Logger to the crawler log

Throws:

DocumentServiceException - if unable to initialize the plug-in

setLocale

public 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