Skip navigation links

oracle.search.sdk.crawler
Interface CrawlerPluginManager

public interface CrawlerPluginManager

CrawlerPluginManager is an interface used by a crawler plug-in to submit URL-related data to the crawler.

Field Summary

static int	POLICY_DOCUMENT_LEVEL_ACL
static int	POLICY_PUBLIC_ACCESS
static int	POLICY_SOURCE_LEVEL_ACL
static String	VERSION

Method Summary

void	cleanup() plug-in manager cleanup; use getCrawlerStatus() from GeneralService if the cleanup depends on the crawler shutdown scenario.
String	getBaseAPIVersion() Get the version string of the plug-in API.
CrawlerPlugin	getCrawlerPlugin(CrawlingThreadService cts)
int	getDefaultAccessPolicy() Get the default access policy of the plug-in
String	getPluginDescription() Get the description of the plug-in
String	getPluginName() Get the name of the 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, boolean forceRecrawl, Date lastCrawlTime, GeneralService generalMgr, int threadCount) Initialize the plug-in manager

Field Detail

POLICY_PUBLIC_ACCESS

static final int POLICY_PUBLIC_ACCESS

See Also:

Constant Field Values

POLICY_SOURCE_LEVEL_ACL

static final int POLICY_SOURCE_LEVEL_ACL

See Also:

Constant Field Values

POLICY_DOCUMENT_LEVEL_ACL

static final int POLICY_DOCUMENT_LEVEL_ACL

See Also:

Constant Field Values

VERSION

static final String VERSION

See Also:

Constant Field Values

Method Detail

getBaseAPIVersion

String getBaseAPIVersion()

Get the version string of the plug-in API. This method always returns CrawlerPluginManager.VERSION

getPluginName

String getPluginName()

Get the name of the plug-in

Returns:

name of the plug-in

getPluginDescription

String getPluginDescription()

Get the description of the plug-in

Returns:

description of the plug-in

getPluginVersion

String getPluginVersion()

Get the version string of the plug-in

Returns:

version of the plug-in

getPluginParameters

List getPluginParameters()

Get the parameters of the plug-in

getDefaultAccessPolicy

int getDefaultAccessPolicy()

Get the default access policy of the plug-in

init

void init(ParameterValues params,
          boolean forceRecrawl,
          Date lastCrawlTime,
          GeneralService generalMgr,
          int threadCount)
          throws PluginException

Initialize the plug-in manager

Parameters:

params - the data source parameters

forceRecrawl - a flag asking plug-in to return all URLs if true

lastCrawlTime - the time last crawling was performed

generalMgr - general manager

threadCount - number of plug-ins required

Throws:

PluginException - if unable to initialize the plug-in

cleanup

void cleanup()
             throws PluginException

plug-in manager cleanup; use getCrawlerStatus() from GeneralService if the cleanup depends on the crawler shutdown scenario.

Throws:

PluginException - if unable to cleanup the plug-in manager

See Also:

GeneralService.getCrawlerStatus()

getCrawlerPlugin

CrawlerPlugin getCrawlerPlugin(CrawlingThreadService cts)

Parameters:

cts - - crawling thread service object

Returns:

instance of the CrawlerPlugin object

Skip navigation links