JCSMPProperties (Solace Messaging API for Java v10.25.1)

java.lang.Object
- com.solacesystems.jcsmp.JCSMPPropertyMap
- - com.solacesystems.jcsmp.JCSMPProperties

All Implemented Interfaces:: Serializable, Cloneable

public class JCSMPProperties
extends JCSMPPropertyMap
implements Serializable

Properties for customizing Session.

Name	Type	Default	Description
`SESSION_NAME`	String	JCSMPSession	(Optional) The name of the session. This parameter is useful for debugging purposes.
`HOST`	String	N/A	(Mandatory) The IPv4 or IPv6 or host name of the appliance. IPv5 addresses must be encoded in brackets ([]). For example, "12.34.56.78", or "[fe80::1]". If connecting to a non-default port, it can be specified here using the "Host:Port" format For example, "12.34.56.78:4444", or "[fe80::1]:4444". This overrides a port setting in `JCSMPChannelProperties`. It is possible to specify a comma-separated list of hosts to connect to, if connecting to Solace appliances; see `JCSMPProperties.HOST`.
`LOCALHOST`	String	N/A	(Optional) The hostname or IP address of the machine on which the application is running. On a multihomed machine, it is recommended to provide this parameter to ensure JCSMP uses the correct network interface.
`USERNAME`	String	N/A	The username used for authentication with the appliance with maximum length of 189 characters (with SolOS 6.1 and above) This property is optional when using `AUTHENTICATION_SCHEME_CLIENT_CERTIFICATE` or `AUTHENTICATION_SCHEME_GSS_KRB` with `AUTHENTICATION_SCHEME`
`PASSWORD`	String	N/A	(Optional) The password used for authentication with the appliance. Normally, there is a password associated with the username. If not, leave this property unset. The maximum length is 128 characters.
`MESSAGE_ACK_MODE`	String	`SUPPORTED_MESSAGE_ACK_AUTO`	(Optional) Indicates whether the acknowledgement of receiving a message is done by JCSMP automatically or by the application explicitly calling `XMLMessage.ackMessage()` or `XMLMessage.settle(com.solacesystems.jcsmp.XMLMessage.Outcome)`. If message acknowledgement mode is `SUPPORTED_MESSAGE_ACK_AUTO`, the call to `XMLMessage.ackMessage()` or `XMLMessage.settle(com.solacesystems.jcsmp.XMLMessage.Outcome)` is ignored and a warning log is generated. The latter corresponds to mode `JCSMPProperties.SUPPORTED_MESSAGE_ACK_CLIENT`. See `XMLMessage.ackMessage()` for more information about acknowledgement modes.
`CLIENT_MODE`	Boolean	N/A	Deprecated. This parameter has no effect.
`APPLICATION_DESCRIPTION`	String	""	(Optional) The client description to report to an appliance. The maximum length is 254 ASCII characters. Setting this property is optional.
`CLIENT_NAME`	String	$HOSTNAME/$PID/$instanceId/$10CharactersRandomString (eg. "localhost/999/00010123/C84bMqRApM")	(Optional) A unique client name to use to register to the appliance. If specified, it must be a valid Topic name, and a maximum of 160 bytes in length when encoded as UTF-8. If a value of "" is specified, the default (auto-generated) client name is applied. CLIENT_NAME is also used to uniquely identify the sender in a message's `senderId` field, if `GENERATE_SENDER_ID` is set.
`P2PINBOX_IN_USE`	`Topic`	`null`	(Read-only) Indicates the P2P topic destination that is used by a connected session operating in client mode. This value is used as a ReplyTo address for requests. A query can be made for this parameter. This topic instance is updated during client channel establishment (login) and when updating the `CLIENT_NAME`.
`GENERATE_SENDER_ID`	Boolean	False	(Optional) Indicates whether the client name should be included in the SenderID message header parameter.
`CLIENT_CHANNEL_PROPERTIES`	`JCSMPChannelProperties`	Refer to `JCSMPChannelProperties` for default settings.	(Optional) The properties for setting up channel connections with a Solace appliance. This replaces the deprecated `CONTROL_CHANNEL_PROPERTIES`, `SUBSCRIBER_DATA_CHANNEL_PROPERTIES` and `PUBLISHER_DATA_CHANNEL_PROPERTIES`.
`CONTROL_CHANNEL_PROPERTIES`	`JCSMPChannelProperties`	Refer to `JCSMPChannelProperties` for default settings.	(Optional) The properties for setting up a control channel connection with the appliance. Deprecated, replaced by `JCSMPProperties.CLIENT_CHANNEL_PROPERTIES`.
`PUBLISHER_DATA_CHANNEL_PROPERTIES`	`JCSMPChannelProperties`	Refer to `JCSMPChannelProperties` for default setting.	(Optional) The properties for setting up a publisher data channel connection with the appliance. Deprecated, replaced by `JCSMPProperties.CLIENT_CHANNEL_PROPERTIES`.
`SUBSCRIBER_DATA_CHANNEL_PROPERTIES`	`JCSMPChannelProperties`	Refer to `JCSMPChannelProperties` for default setting.	(Optional) The properties for setting up a subscriber data channel connection with the appliance. Deprecated, replaced by `JCSMPProperties.CLIENT_CHANNEL_PROPERTIES`.
`SUB_ACK_WINDOW_SIZE`	Integer	255	The size of the sliding subscriber ACK window. The valid range is 1-255.
`PUB_ACK_WINDOW_SIZE`	Integer	1	The size of the sliding publisher window for Guaranteed messages. The Guaranteed Message Publish Window Size property limits the maximum number of messages that can be published before the API must receive an acknowledgement from the appliance. The valid range is 1-255.
`SUB_ACK_TIME`	Integer	1000	The duration of the subscriber ACK timer (in milliseconds). The valid range is 20-1500.
`PUB_ACK_TIME`	Integer	2000	The duration of the publisher acknowledgement timer (in milliseconds). When a published message is not acknowledged within the time specified for this timer, the API automatically retransmits the message. The valid range is 20-60000.
`SUB_ACK_WINDOW_THRESHOLD`	Integer	60	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. The valid range is 1-75.
`MAX_RESENDS`	Integer	N/A	Deprecated. This parameter has no effect.
`GENERATE_RCV_TIMESTAMPS`	Boolean	False	(Optional) Indicates whether to generate a receive timestamp on incoming messages.
`GENERATE_SEND_TIMESTAMPS`	Boolean	False	(Optional) Indicates whether to generate a send timestamp in outgoing messages.
`GENERATE_SEQUENCE_NUMBERS`	Boolean	False	(Optional) Indicates whether to generate a sequence number in outgoing messages.
`CALCULATE_MESSAGE_EXPIRATION`	Boolean	False	(Optional) Indicates whether to calculate message expiration time in outgoing messages and incoming messages.
`VPN_NAME`	String	""	(Optional) The name of the Message VPN to attempt to join when connecting to the appliance. If "", attempt to join the default Message VPN for the client. This parameter is only valid for sessions operating in client mode. If specified, it must be a maximum of 32 bytes in length when encoded as UTF-8.
`VPN_NAME_IN_USE`	String	""	(Read-only) Indicates the Messsage VPN name currently in use by a connected session operating in client mode. A query can be made for this parameter.
`VIRTUAL_ROUTER_NAME`	String	""	(Read-only) Gets the connected router's virtual router name. Used in building appliance endpoint and destination objects such as `Queue` and `Topic`. Router endpoints and destinations created with a virtual router name are valid for use with that appliance, or to address destinations on remote appliances (in a multiple-router network) when publishing messages. Applications requiring the virtual router name need not poll this property every time it is required, and may cache the name. Applications should query the name once after connecting the session, and again after a reconnect operation reports the `SessionEvent.VIRTUAL_ROUTER_NAME_CHANGED` session event to the `SessionEventHandler`. This property must be queried on a previously-connected session, or it will return `""`.
`SUBSCRIBER_LOCAL_PRIORITY`	Integer	1	Subscriber priority is used to choose a client to receive messages sent with the `DeliverToOne` property set. Such messages are sent to the subscriber with the highest priority. Subscribers have two priorities; this priority is for messages published locally. Valid range is 1-4. This property is deprecated.
`SUBSCRIBER_NETWORK_PRIORITY`	Integer	1	Subscriber priority is used to choose a client to receive messages sent with the `DeliverToOne` property set. Such messages are sent to the subscriber with the highest priority. Subscribers have two priorities; this priority is for messages published on appliances other than the one that the client is connected to. Valid range is 1-4. This property is deprecated
`REAPPLY_SUBSCRIPTIONS`	Boolean	False	If enabled, the API maintains a local cache of subscriptions and reapplies them when the subscriber connection is reestablished. Reapply subscriptions will only apply direct topic subscriptions unpon a Session reconnect. It will not reapply topic subscriptions on durable and non-durable endpoints.
`PUB_MULTI_THREAD`	Boolean	True	If enabled (default), the XMLMessageProducer is safe to access from multiple threads.
`PUB_USE_INTERMEDIATE_DIRECT_BUF`	Boolean	True	Defaults to `true`. If enabled, during send operations, the XMLMessageProducer concatenates all published data to an intermediate direct ByteBuffer in the API, and writes only that buffer to the socket instead of performing a vectored write(ByteBuffer[]) operation. This can result in higher throughput for certain send operations. It can, however, lead to performance degradation for some scenarios with large messages or sendMultiple(...) operations, especially if messages are already using direct ByteBuffers for data storage. This property should be set to false in those conditions.
`MESSAGE_CALLBACK_ON_REACTOR`	Boolean	False	If enabled, messages delivered asynchronously to an XMLMessageListener are delivered directly from the I/O thread instead of a consumer notification thread. An application making use of this setting MUST return quickly from the onReceive() callback, and MUST NOT call ANY session methods from the I/O thread. The above means that calling any blocking methods from an `XMLMessageListener` callback is not supported and may cause an application to deadlock.
`IGNORE_DUPLICATE_SUBSCRIPTION_ERROR`	Boolean	False	On addSubscription(Subscription), addSubscription(Endpoint, Subscription, int), or addSubscriptions(XpeList), ignore errors caused by subscriptions being already present.
`IGNORE_SUBSCRIPTION_NOT_FOUND_ERROR`	Boolean	False	On removeSubscription(Subscription), removeSubscription(Endpoint, Subscription, int), or removeSubscriptions(XpeList), ignore errors caused by subscriptions not being found.
`NO_LOCAL`	Boolean	False	If this property is `true`, messages published on the session will not be received on the same session even if the client has a subscription that matches the published topic. If this restriction is requested and the appliance does not have No Local support, the session connect will fail.
`ACK_EVENT_MODE`	String	`SUPPORTED_ACK_EVENT_MODE_PER_MSG`	If this property is set to `SUPPORTED_ACK_EVENT_MODE_PER_MSG`, the message acknowledgement event acknowledges a single published Guaranteed message; if this property is set to `SUPPORTED_ACK_EVENT_MODE_WINDOWED`, the message acknowledgement event acknowledges a range of published Guaranteed messages. Message acknowledgement events are sent from `JCSMPStreamingPublishCorrelatingEventHandler` or `JCSMPStreamingPublishEventHandler`
`SSL_PROTOCOL`	String	"SSLv3,TLSv1,TLSv1.1,TLSv1.2"	This property is used to specify a comma separated list of SSL protocols to use. Allowed values for this property are "SSLv3", "TLSv1", "TLSv1.1", "TLSv1.2", or some combination thereof, such as "SSLv3,TLSv1,TLSv1.1,TLSv1.2". When specifying more than one protocol the order is not important. Note that TLSv1.1 and TLSv1.2 are supported starting with Java 7. This property is deprecated in favor of specifying the protocols to exclude in the property SSL_EXCLUDED_PROTOCOLS.
`SSL_EXCLUDED_PROTOCOLS`	String	""	This property is used to specify a comma separated list of SSL protocols NOT to use. Allowed values for this property are "SSLv3", "TLSv1", "TLSv1.1", "TLSv1.2", or some combination thereof, such as "SSLv3,TLSv1,TLSv1.1,TLSv1.2". When specifying more than one protocol the order is not important. Note that TLSv1.1 and TLSv1.2 are supported starting with Java 7.
`SSL_CIPHER_SUITES`	String	All Supported Ciphers	This property is used to specify a comma separated list of cipher suites in order of preference used for SSL connections. 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_CBC_SHA384 (ECDHE-RSA-AES256-SHA384, SSL_ECDHE_RSA_WITH_AES_256_CBC_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, SSL_ECDHE_RSA_WITH_AES_256_CBC_SHA) * Supported starting with Java 7 and requires installation of the JCE Unlimited Strength Jurisdiction Policy Files TLS_RSA_WITH_AES_256_CBC_SHA256 (AES256-SHA256, SSL_RSA_WITH_AES_256_CBC_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, SSL_RSA_WITH_AES_256_CBC_SHA) * Requires installation of the JCE Unlimited Strength Jurisdiction Policy Files TLS_ECDHE_RSA_WITH_3DES_EDE_CBC_SHA (ECDHE-RSA-DES-CBC3-SHA, SSL_ECDHE_RSA_WITH_3DES_EDE_CBC_SHA) * Supported starting with Java 7 SSL_RSA_WITH_3DES_EDE_CBC_SHA (DES-CBC3-SHA) TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA256 (ECDHE-RSA-AES128-SHA256, SSL_ECDHE_RSA_WITH_AES_128_CBC_SHA256) * Supported starting with Java 7 TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA (ECDHE-RSA-AES128-SHA, SSL_ECDHE_RSA_WITH_AES_128_CBC_SHA) * Supported starting with Java 7 TLS_RSA_WITH_AES_128_CBC_SHA256 (AES128-SHA256, SSL_RSA_WITH_AES_128_CBC_SHA256) * Supported starting with Java 7 TLS_RSA_WITH_AES_128_CBC_SHA (AES128-SHA, SSL_RSA_WITH_AES_128_CBC_SHA) SSL_RSA_WITH_RC4_128_SHA (RC4-SHA) SSL_RSA_WITH_RC4_128_MD5 (RC4-MD5) TLS_RSA_WITH_AES_128_GCM_SHA256 (AES128-GCM-SHA256, SSL_RSA_WITH_AES_128_GCM_SHA256) * Supported starting with Java 8 TLS_RSA_WITH_AES_256_GCM_SHA384 (AES256-GCM-SHA384, SSL_RSA_WITH_AES_256_GCM_SHA384) * Supported starting with Java 8 TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256 (ECDHE-RSA-AES128-GCM-SHA256, SSL_ECDHE_RSA_WITH_AES_128_GCM_SHA256) * Supported starting with Java 8 TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384 (ECDHE-RSA-AES256-GCM-SHA384, SSL_ECDHE_RSA_WITH_AES_256_GCM_SHA384) * Supported starting with Java 8
`SSL_VALIDATE_CERTIFICATE`	Boolean	true	This property is used to specify whether the API should validate server certificates with certificates in the truststore. When disabled, validation of the certificate date, certificate host, and checking the common name list is also disabled. 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 <= 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.
`SSL_VALIDATE_CERTIFICATE_DATE`	Boolean	true	This property is used to specify whether the API should validate server certificate's expiry or not before dates. This property has effect only when `SSL_VALIDATE_CERTIFICATE` property is enabled/set to `true` Disabling of this property IS NOT RECOMMENDED
`SSL_VALIDATE_CERTIFICATE_HOST`	Boolean	true	Session property to indicate if the session connection should fail when a certificate with an invalid host is received. When enabled (by default), and connecting to a named host, the certificate Subject Alternative Name must contain a DNS entry that matches the host string. When enabled, and connecting to a host by IP address, the certificate Subject Alternative Name must contain an IP Address that matches. If there is no Subject Alternate Name the certificate Common Name (CN) must match the named host. This property has effect only when `SSL_VALIDATE_CERTIFICATE` property is enabled/set to `true` Disabling of this property IS NOT RECOMMENDED
`SSL_TRUST_STORE`	String	'java.home/lib/security/jssecacerts' or 'java.home/lib/security/cacerts'	This property is used to specify the truststore file to use in URL or path format. If a truststore named java.home/lib/security/jssecacerts is found, it is set as the default. Otherwise, a truststore named java.home/lib/security/cacerts is set as the default. Where 'java.home' is a system property.
`SSL_IN_MEMORY_TRUST_STORE`	`java.security.KeyStore`	null	This property is used to specify in-memory trust store in a `java.security.KeyStore` format. Default value is `null`. This property should not be used together with `SSL_TRUST_STORE`. `SSL_TRUST_STORE_PASSWORD` is not required when using this property. Only one of `SSL_TRUST_STORE` or `SSL_IN_MEMORY_TRUST_STORE` property should be set, otherwise `InvalidPropertiesException` will be raised. Note: It is expected that the user will not modify KeyStore object after it is passed into JCSMP
`SSL_TRUST_STORE_PASSWORD`	String	""	This property is used to specify the password of the truststore given in `SSL_TRUST_STORE`. Mandatory if `SSL_VALIDATE_CERTIFICATE` is true.
`SSL_TRUST_STORE_FORMAT`	String	the default keystore type as specified by the keystore	This property is used to specify the format of the truststore given in `SSL_TRUST_STORE`.
`SSL_TRUSTED_COMMON_NAME_LIST`	String	""	This property is used to specify a comma separated list of acceptable common names for matching with 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. Note that leading and trailing whitespaces are considered to be part of the common names and are not ignored. An empty string means accept all common names. This property has effect only when `SSL_VALIDATE_CERTIFICATE` property is enabled/set to `true` Note: When `SSL_VALIDATE_CERTIFICATE_HOST` is true (default) this property should be set to an empty list. Failure to do so may cause the API to reject an otherwise valid certificate.
`SSL_KEY_STORE`	String	""	This property is used to specify the keystore file to use in URL or path format. Mandatory if `AUTHENTICATION_SCHEME` is set to `AUTHENTICATION_SCHEME_CLIENT_CERTIFICATE`.
`SSL_IN_MEMORY_KEY_STORE`	`java.security.KeyStore`	null	This property is used to specify in-memory key store in a `java.security.KeyStore` format. Default value is `null`. This property should not be used together with `SSL_KEY_STORE`. `SSL_KEY_STORE_PASSWORD` is not required when using this property. Only one of `SSL_KEY_STORE` or `SSL_IN_MEMORY_KEY_STORE` property should be set, otherwise `InvalidPropertiesException` will be raised. Note: It is expected that the user will not modify KeyStore object after it is passed into JCSMP
`SSL_KEY_STORE_PASSWORD`	String	""	This property is used to specify the password of the keystore specified by `SSL_KEY_STORE`. The keystore password allows JCSMP to ensure the keystore hasn't been tampered with by any party that doesn't know the keystore password. The keystore password is also used to decipher the private key if the `SSL_PRIVATE_KEY_PASSWORD` property is not specified. When `AUTHENTICATION_SCHEME` is set to `AUTHENTICATION_SCHEME_CLIENT_CERTIFICATE` then at least one of these properties have to be set : `SSL_KEY_STORE_PASSWORD` `SSL_PRIVATE_KEY_PASSWORD`
`SSL_KEY_STORE_FORMAT`	String	the default keystore type as specified by the keystore	This property is used to specify the format of the keystore given in `SSL_KEY_STORE`.
`SSL_KEY_STORE_NORMALIZED_FORMAT`	String	Same as specified in `JCSMPProperties.SSL_KEY_STORE_FORMAT`	This property is used to specify the format of an internal normalized representation of the keystore if it needs to be different from the default format.
`SSL_PRIVATE_KEY_ALIAS`	String	""	This property is used to specify the alias of the private key to use for client certificate authentication. If there is only one private key entry in the keystore specified by `SSL_KEY_STORE`, then this property doesn't have to be set.
`SSL_PRIVATE_KEY_PASSWORD`	String	""	This property is used to specify the password that deciphers the private key from the key store. When this property is not specified, the private key will be deciphered using the value of the `SSL_KEY_STORE_PASSWORD` property instead. This property is required when the private key was encrypted using a different key than the password used to sign the keystore. When `AUTHENTICATION_SCHEME` is set to `AUTHENTICATION_SCHEME_CLIENT_CERTIFICATE` then at least one of these properties have to be set : `SSL_KEY_STORE_PASSWORD` `SSL_PRIVATE_KEY_PASSWORD`
`AUTHENTICATION_SCHEME`	String	`AUTHENTICATION_SCHEME_BASIC`	String property specifying the authentication scheme. Allowed values are one of: `AUTHENTICATION_SCHEME_BASIC` `AUTHENTICATION_SCHEME_CLIENT_CERTIFICATE` `AUTHENTICATION_SCHEME_GSS_KRB` `AUTHENTICATION_SCHEME_OAUTH2` When `AUTHENTICATION_SCHEME_CLIENT_CERTIFICATE` is used then at least one of these properties have to be set : `SSL_KEY_STORE_PASSWORD` `SSL_PRIVATE_KEY_PASSWORD` and `SSL_KEY_STORE` becomes mandatory. When `AUTHENTICATION_SCHEME_OAUTH2` is used, one of `OAUTH2_ACCESS_TOKEN` and `OIDC_ID_TOKEN` has to be specified.
`KRB_SERVICE_NAME`	String	solace	This property is used to specify the ServiceName portion of the Service Principal Name (SPN) that has a format of ServiceName/ApplianceName@REALM.
`GD_RECONNECT_FAIL_ACTION`	String	`GD_RECONNECT_FAIL_ACTION_AUTO_RETRY`	A string property to define the behavior when the API is unable to reconnect guaranteed delivery after reconnecting the session. This may occur if the session is configured with a host list where each Solace router in the host list is unaware of state on the previous router. It can also occur if the time to reconnect to the same router exceeds the publisher flow timeout on the router. This property is supported as a system property. Allowed values are: `GD_RECONNECT_FAIL_ACTION_AUTO_RETRY` `GD_RECONNECT_FAIL_ACTION_DISCONNECT`
`SSL_CONNECTION_DOWNGRADE_TO`	String	N/A	Session property specifying a transport protocol that SSL session connection will be downgraded to after client authentication. The downgrade is not supported for the WebSocket transport protocol. Allowed values: `TRANSPORT_PROTOCOL_PLAIN_TEXT`
`OAUTH2_ACCESS_TOKEN`	String	N/A	Session property specifying an Oauth 2.0 Access token.
`OAUTH2_ISSUER_IDENTIFIER`	String	N/A	Session property specifying an Issuer identifier URI.
`OIDC_ID_TOKEN`	String	N/A	Session property specifying an OIDC (OpenId Connect) ID Token.

