SolConnectionFactory (Solace JMS API v10.27.0)

All Superinterfaces:

ConnectionFactory, QueueConnectionFactory, Referenceable, TopicConnectionFactory

All Known Subinterfaces:

SolXAConnectionFactory
```
@ProviderType
public interface SolConnectionFactory
extends ConnectionFactory, QueueConnectionFactory, TopicConnectionFactory, Referenceable
```
This is an interface to our proprietary implementation of a ConnectionFactory.

Method Summary

All Methods Instance Methods Abstract Methods Deprecated Methods
Modifier and Type	Method and Description
`void`	`fromProperties(Properties properties)` Sets the properties based on values in a `Properties` instance.
`Boolean`	`getAllowDuplicateClientId()` This property specifies whether a duplicate client ID is allowed.
`String`	`getAuthenticationScheme()` This property specifies the authentication scheme.
`Integer`	`getBrowserTimeoutInMS()` This property specifies the maximum time in milliseconds for a `QueueBrowser` `Enumeration.hasMoreElements()` to wait for a message to arrive in the browser's local message buffer before returning.
`Boolean`	`getCallbackOnIOThread()` This property specifies whether to call MessageListeners directly from the IO thread.
`String`	`getClientDescription()` This property is used to specify the application description on the appliance for the data connection.
`String`	`getClientID()` This property is used to specify the client name on the appliance for the data connection.
`Integer`	`getCompressionLevel()` This property is used to enable and specify the ZLIB compression level.
`Integer`	`getConnectRetries()` This property is used to specify the total number of times to attempt and retry a connection when establishing an initial connection for a Session to a host router.
`Integer`	`getConnectRetriesPerHost()` This property is used to specify the number of times to retry data connection attempts to a single host before moving on to the next host in the list.
`Integer`	`getConnectTimeoutInMillis()` This property is used to specify the timeout in milliseconds on a data connection attempt.
`Boolean`	`getDeliverToOne()` This property specifies whether sent messages are deliver to one.
`Boolean`	`getDeliverToOneOverride()` This property specifies whether to override deliver to one settings.
`Integer`	`getDeliveryMode()` This property specifies the delivery mode for sent messages.
`Boolean`	`getDirectOptimized()` This property specifies whether to optimize the API for direct transport.
`Boolean`	`getDirectTransport()` This property specifies whether to use direct transport for non-persistent messages.
`Boolean`	`getDmqEligible()` This property specifies whether sent messages are eligible for the dead message queue.
`Boolean`	`getDynamicDurables()` This property is used to indicate whether durable topic endpoints or queues are to be created on the appliance when the corresponding Session.createDurableSubscriber() or Session.createQueue() is called.
`Object`	`getEffectiveProperty(String name)` Gets a property's value given its name.
`Boolean`	`getElidingEligible()` This property specifies whether sent messages are marked as eligible for eliding.
`Hashtable<?,?>`	`getEnvironment()` This method gets the environment that the ConnectionFactory may have.
`Boolean`	`getGenerateSenderID()` This property is used to Indicates whether the client name should be included in the SenderID message header parameter.
`String`	`getHost()` This property is the hostname / IP address of the appliance.
`Boolean`	`getJMSXUserIDEnabled()` This property specifies whether JMSXUserID property should be set.
`Integer`	`getKeepAliveCountMax()` This property is used to specify the allowed number of consecutive keep-alive messages for which no response is received before the connection is closed by the API.
`Integer`	`getKeepAliveIntervalInMillis()` This property is used to specify the interval between keep alives in milliseconds.
`Boolean`	`getKeepAlives()` This property is used to enable/disable keep alives.
`Boolean`	`getKRBMutualAuthentication()` This property is used to indicate that mutual authentication is to be used when Kerberos is enabled.
`String`	`getKRBServiceName()` This property is used to specify the ServiceName portion of the Service Principal Name (SPN) that has a format of ServiceName/ApplianceName@REALM.
`Boolean`	`getLargeMessaging()` This property is used to enable/disable publish/receive large AD messages.
`Integer`	`getLargeMessagingConsumeTimeoutInMillis()`
`String`	`getLargeMessagingIncompletePolicy()`
`Integer`	`getLargeMessagingMaximumSize()`
`Integer`	`getLargeMessagingSegmentSize()`
`String`	`getPassword()` This property is used to specify the password to connect to the appliance with.
`Integer`	`getPayloadCompressionLevel()` A property to enable payload compression and set the compression level.
`Integer`	`getPort()` This property is used to specify the port to use for the data connection.
`Object`	`getProperty(String name)` Gets the property value given its name.
`Set<String>`	`getPropertyNames()` Gets the property names for all the properties.
`Integer`	`getReadTimeoutInMillis()` This property is used to specify the timeout in milliseconds for reading a reply from the appliance.
`Integer`	`getReceiveAdAckThreshold()` This property specifies the threshold for sending an acknowledgement to the appliance.
`Integer`	`getReceiveADAckTimerInMillis()` This property specifies the duration of the acknowledgement timer.
`Integer`	`getReceiveADWindowSize()` This property specifies the size of the sliding acknowledgement window.
`Integer`	`getReceiveBufferSize()` This property is used to configure the socket’s receive buffer size in bytes.
`Integer`	`getReceiveReconnectRetries()` Gets how much time (in ms) to wait between each attempt to reconnect to an endpoint.
`Integer`	`getReceiveReconnectRetryWaitInMillis()` Gets how much time (in ms) to wait between each attempt to reconnect to an endpoint.
`Integer`	`getReconnectRetries()` This property is used to specify the number of times to attempt a reconnect once the initial data connection to the appliance has been lost.
`Integer`	`getReconnectRetryWaitInMillis()` This property is used to specify the amount of time to wait in milliseconds between reconnect attempts.
`Boolean`	`getRespectTTL()` This property is used to indicate whether dynamically created durable topic endpoints or queues are set to respect time to live (see Dynamic Durables).
`Integer`	`getSendADAckTimerInMillis()` This property specifies the duration of the acknowledgement timer in milliseconds.
`Integer`	`getSendADMaxResends()` Deprecated.
`Integer`	`getSendADWindowSize()` This property specifies the size of the sliding acknowledgement window for non-persistent messages.
`Integer`	`getSendBufferSize()` This property is used to specify the socket’s send buffer size in bytes.
`String`	`getSSLCipherSuites()` This property specifies a comma separated list of the cipher suites to enable in order of preference.
`String`	`getSSLConnectionDowngradeTo()` This property specifies a transport protocol that SSL connection will be downgraded to after client authentication.
`String`	`getSSLExcludedProtocols()` This property is used to specify a comma separated list of encryption protocol(s) to exclude from use.
`String`	`getSSLKeyStore()` This property specifies the key store to use in URL or path format.
`String`	`getSSLKeyStoreFormat()` This property specifies the format of the given key store.
`String`	`getSSLKeyStoreNormalizedFormat()` This property specifies the internal normalized format of the given key store.
`String`	`getSSLKeyStorePassword()` This property specifies the key store password to use.
`String`	`getSSLPrivateKeyAlias()` This property specifies which private key in the key store is to be used for the client certificate authentication.
`String`	`getSSLPrivateKeyPassword()` This property specifies the password used to decipher the client certificate private key from the key store.
`String`	`getSSLProtocol()` This property is used to specify a comma separated list of encryption protocol(s) to use.
`String`	`getSSLTrustedCommonNameList()` This property specifies the list of acceptable common names for matching in server certificates.
`String`	`getSSLTrustStore()` This property specifies the trust store to use in URL or path format.
`String`	`getSSLTrustStoreFormat()` This property specifies the format of the given trust store.
`String`	`getSSLTrustStorePassword()` This property specifies the trust store password to use.
`Boolean`	`getSSLValidateCertificate()` This property is used to indicate that the API should validate server certificates with certificates in the trust store.
`Boolean`	`getSSLValidateCertificateDate()` This property is used to indicate that the session connection should fail when an expired certificate or a certificate not yet in effect is received.
`Boolean`	`getSSLValidateCertificateHost()` This method is used to get the value of the SSLValidateCertificateHost property.
`Integer`	`getSubscriberLocalPriority()` This property specifies the priority that a client’s subscriptions have for receiving Deliver-To-One messages published on the Solace appliance that the client is directly connected to.
`Integer`	`getSubscriberNetworkPriority()` This property specifies the priority that a client’s subscriptions have for receiving Deliver-To-One messages published by other Solace appliances in the Solace Messaging Platform.
`Boolean`	`getTcpNoDelay()` This property is used to specify whether to set the TCP_NODELAY option.
`String`	`getUnknownPublisherFlowAction()` This property specifies
`Boolean`	`getUseDefaultContext()` This property is used to indicate whether to use a new context or reuse the default context for new JMS connections.
`String`	`getUsername()` This property is used to specify the username to connect to the appliance with.
`String`	`getVPN()` This property is used to specify the VPN to use when connecting to the appliance.
`Boolean`	`getXA()` This property specified whether this is an XA Connection Factory.
`Boolean`	`getXmlPayload()` This property specifies whether sent text messages have an XML payload.
`void`	`setAuthenticationScheme(String scheme)` This property specifies the authentication scheme.
`void`	`setBrowserTimeoutInMS(Integer timeout)` This property specifies the maximum time in milliseconds for a `QueueBrowser` `Enumeration.hasMoreElements()` to wait for a message to arrive in the browser's local message buffer before returning.
`void`	`setCallbackOnIOThread(Boolean callbackOnIOThread)` This property specifies whether to call MessageListeners directly from the IO thread.
`void`	`setClientDescription(String clientDescription)` This property is used to specify the application description on the appliance for the data connection.
`void`	`setClientID(String clientID)` This property is used to specify the client name on the appliance for the data connection.
`void`	`setCompressionLevel(Integer compressionLevel)` This property is used to enable and specify the ZLIB compression level.
`void`	`setConnectRetries(Integer connectRetries)` This property is used to specify the total number of times to attempt and retry a connection when establishing an initial connection for a Session to a host router.
`void`	`setConnectRetriesPerHost(Integer connectRetriesPerHost)` This property is used to specify the number of times to retry data connection attempts to a single host before moving on to the next host in the list.
`void`	`setConnectTimeoutInMillis(Integer connectTimeoutInMillis)` This property is used to specify the timeout in milliseconds on a data connection attempt.
`void`	`setDeliverToOne(Boolean deliverToOne)` This property specifies whether sent messages are deliver to one.
`void`	`setDeliverToOneOverride(Boolean deliverToOneOverride)` This property specifies whether to override deliver to one settings.
`void`	`setDeliveryMode(Integer deliveryMode)` This property specifies the delivery mode for sent messages.
`void`	`setDirectOptimized(Boolean directOptimized)` This property specifies whether to optimize the API for direct transport.
`void`	`setDirectTransport(Boolean directTransport)` This property specifies whether to use direct transport for non-persistent messages.
`void`	`setDmqEligible(Boolean dmqEligible)` This property specifies whether sent messages are eligible for the dead message queue.
`void`	`setDynamicDurables(Boolean dynamicDurables)` This property is used to indicate whether durable topic endpoints or queues are to be created on the appliance when the corresponding Session.createDurableSubscriber() or Session.createQueue() is called.
`void`	`setElidingEligible(Boolean elidingEligible)` This property specifies whether sent messages are marked as eligible for eliding.
`void`	`setGenerateSenderID(Boolean generateSenderId)` This property is used to Indicates whether the client name should be included in the SenderID message header parameter.
`void`	`setHost(String host)` This property is the hostname / IP address of the appliance.
`void`	`setKeepAliveCountMax(Integer keepAliveCountMax)` This property is used to specify the allowed number of consecutive keep-alive messages for which no response is received before the connection is closed by the API.
`void`	`setKeepAliveIntervalInMillis(Integer keepAliveIntervalInMillis)` This property is used to specify the interval between keep alives in milliseconds.
`void`	`setKeepAlives(Boolean keepAlives)` This property is used to enable/disable keep alives.
`void`	`setKRBMutualAuthentication(Boolean mutualAuth)` This property is used to indicate that mutual authentication is to be used when Kerberos is enabled.
`void`	`setKRBServiceName(String serviceName)` This property is used to specify the ServiceName portion of the Service Principal Name (SPN) that has a format of ServiceName/ApplianceName@REALM.
`void`	`setLargeMessaging(Boolean largeMessaging)` This property is used to enable/disable publish/receive large AD messages..
`void`	`setLargeMessagingConsumeTimeoutInMillis(Integer consumeTimeoutInMillis)`
`void`	`setLargeMessagingIncompletePolicy(String incompletePolicy)`
`void`	`setLargeMessagingMaximumSize(Integer maxSize)`
`void`	`setLargeMessagingSegmentSize(Integer segmentSize)`
`void`	`setPassword(String password)` This property is used to specify the password to connect to the appliance with.
`void`	`setPayloadCompressionLevel(Integer payloadCompressionLevel)` A property to enable payload compression and set the compression level.
`void`	`setPort(Integer port)` This property is used to specify the port to use for the data connection.
`void`	`setProperty(String name, Object value)` Sets a property's value given its name.
`void`	`setReadTimeoutInMillis(Integer readTimeoutInMillis)` This property is used to specify the timeout in milliseconds for reading a reply from the appliance.
`void`	`setReceiveAdAckThreshold(Integer receiveAdAckThreshold)` This property specifies the threshold for sending an acknowledgement to the appliance.
`void`	`setReceiveADAckTimerInMillis(Integer receiveADAckTimerInMillis)` This property specifies the duration of the acknowledgement timer.
`void`	`setReceiveADWindowSize(Integer receiveADWindowSize)` This property specifies the size of the sliding acknowledgement window.
`void`	`setReceiveBufferSize(Integer receiveBufferSize)` This property is used to configure the socket’s receive buffer size in bytes.
`void`	`setReceiveReconnectRetries(Integer reconnectRetries)` This property specifies the number of times to attempt to reconnect to an endpoint after the initial bound flow goes down.
`void`	`setReceiveReconnectRetryWaitInMillis(Integer reconnectRetryWaitInMillis)` This property specifies how much time (in ms) to wait between each attempt to reconnect to an endpoint.
`void`	`setReconnectRetries(Integer reconnectRetries)` This property is used to specify the number of times to attempt a reconnect once the initial data connection to the appliance has been lost.
`void`	`setReconnectRetryWaitInMillis(Integer reconnectRetryWaitInMillis)` This property is used to specify the amount of time to wait in milliseconds between reconnect attempts.
`void`	`setRespectTTL(Boolean respectTTL)` This property is used to indicate whether dynamically created durable topic endpoints or queues are set to respect time to live (see Dynamic Durables).
`void`	`setSendADAckTimerInMillis(Integer sendADAckTimerInMillis)` This property specifies the duration of the acknowledgement timer in milliseconds.
`void`	`setSendADMaxResends(Integer sendADMaxResends)` Deprecated.
`void`	`setSendADWindowSize(Integer sendADWindowSize)` This property specifies the size of the sliding acknowledgement window for non-persistent and transacted messages.
`void`	`setSendBufferSize(Integer sendBufferSize)` This property is used to specify the socket’s send buffer size in bytes.
`void`	`setSSLCipherSuites(String cipherSuites)` This property specifies a comma separated list of the cipher suites to enable in order of preference.
`void`	`setSSLConnectionDowngradeTo(String proto)` This property specifies a transport protocol that SSL connection will be downgraded to after client authentication.
`void`	`setSSLExcludedProtocols(String protocols)` This property is used to specify a comma separated list of encryption protocol(s) to exclude from use.
`void`	`setSSLKeyStore(String keystore)` This property specifies the key store to use in URL or path format.
`void`	`setSSLKeyStoreFormat(String format)` This property specifies the format of the given key store.
`void`	`setSSLKeyStoreNormalizedFormat(String format)` This property specifies the internal normalized format of the given key store.
`void`	`setSSLKeyStorePassword(String password)` This property specifies the key store password to use.
`void`	`setSSLPrivateKeyAlias(String alias)` This property specifies which private key in the key store is to be used for the client certificate authentication.
`void`	`setSSLPrivateKeyPassword(String password)` This property specifies the password used to decipher the client certificate private key from the key store.
`void`	`setSSLProtocol(String protocol)` This property is used to specify a comma separated list of encryption protocol(s) to use.
`void`	`setSSLTrustedCommonNameList(String commonNames)` This property specifies the list of acceptable common names for matching in server certificates.
`void`	`setSSLTrustStore(String truststore)` This property specifies the trust store to use in URL or path format.
`void`	`setSSLTrustStoreFormat(String format)` This property specifies the format of the given trust store.
`void`	`setSSLTrustStorePassword(String password)` This property specifies the trust store password to use.
`void`	`setSSLValidateCertificate(Boolean validate)` This property is used to indicate that the API should validate server certificates with certificates in the trust store.
`void`	`setSSLValidateCertificateDate(Boolean validateDate)` This property is used to indicate that the session connection should fail when an expired certificate or a certificate not yet in effect is received.
`void`	`setSSLValidateCertificateHost(Boolean validate)` Boolean property to indicate if the session connection should fail when a certificate with an invalid host is received.
`void`	`setSubscriberLocalPriority(Integer subscriberLocalPriority)` This property specifies the priority that a client’s subscriptions have for receiving Deliver-To-One messages published on the Solace appliance that the client is directly connected to.
`void`	`setSubscriberNetworkPriority(Integer subscriberNetworkPriority)` This property specifies the priority that a client’s subscriptions have for receiving Deliver-To-One messages published by other Solace appliances in the Solace Messaging Platform.
`void`	`setTcpNoDelay(Boolean tcpNoDelay)` This property is used to specify whether to set the TCP_NODELAY option.
`void`	`setUnknownPublisherFlowAction(String action)` This property specifies
`void`	`setUseDefaultContext(Boolean useDefaultContext)` This property is used to indicate whether to use a new context or reuse the default context for new JMS connections.
`void`	`setUsername(String username)` This property is used to specify the username to connect to the appliance with.
`void`	`setVPN(String vpn)` This property is used to specify the VPN to use when connecting to the appliance.
`void`	`setXmlPayload(Boolean xmlPayload)` This property specifies whether sent text messages have an XML payload.
`String`	`toEffectiveString()` Returns a string representation of all the property values as if the method `getEffectiveProperty(String)` was used to retrieve them.
`Properties`	`toProperties()` Gets the properties in a `Properties` instance.

