com.solacesystems.jcsmp

Class CacheSessionProperties

java.lang.Object

com.solacesystems.jcsmp.CacheSessionProperties

All Implemented Interfaces:

Cloneable

public class CacheSessionProperties
extends Object
implements Cloneable

The cache properties used when creating a CacheSession.

Name	Default	Description
cacheName		The name of the cache to send the request to.
maxMsgsPerTopic	1	The maximum number of messages per Topic. 0 means no restriction on number of messages. Valid values [0 - Integer.MAX_VALUE].
maxMsgAge	0	The maximum message age (in seconds). 0 means no restriction on age. Valid values [0 - Integer.MAX_VALUE].
timeout	10000	The timeout for a cache request (in milliseconds). Valid values [3000 - Integer.MAX_VALUE]. This is a protocol timer used internally by the API on each message exchange with solCache. A single call to CacheSession.sendCacheRequest(Long, Topic, boolean, CacheLiveDataAction) may lead to many request-reply exchanges with solCache and so is not bounded by this timer as long as each internal request is satisfied in time.
deliverEvtsThruBlockingRecv	false	If set to True, deliver a cache request complete event through the API's synchronous receive interface.

Field Summary

Fields

Modifier and Type	Field and Description
static String	CachePrefix

Constructor Summary

Constructors

Constructor and Description
CacheSessionProperties(String cacheName) Create CacheProperties with default values of: Maximum messages per topic = 1, Maximum message age in seconds = 0, Timeout for a cache request = 10000.
CacheSessionProperties(String cacheName, int maxMsgsPerTopic, int maxMsgAge, int timeout) Create CacheProperties.
CacheSessionProperties(String cacheName, int maxMsgsPerTopic, int maxMsgAge, int timeout, boolean deliverEvtsThruBlockingRecv) Create CacheProperties.

Method Summary

Modifier and Type	Method and Description
Object	clone()
boolean	deliverEvtsThruBlockingRecv() Gets whether the cache request complete event will be delivered through the API's synchronous receive interface.
boolean	equals(Object obj)
String	getCacheName() Gets the cache name of the cache to send the request to.
Topic	getCacheTopic() Gets the Topic for the cache request.
int	getMaxAge() Gets the maximum message age (in seconds).
int	getMaxMsgs() Gets the maximum messages per Topic.
int	getTimeout() Gets the timeout for a cache request (in milliseconds).
int	hashCode()
void	setCacheName(String cacheName) Sets the cache name of the cache to send the request to.
void	setDeliverEvtsThruBlockingRecv(boolean deliverEvtsThruBlockingRecv) Sets whether to deliver a cache request complete event through the API's synchronous receive interface.
void	setMaxAge(int maxMsgAge) Sets the maximum message age (in seconds).
void	setMaxMsgs(int maxMsgsPerTopic) Sets the maximum messages per Topic.
void	setTimeout(int timeout) Sets the timeout for a cache request (in milliseconds).
String	toString()

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Field Detail

CachePrefix

public static final String CachePrefix

See Also:

Constant Field Values

Constructor Detail

CacheSessionProperties

public CacheSessionProperties(String cacheName)

Create CacheProperties with default values of: Maximum messages per topic = 1, Maximum message age in seconds = 0, Timeout for a cache request = 10000.

Parameters:

cacheName - parameter

CacheSessionProperties

public CacheSessionProperties(String cacheName,
                              int maxMsgsPerTopic,
                              int maxMsgAge,
                              int timeout)

Create CacheProperties.

Parameters:

cacheName - The name of the cache to send the request to.

maxMsgsPerTopic - Maximum messages per Topic. 0 means no restriction on number of messages. Valid values [0 - Integer.MAX_VALUE].

maxMsgAge - The maximum message age (in seconds). 0 means no restriction on age. Valid values [0 - Integer.MAX_VALUE].

timeout - The timeout for a cache request (in milliseconds). Valid values [3000 - Integer.MAX_VALUE].

CacheSessionProperties

public CacheSessionProperties(String cacheName,
                              int maxMsgsPerTopic,
                              int maxMsgAge,
                              int timeout,
                              boolean deliverEvtsThruBlockingRecv)

Create CacheProperties.

Parameters:

cacheName - The name of the cache to send the request to.

maxMsgsPerTopic - The maximum number of messages per Topic. 0 means no restriction on number of messages. Valid values [0 - Integer.MAX_VALUE].

maxMsgAge - The maximum message age (in seconds). 0 means no restriction on age. Valid values [0 - Integer.MAX_VALUE].

timeout - The timeout for a cache request (in milliseconds). Valid values [3000 - Integer.MAX_VALUE].

deliverEvtsThruBlockingRecv - If set to True, deliver a cache request complete event through the API's synchronous receive interface.

Method Detail

getMaxAge

public int getMaxAge()

Gets the maximum message age (in seconds). 0 means no restriction on age.

Returns:

The maximum message age (in seconds). 0 means no restriction on age.

setMaxAge

public void setMaxAge(int maxMsgAge)

Sets the maximum message age (in seconds). 0 means no restriction on age. Valid values [0 - Integer.MAX_VALUE].

Parameters:

maxMsgAge - The maximum message age (in seconds). 0 means no restriction on age.

getMaxMsgs

public int getMaxMsgs()

Gets the maximum messages per Topic. 0 means no restriction on number of messages.

Returns:

The maximum messages per Topic. 0 means no restriction on number of messages.

setMaxMsgs

public void setMaxMsgs(int maxMsgsPerTopic)

Sets the maximum messages per Topic. 0 means no restriction on number of messages. Valid values [0 - Integer.MAX_VALUE].

Parameters:

maxMsgsPerTopic - Maximum messages per topic. 0 means no restriction on number of messages.

getCacheName

public String getCacheName()

Gets the cache name of the cache to send the request to.

Returns:

The cache name of the cache to send the request to.

setCacheName

public void setCacheName(String cacheName)

Sets the cache name of the cache to send the request to.

Parameters:

cacheName - The cache name of the cache to send the request to.

getCacheTopic

public Topic getCacheTopic()

Gets the Topic for the cache request.

Returns:

The Topic for the cache request.

getTimeout

public int getTimeout()

Gets the timeout for a cache request (in milliseconds).

Returns:

The timeout for a cache request (in milliseconds).

setTimeout

public void setTimeout(int timeout)

Sets the timeout for a cache request (in milliseconds). Valid values [3000 - Integer.MAX_VALUE].

This is a protocol timer used internally by the API on each message exchange with solCache. A single call to CacheSession.sendCacheRequest(Long, Topic, boolean, CacheLiveDataAction) may lead to many request-reply exchanges with solCache and so is not bounded by this timer as long as each internal request is satisfied in time.

Parameters:

timeout - The timeout for a cache request (in milliseconds).

deliverEvtsThruBlockingRecv

public boolean deliverEvtsThruBlockingRecv()

Gets whether the cache request complete event will be delivered through the API's synchronous receive interface.

Returns:

True if the cache request complete event will be delivered through the API's synchronous receive interface.

setDeliverEvtsThruBlockingRecv

public void setDeliverEvtsThruBlockingRecv(boolean deliverEvtsThruBlockingRecv)

Sets whether to deliver a cache request complete event through the API's synchronous receive interface.

Parameters:

deliverEvtsThruBlockingRecv - True to send cache request complete events through the receive() api.

clone

public Object clone()

Overrides:

clone in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object