org.eclipse.smila.connectivity.framework
Interface CrawlerControllerAgent

All Known Implementing Classes:

CrawlerControllerAgentBase, CrawlerControllerAgentImpl

public interface CrawlerControllerAgent

The Interface CrawlerControllerAgent.

Method Summary

java.lang.String[]	getAvailableCrawlers() returns all Crawlers that have connected to the CrawlerController.
java.lang.String[]	getAvailableCrawlerTasks() returns all available Crawler data source configurations.
java.util.Map<java.lang.String,java.lang.String>	getCrawlerTasksState() Gets the status of all crawler tasks as a map of data source id and crawler state.
java.lang.String	startCrawlerTask(java.lang.String dataSourceId, java.lang.String jobName) Start a new crawler task.
java.lang.String	stopCrawlerTask(java.lang.String dataSourceId) Stop a crawler task.

Method Detail

startCrawlerTask

java.lang.String startCrawlerTask(java.lang.String dataSourceId,
                                  java.lang.String jobName)

Start a new crawler task.

Parameters:

dataSourceId - the data source id

jobName - the job for which to push the crawled data

Returns:

the string

stopCrawlerTask

java.lang.String stopCrawlerTask(java.lang.String dataSourceId)

Stop a crawler task.

Parameters:

dataSourceId - the data source id

Returns:

the string

getCrawlerTasksState

java.util.Map<java.lang.String,java.lang.String> getCrawlerTasksState()

Gets the status of all crawler tasks as a map of data source id and crawler state.

Returns:

a map of data source id and crawler state.

getAvailableCrawlers

java.lang.String[] getAvailableCrawlers()

returns all Crawlers that have connected to the CrawlerController.

Returns:

List with Strings of all available Crawlers

getAvailableCrawlerTasks

java.lang.String[] getAvailableCrawlerTasks()

returns all available Crawler data source configurations.

Returns:

List with Strings of all available Crawler data source configurations