org.mule.transport.vm
Class VMMessageReceiver

java.lang.Object
  extended by org.mule.transport.AbstractTransportMessageHandler
      extended by org.mule.transport.AbstractMessageReceiver
          extended by org.mule.transport.AbstractPollingMessageReceiver
              extended by org.mule.transport.TransactedPollingMessageReceiver
                  extended by org.mule.transport.vm.VMMessageReceiver
All Implemented Interfaces:
Disposable, Initialisable, Lifecycle, LifecycleStateEnabled, Startable, Stoppable, MessageSource, Connectable, MessageReceiver

public class VMMessageReceiver
extends TransactedPollingMessageReceiver

VMMessageReceiver is a listener for events from a Mule service which then simply passes the events on to the target service.


Nested Class Summary
 
Nested classes/interfaces inherited from class org.mule.transport.TransactedPollingMessageReceiver
TransactedPollingMessageReceiver.MessageProcessorWorker
 
Field Summary
 
Fields inherited from class org.mule.transport.AbstractPollingMessageReceiver
DEFAULT_POLL_FREQUENCY, DEFAULT_POLL_TIMEUNIT, DEFAULT_STARTUP_DELAY, schedules
 
Fields inherited from class org.mule.transport.AbstractMessageReceiver
defaultInboundTransformers, defaultResponseTransformers, flowConstruct, listener, receiverKey, replyToHandler
 
Fields inherited from class org.mule.transport.AbstractTransportMessageHandler
connected, endpoint, lifecycleManager, logger, muleMessageFactory, retryTemplate
 
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
VMMessageReceiver(Connector connector, FlowConstruct flowConstruct, InboundEndpoint endpoint)
           
 
Method Summary
protected  PollingReceiverWorker createWork()
           
protected  void doConnect()
           
protected  void doDisconnect()
           
protected  void doDispose()
           
protected  MuleEvent getFirstMessage()
           
protected  List<MuleMessage> getFirstMessages()
           
protected  List<MuleMessage> getMessages()
          It's impossible to process all messages in the receive transaction
protected  boolean hasNoMessages()
          Return true if it can be determined that there are currently no messages to process
 MuleMessage onCall(MuleMessage message)
           
 void onMessage(MuleMessage message)
           
protected  void processMessage(Object msg)
           
protected  void schedule()
          This method registers this receiver for periodic polling ticks with the connectors scheduler.
 
Methods inherited from class org.mule.transport.TransactedPollingMessageReceiver
doStart, isReceiveMessagesInTransaction, isUseMultipleTransactedReceivers, poll, setReceiveMessagesInTransaction, setUseMultipleTransactedReceivers
 
Methods inherited from class org.mule.transport.AbstractPollingMessageReceiver
disableNativeScheduling, doStop, getBatchSize, getFrequency, getTimeUnit, performPoll, pollOnPrimaryInstanceOnly, setFrequency, setTimeUnit, unschedule
 
Methods inherited from class org.mule.transport.AbstractMessageReceiver
applyInboundTransformers, applyResponseTransformers, createExecutionTemplate, createLifecycleManager, createMuleEvent, getConnectEventId, getConnectionDescription, getEndpoint, getEndpointURI, getFlowConstruct, getReceiverKey, getReplyToHandler, getWorkManager, handleUnacceptedFilter, initialise, propagateRootMessageIdProperty, routeMessage, routeMessage, routeMessage, routeMessage, routeMessage, setEndpoint, setListener, setReceiverKey, toString, warnIfMuleClientSendUsed
 
Methods inherited from class org.mule.transport.AbstractTransportMessageHandler
activate, connect, createMuleMessage, createMuleMessage, createMuleMessage, createMuleMessageFactory, createNullMuleMessage, disconnect, dispose, disposeAndLogException, doInitialise, getConnectEventId, getConnector, getLifecycleState, initializeMessageFactory, initializeRetryPolicy, isConnected, isDoThreading, isStarted, isStarting, isStopping, passivate, setEndpoint, start, stop, validate, validateConnection
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 
Methods inherited from interface org.mule.api.transport.MessageReceiver
createMuleMessage, createMuleMessage
 
Methods inherited from interface org.mule.api.transport.Connectable
connect, disconnect, isConnected, validateConnection
 
Methods inherited from interface org.mule.api.lifecycle.Startable
start
 
Methods inherited from interface org.mule.api.lifecycle.Stoppable
stop
 
Methods inherited from interface org.mule.api.lifecycle.Disposable
dispose
 

Constructor Detail

VMMessageReceiver

public VMMessageReceiver(Connector connector,
                         FlowConstruct flowConstruct,
                         InboundEndpoint endpoint)
                  throws CreateException
Throws:
CreateException
Method Detail

schedule

protected void schedule()
                 throws RejectedExecutionException,
                        NullPointerException,
                        IllegalArgumentException
Description copied from class: AbstractPollingMessageReceiver
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.

Overrides:
schedule in class AbstractPollingMessageReceiver
Throws:
RejectedExecutionException
NullPointerException
IllegalArgumentException
See Also:
ScheduledExecutorService.scheduleWithFixedDelay(Runnable, long, long, TimeUnit)

doDispose

protected void doDispose()
Overrides:
doDispose in class AbstractMessageReceiver

doConnect

protected void doConnect()
                  throws Exception
Overrides:
doConnect in class AbstractTransportMessageHandler
Throws:
Exception

doDisconnect

protected void doDisconnect()
                     throws Exception
Overrides:
doDisconnect in class AbstractTransportMessageHandler
Throws:
Exception

onMessage

public void onMessage(MuleMessage message)
               throws MuleException
Throws:
MuleException

onCall

public MuleMessage onCall(MuleMessage message)
                   throws MuleException
Throws:
MuleException

getMessages

protected List<MuleMessage> getMessages()
                                 throws Exception
It's impossible to process all messages in the receive transaction

Specified by:
getMessages in class TransactedPollingMessageReceiver
Throws:
Exception

getFirstMessages

protected List<MuleMessage> getFirstMessages()
                                      throws Exception
Throws:
Exception

getFirstMessage

protected MuleEvent getFirstMessage()
                             throws Exception
Throws:
Exception

hasNoMessages

protected boolean hasNoMessages()
Description copied from class: TransactedPollingMessageReceiver
Return true if it can be determined that there are currently no messages to process

Overrides:
hasNoMessages in class TransactedPollingMessageReceiver

processMessage

protected void processMessage(Object msg)
                       throws Exception
Specified by:
processMessage in class TransactedPollingMessageReceiver
Throws:
Exception

createWork

protected PollingReceiverWorker createWork()
Overrides:
createWork in class AbstractPollingMessageReceiver


Copyright © 2003-2012 MuleSoft, Inc.. All Rights Reserved.