Methods inherited from interface javax.jms.QueueConnectionFactory
createQueueConnection, createQueueConnection

Methods inherited from interface javax.jms.TopicConnectionFactory
createTopicConnection, createTopicConnection

Methods inherited from interface javax.jms.ConnectionFactory
createConnection, createConnection

Methods inherited from interface javax.naming.Referenceable
getReference

Method Detail

getAuthenticationScheme
```
String getAuthenticationScheme()
```
This property specifies the authentication scheme.
Values are one of
- SupportedProperty.AUTHENTICATION_SCHEME_BASIC (username/password based authentication)
- SupportedProperty.AUTHENTICATION_SCHEME_CLIENT_CERTIFICATE (Client Certificate based authentication)
- SupportedProperty.AUTHENTICATION_SCHEME_GSS_KRB (Kerberos based authentication)
- SupportedProperty.AUTHENTICATION_SCHEME_OAUTH2 (OAuth 2.0 based authentication)
Default: SupportedProperty.AUTHENTICATION_SCHEME_BASIC
Returns:

The authentication scheme

setAuthenticationScheme
```
void setAuthenticationScheme(String scheme)
```
This property specifies the authentication scheme.
Values are one of
- SupportedProperty.AUTHENTICATION_SCHEME_BASIC (username/password authentication)
- SupportedProperty.AUTHENTICATION_SCHEME_CLIENT_CERTIFICATE (Client Certificate based authentication)
- SupportedProperty.AUTHENTICATION_SCHEME_GSS_KRB (Kerberos based authentication)
- SupportedProperty.AUTHENTICATION_SCHEME_OAUTH2 (OAuth 2.0 based authentication)
Default: SupportedProperty.AUTHENTICATION_SCHEME_BASIC
Parameters:

