SMILA (incubation) API documentation

org.eclipse.smila.connectivity.framework
Class CrawlerControllerAgentBase

java.lang.Object
  extended by org.eclipse.smila.management.LocatedManagementAgentBase
      extended by org.eclipse.smila.management.DeclarativeManagementAgent
          extended by org.eclipse.smila.management.DeclarativeServiceManagementAgent<CrawlerController>
              extended by 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[] getActiveCrawlerTasks()
          Gets the active crawls.
 java.lang.String getActiveCrawlerTaskStatus()
          Gets the active crawls status.
 java.lang.String[] getAvailableCrawlers()
          returns all Crawlers that have connected to the CrawlerController.
protected  java.lang.String getCategory()
          Gets the category.
protected  java.lang.String getName()
          Gets the name.
 java.lang.String getStatus(java.lang.String dataSourceId)
          Gets the status.
 java.lang.String startCrawling(java.lang.String dataSourceId)
          Start crawl.
 java.lang.String stopCrawling(java.lang.String dataSourceId)
          Stop crawl.
 
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()

startCrawling

public java.lang.String startCrawling(java.lang.String dataSourceId)
Start crawl.

Specified by:
startCrawling in interface CrawlerControllerAgent
Parameters:
dataSourceId - the data source id
Returns:
the string
See Also:
CrawlerControllerAgent.startCrawling(java.lang.String)

stopCrawling

public java.lang.String stopCrawling(java.lang.String dataSourceId)
Stop crawl.

Specified by:
stopCrawling in interface CrawlerControllerAgent
Parameters:
dataSourceId - the data source id
Returns:
the string
See Also:
CrawlerControllerAgent.stopCrawling(java.lang.String)

getStatus

public java.lang.String getStatus(java.lang.String dataSourceId)
Gets the status.

Specified by:
getStatus in interface CrawlerControllerAgent
Parameters:
dataSourceId - the data source id
Returns:
the status
See Also:
CrawlerControllerAgent.getStatus(java.lang.String)

getActiveCrawlerTaskStatus

public java.lang.String getActiveCrawlerTaskStatus()
Gets the active crawls status.

Specified by:
getActiveCrawlerTaskStatus in interface CrawlerControllerAgent
Returns:
the active crawls status
See Also:
CrawlerControllerAgent.getActiveCrawlerTaskStatus()

getActiveCrawlerTasks

public java.lang.String[] getActiveCrawlerTasks()
Gets the active crawls.

Specified by:
getActiveCrawlerTasks in interface CrawlerControllerAgent
Returns:
the active crawls
See Also:
CrawlerControllerAgent.getActiveCrawlerTasks()

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()

SMILA (incubation) API documentation