org.apache.camel.component.jms
Class JmsPollingConsumer

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

public class JmsPollingConsumer
extends PollingConsumerSupport

Version:
$Revision: 18227 $

Constructor Summary
JmsPollingConsumer(JmsEndpoint endpoint, JmsOperations template)
           
 
Method Summary
protected  void doStart()
           
protected  void doStop()
           
 JmsEndpoint getEndpoint()
          Gets the endpoint this Consumer consumes from.
 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.
protected  void setReceiveTimeout(long timeout)
           
 
Methods inherited from class org.apache.camel.impl.PollingConsumerSupport
getExceptionHandler, handleException, setExceptionHandler, toString
 
Methods inherited from class org.apache.camel.impl.ServiceSupport
addChildService, doShutdown, getStatus, getVersion, isRunAllowed, isStarted, isStarting, isStopped, isStopping, removeChildService, shutdown, start, stop
 
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

JmsPollingConsumer

public JmsPollingConsumer(JmsEndpoint endpoint,
                          JmsOperations template)
Method Detail

getEndpoint

public JmsEndpoint getEndpoint()
Description copied from interface: Consumer
Gets the endpoint this Consumer consumes from.

Specified by:
getEndpoint in interface Consumer
Overrides:
getEndpoint in class PollingConsumerSupport
Returns:
the endpoint

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()
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.

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

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

setReceiveTimeout

protected void setReceiveTimeout(long timeout)


Copyright © 2007-2010 IONA Open Source Community. All Rights Reserved.