scheme - The authentication scheme

getBrowserTimeoutInMS
```
Integer getBrowserTimeoutInMS()
```
This property specifies the maximum time in milliseconds for a QueueBrowser Enumeration.hasMoreElements() to wait for a message to arrive in the browser's local message buffer before returning. If there is already a message waiting Enumeration.hasMoreElements() returns immediately. A value of 0 means wait forever ( Enumeration.hasMoreElements() will return false only on closing the browser). A value < 0 will return immediately.
Default: -1 (return immediately)

Returns:

the BrowserTimeoutInMS property value, null if not set.

setBrowserTimeoutInMS
```
void setBrowserTimeoutInMS(Integer timeout)
```
This property specifies the maximum time in milliseconds for a QueueBrowser Enumeration.hasMoreElements() to wait for a message to arrive in the browser's local message buffer before returning. If there is already a message waiting Enumeration.hasMoreElements() returns immediately. A value of 0 means wait forever ( Enumeration.hasMoreElements() will return false only on closing the browser). A value < 0 will return immediately.
Default: -1 (return immediately)

Parameters:

timeout - the BrowserTimeoutInMS property value, null to unset.

getCallbackOnIOThread
```
Boolean getCallbackOnIOThread()
```
This property specifies whether to call MessageListeners directly from the IO thread. If false, MessageListeners are called from a consumer notification thread.
Default: false

Returns:

the CallbackOnIOThread property value, null if not set.

setCallbackOnIOThread
```
void setCallbackOnIOThread(Boolean callbackOnIOThread)
```
This property specifies whether to call MessageListeners directly from the IO thread. If false, MessageListeners are called from a consumer notification thread.
Default: false

Parameters:

callbackOnIOThread - the CallbackOnIOThread property value, null to unset.

getClientDescription
```
String getClientDescription()
```
This property is used to specify the application description on the appliance for the data connection.
Format: Must be a maximum of 254 ASCII characters.
Default: “”

Returns:

the ClientDescription property value, null if not set.

setClientDescription
```
void setClientDescription(String clientDescription)
```
This property is used to specify the application description on the appliance for the data connection.
Format: Must be a maximum of 254 ASCII characters.
Default: “”

Parameters:

clientDescription - the ClientDescription property value, null to unset.

getClientID
```
String getClientID()
```
This property is used to specify the client name on the appliance for the data connection. The default client ID used is generated by the API.
Format: Must be a valid topic name and a maximum of 160 bytes when encoded in UTF-8.
Default: a generated client ID

Returns:

the ClientID property value, null if not set.

setClientID
```
void setClientID(String clientID)
```
This property is used to specify the client name on the appliance for the data connection. The default client ID used is generated by the API.
Format: Must be a valid topic name and a maximum of 160 bytes when encoded in UTF-8.
Default: a generated client ID

Parameters:

clientID - the ClientID property value, null to unset.

getCompressionLevel
```
Integer getCompressionLevel()
```
This property is used to enable and specify the ZLIB compression level.
Format: Must be a value [-1..9]. -1 means use the JNDI connection’s compression level. 0 disables compression. 1-9 sets the ZLIB compression level.
Default: -1 (use JNDI connection’s compression level, 0 if no JNDI connection)

Returns:

the CompressionLevel property value, null if not set.

setCompressionLevel
```
void setCompressionLevel(Integer compressionLevel)
```
This property is used to enable and specify the ZLIB compression level.
Format: Must be a value [-1..9]. -1 means use the JNDI connection’s compression level. 0 disables compression. 1-9 sets the ZLIB compression level.
Default: -1 (use JNDI connection’s compression level, 0 if no JNDI connection)

Parameters:

compressionLevel - the CompressionLevel property value, null to unset.

getPayloadCompressionLevel
```
Integer getPayloadCompressionLevel()
```
A property to enable payload compression and set the compression level.
Format: Must be a value [0..9]. 0 disables compression. 1-9 sets the ZLIB compression level.
Default: 0

Returns:

the PayloadCompressionLevel property value, null if not set.

setPayloadCompressionLevel
```
void setPayloadCompressionLevel(Integer payloadCompressionLevel)
```
A property to enable payload compression and set the compression level.
Format: Must be a value [0..9]. 0 disables compression. 1-9 sets the ZLIB compression level.
Default: 0

Parameters:

payloadCompressionLevel - the PayloadCompressionLevel property value, null to unset.

getConnectRetries
```
Integer getConnectRetries()
```
This property is used to specify the total number of times to attempt and retry a connection when establishing an initial connection for a Session to a host router.
Format: Valid values are [-1.. 2147483647]. -1 means retry forever.
Default: 0 (don’t retry)

Returns:

the ConnectRetries property value, null if not set.

setConnectRetries
```
void setConnectRetries(Integer connectRetries)
```
This property is used to specify the total number of times to attempt and retry a connection when establishing an initial connection for a Session to a host router.
Format: Valid values are [-1.. 2147483647]. -1 means retry forever.
Default: 0 (don’t retry)

Parameters:

connectRetries - the ConnectRetries property value, null to unset.

getConnectRetriesPerHost
```
Integer getConnectRetriesPerHost()
```
This property is used to specify the number of times to retry data connection attempts to a single host before moving on to the next host in the list. Valid for host lists only.
Format: Valid values are [-1.. 2147483647]. -1 means retry forever.
Default: 0 (don’t retry)

Returns:

the ConnectRetriesPerHost property value, null if not set.

setConnectRetriesPerHost
```
void setConnectRetriesPerHost(Integer connectRetriesPerHost)
```
This property is used to specify the number of times to retry data connection attempts to a single host before moving on to the next host in the list. Valid for host lists only.
Format: Valid values are [-1.. 2147483647]. -1 means retry forever.
Default: 0 (don’t retry)

Parameters:

connectRetriesPerHost - the ConnectRetriesPerHost property value, null to unset.

getConnectTimeoutInMillis
```
Integer getConnectTimeoutInMillis()
```
This property is used to specify the timeout in milliseconds on a data connection attempt.
Format: In milliseconds. Valid values are [0..2147483647]. 0 means wait forever.
Default: The default value is 30000 (30 seconds)

Returns:

the ConnectTimeoutInMillis property value, null if not set.

setConnectTimeoutInMillis
```
void setConnectTimeoutInMillis(Integer connectTimeoutInMillis)
```
This property is used to specify the timeout in milliseconds on a data connection attempt.
Format: In milliseconds. Valid values are [0..2147483647]. 0 means wait forever.
Default: The default value is 30000 (30 seconds)

Parameters:

connectTimeoutInMillis - the ConnectTimeoutInMillis property value, null to unset.

getDeliveryMode
```
Integer getDeliveryMode()
```
This property specifies the delivery mode for sent messages.
Format: Valid values are [DeliveryMode.NON_PERSISTENT | DeliveryMode.PERSISTENT]
Default: DeliveryMode.PERSISTENT

Returns:

the DeliveryMode property value, null if not set.

setDeliveryMode
```
void setDeliveryMode(Integer deliveryMode)
```
This property specifies the delivery mode for sent messages.
Format: Valid values are [DeliveryMode.NON_PERSISTENT | DeliveryMode.PERSISTENT]
Default: DeliveryMode.PERSISTENT

Parameters:

deliveryMode - the DeliveryMode property value, null to unset.

getDeliverToOne
```
Boolean getDeliverToOne()
```
This property specifies whether sent messages are deliver to one.
Default: false

Returns:

the DeliverToOne property value, null if not set.

