org.mule.jms.commons.internal.consume

Class JmsMessageConsumer

java.lang.Object

org.mule.jms.commons.internal.consume.JmsMessageConsumer

All Implemented Interfaces:

AutoCloseable

public final class JmsMessageConsumer
extends Object
implements AutoCloseable

Wrapper implementation of a JMS MessageConsumer

Since:

1.0

Constructor Summary

Constructors

Constructor and Description
JmsMessageConsumer(javax.jms.MessageConsumer consumer)

Method Summary

Modifier and Type	Method and Description
void	close()
javax.jms.Message	consume(Long maximumWaitTime) Consumes a message in a sync wait.
void	consume(Long maximumWaitTime, javax.jms.CompletionListener completionListener)
void	consume(Long maximumWaitTime, org.mule.runtime.api.scheduler.Scheduler scheduler, javax.jms.CompletionListener completionListener) Consumes a message in a async wait.
javax.jms.MessageConsumer	get()
void	listen(javax.jms.MessageListener listener) Sets the MessageConsumer message listener.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

JmsMessageConsumer

public JmsMessageConsumer(javax.jms.MessageConsumer consumer)

Method Detail

listen

public void listen(javax.jms.MessageListener listener)
            throws javax.jms.JMSException

Sets the MessageConsumer message listener.

Parameters:

listener - the listener to which the messages are to be delivered.

Throws:

javax.jms.JMSException - - if the JMS provider fails to receive the next message due to some internal error.

consume

public javax.jms.Message consume(Long maximumWaitTime)
                          throws javax.jms.JMSException,
                                 JmsTimeoutException

Consumes a message in a sync wait.

Parameters:

maximumWaitTime - Time to wait, in milliseconds, until a timeout is raised.

Returns:

the next Message received by the message consumer, null if the timeout is 0 (message polling).

Throws:

javax.jms.JMSException - - if the JMS provider fails to receive the next message due to some internal error.

JmsTimeoutException - - if no message is received within maximumWaitTime.

consume

public void consume(Long maximumWaitTime,
                    javax.jms.CompletionListener completionListener)

close

public void close()
           throws javax.jms.JMSException

Specified by:

close in interface AutoCloseable

Throws:

javax.jms.JMSException

get

public javax.jms.MessageConsumer get()

consume

public void consume(Long maximumWaitTime,
                    org.mule.runtime.api.scheduler.Scheduler scheduler,
                    javax.jms.CompletionListener completionListener)

Consumes a message in a async wait. The result of the consumption will be communicated to the given CompletionListener.

Parameters:

maximumWaitTime - Time to wait, in milliseconds, until a timeout is raised.

scheduler - Scheduler to create async tasks.

completionListener - Result callback that will be called once the message is received or a error is raised.