com.pcbsys.nirvana.nJMS.TopicConnectionFactoryImpl Class Reference

<Enter Class Description> More...

Inheritance diagram for com.pcbsys.nirvana.nJMS.TopicConnectionFactoryImpl:
com.pcbsys.nirvana.nJMS.ConnectionFactoryImpl

Public Member Functions

javax.jms.TopicConnection createConnection (java.lang.String keyStorePath, java.lang.String keyStorePass, java.lang.String keyStoreCert, java.lang.String trustStorePath, java.lang.String trustStorePass, java.lang.String[] cipherSuite, java.lang.String protocol) throws javax.jms.JMSException
 Creates a topic connection with the default user identity and specified ssl attributes. More...
 
javax.jms.TopicConnection createConnection (java.lang.String userName, java.lang.String password, java.lang.String keyStorePath, java.lang.String keyStorePass, java.lang.String keyStoreCert, java.lang.String trustStorePath, java.lang.String trustStorePass, java.lang.String[] cipherSuite, java.lang.String protocol) throws javax.jms.JMSException
 Creates a topic connection with the specified user identity and specified ssl attributes. More...
 
javax.jms.TopicConnection createTopicConnection () throws javax.jms.JMSException
 <Enter Method Description> More...
 
javax.jms.TopicConnection createTopicConnection (String userName, String password) throws javax.jms.JMSException, javax.jms.JMSSecurityException
 <Enter Method Description> More...
 
Reference getReference () throws NamingException
 Retrieves the Reference of this object. More...
 
 TopicConnectionFactoryImpl (String RNAME)
 <Enter Constructor Description> More...
 
- Public Member Functions inherited from com.pcbsys.nirvana.nJMS.ConnectionFactoryImpl
 ConnectionFactoryImpl ()
 For internal use only.
 
 ConnectionFactoryImpl (String dest)
 For internal use only.
 
 ConnectionFactoryImpl (DestinationImpl dest)
 For internal use only.
 
javax.jms.Connection createConnection () throws javax.jms.JMSException
 Creates a connection with the default user identity. More...
 
javax.jms.Connection createConnection (java.lang.String userName, java.lang.String password) throws javax.jms.JMSException
 Creates a connection with the specified user identity. More...
 
javax.jms.Connection createConnection (java.lang.String keyStorePath, java.lang.String keyStorePass, java.lang.String keyStoreCert, java.lang.String trustStorePath, java.lang.String trustStorePass, java.lang.String[] cipherSuite, java.lang.String protocol) throws javax.jms.JMSException
 Creates a connection with the default user identity and specified ssl attributes. More...
 
javax.jms.Connection createConnection (java.lang.String userName, java.lang.String password, java.lang.String keyStorePath, java.lang.String keyStorePass, java.lang.String keyStoreCert, java.lang.String trustStorePath, java.lang.String trustStorePass, java.lang.String[] cipherSuite, java.lang.String protocol) throws javax.jms.JMSException
 Creates a connection with the specified user identity and specified ssl attributes. More...
 
int getAdapterBuffer ()
 Returns the adapter buffer size for send / receive. More...
 
int getAutoAckCount ()
 With AUTO acknowledgement mode, in order to improve performance, the acknowledgement of messages can be batched so that not every message consumed results in communication with the server. More...
 
boolean getAutoCreateResource ()
 If set will create resources on the server when performing a lookup on a queue or channel. More...
 
boolean getAutoReconnectAfterACL ()
 If a client is disconnected because of a security change, this flag will indicate whether the automatic session reconnection logic wil kick in. More...
 
boolean getBooleanValue (String key, Hashtable eprops) throws Exception
 Returns the value of the specified connection property as a boolean. More...
 
long getConnectionTimeout ()
 Returns the timeout used for connection / reconnection to realms. More...
 
boolean getConxExceptionOnFailure ()
 When enabled, any disconnections from the JMS Connection will not result in an Exception being generated through the ExceptionListener. More...
 
boolean getDisconnectOnClusterFailure ()
 If connected to a cluster of realms, and cluster quorum is lost, this flag determines whether the client will be disconnected. More...
 
nDurableAttributes.nDurableType getDurableType ()
 durable type used by connection factory. More...
 
String[] getEnabledCiphers ()
 Returns the SSL Enabled Ciphers associated with the connection.
 
boolean getEnabledSingleQueueAck ()
 If enabled, queue subscriptions will ack events individually. More...
 
boolean getEnabledSingleSharedDurableAck ()
 If enabled, durable subscriptions will ack events individually. More...
 
boolean getEnableDurablePriority ()
 If enabled, durable subscriptions of the same name can exist on the same topic, but only the 1st in will consume the events for that subscription. More...
 
boolean getEnableMultiplexedConnections ()
 Support the use of a shared physical connection by multiple sessions when the same topic or queue is used by multiple receivers. More...
 
