org.mule.transport

Class AbstractPollingMessageReceiver

java.lang.Object

org.mule.transport.AbstractMessageReceiver

org.mule.transport.AbstractPollingMessageReceiver

All Implemented Interfaces:

Disposable, Initialisable, Lifecycle, Startable, Stoppable, Connectable, MessageReceiver

Direct Known Subclasses:

PollingHttpMessageReceiver, RmiMessageReceiver, StdioMessageReceiver, 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

Fields

Modifier and Type	Field and Description
static long	DEFAULT_POLL_FREQUENCY
static edu.emory.mathcs.backport.java.util.concurrent.TimeUnit	DEFAULT_POLL_TIMEUNIT
static long	DEFAULT_STARTUP_DELAY
protected List	schedules

Fields inherited from class org.mule.transport.AbstractMessageReceiver

connected, connecting, connectionStrategy, connector, disposing, endpoint, logger, receiverKey, responseEndpoint, service, stopped

Fields inherited from interface org.mule.api.lifecycle.Initialisable

PHASE_NAME

Fields inherited from interface org.mule.api.lifecycle.Startable

PHASE_NAME

Fields inherited from interface org.mule.api.lifecycle.Stoppable

PHASE_NAME

Fields inherited from interface org.mule.api.lifecycle.Disposable

PHASE_NAME

Constructor Summary

Constructors

Constructor and Description
AbstractPollingMessageReceiver(Connector connector, Service service, InboundEndpoint endpoint)

Method Summary

Methods

Modifier and Type	Method and Description
protected PollingReceiverWorker	createWork()
protected void	doStart()
protected void	doStop()
long	getFrequency()
edu.emory.mathcs.backport.java.util.concurrent.TimeUnit	getTimeUnit()
abstract void	poll()
protected void	schedule() This method registers this receiver for periodic polling ticks with the connectors scheduler.
void	setFrequency(long value)
void	setTimeUnit(edu.emory.mathcs.backport.java.util.concurrent.TimeUnit timeUnit)
protected void	unschedule() This method cancels the schedules which were created in schedule().

Methods inherited from class org.mule.transport.AbstractMessageReceiver

connect, disconnect, dispose, doConnect, doDisconnect, doDispose, doInitialise, getConnectEventId, getConnectionDescription, getConnector, getEndpoint, getEndpointURI, getListener, getReceiverKey, getService, getWorkManager, handleException, handleUnacceptedFilter, initialise, isConnected, routeMessage, routeMessage, routeMessage, routeMessage, routeMessage, routeMessage, setConnector, setEndpoint, setExceptionDetails, setListener, setReceiverKey, setService, 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 edu.emory.mathcs.backport.java.util.concurrent.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(Connector connector,
                              Service service,
                              InboundEndpoint endpoint)
                               throws CreateException

Throws:

CreateException

Method Detail

doStart

protected void doStart()
                throws MuleException

Specified by:

doStart in class AbstractMessageReceiver

Throws:

MuleException

doStop

protected void doStop()
               throws MuleException

Specified by:

doStop in class AbstractMessageReceiver

Throws:

MuleException

schedule

protected void schedule()
                 throws edu.emory.mathcs.backport.java.util.concurrent.RejectedExecutionException,
                        NullPointerException,
                        IllegalArgumentException

This method registers this receiver for periodic polling ticks with the connectors scheduler. Subclasses can override this in case they want to handle their polling differently.

Throws:

edu.emory.mathcs.backport.java.util.concurrent.RejectedExecutionException

NullPointerException

IllegalArgumentException

See Also:

ScheduledExecutorService#scheduleWithFixedDelay(Runnable, long, long, TimeUnit)}

unschedule

protected void unschedule()

This method cancels the schedules which were created in schedule().

See Also:

Future#cancel(boolean)}

createWork

protected PollingReceiverWorker createWork()

getFrequency

public long getFrequency()

setFrequency

public void setFrequency(long value)

getTimeUnit

public edu.emory.mathcs.backport.java.util.concurrent.TimeUnit getTimeUnit()

setTimeUnit

public void setTimeUnit(edu.emory.mathcs.backport.java.util.concurrent.TimeUnit timeUnit)

poll

public abstract void poll()
                   throws Exception

Throws:

Exception