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() Crawls the data source.
void	init() Instructs the plug-in to prepare for crawling initialization.
void	stopCrawling() Instructs the plug-in to stop crawling.

Method Detail

init

void init()
          throws PluginException

Instructs the plug-in to prepare for crawling initialization.

Throws:

PluginException - If the plug-in is unable to initialize.

crawl

void crawl()
           throws PluginException

Crawls the data source. The plug-in exits the crawl() call when the crawling is complete. The plug-in also exits when stopCrawling is called by the crawler. The plug-in decides when crawling is complete by its own application-specific logic. In most of the cases, the crawl is complete when the queue is empty.

Throws:

PluginException - For any unrecoverable error.

stopCrawling

void stopCrawling()
                  throws PluginException

Instructs the plug-in to stop crawling. Use getCrawlerStatus() from GeneralService if the cleanup depends on the crawler shutdown scenario.

Throws:

PluginException - If plugin is unable to stop crawling.

See Also:

GeneralService.getCrawlerStatus()

Skip navigation links