org.jboss.resource.adapter.jms
Class JmsMessageConsumer

java.lang.Object
  org.jboss.resource.adapter.jms.JmsMessageConsumer

All Implemented Interfaces:

MessageConsumer (src)

Direct Known Subclasses:

JmsQueueReceiver (src) , JmsTopicSubscriber (src)

public class JmsMessageConsumer

extends java.lang.Object

implements MessageConsumer (src)

A wrapper for a message consumer

JmsMessageConsumer

public JmsMessageConsumer(MessageConsumer (src)  consumer,
                          JmsSession (src)  session)

Create a new wrapper

Parameters:

consumer - the consumer

session - the session

close

public void close()
           throws JMSException (src) 

Description copied from interface: MessageConsumer (src)

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 blocks until a receive or message listener in progress has completed. A blocked message consumer receive call returns null when this message consumer is closed.

Specified by:

close in interface MessageConsumer (src)

Throws:

JMSException (src) - if the JMS provider fails to close the consumer due to some internal error.

getMessageListener

public MessageListener (src)  getMessageListener()
                                   throws JMSException (src) 

Description copied from interface: MessageConsumer (src)

Gets the message consumer's MessageListener.

Specified by:

getMessageListener in interface MessageConsumer (src)

Returns:

the listener for the message consumer, or null if no listener is set

Throws:

JMSException (src) - if the JMS provider fails to get the message listener due to some internal error.

See Also:

MessageConsumer.setMessageListener(javax.jms.MessageListener)

getMessageSelector

public java.lang.String getMessageSelector()
                                    throws JMSException (src) 

Description copied from interface: MessageConsumer (src)

Gets this message consumer's message selector expression.

Specified by:

getMessageSelector in interface MessageConsumer (src)

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 (src) - if the JMS provider fails to get the message selector due to some internal error.

receive

public Message (src)  receive()
                throws JMSException (src) 

Description copied from interface: MessageConsumer (src)

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 (src)

Returns:

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

Throws:

JMSException (src) - if the JMS provider fails to receive the next message due to some internal error.

receive

public Message (src)  receive(long timeout)
                throws JMSException (src) 

Description copied from interface: MessageConsumer (src)

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 (src)

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 (src) - if the JMS provider fails to receive the next message due to some internal error.

receiveNoWait

public Message (src)  receiveNoWait()
                      throws JMSException (src) 

Description copied from interface: MessageConsumer (src)

Receives the next message if one is immediately available.

Specified by:

receiveNoWait in interface MessageConsumer (src)

Returns:

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

Throws:

JMSException (src) - if the JMS provider fails to receive the next message due to some internal error.

setMessageListener

public void setMessageListener(MessageListener (src)  listener)
                        throws JMSException (src) 

Description copied from interface: MessageConsumer (src)

Sets the message consumer's MessageListener.

Setting the message listener to null is the equivalent of unsetting the message listener for the message consumer.

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

Specified by:

setMessageListener in interface MessageConsumer (src)

Parameters:

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

Throws:

JMSException (src) - if the JMS provider fails to set the message listener due to some internal error.

See Also:

MessageConsumer.getMessageListener()