setDeliverToOne
```
void setDeliverToOne(Boolean deliverToOne)
```
This property specifies whether sent messages are deliver to one.
Default: false

Parameters:

deliverToOne - the DeliverToOne property value, null to unset.

getDeliverToOneOverride
```
Boolean getDeliverToOneOverride()
```
This property specifies whether to override deliver to one settings. Used only with direct messaging. When enabled, the API will be allowed to receive all deliver to one tagged messages.
Default: true.

Returns:

the DeliverToOneOverride property value, null if not set.

setDeliverToOneOverride
```
void setDeliverToOneOverride(Boolean deliverToOneOverride)
```
This property specifies whether to override deliver to one settings. Used only with direct messaging. When enabled, the API will be allowed to receive all deliver to one tagged messages.
Default: true.

Parameters:

deliverToOneOverride - the DeliverToOneOverride property value, null to unset.

getDirectOptimized
```
Boolean getDirectOptimized()
```
This property specifies whether to optimize the API for direct transport. When optimization is enabled, the application is restricted to creating at most one consumer or producer per connection.
Default: false.

Returns:

DirectOptimized property value, null if not set.

setDirectOptimized
```
void setDirectOptimized(Boolean directOptimized)
```
This property specifies whether to optimize the API for direct transport. When optimization is enabled, the application is restricted to creating at most one consumer or producer per connection.
Default: false.

Parameters:

directOptimized - the DirectOptimized property value, null to unset.

getDirectTransport
```
Boolean getDirectTransport()
```
This property specifies whether to use direct transport for non-persistent messages.
Default: true.

Returns:

DirectTransport property value, null if not set.

setDirectTransport
```
void setDirectTransport(Boolean directTransport)
```
This property specifies whether to use direct transport for non-persistent messages.
Default: true.

Parameters:

directTransport - the DirectTransport property value, null to unset.

getJMSXUserIDEnabled
```
Boolean getJMSXUserIDEnabled()
```
This property specifies whether JMSXUserID property should be set.
Default: false.

Returns:

JMSXUserIDEnabled property value, null if not set.

getAllowDuplicateClientId
```
Boolean getAllowDuplicateClientId()
```
This property specifies whether a duplicate client ID is allowed.
Default: false.

Returns:

AllowDuplicateClientId property value, null if not set.

getDmqEligible
```
Boolean getDmqEligible()
```
This property specifies whether sent messages are eligible for the dead message queue.
Default: false

Returns:

DmqEligible property value, null if not set.

setDmqEligible
```
void setDmqEligible(Boolean dmqEligible)
```
This property specifies whether sent messages are eligible for the dead message queue.
Default: false

Parameters:

dmqEligible - the DmqEligible property value, null to unset.

getDynamicDurables
```
Boolean getDynamicDurables()
```
This property is used to indicate whether durable topic endpoints or queues are to be created on the appliance when the corresponding Session.createDurableSubscriber() or Session.createQueue() is called. The created endpoint will have its respect time to live setting according to the JMS “Respect Time to Live” property.
Default: false

Returns:

DynamicDurables property value, null if not set.

setDynamicDurables
```
void setDynamicDurables(Boolean dynamicDurables)
```
This property is used to indicate whether durable topic endpoints or queues are to be created on the appliance when the corresponding Session.createDurableSubscriber() or Session.createQueue() is called. The created endpoint will have its respect time to live setting according to the JMS “Respect Time to Live” property.
Default: false

Parameters:

dynamicDurables - the DynamicDurables property value, null to unset.

getElidingEligible
```
Boolean getElidingEligible()
```
This property specifies whether sent messages are marked as eligible for eliding.
Default: false

Returns:

ElidingEligible property value, null if not set.

setElidingEligible
```
void setElidingEligible(Boolean elidingEligible)
```
This property specifies whether sent messages are marked as eligible for eliding.
Default: false

Parameters:

elidingEligible - the ElidingEligible property value, null to unset.

getEnvironment
```
Hashtable<?,?> getEnvironment()
```
This method gets the environment that the ConnectionFactory may have. For example, an environment that was passed in to an InitialContext.

Returns:

The environment associated with this ConnectionFactory

getGenerateSenderID
```
Boolean getGenerateSenderID()
```
This property is used to Indicates whether the client name should be included in the SenderID message header parameter. if the Sender ID is specified by the application using SupportedProperty.SOLACE_JMS_PROP_SENDER_ID, it will take precedence over the generation of a Sender ID.

Returns:

Whether the Sender ID is generated, null if not set.

setGenerateSenderID
```
void setGenerateSenderID(Boolean generateSenderId)
```
This property is used to Indicates whether the client name should be included in the SenderID message header parameter. if the Sender ID is specified by the application using SupportedProperty.SOLACE_JMS_PROP_SENDER_ID, it will take precedence over the generation of a Sender ID.

Parameters:

generateSenderId - True to generate sender id, null to unset.

getKeepAliveCountMax
```
Integer getKeepAliveCountMax()
```
This property is used to specify the allowed number of consecutive keep-alive messages for which no response is received before the connection is closed by the API.
Format: Valid values are [3.. 2147483647].
Default: 3

Returns:

KeepAliveCountMax property value, null if not set.

setKeepAliveCountMax
```
void setKeepAliveCountMax(Integer keepAliveCountMax)
```
This property is used to specify the allowed number of consecutive keep-alive messages for which no response is received before the connection is closed by the API.
Format: Valid values are [3.. 2147483647].
Default: 3

Parameters:

keepAliveCountMax - the KeepAliveCountMax property value, null to unset.

getKeepAliveIntervalInMillis
```
Integer getKeepAliveIntervalInMillis()
```
This property is used to specify the interval between keep alives in milliseconds.
Format: In milliseconds. Valid values are [0, 50]. 0 disables the keep alives.
Default: 3000 (3 seconds)

Returns:

KeepAliveIntervalInMillis property value, null if not set.

setKeepAliveIntervalInMillis
```
void setKeepAliveIntervalInMillis(Integer keepAliveIntervalInMillis)
```
This property is used to specify the interval between keep alives in milliseconds.
Format: In milliseconds. Valid values are [0, 50]. 0 disables the keep alives.
Default: 3000 (3 seconds)

Parameters:

keepAliveIntervalInMillis - the KeepAliveIntervalInMillis property value, null to unset.

getKeepAlives
```
Boolean getKeepAlives()
```
This property is used to enable/disable keep alives.
Default: true (enabled)

Returns:

KeepAlives property value, null if not set.

setKeepAlives
```
void setKeepAlives(Boolean keepAlives)
```
This property is used to enable/disable keep alives.
Default: true (enabled)

Parameters:

keepAlives - the KeepAlives property value, null to unset.

getLargeMessaging
```
Boolean getLargeMessaging()
```
This property is used to enable/disable publish/receive large AD messages.
Default: false (disabled)

Returns:

LargeMessaging property value, null if not set.

setLargeMessaging
```
void setLargeMessaging(Boolean largeMessaging)
```
This property is used to enable/disable publish/receive large AD messages..
Default: false (disabled)

Parameters:

largeMessaging - the LargeMessaging property value, null if not set.

getLargeMessagingSegmentSize
```
Integer getLargeMessagingSegmentSize()
```
Returns:

result

setLargeMessagingSegmentSize
```
void setLargeMessagingSegmentSize(Integer segmentSize)
```
Parameters:

segmentSize - parameter

getLargeMessagingMaximumSize
```
Integer getLargeMessagingMaximumSize()
```
Returns:

result

setLargeMessagingMaximumSize
```
void setLargeMessagingMaximumSize(Integer maxSize)
```
Parameters:

maxSize - parameter

getLargeMessagingConsumeTimeoutInMillis
```
Integer getLargeMessagingConsumeTimeoutInMillis()
```
Returns:

result

setLargeMessagingConsumeTimeoutInMillis
```
void setLargeMessagingConsumeTimeoutInMillis(Integer consumeTimeoutInMillis)
```
Parameters:

consumeTimeoutInMillis - parameter

getLargeMessagingIncompletePolicy
```
String getLargeMessagingIncompletePolicy()
```
Returns:

result

setLargeMessagingIncompletePolicy
```
void setLargeMessagingIncompletePolicy(String incompletePolicy)
```
Parameters:

incompletePolicy - parameter

getKRBMutualAuthentication
```
Boolean getKRBMutualAuthentication()
```
This property is used to indicate that mutual authentication is to be used when Kerberos is enabled.
Default: true (enabled)

Returns:

Kerberos mutual authentication property value, null if not set.

See Also:

#setAuthenticationScheme(string)

setKRBMutualAuthentication
```
void setKRBMutualAuthentication(Boolean mutualAuth)
```
This property is used to indicate that mutual authentication is to be used when Kerberos is enabled.
Default: true (enabled)

Parameters:

mutualAuth - Kerberos mutual authentication property value, null to unset.

See Also:

#setAuthenticationScheme

getKRBServiceName
```
String getKRBServiceName()
```
This property is used to specify the ServiceName portion of the Service Principal Name (SPN) that has a format of ServiceName/ApplianceName@REALM.
Default: "solace"

Returns:

Kerberos service name property value, null if not set.

setKRBServiceName
```
void setKRBServiceName(String serviceName)
```
This property is used to specify the ServiceName portion of the Service Principal Name (SPN) that has a format of ServiceName/ApplianceName@REALM.
Default: "solace"

