SolConnectionFactoryImpl (Solace JMS API v10.10.2)

java.lang.Object
- com.solacesystems.jms.SolConnectionFactoryImpl

All Implemented Interfaces:

SolConnectionFactory, Serializable, Cloneable, ConnectionFactory, QueueConnectionFactory, TopicConnectionFactory, Referenceable

Direct Known Subclasses:

SolXAConnectionFactoryImpl
```
public class SolConnectionFactoryImpl
extends Object
implements SolConnectionFactory, Serializable, Cloneable
```
Bug 64727: SolConnectionFactoryImpl is exposed publicly but undocumented and unsupported

See Also:

Serialized Form

Constructor Summary

Constructors
Constructor and Description

SolConnectionFactoryImpl()

SolConnectionFactoryImpl(JMSProperties properties)

Constructors
Constructor and Description
`SolConnectionFactoryImpl()`
`SolConnectionFactoryImpl(JMSProperties properties)`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`Object`	`clone()`
`Connection`	`createConnection()` Creates a connection with the default user identity.
`Connection`	`createConnection(String userName, String password)` Creates a connection with the specified user identity.
`QueueConnection`	`createQueueConnection()` Creates a queue connection with the default user identity.
`QueueConnection`	`createQueueConnection(String userName, String password)` Creates a queue connection with the specified user identity.
`TopicConnection`	`createTopicConnection()` Creates a topic connection with the default user identity.
`TopicConnection`	`createTopicConnection(String userName, String password)` Creates a topic connection with the specified user identity.
`boolean`	`equals(Object obj)`
`void`	`fromJNDIProperties(JNDIObject obj)`
`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.
`JMSProperties`	`getJMSProperties()`
`JMSPropertyBean`	`getJMSPropertyBean()`
`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`	`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.
`Reference`	`getReference()`
`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()`
`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.
`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.
`int`	`hashCode()`
`static boolean`	`isXAEnabled(JNDIObject obj, JMSProperties properties)`
`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`	`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 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 protocol)` 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`	`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`	`setXA(Boolean xa)`
`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 `SolConnectionFactory.getEffectiveProperty(String)` was used to retrieve them.
`Properties`	`toProperties()` Gets the properties in a `Properties` instance.
`String`	`toString()`

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

SolConnectionFactoryImpl
```
public SolConnectionFactoryImpl()
```

SolConnectionFactoryImpl

public SolConnectionFactoryImpl(JMSProperties properties)

Method Detail

getJMSProperties

public JMSProperties getJMSProperties()

getJMSPropertyBean

public JMSPropertyBean getJMSPropertyBean()

createConnection
```
public Connection createConnection()
                            throws JMSException
```
Description copied from interface: ConnectionFactory

Creates a connection with the default user identity. The connection is created in stopped mode. No messages will be delivered until the Connection.start method is explicitly called.

Specified by:

createConnection in interface ConnectionFactory

Returns:

a newly created connection

Throws:

JMSException - if the JMS provider fails to create the connection due to some internal error.

JMSSecurityException - if client authentication fails due to an invalid user name or password.

createConnection
```
public Connection createConnection(String userName,
                                   String password)
                            throws JMSException
```
Description copied from interface: ConnectionFactory

Creates a connection with the specified user identity. The connection is created in stopped mode. No messages will be delivered until the Connection.start method is explicitly called.

Specified by:

createConnection in interface ConnectionFactory

Parameters:

userName - the caller's user name

password - the caller's password

Returns:

a newly created connection

Throws:

JMSException - if the JMS provider fails to create the connection due to some internal error.

JMSSecurityException - if client authentication fails due to an invalid user name or password.

createQueueConnection
```
public QueueConnection createQueueConnection()
                                      throws JMSException
```
Description copied from interface: QueueConnectionFactory

Creates a queue connection with the default user identity. The connection is created in stopped mode. No messages will be delivered until the Connection.start method is explicitly called. .

Specified by:

createQueueConnection in interface QueueConnectionFactory

Returns:

a newly created queue connection

Throws:

JMSException - if the JMS provider fails to create the queue connection due to some internal error.

JMSSecurityException - if client authentication fails due to an invalid user name or password.

createQueueConnection
```
public QueueConnection createQueueConnection(String userName,
                                             String password)
                                      throws JMSException
```
Description copied from interface: QueueConnectionFactory

Creates a queue connection with the specified user identity. The connection is created in stopped mode. No messages will be delivered until the Connection.start method is explicitly called.

Specified by:

createQueueConnection in interface QueueConnectionFactory

Parameters:

userName - the caller's user name

password - the caller's password

Returns:

a newly created queue connection

Throws:

JMSException - if the JMS provider fails to create the queue connection due to some internal error.

JMSSecurityException - if client authentication fails due to an invalid user name or password.

createTopicConnection
```
public TopicConnection createTopicConnection()
                                      throws JMSException
```
Description copied from interface: TopicConnectionFactory

Creates a topic connection with the default user identity. The connection is created in stopped mode. No messages will be delivered until the Connection.start method is explicitly called.

Specified by:

createTopicConnection in interface TopicConnectionFactory

Returns:

a newly created topic connection

Throws:

JMSException - if the JMS provider fails to create a topic connection due to some internal error.

JMSSecurityException - if client authentication fails due to an invalid user name or password.

createTopicConnection
```
public TopicConnection createTopicConnection(String userName,
                                             String password)
                                      throws JMSException
```
Description copied from interface: TopicConnectionFactory

Creates a topic connection with the specified user identity. The connection is created in stopped mode. No messages will be delivered until the Connection.start method is explicitly called.

Specified by:

createTopicConnection in interface TopicConnectionFactory

Parameters:

userName - the caller's user name

password - the caller's password

Returns:

a newly created topic connection

Throws:

JMSException - if the JMS provider fails to create a topic connection due to some internal error.

JMSSecurityException - if client authentication fails due to an invalid user name or password.

getProperty
```
public Object getProperty(String name)
```
Description copied from interface: SolConnectionFactory

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

Specified by:

getProperty in interface SolConnectionFactory

Parameters:

name - Name of the property to return

Returns:

The named property's value

getEffectiveProperty
```
public Object getEffectiveProperty(String name)
```
Description copied from interface: SolConnectionFactory

Gets a property's value given its name. The name must be one of the values in the set from SolConnectionFactory.getPropertyNames() This method differs from SolConnectionFactory.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.

