com.pcbsys.nirvana.nJMS.Constants Class Reference

<Enter Class Description> More...

Static Public Member Functions

static boolean attemptReconnectAfterAccessChange ()
 Returns whether a JMS Connection will attempt to reconnect to the realm after the realm ACL has been revoked. More...
 
static boolean attemptReconnectImmediately ()
 Returns whether a nirvana nSession will attempt to immediately reconnect or whether reconnection attempts will back off over time to prevent a network storm where multiple re-connections can occur all at once. More...
 
static long getConnectionTimeout ()
 Returns the timeout used for connection / reconnection to realms. More...
 
static int getInitialConnectionRetryCount ()
 Returns the number of attempts made to initially connect to the realm server(s) More...
 
static int getMaxReconAttempts ()
 Returns the maximum number of attempts for reconnection before throwing an exception. More...
 
static int getPermittedKeepAlivesMissed ()
 Returns the number of keep server keep alives the client is allowed to miss before detecting a network issue and terminating the connection. More...
 
static long getReconnectInterval ()
 Returns the interval value to use between reconnect attempts when the session is set to reconnect immediately. More...
 
static void setConnectionTimeout (long timeout)
 Set the timeout used for connection / reconnection to realms. More...
 
static void setInitialConnectionRetryCount (int count)
 Set the number of attempts made to initially connect to the realm server(s) More...
 
static void setMaxReconAttempts (int max)
 Set the maximum number of attempts for reconnection before throwing an exception. More...
 
static void setPermittedKeepAlivesMissed (int keepalives)
 Set the number of keep server keep alives the client is allowed to miss before detecting a network issue and terminating the connection. More...
 
static void setReconnectAfterAccessChange (boolean recon)
 Sets whether a JMS Connection will attempt to reconnect to the realm after the realm ACL has been revoked. More...
 
static void setReconnectImmediately (boolean recon)
 Sets whether a nirvana nSession will attempt to immediately reconnect or whether reconnection attempts will back off over time to prevent a network storm where multiple re-connections can occur all at once. More...
 
static void setReconnectInterval (long interval)
 Sets the interval to use between reconnect attempts when the session is set to reconnect immediately. More...
 

Static Public Attributes

static final int JMSMajorVersion = 1
 <Enter Field Description>
 
static final int JMSMinorVersion = 1
 <Enter Field Description>
 
static final String JMSProviderName = "my-channels"
 <Enter Field Description>
 
static final String JMSVersion = "1.1"
 <Enter Field Description>
 
static final int ProviderMajorVersion = -1000000
 <Enter Field Description>
 
static final int ProviderMinorVersion = -2000000
 <Enter Field Description>
 
static final String ProviderVersion
 <Enter Field Description>
 

Detailed Description

<Enter Class Description>

Member Function Documentation

static boolean com.pcbsys.nirvana.nJMS.Constants.attemptReconnectAfterAccessChange ( )
static

Returns whether a JMS Connection will attempt to reconnect to the realm after the realm ACL has been revoked.

By default, the connection will not reconnect after one of these incidents, and a manual restart would need to be initiated

Returns
true if reconnect is enabled after realm ACL subject revocation
static boolean com.pcbsys.nirvana.nJMS.Constants.attemptReconnectImmediately ( )
static

Returns whether a nirvana nSession will attempt to immediately reconnect or whether reconnection attempts will back off over time to prevent a network storm where multiple re-connections can occur all at once.

Returns
true if reconnect immediately is enabled
static long com.pcbsys.nirvana.nJMS.Constants.getConnectionTimeout ( )
static

Returns the timeout used for connection / reconnection to realms.

If the conenction fails to establish within this timeframe it will fail.

Returns
the number of milliseconds to allow for a connection / reconnection
static int com.pcbsys.nirvana.nJMS.Constants.getInitialConnectionRetryCount ( )
static

Returns the number of attempts made to initially connect to the realm server(s)

Returns
the number of initial connection retry attempts
static int com.pcbsys.nirvana.nJMS.Constants.getMaxReconAttempts ( )
static

Returns the maximum number of attempts for reconnection before throwing an exception.

This value will only be used when getConxExceptionOnFailure is true.

Returns
the maximum number of reconnection attempts to make before giving up, default is -1, ie no max
static int com.pcbsys.nirvana.nJMS.Constants.getPermittedKeepAlivesMissed ( )
static

Returns the number of keep server keep alives the client is allowed to miss before detecting a network issue and terminating the connection.

Returns
the number of permitted server keep alives to be missed before termination of connection
static long com.pcbsys.nirvana.nJMS.Constants.getReconnectInterval ( )
static

Returns the interval value to use between reconnect attempts when the session is set to reconnect immediately.

Returns
true if reconnect immediately is enabled
static void com.pcbsys.nirvana.nJMS.Constants.setConnectionTimeout ( long  timeout)
static

Set the timeout used for connection / reconnection to realms.

If the conenction fails to establish within this timeframe it will fail.

Parameters
timeout- the number of milliseconds to allow for connection to be established
static void com.pcbsys.nirvana.nJMS.Constants.setInitialConnectionRetryCount ( int  count)
static

Set the number of attempts made to initially connect to the realm server(s)

Parameters
count- the number of initial conection attempts
static void com.pcbsys.nirvana.nJMS.Constants.setMaxReconAttempts ( int  max)
static

Set the maximum number of attempts for reconnection before throwing an exception.

This value will only be used when getConxExceptionOnFailure is true.

Parameters
max- the maximum number of reconnection attempts to make before giving up, default is -1, ie no max
static void com.pcbsys.nirvana.nJMS.Constants.setPermittedKeepAlivesMissed ( int  keepalives)
static

Set the number of keep server keep alives the client is allowed to miss before detecting a network issue and terminating the connection.

Parameters
keepalives- the number of permitted server keep alives to be missed before termination of connection
static void com.pcbsys.nirvana.nJMS.Constants.setReconnectAfterAccessChange ( boolean  recon)
static

Sets whether a JMS Connection will attempt to reconnect to the realm after the realm ACL has been revoked.

By default, the connection will not reconnect after one of these incidents, and a manual restart would need to be initiated

Parameters
recontrue - will reconnect continually until successful, false, will disabled reconnect
static void com.pcbsys.nirvana.nJMS.Constants.setReconnectImmediately ( boolean  recon)
static

Sets whether a nirvana nSession will attempt to immediately reconnect or whether reconnection attempts will back off over time to prevent a network storm where multiple re-connections can occur all at once.

Parameters
recontrue - will reconnect immediately, and use the value set in
static void com.pcbsys.nirvana.nJMS.Constants.setReconnectInterval ( long  interval)
static

Sets the interval to use between reconnect attempts when the session is set to reconnect immediately.

Parameters
intervalvalue in milliseconds specifying the interval between reconnect attempts