boolean getEnableSerialDurable ()
 If enabled, durable subscriptions of the same name can exist on the same topic, and events will be distributed in a serial manner to each subscriber using that name (ie once and once only per durable name) More...
 
boolean getEnableSharedDurable ()
 If enabled, durable subscriptions of the same name can exist on the same topic, and events will be distributed in a round robin fashion to each subscriber using that name (ie once and once only per durable name) More...
 
int getGlobalStoreCapacity ()
 Each topic or queue store can have a maximum number of messages that can exist before no more messages are allowed to be published. More...
 
int getInitialConnectionRetry ()
 When a connection is first established, the default number of connection attempts is 2. More...
 
int getIntValue (String key, Hashtable eprops) throws Exception
 Returns the value of the specified connection property as an int. More...
 
String getKeyStoreCert ()
 Returns the SSL KeyStore Certificate Alias associated with the connection.
 
String getKeyStorePass ()
 Returns the SSL KeyStorePass associated with the connection.
 
String getKeyStorePath ()
 Returns the SSL KeyStorePath associated with the connection.
 
long getLongValue (String key, Hashtable eprops) throws Exception
 Returns the value of the specified connection property as a long. More...
 
int getMaxReconAttempts ()
 When getConxExceptionOnFailure() is enabled, this value is used to prevent the disconnection exceptions being thrown via the ExceptionListener on the JMS Connection. More...
 
int getMaxRedelivery ()
 Specifies the maximum number of messages that the client will keep reference to if they are marked as redlivered. More...
 
int getMaxUnackedSize ()
 The client will keep a list of messages that have not been acknowledged. More...
 
int getMessageThreadPoolSize ()
 Gets the maximum number of threads used by the client for delivery of all messages to listeners. More...
 
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...
 
int getQueueWindowSize ()
 When synchronously consuming messages from the server, they will be delivered in batches (windows). More...
 
boolean getRandomiseRNames ()
 Allows the list of RNAME urls to be randomised to provide simple load balancing across a list of servers. More...
 
boolean getReconnectImmediately ()
 If a client is disconnected, this flag will indicate whether the client will immediately reconnect and attempt to reconnect as fast as possible, rather than rely on a back off period. More...
 
long getReconnectInterval ()
 If a client is disconnected, this flag will indicate whether the client will immediately reconnect and attempt to reconnect as fast as possible, rather than rely on a back off period. More...
 
Reference getReference () throws NamingException
 Retrieves the Reference of this object. More...
 
boolean getRetryCommit ()
 Determines whether the commit call to a transacted session will retry if any exceptions are detected, rather than simply throw an exception. More...
 
String getRNAME ()
 Returns the RNAME url associated with the connection destination.
 
String getSSLProtocol ()
 Returns the SSL Protocol associated with the connection.
 
int getSyncBatchSize ()
 When file sync is set, you can buffer the sync calls into batches in order to prevent the underlying system from being overloaded during busy periods. More...
 
boolean getSyncNamedTopicAcks ()
 Returns whether durable topic acknowledgements are being sent synchronously. More...
 
boolean getSyncQueueAcks ()
 Returns whether queue acknowledgements are being sent synchronously. More...
 
boolean getSyncSendPersistent ()
 For each persistent message written to the server, ensure the send is a synchronous call. More...
 
int getSyncTime ()
 When file sync is set, you can buffer the sync calls into batches in order to prevent the underlying system from being overloaded during busy periods. More...
 
boolean getSyncTopicAcks ()
 Returns whether topic acknowledgements are being sent synchronously. More...
 
boolean getSyncWrites ()
 For each persistent message written to the server, perform a file system sync to ensure the OS has written the data. More...
 
String getTrustStorePass ()
 Returns the SSL TrustStorePass associated with the connection.
 
String getTrustStorePath ()
 Returns the SSL TrustStorePath associated with the connection.
 
boolean getUseJMSEngine ()
 JMS engine ensures no events are available for topic replay unless durable subscriptions are being used. More...
 
int getWriteHandler ()
 Returns the write handler type. More...
 
boolean isFollowMaster ()
 If set will create resources on the server when performing a lookup on a queue or channel. More...
 
boolean isInfiniteWindow ()
 When using an infinite window size, the consumer will have no upper limit on the number of events they can consume without committing or rolling back.
 
void setAdapterBuffer (int value)
 Specifies for a specific connection the adapter send / receive buffer size. More...
 
void setAutoAckCount (int value)
 With AUTO acknowledgement mode, in order to improve performance, the acknowledgement of messages can be batched so that not every message consumed results in communication with the server. More...
 
void setAutoCreateResource (boolean value)
 If true the client will automatically create resources which do not exist on the server. More...
 
