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 a 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 a 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 a user request.

Method Summary

oracle.search.sdk.crawler.AuthenticationService	getAuthenticationService() Gets a new instance of a Credential Store Service.
int	getCrawlerStatus() Gets the current crawler status.
DataSourceService	getDataSourceService() Gets the datasource service object.
Logger	getLoggingService() Gets the Logger object.
QueueService	getQueueService() Gets the queue service object.
QueueService	getQueueService(int orderType) Get the queue service object based on de-queue order type
oracle.search.sdk.crawler.UserCacheService	getUserCacheService() Gets a new instance of a User Cache Service.
DocumentAcl	newDocumentAcl() Gets a new instance of the DocumentAcl object.
DocumentContainer	newDocumentContainer() Gets a new instance of the DocumentContainer object.
DocumentMetadata	newDocumentMetadata() Gets a new instance of the DocumentMetadata object.
LovInfo	newLovInfo() Gets a new instance of the List of Values object.

Field Detail

STATUS_RUNNING

static final int STATUS_RUNNING

The crawler is running.

See Also:

Constant Field Values

STATUS_NORMAL_SHUTDOWN

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

static final int STATUS_STOPPED_BY_USER

The crawler is shutting down due to a user request.

See Also:

Constant Field Values

STATUS_CRAWL_ABORT_SHUTDOWN

static final int STATUS_CRAWL_ABORT_SHUTDOWN

The crawler is shutting down due to a fatal crawl error.

See Also:

Constant Field Values

STATUS_PLUGIN_ABORT_SHUTDOWN

static final int STATUS_PLUGIN_ABORT_SHUTDOWN

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

See Also:

Constant Field Values

Method Detail

getCrawlerStatus

int getCrawlerStatus()

Gets the current crawler status. The plug-in may need the cause of crawler shutdown in order to close properly.

Returns:

The crawler status code:

• STATUS_RUNNING: running
• STATUS_NORMAL_SHUTDOWN: the crawler shut down normally
• STATUS_STOPPED_BY_USER: the crawler was stopped by the user
• STATUS_CRAWL_ABORT_SHUTDOWN: the crawler stopped because of a crawl error
• STATUS_PLUGIN_ABORT_SHUTDOWN: the crawler stopped because of a plug-in error

getDataSourceService

DataSourceService getDataSourceService()

Gets the datasource service object.

getLoggingService

Logger getLoggingService()

Gets the Logger object.

getQueueService

QueueService getQueueService()

Gets the queue service object.

getQueueService

QueueService getQueueService(int orderType)

Get the queue service object based on de-queue order type

Parameters:

orderType - - de-queue order type in which the queue service will be returned.

• to de-queue documents in no specific order (UNORDERED)
• to de-queue documents in same order as enqueued (FIFO)
• to de-queue documents in reverse order as en-queued (LIFO)

Returns:

the object representing the queue service interface

newDocumentAcl

DocumentAcl newDocumentAcl()

Gets a new instance of the DocumentAcl object.

newDocumentMetadata

DocumentMetadata newDocumentMetadata()

Gets a new instance of the DocumentMetadata object.

newDocumentContainer

DocumentContainer newDocumentContainer()

Gets a new instance of the DocumentContainer object.

newLovInfo

LovInfo newLovInfo()

Gets a new instance of the List of Values object.

getUserCacheService

oracle.search.sdk.crawler.UserCacheService getUserCacheService()

Gets a new instance of a User Cache Service.

getAuthenticationService

oracle.search.sdk.crawler.AuthenticationService getAuthenticationService()

Gets a new instance of a Credential Store Service.

Skip navigation links