See Also:: Serialized Form

Field Summary

Fields
Modifier and Type	Field and Description
`static String`	`ACK_EVENT_MODE`
`static String`	`APPLICATION_DESCRIPTION`
`static String`	`AUTHENTICATION_SCHEME`
`static String`	`AUTHENTICATION_SCHEME_BASIC` Username/Password based Authentication Scheme.
`static String`	`AUTHENTICATION_SCHEME_CLIENT_CERTIFICATE` Client-side certificate base Authentication Scheme.
`static String`	`AUTHENTICATION_SCHEME_GSS_KRB` Kerberos based Authentication Scheme.
`static String`	`AUTHENTICATION_SCHEME_OAUTH2` OAuth 2.0 based Authentication Scheme.
`static String`	`CALCULATE_MESSAGE_EXPIRATION`
`static String`	`CLIENT_CHANNEL_PROPERTIES`
`static String`	`CLIENT_MODE` Deprecated.
`static String`	`CLIENT_NAME`
`static String`	`CONTROL_CHANNEL_PROPERTIES` Deprecated. These channel properties are deprecated in favor of `JCSMPProperties.CLIENT_CHANNEL_PROPERTIES`. If the default settings for CLIENT_CHANNEL_PROPERTIES are modified in any way, they override these legacy channel properties.
`static String`	`DEFAULT_SESSION_NAME`
`static String`	`GD_RECONNECT_FAIL_ACTION` A string property to define the behavior when the API is unable to reconnect guaranteed delivery after reconnecting the session.
`static String`	`GD_RECONNECT_FAIL_ACTION_AUTO_RETRY` Clear the publisher state and reconnect the publisher flow.
`static String`	`GD_RECONNECT_FAIL_ACTION_DISCONNECT` Close the session, even if the `reconnectRetries` is configured to a non-zero value.
`static String`	`GENERATE_RCV_TIMESTAMPS`
`static String`	`GENERATE_SEND_TIMESTAMPS`
`static String`	`GENERATE_SENDER_ID`
`static String`	`GENERATE_SEQUENCE_NUMBERS`
`static String`	`HOST` The IP address (or host name) to connect to.
`static String`	`IGNORE_DUPLICATE_SUBSCRIPTION_ERROR`
`static String`	`IGNORE_SUBSCRIPTION_NOT_FOUND_ERROR`
`static String`	`JAAS_CONFIG_FILE_RELOAD_ENABLED` A boolean property when true indicates that the login configuration file is reloaded before connect or reconnect to the router.
`static String`	`JAAS_LOGIN_CONTEXT` A session property that specifies a name that applications use to refer to the entry in a login configuration file when they instantiate a LoginContext.
`static String`	`KRB_SERVICE_DEFAULT`
`static String`	`KRB_SERVICE_NAME`
`static String`	`LOCALHOST`
`static String`	`MAX_RESENDS` Deprecated.
`static String`	`MESSAGE_ACK_MODE`
`static String`	`MESSAGE_CALLBACK_ON_REACTOR`
`static String`	`NO_LOCAL`
`static String`	`OAUTH2_ACCESS_TOKEN` Specifies Oauth 2.0 Access token.
`static String`	`OAUTH2_ISSUER_IDENTIFIER` Specifies Issuer identifier URI
`static String`	`OIDC_ID_TOKEN` Specifies OIDC (OpenId Connect) ID Token.
`static String`	`P2PINBOX_IN_USE`
`static String`	`PASSWORD`
`static String`	`PAYLOAD_COMPRESSION_LEVEL` This property must be set to enable payload compression.
`static String`	`PUB_ACK_TIME`
`static String`	`PUB_ACK_WINDOW_SIZE`
`static String`	`PUB_MULTI_THREAD`
`static String`	`PUB_USE_INTERMEDIATE_DIRECT_BUF`
`static String`	`PUBLISHER_DATA_CHANNEL_PROPERTIES` Deprecated. These channel properties are deprecated in favor of `JCSMPProperties.CLIENT_CHANNEL_PROPERTIES`. If the default settings for CLIENT_CHANNEL_PROPERTIES are modified in any way, they override these legacy channel properties.
`static String`	`REAPPLY_SUBSCRIPTIONS`
`static String`	`SECURE_PROPS` Deprecated.
`static String`	`SESSION_NAME` Deprecated.
`static String`	`SSL_CIPHER_SUITES`
`static String`	`SSL_CONNECTION_DOWNGRADE_TO` Session property specifying a transport protocol that SSL session connection will be downgraded to after client authentication.
`static String`	`SSL_EXCLUDED_PROTOCOLS`
`static String`	`SSL_IN_MEMORY_KEY_STORE`
`static String`	`SSL_IN_MEMORY_TRUST_STORE`
`static String`	`SSL_KEY_STORE`
`static String`	`SSL_KEY_STORE_FORMAT`
`static String`	`SSL_KEY_STORE_NORMALIZED_FORMAT`
`static String`	`SSL_KEY_STORE_PASSWORD`
`static String`	`SSL_PRIVATE_KEY_ALIAS`
`static String`	`SSL_PRIVATE_KEY_PASSWORD`
`static String`	`SSL_PROTOCOL` Deprecated.
`static String`	`SSL_TRUST_STORE`
`static String`	`SSL_TRUST_STORE_FORMAT`
`static String`	`SSL_TRUST_STORE_PASSWORD`
`static String`	`SSL_TRUSTED_COMMON_NAME_LIST`
`static String`	`SSL_VALIDATE_CERTIFICATE`
`static String`	`SSL_VALIDATE_CERTIFICATE_DATE`
`static String`	`SSL_VALIDATE_CERTIFICATE_HOST`
`static String`	`SUB_ACK_TIME`
`static String`	`SUB_ACK_WINDOW_SIZE`
`static String`	`SUB_ACK_WINDOW_THRESHOLD`
`static String`	`SUBSCRIBER_DATA_CHANNEL_PROPERTIES` Deprecated. These channel properties are deprecated in favor of `JCSMPProperties.CLIENT_CHANNEL_PROPERTIES`. If the default settings for CLIENT_CHANNEL_PROPERTIES are modified in any way, they override these legacy channel properties.
`static String`	`SUBSCRIBER_LOCAL_PRIORITY` Deprecated.
`static String`	`SUBSCRIBER_NETWORK_PRIORITY` Deprecated.
`static String`	`SUPPORTED_ACK_EVENT_MODE_PER_MSG` API sends out message acknowledgement event for a single Guaranteed message published.
`static String`	`SUPPORTED_ACK_EVENT_MODE_WINDOWED` API sends out message acknowledgement event for a range of Guaranteed messages published.
`static String`	`SUPPORTED_MESSAGE_ACK_AUTO` Auto-ack incoming Guaranteed messages.
`static String`	`SUPPORTED_MESSAGE_ACK_CLIENT` Client acknowledgement of incoming Guaranteed messages.
`static String`	`TRANSPORT_PROTOCOL_PLAIN_TEXT` Plain text transport protocol for `SSL_CONNECTION_DOWNGRADE_TO`.
`static String`	`USERNAME`
`static String`	`VIRTUAL_ROUTER_NAME`
`static String`	`VPN_NAME`
`static String`	`VPN_NAME_IN_USE`