void setAutoReconnectAfterACL (boolean auto)
 If a client is disconnected because of a security change, this flag will indicate whether the automatic session reconnection logic wil kick in. More...
 
void setConnectionTimeout (long value)
 Set the timeout used for connection / reconnection to realms. More...
 
void setConxExceptionOnFailure (boolean conxException)
 When enabled, any disconnections from the JMS Connection will not result in an Exception being generated through the ExceptionListener. More...
 
void setDisconnectOnClusterFailure (boolean value)
 If connected to a cluster of realms, and cluster quorum is lost, this flag determines whether the client will be disconnected. More...
 
void setDurableType (nDurableAttributes.nDurableType type)
 Set the durable types for the connection factories. More...
 
void setEnableDurablePriority (Boolean value)
 If enabled, durable subscriptions of the same name can exist on the same topic, but only the 1st in will consume the events for that subscription. More...
 
void setEnableMultiplexedConnections (boolean value)
 Support the use of a shared physical connection by multiple sessions when the same topic or queue is used by multiple receivers. More...
 
void setEnableSerialDurable (boolean value)
 If enabled, durable subscriptions of the same name can exist on the same topic, and events will be distributed in a serial fashion to each subscriber using that name (ie once and once only per durable name) More...
 
void setEnableSharedDurable (boolean value)
 If enabled, durable subscriptions of the same name can exist on the same topic, and events will be distributed in a round robin fashion to each subscriber using that name (ie once and once only per durable name) More...
 
void setEnableSharedPriority (boolean value)
 If enabled, durable subscriptions of the same name can exist on the same topic, and events will be distributed in a round robin fashion to each subscriber using that name (ie once and once only per durable name) Note: this is a duplicate of setEnableSharedDurable, and will do the same as that. More...
 
void setEnableSingleQueueAck (boolean value)
 If enabled, message acknowledgements on a queue consumer will only acknowledge that specific message rather than all messages consumed prior to that message, on that queue. More...
 
void setEnableSingleSharedDurableAck (boolean value)
 If enabled, message acknowledgements on a shared durable consumer will only acknowledge that specific message rather than all messages consumed prior to that message, on that shared durable. More...
 
void setGlobalStoreCapacity (int value)
 Each topic or queue store can have a maximum number of messages that can exist before no more messages are allowed to be published. More...
 
void setImmediateReconnect (boolean immediate)
 If a client is disconnected, this flag will indicate whether the client will immediately reconnect and attempt to reconnect as fast as possible, rather than rely on a back off period. More...
 
void setInitialConnectionRetry (int value)
 When a connection is first established, the default number of connection attempts is 2. More...
 
void setIsInfiniteWindow (boolean isInfiniteWindow)
 When set to true, the consumer can consume as many events as required before committing. More...
 
void setKeepAlivesMissed (int value)
 Set the number of keep server keep alives the client is allowed to miss before detecting a network issue and terminating the connection. More...
 
void setMaxReconAttempts (int max)
 When getConxExceptionOnFailure() is enabled, this value is used to prevent the disconnection exceptions being thrown via the ExceptionListener on the JMS Connection. More...
 
void setMaxRedelivery (int value)
 Specifies the maximum number of messages that the client will keep reference to if they are marked as redelivered. More...
 
void setMaxUnackedSize (int value)
 The client will keep a list of messages that have not been acknowledged. More...
 
void setMessageThreadPoolSize (int value)
 Sets the maximum number of threads used by the client for delivery of all messages to listeners. More...
 
void setProperties (Hashtable eprops)
 Sets the connection factory properties. More...
 
void setQueueWindowSize (int value)
 When synchronously consuming messages from the server from a queue, they will be delivered in batches (windows). More...
 
void setRandomiseRNames (boolean value)
 Allows the list of RNAME urls to be randomised to provide simple load balancing across a list of servers. More...
 
void setReconnectInterval (long interval)
 If a client is disconnected, and Immediate Reconnect is set to true, this value represents the interval between reconnect attempts. More...
 
void setRetryCommit (boolean value)
 Determines whether the commit call to a transacted session will retry if any exceptions are detected, rather than simply throw an exception. More...
 
void setRNAME (String rname)
 Sets the RNAME url associated with the connection destination. More...
 
void setSSLEnabledCiphers (String[] enabledCiphers)
 Sets the SSL cipher suite associated with the connection factory. More...
 
void setSSLProtocol (String protocol)
 Sets the SSL protocol associated with the connection factory. More...
 
void setSSLStores (String keyStorePath, String keyStorePass, String trustStorePath, String trustStorePass)
 Sets the SSL KeyStore / TrustStore details associated with the connection factory. More...
 
void setSSLStores (String keyStorePath, String keyStorePass, String certificateAlias, String trustStorePath, String trustStorePass)
 Sets the SSL KeyStore / TrustStore details associated with the connection factory. More...
 
