SMILA (incubation) API documentation

org.eclipse.smila.connectivity.framework
Interface AgentControllerAgent

All Known Implementing Classes:
AgentControllerAgentBase, AgentControllerAgentImpl

public interface AgentControllerAgent

The Interface AgentControllerAgent.


Method Summary
 java.util.Map<java.lang.String,java.lang.String> getAgentTasksState()
          Gets the status of all agent tasks as a map of data source id and agent state.
 java.lang.String[] getAvailableAgents()
          returns all Agents that have connected to the AgentController.
 java.lang.String[] getAvailableAgentTasks()
          returns all available Agent data source configurations.
 java.lang.String startAgentTask(java.lang.String dataSourceId)
          Start agent.
 java.lang.String stopAgentTask(java.lang.String dataSourceId)
          Stop agent.
 

Method Detail

startAgentTask

java.lang.String startAgentTask(java.lang.String dataSourceId)
Start agent.

Parameters:
dataSourceId - the data source id
Returns:
the string

stopAgentTask

java.lang.String stopAgentTask(java.lang.String dataSourceId)
Stop agent.

Parameters:
dataSourceId - the data source id
Returns:
the string

getAvailableAgents

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

Returns:
List with Strings of all available Agents

getAvailableAgentTasks

java.lang.String[] getAvailableAgentTasks()
returns all available Agent data source configurations.

Returns:
List with Strings of all available Agent data source configurations

getAgentTasksState

java.util.Map<java.lang.String,java.lang.String> getAgentTasksState()
Gets the status of all agent tasks as a map of data source id and agent state.

Returns:
a map of data source id and agent state.

SMILA (incubation) API documentation