Skip navigation links

oracle.search.sdk.crawler
Interface CrawlerPlugin

public interface CrawlerPlugin

CrawlerPlugin is an interface used by a crawler plugin to crawl its own repository.

Method Summary

void	crawl() "crawl" the data source.
void	init() Ask the plugin to prepare for crawling initialization
void	stopCrawling() Tell the plugin to stop crawling; use getCrawlerStatus() from GeneralService if the clean up depends on the crawler shutdown scenario.

Method Detail

init

public void init()
          throws PluginException

Ask the plugin to prepare for crawling initialization

Throws:

PluginException - if unable to initialize

crawl

public void crawl()
           throws PluginException

"crawl" the data source. The plugin exit the crawl() call when the crawling is done. The plugin should also exit when stopCrawling is called by the crawler. Note that the definition of "crawling done" is up to the plugin to decide by whatever application-specific logic. In most of the cases crawl is done when the queue is empty

Throws:

PluginException - for any unrecoverable error

stopCrawling

public void stopCrawling()
                  throws PluginException

Tell the plugin to stop crawling; use getCrawlerStatus() from GeneralService if the clean up depends on the crawler shutdown scenario.

Throws:

PluginException - if plugin is unable to stop crawling

See Also:

GeneralService.getCrawlerStatus()

Skip navigation links