Package org.apache.activemq.artemis.ra

Class ActiveMQRAMessageConsumer

java.lang.Object

org.apache.activemq.artemis.ra.ActiveMQRAMessageConsumer

All Implemented Interfaces:

jakarta.jms.MessageConsumer, AutoCloseable

Direct Known Subclasses:

ActiveMQRAQueueReceiver, ActiveMQRATopicSubscriber

public class ActiveMQRAMessageConsumer
extends Object
implements jakarta.jms.MessageConsumer

A wrapper for a message consumer

Field Summary

Fields

Modifier and Type	Field	Description
protected jakarta.jms.MessageConsumer	consumer	The wrapped message consumer
protected ActiveMQRASession	session	The session for this consumer

Constructor Summary

Constructors

Constructor	Description
ActiveMQRAMessageConsumer(jakarta.jms.MessageConsumer consumer, ActiveMQRASession session)	Create a new wrapper

Method Summary

Modifier and Type	Method	Description
void	close()	Close
jakarta.jms.MessageListener	getMessageListener()	Get message listener
String	getMessageSelector()	Get message selector
jakarta.jms.Message	receive()	Receive
jakarta.jms.Message	receive(long timeout)	Receive
jakarta.jms.Message	receiveNoWait()	Receive
void	setMessageListener(jakarta.jms.MessageListener listener)	Set message listener

Methods inherited from class java.lang.Object

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

Field Detail

consumer

protected jakarta.jms.MessageConsumer consumer

The wrapped message consumer

session

protected ActiveMQRASession session

The session for this consumer

Constructor Detail

ActiveMQRAMessageConsumer

public ActiveMQRAMessageConsumer(jakarta.jms.MessageConsumer consumer,
                                 ActiveMQRASession session)

Create a new wrapper

Parameters:

consumer - the consumer

session - the session

Method Detail

close

public void close()
           throws jakarta.jms.JMSException

Close

Specified by:

close in interface AutoCloseable

Specified by:

close in interface jakarta.jms.MessageConsumer

Throws:

jakarta.jms.JMSException - Thrown if an error occurs

getMessageListener

public jakarta.jms.MessageListener getMessageListener()
                                               throws jakarta.jms.JMSException

Get message listener

Specified by:

getMessageListener in interface jakarta.jms.MessageConsumer

Returns:

The listener

Throws:

jakarta.jms.JMSException - Thrown if an error occurs

setMessageListener

public void setMessageListener(jakarta.jms.MessageListener listener)
                        throws jakarta.jms.JMSException

Set message listener

Specified by:

setMessageListener in interface jakarta.jms.MessageConsumer

Parameters:

listener - The listener

Throws:

jakarta.jms.JMSException - Thrown if an error occurs

getMessageSelector

public String getMessageSelector()
                          throws jakarta.jms.JMSException

Get message selector

Specified by:

getMessageSelector in interface jakarta.jms.MessageConsumer

Returns:

The selector

Throws:

jakarta.jms.JMSException - Thrown if an error occurs

receive

public jakarta.jms.Message receive()
                            throws jakarta.jms.JMSException

Receive

Specified by:

receive in interface jakarta.jms.MessageConsumer

Returns:

The message

Throws:

jakarta.jms.JMSException - Thrown if an error occurs

receive

public jakarta.jms.Message receive(long timeout)
                            throws jakarta.jms.JMSException

Receive

Specified by:

receive in interface jakarta.jms.MessageConsumer

Parameters:

timeout - The timeout value

Returns:

The message

Throws:

jakarta.jms.JMSException - Thrown if an error occurs

receiveNoWait

public jakarta.jms.Message receiveNoWait()
                                  throws jakarta.jms.JMSException

Receive

Specified by:

receiveNoWait in interface jakarta.jms.MessageConsumer

Returns:

The message

Throws:

jakarta.jms.JMSException - Thrown if an error occurs