Specified by:

getEffectiveProperty in interface SolConnectionFactory

Parameters:

name - Name of the property to return.

Returns:

The named property's effective value for connection creation.

setProperty
```
public void setProperty(String name,
                        Object value)
```
Description copied from interface: SolConnectionFactory

Sets a property's value given its name. The name must be one of the values in the set from SolConnectionFactory.getPropertyNames()

Specified by:

setProperty in interface SolConnectionFactory

Parameters:

name - The name of the property to set

value - The value to set the property t

getPropertyNames
```
public Set<String> getPropertyNames()
```
Description copied from interface: SolConnectionFactory

Gets the property names for all the properties. To be used with SolConnectionFactory.getProperty(String) and SolConnectionFactory.setProperty(String, Object)

Specified by:

getPropertyNames in interface SolConnectionFactory

Returns:

The set of property names

getAuthenticationScheme
```
public String getAuthenticationScheme()
```
Description copied from interface: SolConnectionFactory
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)
Default: SupportedProperty.AUTHENTICATION_SCHEME_BASIC
Specified by:

getAuthenticationScheme in interface SolConnectionFactory

Returns:

The authentication scheme

setAuthenticationScheme
```
public void setAuthenticationScheme(String scheme)
```
Description copied from interface: SolConnectionFactory
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)
Default: SupportedProperty.AUTHENTICATION_SCHEME_BASIC
Specified by:

setAuthenticationScheme in interface SolConnectionFactory

Parameters:

scheme - The authentication scheme

getBrowserTimeoutInMS
```
public Integer getBrowserTimeoutInMS()
```
Description copied from interface: SolConnectionFactory

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)

Specified by:

getBrowserTimeoutInMS in interface SolConnectionFactory

Returns:

the BrowserTimeoutInMS property value, null if not set.

setBrowserTimeoutInMS
```
public void setBrowserTimeoutInMS(Integer timeout)
```
Description copied from interface: SolConnectionFactory

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)

Specified by:

setBrowserTimeoutInMS in interface SolConnectionFactory

Parameters:

timeout - the BrowserTimeoutInMS property value, null to unset.

getCallbackOnIOThread
```
public Boolean getCallbackOnIOThread()
```
Description copied from interface: SolConnectionFactory

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

Specified by:

getCallbackOnIOThread in interface SolConnectionFactory

Returns:

the CallbackOnIOThread property value, null if not set.

setCallbackOnIOThread
```
public void setCallbackOnIOThread(Boolean callbackOnIOThread)
```
Description copied from interface: SolConnectionFactory

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

Specified by:

setCallbackOnIOThread in interface SolConnectionFactory

Parameters:

callbackOnIOThread - the CallbackOnIOThread property value, null to unset.

getClientDescription
```
public String getClientDescription()
```
Description copied from interface: SolConnectionFactory

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: “”

Specified by:

getClientDescription in interface SolConnectionFactory

Returns:

the ClientDescription property value, null if not set.

setClientDescription
```
public void setClientDescription(String clientDescription)
```
Description copied from interface: SolConnectionFactory

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: “”

Specified by:

setClientDescription in interface SolConnectionFactory

Parameters:

clientDescription - the ClientDescription property value, null to unset.

getClientID
```
public String getClientID()
```
Description copied from interface: SolConnectionFactory

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

Specified by:

getClientID in interface SolConnectionFactory

Returns:

the ClientID property value, null if not set.

setClientID
```
public void setClientID(String clientID)
```
Description copied from interface: SolConnectionFactory

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

Specified by:

setClientID in interface SolConnectionFactory

Parameters:

clientID - the ClientID property value, null to unset.

getCompressionLevel
```
public Integer getCompressionLevel()
```
Description copied from interface: SolConnectionFactory

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. O disables compression. 1-9 sets the ZLIB compression level.
Default: -1 (use JNDI connection’s compression level, 0 if no JNDI connection)

Specified by:

getCompressionLevel in interface SolConnectionFactory

Returns:

the CompressionLevel property value, null if not set.

setCompressionLevel
```
public void setCompressionLevel(Integer compressionLevel)
```
Description copied from interface: SolConnectionFactory

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. O disables compression. 1-9 sets the ZLIB compression level.
Default: -1 (use JNDI connection’s compression level, 0 if no JNDI connection)

Specified by:

setCompressionLevel in interface SolConnectionFactory

Parameters:

compressionLevel - the CompressionLevel property value, null to unset.

getConnectRetries
```
public Integer getConnectRetries()
```
Description copied from interface: SolConnectionFactory

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)

Specified by:

getConnectRetries in interface SolConnectionFactory

Returns:

the ConnectRetries property value, null if not set.

setConnectRetries
```
public void setConnectRetries(Integer connectRetries)
```
Description copied from interface: SolConnectionFactory

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)

Specified by:

setConnectRetries in interface SolConnectionFactory

Parameters:

connectRetries - the ConnectRetries property value, null to unset.

getConnectRetriesPerHost
```
public Integer getConnectRetriesPerHost()
```
Description copied from interface: SolConnectionFactory

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)

Specified by:

getConnectRetriesPerHost in interface SolConnectionFactory

Returns:

the ConnectRetriesPerHost property value, null if not set.

setConnectRetriesPerHost
```
public void setConnectRetriesPerHost(Integer connectRetriesPerHost)
```
Description copied from interface: SolConnectionFactory

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)

Specified by:

setConnectRetriesPerHost in interface SolConnectionFactory

Parameters:

connectRetriesPerHost - the ConnectRetriesPerHost property value, null to unset.

getConnectTimeoutInMillis
```
public Integer getConnectTimeoutInMillis()
```
Description copied from interface: SolConnectionFactory

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)

Specified by:

getConnectTimeoutInMillis in interface SolConnectionFactory

Returns:

the ConnectTimeoutInMillis property value, null if not set.

setConnectTimeoutInMillis
```
public void setConnectTimeoutInMillis(Integer connectTimeoutInMillis)
```
Description copied from interface: SolConnectionFactory

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)

Specified by:

setConnectTimeoutInMillis in interface SolConnectionFactory

Parameters:

connectTimeoutInMillis - the ConnectTimeoutInMillis property value, null to unset.

getDeliveryMode
```
public Integer getDeliveryMode()
```
Description copied from interface: SolConnectionFactory

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