Constructor Summary

Constructors
Constructor and Description
`JCSMPProperties()` Construct a `JCSMPProperties` object with default settings.
`JCSMPProperties(String host, int port, String username, String password, com.solacesystems.jcsmp.secure.SecureSessionProperties secureProps)` Construct a `JCSMPProperties` object.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static JCSMPProperties`	`fromProperties(Properties p)` Construct a new instance of `JCSMPProperties` from textual `Properties`.
`Object`	`setProperty(String key, Object value)` Sets a property with the specified key and value in the property list.
`Properties`	`toProperties()` Get a `Properties` object representing this instance, suitable for persisting to a flat file.
`String`	`toString()` Returns a string representation of the property list.

Methods inherited from class com.solacesystems.jcsmp.JCSMPPropertyMap
getBooleanProperty, getIntegerProperty, getProperties, getProperty, getStringProperty, propertyNames, setBooleanProperty, setIntegerProperty, setProperties

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

- Field Detail
  - SUPPORTED_MESSAGE_ACK_AUTO
```
public static final String SUPPORTED_MESSAGE_ACK_AUTO
```
    Auto-ack incoming Guaranteed messages.
    
    See Also:
    
    Constant Field Values
  - SUPPORTED_MESSAGE_ACK_CLIENT
```
public static final String SUPPORTED_MESSAGE_ACK_CLIENT
```
    Client acknowledgement of incoming Guaranteed messages.
    
    See Also:
    
    Constant Field Values
  - SUPPORTED_ACK_EVENT_MODE_PER_MSG
```
public static final String SUPPORTED_ACK_EVENT_MODE_PER_MSG
```
    API sends out message acknowledgement event for a single Guaranteed message published.
    
    See Also:
    
    Constant Field Values
  - SUPPORTED_ACK_EVENT_MODE_WINDOWED
```
public static final String SUPPORTED_ACK_EVENT_MODE_WINDOWED
```
    API sends out message acknowledgement event for a range of Guaranteed messages published.
    
    See Also:
    
    Constant Field Values
  - CLIENT_MODE
```
@Deprecated
public static final String CLIENT_MODE
```
    Deprecated.
    
    See Also:
    
    Constant Field Values
  - AUTHENTICATION_SCHEME_BASIC
```
public static final String AUTHENTICATION_SCHEME_BASIC
```
    Username/Password based Authentication Scheme.
    
    See Also:
    
    Constant Field Values
  - AUTHENTICATION_SCHEME_CLIENT_CERTIFICATE
```
public static final String AUTHENTICATION_SCHEME_CLIENT_CERTIFICATE
```
    Client-side certificate base Authentication Scheme.
    
    See Also:
    
    Constant Field Values
  - AUTHENTICATION_SCHEME_GSS_KRB
```
public static final String AUTHENTICATION_SCHEME_GSS_KRB
```
    Kerberos based Authentication Scheme.
    
    See Also:
    
    Constant Field Values
  - AUTHENTICATION_SCHEME_OAUTH2
```
public static final String AUTHENTICATION_SCHEME_OAUTH2
```
    OAuth 2.0 based Authentication Scheme. When this schema is used, a token (JCSMPProperties.OAUTH2_ACCESS_TOKEN or JCSMPProperties.OIDC_ID_TOKEN) has to be specified.
    
    See Also:
    
    Constant Field Values
  - OAUTH2_ACCESS_TOKEN
```
public static final String OAUTH2_ACCESS_TOKEN
```
    Specifies Oauth 2.0 Access token.
    This is a modifiable property (see JCSMPSession.setProperty(String property, Object value)). A modification occurs during the next session reconnection.
    
    See Also:
    
    Constant Field Values
  - OAUTH2_ISSUER_IDENTIFIER
```
public static final String OAUTH2_ISSUER_IDENTIFIER
```
    Specifies Issuer identifier URI
    
    See Also:
    
    Constant Field Values
  - OIDC_ID_TOKEN
```
public static final String OIDC_ID_TOKEN
```
    Specifies OIDC (OpenId Connect) ID Token.
    This is a modifiable property (see JCSMPSession.setProperty(String property, Object value)). A modification occurs during the next session reconnection.
    
    See Also:
    
    Constant Field Values
  - TRANSPORT_PROTOCOL_PLAIN_TEXT
```
public static final String TRANSPORT_PROTOCOL_PLAIN_TEXT
```
    Plain text transport protocol for SSL_CONNECTION_DOWNGRADE_TO.
    
    See Also:
    
    Constant Field Values
  - HOST
```
public static final String HOST
```
    The IP address (or host name) to connect to. Multiple host entries separated by commas (up to four) are allowed. With multiple entries, each is tried in turn until one succeeds. Host contains one or more host entries (up to four). A host entry has the following form:
    [Protocol:]Host[:Port] or [Protocol://]Host[:Port]
    Protocol is the protocol used for the transport channel. The valid values are:
    - tcp - use a TCP channel for communications between the application and its peers. If no protocol is set, tcp is used as a default.
    - tcps - use a SSL channel over TCP for communications between the application and its peers.
    - ws - use a WebSocket channel for communications between the application and its peers. The WebSocket with compression is not supported.
    - wss - use a SSL channel over WebSocket for communications between the application and its peers. The WebSocket 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. This value overrides port setting in JCSMPChannelProperties. A value is only required when using a port other than the following automatically assigned default port number.
    - The default port for TCP without compression is 55555
    - The default port for TCP with compression is 55003
    - The default port for SSL over Tcp is 55443
    - The default port for WebSocket is 80
    - The default port for SSL over WebSocket is 443
    The following examples show how to specify transport channel types. Unless itis otherwise specified, the default port 55555 is used.
    - 192.168.160.28 - connect to IP address 192.168.160.28 over TCP.
    - tcp:192.168.160.28 - connect to IP address 192.168.160.28 over TCP.
    - tcps:192.168.160.28 - connect to IP address 192.168.160.28 and port 55443 over SSL over TCP.
    - ws:192.168.160.28 - connect to IP address 192.168.160.28 over WebSocket.
    - wss:192.168.160.28 - connect to IP address 192.168.160.28 and port 443 over SSL over WebSocket.
    - tcp:192.168.160.28:77777 - connect to IP address 192.168.160.28 and port 77777 over TCP.
    Configuring Multiple Hosts for Redundancy and Failover
    
    Usage
    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.
    See Also:
    
    Constant Field Values
  - SESSION_NAME
```
@Deprecated
public static final String SESSION_NAME
```
    Deprecated.
    
    See Also:
    
    Constant Field Values
  - LOCALHOST
```
public static final String LOCALHOST
```
    See Also:
    
    Constant Field Values
  - USERNAME
```
public static final String USERNAME
```
    See Also:
    
    Constant Field Values
  - PASSWORD
```
public static final String PASSWORD
```
    See Also:
    
    Constant Field Values
  - SECURE_PROPS
```
@Deprecated
public static final String SECURE_PROPS
```
    Deprecated.
    
    See Also:
    
    Constant Field Values
  - CLIENT_CHANNEL_PROPERTIES
```
public static final String CLIENT_CHANNEL_PROPERTIES
```
    See Also:
    
    Constant Field Values
  - MESSAGE_ACK_MODE
```
public static final String MESSAGE_ACK_MODE
```
    See Also:
    
    Constant Field Values
  - APPLICATION_DESCRIPTION
```
public static final String APPLICATION_DESCRIPTION
```
    See Also:
    
    Constant Field Values
  - CLIENT_NAME
```
public static final String CLIENT_NAME
```
    See Also:
    
    Constant Field Values
  - P2PINBOX_IN_USE
```
public static final String P2PINBOX_IN_USE
```
    See Also:
    
    Constant Field Values
  - GENERATE_SENDER_ID
```
public static final String GENERATE_SENDER_ID
```
    See Also:
    
    Constant Field Values
  - GENERATE_SEND_TIMESTAMPS
```
public static final String GENERATE_SEND_TIMESTAMPS
```
    See Also:
    
    Constant Field Values
  - GENERATE_RCV_TIMESTAMPS
```
public static final String GENERATE_RCV_TIMESTAMPS
```
    See Also:
    
    Constant Field Values
  - GENERATE_SEQUENCE_NUMBERS
```
public static final String GENERATE_SEQUENCE_NUMBERS
```
    See Also:
    
    Constant Field Values
  - CALCULATE_MESSAGE_EXPIRATION
```
public static final String CALCULATE_MESSAGE_EXPIRATION
```
    See Also:
    
    Constant Field Values
  - VPN_NAME
```
public static final String VPN_NAME
```
    See Also:
    
    Constant Field Values
  - VPN_NAME_IN_USE
```
public static final String VPN_NAME_IN_USE
```
    See Also:
    
    Constant Field Values
  - REAPPLY_SUBSCRIPTIONS
```
public static final String REAPPLY_SUBSCRIPTIONS
```
    See Also:
    
    Constant Field Values
  - PUB_MULTI_THREAD
```
public static final String PUB_MULTI_THREAD
```
    See Also:
    
    Constant Field Values
  - PUB_USE_INTERMEDIATE_DIRECT_BUF
```
public static final String PUB_USE_INTERMEDIATE_DIRECT_BUF
```
    See Also:
    
    Constant Field Values
  - MESSAGE_CALLBACK_ON_REACTOR
```
public static final String MESSAGE_CALLBACK_ON_REACTOR
```
    See Also:
    
    Constant Field Values
  - IGNORE_DUPLICATE_SUBSCRIPTION_ERROR
```
public static final String IGNORE_DUPLICATE_SUBSCRIPTION_ERROR
```
    See Also:
    
    Constant Field Values
  - IGNORE_SUBSCRIPTION_NOT_FOUND_ERROR
```
public static final String IGNORE_SUBSCRIPTION_NOT_FOUND_ERROR
```
    See Also:
    
    Constant Field Values
  - VIRTUAL_ROUTER_NAME
```
public static final String VIRTUAL_ROUTER_NAME
```
    See Also:
    
    Constant Field Values
  - NO_LOCAL
```
public static final String NO_LOCAL
```
    See Also:
    
    Constant Field Values
  - ACK_EVENT_MODE
```
public static final String ACK_EVENT_MODE
```
    See Also:
    
    Constant Field Values
  - SSL_EXCLUDED_PROTOCOLS
```
public static final String SSL_EXCLUDED_PROTOCOLS
```
    See Also:
    
    Constant Field Values
  - SSL_VALIDATE_CERTIFICATE
```
public static final String SSL_VALIDATE_CERTIFICATE
```
    See Also:
    
    Constant Field Values
  - SSL_VALIDATE_CERTIFICATE_DATE
```
public static final String SSL_VALIDATE_CERTIFICATE_DATE
```
    See Also:
    
    Constant Field Values
  - SSL_VALIDATE_CERTIFICATE_HOST
```
public static final String SSL_VALIDATE_CERTIFICATE_HOST
```
    See Also:
    
    Constant Field Values
  - SSL_CIPHER_SUITES
```
public static final String SSL_CIPHER_SUITES
```
    See Also:
    
    Constant Field Values
  - SSL_TRUST_STORE
```
public static final String SSL_TRUST_STORE
```
    See Also:
    
    Constant Field Values
  - SSL_TRUST_STORE_PASSWORD
```
public static final String SSL_TRUST_STORE_PASSWORD
```
    See Also:
    
    Constant Field Values
  - SSL_TRUST_STORE_FORMAT
```
public static final String SSL_TRUST_STORE_FORMAT
```
    See Also:
    
    Constant Field Values
  - SSL_TRUSTED_COMMON_NAME_LIST
```
public static final String SSL_TRUSTED_COMMON_NAME_LIST
```
    See Also:
    
    Constant Field Values
  - SSL_KEY_STORE
```
public static final String SSL_KEY_STORE
```
    See Also:
    
    Constant Field Values
  - SSL_KEY_STORE_PASSWORD
```
public static final String SSL_KEY_STORE_PASSWORD
```
    See Also:
    
    Constant Field Values
  - SSL_KEY_STORE_FORMAT
```
public static final String SSL_KEY_STORE_FORMAT
```
    See Also:
    
    Constant Field Values
  - SSL_KEY_STORE_NORMALIZED_FORMAT
```
public static final String SSL_KEY_STORE_NORMALIZED_FORMAT
```
    See Also:
    
    Constant Field Values
  - SSL_PRIVATE_KEY_ALIAS
```
public static final String SSL_PRIVATE_KEY_ALIAS
```
    See Also:
    
    Constant Field Values
  - SSL_PRIVATE_KEY_PASSWORD
```
public static final String SSL_PRIVATE_KEY_PASSWORD
```
    See Also:
    
    Constant Field Values
  - SSL_IN_MEMORY_KEY_STORE
```
public static final String SSL_IN_MEMORY_KEY_STORE
```
    See Also:
    
    Constant Field Values
  - SSL_IN_MEMORY_TRUST_STORE
```
public static final String SSL_IN_MEMORY_TRUST_STORE
```
    See Also:
    
    Constant Field Values
  - KRB_SERVICE_NAME
```
public static final String KRB_SERVICE_NAME
```
    See Also:
    
    Constant Field Values
  - SUBSCRIBER_LOCAL_PRIORITY
```
@Deprecated
public static final String SUBSCRIBER_LOCAL_PRIORITY
```
    Deprecated.
    
    See Also:
    
    Constant Field Values
  - SUBSCRIBER_NETWORK_PRIORITY
```
@Deprecated
public static final String SUBSCRIBER_NETWORK_PRIORITY
```
    Deprecated.
    
    See Also:
    
    Constant Field Values
  - SSL_PROTOCOL
```
@Deprecated
public static final String SSL_PROTOCOL
```
    Deprecated.
    
    See Also:
    
    Constant Field Values
  - AUTHENTICATION_SCHEME
```
public static final String AUTHENTICATION_SCHEME
```
    See Also:
    
    Constant Field Values
  - SSL_CONNECTION_DOWNGRADE_TO
```
public static final String SSL_CONNECTION_DOWNGRADE_TO
```
    Session property specifying a transport protocol that SSL session connection will be downgraded to after client authentication. The downgrade is not supported for the WebSocket transport protocol.
    Allowed values:
    - TRANSPORT_PROTOCOL_PLAIN_TEXT
    Default: N/A
    See Also:
    
    Constant Field Values
  - GD_RECONNECT_FAIL_ACTION
```
public static final String GD_RECONNECT_FAIL_ACTION
```
    A string property to define the behavior when the API is unable to reconnect guaranteed delivery after reconnecting the session. This may occur if the session is configured with a host list where each Solace router in the host list is unaware of state on the previous router. It can also occur if the time to reconnect to the same router exceeds the publisher flow timeout on the router.
    Default: JCSMPProperties.GD_RECONNECT_FAIL_ACTION_AUTO_RETRY
    
    See Also:
    
    Constant Field Values
  - GD_RECONNECT_FAIL_ACTION_AUTO_RETRY
```
public static final String GD_RECONNECT_FAIL_ACTION_AUTO_RETRY
```
    Clear the publisher state and reconnect the publisher flow. Then republish all unacknowledged messages and raise an event ProducerEvent.REPUBLISH_UNACKED_MESSAGES, this may cause duplication.
    
    See Also:
    
    Constant Field Values
  - GD_RECONNECT_FAIL_ACTION_DISCONNECT
```
public static final String GD_RECONNECT_FAIL_ACTION_DISCONNECT
```
    Close the session, even if the reconnectRetries is configured to a non-zero value. The application is responsible for recreating the session (if required) and resending unacked messages.
    This is the legacy behavior.
    
    See Also:
    
    Constant Field Values
  - CONTROL_CHANNEL_PROPERTIES
```
public static final String CONTROL_CHANNEL_PROPERTIES
```
    Deprecated. These channel properties are deprecated in favor of JCSMPProperties.CLIENT_CHANNEL_PROPERTIES. If the default settings for CLIENT_CHANNEL_PROPERTIES are modified in any way, they override these legacy channel properties.
    
    See Also:
    
    Constant Field Values
  - PUBLISHER_DATA_CHANNEL_PROPERTIES
```
public static final String PUBLISHER_DATA_CHANNEL_PROPERTIES
```
    Deprecated. These channel properties are deprecated in favor of JCSMPProperties.CLIENT_CHANNEL_PROPERTIES. If the default settings for CLIENT_CHANNEL_PROPERTIES are modified in any way, they override these legacy channel properties.
    
    See Also:
    
    Constant Field Values
  - SUBSCRIBER_DATA_CHANNEL_PROPERTIES
```
public static final String SUBSCRIBER_DATA_CHANNEL_PROPERTIES
```
    Deprecated. These channel properties are deprecated in favor of JCSMPProperties.CLIENT_CHANNEL_PROPERTIES. If the default settings for CLIENT_CHANNEL_PROPERTIES are modified in any way, they override these legacy channel properties.
    
    See Also:
    
    Constant Field Values
  - SUB_ACK_WINDOW_SIZE
```
public static final String SUB_ACK_WINDOW_SIZE
```
    See Also:
    
    Constant Field Values
  - PUB_ACK_WINDOW_SIZE
```
public static final String PUB_ACK_WINDOW_SIZE
```
    See Also:
    
    Constant Field Values
  - SUB_ACK_TIME
```
public static final String SUB_ACK_TIME
```
    See Also:
    
    Constant Field Values
  - PUB_ACK_TIME
```
public static final String PUB_ACK_TIME
```
    See Also:
    
    Constant Field Values
  - SUB_ACK_WINDOW_THRESHOLD
```
public static final String SUB_ACK_WINDOW_THRESHOLD
```
    See Also:
    
    Constant Field Values
  - MAX_RESENDS
```
@Deprecated
public static final String MAX_RESENDS
```
    Deprecated.
    
    See Also:
    
    Constant Field Values
  - DEFAULT_SESSION_NAME
```
public static final String DEFAULT_SESSION_NAME
```
    See Also:
    
    Constant Field Values
  - KRB_SERVICE_DEFAULT
```
public static final String KRB_SERVICE_DEFAULT
```
    See Also:
    
    Constant Field Values
  - JAAS_CONFIG_FILE_RELOAD_ENABLED
```
public static final String JAAS_CONFIG_FILE_RELOAD_ENABLED
```
    A boolean property when true indicates that the login configuration file is reloaded before connect or reconnect to the router.
    Default: Boolean.FALSE
    
    See Also:
    
    Constant Field Values
  - JAAS_LOGIN_CONTEXT
```
public static final String JAAS_LOGIN_CONTEXT
```
    A session property that specifies a name that applications use to refer to the entry in a login configuration file when they instantiate a LoginContext.
    Default: SolaceGSS
    
    See Also:
    
    Constant Field Values
  - PAYLOAD_COMPRESSION_LEVEL
```
public static final String PAYLOAD_COMPRESSION_LEVEL
```
    This property must be set to enable payload compression. Valid values for the payload compression level to be applied to the payload of a message published by a client are 0-9.
    Value meanings:
    - 0 - "disable payload compression" (the default)
    - 1 - least amount of compression and fastest data throughput
    - 9 - most compression and slowest data throughput
    The payload compression value should be adjusted according to particular network requirements and the performance required.
    Note: Please ensure that both publishers and consumers are updated to support payload compression before enabling this property. In the case where a publisher compresses the payload and a consumer does not support payload decompression, the untouched compressed message will be received which can lead to potential issues within the consuming application. Therefore, the consumer would either need to update to a newer version of the API or the user would need to handle the decompression on the receiving side in their own application. If a publishing application is able to send a compressed message, the broker's treatment of message-type will vary depending on the protocol. Lastly, do not enable payload compression when sending cache-requests. Applications that are sending cache-requests and receiving cache-responses may end up getting compressed messages that they are not able to handle.
    
    Default: 0 (disabled)
    See Also:
    
    Constant Field Values
- Constructor Detail
  - JCSMPProperties
```
public JCSMPProperties()
```
    Construct a JCSMPProperties object with default settings.
  - JCSMPProperties
```
public JCSMPProperties(String host,
                       int port,
                       String username,
                       String password,
                       com.solacesystems.jcsmp.secure.SecureSessionProperties secureProps)
