com.celequest.api.agent
Interface IAgent

All Known Subinterfaces:

IEventAgent, IPollingAgent, IRecoverableAgent

public interface IAgent

IAgent is implemented by a class that extracts data from an arbitrary source and sends it to the Celequest server.

Method Summary

void	cleanup(Throwable t) cleanup is called to allow the source to clean up after the agent has transmitted the data to the server.
void	close() close closes the source.
void	disable() disable is called when a DISABLE request is received from the Celequest server.
void	enable() enable enables the source.
String	getDescription() getDescription provides an arbitrary description of the source.
boolean	isRecoverable() isRecoverable states whether the agent is recoverable.
void	open(String agentName, String agentConfigFile) open is called by the Celequest agent to open the source.

Method Detail

open

public void open(String agentName,
                 String agentConfigFile)
          throws Exception

open is called by the Celequest agent to open the source.

Parameters:

agentName - a String value - the name of the agent. This is a mandatory parameter.

agentConfigFile - a String value - the agent configuration file. This is an optional parameter; the contents of the file are determined by the source.

Throws:

Exception - if an error occurs

close

public void close()

close closes the source. The source will not be reopened under any circumstances.

enable

public void enable()
            throws Exception

enable enables the source. The Celequest agent will not attempt to request data from the source without calling this method. The method is called when an ENABLE request is received from the Celequest server.

Throws:

Exception - if an error occurs

disable

public void disable()
             throws Exception

disable is called when a DISABLE request is received from the Celequest server. The agent will call enable before requesting data.

Throws:

Exception - if an error occurs

getDescription

public String getDescription()

getDescription provides an arbitrary description of the source. This description might be published in the log files.

Returns:

a String value

cleanup

public void cleanup(Throwable t)

cleanup is called to allow the source to clean up after the agent has transmitted the data to the server.

Parameters:

t - a Throwable - the error received when transmitting the data. A value of null implies that the data was transmitted without any error. The source is free to ignore the error code.

isRecoverable

public boolean isRecoverable()

isRecoverable states whether the agent is recoverable.

Returns:

a boolean value