Specified by:

getDeliveryMode in interface SolConnectionFactory

Returns:

the DeliveryMode property value, null if not set.

setDeliveryMode
```
public void setDeliveryMode(Integer deliveryMode)
```
Description copied from interface: SolConnectionFactory

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

Specified by:

setDeliveryMode in interface SolConnectionFactory

Parameters:

deliveryMode - the DeliveryMode property value, null to unset.

getDeliverToOne
```
public Boolean getDeliverToOne()
```
Description copied from interface: SolConnectionFactory

This property specifies whether sent messages are deliver to one.
Default: false

Specified by:

getDeliverToOne in interface SolConnectionFactory

Returns:

the DeliverToOne property value, null if not set.

setDeliverToOne
```
public void setDeliverToOne(Boolean deliverToOne)
```
Description copied from interface: SolConnectionFactory

This property specifies whether sent messages are deliver to one.
Default: false

Specified by:

setDeliverToOne in interface SolConnectionFactory

Parameters:

deliverToOne - the DeliverToOne property value, null to unset.

getDeliverToOneOverride
```
public Boolean getDeliverToOneOverride()
```
Description copied from interface: SolConnectionFactory

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.

Specified by:

getDeliverToOneOverride in interface SolConnectionFactory

Returns:

the DeliverToOneOverride property value, null if not set.

setDeliverToOneOverride
```
public void setDeliverToOneOverride(Boolean deliverToOneOverride)
```
Description copied from interface: SolConnectionFactory

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.

Specified by:

setDeliverToOneOverride in interface SolConnectionFactory

Parameters:

deliverToOneOverride - the DeliverToOneOverride property value, null to unset.

getDirectOptimized
```
public Boolean getDirectOptimized()
```
Description copied from interface: SolConnectionFactory

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.

Specified by:

getDirectOptimized in interface SolConnectionFactory

Returns:

DirectOptimized property value, null if not set.

setDirectOptimized
```
public void setDirectOptimized(Boolean directOptimized)
```
Description copied from interface: SolConnectionFactory

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.

Specified by:

setDirectOptimized in interface SolConnectionFactory

Parameters:

directOptimized - the DirectOptimized property value, null to unset.

getDirectTransport
```
public Boolean getDirectTransport()
```
Description copied from interface: SolConnectionFactory

This property specifies whether to use direct transport for non-persistent messages.
Default: true.

Specified by:

getDirectTransport in interface SolConnectionFactory

Returns:

DirectTransport property value, null if not set.

getJMSXUserIDEnabled
```
public Boolean getJMSXUserIDEnabled()
```
Description copied from interface: SolConnectionFactory

This property specifies whether JMSXUserID property should be set.
Default: false.

Specified by:

getJMSXUserIDEnabled in interface SolConnectionFactory

Returns:

JMSXUserIDEnabled property value, null if not set.

getAllowDuplicateClientId
```
public Boolean getAllowDuplicateClientId()
```
Description copied from interface: SolConnectionFactory

This property specifies whether a duplicate client ID is allowed.
Default: false.

Specified by:

getAllowDuplicateClientId in interface SolConnectionFactory

Returns:

AllowDuplicateClientId property value, null if not set.

setDirectTransport
```
public void setDirectTransport(Boolean directTransport)
```
Description copied from interface: SolConnectionFactory

This property specifies whether to use direct transport for non-persistent messages.
Default: true.

Specified by:

setDirectTransport in interface SolConnectionFactory

Parameters:

directTransport - the DirectTransport property value, null to unset.

getDmqEligible
```
public Boolean getDmqEligible()
```
Description copied from interface: SolConnectionFactory

This property specifies whether sent messages are eligible for the dead message queue.
Default: false

Specified by:

getDmqEligible in interface SolConnectionFactory

Returns:

DmqEligible property value, null if not set.

setDmqEligible
```
public void setDmqEligible(Boolean dmqEligible)
```
Description copied from interface: SolConnectionFactory

This property specifies whether sent messages are eligible for the dead message queue.
Default: false

Specified by:

setDmqEligible in interface SolConnectionFactory

Parameters:

dmqEligible - the DmqEligible property value, null to unset.

getDynamicDurables
```
public Boolean getDynamicDurables()
```
Description copied from interface: SolConnectionFactory

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

Specified by:

getDynamicDurables in interface SolConnectionFactory

Returns:

DynamicDurables property value, null if not set.

setDynamicDurables
```
public void setDynamicDurables(Boolean dynamicDurables)
```
Description copied from interface: SolConnectionFactory

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

Specified by:

setDynamicDurables in interface SolConnectionFactory

Parameters:

dynamicDurables - the DynamicDurables property value, null to unset.

getElidingEligible
```
public Boolean getElidingEligible()
```
Description copied from interface: SolConnectionFactory

This property specifies whether sent messages are marked as eligible for eliding.
Default: false

Specified by:

getElidingEligible in interface SolConnectionFactory

Returns:

ElidingEligible property value, null if not set.

setElidingEligible
```
public void setElidingEligible(Boolean elidingEligible)
```
Description copied from interface: SolConnectionFactory

This property specifies whether sent messages are marked as eligible for eliding.
Default: false

Specified by:

setElidingEligible in interface SolConnectionFactory

Parameters:

elidingEligible - the ElidingEligible property value, null to unset.

getEnvironment
```
public Hashtable<?,?> getEnvironment()
```
Description copied from interface: SolConnectionFactory

This method gets the environment that the ConnectionFactory may have. For example, an environment that was passed in to an InitialContext.

Specified by:

getEnvironment in interface SolConnectionFactory

Returns:

The environment associated with this ConnectionFactory

getGenerateSenderID
```
public Boolean getGenerateSenderID()
```
Description copied from interface: SolConnectionFactory

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.

Specified by:

getGenerateSenderID in interface SolConnectionFactory

Returns:

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

setGenerateSenderID
```
public void setGenerateSenderID(Boolean generateSenderId)
```
Description copied from interface: SolConnectionFactory

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.

Specified by:

setGenerateSenderID in interface SolConnectionFactory

Parameters:

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

getHost
```
public String getHost()
```
Description copied from interface: SolConnectionFactory

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.

Specified by:

getHost in interface SolConnectionFactory

Returns:

Host property value, null if not set.

setHost
```
public void setHost(String host)
```
Description copied from interface: SolConnectionFactory
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.
Specified by:

