com.solacesystems.jms

Class SolQueueBrowser

java.lang.Object

com.solacesystems.jms.SolQueueBrowser

All Implemented Interfaces:

SolCloseableIF, SolQueueBrowserIF, QueueBrowser

public class SolQueueBrowser
extends Object
implements SolQueueBrowserIF

Constructor Summary

Constructors

Constructor and Description
SolQueueBrowser(SolSessionIF session, Queue queue, String messageSelector)

Method Summary

Modifier and Type	Method and Description
void	close() Closes the QueueBrowser.
Enumeration<?>	getEnumeration() Gets an enumeration for browsing the current queue messages in the order they would be received.
Browser	getJCSMPBrowser()
String	getMessageSelector() Gets this queue browser's message selector expression.
Queue	getQueue() Gets the queue associated with this queue browser.
int	getTimeout()

Methods inherited from class java.lang.Object

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

Constructor Detail

SolQueueBrowser

public SolQueueBrowser(SolSessionIF session,
                       Queue queue,
                       String messageSelector)
                throws JMSException

Throws:

JMSException

Method Detail

getTimeout

public int getTimeout()

Specified by:

getTimeout in interface SolQueueBrowserIF

close

public void close()
           throws JMSException

Description copied from interface: QueueBrowser

Closes the QueueBrowser.

Since a provider may allocate some resources on behalf of a QueueBrowser 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.

Specified by:

close in interface SolCloseableIF

Specified by:

close in interface QueueBrowser

Throws:

JMSException - if the JMS provider fails to close this browser due to some internal error.

getEnumeration

public Enumeration<?> getEnumeration()
                              throws JMSException

Description copied from interface: QueueBrowser

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

Enumeration.hasMoreElements() Returns true if there's at least one message available in the browser's local message buffer. Note: If this method returns false, it does not mean that the queue is empty; subsequent calls to hasMoreElements or Enumeration.nextElement() might return true and a message respectively.

Note: A properpty SupportedProperty.SOLACE_JMS_BROWSER_TIMEOUT_IN_MS could be used to specify the maximum time in milliseconds for a QueueBrowser Enumeration.hasMoreElements() to wait for a message to arrive in the browser's local message buffer before returning.

Specified by:

getEnumeration in interface QueueBrowser

Returns:

an enumeration for browsing the messages

Throws:

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

See Also:

SupportedProperty.SOLACE_JMS_BROWSER_TIMEOUT_IN_MS

getMessageSelector

public String getMessageSelector()
                          throws JMSException

Description copied from interface: QueueBrowser

Gets this queue browser's message selector expression.

Specified by:

getMessageSelector in interface QueueBrowser

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:

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

getQueue

public Queue getQueue()
               throws JMSException

Description copied from interface: QueueBrowser

Gets the queue associated with this queue browser.

Specified by:

getQueue in interface QueueBrowser

Returns:

the queue

Throws:

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

getJCSMPBrowser

public Browser getJCSMPBrowser()
                        throws JMSException

Specified by:

getJCSMPBrowser in interface SolQueueBrowserIF

Throws:

JMSException