@ProviderType public interface SolConnectionFactory extends ConnectionFactory, QueueConnectionFactory, TopicConnectionFactory, Referenceable
ConnectionFactory
.Modifier and Type | Method and Description |
---|---|
void |
fromProperties(Properties properties)
Sets the properties based on values in a
Properties instance. |
Boolean |
getAllowDuplicateClientId()
This property specifies whether a duplicate client ID is allowed.
|
String |
getAuthenticationScheme()
This property specifies the authentication scheme.
|
Integer |
getBrowserTimeoutInMS()
This property specifies the maximum time in milliseconds for a
QueueBrowser Enumeration.hasMoreElements() to wait
for a message to arrive in the browser's local message buffer before returning. |
Boolean |
getCallbackOnIOThread()
This property specifies whether to call MessageListeners directly from the IO thread.
|
String |
getClientDescription()
This property is used to specify the application description on the appliance for the data connection.
|
String |
getClientID()
This property is used to specify the client name on the appliance for the data connection.
|
Integer |
getCompressionLevel()
This property is used to enable and specify the ZLIB compression level.
|
Integer |
getConnectRetries()
This property is used to specify the total number of times to attempt
and retry a connection when establishing an initial connection
for a Session to a host router.
|
Integer |
getConnectRetriesPerHost()
This property is used to specify the number of times to
retry data connection attempts to a single host before moving on to the next host
in the list.
|
Integer |
getConnectTimeoutInMillis()
This property is used to specify the timeout in milliseconds on a data connection attempt.
|
Boolean |
getDeliverToOne()
This property specifies whether sent messages are deliver to one.
|
Boolean |
getDeliverToOneOverride()
This property specifies whether to override deliver to one settings.
|
Integer |
getDeliveryMode()
This property specifies the delivery mode for sent messages.
|
Boolean |
getDirectOptimized()
This property specifies whether to optimize the API for direct transport.
|
Boolean |
getDirectTransport()
This property specifies whether to use direct transport for non-persistent messages.
|
Boolean |
getDmqEligible()
This property specifies whether sent messages are eligible for the dead message queue.
|
Boolean |
getDynamicDurables()
This property is used to indicate whether durable topic endpoints or queues are to be
created on the appliance when the corresponding Session.createDurableSubscriber() or
Session.createQueue() is called.
|
Object |
getEffectiveProperty(String name)
Gets a property's value given its name.
|
Boolean |
getElidingEligible()
This property specifies whether sent messages are marked as eligible for eliding.
|
Hashtable<?,?> |
getEnvironment()
This method gets the environment that the ConnectionFactory may have.
|
Boolean |
getGenerateSenderID()
This property is used to Indicates whether the client name should be
included in the SenderID message header parameter.
|
String |
getHost()
This property is the hostname / IP address of the appliance.
|
Boolean |
getJMSXUserIDEnabled()
This property specifies whether JMSXUserID property should be set.
|
Integer |
getKeepAliveCountMax()
This property is used to specify the allowed number of consecutive keep-alive
messages for which no response is received before the connection is closed by
the API.
|
Integer |
getKeepAliveIntervalInMillis()
This property is used to specify the interval between keep alives in milliseconds.
|
Boolean |
getKeepAlives()
This property is used to enable/disable keep alives.
|
Boolean |
getKRBMutualAuthentication()
This property is used to indicate that mutual authentication is
to be used when Kerberos is enabled.
|
String |
getKRBServiceName()
This property is used to specify the ServiceName portion of the Service Principal Name (SPN)
that has a format of ServiceName/ApplianceName@REALM.
|
Boolean |
getLargeMessaging()
This property is used to enable/disable publish/receive large AD messages.
|
Integer |
getLargeMessagingConsumeTimeoutInMillis() |
String |
getLargeMessagingIncompletePolicy() |
Integer |
getLargeMessagingMaximumSize() |
Integer |
getLargeMessagingSegmentSize() |
String |
getPassword()
This property is used to specify the password to connect to the
appliance with.
|
Integer |
getPayloadCompressionLevel()
A property to enable payload compression and set the compression level.
|
Integer |
getPort()
This property is used to specify the port to use for the data connection.
|
Object |
getProperty(String name)
Gets the property value given its name.
|
Set<String> |
getPropertyNames()
Gets the property names for all the properties.
|
Integer |
getReadTimeoutInMillis()
This property is used to specify the timeout in milliseconds for
reading a reply from the appliance.
|
Integer |
getReceiveAdAckThreshold()
This property specifies the threshold for sending an acknowledgement to the appliance.
|
Integer |
getReceiveADAckTimerInMillis()
This property specifies the duration of the acknowledgement timer.
|
Integer |
getReceiveADWindowSize()
This property specifies the size of the sliding acknowledgement window.
|
Integer |
getReceiveBufferSize()
This property is used to configure the socket’s receive buffer size in bytes.
|
Integer |
getReceiveReconnectRetries()
Gets how much time (in ms) to wait between each attempt to reconnect to an endpoint.
|
Integer |
getReceiveReconnectRetryWaitInMillis()
Gets how much time (in ms) to wait between each attempt to reconnect to an endpoint.
|
Integer |
getReconnectRetries()
This property is used to specify the number of times to attempt a reconnect
once the initial data connection to the appliance has been lost.
|
Integer |
getReconnectRetryWaitInMillis()
This property is used to specify the amount of time to wait in milliseconds
between reconnect attempts.
|
Boolean |
getRespectTTL()
This property is used to indicate whether dynamically created durable topic
endpoints or queues are set to respect time to live (see Dynamic Durables).
|
Integer |
getSendADAckTimerInMillis()
This property specifies the duration of the acknowledgement timer in milliseconds.
|
Integer |
getSendADMaxResends()
Deprecated.
|
Integer |
getSendADWindowSize()
This property specifies the size of the sliding acknowledgement window for
non-persistent messages.
|
Integer |
getSendBufferSize()
This property is used to specify the socket’s send buffer size in bytes.
|
String |
getSSLCipherSuites()
This property specifies a comma separated list of the
cipher suites to enable in order of preference.
|
String |
getSSLConnectionDowngradeTo()
This property specifies a transport protocol that SSL connection will
be downgraded to after client authentication.
|
String |
getSSLExcludedProtocols()
This property is used to specify a comma separated list of encryption
protocol(s) to exclude from use.
|
String |
getSSLKeyStore()
This property specifies the key store to use in URL or path format.
|
String |
getSSLKeyStoreFormat()
This property specifies the format of the given key store.
|
String |
getSSLKeyStoreNormalizedFormat()
This property specifies the internal normalized format of the given key store.
|
String |
getSSLKeyStorePassword()
This property specifies the key store password to use.
|
String |
getSSLPrivateKeyAlias()
This property specifies which private key in the key store is to be used
for the client certificate authentication.
|
String |
getSSLPrivateKeyPassword()
This property specifies the password used to decipher the client
certificate private key from the key store.
|
String |
getSSLProtocol()
This property is used to specify a comma separated list of encryption
protocol(s) to use.
|
String |
getSSLTrustedCommonNameList()
This property specifies the list of acceptable common
names for matching in server certificates.
|
String |
getSSLTrustStore()
This property specifies the trust store to use in URL or path format.
|
String |
getSSLTrustStoreFormat()
This property specifies the format of the given trust store.
|
String |
getSSLTrustStorePassword()
This property specifies the trust store password to use.
|
Boolean |
getSSLValidateCertificate()
This property is used to indicate that the API should
validate server certificates with certificates in the
trust store.
|
Boolean |
getSSLValidateCertificateDate()
This property is used to indicate that the session
connection should fail when an expired certificate or
a certificate not yet in effect is received.
|
Boolean |
getSSLValidateCertificateHost()
This method is used to get the value of the SSLValidateCertificateHost property.
|
Integer |
getSubscriberLocalPriority()
This property specifies the priority that a client’s subscriptions have
for receiving Deliver-To-One messages published on the Solace appliance
that the client is directly connected to.
|
Integer |
getSubscriberNetworkPriority()
This property specifies the priority that a client’s subscriptions have
for receiving Deliver-To-One messages published by other Solace appliances
in the Solace Messaging Platform.
|
Boolean |
getTcpNoDelay()
This property is used to specify whether to set the TCP_NODELAY option.
|
String |
getUnknownPublisherFlowAction()
This property specifies
|
Boolean |
getUseDefaultContext()
This property is used to indicate whether to use a new context or reuse
the default context for new JMS connections.
|
String |
getUsername()
This property is used to specify the username to connect to the appliance with.
|
String |
getVPN()
This property is used to specify the VPN to use when connecting to the appliance.
|
Boolean |
getXA()
This property specified whether this is an XA Connection Factory.
|
Boolean |
getXmlPayload()
This property specifies whether sent text messages have an XML payload.
|
void |
setAuthenticationScheme(String scheme)
This property specifies the authentication scheme.
|
void |
setBrowserTimeoutInMS(Integer timeout)
This property specifies the maximum time in milliseconds for a
QueueBrowser Enumeration.hasMoreElements() to wait
for a message to arrive in the browser's local message buffer before returning. |
void |
setCallbackOnIOThread(Boolean callbackOnIOThread)
This property specifies whether to call MessageListeners directly from the IO thread.
|
void |
setClientDescription(String clientDescription)
This property is used to specify the application description on the appliance for the data connection.
|
void |
setClientID(String clientID)
This property is used to specify the client name on the appliance for the data connection.
|
void |
setCompressionLevel(Integer compressionLevel)
This property is used to enable and specify the ZLIB compression level.
|
void |
setConnectRetries(Integer connectRetries)
This property is used to specify the total number of times to attempt
and retry a connection when establishing an initial connection
for a Session to a host router.
|
void |
setConnectRetriesPerHost(Integer connectRetriesPerHost)
This property is used to specify the number of times to
retry data connection attempts to a single host before moving on to the next host
in the list.
|
void |
setConnectTimeoutInMillis(Integer connectTimeoutInMillis)
This property is used to specify the timeout in milliseconds on a data connection attempt.
|
void |
setDeliverToOne(Boolean deliverToOne)
This property specifies whether sent messages are deliver to one.
|
void |
setDeliverToOneOverride(Boolean deliverToOneOverride)
This property specifies whether to override deliver to one settings.
|
void |
setDeliveryMode(Integer deliveryMode)
This property specifies the delivery mode for sent messages.
|
void |
setDirectOptimized(Boolean directOptimized)
This property specifies whether to optimize the API for direct transport.
|
void |
setDirectTransport(Boolean directTransport)
This property specifies whether to use direct transport for non-persistent messages.
|
void |
setDmqEligible(Boolean dmqEligible)
This property specifies whether sent messages are eligible for the dead message queue.
|
void |
setDynamicDurables(Boolean dynamicDurables)
This property is used to indicate whether durable topic endpoints or queues are to be
created on the appliance when the corresponding Session.createDurableSubscriber() or
Session.createQueue() is called.
|
void |
setElidingEligible(Boolean elidingEligible)
This property specifies whether sent messages are marked as eligible for eliding.
|
void |
setGenerateSenderID(Boolean generateSenderId)
This property is used to Indicates whether the client name should be
included in the SenderID message header parameter.
|
void |
setHost(String host)
This property is the hostname / IP address of the appliance.
|
void |
setKeepAliveCountMax(Integer keepAliveCountMax)
This property is used to specify the allowed number of consecutive keep-alive
messages for which no response is received before the connection is closed by
the API.
|
void |
setKeepAliveIntervalInMillis(Integer keepAliveIntervalInMillis)
This property is used to specify the interval between keep alives in milliseconds.
|
void |
setKeepAlives(Boolean keepAlives)
This property is used to enable/disable keep alives.
|
void |
setKRBMutualAuthentication(Boolean mutualAuth)
This property is used to indicate that mutual authentication is
to be used when Kerberos is enabled.
|
void |
setKRBServiceName(String serviceName)
This property is used to specify the ServiceName portion of the Service Principal Name (SPN)
that has a format of ServiceName/ApplianceName@REALM.
|
void |
setLargeMessaging(Boolean largeMessaging)
This property is used to enable/disable publish/receive large AD messages..
|
void |
setLargeMessagingConsumeTimeoutInMillis(Integer consumeTimeoutInMillis) |
void |
setLargeMessagingIncompletePolicy(String incompletePolicy) |
void |
setLargeMessagingMaximumSize(Integer maxSize) |
void |
setLargeMessagingSegmentSize(Integer segmentSize) |
void |
setPassword(String password)
This property is used to specify the password to connect to the
appliance with.
|
void |
setPayloadCompressionLevel(Integer payloadCompressionLevel)
A property to enable payload compression and set the compression level.
|
void |
setPort(Integer port)
This property is used to specify the port to use for the data connection.
|
void |
setProperty(String name,
Object value)
Sets a property's value given its name.
|
void |
setReadTimeoutInMillis(Integer readTimeoutInMillis)
This property is used to specify the timeout in milliseconds for
reading a reply from the appliance.
|
void |
setReceiveAdAckThreshold(Integer receiveAdAckThreshold)
This property specifies the threshold for sending an acknowledgement to the appliance.
|
void |
setReceiveADAckTimerInMillis(Integer receiveADAckTimerInMillis)
This property specifies the duration of the acknowledgement timer.
|
void |
setReceiveADWindowSize(Integer receiveADWindowSize)
This property specifies the size of the sliding acknowledgement window.
|
void |
setReceiveBufferSize(Integer receiveBufferSize)
This property is used to configure the socket’s receive buffer size in bytes.
|
void |
setReceiveReconnectRetries(Integer reconnectRetries)
This property specifies the number of times to attempt to reconnect to an endpoint after the initial bound flow goes down.
|
void |
setReceiveReconnectRetryWaitInMillis(Integer reconnectRetryWaitInMillis)
This property specifies how much time (in ms) to wait between each attempt to reconnect to an endpoint.
|
void |
setReconnectRetries(Integer reconnectRetries)
This property is used to specify the number of times to attempt a reconnect
once the initial data connection to the appliance has been lost.
|
void |
setReconnectRetryWaitInMillis(Integer reconnectRetryWaitInMillis)
This property is used to specify the amount of time to wait in milliseconds
between reconnect attempts.
|
void |
setRespectTTL(Boolean respectTTL)
This property is used to indicate whether dynamically created durable topic
endpoints or queues are set to respect time to live (see Dynamic Durables).
|
void |
setSendADAckTimerInMillis(Integer sendADAckTimerInMillis)
This property specifies the duration of the acknowledgement timer in milliseconds.
|
void |
setSendADMaxResends(Integer sendADMaxResends)
Deprecated.
|
void |
setSendADWindowSize(Integer sendADWindowSize)
This property specifies the size of the sliding acknowledgement window for
non-persistent and transacted messages.
|
void |
setSendBufferSize(Integer sendBufferSize)
This property is used to specify the socket’s send buffer size in bytes.
|
void |
setSSLCipherSuites(String cipherSuites)
This property specifies a comma separated list of the
cipher suites to enable in order of preference.
|
void |
setSSLConnectionDowngradeTo(String proto)
This property specifies a transport protocol that SSL connection will
be downgraded to after client authentication.
|
void |
setSSLExcludedProtocols(String protocols)
This property is used to specify a comma separated list of encryption
protocol(s) to exclude from use.
|
void |
setSSLKeyStore(String keystore)
This property specifies the key store to use in URL or path format.
|
void |
setSSLKeyStoreFormat(String format)
This property specifies the format of the given key store.
|
void |
setSSLKeyStoreNormalizedFormat(String format)
This property specifies the internal normalized format of the given key store.
|
void |
setSSLKeyStorePassword(String password)
This property specifies the key store password to use.
|
void |
setSSLPrivateKeyAlias(String alias)
This property specifies which private key in the key store is to be used
for the client certificate authentication.
|
void |
setSSLPrivateKeyPassword(String password)
This property specifies the password used to decipher the client
certificate private key from the key store.
|
void |
setSSLProtocol(String protocol)
This property is used to specify a comma separated list of encryption
protocol(s) to use.
|
void |
setSSLTrustedCommonNameList(String commonNames)
This property specifies the list of acceptable common
names for matching in server certificates.
|
void |
setSSLTrustStore(String truststore)
This property specifies the trust store to use in URL or path format.
|
void |
setSSLTrustStoreFormat(String format)
This property specifies the format of the given trust store.
|
void |
setSSLTrustStorePassword(String password)
This property specifies the trust store password to use.
|
void |
setSSLValidateCertificate(Boolean validate)
This property is used to indicate that the API should validate server
certificates with certificates in the trust store.
|
void |
setSSLValidateCertificateDate(Boolean validateDate)
This property is used to indicate that the session
connection should fail when an expired certificate or
a certificate not yet in effect is received.
|
void |
setSSLValidateCertificateHost(Boolean validate)
Boolean property to indicate if the session connection should fail when a certificate with an
invalid host is received.
|
void |
setSubscriberLocalPriority(Integer subscriberLocalPriority)
This property specifies the priority that a client’s subscriptions have
for receiving Deliver-To-One messages published on the Solace appliance
that the client is directly connected to.
|
void |
setSubscriberNetworkPriority(Integer subscriberNetworkPriority)
This property specifies the priority that a client’s subscriptions have
for receiving Deliver-To-One messages published by other Solace appliances
in the Solace Messaging Platform.
|
void |
setTcpNoDelay(Boolean tcpNoDelay)
This property is used to specify whether to set the TCP_NODELAY option.
|
void |
setUnknownPublisherFlowAction(String action)
This property specifies
|
void |
setUseDefaultContext(Boolean useDefaultContext)
This property is used to indicate whether to use a new context or reuse
the default context for new JMS connections.
|
void |
setUsername(String username)
This property is used to specify the username to connect to the appliance with.
|
void |
setVPN(String vpn)
This property is used to specify the VPN to use when connecting to the appliance.
|
void |
setXmlPayload(Boolean xmlPayload)
This property specifies whether sent text messages have an XML payload.
|
String |
toEffectiveString()
Returns a string representation of all the property values as if the
method
getEffectiveProperty(String) was used to retrieve them. |
Properties |
toProperties()
Gets the properties in a
Properties instance. |
createQueueConnection, createQueueConnection
createTopicConnection, createTopicConnection
createConnection, createConnection
getReference
String getAuthenticationScheme()
Values are one of
SupportedProperty.AUTHENTICATION_SCHEME_BASIC
(username/password based authentication)SupportedProperty.AUTHENTICATION_SCHEME_CLIENT_CERTIFICATE
(Client Certificate based authentication)SupportedProperty.AUTHENTICATION_SCHEME_GSS_KRB
(Kerberos based authentication)SupportedProperty.AUTHENTICATION_SCHEME_OAUTH2
(OAuth 2.0 based authentication)void setAuthenticationScheme(String scheme)
Values are one of
SupportedProperty.AUTHENTICATION_SCHEME_BASIC
(username/password authentication) SupportedProperty.AUTHENTICATION_SCHEME_CLIENT_CERTIFICATE
(Client Certificate based authentication)SupportedProperty.AUTHENTICATION_SCHEME_GSS_KRB
(Kerberos based authentication)SupportedProperty.AUTHENTICATION_SCHEME_OAUTH2
(OAuth 2.0 based authentication)scheme
- The authentication schemeInteger getBrowserTimeoutInMS()
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)
void setBrowserTimeoutInMS(Integer timeout)
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)
timeout
- the BrowserTimeoutInMS property value, null to unset.Boolean getCallbackOnIOThread()
Default: false
void setCallbackOnIOThread(Boolean callbackOnIOThread)
Default: false
callbackOnIOThread
- the CallbackOnIOThread property value, null to unset.String getClientDescription()
Format: Must be a maximum of 254 ASCII characters.
Default: “”
void setClientDescription(String clientDescription)
Format: Must be a maximum of 254 ASCII characters.
Default: “”
clientDescription
- the ClientDescription property value, null to unset.String getClientID()
Format: Must be a valid topic name and a maximum of 160 bytes when encoded in UTF-8.
Default: a generated client ID
void setClientID(String clientID)
Format: Must be a valid topic name and a maximum of 160 bytes when encoded in UTF-8.
Default: a generated client ID
clientID
- the ClientID property value, null to unset.Integer getCompressionLevel()
Format: Must be a value [-1..9]. -1 means use the JNDI connection’s compression level. 0 disables compression. 1-9 sets the ZLIB compression level.
Default: -1 (use JNDI connection’s compression level, 0 if no JNDI connection)
void setCompressionLevel(Integer compressionLevel)
Format: Must be a value [-1..9]. -1 means use the JNDI connection’s compression level. 0 disables compression. 1-9 sets the ZLIB compression level.
Default: -1 (use JNDI connection’s compression level, 0 if no JNDI connection)
compressionLevel
- the CompressionLevel property value, null to unset.Integer getPayloadCompressionLevel()
Format: Must be a value [0..9]. 0 disables compression. 1-9 sets the ZLIB compression level.
Default: 0
void setPayloadCompressionLevel(Integer payloadCompressionLevel)
Format: Must be a value [0..9]. 0 disables compression. 1-9 sets the ZLIB compression level.
Default: 0
payloadCompressionLevel
- the PayloadCompressionLevel property value, null to unset.Integer getConnectRetries()
Format: Valid values are [-1.. 2147483647]. -1 means retry forever.
Default: 0 (don’t retry)
void setConnectRetries(Integer connectRetries)
Format: Valid values are [-1.. 2147483647]. -1 means retry forever.
Default: 0 (don’t retry)
connectRetries
- the ConnectRetries property value, null to unset.Integer getConnectRetriesPerHost()
Format: Valid values are [-1.. 2147483647]. -1 means retry forever.
Default: 0 (don’t retry)
void setConnectRetriesPerHost(Integer connectRetriesPerHost)
Format: Valid values are [-1.. 2147483647]. -1 means retry forever.
Default: 0 (don’t retry)
connectRetriesPerHost
- the ConnectRetriesPerHost property value, null to unset.Integer getConnectTimeoutInMillis()
Format: In milliseconds. Valid values are [0..2147483647]. 0 means wait forever.
Default: The default value is 30000 (30 seconds)
void setConnectTimeoutInMillis(Integer connectTimeoutInMillis)
Format: In milliseconds. Valid values are [0..2147483647]. 0 means wait forever.
Default: The default value is 30000 (30 seconds)
connectTimeoutInMillis
- the ConnectTimeoutInMillis property value, null to unset.Integer getDeliveryMode()
Format: Valid values are [DeliveryMode.NON_PERSISTENT
| DeliveryMode.PERSISTENT
]
Default: DeliveryMode.PERSISTENT
void setDeliveryMode(Integer deliveryMode)
Format: Valid values are [DeliveryMode.NON_PERSISTENT
| DeliveryMode.PERSISTENT
]
Default: DeliveryMode.PERSISTENT
deliveryMode
- the DeliveryMode property value, null to unset.Boolean getDeliverToOne()
Default: false
void setDeliverToOne(Boolean deliverToOne)
Default: false
deliverToOne
- the DeliverToOne property value, null to unset.Boolean getDeliverToOneOverride()
Default: true.
void setDeliverToOneOverride(Boolean deliverToOneOverride)
Default: true.
deliverToOneOverride
- the DeliverToOneOverride property value, null to unset.Boolean getDirectOptimized()
Default: false.
void setDirectOptimized(Boolean directOptimized)
Default: false.
directOptimized
- the DirectOptimized property value, null to unset.Boolean getDirectTransport()
Default: true.
void setDirectTransport(Boolean directTransport)
Default: true.
directTransport
- the DirectTransport property value, null to unset.Boolean getJMSXUserIDEnabled()
Default: false.
Boolean getAllowDuplicateClientId()
Default: false.
Boolean getDmqEligible()
Default: false
void setDmqEligible(Boolean dmqEligible)
Default: false
dmqEligible
- the DmqEligible property value, null to unset.Boolean getDynamicDurables()
Default: false
void setDynamicDurables(Boolean dynamicDurables)
Default: false
dynamicDurables
- the DynamicDurables property value, null to unset.Boolean getElidingEligible()
Default: false
void setElidingEligible(Boolean elidingEligible)
Default: false
elidingEligible
- the ElidingEligible property value, null to unset.Hashtable<?,?> getEnvironment()
Boolean getGenerateSenderID()
void setGenerateSenderID(Boolean generateSenderId)
generateSenderId
- True to generate sender id, null to unset.Integer getKeepAliveCountMax()
Format: Valid values are [3.. 2147483647].
Default: 3
void setKeepAliveCountMax(Integer keepAliveCountMax)
Format: Valid values are [3.. 2147483647].
Default: 3
keepAliveCountMax
- the KeepAliveCountMax property value, null to unset.Integer getKeepAliveIntervalInMillis()
Format: In milliseconds. Valid values are [0, 50]. 0 disables the keep alives.
Default: 3000 (3 seconds)
void setKeepAliveIntervalInMillis(Integer keepAliveIntervalInMillis)
Format: In milliseconds. Valid values are [0, 50]. 0 disables the keep alives.
Default: 3000 (3 seconds)
keepAliveIntervalInMillis
- the KeepAliveIntervalInMillis property value, null to unset.Boolean getKeepAlives()
Default: true (enabled)
void setKeepAlives(Boolean keepAlives)
Default: true (enabled)
keepAlives
- the KeepAlives property value, null to unset.Boolean getLargeMessaging()
Default: false (disabled)
void setLargeMessaging(Boolean largeMessaging)
Default: false (disabled)
largeMessaging
- the LargeMessaging property value, null if not set.Integer getLargeMessagingSegmentSize()
void setLargeMessagingSegmentSize(Integer segmentSize)
segmentSize
- parameterInteger getLargeMessagingMaximumSize()
void setLargeMessagingMaximumSize(Integer maxSize)
maxSize
- parameterInteger getLargeMessagingConsumeTimeoutInMillis()
void setLargeMessagingConsumeTimeoutInMillis(Integer consumeTimeoutInMillis)
consumeTimeoutInMillis
- parameterString getLargeMessagingIncompletePolicy()
void setLargeMessagingIncompletePolicy(String incompletePolicy)
incompletePolicy
- parameterBoolean getKRBMutualAuthentication()
Default: true (enabled)
#setAuthenticationScheme(string)
void setKRBMutualAuthentication(Boolean mutualAuth)
Default: true (enabled)
mutualAuth
- Kerberos mutual authentication property value, null to unset.#setAuthenticationScheme
String getKRBServiceName()
Default: "solace"
void setKRBServiceName(String serviceName)
Default: "solace"
serviceName
- Kerberos service name, null to unset.String getHost()
void setHost(String host)
Usage A host entry has the following form:
[Protocol:]Host[:Port]
Protocol is the protocol used for the transport channel. The valid values are:
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.
"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.
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.
host
- the Host property value, null to unset.String getPassword()
Format: The maximum length is 128 characters.
void setPassword(String password)
Format: The maximum length is 128 characters.
password
- the Password property value, null to unset.Integer getPort()
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)
void setPort(Integer port)
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)
port
- the Port property value, null to unset.Integer getReadTimeoutInMillis()
Format: Valid values are [1..2147483647].
Default: 10000 (10 seconds)
void setReadTimeoutInMillis(Integer readTimeoutInMillis)
Format: Valid values are [1..2147483647].
Default: 10000 (10 seconds)
readTimeoutInMillis
- the ReadTimeoutInMillis property value, null to unset.Integer getReceiveAdAckThreshold()
Format: Valid values are [1..75]
Default: 60
void setReceiveAdAckThreshold(Integer receiveAdAckThreshold)
Format: Valid values are [1..75]
Default: 60
receiveAdAckThreshold
- the ReceiveAdAckThreshold property value, null to unset.Integer getReceiveADAckTimerInMillis()
Format: In milliseconds. Valid values are [20..1500]
Default: 1000 (1 second)
void setReceiveADAckTimerInMillis(Integer receiveADAckTimerInMillis)
Format: In milliseconds. Valid values are [20..1500]
Default: 1000 (1 second)
receiveADAckTimerInMillis
- the ReceiveADAckTimerInMillis property value, null to unset.Integer getReceiveADWindowSize()
Format: Valid values are [1..255]
Default: 18
void setReceiveADWindowSize(Integer receiveADWindowSize)
Format: Valid values are [1..255]
Default: 18
receiveADWindowSize
- the ReceiveADWindowSize property value, null to unset.Integer getReceiveBufferSize()
Format: Valid values are greater than 0.
Default: 65536
void setReceiveBufferSize(Integer receiveBufferSize)
Format: Valid values are greater than 0.
Default: 65536
receiveBufferSize
- the ReceiveBufferSize property value, null to unset.Integer getReceiveReconnectRetries()
void setReceiveReconnectRetries(Integer reconnectRetries)
Integer getReceiveReconnectRetryWaitInMillis()
void setReceiveReconnectRetryWaitInMillis(Integer reconnectRetryWaitInMillis)
Integer getReconnectRetries()
Format: Valid values are [-1..2147483647]. -1 means retry forever.
Default: 3 retries
void setReconnectRetries(Integer reconnectRetries)
Format: Valid values are [-1..2147483647]. -1 means retry forever.
Default: 3 retries
reconnectRetries
- the ReconnectRetries property value, null to unset.Integer getReconnectRetryWaitInMillis()
Format: Valid values are [0..60000]. 0 means don’t wait.
Default: 3000 (3 seconds)
void setReconnectRetryWaitInMillis(Integer reconnectRetryWaitInMillis)
Format: Valid values are [0..60000]. 0 means don’t wait.
Default: 3000 (3 seconds)
reconnectRetryWaitInMillis
- the ReconnectRetryWaitInMillis property value, null to unset.Boolean getRespectTTL()
Default: true
void setRespectTTL(Boolean respectTTL)
Default: true
respectTTL
- the RespectTTL property value, null to unset.Integer getSendADAckTimerInMillis()
Format: In milliseconds. Valid values are [20..60000]
Default: 2000 (2 seconds)
void setSendADAckTimerInMillis(Integer sendADAckTimerInMillis)
Format: In milliseconds. Valid values are [20..60000]
Default: 2000 (2 seconds)
sendADAckTimerInMillis
- the SendADAckTimerInMillis property value, null to unset.@Deprecated Integer getSendADMaxResends()
@Deprecated void setSendADMaxResends(Integer sendADMaxResends)
Integer getSendADWindowSize()
Format: Valid values are [1..255]
Default: 255
void setSendADWindowSize(Integer sendADWindowSize)
Format: Valid values are [1..255]
Default: 255
sendADWindowSize
- the SendADWindowSize property value, null to unset.Integer getSendBufferSize()
Format: Valid values are greater than 0.
Default: 65536
void setSendBufferSize(Integer sendBufferSize)
Format: Valid values are greater than 0.
Default: 65536
sendBufferSize
- the SendBufferSize property value, null to unset.String getSSLExcludedProtocols()
Format: Allowed values are “tlsv1.1”, “tlsv1.2”, “tlsv1.3”.
Default: “” Note that TLSv1.1 and TLSv1.2 are supported starting with Java 7.
void setSSLExcludedProtocols(String protocols)
Format: Allowed values are “tlsv1.1”, “tlsv1.2”, “tlsv1.3”.
Default: “” Note that TLSv1.1 and TLSv1.2 are supported starting with Java 7.
protocols
- The SSL Excluded Protocols property value, null to unset.String getSSLProtocol()
Format: Allowed values are “tlsv1.1”, “tlsv1.2”, “tlsv1.3”.
Default: “tlsv1.1,tlsv1.2,tlsv1.3” Note that TLSv1.1 and TLSv1.2 are supported starting with Java 7.
void setSSLProtocol(String protocol)
Format: Allowed values are “tlsv1.1”, “tlsv1.2”, “tlsv1.3”.
Default: “tlsv1.1,tlsv1.2,tlsv1.3” Note that TLSv1.1 and TLSv1.2 are supported starting with Java 7.
protocol
- The SSL Protocol property value, null to unset.Boolean getSSLValidateCertificate()
Format: Valid values are true, false.
Default: true
void setSSLValidateCertificate(Boolean validate)
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. |
Format: Valid values are true, false.
Default: true
validate
- The SSL Validate Certificate property, null to unset.Boolean getSSLValidateCertificateHost()
Format: Valid values are true, false.
Default: true
void setSSLValidateCertificateHost(Boolean validate)
This property has effect only when setSSLValidateCertificate(Boolean)
property is
enabled/set to true
Disabling of this property IS NOT RECOMMENDED
Default: true
if not set otherwise
validate
- The SSL Validate Certificate host property, null to unset.Boolean getSSLValidateCertificateDate()
Format: Valid values are true, false.
Default: True
void setSSLValidateCertificateDate(Boolean validateDate)
Format: Valid values are true, false.
Default: True
validateDate
- The SSL Validate Certificate Date property, null to unset.String getSSLCipherSuites()
Format: Comma separated list of cipher names.
Default: All supported ciphers.
void setSSLCipherSuites(String cipherSuites)
Format: Comma separated list of cipher names.
Default: All supported ciphers.
cipherSuites
- The list of ciphers to enable, null to unset.String getSSLTrustStore()
Format: URL or path to the trust store.
Default: none.
void setSSLTrustStore(String truststore)
Format: URL or path to the trust store.
Default: none.
truststore
- The trust store to use in URL or path format, null to unset.String getSSLTrustStorePassword()
Format: String
Default: none.
void setSSLTrustStorePassword(String password)
Format: String
Default: none.
password
- The trust store password, null to unset.String getSSLTrustStoreFormat()
Format: Valid values are “jks”, “pkcs12”..
Default: “jks”
void setSSLTrustStoreFormat(String format)
Format: Valid values are “jks”, “pkcs12”..
Default: “jks”
format
- The format of the given trust store, null to unset.String getSSLKeyStore()
Format: URL or path to the key store.
Default: none.
void setSSLKeyStore(String keystore)
Format: URL or path to the trust store.
Default: none.
keystore
- The key store to use in URL or path format, null to unset.String getSSLKeyStorePassword()
Format: String
Default: none.
void setSSLKeyStorePassword(String password)
Format: String
Default: none.
password
- The key store password, null to unset.String getSSLKeyStoreFormat()
Format: Valid values include “jks”, “pkcs12”..
Default: “jks”
void setSSLKeyStoreFormat(String format)
Format: Valid values include “jks”, “pkcs12”..
Default: “jks”
format
- The format of the given key store, null to unset.String getSSLKeyStoreNormalizedFormat()
Format: Valid values include “jks”, “pkcs12”, etc.
Default: none
void setSSLKeyStoreNormalizedFormat(String format)
Format: Valid values include “jks”, “pkcs12”, etc.
Default: none
format
- The format of the internal normalized key store, null to unset.String getSSLPrivateKeyAlias()
void setSSLPrivateKeyAlias(String alias)
alias
- The alias of the private keyString getSSLPrivateKeyPassword()
void setSSLPrivateKeyPassword(String password)
password
- The password used to decipher the private keyString getSSLTrustedCommonNameList()
Format: A comma separated list of common names.
Default: No common names provided means that all common names are acceptable.
void setSSLTrustedCommonNameList(String commonNames)
Format: A comma separated list of common names.
Default: No common names provided means that all common names are acceptable.
commonNames
- The list of acceptable common names for matching in server certificates, null to unset.Integer getSubscriberLocalPriority()
Format: Valid values are [1..4]
Default: 1
void setSubscriberLocalPriority(Integer subscriberLocalPriority)
Format: Valid values are [1..4]
Default: 1
subscriberLocalPriority
- the SubscriberLocalPriority property value, null to unset.Integer getSubscriberNetworkPriority()
Format: Valid values are [1..4]
Default: 1
void setSubscriberNetworkPriority(Integer subscriberNetworkPriority)
Format: Valid values are [1..4]
Default: 1
subscriberNetworkPriority
- the SubscriberNetworkPriority property value, null to unset.Boolean getTcpNoDelay()
Default: true
void setTcpNoDelay(Boolean tcpNoDelay)
Default: true
tcpNoDelay
- the TcpNoDelay property value, null to unset.Boolean getUseDefaultContext()
Default: false (creates a new context for every connection)
void setUseDefaultContext(Boolean useDefaultContext)
Default: false (creates a new context for every connection)
useDefaultContext
- the UseDefaultContext property value, null to unset.String getUsername()
Format: The maximum length is 189 bytes when encoded in UTF-8 (with SolOS-TR 6.1 and above)
void setUsername(String username)
SupportedProperty.AUTHENTICATION_SCHEME_CLIENT_CERTIFICATE
(Client Certificate based authentication) with setAuthenticationScheme(String)
Format: The maximum length is 189 bytes when encoded in UTF-8 (with SolOS-TR 6.1 and above).
username
- the Username property value, null to unset.String getVPN()
Format: The maximum length is 32 bytes when encoded in UTF-8
Default: “”
void setVPN(String vpn)
Format: The maximum length is 32 bytes when encoded in UTF-8
Default: “”
vpn
- the VPN property value, null to unset.String getSSLConnectionDowngradeTo()
void setSSLConnectionDowngradeTo(String proto)
proto
- the SSLConnectionDowngradeTo property value, null to unset.Boolean getXA()
Default: false
Boolean getXmlPayload()
Default: true
void setXmlPayload(Boolean xmlPayload)
Default: true
xmlPayload
- the XmlPayload property value, null to unset.String getUnknownPublisherFlowAction()
void setUnknownPublisherFlowAction(String action)
Default:
action
- the UnknownPublisherFlowAction property value, null to unset.Set<String> getPropertyNames()
getProperty(String)
and setProperty(String, Object)
Object getProperty(String name)
getPropertyNames()
name
- Name of the property to returnvoid setProperty(String name, Object value)
getPropertyNames()
name
- The name of the property to setvalue
- The value to set the property tIllegalArgumentException
- on errorObject getEffectiveProperty(String name)
getPropertyNames()
This method differs from getProperty(String)
in that it returns
the value that will be used in connection creation. If a property has not
been set through the api (or even if it has), this method may return the
default value or another value that overrides the connection factory's value.name
- Name of the property to return.String toEffectiveString()
getEffectiveProperty(String)
was used to retrieve them.Properties toProperties()
Properties
instance.Properties
instance.void fromProperties(Properties properties)
Properties
instance.properties
- Values to set the ConnectionFactory properties from.IllegalArgumentException
- on errorCopyright 2004-2025 Solace Corporation. All rights reserved.