setHost in interface SolConnectionFactory

Parameters:

host - the Host property value, null to unset.

getKeepAliveCountMax
```
public Integer getKeepAliveCountMax()
```
Description copied from interface: SolConnectionFactory

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

Specified by:

getKeepAliveCountMax in interface SolConnectionFactory

Returns:

KeepAliveCountMax property value, null if not set.

setKeepAliveCountMax
```
public void setKeepAliveCountMax(Integer keepAliveCountMax)
```
Description copied from interface: SolConnectionFactory

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

Specified by:

setKeepAliveCountMax in interface SolConnectionFactory

Parameters:

keepAliveCountMax - the KeepAliveCountMax property value, null to unset.

getKeepAliveIntervalInMillis
```
public Integer getKeepAliveIntervalInMillis()
```
Description copied from interface: SolConnectionFactory

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)

Specified by:

getKeepAliveIntervalInMillis in interface SolConnectionFactory

Returns:

KeepAliveIntervalInMillis property value, null if not set.

setKeepAliveIntervalInMillis
```
public void setKeepAliveIntervalInMillis(Integer keepAliveIntervalInMillis)
```
Description copied from interface: SolConnectionFactory

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)

Specified by:

setKeepAliveIntervalInMillis in interface SolConnectionFactory

Parameters:

keepAliveIntervalInMillis - the KeepAliveIntervalInMillis property value, null to unset.

getKeepAlives
```
public Boolean getKeepAlives()
```
Description copied from interface: SolConnectionFactory

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

Specified by:

getKeepAlives in interface SolConnectionFactory

Returns:

KeepAlives property value, null if not set.

setKeepAlives
```
public void setKeepAlives(Boolean keepAlives)
```
Description copied from interface: SolConnectionFactory

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

Specified by:

setKeepAlives in interface SolConnectionFactory

Parameters:

keepAlives - the KeepAlives property value, null to unset.

getKRBMutualAuthentication
```
public Boolean getKRBMutualAuthentication()
```
Description copied from interface: SolConnectionFactory

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

Specified by:

getKRBMutualAuthentication in interface SolConnectionFactory

Returns:

Kerberos mutual authentication property value, null if not set.

See Also:

#setAuthenticationScheme(string)

setKRBMutualAuthentication
```
public void setKRBMutualAuthentication(Boolean mutualAuth)
```
Description copied from interface: SolConnectionFactory

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

Specified by:

setKRBMutualAuthentication in interface SolConnectionFactory

Parameters:

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

See Also:

#setAuthenticationScheme

getKRBServiceName
```
public String getKRBServiceName()
```
Description copied from interface: SolConnectionFactory

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"

Specified by:

getKRBServiceName in interface SolConnectionFactory

Returns:

Kerberos service name property value, null if not set.

setKRBServiceName
```
public void setKRBServiceName(String serviceName)
```
Description copied from interface: SolConnectionFactory

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"

Specified by:

setKRBServiceName in interface SolConnectionFactory

Parameters:

serviceName - Kerberos service name, null to unset.

getLargeMessaging
```
public Boolean getLargeMessaging()
```
Description copied from interface: SolConnectionFactory

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

Specified by:

getLargeMessaging in interface SolConnectionFactory

Returns:

LargeMessaging property value, null if not set.

setLargeMessaging
```
public void setLargeMessaging(Boolean largeMessaging)
```
Description copied from interface: SolConnectionFactory

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

Specified by:

setLargeMessaging in interface SolConnectionFactory

Parameters:

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

getLargeMessagingSegmentSize
```
public Integer getLargeMessagingSegmentSize()
```
Specified by:

getLargeMessagingSegmentSize in interface SolConnectionFactory

Returns:

result

setLargeMessagingSegmentSize
```
public void setLargeMessagingSegmentSize(Integer segmentSize)
```
Specified by:

setLargeMessagingSegmentSize in interface SolConnectionFactory

Parameters:

segmentSize - parameter

getLargeMessagingMaximumSize
```
public Integer getLargeMessagingMaximumSize()
```
Specified by:

getLargeMessagingMaximumSize in interface SolConnectionFactory

Returns:

result

setLargeMessagingMaximumSize
```
public void setLargeMessagingMaximumSize(Integer maxSize)
```
Specified by:

setLargeMessagingMaximumSize in interface SolConnectionFactory

Parameters:

maxSize - parameter

getLargeMessagingConsumeTimeoutInMillis
```
public Integer getLargeMessagingConsumeTimeoutInMillis()
```
Specified by:

getLargeMessagingConsumeTimeoutInMillis in interface SolConnectionFactory

Returns:

result

setLargeMessagingConsumeTimeoutInMillis
```
public void setLargeMessagingConsumeTimeoutInMillis(Integer consumeTimeoutInMillis)
```
Specified by:

setLargeMessagingConsumeTimeoutInMillis in interface SolConnectionFactory

Parameters:

consumeTimeoutInMillis - parameter

getLargeMessagingIncompletePolicy
```
public String getLargeMessagingIncompletePolicy()
```
Specified by:

getLargeMessagingIncompletePolicy in interface SolConnectionFactory

Returns:

result

setLargeMessagingIncompletePolicy
```
public void setLargeMessagingIncompletePolicy(String incompletePolicy)
```
Specified by:

setLargeMessagingIncompletePolicy in interface SolConnectionFactory

Parameters:

incompletePolicy - parameter

getPassword
```
public String getPassword()
```
Description copied from interface: SolConnectionFactory

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.

Specified by:

getPassword in interface SolConnectionFactory

Returns:

Password property value, null if not set.

setPassword
```
public void setPassword(String password)
```
Description copied from interface: SolConnectionFactory

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.

Specified by:

setPassword in interface SolConnectionFactory

Parameters:

password - the Password property value, null to unset.

getPort
```
public Integer getPort()
```
Description copied from interface: SolConnectionFactory

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)

Specified by:

getPort in interface SolConnectionFactory

Returns:

Port property value, null if not set.

setPort
```
public void setPort(Integer port)
```
Description copied from interface: SolConnectionFactory

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)

Specified by:

setPort in interface SolConnectionFactory

Parameters:

port - the Port property value, null to unset.

getReadTimeoutInMillis
```
public Integer getReadTimeoutInMillis()
```
Description copied from interface: SolConnectionFactory

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)

Specified by:

