org.eclipse.smila.connectivity.framework
Class AgentControllerAgentBase

java.lang.Object
  org.eclipse.smila.management.LocatedManagementAgentBase
      org.eclipse.smila.management.DeclarativeManagementAgent
          org.eclipse.smila.management.DeclarativeServiceManagementAgent<AgentController>
              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.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.
protected java.lang.String	getCategory() Gets the category.
protected java.lang.String	getName() Gets the name.
java.lang.String	startAgentTask(java.lang.String dataSourceId, java.lang.String jobName) Start agent.
java.lang.String	stopAgentTask(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()

startAgentTask

public java.lang.String startAgentTask(java.lang.String dataSourceId,
                                       java.lang.String jobName)

Start agent.

Specified by:

startAgentTask in interface AgentControllerAgent

Parameters:

dataSourceId - the data source id

jobName - JobManager job name to submit records to.

Returns:

the string

See Also:

org.eclipse.smila.connectivity.framework.AgentControllerAgent#startAgentTask(java.lang.String)

stopAgentTask

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

Stop agent.

Specified by:

stopAgentTask in interface AgentControllerAgent

Parameters:

dataSourceId - the data source id

Returns:

the string

See Also:

AgentControllerAgent.stopAgentTask(java.lang.String)

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

getAvailableAgentTasks

public java.lang.String[] getAvailableAgentTasks()

returns all available Agent data source configurations.

Specified by:

getAvailableAgentTasks in interface AgentControllerAgent

Returns:

List with Strings of all available Agent data source configurations

See Also:

AgentControllerAgent.getAvailableAgentTasks()

getAgentTasksState

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

Specified by:

getAgentTasksState in interface AgentControllerAgent

Returns:

a map of data source id and agent state.

See Also:

AgentControllerAgent.getAgentTasksState()