pack-priv Class CachedMessageConsumer

Implements jakarta.jms.MessageConsumer.close.

Doc from jakarta.jms.MessageConsumer.close.

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.

Annotations

@Override

Exceptions

JMSException:

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

Implements jakarta.jms.MessageConsumer.getMessageListener.

Doc from jakarta.jms.MessageConsumer.getMessageListener.

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.

Returns:MessageListener

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

Annotations

@Override

Exceptions

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)

Implements jakarta.jms.MessageConsumer.getMessageSelector.

Doc from jakarta.jms.MessageConsumer.getMessageSelector.

Gets this message consumer's message selector expression.

Returns:String

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)

Annotations

@Override

Exceptions

JMSException:

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

Implements jakarta.jms.TopicSubscriber.getNoLocal.

Doc from jakarta.jms.TopicSubscriber.getNoLocal.

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

Returns:boolean

true if locally published messages are being inhibited

Annotations

@Override

Exceptions

JMSException:

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

Implements jakarta.jms.QueueReceiver.getQueue.

Doc from jakarta.jms.QueueReceiver.getQueue.

Gets the Queue associated with this queue receiver.

Returns:Queue

this receiver's Queue

Annotations

@Override

@Nullable

Exceptions

JMSException:

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

Implements jakarta.jms.TopicSubscriber.getTopic.

Doc from jakarta.jms.TopicSubscriber.getTopic.

Gets the Topic associated with this subscriber.

Returns:Topic

this subscriber's Topic

Annotations

@Override

@Nullable

Exceptions

JMSException:

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

Implements jakarta.jms.MessageConsumer.receive.

Doc from jakarta.jms.MessageConsumer.receive.

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.

Returns:Message

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

Annotations

@Override

Exceptions

JMSException:

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

Implements jakarta.jms.MessageConsumer.receive.

Doc from jakarta.jms.MessageConsumer.receive.

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.

Parameters

timeout:long

the timeout value (in milliseconds)

Returns:Message

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

Annotations

@Override

Exceptions

JMSException:

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

Implements jakarta.jms.MessageConsumer.receiveNoWait.

Doc from jakarta.jms.MessageConsumer.receiveNoWait.

Receives the next message if one is immediately available.

Returns:Message

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

Annotations

@Override

Exceptions

JMSException:

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

Implements jakarta.jms.MessageConsumer.setMessageListener.

Doc from jakarta.jms.MessageConsumer.setMessageListener.

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.

Parameters

messageListener:MessageListener

the listener to which the messages are to be delivered

Annotations

@Override

Exceptions

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)

Overrides java.lang.Object.toString.

Doc from java.lang.Object.toString.

Returns a string representation of the object. Satisfying this method's contract implies a non-null result must be returned.

Returns:String

a string representation of the object

Annotations

@Override