getReadTimeoutInMillis in interface SolConnectionFactory

Returns:

ReadTimeoutInMillis property value, null if not set.

setReadTimeoutInMillis
```
public void setReadTimeoutInMillis(Integer readTimeoutInMillis)
```
Description copied from interface: SolConnectionFactory

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)

Specified by:

setReadTimeoutInMillis in interface SolConnectionFactory

Parameters:

readTimeoutInMillis - the ReadTimeoutInMillis property value, null to unset.

getReceiveAdAckThreshold
```
public Integer getReceiveAdAckThreshold()
```
Description copied from interface: SolConnectionFactory

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

Specified by:

getReceiveAdAckThreshold in interface SolConnectionFactory

Returns:

ReceiveAdAckThreshold property value, null if not set.

setReceiveAdAckThreshold
```
public void setReceiveAdAckThreshold(Integer receiveAdAckThreshold)
```
Description copied from interface: SolConnectionFactory

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

Specified by:

setReceiveAdAckThreshold in interface SolConnectionFactory

Parameters:

receiveAdAckThreshold - the ReceiveAdAckThreshold property value, null to unset.

getReceiveADAckTimerInMillis
```
public Integer getReceiveADAckTimerInMillis()
```
Description copied from interface: SolConnectionFactory

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

Specified by:

getReceiveADAckTimerInMillis in interface SolConnectionFactory

Returns:

ReceiveADAckTimerInMillis property value, null if not set.

setReceiveADAckTimerInMillis
```
public void setReceiveADAckTimerInMillis(Integer receiveADAckTimerInMillis)
```
Description copied from interface: SolConnectionFactory

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

Specified by:

setReceiveADAckTimerInMillis in interface SolConnectionFactory

Parameters:

receiveADAckTimerInMillis - the ReceiveADAckTimerInMillis property value, null to unset.

getReceiveADWindowSize
```
public Integer getReceiveADWindowSize()
```
Description copied from interface: SolConnectionFactory

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

Specified by:

getReceiveADWindowSize in interface SolConnectionFactory

Returns:

ReceiveADWindowSize property value, null if not set.

setReceiveADWindowSize
```
public void setReceiveADWindowSize(Integer receiveADWindowSize)
```
Description copied from interface: SolConnectionFactory

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

Specified by:

setReceiveADWindowSize in interface SolConnectionFactory

Parameters:

receiveADWindowSize - the ReceiveADWindowSize property value, null to unset.

getReceiveBufferSize
```
public Integer getReceiveBufferSize()
```
Description copied from interface: SolConnectionFactory

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

Specified by:

getReceiveBufferSize in interface SolConnectionFactory

Returns:

ReceiveBufferSize property value, null if not set.

setReceiveBufferSize
```
public void setReceiveBufferSize(Integer receiveBufferSize)
```
Description copied from interface: SolConnectionFactory

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

Specified by:

setReceiveBufferSize in interface SolConnectionFactory

Parameters:

receiveBufferSize - the ReceiveBufferSize property value, null to unset.

getReceiveReconnectRetries
```
public Integer getReceiveReconnectRetries()
```
Description copied from interface: SolConnectionFactory

Gets how much time (in ms) to wait between each attempt to reconnect to an endpoint.

Specified by:

getReceiveReconnectRetries in interface SolConnectionFactory

Returns:

How much time (in ms) to wait between each attempt

setReceiveReconnectRetries
```
public void setReceiveReconnectRetries(Integer reconnectRetries)
```
Description copied from interface: SolConnectionFactory

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.

Specified by:

setReceiveReconnectRetries in interface SolConnectionFactory

getReceiveReconnectRetryWaitInMillis
```
public Integer getReceiveReconnectRetryWaitInMillis()
```
Description copied from interface: SolConnectionFactory

Gets how much time (in ms) to wait between each attempt to reconnect to an endpoint.

Specified by:

getReceiveReconnectRetryWaitInMillis in interface SolConnectionFactory

Returns:

How much time (in ms) to wait between each attempt

setReceiveReconnectRetryWaitInMillis
```
public void setReceiveReconnectRetryWaitInMillis(Integer reconnectRetryWaitInMillis)
```
Description copied from interface: SolConnectionFactory

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.

Specified by:

setReceiveReconnectRetryWaitInMillis in interface SolConnectionFactory

getReconnectRetries
```
public Integer getReconnectRetries()
```
Description copied from interface: SolConnectionFactory

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

Specified by:

getReconnectRetries in interface SolConnectionFactory

Returns:

ReconnectRetries property value, null if not set.

setReconnectRetries
```
public void setReconnectRetries(Integer reconnectRetries)
```
Description copied from interface: SolConnectionFactory

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

Specified by:

setReconnectRetries in interface SolConnectionFactory

Parameters:

reconnectRetries - the ReconnectRetries property value, null to unset.

getReconnectRetryWaitInMillis
```
public Integer getReconnectRetryWaitInMillis()
```
Description copied from interface: SolConnectionFactory

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)

Specified by:

getReconnectRetryWaitInMillis in interface SolConnectionFactory

Returns:

ReconnectRetryWaitInMillis property value, null if not set.

setReconnectRetryWaitInMillis
```
public void setReconnectRetryWaitInMillis(Integer reconnectRetryWaitInMillis)
```
Description copied from interface: SolConnectionFactory

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)

Specified by:

setReconnectRetryWaitInMillis in interface SolConnectionFactory

Parameters:

reconnectRetryWaitInMillis - the ReconnectRetryWaitInMillis property value, null to unset.

getRespectTTL
```
public Boolean getRespectTTL()
```
Description copied from interface: SolConnectionFactory

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

Specified by:

getRespectTTL in interface SolConnectionFactory

Returns:

RespectTTL property value, null if not set.

setRespectTTL
```
public void setRespectTTL(Boolean respectTTL)
```
Description copied from interface: SolConnectionFactory

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

Specified by:

setRespectTTL in interface SolConnectionFactory

Parameters:

respectTTL - the RespectTTL property value, null to unset.

getSendADAckTimerInMillis
```
public Integer getSendADAckTimerInMillis()
```
Description copied from interface: SolConnectionFactory

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

Specified by:

getSendADAckTimerInMillis in interface SolConnectionFactory

Returns:

SendADAckTimerInMillis property value, null if not set.

