org.mule.providers
Class AbstractPollingMessageReceiver

java.lang.Object
  extended byorg.mule.providers.AbstractMessageReceiver
      extended byorg.mule.providers.AbstractPollingMessageReceiver
All Implemented Interfaces:
Disposable, Lifecycle, Startable, Stoppable, UMOConnectable, UMOMessageReceiver
Direct Known Subclasses:
FileMessageReceiver, FtpMessageReceiver, PollingHttpMessageReceiver, RetrieveMessageReceiver, RmiMessageReceiver, StreamMessageReceiver, TcpStreamingMessageReceiver, TransactedPollingMessageReceiver

public abstract class AbstractPollingMessageReceiver
extends AbstractMessageReceiver

AbstractPollingMessageReceiver implements a base class for polling message receivers. The receiver provides a poll() method that implementations must implement to execute their custom code. Note that the receiver will not poll if the associated connector is not started.


Field Summary
static long DEFAULT_POLL_FREQUENCY
           
static TimeUnit DEFAULT_POLL_TIMEUNIT
           
static long DEFAULT_STARTUP_DELAY
           
protected  List schedules
           
 
Fields inherited from class org.mule.providers.AbstractMessageReceiver
component, connected, connecting, connectionStrategy, connector, disposing, endpoint, logger, receiverKey, stopped
 
Constructor Summary
AbstractPollingMessageReceiver(UMOConnector connector, UMOComponent component, UMOEndpoint endpoint)
           
 
Method Summary
protected  PollingReceiverWorker createWork()
           
protected  void doStart()
           
protected  void doStop()
           
 long getFrequency()
           
 TimeUnit getTimeUnit()
           
abstract  void poll()
           
 void setFrequency(long value)
           
 void setTimeUnit(TimeUnit timeUnit)
           
 
Methods inherited from class org.mule.providers.AbstractMessageReceiver
applyResponseTransformer, connect, disconnect, dispose, doConnect, doDisconnect, doDispose, getComponent, getConnectEventId, getConnectionDescription, getConnector, getEndpoint, getEndpointURI, getListener, getReceiverKey, getWorkManager, handleException, handleUnacceptedFilter, isConnected, routeMessage, routeMessage, routeMessage, routeMessage, routeMessage, routeMessage, setComponent, setConnector, setEndpoint, setExceptionDetails, setListener, setReceiverKey, setWorkManager, start, stop, toString
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Field Detail

DEFAULT_POLL_FREQUENCY

public static final long DEFAULT_POLL_FREQUENCY
See Also:
Constant Field Values

DEFAULT_POLL_TIMEUNIT

public static final TimeUnit DEFAULT_POLL_TIMEUNIT

DEFAULT_STARTUP_DELAY

public static final long DEFAULT_STARTUP_DELAY
See Also:
Constant Field Values

schedules

protected final List schedules
Constructor Detail

AbstractPollingMessageReceiver

public AbstractPollingMessageReceiver(UMOConnector connector,
                                      UMOComponent component,
                                      UMOEndpoint endpoint)
                               throws InitialisationException
Method Detail

doStart

protected void doStart()
                throws UMOException
Specified by:
doStart in class AbstractMessageReceiver
Throws:
UMOException

doStop

protected void doStop()
               throws UMOException
Specified by:
doStop in class AbstractMessageReceiver
Throws:
UMOException

createWork

protected PollingReceiverWorker createWork()

getFrequency

public long getFrequency()

setFrequency

public void setFrequency(long value)

getTimeUnit

public TimeUnit getTimeUnit()

setTimeUnit

public void setTimeUnit(TimeUnit timeUnit)

poll

public abstract void poll()
                   throws Exception
Throws:
Exception


Copyright © 2003-2008 MuleSource, Inc.. All Rights Reserved.