Parameters:

serviceName - Kerberos service name, null to unset.

getHost
```
String getHost()
```
This property is the hostname / IP address of the appliance. This property can be set through a passed in environment with the property: @link Context#. The API extracts the host from the URL.

Returns:

Host property value, null if not set.

setHost
```
void setHost(String host)
```
This property is the hostname / IP address of the appliance. This property can be set through a passed in environment with the property: InitialContext.PROVIDER_URL. The API extracts the host from the URL.
Usage A host entry has the following form:
[Protocol:]Host[:Port]
Protocol is the protocol used for the transport channel. The valid values are:
- smf or tcp - use a TCP channel for communications between the application and its peers. If no protocol is set, smf is used as a default.
- smfs or tcps - use a SSL channel over TCP for communications between the application and its peers. The encryption with compression is not supported.
Host is the IP address (or host name) to connect to for a connection. Port is the port to connect to for a connection. A value is only required when using a port other than the automatically assigned default port number. The default port for smf is 55555 when compression is not in use, or 55003 when compression is in use. The default port for SSL is 55443.
Configuring Multiple Hosts for Redundancy and Failover
Some applications might want to have a list of appliances available for connection. Use of a host list allows applications to connect to the alternate connections should the first appliance be unavailable. The host list is configured as a comma-separated list of hosts. Each host can optionally include a port number as well. For example, if there are two appliances at 192.168.160.128 and 192.168.160.129, but the second is using the non-default port 50005 for the message bus, the HOST property would be configured as:
"192.168.160.128,192.168.160.129:50005"
When a connection is attempted, the API first attempts to connect to 192.168.160.128. If that connection fails for any reason, it attempts to connect to 192.168.160.129:50005. This process is repeated until all other entries in the host list are attempted.
After each entry has been attempted, and if all fail, the channel properties ConnectRetries, ReconnectRetries, and ReconnectRetryWaitInMillis determine the behavior of the API. If ConnectRetries is non-zero, the API waits for the amount of time set for ReconnectRetryWaitInMillis, then starts its connection attempts again from the beginning of the list. When traversing the list, each entry is attempted the number of times set for the ConnectRetriesPerHost property + 1.
If an established session to any host in the list fails, when ReconnectRetries is non-zero, the API automatically attempts to reconnect, starting at the beginning of the list.
Limitations
It is possible to specify a list of hosts to connect to, if connecting to Solace appliances running SolOS-TR. When using this feature, Guaranteed Messaging state can be reset when switching between hosts. If a client application publishes Guaranteed messages in a Session, and then a disconnect occurs, the API will not automatically reconnect to other listed hosts because another host will not know the state of the publisher flow to the original host. Without knowledge of the publisher flow’s state, it cannot be guaranteed that any unacknowledged published messages will be properly handled when another publisher flow is created to a new host. Therefore, when publishing Guaranteed messages and using a host list, the client application is responsible for recreating its Session to another listed host and keeping track of any published messages that have not been acknowledged by the host appliance when the disconnect occurs.
For typical Guaranteed Messaging scenarios, redundancy is achieved by using an active/standby pair of appliances sharing the same IP address, so only one host entry is required in the session HOST property. In this situation, once-and-only-once delivery is guaranteed.
Parameters:

host - the Host property value, null to unset.

getPassword
```
String getPassword()
```
This property is used to specify the password to connect to the appliance with. This property can be set through a passed in environment with the property: InitialContext.PROVIDER_URL. The API extracts the password from the URL.
Format: The maximum length is 128 characters.

Returns:

Password property value, null if not set.

setPassword
```
void setPassword(String password)
```
This property is used to specify the password to connect to the appliance with. This property can be set through a passed in environment with the property: InitialContext.PROVIDER_URL. The API extracts the password from the URL.
Format: The maximum length is 128 characters.

Parameters:

password - the Password property value, null to unset.

getPort
```
Integer getPort()
```
This property is used to specify the port to use for the data connection.
Format: Valid values are [-1..65535]. -1 means use the same port as specified for the JNDI connection.
Default: -1 (use JNDI connection port, or the default appliance port if no JNDI connection)

Returns:

Port property value, null if not set.

setPort
```
void setPort(Integer port)
```
This property is used to specify the port to use for the data connection.
Format: Valid values are [-1..65535]. -1 means use the same port as specified for the JNDI connection.
Default: -1 (use JNDI connection port, or the default appliance port if no JNDI connection)

Parameters:

port - the Port property value, null to unset.

getReadTimeoutInMillis
```
Integer getReadTimeoutInMillis()
```
This property is used to specify the timeout in milliseconds for reading a reply from the appliance.
Format: Valid values are [1..2147483647].
Default: 10000 (10 seconds)

Returns:

ReadTimeoutInMillis property value, null if not set.

setReadTimeoutInMillis
```
void setReadTimeoutInMillis(Integer readTimeoutInMillis)
```
This property is used to specify the timeout in milliseconds for reading a reply from the appliance.
Format: Valid values are [1..2147483647].
Default: 10000 (10 seconds)

Parameters:

readTimeoutInMillis - the ReadTimeoutInMillis property value, null to unset.

getReceiveAdAckThreshold
```
Integer getReceiveAdAckThreshold()
```
This property specifies the threshold for sending an acknowledgement to the appliance.
Format: Valid values are [1..75]
Default: 60

Returns:

ReceiveAdAckThreshold property value, null if not set.

setReceiveAdAckThreshold
```
void setReceiveAdAckThreshold(Integer receiveAdAckThreshold)
```
This property specifies the threshold for sending an acknowledgement to the appliance. The threshold for sending an acknowledgement, configured as a percentage. The API sends a transport acknowledgment every N messages where N is calculated as this percentage of the flow window size if the endpoint's max-delivered-unacked-msgs-per-flow setting at bind time is greater than or equal to the transport window size. Otherwise, N is calculated as this percentage of the endpoint's max-delivered-unacked-msgs-per-flow setting at bind time.
Format: Valid values are [1..75]
Default: 60

Parameters:

receiveAdAckThreshold - the ReceiveAdAckThreshold property value, null to unset.

getReceiveADAckTimerInMillis
```
Integer getReceiveADAckTimerInMillis()
```
This property specifies the duration of the acknowledgement timer.
Format: In milliseconds. Valid values are [20..1500]
Default: 1000 (1 second)

Returns:

ReceiveADAckTimerInMillis property value, null if not set.

setReceiveADAckTimerInMillis
```
void setReceiveADAckTimerInMillis(Integer receiveADAckTimerInMillis)
```
This property specifies the duration of the acknowledgement timer.
Format: In milliseconds. Valid values are [20..1500]
Default: 1000 (1 second)

Parameters:

receiveADAckTimerInMillis - the ReceiveADAckTimerInMillis property value, null to unset.

getReceiveADWindowSize
```
Integer getReceiveADWindowSize()
```
This property specifies the size of the sliding acknowledgement window.
Format: Valid values are [1..255]
Default: 18

Returns:

ReceiveADWindowSize property value, null if not set.

setReceiveADWindowSize
```
void setReceiveADWindowSize(Integer receiveADWindowSize)
```
This property specifies the size of the sliding acknowledgement window.
Format: Valid values are [1..255]
Default: 18

Parameters:

receiveADWindowSize - the ReceiveADWindowSize property value, null to unset.

getReceiveBufferSize
```
Integer getReceiveBufferSize()
```
This property is used to configure the socket’s receive buffer size in bytes.
Format: Valid values are greater than 0.
Default: 65536

Returns:

ReceiveBufferSize property value, null if not set.

setReceiveBufferSize
```
void setReceiveBufferSize(Integer receiveBufferSize)
```
This property is used to configure the socket’s receive buffer size in bytes.
Format: Valid values are greater than 0.
Default: 65536

Parameters:

receiveBufferSize - the ReceiveBufferSize property value, null to unset.

getReceiveReconnectRetries
```
Integer getReceiveReconnectRetries()
```
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

setReceiveReconnectRetries
```
void setReceiveReconnectRetries(Integer reconnectRetries)
```
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.

getReceiveReconnectRetryWaitInMillis
```
Integer getReceiveReconnectRetryWaitInMillis()
```
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

setReceiveReconnectRetryWaitInMillis
```
void setReceiveReconnectRetryWaitInMillis(Integer reconnectRetryWaitInMillis)
```
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.

getReconnectRetries
```
Integer getReconnectRetries()
```
This property is used to specify the number of times to attempt a reconnect once the initial data connection to the appliance has been lost.
Format: Valid values are [-1..2147483647]. -1 means retry forever.
Default: 3 retries

Returns:

ReconnectRetries property value, null if not set.

setReconnectRetries
```
void setReconnectRetries(Integer reconnectRetries)
```
This property is used to specify the number of times to attempt a reconnect once the initial data connection to the appliance has been lost.
Format: Valid values are [-1..2147483647]. -1 means retry forever.
Default: 3 retries

Parameters:

reconnectRetries - the ReconnectRetries property value, null to unset.

getReconnectRetryWaitInMillis
```
Integer getReconnectRetryWaitInMillis()
```
This property is used to specify the amount of time to wait in milliseconds between reconnect attempts.
Format: Valid values are [0..60000]. 0 means don’t wait.
Default: 3000 (3 seconds)