```
    Construct a JCSMPProperties object. This is a convenience constructor to set commonly used properties.
    
    Parameters:
    
    host - The appliance host IP address.
    
    port - The default SMF/SMFs port used by the appliance.
    
    username - The username for authentication.
    
    password - The password for authentication.
    
    secureProps - The secureSessionProperties.
- Method Detail
  - toString
```
public String toString()
```
    Returns a string representation of the property list.
    
    Overrides:
    
    toString in class Object
    
    Returns:
    
    The list of property names and values.
  - toProperties
```
public Properties toProperties()
```
    Get a Properties object representing this instance, suitable for persisting to a flat file. Deprecated properties are not included in the output. Properties that have value of type Object and cannot be converted to String are not included in the output (e.g. JCSMPProperties.SSL_IN_MEMORY_KEY_STORE and JCSMPProperties.SSL_IN_MEMORY_TRUST_STORE)
    
    Returns:
    
    A new Properties instance.
    
    See Also:
    
    fromProperties(Properties)
  - fromProperties
```
public static JCSMPProperties fromProperties(Properties p)
```
    Construct a new instance of JCSMPProperties from textual Properties.
    The format is as follows: jcsmp.PROPERTY_NAME=PROPERTY_VALUE . For channel properties, use jcsmp.CLIENT_CHANNEL_PROPERTIES.SmfPort=55555, where the property name 'Xxxx' is derived from the corresponding getter/setter 'getXxxx'. Example properties file:
```
 jcsmp.HOST=192.168.1.100
 jcsmp.USERNAME=example
 jcsmp.PASSWORD=secret
 jcsmp.CLIENT_CHANNEL_PROPERTIES.ConnectRetries=2
 jcsmp.CLIENT_CHANNEL_PROPERTIES.SmfPort=55555
 jcsmp.CLIENT_CHANNEL_PROPERTIES.SendBuffer=32000
 
