org.eclipse.smila.connectivity.framework
Interface Agent

All Superinterfaces:

java.lang.Runnable

All Known Implementing Classes:

AbstractAgent, FeedAgent, JobFileAgent, MockAgent

public interface Agent
extends java.lang.Runnable

The Interface Agent.

Method Summary

java.lang.String	getAgentId() Returns the ID of this Agent.
AgentPerformanceCounterHelper<? extends ConnectivityPerformanceAgent>	getCounterHelper()
void	start(AgentControllerCallback controllerCallback, AgentState agentState, DataSourceConnectionConfig config, java.lang.String sessionId) Starts the agent using the given configuration, creating a new internal thread.
void	stop() Stops the agent.

Methods inherited from interface java.lang.Runnable

run

Method Detail

getAgentId

java.lang.String getAgentId()
                            throws AgentException

Returns the ID of this Agent.

Returns:

a String containing the ID of this Agent

Throws:

AgentException - if any error occurs

start

void start(AgentControllerCallback controllerCallback,
           AgentState agentState,
           DataSourceConnectionConfig config,
           java.lang.String sessionId)
           throws AgentException

Starts the agent using the given configuration, creating a new internal thread.

Parameters:

controllerCallback - reference to the interface AgentControllerCallback

agentState - the AgentState

config - the DataSourceConnectionConfig

sessionId - the delta indexing session id

Throws:

AgentException - if any error occurs

stop

void stop()
          throws AgentException

Stops the agent.

Throws:

AgentException - if any error occurs

getCounterHelper

AgentPerformanceCounterHelper<? extends ConnectivityPerformanceAgent> getCounterHelper()

Returns:

the PerformanceCounterHelper of the Agent.