com.solacesystems.solclientj.core.handle

Class SessionHandle.PROPERTIES

java.lang.Object

com.solacesystems.solclientj.core.handle.SessionHandle.PROPERTIES

Enclosing interface:

SessionHandle

public static final class SessionHandle.PROPERTIES
extends java.lang.Object

Defines the property names used to create a SessionHandle.

Some Session Properties can also be set as environment variables. If a session property can be set as an environment variable, the API will only look for that environment variable if the property is not specified in the session property list passed to ContextHandle.createSessionForHandle(SessionHandle, String[], MessageCallback, SessionEventCallback).

The names of the environment variables are based on the native library property names. The following environment variables are recognized:

• SOLCLIENT_SESSION_PROP_PASSWORD
• SOLCLIENT_SESSION_PROP_HOST
• SOLCLIENT_SESSION_PROP_GD_RECONNECT_FAIL_ACTION - The acceptable strings for this environment variable are also based on the underlying native library:
  1. "SOLCLIENT_SESSION_PROP_GD_RECONNECT_FAIL_ACTION_AUTO_RETRY"
  2. "SOLCLIENT_SESSION_PROP_GD_RECONNECT_FAIL_ACTION_DISCONNECT"

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	ACK_EVENT_MODE This property specifies if the session event SolEnum.SessionEventCode#ACKNOWLEDGEMENT acknowledges a single message (see SolEnum.AckEventMode.PER_MSG) or a range of messages (see SolEnum.AckEventMode.WINDOWED).
static java.lang.String	AD_PUB_ROUTER_WINDOWED_ACK When disabled, initiate a window size of 1 to appliance, but do not wait for acknowledgements before transmitting up to the actual window size.
static java.lang.String	APPLICATION_DESCRIPTION A string that uniquely describes the application instance.
static java.lang.String	AUTHENTICATION_SCHEME This property specifies the authentication scheme.
static java.lang.String	BIND_IP (Optional) The hostname or IP address of the machine on which the application is running.
static java.lang.String	BLOCK_WHILE_CONNECTING Enable this property to block the calling thread on operations such as sending a message, subscribing, or unsubscribing when the Session is being connected or reconnected.
static java.lang.String	BLOCKING_WRITE_TIMEOUT_MS The timeout period (in milliseconds) for blocking write operation.
static java.lang.String	BUFFER_SIZE The maximum amount of messages to buffer (in bytes) when the TCP session is flow controlled.
static java.lang.String	CALCULATE_MESSAGE_EXPIRATION If this property is enabled and time-to-live ( MessageHandle.setTimeToLive(long)) has a positive value in a message, the expiration time is calculated when the message is sent or received and can be retrieved with MessageHandle.getExpiration()
static java.lang.String	CLIENT_NAME The Session client name that is used during client login to create a unique Session.
static java.lang.String	COMPRESSION_LEVEL Enables messages to be compressed with ZLIB before transmission and decompressed on receive.
static java.lang.String	CONNECT_BLOCKING A blocking connect operation suspends until the Session is successfully connected, including restoring all remembered subscriptions if REAPPLY_SUBSCRIPTIONS is enabled.
static java.lang.String	CONNECT_RETRIES How many times to try to connect to the host appliance (or list of appliances) during connection setup.
static java.lang.String	CONNECT_RETRIES_PER_HOST When using a host list, this property defines how many times to try to connect or reconnect to a single host before moving to the next host in the list.
static java.lang.String	CONNECT_TIMEOUT_MS The timeout period (in milliseconds) for a connect operation to a given host (per host).
static java.lang.String	GD_RECONNECT_FAIL_ACTION A property to define the behavior when the CCSMP API is unable to reconnect guaranteed delivery after reconnecting the session.
static java.lang.String	GENERATE_RCV_TIMESTAMPS When enabled, a receive timestamp is recorded for each message and can be retrieved with MessageHandle.getReceiveTimestamp().
static java.lang.String	GENERATE_SEND_TIMESTAMPS When enabled, a send timestamp is automatically included (if not already present) in the Solace-defined fields for each message sent.
static java.lang.String	GENERATE_SENDER_ID When enabled, a sender ID is automatically included (if not already present) in the Solace-defined fields for each message sent.
static java.lang.String	GENERATE_SEQUENCE_NUMBER When enabled, a sequence number is automatically included (if not already present) in the Solace-defined fields for each message sent.
static java.lang.String	GUARANTEED_WITH_WEB_TRANSPORT Enables guaranteed messaging with web transport protocols.
static java.lang.String	HOST The IPv4 or IPv6 address or host name to connect to.
static java.lang.String	IGNORE_DUP_SUBSCRIPTION_ERROR Enable this property to ignore errors for duplicate subscription/topic on subscribe or subscription not found errors on unsubscribe.
static java.lang.String	KEEP_ALIVE_INT_MS The amount of time (in milliseconds) to wait between sending out Keep-Alive messages.
static java.lang.String	KEEP_ALIVE_LIMIT The maximum number of consecutive Keep-Alive messages that can be sent without receiving a response before the connection is closed by the API.
static java.lang.String	KRB_SERVICE_NAME This property specifies the first part of Kerberos Service Principal Name (SPN) of the form ServiceName/Hostname\@REALM (for Windows) or Host Based Service of the form ServiceName\@Hostname (for Linux and SunOS).
static java.lang.String	MODIFYPROP_TIMEOUT_MS Maximum amount of time (in milliseconds) to wait for session property modification.
static java.lang.String	NO_LOCAL If this property is enables, messages published on the Session cannot be received on the same Session even if the client has a subscription that matches the published topic.
static java.lang.String	OAUTH2_ACCESS_TOKEN The OAUTH2 access token.
static java.lang.String	OAUTH2_ISSUER_IDENTIFIER The optional Issuer identifier URI for OAUTH2 access token based authentication.
static java.lang.String	OIDC_ID_TOKEN The OIDC (OpenId Connect) ID Token.
static java.lang.String	P2PINBOX_IN_USE A read-only informational string that indicates the default reply-to destination that is used when a request message is sent that does not have a reply-to destination specified.
static java.lang.String	PASSWORD The password required for authentication.
static java.lang.String	PAYLOAD_COMPRESSION_LEVEL This property must be set to enable payload compression.
static java.lang.String	PROVISION_TIMEOUT_MS Maximum amount of time (in milliseconds) to wait for a provision command (create or delete an endpoint)
static java.lang.String	PUB_ACK_TIMER The duration of publisher acknowledgement timer (in milliseconds).
static java.lang.String	PUB_WINDOW_SIZE The publisher window size for Guaranteed messages.
static java.lang.String	REAPPLY_SUBSCRIPTIONS Enable this property to have the API remember subscriptions and reapply them upon a Session reconnect.
static java.lang.String	RECONNECT_RETRIES How many times to retry to reconnect to the host appliance (or list of appliances) after a connected Session goes down.
static java.lang.String	RETRY_WAIT_MS How much time (in ms) to wait between each attempt to connect or reconnect to a host.
static java.lang.String	SEND_BLOCKING A blocking send operation suspends when the Session is transport flow controlled, otherwise the send operation returns SolEnum.ReturnCode.WOULD_BLOCK.
static java.lang.String	SOCKET_RCV_BUF_SIZE The value for socket receive buffer size (in bytes).
static java.lang.String	SOCKET_SEND_BUF_SIZE The value for the socket send buffer size (in bytes).
static java.lang.String	SSL_CIPHER_SUITES This property specifies a comma separated list of the cipher suites.
static java.lang.String	SSL_CLIENT_CERTIFICATE_FILE This property specifies the client certificate file name.
static java.lang.String	SSL_CLIENT_PRIVATE_KEY_FILE This property specifies the client private key file name.
static java.lang.String	SSL_CLIENT_PRIVATE_KEY_FILE_PASSWORD This property specifies the password used to encrypt the client private key file.
static java.lang.String	SSL_CONNECTION_DOWNGRADE_TO This property specifies a transport protocol that SSL connection will be downgraded to after client authentication.
static java.lang.String	SSL_EXCLUDED_PROTOCOLS This property specifies a comma separated list of SSL protocol(s) not to use.
static java.lang.String	SSL_PROTOCOL Deprecated.
static java.lang.String	SSL_TRUST_STORE_DIR This property specifies the directory where the trusted certificates are.
static java.lang.String	SSL_TRUSTED_COMMON_NAME_LIST NOT RECOMMENDED Per RFC-6125 section 6.4.4, the Common Name (CN) of a certificate should not be used to validate the certificate.
static java.lang.String	SSL_VALIDATE_CERTIFICATE This property indicates if the certificate validation with certificates in the truststore is enabled.
static java.lang.String	SSL_VALIDATE_CERTIFICATE_DATE This property indicates if the session connection should fail when a certificate with an invalid date is received.
static java.lang.String	SSL_VALIDATE_CERTIFICATE_HOST This property indicates if the sesssion connection should fail when a certificate with an invalid host is received.
static java.lang.String	SUBCONFIRM_TIMEOUT_MS The timeout period (in milliseconds) for subscription confirm (add or remove).
static java.lang.String	SUBSCRIBE_BLOCKING A blocking subscribe operation will suspend when the Session is transport flow controlled, otherwise the subscribe operation returns SolEnum.ReturnCode.WOULD_BLOCK.
static java.lang.String	SUBSCRIBER_LOCAL_PRIORITY Deprecated. New applications should use shared subscriptions instead.
static java.lang.String	SUBSCRIBER_NETWORK_PRIORITY Deprecated. New applications should use shared subscriptions instead.
static java.lang.String	TCP_NODELAY Enable this property to enable TCP no delay.
static java.lang.String	TOPIC_DISPATCH Enable this property to have the API dispatch messages based on Topic (see event.MessageDispatcher)
static java.lang.String	TRANSPORT_PROTOCOL_DOWNGRADE_TIMEOUT_MS Specifies how long to wait (in milliseconds) for a login response before moving to the next available protocol in a user specified or the default WEB Transport Protocol downgradelist.
static java.lang.String	UNBIND_FAIL_ACTION A property to define the behavior if an unbind-response is not received after an unbind-request (FlowHandle.destroy()) is sent to the Solace Appliance.
static java.lang.String	USER_ID A read-only informational string providing information about the application, such as the name of operating system user that is running the application, the hostname, and the PID of the application.
static java.lang.String	USERNAME The username required for authentication.
static java.lang.String	VIRTUAL_ROUTER_NAME A read-only property that indicates the connected appliance's virtual router name.
static java.lang.String	VPN_NAME The name of the Message VPN to attempt to join when connecting to an Appliance.
static java.lang.String	VPN_NAME_IN_USE A read-only Session property that indicates which Message VPN the Session is connected to.
static java.lang.String	WEB_TRANSPORT_PROTOCOL This property specifies a WEB Transport Protocol in the default WEB Transport Protocol downgrade list to use for the session connection.
static java.lang.String	WEB_TRANSPORT_PROTOCOL_IN_USE Read-only property which returns the WEB Transport Protocol curently in use for web messaging.
static java.lang.String	WEB_TRANSPORT_PROTOCOL_LIST This property specifies a comma separated list of WEB Transport Protocols to use for session connection.

