org.eclipse.smila.connectivity.framework
Class CrawlerControllerAgentBase

java.lang.Object
  org.eclipse.smila.management.LocatedManagementAgentBase
      org.eclipse.smila.management.DeclarativeManagementAgent
          org.eclipse.smila.management.DeclarativeServiceManagementAgent<CrawlerController>
              org.eclipse.smila.connectivity.framework.CrawlerControllerAgentBase

All Implemented Interfaces:

CrawlerControllerAgent, LocatedManagementAgent, ManagementAgent

Direct Known Subclasses:

CrawlerControllerAgentImpl

public abstract class CrawlerControllerAgentBase
extends DeclarativeServiceManagementAgent<CrawlerController>
implements CrawlerControllerAgent

The Class CrawlerControllerAgent.

Field Summary

Fields inherited from class org.eclipse.smila.management.DeclarativeServiceManagementAgent

_service

Constructor Summary

CrawlerControllerAgentBase()

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.
protected java.lang.String	getCategory() Gets the category.
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.
protected java.lang.String	getName() Gets the name.
java.lang.String	startCrawlerTask(java.lang.String dataSourceId) Start a new crawler task.
java.lang.String	stopCrawlerTask(java.lang.String dataSourceId) Stop a crawler task.

Methods inherited from class org.eclipse.smila.management.DeclarativeServiceManagementAgent

setService, unsetService

Methods inherited from class org.eclipse.smila.management.DeclarativeManagementAgent

activate, deactivate

Methods inherited from class org.eclipse.smila.management.LocatedManagementAgentBase

getLocation

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

CrawlerControllerAgentBase

public CrawlerControllerAgentBase()

Method Detail

getCategory

protected java.lang.String getCategory()

Gets the category.

Specified by:

getCategory in class LocatedManagementAgentBase

Returns:

the category

See Also:

LocatedManagementAgentBase.getCategory()

getName

protected java.lang.String getName()

Gets the name.

Specified by:

getName in class LocatedManagementAgentBase

Returns:

the name

See Also:

LocatedManagementAgentBase.getName()

startCrawlerTask

public java.lang.String startCrawlerTask(java.lang.String dataSourceId)

Start a new crawler task.

Specified by:

startCrawlerTask in interface CrawlerControllerAgent

Parameters:

dataSourceId - the data source id

Returns:

the string

See Also:

CrawlerControllerAgent.startCrawlerTask(java.lang.String)

stopCrawlerTask

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

Stop a crawler task.

Specified by:

stopCrawlerTask in interface CrawlerControllerAgent

Parameters:

dataSourceId - the data source id

Returns:

the string

See Also:

CrawlerControllerAgent.stopCrawlerTask(java.lang.String)

getCrawlerTasksState

public 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.

Specified by:

getCrawlerTasksState in interface CrawlerControllerAgent

Returns:

a map of data source id and crawler state.

See Also:

org.eclipse.smila.connectivity.framework.CrawlerControllerAgent#getAgentTasksState()

getAvailableCrawlers

public java.lang.String[] getAvailableCrawlers()

returns all Crawlers that have connected to the CrawlerController.

Specified by:

getAvailableCrawlers in interface CrawlerControllerAgent

Returns:

List with Strings of all available Crawlers

See Also:

CrawlerControllerAgent.getAvailableCrawlers()

getAvailableCrawlerTasks

public java.lang.String[] getAvailableCrawlerTasks()

returns all available Crawler data source configurations.

Specified by:

getAvailableCrawlerTasks in interface CrawlerControllerAgent

Returns:

List with Strings of all available Crawler data source configurations

See Also:

CrawlerControllerAgent.getAvailableCrawlerTasks()