com.solacesystems.jcsmp.impl

Class BrowserImpl

java.lang.Object

com.solacesystems.jcsmp.impl.BrowserImpl

All Implemented Interfaces:

Browser

public class BrowserImpl
extends Object
implements Browser

Constructor Summary

Constructors

Constructor and Description
BrowserImpl(BrowserProperties props, FlowReceiver receiver)

Method Summary

Modifier and Type	Method and Description
void	close() Closes the Browser.
BytesXMLMessage	getNext() Retrieve the next message from the Browser's local message buffer, if one is available, waiting if necessary up to the timeout configured in BrowserProperties.
BytesXMLMessage	getNext(int timeoutInMillis) Retrieve the next message from the Browser's local message buffer, if one is available, waiting if necessary up to timeoutInMillis ms.
BytesXMLMessage	getNextNoWait() If there is at least one message available in the Browser's local message buffer, return it immediately; otherwise, return null.
boolean	hasMore() Returns true if there is at least one message available in the Browser's local message buffer.
void	remove(BytesXMLMessage message) Remove a message from the appliance's Queue Endpoint.
void	setFlowReceiver(FlowReceiver receiver)

Methods inherited from class java.lang.Object

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

Constructor Detail

BrowserImpl

public BrowserImpl(BrowserProperties props,
                   FlowReceiver receiver)

Method Detail

close

public void close()

Description copied from interface: Browser

Closes the Browser.

Specified by:

close in interface Browser

setFlowReceiver

public void setFlowReceiver(FlowReceiver receiver)

getNext

public BytesXMLMessage getNext()
                        throws JCSMPException

Description copied from interface: Browser

Retrieve the next message from the Browser's local message buffer, if one is available, waiting if necessary up to the timeout configured in BrowserProperties. If you want to wait indefinitely, use Browser.getNext(int) with a timeoutInMillis of 0.

Specified by:

getNext in interface Browser

Returns:

A message from the Browser's local message buffer or null, if timed out.

Throws:

JCSMPException - on error

getNext

public BytesXMLMessage getNext(int timeoutInMillis)
                        throws JCSMPException

Description copied from interface: Browser

Retrieve the next message from the Browser's local message buffer, if one is available, waiting if necessary up to timeoutInMillis ms.

• If timeout is < 0, return immediately if there are no messages available locally.
• If timeout is equal to 0, wait forever. This blocks the calling thread; to unblock it, call Browser.close().

Specified by:

getNext in interface Browser

Parameters:

timeoutInMillis - Time to wait for a message.

Returns:

A message from the Browser's local message buffer, or null, if timed out.

Throws:

JCSMPException - on error

getNextNoWait

public BytesXMLMessage getNextNoWait()
                              throws JCSMPException

Description copied from interface: Browser

If there is at least one message available in the Browser's local message buffer, return it immediately; otherwise, return null.

Specified by:

getNextNoWait in interface Browser

Returns:

A message from the Browsers local message buffer, or null, if none.

Throws:

JCSMPException - on error

hasMore

public boolean hasMore()
                throws JCSMPException

Description copied from interface: Browser

Returns true if there is 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 Browser.hasMore() or Browser.getNext() might return true and a message respectively.

Specified by:

hasMore in interface Browser

Returns:

True, if there is at least one message available in the Browser's local message buffer.

Throws:

JCSMPException - on error

remove

public void remove(BytesXMLMessage message)
            throws JCSMPException

Description copied from interface: Browser

Remove a message from the appliance's Queue Endpoint.

Specified by:

remove in interface Browser

Parameters:

message - Message to remove from the Endpoint.

Throws:

JCSMPException - on error