public final class ActiveMQMessageConsumer extends Object implements QueueReceiver, TopicSubscriber
| Modifier | Constructor and Description |
|---|---|
protected |
ActiveMQMessageConsumer(ConnectionFactoryOptions options,
ActiveMQConnection connection,
ActiveMQSession session,
ClientConsumer consumer,
boolean noLocal,
ActiveMQDestination destination,
String selector,
SimpleString autoDeleteQueueName) |
| Modifier and Type | Method and 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() |
protected ActiveMQMessageConsumer(ConnectionFactoryOptions options, ActiveMQConnection connection, ActiveMQSession session, ClientConsumer consumer, boolean noLocal, ActiveMQDestination destination, String selector, SimpleString autoDeleteQueueName) throws JMSException
JMSExceptionpublic String getMessageSelector() throws JMSException
MessageConsumergetMessageSelector in interface MessageConsumerJMSException - if the Jakarta Messaging provider fails to get the message selector due to some internal error.public MessageListener getMessageListener() throws JMSException
MessageConsumerMessageConsumer'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.
getMessageListener in interface MessageConsumerMessageConsumer's MessageListener, or null if one was not setJMSException - if the Jakarta Messaging provider fails to get the MessageListener for one of the following
reasons:
MessageConsumer.setMessageListener(javax.jms.MessageListener)public void setMessageListener(MessageListener listener) throws JMSException
MessageConsumerMessageConsumer'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.
setMessageListener in interface MessageConsumerlistener - the listener to which the messages are to be deliveredJMSException - if the Jakarta Messaging provider fails to set the MessageConsumer's MessageListener for
one of the following reasons:
MessageConsumer.getMessageListener()public Message receive() throws JMSException
MessageConsumerThis 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.
receive in interface MessageConsumerJMSException - if the Jakarta Messaging provider fails to receive the next message due to some internal error.public Message receive(long timeout) throws JMSException
MessageConsumer
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.
receive in interface MessageConsumertimeout - the timeout value (in milliseconds)JMSException - if the Jakarta Messaging provider fails to receive the next message due to some internal error.public Message receiveNoWait() throws JMSException
MessageConsumerreceiveNoWait in interface MessageConsumerJMSException - if the Jakarta Messaging provider fails to receive the next message due to some internal error.public void close()
throws JMSException
MessageConsumer
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.
close in interface AutoCloseableclose in interface MessageConsumerJMSException - if the Jakarta Messaging provider fails to close the consumer due to some internal error.public Queue getQueue() throws JMSException
QueueReceiverQueue associated with this queue receiver.getQueue in interface QueueReceiverQueueJMSException - if the Jakarta Messaging provider fails to get the queue for this queue receiver due to some internal
error.public Topic getTopic() throws JMSException
TopicSubscriberTopic associated with this subscriber.getTopic in interface TopicSubscriberTopicJMSException - if the Jakarta Messaging provider fails to get the topic for this topic subscriber due to some internal
error.public boolean getNoLocal()
throws JMSException
TopicSubscriberNoLocal attribute for this subscriber. The default value for this attribute is false.getNoLocal in interface TopicSubscriberJMSException - if the Jakarta Messaging provider fails to get the NoLocal attribute for this topic subscriber due
to some internal error.public boolean isClosed()
Copyright © 2019 JBoss by Red Hat. All rights reserved.