void setSyncBatchSize (int value)
 When file sync is set, you can buffer the sync calls into batches in order to prevent the underlying system from being overloaded during busy periods. More...
 
void setSyncNamedTopicAcks (boolean value)
 Specifies for a specific connection whether the durable topic acknowledgements will be sent synchronously. More...
 
void setSyncQueueAcks (boolean value)
 Specifies for a specific connection whether the queue acknowledgements will be sent synchronously. More...
 
void setSyncSendPersistent (boolean value)
 For each persistent message written to the server, ensure the send is a synchronous call. More...
 
void setSyncTime (int value)
 When file sync is set, you can buffer the sync calls into batches in order to prevent the underlying system from being overloaded during busy periods. More...
 
void setSyncTopicAcks (boolean value)
 Specifies for a specific connection whether the topic acknowledgements will be sent synchronously. More...
 
void setSyncWrites (boolean value)
 For each persistent message written to the server, perform a file system sync to ensure the OS has written the data. More...
 
void setUseJMSEngine (boolean value)
 JMS engine ensures no events are available for topic replay unless durable subscriptions are being used. More...
 
void setWriteHandler (int value)
 Specifies for a specific connection the write handler type to use. More...
 

Additional Inherited Members

- Protected Attributes inherited from com.pcbsys.nirvana.nJMS.ConnectionFactoryImpl
String keyStorePath = Constants.getKeyStorePath()
 SSL Related Attributes.
 
DestinationImpl myDestination = null
 <Enter Field Description>
 

Detailed Description

<Enter Class Description>

Constructor & Destructor Documentation

com.pcbsys.nirvana.nJMS.TopicConnectionFactoryImpl.TopicConnectionFactoryImpl ( String  RNAME)

<Enter Constructor Description>

Parameters
RNAME<Enter Parameter Description>

Member Function Documentation

javax.jms.TopicConnection com.pcbsys.nirvana.nJMS.TopicConnectionFactoryImpl.createConnection ( java.lang.String  keyStorePath,
java.lang.String  keyStorePass,
java.lang.String  keyStoreCert,
java.lang.String  trustStorePath,
java.lang.String  trustStorePass,
java.lang.String[]  cipherSuite,
java.lang.String  protocol 
) throws javax.jms.JMSException

Creates a topic connection with the default user identity and specified ssl attributes.

Parameters
keyStorePaththe caller's SSL keystore path
keyStorePassthe caller's SSL keystore password
keyStoreCertthe caller's SSL keystore certificate alias
trustStorePaththe caller's SSL truststore path
trustStorePassthe caller's SSL truststore password
cipherSuitethe caller's SSL enabled ciphersuite
protocolthe caller's SSL protocol
Returns
Topic Connection
Exceptions
JMSExceptionif the JMS provider fails to create a connection due to some internal error.
javax.jms.TopicConnection com.pcbsys.nirvana.nJMS.TopicConnectionFactoryImpl.createConnection ( java.lang.String  userName,
java.lang.String  password,
java.lang.String  keyStorePath,
java.lang.String  keyStorePass,
java.lang.String  keyStoreCert,
java.lang.String  trustStorePath,
java.lang.String  trustStorePass,
java.lang.String[]  cipherSuite,
java.lang.String  protocol 
) throws javax.jms.JMSException

Creates a topic connection with the specified user identity and specified ssl attributes.

Parameters
userNamethe caller's user name
passwordthe caller's password
keyStorePaththe caller's SSL keystore path
keyStorePassthe caller's SSL keystore password
keyStoreCertthe caller's SSL keystore certificate alias
trustStorePaththe caller's SSL truststore path
trustStorePassthe caller's SSL truststore password
cipherSuitethe caller's SSL enabled ciphersuite
protocolthe caller's SSL protocol
Returns
Topic Connection
Exceptions
JMSExceptionif the JMS provider fails to create a connection due to some internal error.
javax.jms.TopicConnection com.pcbsys.nirvana.nJMS.TopicConnectionFactoryImpl.createTopicConnection ( ) throws javax.jms.JMSException

<Enter Method Description>

Returns
<Enter Result Description>
Exceptions
JMSException<Enter Exception Description>
javax.jms.TopicConnection com.pcbsys.nirvana.nJMS.TopicConnectionFactoryImpl.createTopicConnection ( String  userName,
String  password 
) throws javax.jms.JMSException, javax.jms.JMSSecurityException

<Enter Method Description>

Parameters
userName<Enter Parameter Description>
password<Enter Parameter Description>
Returns
<Enter Result Description>
Exceptions
JMSException<Enter Exception Description>
Reference com.pcbsys.nirvana.nJMS.TopicConnectionFactoryImpl.getReference ( ) throws NamingException

Retrieves the Reference of this object.

Returns
The Reference of this object.