org.apache.camel.impl
Class ProcessorPollingConsumer

java.lang.Object
  extended by org.apache.camel.impl.ServiceSupport
      extended by org.apache.camel.impl.PollingConsumerSupport
          extended by org.apache.camel.impl.ProcessorPollingConsumer
All Implemented Interfaces:
Consumer, PollingConsumer, Service, ShutdownableService

public class ProcessorPollingConsumer
extends PollingConsumerSupport

A simple implementation of PollingConsumer which just uses a Processor. This implementation does not support timeout based receive methods such as receive(long)

Version:

Field Summary
 
Fields inherited from class org.apache.camel.impl.PollingConsumerSupport
log
 
Constructor Summary
ProcessorPollingConsumer(Endpoint endpoint, Processor processor)
           
 
Method Summary
protected  void doStart()
           
protected  void doStop()
           
 Exchange receive()
          Waits until a message is available and then returns it.
 Exchange receive(long timeout)
          Attempts to receive a message exchange, waiting up to the given timeout to expire if a message is not yet available
 Exchange receiveNoWait()
          Attempts to receive a message exchange immediately without waiting and returning null if a message exchange is not available yet.
 
Methods inherited from class org.apache.camel.impl.PollingConsumerSupport
getEndpoint, getExceptionHandler, handleException, setExceptionHandler, toString
 
Methods inherited from class org.apache.camel.impl.ServiceSupport
addChildService, doResume, doShutdown, doSuspend, getStatus, getVersion, isRunAllowed, isStarted, isStarting, isStopped, isStopping, isSuspended, isSuspending, removeChildService, resume, shutdown, start, start, stop, suspend
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 
Methods inherited from interface org.apache.camel.Service
start, stop
 

Constructor Detail

ProcessorPollingConsumer

public ProcessorPollingConsumer(Endpoint endpoint,
                                Processor processor)
Method Detail

doStart

protected void doStart()
                throws Exception
Specified by:
doStart in class ServiceSupport
Throws:
Exception

doStop

protected void doStop()
               throws Exception
Specified by:
doStop in class ServiceSupport
Throws:
Exception

receive

public Exchange receive()
Description copied from interface: PollingConsumer
Waits until a message is available and then returns it. Warning that this method could block indefinitely if no messages are available.

Will return null if the consumer is not started

Returns:
the message exchange received.

receiveNoWait

public Exchange receiveNoWait()
Description copied from interface: PollingConsumer
Attempts to receive a message exchange immediately without waiting and returning null if a message exchange is not available yet.

Returns:
the message exchange if one is immediately available otherwise null

receive

public Exchange receive(long timeout)
Description copied from interface: PollingConsumer
Attempts to receive a message exchange, waiting up to the given timeout to expire if a message is not yet available

Parameters:
timeout - the amount of time in milliseconds to wait for a message before timing out and returning null
Returns:
the message exchange if one iwas available within the timeout period, or null if the timeout expired


Apache CAMEL