JBossConsumer

Overview

Package

Class

Tree

Deprecated

Index

Help

PREV CLASS (src) NEXT CLASS (src)

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

org.jboss.jms.client
Class JBossConsumer

java.lang.Object
  org.jboss.jms.client.JBossConsumer

All Implemented Interfaces:: MessageConsumer (src) , QueueReceiver (src) , TopicSubscriber (src)

public class JBossConsumer
extends java.lang.Object
implements MessageConsumer (src) , QueueReceiver (src) , TopicSubscriber (src)

A consumer

Constructor Summary
`JBossConsumer(ConsumerDelegate (src) delegate, Destination (src) destination, java.lang.String selector, boolean noLocal)` Create a new JBossBrowser

Method Summary
`void`	`close()` Closes the message consumer.
`Destination (src)`	`getDestination()`
`MessageListener (src)`	`getMessageListener()` Gets the message consumer's `MessageListener`.
`java.lang.String`	`getMessageSelector()` Gets this message consumer's message selector expression.
`boolean`	`getNoLocal()` Gets the `NoLocal` attribute for this subscriber.
`Queue (src)`	`getQueue()` Gets the `Queue` associated with this queue receiver.
`Topic (src)`	`getTopic()` Gets the `Topic` associated with this subscriber.
`Message (src)`	`receive()` Receives the next message produced for this message consumer.
`Message (src)`	`receive(long timeout)` Receives the next message that arrives within the specified timeout interval.
`Message (src)`	`receiveNoWait()` Receives the next message if one is immediately available.
`void`	`setMessageListener(MessageListener (src) listener)` Sets the message consumer's `MessageListener`.

Methods inherited from class java.lang.Object

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

Constructor Detail

JBossConsumer

public JBossConsumer(ConsumerDelegate (src)  delegate,
                     Destination (src)  destination,
                     java.lang.String selector,
                     boolean noLocal)
              throws JMSException (src)

Create a new JBossBrowser
Parameters:: delegate - the delegate; destination - the destination; selector - the selector; noLocal - the no local flag
Throws:: JMSException (src) - for any error

Method Detail

getDestination

public Destination (src)  getDestination()
                           throws JMSException (src)

Throws:: JMSException (src)

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

getQueue

public Queue (src)  getQueue()
               throws JMSException (src)

Description copied from interface: QueueReceiver (src)

Gets the Queue associated with this queue receiver.

Specified by:: getQueue in interface QueueReceiver (src)

Returns:: this receiver's Queue
Throws:: JMSException (src) - if the JMS provider fails to get the queue for this queue receiver due to some internal error.

getNoLocal

public boolean getNoLocal()
                   throws JMSException (src)

Description copied from interface: TopicSubscriber (src)

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

Specified by:: getNoLocal in interface TopicSubscriber (src)

Returns:: true if locally published messages are being inhibited
Throws:: JMSException (src) - if the JMS provider fails to get the NoLocal attribute for this topic subscriber due to some internal error.

getTopic

public Topic (src)  getTopic()
               throws JMSException (src)

Description copied from interface: TopicSubscriber (src)

Gets the Topic associated with this subscriber.

Specified by:: getTopic in interface TopicSubscriber (src)

Returns:: this subscriber's Topic
Throws:: JMSException (src) - if the JMS provider fails to get the topic for this topic subscriber due to some internal error.