org.apache.activemq.artemis.jms.client

Class ActiveMQMessageConsumer

java.lang.Object

org.apache.activemq.artemis.jms.client.ActiveMQMessageConsumer

All Implemented Interfaces:

jakarta.jms.MessageConsumer, jakarta.jms.QueueReceiver, jakarta.jms.TopicSubscriber, AutoCloseable

public final class ActiveMQMessageConsumer
extends Object
implements jakarta.jms.QueueReceiver, jakarta.jms.TopicSubscriber

ActiveMQ Artemis implementation of a JMS MessageConsumer.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	ActiveMQMessageConsumer(ConnectionFactoryOptions options, ActiveMQConnection connection, ActiveMQSession session, ClientConsumer consumer, boolean noLocal, ActiveMQDestination destination, String selector, SimpleString autoDeleteQueueName)

Method Summary

Modifier and Type	Method and Description
void	close()
jakarta.jms.MessageListener	getMessageListener()
String	getMessageSelector()
boolean	getNoLocal()
jakarta.jms.Queue	getQueue()
jakarta.jms.Topic	getTopic()
boolean	isClosed()
jakarta.jms.Message	receive()
jakarta.jms.Message	receive(long timeout)
jakarta.jms.Message	receiveNoWait()
void	setMessageListener(jakarta.jms.MessageListener listener)
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

ActiveMQMessageConsumer

protected ActiveMQMessageConsumer(ConnectionFactoryOptions options,
                                  ActiveMQConnection connection,
                                  ActiveMQSession session,
                                  ClientConsumer consumer,
                                  boolean noLocal,
                                  ActiveMQDestination destination,
                                  String selector,
                                  SimpleString autoDeleteQueueName)
                           throws jakarta.jms.JMSException

Throws:

jakarta.jms.JMSException

Method Detail

getMessageSelector

public String getMessageSelector()
                          throws jakarta.jms.JMSException

Specified by:

getMessageSelector in interface jakarta.jms.MessageConsumer

Throws:

jakarta.jms.JMSException

getMessageListener

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

Specified by:

getMessageListener in interface jakarta.jms.MessageConsumer

Throws:

jakarta.jms.JMSException

setMessageListener

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

Specified by:

setMessageListener in interface jakarta.jms.MessageConsumer

Throws:

jakarta.jms.JMSException

receive

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

Specified by:

receive in interface jakarta.jms.MessageConsumer

Throws:

jakarta.jms.JMSException

receive

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

Specified by:

receive in interface jakarta.jms.MessageConsumer

Throws:

jakarta.jms.JMSException

receiveNoWait

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

Specified by:

receiveNoWait in interface jakarta.jms.MessageConsumer

Throws:

jakarta.jms.JMSException

close

public void close()
           throws jakarta.jms.JMSException

Specified by:

close in interface jakarta.jms.MessageConsumer

Specified by:

close in interface AutoCloseable

Throws:

jakarta.jms.JMSException

getQueue

public jakarta.jms.Queue getQueue()
                           throws jakarta.jms.JMSException

Specified by:

getQueue in interface jakarta.jms.QueueReceiver

Throws:

jakarta.jms.JMSException

getTopic

public jakarta.jms.Topic getTopic()
                           throws jakarta.jms.JMSException

Specified by:

getTopic in interface jakarta.jms.TopicSubscriber

Throws:

jakarta.jms.JMSException

getNoLocal

public boolean getNoLocal()
                   throws jakarta.jms.JMSException

Specified by:

getNoLocal in interface jakarta.jms.TopicSubscriber

Throws:

jakarta.jms.JMSException

toString

public String toString()

Overrides:

toString in class Object

isClosed

public boolean isClosed()