com.celequest.api.agent
Interface IPollingAgent

All Superinterfaces:

IAgent

public interface IPollingAgent

extends IAgent

IPollingAgent is implemented by an agent and is polled at intervals seconds by the Celequest agent.

Method Summary

String

getData() getData is called by the agent every polling interval.

Methods inherited from interface com.celequest.api.agent.IAgent

cleanup, close, disable, enable, getDescription, isRecoverable, open

Method Detail

getData

public String getData()
               throws Exception

getData is called by the agent every polling interval. The source is required to extract data, convert it to a String, and return it. A return value of null implies that no more data has to be sent. The agent will sleep for the polling interval and call this method again.

Returns:

a String value - data to be sent.

Throws:

Exception - if an error occurs