Package org.apache.activemq.artemis.jms.client

Class ActiveMQMessageConsumer

java.lang.Object

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

All Implemented Interfaces:

MessageConsumer, QueueReceiver, TopicSubscriber, AutoCloseable

public final class ActiveMQMessageConsumer
extends Object
implements QueueReceiver, TopicSubscriber

ActiveMQ Artemis implementation of a JMS MessageConsumer.

Constructor Summary

Constructors

Modifier	Constructor	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	Description
void	close()	Closes the message consumer.
MessageListener	getMessageListener()	Gets the MessageConsumer's MessageListener.
String	getMessageSelector()	Gets this message consumer's message selector expression.
boolean	getNoLocal()	Gets the NoLocal attribute for this subscriber.
Queue	getQueue()	Gets the Queue associated with this queue receiver.
Topic	getTopic()	Gets the Topic associated with this subscriber.
boolean	isClosed()
Message	receive()	Receives the next message produced for this message consumer.
Message	receive(long timeout)	Receives the next message that arrives within the specified timeout interval.
Message	receiveNoWait()	Receives the next message if one is immediately available.
void	setMessageListener(MessageListener listener)	Sets the MessageConsumer's MessageListener.
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 JMSException

Throws:

JMSException

Method Detail

getMessageSelector

public String getMessageSelector()
                          throws JMSException

Description copied from interface: MessageConsumer

Gets this message consumer's message selector expression.

Specified by:

getMessageSelector in interface MessageConsumer

Returns:

this message consumer's message selector, or null if no message selector exists for the message consumer (that is, if the message selector was not set or was set to null or the empty string)

Throws:

JMSException - if the Jakarta Messaging provider fails to get the message selector due to some internal error.

getMessageListener

public MessageListener getMessageListener()
                                   throws JMSException

Description copied from interface: MessageConsumer

Gets the MessageConsumer's MessageListener.

This method must not be used in a Jakarta EE web or EJB application. Doing so may cause a JMSException to be thrown though this is not guaranteed.

Specified by:

getMessageListener in interface MessageConsumer

Returns:

the MessageConsumer's MessageListener, or null if one was not set

Throws:

JMSException - if the Jakarta Messaging provider fails to get the MessageListener for one of the following reasons:

• an internal error has occurred or
• this method has been called in a Jakarta EE web or EJB application (though it is not guaranteed that an exception is thrown in this case)

See Also:

MessageConsumer.setMessageListener(jakarta.jms.MessageListener)

setMessageListener

public void setMessageListener(MessageListener listener)
                        throws JMSException

Description copied from interface: MessageConsumer

Sets the MessageConsumer's MessageListener.

Setting the the MessageListener to null is the equivalent of unsetting the MessageListener for the MessageConsumer.

The effect of calling this method while messages are being consumed by an existing listener or the MessageConsumer is being used to consume messages synchronously is undefined.

This method must not be used in a Jakarta EE web or EJB application. Doing so may cause a JMSException to be thrown though this is not guaranteed.

Specified by:

setMessageListener in interface MessageConsumer

Parameters:

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

Throws:

JMSException - if the Jakarta Messaging provider fails to set the MessageConsumer's MessageListener for one of the following reasons:

• an internal error has occurred or
• this method has been called in a Jakarta EE web or EJB application (though it is not guaranteed that an exception is thrown in this case)

See Also:

MessageConsumer.getMessageListener()

receive

public Message receive()
                throws JMSException

Description copied from interface: MessageConsumer

Receives the next message produced for this message consumer.

This call blocks indefinitely until a message is produced or until this message consumer is closed.

If this receive is done within a transaction, the consumer retains the message until the transaction commits.

Specified by:

receive in interface MessageConsumer

Returns:

the next message produced for this message consumer, or null if this message consumer is concurrently closed

Throws:

JMSException - if the Jakarta Messaging provider fails to receive the next message due to some internal error.

receive

public Message receive(long timeout)
                throws JMSException

Description copied from interface: MessageConsumer

Receives the next message that arrives within the specified timeout interval.

This call blocks until a message arrives, the timeout expires, or this message consumer is closed. A timeout of zero never expires, and the call blocks indefinitely.

Specified by:

receive in interface MessageConsumer

Parameters:

timeout - the timeout value (in milliseconds)

Returns:

the next message produced for this message consumer, or null if the timeout expires or this message consumer is concurrently closed

Throws:

JMSException - if the Jakarta Messaging provider fails to receive the next message due to some internal error.

receiveNoWait

public Message receiveNoWait()
                      throws JMSException

Description copied from interface: MessageConsumer

Receives the next message if one is immediately available.

Specified by:

receiveNoWait in interface MessageConsumer

Returns:

the next message produced for this message consumer, or null if one is not available

Throws:

JMSException - if the Jakarta Messaging provider fails to receive the next message due to some internal error.

close

public void close()
           throws JMSException

Description copied from interface: MessageConsumer

Closes the message consumer.

Since a provider may allocate some resources on behalf of a MessageConsumer outside the Java virtual machine, clients should close them when they are not needed. Relying on garbage collection to eventually reclaim these resources may not be timely enough.

This call will block until a receive call in progress on this consumer has completed. A blocked receive call returns null when this message consumer is closed.

If this method is called whilst a message listener is in progress in another thread then it will block until the message listener has completed.

This method may be called from a message listener's onMessage method on its own consumer. After this method returns the onMessage method will be allowed to complete normally.

This method is the only MessageConsumer method that can be called concurrently.

Specified by:

close in interface AutoCloseable

Specified by:

close in interface MessageConsumer

Throws:

JMSException - if the Jakarta Messaging provider fails to close the consumer due to some internal error.

getQueue

public Queue getQueue()
               throws JMSException

Description copied from interface: QueueReceiver

Gets the Queue associated with this queue receiver.

Specified by:

getQueue in interface QueueReceiver

Returns:

this receiver's Queue

Throws:

JMSException - if the Jakarta Messaging provider fails to get the queue for this queue receiver due to some internal error.

getTopic

public Topic getTopic()
               throws JMSException

Description copied from interface: TopicSubscriber

Gets the Topic associated with this subscriber.

Specified by:

getTopic in interface TopicSubscriber

Returns:

this subscriber's Topic

Throws:

JMSException - if the Jakarta Messaging provider fails to get the topic for this topic subscriber due to some internal error.

getNoLocal

public boolean getNoLocal()
                   throws JMSException

Description copied from interface: TopicSubscriber

Gets the NoLocal attribute for this subscriber. The default value for this attribute is false.

Specified by:

getNoLocal in interface TopicSubscriber

Returns:

true if locally published messages are being inhibited

Throws:

JMSException - if the Jakarta Messaging provider fails to get the NoLocal attribute for this topic subscriber due to some internal error.

toString

public String toString()

Overrides:

toString in class Object

isClosed

public boolean isClosed()