Returns:

ReconnectRetryWaitInMillis property value, null if not set.

setReconnectRetryWaitInMillis
```
void setReconnectRetryWaitInMillis(Integer reconnectRetryWaitInMillis)
```
This property is used to specify the amount of time to wait in milliseconds between reconnect attempts.
Format: Valid values are [0..60000]. 0 means don’t wait.
Default: 3000 (3 seconds)

Parameters:

reconnectRetryWaitInMillis - the ReconnectRetryWaitInMillis property value, null to unset.

getRespectTTL
```
Boolean getRespectTTL()
```
This property is used to indicate whether dynamically created durable topic endpoints or queues are set to respect time to live (see Dynamic Durables).
Default: true

Returns:

RespectTTL property value, null if not set.

setRespectTTL
```
void setRespectTTL(Boolean respectTTL)
```
This property is used to indicate whether dynamically created durable topic endpoints or queues are set to respect time to live (see Dynamic Durables).
Default: true

Parameters:

respectTTL - the RespectTTL property value, null to unset.

getSendADAckTimerInMillis
```
Integer getSendADAckTimerInMillis()
```
This property specifies the duration of the acknowledgement timer in milliseconds.
Format: In milliseconds. Valid values are [20..60000]
Default: 2000 (2 seconds)

Returns:

SendADAckTimerInMillis property value, null if not set.

setSendADAckTimerInMillis
```
void setSendADAckTimerInMillis(Integer sendADAckTimerInMillis)
```
This property specifies the duration of the acknowledgement timer in milliseconds.
Format: In milliseconds. Valid values are [20..60000]
Default: 2000 (2 seconds)

Parameters:

sendADAckTimerInMillis - the SendADAckTimerInMillis property value, null to unset.

getSendADMaxResends

@Deprecated
Integer getSendADMaxResends()

Deprecated.

setSendADMaxResends

@Deprecated
void setSendADMaxResends(Integer sendADMaxResends)

Deprecated.

getSendADWindowSize
```
Integer getSendADWindowSize()
```
This property specifies the size of the sliding acknowledgement window for non-persistent messages. The window size for persistent messages is fixed at 1.
Format: Valid values are [1..255]
Default: 255

Returns:

SendADWindowSize property value, null if not set.

setSendADWindowSize
```
void setSendADWindowSize(Integer sendADWindowSize)
```
This property specifies the size of the sliding acknowledgement window for non-persistent and transacted messages. The window size for persistent messages is fixed at 1.
Format: Valid values are [1..255]
Default: 255

Parameters:

sendADWindowSize - the SendADWindowSize property value, null to unset.

getSendBufferSize
```
Integer getSendBufferSize()
```
This property is used to specify the socket’s send buffer size in bytes.
Format: Valid values are greater than 0.
Default: 65536

Returns:

SendBufferSize property value, null if not set.

setSendBufferSize
```
void setSendBufferSize(Integer sendBufferSize)
```
This property is used to specify the socket’s send buffer size in bytes.
Format: Valid values are greater than 0.
Default: 65536

Parameters:

sendBufferSize - the SendBufferSize property value, null to unset.

getSSLExcludedProtocols
```
String getSSLExcludedProtocols()
```
This property is used to specify a comma separated list of encryption protocol(s) to exclude from use.
Format: Allowed values are “tlsv1.1”, “tlsv1.2”, “tlsv1.3”.
Default: “” Note that TLSv1.1 and TLSv1.2 are supported starting with Java 7.

Returns:

The SSL Excluded Protocols property value.

setSSLExcludedProtocols
```
void setSSLExcludedProtocols(String protocols)
```
This property is used to specify a comma separated list of encryption protocol(s) to exclude from use. When specifying more than one protocol the order is not important.
Format: Allowed values are “tlsv1.1”, “tlsv1.2”, “tlsv1.3”.
Default: “” Note that TLSv1.1 and TLSv1.2 are supported starting with Java 7.

Parameters:

protocols - The SSL Excluded Protocols property value, null to unset.

getSSLProtocol
```
String getSSLProtocol()
```
This property is used to specify a comma separated list of encryption protocol(s) to use.
Format: Allowed values are “tlsv1.1”, “tlsv1.2”, “tlsv1.3”.
Default: “tlsv1.1,tlsv1.2,tlsv1.3” Note that TLSv1.1 and TLSv1.2 are supported starting with Java 7.

Returns:

The SSL Protocol property value.

setSSLProtocol
```
void setSSLProtocol(String protocol)
```
This property is used to specify a comma separated list of encryption protocol(s) to use. When specifying more than one protocol the order is not important.
Format: Allowed values are “tlsv1.1”, “tlsv1.2”, “tlsv1.3”.
Default: “tlsv1.1,tlsv1.2,tlsv1.3” Note that TLSv1.1 and TLSv1.2 are supported starting with Java 7.

Parameters:

protocol - The SSL Protocol property value, null to unset.

getSSLValidateCertificate
```
Boolean getSSLValidateCertificate()
```
This property is used to indicate that the API should validate server certificates with certificates in the trust store. If set to false, no validation of the certificate date or common name is performed.
Format: Valid values are true, false.
Default: true

Returns:

True if certificate validation is enabled.

setSSLValidateCertificate

void setSSLValidateCertificate(Boolean validate)

This property is used to indicate that the API should validate server certificates with certificates in the trust store. If set to false, no validation of the certificate date or common name is performed.

SupportedProperty.SOLACE_JMS_SSL_VALIDATE_CERTIFICATE Boolean true This property is used to specify whether the API should validate server certificates with certificates in the truststore. If set to false, no validation of the certificate date or common name is performed.

Note on certificate validation:
When validating certificates, the messaging APIs for C and .NET use the following validation rules, after building the chain from the server certificate to a self-signed root certificate using certificates presented by the server and certificates in the trust store :

Verify the root certificate is trusted.
Verify depth of the chain is less than or equal to 3.

Java and JMS messaging APIs use the same rules as C and .NET with the following exceptions:

Depth validation is not enforced in Java or JMS.
When the server presents an incomplete certificate chain, Java/JMS messaging APIs only require the signer of the incomplete certificate chain to be in the trust store, where this could be insufficient for C/.NET APIs.

Therefore C and .NET messaging APIs certificate validation rules are more restrictive, hence if a certificate is accepted by C or .NET, it will definitely be accepted by Java and JMS.

Format: Valid values are true, false.

Default: true

Parameters:: validate - The SSL Validate Certificate property, null to unset.

getSSLValidateCertificateHost
```
Boolean getSSLValidateCertificateHost()
```
This method is used to get the value of the SSLValidateCertificateHost property.
Format: Valid values are true, false.
Default: true

Returns:

True if server certificate host validation is enabled.

setSSLValidateCertificateHost
```
void setSSLValidateCertificateHost(Boolean validate)
```
Boolean property to indicate if the session connection should fail when a certificate with an invalid host is received. When enabled (by default), and connecting to a named host, the certificate Subject Alternative Name must contain a DNS entry that matches the host string. When enabled, and connecting to a host by IP address, the certificate Subject Alternative Name must contain an IP Address that matches. If there is no Subject Alternate Name the certificate common name (CN) must match the named host.
This property has effect only when setSSLValidateCertificate(Boolean) property is enabled/set to true
Disabling of this property IS NOT RECOMMENDED
Default: true if not set otherwise

Parameters:

validate - The SSL Validate Certificate host property, null to unset.

getSSLValidateCertificateDate
```
Boolean getSSLValidateCertificateDate()
```
This property is used to indicate that the session connection should fail when an expired certificate or a certificate not yet in effect is received. No date validation will be performed (overriding this property) if certificate validation is set to false.
Format: Valid values are true, false.
Default: True

Returns:

True if certificate date validation is enabled.

setSSLValidateCertificateDate
```
void setSSLValidateCertificateDate(Boolean validateDate)
```
This property is used to indicate that the session connection should fail when an expired certificate or a certificate not yet in effect is received. No date validation will be performed (overriding this property) if certificate validation is set to false.
Format: Valid values are true, false.
Default: True

Parameters:

validateDate - The SSL Validate Certificate Date property, null to unset.