setSendADAckTimerInMillis
```
public void setSendADAckTimerInMillis(Integer sendADAckTimerInMillis)
```
Description copied from interface: SolConnectionFactory

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

Specified by:

setSendADAckTimerInMillis in interface SolConnectionFactory

Parameters:

sendADAckTimerInMillis - the SendADAckTimerInMillis property value, null to unset.

getSendADMaxResends
```
public Integer getSendADMaxResends()
```
Specified by:

getSendADMaxResends in interface SolConnectionFactory

setSendADMaxResends
```
@Deprecated
public void setSendADMaxResends(Integer sendADMaxResends)
```
Deprecated.

Specified by:

setSendADMaxResends in interface SolConnectionFactory

getSendADWindowSize
```
public Integer getSendADWindowSize()
```
Description copied from interface: SolConnectionFactory

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

Specified by:

getSendADWindowSize in interface SolConnectionFactory

Returns:

SendADWindowSize property value, null if not set.

setSendADWindowSize
```
public void setSendADWindowSize(Integer sendADWindowSize)
```
Description copied from interface: SolConnectionFactory

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

Specified by:

setSendADWindowSize in interface SolConnectionFactory

Parameters:

sendADWindowSize - the SendADWindowSize property value, null to unset.

getSendBufferSize
```
public Integer getSendBufferSize()
```
Description copied from interface: SolConnectionFactory

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

Specified by:

getSendBufferSize in interface SolConnectionFactory

Returns:

SendBufferSize property value, null if not set.

setSendBufferSize
```
public void setSendBufferSize(Integer sendBufferSize)
```
Description copied from interface: SolConnectionFactory

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

Specified by:

setSendBufferSize in interface SolConnectionFactory

Parameters:

sendBufferSize - the SendBufferSize property value, null to unset.

getSSLExcludedProtocols
```
public String getSSLExcludedProtocols()
```
Description copied from interface: SolConnectionFactory

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

Specified by:

getSSLExcludedProtocols in interface SolConnectionFactory

Returns:

The SSL Excluded Protocols property value.

setSSLExcludedProtocols
```
public void setSSLExcludedProtocols(String protocols)
```
Description copied from interface: SolConnectionFactory

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 “sslv3”, “tlsv1”, “tlsv1.1”, “tlsv1.2”.
Default: “” Note that TLSv1.1 and TLSv1.2 are supported starting with Java 7.

Specified by:

setSSLExcludedProtocols in interface SolConnectionFactory

Parameters:

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

getSSLConnectionDowngradeTo
```
public String getSSLConnectionDowngradeTo()
```
Description copied from interface: SolConnectionFactory

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

Specified by:

getSSLConnectionDowngradeTo in interface SolConnectionFactory

Returns:

transport protocol, null if not set.

setSSLConnectionDowngradeTo
```
public void setSSLConnectionDowngradeTo(String protocol)
```
Description copied from interface: SolConnectionFactory

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

Specified by:

setSSLConnectionDowngradeTo in interface SolConnectionFactory

Parameters:

protocol - the SSLConnectionDowngradeTo property value, null to unset.

getSSLProtocol
```
public String getSSLProtocol()
```
Description copied from interface: SolConnectionFactory

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

Specified by:

getSSLProtocol in interface SolConnectionFactory

Returns:

The SSL Protocol property value.

setSSLProtocol
```
public void setSSLProtocol(String protocol)
```
Description copied from interface: SolConnectionFactory

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 “sslv3”, “tlsv1”, “tlsv1.1”, “tlsv1.2”.
Default: “sslv3,tlsv1,tlsv1.1,tlsv1.2” Note that TLSv1.1 and TLSv1.2 are supported starting with Java 7.

Specified by:

setSSLProtocol in interface SolConnectionFactory

Parameters:

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

getSSLValidateCertificate
```
public Boolean getSSLValidateCertificate()
```
Description copied from interface: SolConnectionFactory

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

Specified by:

getSSLValidateCertificate in interface SolConnectionFactory

Returns:

True if certificate validation is enabled.

setSSLValidateCertificate

public void setSSLValidateCertificate(Boolean validate)

Description copied from interface: SolConnectionFactory

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

Specified by:: setSSLValidateCertificate in interface SolConnectionFactory
Parameters:: validate - The SSL Validate Certificate property, null to unset.

getSSLValidateCertificateDate
```
public Boolean getSSLValidateCertificateDate()
```
Description copied from interface: SolConnectionFactory

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

Specified by:

getSSLValidateCertificateDate in interface SolConnectionFactory

Returns:

True if certificate date validation is enabled.

setSSLValidateCertificateDate
```
public void setSSLValidateCertificateDate(Boolean validateDate)
```
Description copied from interface: SolConnectionFactory

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

Specified by:

setSSLValidateCertificateDate in interface SolConnectionFactory

Parameters:

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

getSSLCipherSuites
```
public String getSSLCipherSuites()
```
Description copied from interface: SolConnectionFactory
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.
Specified by:

getSSLCipherSuites in interface SolConnectionFactory

Returns:

The list of ciphers.

setSSLCipherSuites
```
public void setSSLCipherSuites(String cipherSuites)
```
Description copied from interface: SolConnectionFactory
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.
Specified by:

setSSLCipherSuites in interface SolConnectionFactory

Parameters:

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

getSSLTrustStore
```
public String getSSLTrustStore()
```
Description copied from interface: SolConnectionFactory

This property specifies the trust store to use in URL or path format.
Format: URL or path to the trust store.
Default: none.

Specified by:

getSSLTrustStore in interface SolConnectionFactory

Returns:

The URL or path to the trust store.

setSSLTrustStore
```
public void setSSLTrustStore(String truststore)
```
Description copied from interface: SolConnectionFactory

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.

Specified by:

setSSLTrustStore in interface SolConnectionFactory

Parameters:

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

getSSLTrustStorePassword
```
public String getSSLTrustStorePassword()
```
Description copied from interface: SolConnectionFactory

This property specifies the trust store password to use.
Format: String
Default: none.

Specified by:

getSSLTrustStorePassword in interface SolConnectionFactory

Returns:

The trust store password to use.

setSSLTrustStorePassword
```
public void setSSLTrustStorePassword(String password)
```
Description copied from interface: SolConnectionFactory

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

Specified by:

setSSLTrustStorePassword in interface SolConnectionFactory

Parameters:

password - The trust store password, null to unset.

