Skip navigation links

oracle.search.sdk.crawler
Interface GeneralService

public interface GeneralService

GeneralService is an interface used by a crawler plugin to perform miscellaneous service

Field Summary

static int	STATUS_CRAWL_ABORT_SHUTDOWN The crawler is shutting down due to fatal crawl error
static int	STATUS_NORMAL_SHUTDOWN The crawler finished crawl and is in the process of shutting down
static int	STATUS_PLUGIN_ABORT_SHUTDOWN The crawler is shutting down due to fatal plug-in error
static int	STATUS_RUNNING The crawler is running
static int	STATUS_STOPPED_BY_USER The crawler is shutting down due to user request

Method Summary

int	getCrawlerStatus() Get the current crawler status.
DataSourceService	getDataSourceService() Get the datasource service object
Logger	getLoggingService() get the Logger object
QueueService	getQueueService() Get the queue service object
DocumentAcl	newDocumentAcl() Get a new instance of the DocumentAcl object
DocumentContainer	newDocumentContainer() Get a new instance of the DocumentContainer object
DocumentMetadata	newDocumentMetadata() Get a new instance of the DocumentMetadata object
LovInfo	newLovInfo() Get a new instance of the List of values object

Field Detail

STATUS_RUNNING

public static final int STATUS_RUNNING

The crawler is running

See Also:

Constant Field Values

STATUS_NORMAL_SHUTDOWN

public static final int STATUS_NORMAL_SHUTDOWN

The crawler finished crawl and is in the process of shutting down

See Also:

Constant Field Values

STATUS_STOPPED_BY_USER

public static final int STATUS_STOPPED_BY_USER

The crawler is shutting down due to user request

See Also:

Constant Field Values

STATUS_CRAWL_ABORT_SHUTDOWN

public static final int STATUS_CRAWL_ABORT_SHUTDOWN

The crawler is shutting down due to fatal crawl error

See Also:

Constant Field Values

STATUS_PLUGIN_ABORT_SHUTDOWN

public static final int STATUS_PLUGIN_ABORT_SHUTDOWN

The crawler is shutting down due to fatal plug-in error

See Also:

Constant Field Values

Method Detail

getCrawlerStatus

public int getCrawlerStatus()

Get the current crawler status. The plug-in may need to know the cause of crawler shutdown in order to properly shutdown itself.

Returns:

status code indicating the crawler is:

• running (STATUS_RUNNING)
• normal shutdown (STATUS_NORMAL_SHUTDOWN)
• stopped by the user (STATUS_STOPPED_BY_USER)
• abort due to crawl error (STATUS_CRAWL_ABORT_SHUTDOWN)
• abort due to plug-in error (STATUS_PLUGIN_ABORT_SHUTDOWN)

getDataSourceService

public DataSourceService getDataSourceService()

Get the datasource service object

Returns:

the object representing the datasource service interface

getLoggingService

public Logger getLoggingService()

get the Logger object

Returns:

the logger implementation

getQueueService

public QueueService getQueueService()

Get the queue service object

Returns:

the object representing the queue service interface

newDocumentAcl

public DocumentAcl newDocumentAcl()

Get a new instance of the DocumentAcl object

Returns:

a new instance of a document acl object

newDocumentMetadata

public DocumentMetadata newDocumentMetadata()

Get a new instance of the DocumentMetadata object

Returns:

a new instance of a document metadata object

newDocumentContainer

public DocumentContainer newDocumentContainer()

Get a new instance of the DocumentContainer object

Returns:

a new instance of a document container object

newLovInfo

public LovInfo newLovInfo()

Get a new instance of the List of values object

Returns:

a new instance of a document container object

Skip navigation links