net.esper.adapter
Interface Adapter

All Known Subinterfaces:

AdapterCoordinator, CoordinatedAdapter, InputAdapter, OutputAdapter

All Known Implementing Classes:

AbstractCoordinatedAdapter, AdapterCoordinatorImpl, CSVInputAdapter, JMSInputAdapter, JMSOutputAdapter, SpringJMSTemplateInputAdapter, SpringJMSTemplateOutputAdapter

public interface Adapter

An Adapter takes some external data, converts it into events, and sends it into the runtime engine.

Method Summary

void	destroy() Destroy the Adapter, stopping the sending of all events and releasing all the resources, and disallowing any further state changes on the Adapter.
AdapterState	getState() Get the state of this Adapter.
void	pause() Pause the sending of events after a Adapter has been started.
void	resume() Resume sending events after the Adapter has been paused.
void	start() Start the sending of events into the runtime egine.
void	stop() Stop sending events and return the Adapter to the OPENED state, ready to be started once again.

Method Detail

start

void start()
           throws net.esper.client.EPException

Start the sending of events into the runtime egine.

Throws:

net.esper.client.EPException - in case of errors processing the events

pause

void pause()
           throws net.esper.client.EPException

Pause the sending of events after a Adapter has been started.

Throws:

net.esper.client.EPException - if this Adapter has already been stopped

resume

void resume()
            throws net.esper.client.EPException

Resume sending events after the Adapter has been paused.

Throws:

net.esper.client.EPException - in case of errors processing the events

stop

void stop()
          throws net.esper.client.EPException

Stop sending events and return the Adapter to the OPENED state, ready to be started once again.

Throws:

net.esper.client.EPException - in case of errors releasing resources

destroy

void destroy()
             throws net.esper.client.EPException

Destroy the Adapter, stopping the sending of all events and releasing all the resources, and disallowing any further state changes on the Adapter.

Throws:

net.esper.client.EPException - to indicate errors during destroy

getState

AdapterState getState()

Get the state of this Adapter.

Returns:

state