getSSLTrustStoreFormat
```
public String getSSLTrustStoreFormat()
```
Description copied from interface: SolConnectionFactory

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

Specified by:

getSSLTrustStoreFormat in interface SolConnectionFactory

Returns:

The format of the given trust store.

setSSLTrustStoreFormat
```
public void setSSLTrustStoreFormat(String format)
```
Description copied from interface: SolConnectionFactory

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

Specified by:

setSSLTrustStoreFormat in interface SolConnectionFactory

Parameters:

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

getSSLKeyStore
```
public String getSSLKeyStore()
```
Description copied from interface: SolConnectionFactory

This property specifies the key store to use in URL or path format.
Format: URL or path to the key store.
Default: none.

Specified by:

getSSLKeyStore in interface SolConnectionFactory

Returns:

The URL or path to the key store.

setSSLKeyStore
```
public void setSSLKeyStore(String keystore)
```
Description copied from interface: SolConnectionFactory

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.

Specified by:

setSSLKeyStore in interface SolConnectionFactory

Parameters:

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

getSSLKeyStorePassword
```
public String getSSLKeyStorePassword()
```
Description copied from interface: SolConnectionFactory

This property specifies the key store password to use.
Format: String
Default: none.

Specified by:

getSSLKeyStorePassword in interface SolConnectionFactory

Returns:

The key store password to use.

setSSLKeyStorePassword
```
public void setSSLKeyStorePassword(String password)
```
Description copied from interface: SolConnectionFactory

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

Specified by:

setSSLKeyStorePassword in interface SolConnectionFactory

Parameters:

password - The key store password, null to unset.

getSSLKeyStoreFormat
```
public String getSSLKeyStoreFormat()
```
Description copied from interface: SolConnectionFactory

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

Specified by:

getSSLKeyStoreFormat in interface SolConnectionFactory

Returns:

The format of the given key store.

setSSLKeyStoreFormat
```
public void setSSLKeyStoreFormat(String format)
```
Description copied from interface: SolConnectionFactory

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

Specified by:

setSSLKeyStoreFormat in interface SolConnectionFactory

Parameters:

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

getSSLKeyStoreNormalizedFormat
```
public String getSSLKeyStoreNormalizedFormat()
```
Description copied from interface: SolConnectionFactory

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

Specified by:

getSSLKeyStoreNormalizedFormat in interface SolConnectionFactory

Returns:

The format of the internal normalized key store.

setSSLKeyStoreNormalizedFormat
```
public void setSSLKeyStoreNormalizedFormat(String format)
```
Description copied from interface: SolConnectionFactory

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

Specified by:

setSSLKeyStoreNormalizedFormat in interface SolConnectionFactory

Parameters:

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

getSSLPrivateKeyAlias
```
public String getSSLPrivateKeyAlias()
```
Description copied from interface: SolConnectionFactory

This property specifies which private key in the key store is to be used for the client certificate authentication.

Specified by:

getSSLPrivateKeyAlias in interface SolConnectionFactory

Returns:

The alias of the private key

setSSLPrivateKeyAlias
```
public void setSSLPrivateKeyAlias(String alias)
```
Description copied from interface: SolConnectionFactory

This property specifies which private key in the key store is to be used for the client certificate authentication.

Specified by:

setSSLPrivateKeyAlias in interface SolConnectionFactory

Parameters:

alias - The alias of the private key

getSSLPrivateKeyPassword
```
public String getSSLPrivateKeyPassword()
```
Description copied from interface: SolConnectionFactory

This property specifies the password used to decipher the client certificate private key from the key store.

Specified by:

getSSLPrivateKeyPassword in interface SolConnectionFactory

Returns:

The password used to decipher the private key

setSSLPrivateKeyPassword
```
public void setSSLPrivateKeyPassword(String password)
```
Description copied from interface: SolConnectionFactory

This property specifies the password used to decipher the client certificate private key from the key store.

Specified by:

setSSLPrivateKeyPassword in interface SolConnectionFactory

Parameters:

password - The password used to decipher the private key

getSSLTrustedCommonNameList
```
public String getSSLTrustedCommonNameList()
```
Description copied from interface: SolConnectionFactory

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.

Specified by:

getSSLTrustedCommonNameList in interface SolConnectionFactory

Returns:

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

setSSLTrustedCommonNameList
```
public void setSSLTrustedCommonNameList(String commonNames)
```
Description copied from interface: SolConnectionFactory

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.

Specified by:

setSSLTrustedCommonNameList in interface SolConnectionFactory

Parameters:

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

getSubscriberLocalPriority
```
public Integer getSubscriberLocalPriority()
```
Description copied from interface: SolConnectionFactory

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

Specified by:

getSubscriberLocalPriority in interface SolConnectionFactory

Returns:

SubscriberLocalPriority property value, null if not set.

setSubscriberLocalPriority
```
public void setSubscriberLocalPriority(Integer subscriberLocalPriority)
```
Description copied from interface: SolConnectionFactory

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

Specified by:

setSubscriberLocalPriority in interface SolConnectionFactory

Parameters:

subscriberLocalPriority - the SubscriberLocalPriority property value, null to unset.

getSubscriberNetworkPriority
```
public Integer getSubscriberNetworkPriority()
```
Description copied from interface: SolConnectionFactory

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

Specified by:

getSubscriberNetworkPriority in interface SolConnectionFactory

Returns:

SubscriberNetworkPriority property value, null if not set.

setSubscriberNetworkPriority
```
public void setSubscriberNetworkPriority(Integer subscriberNetworkPriority)
```
Description copied from interface: SolConnectionFactory

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

Specified by:

setSubscriberNetworkPriority in interface SolConnectionFactory

Parameters:

subscriberNetworkPriority - the SubscriberNetworkPriority property value, null to unset.

getTcpNoDelay
```
public Boolean getTcpNoDelay()
```
Description copied from interface: SolConnectionFactory

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

Specified by:

getTcpNoDelay in interface SolConnectionFactory

Returns:

TcpNoDelay property value, null if not set.

setTcpNoDelay
```
public void setTcpNoDelay(Boolean tcpNoDelay)
```
Description copied from interface: SolConnectionFactory

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

Specified by:

setTcpNoDelay in interface SolConnectionFactory

Parameters:

tcpNoDelay - the TcpNoDelay property value, null to unset.

