- com
- pcbsys
- nirvana
- nJMS
- ConnectionFactoryImpl
A ConnectionFactory object encapsulates a set of connection configuration parameters that has been defined by an administrator. More...
Public Member Functions | |
| 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... | |
Protected Attributes | |
| String | keyStorePath = Constants.getKeyStorePath() |
| SSL Related Attributes. | |
| DestinationImpl | myDestination = null |
| <Enter Field Description> | |
A ConnectionFactory object encapsulates a set of connection configuration parameters that has been defined by an administrator.
A client uses it to create a connection with a JMS server.
| javax.jms.Connection com.pcbsys.nirvana.nJMS.ConnectionFactoryImpl.createConnection | ( | ) | throws javax.jms.JMSException |
Creates a connection with the default user identity.
| JMSException | if the JMS provider fails to create a topic connection due to some internal error. |
| javax.jms.Connection com.pcbsys.nirvana.nJMS.ConnectionFactoryImpl.createConnection | ( | java.lang.String | userName, |
| java.lang.String | password | ||
| ) | throws javax.jms.JMSException |
Creates a connection with the specified user identity.
| userName | the caller's user name |
| password | the caller's password |
| JMSException | if the JMS provider fails to create a topic connection due to some internal error. |
| javax.jms.Connection com.pcbsys.nirvana.nJMS.ConnectionFactoryImpl.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.
| keyStorePath | the caller's SSL keystore path |
| keyStorePass | the caller's SSL keystore password |
| keyStoreCert | the caller's SSL keystore certificate alias |
| trustStorePath | the caller's SSL truststore path |
| trustStorePass | the caller's SSL truststore password |
| cipherSuite | the caller's SSL enabled ciphersuite |
| protocol | the caller's SSL protocol |
| JMSException | if the JMS provider fails to create a connection due to some internal error. |
| javax.jms.Connection com.pcbsys.nirvana.nJMS.ConnectionFactoryImpl.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.
| userName | the caller's user name |
| password | the caller's password |
| keyStorePath | the caller's SSL keystore path |
| keyStorePass | the caller's SSL keystore password |
| keyStoreCert | the caller's SSL keystore certificate alias |
| trustStorePath | the caller's SSL truststore path |
| trustStorePass | the caller's SSL truststore password |
| cipherSuite | the caller's SSL enabled ciphersuite |
| protocol | the caller's SSL protocol |
| JMSException | if the JMS provider fails to create a connection due to some internal error. |
| int com.pcbsys.nirvana.nJMS.ConnectionFactoryImpl.getAdapterBuffer | ( | ) |
Returns the adapter buffer size for send / receive.
| int com.pcbsys.nirvana.nJMS.ConnectionFactoryImpl.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.
This value determines how many events can be consumed before an acknowledgement is sent to the server
| boolean com.pcbsys.nirvana.nJMS.ConnectionFactoryImpl.getAutoCreateResource | ( | ) |
If set will create resources on the server when performing a lookup on a queue or channel.
| boolean com.pcbsys.nirvana.nJMS.ConnectionFactoryImpl.getAutoReconnectAfterACL | ( | ) |
If a client is disconnected because of a security change, this flag will indicate whether the automatic session reconnection logic wil kick in.
| boolean com.pcbsys.nirvana.nJMS.ConnectionFactoryImpl.getBooleanValue | ( | String | key, |
| Hashtable | eprops | ||
| ) | throws Exception |
Returns the value of the specified connection property as a boolean.
| key | the connection property name |
| eprops | the Hashtable instance containing connection properties |
| Exception | if the specified key is not found or if an error occurs in the conversion |
| long com.pcbsys.nirvana.nJMS.ConnectionFactoryImpl.getConnectionTimeout | ( | ) |
Returns the timeout used for connection / reconnection to realms.
If the connection fails to establish within this timeframe it will fail.
| boolean com.pcbsys.nirvana.nJMS.ConnectionFactoryImpl.getConxExceptionOnFailure | ( | ) |
When enabled, any disconnections from the JMS Connection will not result in an Exception being generated through the ExceptionListener.
An exception will only be thrown to the ExceptionListener when the getMaxReconAttempts() value is reached.
| boolean com.pcbsys.nirvana.nJMS.ConnectionFactoryImpl.getDisconnectOnClusterFailure | ( | ) |
If connected to a cluster of realms, and cluster quorum is lost, this flag determines whether the client will be disconnected.
| nDurableAttributes.nDurableType com.pcbsys.nirvana.nJMS.ConnectionFactoryImpl.getDurableType | ( | ) |
durable type used by connection factory.
| boolean com.pcbsys.nirvana.nJMS.ConnectionFactoryImpl.getEnabledSingleQueueAck | ( | ) |
If enabled, queue subscriptions will ack events individually.
| boolean com.pcbsys.nirvana.nJMS.ConnectionFactoryImpl.getEnabledSingleSharedDurableAck | ( | ) |
If enabled, durable subscriptions will ack events individually.
| boolean com.pcbsys.nirvana.nJMS.ConnectionFactoryImpl.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.
This value is overruled by enableSharedDurable, and if that is true, a shared durable will be created rather than a priority durable
| boolean com.pcbsys.nirvana.nJMS.ConnectionFactoryImpl.getEnableMultiplexedConnections | ( | ) |
Support the use of a shared physical connection by multiple sessions when the same topic or queue is used by multiple receivers.
| boolean com.pcbsys.nirvana.nJMS.ConnectionFactoryImpl.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)
| boolean com.pcbsys.nirvana.nJMS.ConnectionFactoryImpl.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)
| int com.pcbsys.nirvana.nJMS.ConnectionFactoryImpl.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.
| int com.pcbsys.nirvana.nJMS.ConnectionFactoryImpl.getInitialConnectionRetry | ( | ) |
When a connection is first established, the default number of connection attempts is 2.
This allows this value to be overridden.
| int com.pcbsys.nirvana.nJMS.ConnectionFactoryImpl.getIntValue | ( | String | key, |
| Hashtable | eprops | ||
| ) | throws Exception |
Returns the value of the specified connection property as an int.
| key | the connection property name |
| eprops | the Hashtable instance containing connection properties |
| Exception | if the specified key is not found or if an error occurs in the conversion |
| long com.pcbsys.nirvana.nJMS.ConnectionFactoryImpl.getLongValue | ( | String | key, |
| Hashtable | eprops | ||
| ) | throws Exception |
Returns the value of the specified connection property as a long.
| key | the connection property name |
| eprops | the Hashtable instance containing connection properties |
| Exception | if the specified key is not found or if an error occurs in the conversion |
| int com.pcbsys.nirvana.nJMS.ConnectionFactoryImpl.getMaxReconAttempts | ( | ) |
When getConxExceptionOnFailure() is enabled, this value is used to prevent the disconnection exceptions being thrown via the ExceptionListener on the JMS Connection.
The default value is -1, which represents infinite retries.
| int com.pcbsys.nirvana.nJMS.ConnectionFactoryImpl.getMaxRedelivery | ( | ) |
Specifies the maximum number of messages that the client will keep reference to if they are marked as redlivered.
| int com.pcbsys.nirvana.nJMS.ConnectionFactoryImpl.getMaxUnackedSize | ( | ) |
The client will keep a list of messages that have not been acknowledged.
This value sets the maximum size of this list.
| int com.pcbsys.nirvana.nJMS.ConnectionFactoryImpl.getMessageThreadPoolSize | ( | ) |
Gets the maximum number of threads used by the client for delivery of all messages to listeners.
| int com.pcbsys.nirvana.nJMS.ConnectionFactoryImpl.getPermittedKeepAlivesMissed | ( | ) |
Returns the number of keep server keep alives the client is allowed to miss before detecting a network issue and terminating the connection.
| int com.pcbsys.nirvana.nJMS.ConnectionFactoryImpl.getQueueWindowSize | ( | ) |
When synchronously consuming messages from the server, they will be delivered in batches (windows).
This property sets the size of that window
| boolean com.pcbsys.nirvana.nJMS.ConnectionFactoryImpl.getRandomiseRNames | ( | ) |
Allows the list of RNAME urls to be randomised to provide simple load balancing across a list of servers.
| boolean com.pcbsys.nirvana.nJMS.ConnectionFactoryImpl.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.
| long com.pcbsys.nirvana.nJMS.ConnectionFactoryImpl.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.
| Reference com.pcbsys.nirvana.nJMS.ConnectionFactoryImpl.getReference | ( | ) | throws NamingException |
Retrieves the Reference of this object.
| boolean com.pcbsys.nirvana.nJMS.ConnectionFactoryImpl.getRetryCommit | ( | ) |
Determines whether the commit call to a transacted session will retry if any exceptions are detected, rather than simply throw an exception.
| int com.pcbsys.nirvana.nJMS.ConnectionFactoryImpl.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.
This value specifies the number of messages in each batch The smaller the value, the more frequent the sync will be called on the physical file system.
| boolean com.pcbsys.nirvana.nJMS.ConnectionFactoryImpl.getSyncNamedTopicAcks | ( | ) |
Returns whether durable topic acknowledgements are being sent synchronously.
| boolean com.pcbsys.nirvana.nJMS.ConnectionFactoryImpl.getSyncQueueAcks | ( | ) |
Returns whether queue acknowledgements are being sent synchronously.
| boolean com.pcbsys.nirvana.nJMS.ConnectionFactoryImpl.getSyncSendPersistent | ( | ) |
For each persistent message written to the server, ensure the send is a synchronous call.
| int com.pcbsys.nirvana.nJMS.ConnectionFactoryImpl.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.
This value specifies the maximum time in milliseconds between sync calls The smaller the value, the more frequent the sync will be called on the physical file system.
| boolean com.pcbsys.nirvana.nJMS.ConnectionFactoryImpl.getSyncTopicAcks | ( | ) |
Returns whether topic acknowledgements are being sent synchronously.
| boolean com.pcbsys.nirvana.nJMS.ConnectionFactoryImpl.getSyncWrites | ( | ) |
For each persistent message written to the server, perform a file system sync to ensure the OS has written the data.
| boolean com.pcbsys.nirvana.nJMS.ConnectionFactoryImpl.getUseJMSEngine | ( | ) |
JMS engine ensures no events are available for topic replay unless durable subscriptions are being used.
Non JMS engine fanout enables events to be stored even after events are delivered. Default is true.
| int com.pcbsys.nirvana.nJMS.ConnectionFactoryImpl.getWriteHandler | ( | ) |
Returns the write handler type.
| boolean com.pcbsys.nirvana.nJMS.ConnectionFactoryImpl.isFollowMaster | ( | ) |
If set will create resources on the server when performing a lookup on a queue or channel.
| void com.pcbsys.nirvana.nJMS.ConnectionFactoryImpl.setAdapterBuffer | ( | int | value | ) |
Specifies for a specific connection the adapter send / receive buffer size.
If the value is 0 or less it is ignored.
| value | sets the adapter send / receive buffer size in bytes (default is 80000 bytes) |
| void com.pcbsys.nirvana.nJMS.ConnectionFactoryImpl.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.
This value determines how many events can be consumed before an acknowledgement is sent to the server
| value | 1 will mean every message is acknowledged in AUTO mode |
| void com.pcbsys.nirvana.nJMS.ConnectionFactoryImpl.setAutoCreateResource | ( | boolean | value | ) |
If true the client will automatically create resources which do not exist on the server.
| value | if true, resources will automatically be created on the server when needed |
| void com.pcbsys.nirvana.nJMS.ConnectionFactoryImpl.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.
| auto | true to enable auto reconnect even after security change |
| void com.pcbsys.nirvana.nJMS.ConnectionFactoryImpl.setConnectionTimeout | ( | long | value | ) |
Set the timeout used for connection / reconnection to realms.
If the connection fails to establish within this timeframe it will fail.
| value | - the number of milliseconds to allow for connection to be established |
| void com.pcbsys.nirvana.nJMS.ConnectionFactoryImpl.setConxExceptionOnFailure | ( | boolean | conxException | ) |
When enabled, any disconnections from the JMS Connection will not result in an Exception being generated through the ExceptionListener.
An exception will only be thrown to the ExceptionListener when the getMaxReconAttempts() value is reached.
| conxException | whether disconnections are reported through the ExceptionListener (default false) or only when reconnection fails after a defined maximum number of attempts (true). |
| void com.pcbsys.nirvana.nJMS.ConnectionFactoryImpl.setDisconnectOnClusterFailure | ( | boolean | value | ) |
If connected to a cluster of realms, and cluster quorum is lost, this flag determines whether the client will be disconnected.
| value | true will ensure when quorum is lost, the client will get a disconnect and attempt reconnection |
| void com.pcbsys.nirvana.nJMS.ConnectionFactoryImpl.setDurableType | ( | nDurableAttributes.nDurableType | type | ) |
Set the durable types for the connection factories.
see for supported types.
| type |
| void com.pcbsys.nirvana.nJMS.ConnectionFactoryImpl.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.
This value is overruled by enableSharedDurable, and if that is true a shared durable will be created rather than a priority durable
| value | true if enabled |
| void com.pcbsys.nirvana.nJMS.ConnectionFactoryImpl.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.
| value | true will enable multiplexing of the physical connection |
| void com.pcbsys.nirvana.nJMS.ConnectionFactoryImpl.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)
| value | true will enable shared durable |
| void com.pcbsys.nirvana.nJMS.ConnectionFactoryImpl.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)
| value | true will enable shared durable |
| void com.pcbsys.nirvana.nJMS.ConnectionFactoryImpl.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.
| value | true will enable shared durable |
| void com.pcbsys.nirvana.nJMS.ConnectionFactoryImpl.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.
| value | true will enforce single acknowledgement on queues |
| void com.pcbsys.nirvana.nJMS.ConnectionFactoryImpl.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.
| value | true will enforce single acknowledgement on shared durables |
| void com.pcbsys.nirvana.nJMS.ConnectionFactoryImpl.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.
| value | the maximum messages to allow in the topic or queue |
| void com.pcbsys.nirvana.nJMS.ConnectionFactoryImpl.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.
| immediate | true to enable immediate reconnect |
| void com.pcbsys.nirvana.nJMS.ConnectionFactoryImpl.setInitialConnectionRetry | ( | int | value | ) |
When a connection is first established, the default number of connection attempts is 2.
This allows this value to be overridden.
| value | the number of connection attempts made on connection establishment |
| void com.pcbsys.nirvana.nJMS.ConnectionFactoryImpl.setIsInfiniteWindow | ( | boolean | isInfiniteWindow | ) |
When set to true, the consumer can consume as many events as required before committing.
| isInfiniteWindow | true if using infinite window |
| void com.pcbsys.nirvana.nJMS.ConnectionFactoryImpl.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.
| value | - the number of permitted server keep alives to be missed before termination of connection |
| void com.pcbsys.nirvana.nJMS.ConnectionFactoryImpl.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.
The default value is -1, which represents infinite retries.
| max | the maximum number of configured reconnect attempts |
| void com.pcbsys.nirvana.nJMS.ConnectionFactoryImpl.setMaxRedelivery | ( | int | value | ) |
Specifies the maximum number of messages that the client will keep reference to if they are marked as redelivered.
| value | the maximum number |
| void com.pcbsys.nirvana.nJMS.ConnectionFactoryImpl.setMaxUnackedSize | ( | int | value | ) |
The client will keep a list of messages that have not been acknowledged.
This value sets the maximum size of this list.
| value | default is 100 |
| void com.pcbsys.nirvana.nJMS.ConnectionFactoryImpl.setMessageThreadPoolSize | ( | int | value | ) |
Sets the maximum number of threads used by the client for delivery of all messages to listeners.
| value | default is 30 |
| void com.pcbsys.nirvana.nJMS.ConnectionFactoryImpl.setProperties | ( | Hashtable | eprops | ) |
Sets the connection factory properties.
These are :
nirvana.ssl.protocol - see setSSLProtocol / getSSLProtocol
| eprops | props |
| void com.pcbsys.nirvana.nJMS.ConnectionFactoryImpl.setQueueWindowSize | ( | int | value | ) |
When synchronously consuming messages from the server from a queue, they will be delivered in batches (windows).
This property sets the size of that window
| value | default is 100 |
| void com.pcbsys.nirvana.nJMS.ConnectionFactoryImpl.setRandomiseRNames | ( | boolean | value | ) |
Allows the list of RNAME urls to be randomised to provide simple load balancing across a list of servers.
| value | if true, the list of RNAME urls will be shuffled into a random order |
| void com.pcbsys.nirvana.nJMS.ConnectionFactoryImpl.setReconnectInterval | ( | long | interval | ) |
If a client is disconnected, and Immediate Reconnect is set to true, this value represents the interval between reconnect attempts.
| interval | the constant time between reconnect attempts (in milliseconds) |
| void com.pcbsys.nirvana.nJMS.ConnectionFactoryImpl.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.
| value | if true, the commit will be retried after failure |
| void com.pcbsys.nirvana.nJMS.ConnectionFactoryImpl.setRNAME | ( | String | rname | ) |
Sets the RNAME url associated with the connection destination.
| rname | the RNAME url |
| void com.pcbsys.nirvana.nJMS.ConnectionFactoryImpl.setSSLEnabledCiphers | ( | String[] | enabledCiphers | ) |
Sets the SSL cipher suite associated with the connection factory.
| enabledCiphers | the caller's SSL enabled ciphersuite |
| void com.pcbsys.nirvana.nJMS.ConnectionFactoryImpl.setSSLProtocol | ( | String | protocol | ) |
Sets the SSL protocol associated with the connection factory.
| protocol | the caller's SSL protocol |
| void com.pcbsys.nirvana.nJMS.ConnectionFactoryImpl.setSSLStores | ( | String | keyStorePath, |
| String | keyStorePass, | ||
| String | trustStorePath, | ||
| String | trustStorePass | ||
| ) |
Sets the SSL KeyStore / TrustStore details associated with the connection factory.
| keyStorePath | the caller's SSL keystore path |
| keyStorePass | the caller's SSL keystore password |
| trustStorePath | the caller's SSL truststore path |
| trustStorePass | the caller's SSL truststore password |
| void com.pcbsys.nirvana.nJMS.ConnectionFactoryImpl.setSSLStores | ( | String | keyStorePath, |
| String | keyStorePass, | ||
| String | certificateAlias, | ||
| String | trustStorePath, | ||
| String | trustStorePass | ||
| ) |
Sets the SSL KeyStore / TrustStore details associated with the connection factory.
| keyStorePath | the caller's SSL keystore path |
| keyStorePass | the caller's SSL keystore password |
| certificateAlias | the caller's SSL keystore certificate alias |
| trustStorePath | the caller's SSL truststore path |
| trustStorePass | the caller's SSL truststore password |
| void com.pcbsys.nirvana.nJMS.ConnectionFactoryImpl.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.
This value specifies the number of messages in each batch The smaller the value, the more frequent the sync will be called on the physical file system.
| value | the number of messages to batch in each sync |
| void com.pcbsys.nirvana.nJMS.ConnectionFactoryImpl.setSyncNamedTopicAcks | ( | boolean | value | ) |
Specifies for a specific connection whether the durable topic acknowledgements will be sent synchronously.
| value | true will ensure acknowledgements are sent synchronously (default is false) |
| void com.pcbsys.nirvana.nJMS.ConnectionFactoryImpl.setSyncQueueAcks | ( | boolean | value | ) |
Specifies for a specific connection whether the queue acknowledgements will be sent synchronously.
| value | true will ensure acknowledgements are sent synchronously (default) |
| void com.pcbsys.nirvana.nJMS.ConnectionFactoryImpl.setSyncSendPersistent | ( | boolean | value | ) |
For each persistent message written to the server, ensure the send is a synchronous call.
| value | true will ensure each send is a synchronous call |
| void com.pcbsys.nirvana.nJMS.ConnectionFactoryImpl.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.
This value specifies the maximum time in milliseconds between sync calls The smaller the value, the more frequent the sync will be called on the physical file system.
| value | the maximum time between calls to sync the file system |
| void com.pcbsys.nirvana.nJMS.ConnectionFactoryImpl.setSyncTopicAcks | ( | boolean | value | ) |
Specifies for a specific connection whether the topic acknowledgements will be sent synchronously.
| value | true will ensure acknowledgements are sent synchronously (default) |
| void com.pcbsys.nirvana.nJMS.ConnectionFactoryImpl.setSyncWrites | ( | boolean | value | ) |
For each persistent message written to the server, perform a file system sync to ensure the OS has written the data.
| value | true will ensure file sync operations occur for all persistent messages |
| void com.pcbsys.nirvana.nJMS.ConnectionFactoryImpl.setUseJMSEngine | ( | boolean | value | ) |
JMS engine ensures no events are available for topic replay unless durable subscriptions are being used.
Non JMS engine fanout enables events to be stored even after events are delivered. Default is true.
| value | true if set |
| void com.pcbsys.nirvana.nJMS.ConnectionFactoryImpl.setWriteHandler | ( | int | value | ) |
Specifies for a specific connection the write handler type to use.
| value | sets the write handler type (default is 3 ) |