getSSLCipherSuites
```
String getSSLCipherSuites()
```
This property specifies a comma separated list of the cipher suites to enable in order of preference. Cipher suites can be specified using their JSSE name or OpenSSL name. The following is the list of supported Cipher suites (showing the JSSE name with the OpenSSL name in brackets):
- TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384 (ECDHE-RSA-AES256-GCM-SHA384) * Supported starting with Java 8 and requires installation of the JCE Unlimited Strength Jurisdiction Policy Files
- TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA384 (ECDHE-RSA-AES256-SHA384) * Supported starting with Java 7 and requires installation of the JCE Unlimited Strength Jurisdiction Policy Files
- TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA (ECDHE-RSA-AES256-SHA) * Supported starting with Java 7 and requires installation of the JCE Unlimited Strength Jurisdiction Policy Files
- TLS_RSA_WITH_AES_256_GCM_SHA384 (AES256-GCM-SHA384) * Supported starting with Java 8 and requires installation of the JCE Unlimited Strength Jurisdiction Policy Files
- TLS_RSA_WITH_AES_256_CBC_SHA256 (AES256-SHA256) * Supported starting with Java 7 and requires installation of the JCE Unlimited Strength Jurisdiction Policy Files
- TLS_RSA_WITH_AES_256_CBC_SHA (AES256-SHA) * Requires installation of the JCE Unlimited Strength Jurisdiction Policy Files
- TLS_ECDHE_RSA_WITH_3DES_EDE_CBC_SHA (ECDHE-RSA-DES-CBC3-SHA) * Supported starting with Java 7
- SSL_RSA_WITH_3DES_EDE_CBC_SHA (DES-CBC3-SHA)
- TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256 (ECDHE-RSA-AES128-GCM-SHA256) * Supported starting with Java 8
- TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA256 (ECDHE-RSA-AES128-SHA256) * Supported starting with Java 7
- TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA (ECDHE-RSA-AES128-SHA) * Supported starting with Java 7
- TLS_RSA_WITH_AES_128_GCM_SHA256 (AES128-GCM-SHA256) * Supported starting with Java 8
- TLS_RSA_WITH_AES_128_CBC_SHA256 (AES128-SHA256) * Supported starting with Java 7
- TLS_RSA_WITH_AES_128_CBC_SHA (AES128-SHA)
- SSL_RSA_WITH_RC4_128_SHA (RC4-SHA)
- SSL_RSA_WITH_RC4_128_MD5 (RC4-MD5)
Format: Comma separated list of cipher names.
Default: All supported ciphers.
Returns:

The list of ciphers.

setSSLCipherSuites
```
void setSSLCipherSuites(String cipherSuites)
```
This property specifies a comma separated list of the cipher suites to enable in order of preference. Cipher suites can be specified using their JSSE name or OpenSSL name. The following is the list of supported Cipher suites (showing the JSSE name with the OpenSSL name in brackets):
- TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384 (ECDHE-RSA-AES256-GCM-SHA384) * Supported starting with Java 8 and requires installation of the JCE Unlimited Strength Jurisdiction Policy Files
- TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA384 (ECDHE-RSA-AES256-SHA384) * Supported starting with Java 7 and requires installation of the JCE Unlimited Strength Jurisdiction Policy Files
- TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA (ECDHE-RSA-AES256-SHA) * Supported starting with Java 7 and requires installation of the JCE Unlimited Strength Jurisdiction Policy Files
- TLS_RSA_WITH_AES_256_GCM_SHA384 (AES256-GCM-SHA384) * Supported starting with Java 8 and requires installation of the JCE Unlimited Strength Jurisdiction Policy Files
- TLS_RSA_WITH_AES_256_CBC_SHA256 (AES256-SHA256) * Supported starting with Java 7 and requires installation of the JCE Unlimited Strength Jurisdiction Policy Files
- TLS_RSA_WITH_AES_256_CBC_SHA (AES256-SHA) * Requires installation of the JCE Unlimited Strength Jurisdiction Policy Files
- TLS_ECDHE_RSA_WITH_3DES_EDE_CBC_SHA (ECDHE-RSA-DES-CBC3-SHA) * Supported starting with Java 7
- SSL_RSA_WITH_3DES_EDE_CBC_SHA (DES-CBC3-SHA)
- TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256 (ECDHE-RSA-AES128-GCM-SHA256) * Supported starting with Java 8
- TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA256 (ECDHE-RSA-AES128-SHA256) * Supported starting with Java 7
- TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA (ECDHE-RSA-AES128-SHA) * Supported starting with Java 7
- TLS_RSA_WITH_AES_128_GCM_SHA256 (AES128-GCM-SHA256) * Supported starting with Java 8
- TLS_RSA_WITH_AES_128_CBC_SHA256 (AES128-SHA256) * Supported starting with Java 7
- TLS_RSA_WITH_AES_128_CBC_SHA (AES128-SHA)
- SSL_RSA_WITH_RC4_128_SHA (RC4-SHA)
- SSL_RSA_WITH_RC4_128_MD5 (RC4-MD5)
Format: Comma separated list of cipher names.
Default: All supported ciphers.
Parameters:

cipherSuites - The list of ciphers to enable, null to unset.

getSSLTrustStore
```
String getSSLTrustStore()
```
This property specifies the trust store to use in URL or path format.
Format: URL or path to the trust store.
Default: none.

Returns:

The URL or path to the trust store.

setSSLTrustStore
```
void setSSLTrustStore(String truststore)
```
This property specifies the trust store to use in URL or path format. Mandatory if certificate validation is true.
Format: URL or path to the trust store.
Default: none.

Parameters:

truststore - The trust store to use in URL or path format, null to unset.

getSSLTrustStorePassword
```
String getSSLTrustStorePassword()
```
This property specifies the trust store password to use.
Format: String
Default: none.

Returns:

The trust store password to use.

setSSLTrustStorePassword
```
void setSSLTrustStorePassword(String password)
```
This property specifies the trust store password to use. Mandatory if certificate validation is true.
Format: String
Default: none.

Parameters:

password - The trust store password, null to unset.

getSSLTrustStoreFormat
```
String getSSLTrustStoreFormat()
```
This property specifies the format of the given trust store.
Format: Valid values are “jks”, “pkcs12”..
Default: “jks”

Returns:

The format of the given trust store.

setSSLTrustStoreFormat
```
void setSSLTrustStoreFormat(String format)
```
This property specifies the format of the given trust store.
Format: Valid values are “jks”, “pkcs12”..
Default: “jks”

Parameters:

format - The format of the given trust store, null to unset.

getSSLKeyStore
```
String getSSLKeyStore()
```
This property specifies the key store to use in URL or path format.
Format: URL or path to the key store.
Default: none.

Returns:

The URL or path to the key store.

setSSLKeyStore
```
void setSSLKeyStore(String keystore)
```
This property specifies the key store to use in URL or path format. Mandatory if the client certificate authentication scheme is used.
Format: URL or path to the trust store.
Default: none.

Parameters:

keystore - The key store to use in URL or path format, null to unset.

getSSLKeyStorePassword
```
String getSSLKeyStorePassword()
```
This property specifies the key store password to use.
Format: String
Default: none.

Returns:

The key store password to use.

setSSLKeyStorePassword
```
void setSSLKeyStorePassword(String password)
```
This property specifies the key store password to use. Mandatory if the client certificate authentication scheme is used.
Format: String
Default: none.

Parameters:

password - The key store password, null to unset.

getSSLKeyStoreFormat
```
String getSSLKeyStoreFormat()
```
This property specifies the format of the given key store.
Format: Valid values include “jks”, “pkcs12”..
Default: “jks”

Returns:

The format of the given key store.

setSSLKeyStoreFormat
```
void setSSLKeyStoreFormat(String format)
```
This property specifies the format of the given key store.
Format: Valid values include “jks”, “pkcs12”..
Default: “jks”

Parameters:

format - The format of the given key store, null to unset.

getSSLKeyStoreNormalizedFormat
```
String getSSLKeyStoreNormalizedFormat()
```
This property specifies the internal normalized format of the given key store.
Format: Valid values include “jks”, “pkcs12”, etc.
Default: none

Returns:

The format of the internal normalized key store.

setSSLKeyStoreNormalizedFormat
```
void setSSLKeyStoreNormalizedFormat(String format)
```
This property specifies the internal normalized format of the given key store.
Format: Valid values include “jks”, “pkcs12”, etc.
Default: none

Parameters:

format - The format of the internal normalized key store, null to unset.

getSSLPrivateKeyAlias
```
String getSSLPrivateKeyAlias()
```
This property specifies which private key in the key store is to be used for the client certificate authentication.

Returns:

The alias of the private key

setSSLPrivateKeyAlias
```
void setSSLPrivateKeyAlias(String alias)
```
This property specifies which private key in the key store is to be used for the client certificate authentication.

Parameters:

alias - The alias of the private key

getSSLPrivateKeyPassword
```
String getSSLPrivateKeyPassword()
```
This property specifies the password used to decipher the client certificate private key from the key store.

Returns:

The password used to decipher the private key

setSSLPrivateKeyPassword
```
void setSSLPrivateKeyPassword(String password)
```
This property specifies the password used to decipher the client certificate private key from the key store.

Parameters:

password - The password used to decipher the private key

getSSLTrustedCommonNameList
```
String getSSLTrustedCommonNameList()
```
This property specifies the list of acceptable common names for matching in server certificates. The API performs a case insensitive comparison of the common names provided in this property with the common name in the server certificate. No common names provided means that all common names are acceptable. No common name validation will be performed (overriding this property) if certificate validation is set to false.
Format: A comma separated list of common names.
Default: No common names provided means that all common names are acceptable.

Returns:

The list of acceptable common names for matching in server certificates.

setSSLTrustedCommonNameList
```
void setSSLTrustedCommonNameList(String commonNames)
```
This property specifies the list of acceptable common names for matching in server certificates. The API performs a case insensitive comparison of the common names provided in this property with the common name in the server certificate. No common names provided means that all common names are acceptable. No common name validation will be performed (overriding this property) if certificate validation is set to false.
Format: A comma separated list of common names.
Default: No common names provided means that all common names are acceptable.

Parameters:

commonNames - The list of acceptable common names for matching in server certificates, null to unset.

