Package com.webmethods.jms.loadbalance.connection

Class WmClusterQueueBrowserImpl

java.lang.Object

com.webmethods.locks.Node

com.webmethods.jms.impl.WmMessageConsumerImpl

com.webmethods.jms.impl.WmQueueReceiverImpl

com.webmethods.jms.impl.WmQueueBrowserImpl

com.webmethods.jms.loadbalance.connection.WmClusterQueueBrowserImpl

All Implemented Interfaces:

ReplyCb, WmMessageConsumer, WmQueueBrowser, WmQueueReceiver, javax.jms.MessageConsumer, javax.jms.QueueBrowser, javax.jms.QueueReceiver

public class WmClusterQueueBrowserImpl
extends WmQueueBrowserImpl

Field Summary

Fields inherited from class com.webmethods.jms.impl.WmMessageConsumerImpl

_closed, _destination, _durableName, _filter, _logApi, _maxReceive, _messageListener, _messageQueue, _noLocal, _protocolHandler, _selector, _session, _sessionID, _suspendedTransactions

Fields inherited from class com.webmethods.locks.Node

_lockManager

Method Summary

Modifier and Type	Method	Description
long	available()	Gets the number of messages on the Broker available to the consumer.
void	close(boolean force, boolean remove)
java.util.Enumeration<WmMessageImpl>	getEnumeration()	Gets an enumeration for browsing the current queue messages in the order they would be received.
java.lang.String	getMessageSelector()	Gets this queue browser's message selector expression.
javax.jms.Queue	getQueue()	Gets the queue associated with this queue browser.

Methods inherited from class com.webmethods.jms.impl.WmQueueBrowserImpl

begin, browse, end, isClosed

Methods inherited from class com.webmethods.jms.impl.WmMessageConsumerImpl

acknowledge, addToPreAckList, autoAcknowledge, availableOnServer, cancelRequestEvents, checkState, checkSynchronous, clear, clientAcknowledge, close, commit, commit, createFilter, deliver, dupsOkAcknowledge, getClientAcknowledgeList, getDestination, getDurableName, getInputStream, getMaxReceive, getMessageListener, getMessageQueue, getSession, getTransactionAckCount, isNoLocal, onMessage, onMessage, onReply, preAckClientList, preAcknowledge, receive, receive, receiveNoWait, removeMessage, removeMessageNoWait, removeMessageWithWait, requestEvents, requestEvents, requestEvents, rollback, setFilter, setMaxReceive, setMessageListener, setMessageListener, setMessageQueue, setTransactionID, setTransactionID, setTransactionTimeout, start, startLocalTransaction, stop, stopAutoAcknowledger, toString, transactedAcknowledge, transactionComplete

Methods inherited from class com.webmethods.locks.Node

getLockManager, getParent

Methods inherited from class java.lang.Object

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

Methods inherited from interface javax.jms.MessageConsumer

getMessageListener, receive, receive, receiveNoWait, setMessageListener

Methods inherited from interface javax.jms.QueueBrowser

close

Methods inherited from interface com.webmethods.jms.WmMessageConsumer

clear, close, getDestination, getInputStream, getMaxReceive, setMaxReceive

Method Detail

available

public long available()
               throws javax.jms.JMSException

Description copied from class: WmMessageConsumerImpl

Gets the number of messages on the Broker available to the consumer. This is an approximate number in that some of the messages may be expired or don't match the consumer's message selector or are already pre-acknowledged..

Specified by:

available in interface WmMessageConsumer

Specified by:

available in interface WmQueueBrowser

Overrides:

available in class WmMessageConsumerImpl

Returns:

the number of messages available to the consumer

Throws:

javax.jms.JMSException - if the JMS provider fails to get the number of available messages.

getQueue

public javax.jms.Queue getQueue()
                         throws javax.jms.JMSException

Gets the queue associated with this queue browser.

Specified by:

getQueue in interface javax.jms.QueueBrowser

Specified by:

getQueue in interface javax.jms.QueueReceiver

Overrides:

getQueue in class WmQueueBrowserImpl

Returns:

the queue

Throws:

javax.jms.JMSException - if the JMS provider fails to get the queue associated with this browser due to some internal error.

getMessageSelector

public java.lang.String getMessageSelector()
                                    throws javax.jms.JMSException

Gets this queue browser's message selector expression.

Specified by:

getMessageSelector in interface javax.jms.MessageConsumer

Specified by:

getMessageSelector in interface javax.jms.QueueBrowser

Overrides:

getMessageSelector in class WmQueueBrowserImpl

Returns:

this queue browser'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:

javax.jms.JMSException - if the JMS provider fails to get the message selector for this browser due to some internal error.

getEnumeration

public java.util.Enumeration<WmMessageImpl> getEnumeration()
                                                    throws javax.jms.JMSException

Gets an enumeration for browsing the current queue messages in the order they would be received.

Specified by:

getEnumeration in interface javax.jms.QueueBrowser

Overrides:

getEnumeration in class WmQueueBrowserImpl

Returns:

an enumeration for browsing the messages

Throws:

javax.jms.JMSException - if the JMS provider fails to get the enumeration for this browser due to some internal error.

close

public void close(boolean force,
                  boolean remove)
           throws javax.jms.JMSException

Overrides:

close in class WmMessageConsumerImpl

Throws:

javax.jms.JMSException