```
    Unrecognized properties are ignored and an INFO-level log message is output.
    Parameters:
    
    p - A Properties instance.
    
    Returns:
    
    A JCSMPProperties instance loaded with the properties supplied.
    
    Throws:
    
    IllegalArgumentException - if a property value cannot be converted from text.
    
    See Also:
    
    toProperties()
  - setProperty
```
public Object setProperty(String key,
                          Object value)
```
    Description copied from class: JCSMPPropertyMap
    
    Sets a property with the specified key and value in the property list. The method returns the result of the put operation to the property map. Property values should match the expected type listed, such as Integer and Boolean properties.
    
    Overrides:
    
    setProperty in class JCSMPPropertyMap
    
    Parameters:
    
    key - The name of the property.
    
    value - The value of the property.
    
    Returns:
    
    The result of the put operation.

Class JCSMPProperties

Field Summary

Constructor Summary

Method Summary

Methods inherited from class com.solacesystems.jcsmp.JCSMPPropertyMap

Methods inherited from class java.lang.Object

Field Detail

SUPPORTED_MESSAGE_ACK_AUTO

SUPPORTED_MESSAGE_ACK_CLIENT

SUPPORTED_ACK_EVENT_MODE_PER_MSG

SUPPORTED_ACK_EVENT_MODE_WINDOWED

CLIENT_MODE

AUTHENTICATION_SCHEME_BASIC

AUTHENTICATION_SCHEME_CLIENT_CERTIFICATE

AUTHENTICATION_SCHEME_GSS_KRB

AUTHENTICATION_SCHEME_OAUTH2

OAUTH2_ACCESS_TOKEN

OAUTH2_ISSUER_IDENTIFIER

OIDC_ID_TOKEN

TRANSPORT_PROTOCOL_PLAIN_TEXT

HOST

Configuring Multiple Hosts for Redundancy and Failover

Usage

SESSION_NAME

LOCALHOST

USERNAME

PASSWORD

SECURE_PROPS

CLIENT_CHANNEL_PROPERTIES

MESSAGE_ACK_MODE

APPLICATION_DESCRIPTION

CLIENT_NAME

P2PINBOX_IN_USE

GENERATE_SENDER_ID

GENERATE_SEND_TIMESTAMPS

GENERATE_RCV_TIMESTAMPS

GENERATE_SEQUENCE_NUMBERS

CALCULATE_MESSAGE_EXPIRATION

VPN_NAME

VPN_NAME_IN_USE

REAPPLY_SUBSCRIPTIONS

PUB_MULTI_THREAD

PUB_USE_INTERMEDIATE_DIRECT_BUF

MESSAGE_CALLBACK_ON_REACTOR

IGNORE_DUPLICATE_SUBSCRIPTION_ERROR

IGNORE_SUBSCRIPTION_NOT_FOUND_ERROR

VIRTUAL_ROUTER_NAME

NO_LOCAL

ACK_EVENT_MODE

SSL_EXCLUDED_PROTOCOLS

SSL_VALIDATE_CERTIFICATE

SSL_VALIDATE_CERTIFICATE_DATE

SSL_VALIDATE_CERTIFICATE_HOST

SSL_CIPHER_SUITES

SSL_TRUST_STORE

SSL_TRUST_STORE_PASSWORD

SSL_TRUST_STORE_FORMAT

SSL_TRUSTED_COMMON_NAME_LIST

SSL_KEY_STORE

SSL_KEY_STORE_PASSWORD

SSL_KEY_STORE_FORMAT

SSL_KEY_STORE_NORMALIZED_FORMAT

SSL_PRIVATE_KEY_ALIAS

SSL_PRIVATE_KEY_PASSWORD

SSL_IN_MEMORY_KEY_STORE

SSL_IN_MEMORY_TRUST_STORE

KRB_SERVICE_NAME

SUBSCRIBER_LOCAL_PRIORITY

SUBSCRIBER_NETWORK_PRIORITY

SSL_PROTOCOL

AUTHENTICATION_SCHEME

SSL_CONNECTION_DOWNGRADE_TO

GD_RECONNECT_FAIL_ACTION

GD_RECONNECT_FAIL_ACTION_AUTO_RETRY

GD_RECONNECT_FAIL_ACTION_DISCONNECT

CONTROL_CHANNEL_PROPERTIES

PUBLISHER_DATA_CHANNEL_PROPERTIES

SUBSCRIBER_DATA_CHANNEL_PROPERTIES

SUB_ACK_WINDOW_SIZE

PUB_ACK_WINDOW_SIZE