getUseDefaultContext
```
public Boolean getUseDefaultContext()
```
Description copied from interface: SolConnectionFactory

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)

Specified by:

getUseDefaultContext in interface SolConnectionFactory

Returns:

UseDefaultContext property value, null if not set.

setUseDefaultContext
```
public void setUseDefaultContext(Boolean useDefaultContext)
```
Description copied from interface: SolConnectionFactory

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)

Specified by:

setUseDefaultContext in interface SolConnectionFactory

Parameters:

useDefaultContext - the UseDefaultContext property value, null to unset.

getUsername
```
public String getUsername()
```
Description copied from interface: SolConnectionFactory

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)

Specified by:

getUsername in interface SolConnectionFactory

Returns:

Username property value, null if not set.

setUsername
```
public void setUsername(String username)
```
Description copied from interface: SolConnectionFactory

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 SolConnectionFactory.setAuthenticationScheme(String)
Format: The maximum length is 189 bytes when encoded in UTF-8 (with SolOS-TR 6.1 and above).

Specified by:

setUsername in interface SolConnectionFactory

Parameters:

username - the Username property value, null to unset.

getVPN
```
public String getVPN()
```
Description copied from interface: SolConnectionFactory

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: “”

Specified by:

getVPN in interface SolConnectionFactory

Returns:

VPN property value, null if not set.

setVPN
```
public void setVPN(String vpn)
```
Description copied from interface: SolConnectionFactory

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: “”

Specified by:

setVPN in interface SolConnectionFactory

Parameters:

vpn - the VPN property value, null to unset.

getXA
```
public Boolean getXA()
```
Description copied from interface: SolConnectionFactory

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

Specified by:

getXA in interface SolConnectionFactory

Returns:

XA property value, null if not set.

setXA
```
public void setXA(Boolean xa)
```

getXmlPayload
```
public Boolean getXmlPayload()
```
Description copied from interface: SolConnectionFactory

This property specifies whether sent text messages have an XML payload.
Default: true

Specified by:

getXmlPayload in interface SolConnectionFactory

Returns:

XmlPayload property value, null if not set.

setXmlPayload
```
public void setXmlPayload(Boolean xmlPayload)
```
Description copied from interface: SolConnectionFactory

This property specifies whether sent text messages have an XML payload.
Default: true

Specified by:

setXmlPayload in interface SolConnectionFactory

Parameters:

xmlPayload - the XmlPayload property value, null to unset.

getUnknownPublisherFlowAction
```
public String getUnknownPublisherFlowAction()
```
Description copied from interface: SolConnectionFactory

This property specifies

Specified by:

getUnknownPublisherFlowAction in interface SolConnectionFactory

Returns:

UnknownPublisherFlowAction property value, null if not set

setUnknownPublisherFlowAction
```
public void setUnknownPublisherFlowAction(String action)
```
Description copied from interface: SolConnectionFactory

This property specifies
Default:

Specified by:

setUnknownPublisherFlowAction in interface SolConnectionFactory

Parameters:

action - the UnknownPublisherFlowAction property value, null to unset.

fromJNDIProperties

public void fromJNDIProperties(JNDIObject obj)

toProperties
```
public Properties toProperties()
```
Description copied from interface: SolConnectionFactory

Gets the properties in a Properties instance.

Specified by:

toProperties in interface SolConnectionFactory

Returns:

the properties in a Properties instance.

fromProperties
```
public void fromProperties(Properties properties)
```
Description copied from interface: SolConnectionFactory

Sets the properties based on values in a Properties instance.

Specified by:

fromProperties in interface SolConnectionFactory

Parameters:

properties - Values to set the ConnectionFactory properties from.

getReference

public Reference getReference()
                       throws NamingException

Specified by:: getReference in interface Referenceable
Throws:: NamingException

clone

public Object clone()
             throws CloneNotSupportedException

Overrides:: clone in class Object
Throws:: CloneNotSupportedException

equals
```
public boolean equals(Object obj)
```
Overrides:

equals in class Object

hashCode
```
public int hashCode()
```
Overrides:

hashCode in class Object

toString
```
public String toString()
```
Overrides:

toString in class Object

toEffectiveString
```
public String toEffectiveString()
```
Description copied from interface: SolConnectionFactory

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

Specified by:

toEffectiveString in interface SolConnectionFactory

Returns:

A string representation of the effective property values.

isXAEnabled

public static boolean isXAEnabled(JNDIObject obj,
                                  JMSProperties properties)

Class SolConnectionFactoryImpl

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

SolConnectionFactoryImpl

SolConnectionFactoryImpl

Method Detail

getJMSProperties

getJMSPropertyBean

createConnection

createConnection

createQueueConnection

createQueueConnection

createTopicConnection

createTopicConnection

getProperty

getEffectiveProperty

setProperty

getPropertyNames

getAuthenticationScheme

setAuthenticationScheme

getBrowserTimeoutInMS

setBrowserTimeoutInMS

getCallbackOnIOThread

setCallbackOnIOThread

getClientDescription

setClientDescription

getClientID

setClientID

getCompressionLevel

setCompressionLevel

getConnectRetries

setConnectRetries

getConnectRetriesPerHost

setConnectRetriesPerHost

getConnectTimeoutInMillis

setConnectTimeoutInMillis

getDeliveryMode

setDeliveryMode

getDeliverToOne

setDeliverToOne

getDeliverToOneOverride

setDeliverToOneOverride

getDirectOptimized

setDirectOptimized

getDirectTransport

getJMSXUserIDEnabled

getAllowDuplicateClientId

setDirectTransport

getDmqEligible

setDmqEligible

getDynamicDurables

setDynamicDurables

getElidingEligible

setElidingEligible

getEnvironment

getGenerateSenderID

setGenerateSenderID

getHost

setHost

Configuring Multiple Hosts for Redundancy and Failover

Limitations

getKeepAliveCountMax

setKeepAliveCountMax

getKeepAliveIntervalInMillis

setKeepAliveIntervalInMillis

getKeepAlives

setKeepAlives

getKRBMutualAuthentication

setKRBMutualAuthentication

getKRBServiceName

setKRBServiceName

getLargeMessaging

setLargeMessaging

getLargeMessagingSegmentSize

setLargeMessagingSegmentSize

getLargeMessagingMaximumSize

setLargeMessagingMaximumSize

getLargeMessagingConsumeTimeoutInMillis