Skip navigation links

oracle.search.sdk.crawler
Interface CrawlerPluginManager

public interface CrawlerPluginManager

CrawlerPluginManager is an interface used by a crawler plugin 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() plugin manager cleanup; use getCrawlerStatus() from GeneralService if the clean up depends on the crawler shutdown scenario.
String	getBaseAPIVersion() Get the version string of the plugin API - this method should always return CrawlerPluginManager.VERSION
CrawlerPlugin	getCrawlerPlugin(CrawlingThreadService cts) provide a CrawlerPlugin instance.
int	getDefaultAccessPolicy() Get the default access policy of the plugin
String	getPluginDescription() Get the description of the plugin
String	getPluginName() Get the name of the plugin
List	getPluginParameters() Get the parameters of the plugin
String	getPluginVersion() Get the version string of the plugin
void	init(ParameterValues params, boolean forceRecrawl, Date lastCrawlTime, GeneralService generalMgr, int threadCount) Initialize the plugin manager

Field Detail

POLICY_PUBLIC_ACCESS

public static final int POLICY_PUBLIC_ACCESS

See Also:

Constant Field Values

POLICY_SOURCE_LEVEL_ACL

public static final int POLICY_SOURCE_LEVEL_ACL

See Also:

Constant Field Values

POLICY_DOCUMENT_LEVEL_ACL

public static final int POLICY_DOCUMENT_LEVEL_ACL

See Also:

Constant Field Values

VERSION

public static final String VERSION

See Also:

Constant Field Values

Method Detail

getBaseAPIVersion

public String getBaseAPIVersion()

Get the version string of the plugin API - this method should always return CrawlerPluginManager.VERSION

Returns:

the plugin API version string

getPluginName

public String getPluginName()

Get the name of the plugin

Returns:

name of the plugin

getPluginDescription

public String getPluginDescription()

Get the description of the plugin

Returns:

description of the plugin

getPluginVersion

public String getPluginVersion()

Get the version string of the plugin

Returns:

version of the plugin

getPluginParameters

public List getPluginParameters()

Get the parameters of the plugin

Returns:

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

getDefaultAccessPolicy

public int getDefaultAccessPolicy()

Get the default access policy of the plugin

Returns:

the access policy: CrawlerPluginManager.POLICY_PUBLIC_ACCESS, CrawlerPluginManager.POLICY_SOURCE_LEVEL_ACL, or CrawlerPluginManager.POLICY_DOCUMENT_LEVEL_ACL

init

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

Initialize the plugin manager

Parameters:

params - the data source parameters

forceRecrawl - a flag asking plugin to return all URLs if true

lastCrawlTime - the time last crawling was performed

generalMgr - general manager

threadCount - number of plugins required

Throws:

PluginException - if unable to initialize the plugin

cleanup

public void cleanup()
             throws PluginException

plugin manager cleanup; use getCrawlerStatus() from GeneralService if the clean up depends on the crawler shutdown scenario.

Throws:

PluginException - if unable to clean up the plugin manager

See Also:

GeneralService.getCrawlerStatus()

getCrawlerPlugin

public CrawlerPlugin getCrawlerPlugin(CrawlingThreadService cts)

provide a CrawlerPlugin instance. The CrawlingThreadService object provides crawl related service in the context of a crawling thread

Parameters:

cts - crawling thread service object

Returns:

instance of the CrawlerPlugin object

Skip navigation links