SMILA (incubation) API documentation

org.eclipse.smila.connectivity.framework
Class AgentControllerAgentBase

java.lang.Object
  extended by org.eclipse.smila.management.LocatedManagementAgentBase
      extended by org.eclipse.smila.management.DeclarativeManagementAgent
          extended by org.eclipse.smila.management.DeclarativeServiceManagementAgent<AgentController>
              extended by org.eclipse.smila.connectivity.framework.AgentControllerAgentBase
All Implemented Interfaces:
AgentControllerAgent, LocatedManagementAgent, ManagementAgent
Direct Known Subclasses:
AgentControllerAgentImpl

public abstract class AgentControllerAgentBase
extends DeclarativeServiceManagementAgent<AgentController>
implements AgentControllerAgent

The Class AgentControllerAgent.


Field Summary
 
Fields inherited from class org.eclipse.smila.management.DeclarativeServiceManagementAgent
_service
 
Constructor Summary
AgentControllerAgentBase()
           
 
Method Summary
 java.lang.String[] getActiveAgentTasks()
          Gets the active agents.
 java.lang.String getActiveAgentTaskStatus()
          Gets the active agents status.
 java.lang.String[] getAvailableAgents()
          returns all Agents that have connected to the AgentController.
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 startAgent(java.lang.String dataSourceId)
          Start agent.
 java.lang.String stopAgent(java.lang.String dataSourceId)
          Stop agent.
 
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

AgentControllerAgentBase

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

startAgent

public java.lang.String startAgent(java.lang.String dataSourceId)
Start agent.

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

stopAgent

public java.lang.String stopAgent(java.lang.String dataSourceId)
Stop agent.

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

getStatus

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

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

getActiveAgentTaskStatus

public java.lang.String getActiveAgentTaskStatus()
Gets the active agents status.

Specified by:
getActiveAgentTaskStatus in interface AgentControllerAgent
Returns:
the active agents status
See Also:
AgentControllerAgent.getActiveAgentTaskStatus()

getActiveAgentTasks

public java.lang.String[] getActiveAgentTasks()
Gets the active agents.

Specified by:
getActiveAgentTasks in interface AgentControllerAgent
Returns:
the active agents
See Also:
AgentControllerAgent.getActiveAgentTasks()

getAvailableAgents

public java.lang.String[] getAvailableAgents()
returns all Agents that have connected to the AgentController.

Specified by:
getAvailableAgents in interface AgentControllerAgent
Returns:
List with Strings of all available Agents
See Also:
AgentControllerAgent.getAvailableAgents()

SMILA (incubation) API documentation