Constructor Summary

Constructors

Constructor and Description
PROPERTIES()

Method Summary

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

VPN_NAME

public static final java.lang.String VPN_NAME

The name of the Message VPN to attempt to join when connecting to an Appliance.
Default: empty string

See Also:

Constant Field Values

USERNAME

public static final java.lang.String USERNAME

The username required for authentication.
Default: empty string

See Also:

Constant Field Values

PASSWORD

public static final java.lang.String PASSWORD

The password required for authentication.
May be set as an environment variable. (see Session Properties)

Default: empty string

See Also:

Constant Field Values

HOST

public static final java.lang.String HOST

The IPv4 or IPv6 address or host name to connect to. Multiple entries separated by commas (up to sixteen) are allowed. With multiple entries, each is tried in turn until one succeeds.

Each entry should provide a protocol, host, and port. The SessionHandle.PROPERTIES.HOST property may also include an optional Proxy Server configuration, separated from the message router configuration by a percent (%) sign.

[Protocol:]Host[:Port][%ProxyService] or [Protocol://]Host[:Port][%ProxyService]

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. The encryption with compression is not supported. http - use HTTP channels or a WebSocket channel over TCP for communications between the application and its peers. Web Messaging with compression is not supported. https - use HTTP channels or a WebSocket channel over SSL for communications between the application and its peers. Web Messaging with compression is not supported.

Host is the IPv4 or IPv6 address or host name to connect to for a connection. IPv6 addresses must be enclosed in brackets ([]).

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 TCP is 55555 when compression is not in use, or 55003 when compression is in use. The default port for SSL is 55443. The default port for HTTP or WebSocket over TCP is 80. The default port for HTTP or WebSocket over SSL is 443.

The following examples show how to specify transport channel types. Unless it is otherwise specified, the default port 55555 is used.

192.168.160.28 - connect to IP address 192.168.160.28 and the default port 55555 over TCP. [fe80::1] - connect to IPV6 address fe80::1 and the default port 55555 over TCP. tcp:192.168.160.28 - connect to IP address 192.168.160.28 and the default port 55555 over TCP. tcps:192.168.160.28 - connect to IP address 192.168.160.28 and the default port 55443 over SSL over TCP. tcps:[fe80::1] - connect to IPV6 address fe80::1 and the default port 55443 over SSL over TCP. tcp:192.168.160.28:44444 - connect to IP address 192.168.160.28 and port 44444 over TCP. tcp:[fe80::1]:44444 - connect to IPV6 address fe80::1 and port 44444 over TCP. http://192.168.160.28 - connect to IP address 192.168.160.28 and the default port 80 over HTTP or WebSocket over TCP. https://192.168.160.28 - connect to IP address 192.168.160.28 and the default port 443 over HTTP or WebSocket over SSL over TCP.

When Guaranteed messages are being sent, or when flows are being used to receive Guaranteed delivery messages, the API will automatically reconnect to other listed hosts. However, because another host will not know the state of the publisher flow to the original host, the API must reset publisher flow state. Unacknowledged messages are renumbered and resent by the API. If the alternate router is configured as a replication site this may lead to duplicate messages in the system. It is up to the application to resolve this duplication in what ever way is appropriate to the application.

Applications may wish to configure the session so that auto-reconnect only occurs if no guaranteed messages have been published. This is the legacy behavior of the API. If this is desired then set the session property SessionHandle.PROPERTIES.GD_RECONNECT_FAIL_ACTION to the value GdReconnectFailAction.DISCONNECT. This session property can also be set as environment variable which then allows legacy applications to run without modification or recompile.

Configuring a Proxy Server in a HOST entry

It is sometimes necessary to connect to the message router through a proxy server. The API supports configuring connection through a proxy server in any entry in the list of hosts. If proxy server configuration is required, it follows the message-router configuration and is separated by a percent (%) sign. The host entry format is:

[Protocol:]Host[:Port][%ProxyService] or [Protocol://]Host[:Port][%ProxyService]

ProxyService is a description of the non-transparent proxy. If it is necessary to configure the proxy server that is used to connect to the message router, then the proxy server is configured in the ProxyService string. The ProxyService string format is specified as: [ProxyProtocol]://[username:password@]proxyHost[:proxyPort]

ProxyProtocol is the protocol used to communication with the proxy server. The valid values are: socks5 - Connect to the server with the SOCKS Protocol Version 5, RFC 1928 (IETF Standards Track Document) httpc - Connect to the server with the HTTP Connect Protocol, RFC 2817 (IETF Standards Track Document)

If authentication is required for the proxy server, the username and password may be optionally specified before the proxy host.

proxyHost is the IPv4 or IPv6 address or host name of the proxy server.

proxyPort is the port to connect to for a connection. If the port number is not specified, the default for SOCKS5 is port 1080, and the default for Http-Connect is port 3128.

The following examples show how to connect to a message router through a proxy server.

192.168.160.28%socks5://192.168.1.1 - connect to message router at 192.168.160.28 through a SOCKS5 proxy server at 192.168.1.1. 192.168.160.28%httpc://192.168.1.1 - connect to message router at 192.168.160.28 through a HTTP-Connect proxy server at 192.168.1.1. tcps:solace.company.com%socks5://User:PassWord@proxy.company.com:13128 - connect to message router at solace.company.com using SSL over TCP through a SOCKS5 proxy server at proxy.company.com, port 13128. Authenticate with the proxy server using username User and password PassWord. http://192.168.160.27:44444%httpc://proxy.company.com:11080 - connect to the message router at 192.168.160.28, port 44444, using HTTP. Connect through the proxy server at proxy.company.com, port 11080. [fe80::1]\%socks5://[fe80::2] - connect message router at [fe80::1] through a SOCKS5 proxy server at [fe80::2].

Configuring Multiple Hosts for Redundancy and Failover

Some applications might want to have a list of routers available for connection. Typically these routers will be in separate geographic locations and use of a host list allows applications to fail over to the alternate connections if the first router is unavailable. The host list is configured in the Host property of SessionProperties as a comma separated list of hosts. Each host can optionally include a port number as well. For example, if there are two routers 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 SessionProperties.Host would be configured as:

SessionProperties.Host = "192.168.160.128,192.168.160.129:50005"

In this case, when session connect is called, the API attempts to connect, first 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 entries in the host list are attempted. After each entry has been attempted, if all fail, the session properties and SessionHandle.PROPERTIES.RETRY_WAIT_MS determine the behavior of the API. If SessionHandle.PROPERTIES.CONNECT_RETRIES is non-zero, solclientj waits for SessionHandle.PROPERTIES.RETRY_WAIT_MS milliseconds then starts connection attempts again from the beginning of the list.

If an established session fails, to any host in the list, when SessionHandle.PROPERTIES.RECONNECT_RETRIES is non-zero, then API automatically attempts to reconnect, starting at the beginning of the list. Note that the session connect timer, SessionHandle.PROPERTIES.CONNECT_TIMEOUT_MS, runs separately for each connection attempt. So an application waiting for a connection established SolEnum.SessionEvent.UP_NOTICE or connection failure SolEnum.SessionEventCode.CONNECT_FAILED_ERROR could have to wait up to ( (number of hosts in the hosts list) times ( SessionHandle.PROPERTIES.CONNECT_TIMEOUT_MS) for the event.

May be set as an environment variable. (see Session Properties)

Default: empty string

See Also:

Constant Field Values

BUFFER_SIZE

public static final java.lang.String BUFFER_SIZE

The maximum amount of messages to buffer (in bytes) when the TCP session is flow controlled. Controls the buffering of transmit messages. When sending small messages, the session buffer size should be set to multiple times the typical message size to improve performance. Regardless of the buffer size, the API always accepts at least one message to transmit. So even if a single message's size exceeds this value, it is accepted and transmitted, as along as the current buffered data is zero. However, no more messages are accepted until the amount of data buffered is reduced below this value.
Default: 90000

See Also:

Constant Field Values

CONNECT_BLOCKING

public static final java.lang.String CONNECT_BLOCKING

A blocking connect operation suspends until the Session is successfully connected, including restoring all remembered subscriptions if REAPPLY_SUBSCRIPTIONS is enabled. Otherwise session connect returns SolEnum.ReturnCode.IN_PROGRESS.

Default: ENABLE

Possible values in SolEnum.BooleanValue

See Also:

Constant Field Values

SEND_BLOCKING

public static final java.lang.String SEND_BLOCKING

A blocking send operation suspends when the Session is transport flow controlled, otherwise the send operation returns SolEnum.ReturnCode.WOULD_BLOCK. Successful return from a blocking send operation only means the message has been accepted by the transport, it does not guaranteed the message has been processed by the appliance. For the latter you must used Guaranteed Message Delivery mode.

Default: ENABLE

Possible values in SolEnum.BooleanValue

See Also:

Constant Field Values

SUBSCRIBE_BLOCKING

public static final java.lang.String SUBSCRIBE_BLOCKING

A blocking subscribe operation will suspend when the Session is transport flow controlled, otherwise the subscribe operation returns SolEnum.ReturnCode.WOULD_BLOCK. A successful return from a blocking subscribe operation only means the subscription has been accepted by the transport, it does not guarantee the subscription has been processed by the appliance. For the latter you must use a confirmed operation (see SolEnum.SubscribeFlags.WAIT_FOR_CONFIRM)

Default: ENABLE

Possible values in SolEnum.BooleanValue

See Also:

Constant Field Values

BLOCK_WHILE_CONNECTING

public static final java.lang.String BLOCK_WHILE_CONNECTING

Enable this property to block the calling thread on operations such as sending a message, subscribing, or unsubscribing when the Session is being connected or reconnected. The operation must already be blocking (see SessionHandle.PROPERTIES.SEND_BLOCKING and SessionHandle.PROPERTIES.SUBSCRIBE_BLOCKING ), Otherwise, SolEnum.ReturnCode.NOT_READY is returned if the Session is being connected.

Default: ENABLE

Possible values in SolEnum.BooleanValue

See Also:

Constant Field Values

BLOCKING_WRITE_TIMEOUT_MS

public static final java.lang.String BLOCKING_WRITE_TIMEOUT_MS

The timeout period (in milliseconds) for blocking write operation.

Default: 100000 (100 seconds)

Possible values: any non-zero, non-negative integer.

See Also:

Constant Field Values

CONNECT_TIMEOUT_MS

public static final java.lang.String CONNECT_TIMEOUT_MS

The timeout period (in milliseconds) for a connect operation to a given host (per host).

Default: 30000 (30 seconds)

Possible values: any non-zero, non-negative integer.

See Also:

Constant Field Values

SUBCONFIRM_TIMEOUT_MS

public static final java.lang.String SUBCONFIRM_TIMEOUT_MS

The timeout period (in milliseconds) for subscription confirm (add or remove).

Default: 10000 (10 seconds)

Possible values: any value greater than or equal to 1000 (1 second).

See Also:

Constant Field Values

IGNORE_DUP_SUBSCRIPTION_ERROR

public static final java.lang.String IGNORE_DUP_SUBSCRIPTION_ERROR

Enable this property to ignore errors for duplicate subscription/topic on subscribe or subscription not found errors on unsubscribe.

Default: ENABLE

Possible values in SolEnum.BooleanValue

See Also:

Constant Field Values

TCP_NODELAY

public static final java.lang.String TCP_NODELAY

Enable this property to enable TCP no delay.

Default: ENABLE

Possible values in SolEnum.BooleanValue

See Also:

Constant Field Values

SOCKET_SEND_BUF_SIZE

public static final java.lang.String SOCKET_SEND_BUF_SIZE

The value for the socket send buffer size (in bytes). 0 indicates do not set and leave at operating system default. Note that Linux operating system actually allocates twice the size of the buffer requested in the setsockopt(2) call, and so a succeeding getsockopt(2) call will not return the same size of buffer as requested in the setsockopt(2) call. TCP uses the extra space for administrative purposes and internal kernel structures, and the sysctl variables reflect the larger sizes compared to the actual TCP windows.

Default: 90000

Possible values: 0 or any value greater than or equal to 1024.

See Also:

Constant Field Values

SOCKET_RCV_BUF_SIZE

public static final java.lang.String SOCKET_RCV_BUF_SIZE

The value for socket receive buffer size (in bytes). 0 indicates do not set and leave at operating system default.

Default: 150000

Possible values: 0 or any value greater than or equal to 1024.

See Also:

Constant Field Values

KEEP_ALIVE_INT_MS

public static final java.lang.String KEEP_ALIVE_INT_MS

The amount of time (in milliseconds) to wait between sending out Keep-Alive messages. Typically, this feature should be enabled for message receivers. Use 0 to disable Keep-Alives (0 is required before appliance release 4.2).

Default: 3000 (3 seconds)

Possible values: 0 or any value greater than or equal to 50.

See Also:

Constant Field Values

KEEP_ALIVE_LIMIT

public static final java.lang.String KEEP_ALIVE_LIMIT

The maximum number of consecutive Keep-Alive messages that can be sent without receiving a response before the connection is closed by the API.

Default: 3

Possible values: any value greater than or equal to 3.

See Also:

Constant Field Values

APPLICATION_DESCRIPTION

public static final java.lang.String APPLICATION_DESCRIPTION

A string that uniquely describes the application instance.

Default: empty string

See Also:

Constant Field Values

BIND_IP

public static final java.lang.String BIND_IP

(Optional) The hostname or IP address of the machine on which the application is running. On a multihomed machine, it is strongly recommended to provide this parameter to ensure that the API uses the correct network interface at Session connect time.

Default: empty string

See Also:

Constant Field Values

PUB_WINDOW_SIZE

public static final java.lang.String PUB_WINDOW_SIZE

The publisher window size 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, or 0 to disable publishing Guaranteed messages.

Default: 50

Possible values: 1..255, or 0 to disable publishing Guaranteed messages.

See Also:

Constant Field Values

PUB_ACK_TIMER

public static final java.lang.String PUB_ACK_TIMER

The duration of 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. There is no limit on the number of retransmissions for any message. However, while the API is resending, applications can become flow controlled. The flow control behavior is controlled by SessionHandle.PROPERTIES.SEND_BLOCKING and SessionHandle.PROPERTIES.BLOCKING_WRITE_TIMEOUT_MS. The valid range is 20..60000.

Default: 2000 (2 seconds)

Possible values: 20..60000

See Also:

Constant Field Values

VPN_NAME_IN_USE

public static final java.lang.String VPN_NAME_IN_USE

A read-only Session property that indicates which Message VPN the Session is connected to. When not connected, an empty string is returned.

See Also:

Constant Field Values

CLIENT_NAME

public static final java.lang.String CLIENT_NAME

The Session client name that is used during client login to create a unique Session. An empty string causes a unique client name to be generated automatically. If specified, it must be a valid Topic name, and a maximum of 160 bytes in length. The SessionHandle.PROPERTIES.CLIENT_NAME is also used to uniquely identify the sender in a message's senderId field if SessionHandle.PROPERTIES.GENERATE_SENDER_ID is set.

Default: empty string

See Also:

Constant Field Values

SUBSCRIBER_LOCAL_PRIORITY

@Deprecated
public static final java.lang.String SUBSCRIBER_LOCAL_PRIORITY

Deprecated. New applications should use shared subscriptions instead.

Subscriber priorities are used to choose a client to receive messages that are sent with MessageHandle.setDeliverToOne(true). These messages are sent to the subscriber with the highest priority. Subscribers have two priorities; this priority is for messages published locally.

Default: 1

Possible values: 1..4

See Also:

Constant Field Values

SUBSCRIBER_NETWORK_PRIORITY

@Deprecated
public static final java.lang.String SUBSCRIBER_NETWORK_PRIORITY

Deprecated. New applications should use shared subscriptions instead.

Subscriber priorities are used to choose a client to receive messages that are sent with MessageHandle.setDeliverToOne(true). These 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.

Default: 1

Possible values: 1..4

See Also:

Constant Field Values

COMPRESSION_LEVEL

public static final java.lang.String COMPRESSION_LEVEL

Enables messages to be compressed with ZLIB before transmission and decompressed on receive. The valid range is 0 (off) or 1..9, where 1 is less compression (fastest) and 9 is most compression (slowest).

Default: 0 (off)

Possible values: 0..9

See Also:

Constant Field Values

GENERATE_RCV_TIMESTAMPS

public static final java.lang.String GENERATE_RCV_TIMESTAMPS

When enabled, a receive timestamp is recorded for each message and can be retrieved with MessageHandle.getReceiveTimestamp().

Default: DISABLE

Possible values in SolEnum.BooleanValue

See Also:

Constant Field Values

GENERATE_SEND_TIMESTAMPS

public static final java.lang.String GENERATE_SEND_TIMESTAMPS

When enabled, a send timestamp is automatically included (if not already present) in the Solace-defined fields for each message sent.

Default: DISABLE

Possible values in SolEnum.BooleanValue

See Also:

Constant Field Values

GENERATE_SENDER_ID

public static final java.lang.String GENERATE_SENDER_ID

When enabled, a sender ID is automatically included (if not already present) in the Solace-defined fields for each message sent.

Default: DISABLE

Possible values in SolEnum.BooleanValue

See Also:

Constant Field Values

GENERATE_SEQUENCE_NUMBER

public static final java.lang.String GENERATE_SEQUENCE_NUMBER

When enabled, a sequence number is automatically included (if not already present) in the Solace-defined fields for each message sent.

Default: DISABLE

Possible values in SolEnum.BooleanValue

See Also:

Constant Field Values

CONNECT_RETRIES_PER_HOST

public static final java.lang.String CONNECT_RETRIES_PER_HOST

When using a host list, this property defines how many times to try to connect or reconnect to a single host before moving to the next host in the list. A value of 0 (the default) means make a single connection attempt (that is, 0 retries). A value of -1 means attempt an infinite number of reconnect retries (that is, the API will only try to connect or reconnect to first host listed.) NOTE: This property works in conjunction with the connect and reconnect retries Session properties; it does not replace them.

Default: 0. Make a single connection attempt (that is, 0 retries)

See Also:

Constant Field Values

CONNECT_RETRIES

public static final java.lang.String CONNECT_RETRIES

How many times to try to connect to the host appliance (or list of appliances) during connection setup. Zero means no automatic connection retries (that is, try once and give up). -1 means try to connect forever.

When using a host list, each time the API works through the host list without establishing a connection is considered a connect retry. For example, if a SessionHandle.PROPERTIES.CONNECT_RETRIES value of two is used, the API could possibly work through all of the listed hosts without connecting to them three times: one time through for the initial connect attempt, and then two times through for connect retries. Each connect retry begins with the first host listed. After each unsuccessful attempt to connect to a host, the API waits for the amount of time set for SessionHandle.PROPERTIES.RETRY_WAIT_MS before attempting another connection to a host, and the number times to attempt to connect to one host before moving on to the next listed host is determined by the value set for SessionHandle.PROPERTIES.CONNECT_RETRIES_PER_HOST.

Default: 0. Try the host list once then give up.

See Also:

Constant Field Values

RECONNECT_RETRIES

public static final java.lang.String RECONNECT_RETRIES

How many times to retry to reconnect to the host appliance (or list of appliances) after a connected Session goes down. Zero means no automatic reconnection attempts. -1 means try to reconnect forever.

When using a host list, each time the API works through the host list without establishing a connection is considered a reconnect retry. Each reconnect retry begins with the first host listed.

After each unsuccessful attempt to reconnect to a host, the API waits for the amount of time set for SessionHandle.PROPERTIES.RETRY_WAIT_MS before attempting another connection to a host, and the number times to attempt to connect to one host before moving on to the next listed host is determined by the value set for SessionHandle.PROPERTIES.CONNECT_RETRIES_PER_HOST.

Default: 0

See Also:

Constant Field Values

RETRY_WAIT_MS

public static final java.lang.String RETRY_WAIT_MS

How much time (in ms) to wait between each attempt to connect or reconnect to a host. If a connect or reconnect attempt to host is not successful, the API waits for the amount of time set for RETRY_WAIT_MS, and then makes another connect or reconnect attempt. SessionHandle.PROPERTIES.CONNECT_RETRIES_PER_HOST sets how many connection or reconnection attempts can be made before moving on to the next host in the list.

Default: 3000 (3 seconds)

See Also:

Constant Field Values

USER_ID

public static final java.lang.String USER_ID

A read-only informational string providing information about the application, such as the name of operating system user that is running the application, the hostname, and the PID of the application.

See Also:

Constant Field Values

P2PINBOX_IN_USE

public static final java.lang.String P2PINBOX_IN_USE

A read-only informational string that indicates the default reply-to destination that is used when a request message is sent that does not have a reply-to destination specified. See SessionHandle.sendRequest(com.solacesystems.solclientj.core.handle.MessageHandle, com.solacesystems.solclientj.core.handle.MessageHandle, int). This parameter is only valid when the Session is connected.

See Also:

Constant Field Values

REAPPLY_SUBSCRIPTIONS

public static final java.lang.String REAPPLY_SUBSCRIPTIONS

Enable this property to have the API remember subscriptions and reapply them upon a Session reconnect. Reapply subscriptions will only apply direct topic subscriptions upon a Session reconnect. It will not reapply topic subscriptions on durable and non-durable endpoints.

Default: DISABLE

Possible values in SolEnum.BooleanValue

See Also:

Constant Field Values

TOPIC_DISPATCH

public static final java.lang.String TOPIC_DISPATCH

Enable this property to have the API dispatch messages based on Topic (see event.MessageDispatcher)

Default: DISABLE

Possible values in SolEnum.BooleanValue

See Also:

Constant Field Values

PROVISION_TIMEOUT_MS

public static final java.lang.String PROVISION_TIMEOUT_MS

Maximum amount of time (in milliseconds) to wait for a provision command (create or delete an endpoint)

Default: 3000 (3 seconds)

See Also:

Constant Field Values

CALCULATE_MESSAGE_EXPIRATION

public static final java.lang.String CALCULATE_MESSAGE_EXPIRATION

If this property is enabled and time-to-live ( MessageHandle.setTimeToLive(long)) has a positive value in a message, the expiration time is calculated when the message is sent or received and can be retrieved with MessageHandle.getExpiration()

Default: DISABLE

Possible values in SolEnum.BooleanValue

See Also:

Constant Field Values

VIRTUAL_ROUTER_NAME

public static final java.lang.String VIRTUAL_ROUTER_NAME

A read-only property that indicates the connected appliance's virtual router name. Appliance endpoint and destination names created with a virtual router name are valid for use with that appliance, or to address destinations on remote appliances (in a multiple-appliance network) when publishing messages. Applications requiring the virtual router name do not need to poll this property every time it is required, and they may cache the name. Applications should query the name once after connecting the Session, and again after a reconnect operation reports the SolEnum.SessionEventCode.VIRTUAL_ROUTER_NAME_CHANGED event. Prior to connecting, an empty string is returned.

See Also:

Constant Field Values

NO_LOCAL

public static final java.lang.String NO_LOCAL

If this property is enables, messages published on the Session cannot 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 with SolEnum.SubCode.NO_LOCAL_NOT_SUPPORTED .

Default: DISABLE

Possible values in SolEnum.BooleanValue

See Also:

Constant Field Values

AD_PUB_ROUTER_WINDOWED_ACK

public static final java.lang.String AD_PUB_ROUTER_WINDOWED_ACK

When disabled, initiate a window size of 1 to appliance, but do not wait for acknowledgements before transmitting up to the actual window size.

Default: ENABLE - Normal windowed acknowledgement mode.

Possible values in SolEnum.BooleanValue

See Also:

Constant Field Values

MODIFYPROP_TIMEOUT_MS

public static final java.lang.String MODIFYPROP_TIMEOUT_MS

Maximum amount of time (in milliseconds) to wait for session property modification.

Default: 3000 (3 seconds)

See Also:

Constant Field Values

ACK_EVENT_MODE

public static final java.lang.String ACK_EVENT_MODE

This property specifies if the session event SolEnum.SessionEventCode#ACKNOWLEDGEMENT acknowledges a single message (see SolEnum.AckEventMode.PER_MSG) or a range of messages (see SolEnum.AckEventMode.WINDOWED).

Setting this property to SolEnum.AckEventMode.WINDOWED will not affect RejectedMessageError events, they will still be emitted on a per message basis

. Default: SolEnum.AckEventMode.PER_MSG)

Possible values in SolEnum.AckEventMode

See Also:

Constant Field Values

SSL_PROTOCOL

@Deprecated
public static final java.lang.String SSL_PROTOCOL

Deprecated.

This is a deprecated property which specifies a comma separated list of the encryption protocol(s) to use. Use SSL_EXCLUDED_PROTOCOLS to specify a list of protocol(s) to exclude.

Default: "SSLv3"

Possible values in SolEnum.SSLProtocol

See Also:

Constant Field Values

SSL_EXCLUDED_PROTOCOLS

public static final java.lang.String SSL_EXCLUDED_PROTOCOLS

This property specifies a comma separated list of SSL protocol(s) not to use. Allowed SSL protocols in SolEnum.SSLProtocol

See Also:

Constant Field Values

SSL_VALIDATE_CERTIFICATE

public static final java.lang.String SSL_VALIDATE_CERTIFICATE

This property indicates if the certificate validation with certificates in the truststore is enabled.

Default: ENABLE

Possible values in SolEnum.BooleanValue

See Also:

Constant Field Values

SSL_CLIENT_CERTIFICATE_FILE

public static final java.lang.String SSL_CLIENT_CERTIFICATE_FILE

This property specifies the client certificate file name.

Default: empty string

See Also:

Constant Field Values

SSL_CLIENT_PRIVATE_KEY_FILE

public static final java.lang.String SSL_CLIENT_PRIVATE_KEY_FILE

This property specifies the client private key file name.

Default: empty string

See Also:

Constant Field Values

SSL_CLIENT_PRIVATE_KEY_FILE_PASSWORD

public static final java.lang.String SSL_CLIENT_PRIVATE_KEY_FILE_PASSWORD

This property specifies the password used to encrypt the client private key file.

Default: empty string

See Also:

Constant Field Values

AUTHENTICATION_SCHEME

public static final java.lang.String AUTHENTICATION_SCHEME

This property specifies the authentication scheme.

Default: SolEnum.AuthenticationScheme.BASIC

Possible values in SolEnum.AuthenticationScheme

See Also:

Constant Field Values

KRB_SERVICE_NAME

public static final java.lang.String KRB_SERVICE_NAME

This property specifies the first part of Kerberos Service Principal Name (SPN) of the form ServiceName/Hostname\@REALM (for Windows) or Host Based Service of the form ServiceName\@Hostname (for Linux and SunOS).

The Hostname of SPN or Host Based Service is the host portion of an entry specified by the session property SessionHandle.PROPERTIES.HOST. The REALM of the SPN is Kerberos realm.The maximum length of an SPN is 256 characters.

Note: This property is used for all entries specified by the property SessionHandle.PROPERTIES.HOST.

Default: "solace"

See Also:

Constant Field Values

UNBIND_FAIL_ACTION

public static final java.lang.String UNBIND_FAIL_ACTION

A property to define the behavior if an unbind-response is not received after an unbind-request (FlowHandle.destroy()) is sent to the Solace Appliance. If this occurs it is possible that the endpoint may be still bound and unavailable until the session is terminated. In this occurrence the session can be configured to retry sending the unbind-request or to disconnect the session.

Default: SolEnum.UnbindFailAction.RETRY

Possible values in SolEnum.UnbindFailAction

See Also:

Constant Field Values

SSL_VALIDATE_CERTIFICATE_DATE

public static final java.lang.String SSL_VALIDATE_CERTIFICATE_DATE

This property indicates if the session connection should fail when a certificate with an invalid date is received.

This property only applies when SessionHandle.PROPERTIES.SSL_VALIDATE_CERTIFICATE is enabled.

Default: ENABLE

Possible values in SolEnum.BooleanValue

See Also:

Constant Field Values

SSL_VALIDATE_CERTIFICATE_HOST

public static final java.lang.String SSL_VALIDATE_CERTIFICATE_HOST

This property indicates if the sesssion connection should fail when a certificate with an invalid host is received.

When enabled, 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) may be checked against the host string.

This property only applies when SessionHandle.PROPERTIES.SSL_VALIDATE_CERTIFICATE is enabled.

Default: ENABLE Possible values in SolEnum.BooleanValue

See Also:

Constant Field Values

SSL_CIPHER_SUITES

public static final java.lang.String SSL_CIPHER_SUITES

This property specifies a comma separated list of the cipher suites. Allowed cipher suites are:

• ECDHE-RSA-AES256-GCM-SHA384
• ECDHE-RSA-AES256-SHA384
• ECDHE-RSA-AES256-SHA
• AES256-GCM-SHA384
• AES256-SHA256
• AES256-SHA
• ECDHE-RSA-DES-CBC3-SHA
• DES-CBC3-SHA
• ECDHE-RSA-AES128-GCM-SHA256
• ECDHE-RSA-AES128-SHA256
• ECDHE-RSA-AES128-SHA
• AES128-GCM-SHA256
• AES128-SHA256
• AES128-SHA
• RC4-SHA
• RC4-MD5
• TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384
• TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA384
• TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA
• TLS_RSA_WITH_AES_256_GCM_SHA384
• TLS_RSA_WITH_AES_256_CBC_SHA256
• TLS_RSA_WITH_AES_256_CBC_SHA
• TLS_ECDHE_RSA_WITH_3DES_EDE_CBC_SHA
• SSL_RSA_WITH_3DES_EDE_CBC_SHA
• TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256
• TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA256
• TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA
• TLS_RSA_WITH_AES_128_GCM_SHA256
• TLS_RSA_WITH_AES_128_CBC_SHA256
• TLS_RSA_WITH_AES_128_CBC_SHA
• SSL_RSA_WITH_RC4_128_SHA
• SSL_RSA_WITH_RC4_128_MD5

Default: "ECDHE-RSA-AES256-GCM-SHA384,ECDHE-RSA-AES256-SHA384,ECDHE-RSA-AES256-SHA,DHE-RSA-AES256-GCM-SHA384,AES256-SHA256,AES256-SHA,ECDHE-RSA-DES-CBC3-SHA,DES-CBC3-SHA,ECDHE-RSA-AES128-GCM-SHA256,ECDHE-RSA-AES128-SHA256,ECDHE-RSA-AES128-SHA,AES128-GCM-SHA256,AES128-SHA256,AES128-SHA,RC4-SHA,RC4-MD5"

See Also:

Constant Field Values

SSL_TRUST_STORE_DIR

public static final java.lang.String SSL_TRUST_STORE_DIR

This property specifies the directory where the trusted certificates are. The maximum depth for the certificate chain verification that shall be allowed is 3.

Default: empty string

See Also:

Constant Field Values

SSL_TRUSTED_COMMON_NAME_LIST

public static final java.lang.String SSL_TRUSTED_COMMON_NAME_LIST

NOT RECOMMENDED Per RFC-6125 section 6.4.4, the Common Name (CN) of a certificate should not be used to validate the certificate. Instead SessionHandle.PROPERTIES.SSL_VALIDATE_CERTIFICATE_HOST (enabled by default) indicates that the server certificate must contain a Subject Alternate Name (SAN) that matches the host name (SessionHandle.PROPERTIES.HOST).

This property is only used if SessionHandle.PROPERTIES.SSL_VALIDATE_CERTIFICATE_HOST is disabled. This property specifies a comma separated list of acceptable common names in certificate validation. The number of common names specified by an applications is limited to 16. Leading and trailing whitespaces are considered to be part of the common names and are not ignored.If the application does not provide any common names, there is no common name verification.

Default: empty string

See Also:

Constant Field Values

WEB_TRANSPORT_PROTOCOL

public static final java.lang.String WEB_TRANSPORT_PROTOCOL

This property specifies a WEB Transport Protocol in the default WEB Transport Protocol downgrade list to use for the session connection. Valid values are SolEnum.WebTransportProtocol.

If the connection fails, the API will try to connect using the next (less efficient) availabe protocol in the list until it finds one that works. If there is none available, then the session connection fails.

Default: WebTransportProtocol.NULL

See Also:

Constant Field Values

WEB_TRANSPORT_PROTOCOL_IN_USE

public static final java.lang.String WEB_TRANSPORT_PROTOCOL_IN_USE

Read-only property which returns the WEB Transport Protocol curently in use for web messaging. An empty string is returned when a session is not connected or it is not a web messaging session.
Valid values are SolEnum.WebTransportProtocol

See Also:

Constant Field Values

WEB_TRANSPORT_PROTOCOL_LIST

public static final java.lang.String WEB_TRANSPORT_PROTOCOL_LIST

This property specifies a comma separated list of WEB Transport Protocols to use for session connection. The API will use the first one in the list to start session connection. If the connection fails, the API will try to connect using the next available protocol in the list until it finds one that works. If there is none available, then the session connection fails.
Note: Only one of the session properties WEB_TRANSPORT_PROTOCOL and WEB_TRANSPORT_PROTOCOL_LIST is allowed to be configured. There shall be no duplicates in the list.

See Also:

Constant Field Values

TRANSPORT_PROTOCOL_DOWNGRADE_TIMEOUT_MS

public static final java.lang.String TRANSPORT_PROTOCOL_DOWNGRADE_TIMEOUT_MS

Specifies how long to wait (in milliseconds) for a login response before moving to the next available protocol in a user specified or the default WEB Transport Protocol downgradelist.

Default: "3000"

See Also:

Constant Field Values

GUARANTEED_WITH_WEB_TRANSPORT

public static final java.lang.String GUARANTEED_WITH_WEB_TRANSPORT

Enables guaranteed messaging with web transport protocols. Refer to SolEnum.WebTransportProtocol for supported transport protocols. Only has effect when a session is established over a web messaging transport.

Default: DISABLE

Possible values in SolEnum.BooleanValue

See Also:

Constant Field Values

SSL_CONNECTION_DOWNGRADE_TO

public static final java.lang.String SSL_CONNECTION_DOWNGRADE_TO

This property specifies a transport protocol that SSL connection will be downgraded to after client authentication. Allowed transport protocols for SSL downgrade in SolEnum.SSLDowngradeTransportProtocol

See Also:

Constant Field Values

GD_RECONNECT_FAIL_ACTION

public static final java.lang.String GD_RECONNECT_FAIL_ACTION

A property to define the behavior when the CCSMP 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.

May be set as an environment variable. (see Session Properties)

Values: SolEnum.GdReconnectFailAction

Default: GdReconnectFailAction.AUTO_RETRY

See Also:

Constant Field Values

OAUTH2_ACCESS_TOKEN

public static final java.lang.String OAUTH2_ACCESS_TOKEN

The OAUTH2 access token. When authentication scheme AuthenticationScheme.OAUTH2 is used at least one of SessionHandle.PROPERTIES.OAUTH2_ACCESS_TOKEN or SessionHandle.PROPERTIES.OIDC_ID_TOKEN must be set

See Also:

Constant Field Values

OAUTH2_ISSUER_IDENTIFIER

public static final java.lang.String OAUTH2_ISSUER_IDENTIFIER

The optional Issuer identifier URI for OAUTH2 access token based authentication.

See Also:

Constant Field Values

OIDC_ID_TOKEN

public static final java.lang.String OIDC_ID_TOKEN

The OIDC (OpenId Connect) ID Token. When authentication scheme AuthenticationScheme.OAUTH2 is used at least one of SessionHandle.PROPERTIES.OAUTH2_ACCESS_TOKEN or SessionHandle.PROPERTIES.OIDC_ID_TOKEN must be set

See Also:

Constant Field Values

PAYLOAD_COMPRESSION_LEVEL

public static final java.lang.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, brokers currently will discard messages on egress to other protocols such as MQTT, AMQP & HTTP (Kafka too?).

Default: 0 (disabled)

See Also:

Constant Field Values

Constructor Detail

PROPERTIES

public PROPERTIES()