getSubscriberLocalPriority
```
Integer getSubscriberLocalPriority()
```
This property specifies the priority that a client’s subscriptions have for receiving Deliver-To-One messages published on the Solace appliance that the client is directly connected to.
Format: Valid values are [1..4]
Default: 1

Returns:

SubscriberLocalPriority property value, null if not set.

setSubscriberLocalPriority
```
void setSubscriberLocalPriority(Integer subscriberLocalPriority)
```
This property specifies the priority that a client’s subscriptions have for receiving Deliver-To-One messages published on the Solace appliance that the client is directly connected to.
Format: Valid values are [1..4]
Default: 1

Parameters:

subscriberLocalPriority - the SubscriberLocalPriority property value, null to unset.

getSubscriberNetworkPriority
```
Integer getSubscriberNetworkPriority()
```
This property specifies the priority that a client’s subscriptions have for receiving Deliver-To-One messages published by other Solace appliances in the Solace Messaging Platform.
Format: Valid values are [1..4]
Default: 1

Returns:

SubscriberNetworkPriority property value, null if not set.

setSubscriberNetworkPriority
```
void setSubscriberNetworkPriority(Integer subscriberNetworkPriority)
```
This property specifies the priority that a client’s subscriptions have for receiving Deliver-To-One messages published by other Solace appliances in the Solace Messaging Platform.
Format: Valid values are [1..4]
Default: 1

Parameters:

subscriberNetworkPriority - the SubscriberNetworkPriority property value, null to unset.

getTcpNoDelay
```
Boolean getTcpNoDelay()
```
This property is used to specify whether to set the TCP_NODELAY option. When enabled, this option disables Nagle's algorithm.
Default: true

Returns:

TcpNoDelay property value, null if not set.

setTcpNoDelay
```
void setTcpNoDelay(Boolean tcpNoDelay)
```
This property is used to specify whether to set the TCP_NODELAY option. When enabled, this option disables Nagle's algorithm.
Default: true

Parameters:

tcpNoDelay - the TcpNoDelay property value, null to unset.

getUseDefaultContext
```
Boolean getUseDefaultContext()
```
This property is used to indicate whether to use a new context or reuse the default context for new JMS connections.
Default: false (creates a new context for every connection)

Returns:

UseDefaultContext property value, null if not set.

setUseDefaultContext
```
void setUseDefaultContext(Boolean useDefaultContext)
```
This property is used to indicate whether to use a new context or reuse the default context for new JMS connections.
Default: false (creates a new context for every connection)

Parameters:

useDefaultContext - the UseDefaultContext property value, null to unset.

getUsername
```
String getUsername()
```
This property is used to specify the username to connect to the appliance with. This property can be set through a passed in environment with the property: InitialContext.PROVIDER_URL. The API extracts the username from the URL.
Format: The maximum length is 189 bytes when encoded in UTF-8 (with SolOS-TR 6.1 and above)

Returns:

Username property value, null if not set.

setUsername
```
void setUsername(String username)
```
This property is used to specify the username to connect to the appliance with. This property can be set through a passed in environment with the property: InitialContext.PROVIDER_URL. The API extracts the username from the URL.
Username is optional when using SupportedProperty.AUTHENTICATION_SCHEME_CLIENT_CERTIFICATE (Client Certificate based authentication) with setAuthenticationScheme(String)
Format: The maximum length is 189 bytes when encoded in UTF-8 (with SolOS-TR 6.1 and above).

Parameters:

username - the Username property value, null to unset.

getVPN
```
String getVPN()
```
This property is used to specify the VPN to use when connecting to the appliance. The default value is “” which means connect to the default VPN.
Format: The maximum length is 32 bytes when encoded in UTF-8
Default: “”

Returns:

VPN property value, null if not set.

setVPN
```
void setVPN(String vpn)
```
This property is used to specify the VPN to use when connecting to the appliance. The default value is “” which means connect to the default VPN.
Format: The maximum length is 32 bytes when encoded in UTF-8
Default: “”

Parameters:

vpn - the VPN property value, null to unset.

getSSLConnectionDowngradeTo
```
String getSSLConnectionDowngradeTo()
```
This property specifies a transport protocol that SSL connection will be downgraded to after client authentication. Allowed values: "PLAIN_TEXT".

Returns:

transport protocol, null if not set.

setSSLConnectionDowngradeTo
```
void setSSLConnectionDowngradeTo(String proto)
```
This property specifies a transport protocol that SSL connection will be downgraded to after client authentication. Allowed values: "PLAIN_TEXT".

Parameters:

proto - the SSLConnectionDowngradeTo property value, null to unset.

getXA
```
Boolean getXA()
```
This property specified whether this is an XA Connection Factory. Whether this is an XA Connection Factory can also be determined by performing instanceof.
Default: false

Returns:

XA property value, null if not set.

getXmlPayload
```
Boolean getXmlPayload()
```
This property specifies whether sent text messages have an XML payload.
Default: true

Returns:

XmlPayload property value, null if not set.

setXmlPayload
```
void setXmlPayload(Boolean xmlPayload)
```
This property specifies whether sent text messages have an XML payload.
Default: true

Parameters:

xmlPayload - the XmlPayload property value, null to unset.

getUnknownPublisherFlowAction
```
String getUnknownPublisherFlowAction()
```
This property specifies

Returns:

UnknownPublisherFlowAction property value, null if not set

setUnknownPublisherFlowAction
```
void setUnknownPublisherFlowAction(String action)
```
This property specifies
Default:

Parameters:

action - the UnknownPublisherFlowAction property value, null to unset.

getPropertyNames
```
Set<String> getPropertyNames()
```
Gets the property names for all the properties. To be used with getProperty(String) and setProperty(String, Object)

Returns:

The set of property names

getProperty
```
Object getProperty(String name)
```
Gets the property value given its name. The name must be one of the values in the set from getPropertyNames()

Parameters:

name - Name of the property to return

Returns:

The named property's value

setProperty
```
void setProperty(String name,
                 Object value)
```
Sets a property's value given its name. The name must be one of the values in the set from getPropertyNames()

Parameters:

name - The name of the property to set

value - The value to set the property t

Throws:

IllegalArgumentException - on error

getEffectiveProperty
```
Object getEffectiveProperty(String name)
```
Gets a property's value given its name. The name must be one of the values in the set from getPropertyNames() This method differs from getProperty(String) in that it returns the value that will be used in connection creation. If a property has not been set through the api (or even if it has), this method may return the default value or another value that overrides the connection factory's value.

Parameters:

name - Name of the property to return.

Returns:

The named property's effective value for connection creation.

toEffectiveString
```
String toEffectiveString()
```
Returns a string representation of all the property values as if the method getEffectiveProperty(String) was used to retrieve them.

Returns:

A string representation of the effective property values.

toProperties
```
Properties toProperties()
```
Gets the properties in a Properties instance.

Returns:

the properties in a Properties instance.

fromProperties
```
void fromProperties(Properties properties)
```
Sets the properties based on values in a Properties instance.

Parameters:

properties - Values to set the ConnectionFactory properties from.

Throws:

IllegalArgumentException - on error

Interface SolConnectionFactory

Method Summary

Methods inherited from interface javax.jms.QueueConnectionFactory

Methods inherited from interface javax.jms.TopicConnectionFactory

Methods inherited from interface javax.jms.ConnectionFactory

Methods inherited from interface javax.naming.Referenceable

Method Detail

getAuthenticationScheme

setAuthenticationScheme

getBrowserTimeoutInMS

setBrowserTimeoutInMS

getCallbackOnIOThread

setCallbackOnIOThread

getClientDescription

setClientDescription

getClientID

setClientID

getCompressionLevel

setCompressionLevel

getPayloadCompressionLevel

setPayloadCompressionLevel

getConnectRetries

setConnectRetries

getConnectRetriesPerHost

setConnectRetriesPerHost

getConnectTimeoutInMillis

setConnectTimeoutInMillis

getDeliveryMode

setDeliveryMode

getDeliverToOne

setDeliverToOne

getDeliverToOneOverride

setDeliverToOneOverride

getDirectOptimized

setDirectOptimized

getDirectTransport

setDirectTransport

getJMSXUserIDEnabled

getAllowDuplicateClientId

getDmqEligible

setDmqEligible

getDynamicDurables

setDynamicDurables

getElidingEligible

setElidingEligible

getEnvironment

getGenerateSenderID

setGenerateSenderID

getKeepAliveCountMax

setKeepAliveCountMax

getKeepAliveIntervalInMillis

setKeepAliveIntervalInMillis

getKeepAlives

setKeepAlives

getLargeMessaging

setLargeMessaging

getLargeMessagingSegmentSize

setLargeMessagingSegmentSize

getLargeMessagingMaximumSize

setLargeMessagingMaximumSize

getLargeMessagingConsumeTimeoutInMillis

setLargeMessagingConsumeTimeoutInMillis

getLargeMessagingIncompletePolicy

setLargeMessagingIncompletePolicy

getKRBMutualAuthentication

setKRBMutualAuthentication

getKRBServiceName

setKRBServiceName

getHost

setHost

Configuring Multiple Hosts for Redundancy and Failover

Limitations

getPassword

setPassword

getPort

setPort

getReadTimeoutInMillis

setReadTimeoutInMillis

getReceiveAdAckThreshold

setReceiveAdAckThreshold