com.solacesystems.jcsmp

Class BrowserProperties

java.lang.Object

com.solacesystems.jcsmp.BrowserProperties

public class BrowserProperties
extends Object

Properties used for the creation of a Browser.

Constructor Summary

Constructors

Constructor and Description
BrowserProperties() Constructs BrowserProperties with default values.

Method Summary

Modifier and Type	Method and Description
Endpoint	getEndpoint() Returns the Endpoint to browse.
int	getReconnectRetryIntervalInMsecs() Gets how much time (in ms) to wait between each attempt to reconnect to an endpoint.
int	getReconnectTries() Gets number of times to attempt to reconnect to an endpoint after the initial bound flow goes down.
String	getSelector() Returns the browse selector string.
int	getTransportWindowSize() The TransportWindowSize affects the number of local messages that are pre-fetched by the Browser.
int	getWaitTimeout() Returns the WaitTimeout in msecs.
BrowserProperties	setEndpoint(Endpoint endpoint) Sets the Endpoint to browse.
BrowserProperties	setReconnectRetryIntervalInMsecs(int val) This property specifies how much time (in ms) to wait between each attempt to reconnect to an endpoint.
BrowserProperties	setReconnectTries(int count) This property specifies the number of times to attempt to reconnect to an endpoint after the initial bound flow goes down.
BrowserProperties	setSelector(String selector) Sets the browse selector.
void	setTransportWindowSize(int transportWindowSize) The TransportWindowSize affects the number of local messages that are pre-fetched by the Browser.
BrowserProperties	setWaitTimeout(int waitTimeout) Sets the WaitTimeout in msecs.

Methods inherited from class java.lang.Object

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

Constructor Detail

BrowserProperties

public BrowserProperties()

Constructs BrowserProperties with default values. BrowserProperties.setEndpoint(Endpoint) must be called before using this to create a Browser.

Method Detail

getEndpoint

public Endpoint getEndpoint()

Returns the Endpoint to browse. The only Endpoint type currently supported is Queue.

Returns:

The Endpoint to browse.

setEndpoint

public BrowserProperties setEndpoint(Endpoint endpoint)

Sets the Endpoint to browse. The only Endpoint type currently supported is Queue.

Parameters:

endpoint - The Endpoint to browse.

getSelector

public String getSelector()

Returns the browse selector string.

Returns:

null if not specified

setSelector

public BrowserProperties setSelector(String selector)

Sets the browse selector.

Parameters:

selector - Selector string, null for unspecified

getWaitTimeout

public int getWaitTimeout()

Returns the WaitTimeout in msecs. When calling getNext(), the calling thread is blocked for up to this wait timeout value, if no messages become available in the local API message buffer. The default is 10000 msecs. Valid range is [50...]

Returns:

The WaitTimeout in msecs.

setWaitTimeout

public BrowserProperties setWaitTimeout(int waitTimeout)

Sets the WaitTimeout in msecs. When calling getNext(), the calling thread is blocked up to this wait timeout value, if no messages become available in the local API message buffer. The default is 10000 msecs. Valid range is [50...]

Parameters:

waitTimeout - The WaitTimeout in msecs. Valid range is [50...]

getTransportWindowSize

public int getTransportWindowSize()

The TransportWindowSize affects the number of local messages that are pre-fetched by the Browser. The default is 255 Valid range is [1..255]

Returns:

The TransportWindowSize.

setTransportWindowSize

public void setTransportWindowSize(int transportWindowSize)

The TransportWindowSize affects the number of local messages that are pre-fetched by the Browser. The default is 255 Valid range is [1..255]

Parameters:

transportWindowSize - The TransportWindowSize. Valid range is [1..255].

getReconnectTries

public int getReconnectTries()

Gets number of times to attempt to reconnect to an endpoint after the initial bound flow goes down.

Returns:

number of reconnect attempts.

setReconnectTries

public BrowserProperties setReconnectTries(int count)

This property specifies the number of times to attempt to reconnect to an endpoint after the initial bound flow goes down. Valid values are >= -1. -1 means "retry forever". 0 means no automatic reconnection retries. The default value is-1.

getReconnectRetryIntervalInMsecs

public int getReconnectRetryIntervalInMsecs()

Gets how much time (in ms) to wait between each attempt to reconnect to an endpoint.

Returns:

How much time (in ms) to wait between each attempt

setReconnectRetryIntervalInMsecs

public BrowserProperties setReconnectRetryIntervalInMsecs(int val)

This property specifies how much time (in ms) to wait between each attempt to reconnect to an endpoint. Valid values are >= 50. The default value is 3000.