Index (Solace Java RTO Messaging API v10.8.0)

A B C D E F G H I K L M N O P Q R S T U V W X

A

ACCEPTED - Static variable in class com.solacesystems.solclientj.core.SolEnum.MessageOutcome: Represents a successful message processing acknowledgement outcome.
ACCESSTYPE - Static variable in class com.solacesystems.solclientj.core.resource.Endpoint.PROPERTIES: Sets the access type for the endpoint.
ack(long) - Method in interface com.solacesystems.solclientj.core.handle.FlowHandle: Sends an acknowledgement for a message received over this flow.
ack(MessageHandle) - Method in interface com.solacesystems.solclientj.core.handle.FlowHandle: Sends an acknowledgement for a message received over this flow.
ACK_EVENT_MODE - Static variable in class com.solacesystems.solclientj.core.handle.SessionHandle.PROPERTIES: 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).
ACK_THRESHOLD - Static variable in class com.solacesystems.solclientj.core.handle.FlowHandle.PROPERTIES: The threshold for sending an acknowledgement, configured as a percentage.
ACK_TIMEOUT - Static variable in class com.solacesystems.solclientj.core.SolEnum.StatTx: The number of times the acknowledgement timer expired.
ACK_TIMER_MS - Static variable in class com.solacesystems.solclientj.core.handle.FlowHandle.PROPERTIES: The duration of the Flow acknowledgement timer (in milliseconds).
ACKED - Static variable in class com.solacesystems.solclientj.core.SolEnum.StatRx: The number of acknowledgements sent for Guaranteed messages.
AckEventMode() - Constructor for class com.solacesystems.solclientj.core.SolEnum.AckEventMode
ACKMODE - Static variable in class com.solacesystems.solclientj.core.handle.FlowHandle.PROPERTIES: Controls how acknowledgements are generated for received Guaranteed messages.
Possible values in SolEnum.AckMode
Default: SolEnum.AckMode.AUTO
AckMode() - Constructor for class com.solacesystems.solclientj.core.SolEnum.AckMode
ACKNOWLEDGEMENT - Static variable in class com.solacesystems.solclientj.core.SolEnum.SessionEventCode: The oldest transmitted Persistent/Non-Persistent message that has been acknowledged.
ACKS_RXED - Static variable in class com.solacesystems.solclientj.core.SolEnum.StatTx: The number of acknowledgements received.
ACTIVE - Static variable in class com.solacesystems.solclientj.core.SolEnum.FlowEventCode: The flow has become active
ACTIVE_FLOW_IND - Static variable in class com.solacesystems.solclientj.core.handle.FlowHandle.PROPERTIES: When a Flow has the Active Flow Indication property enabled, the application will receive flow events when the flow becomes active, or inactive.
AD_APP_ACK_FAILED_NOT_SUPPORTED - Static variable in class com.solacesystems.solclientj.core.SolEnum.SubCode: SolEnum.MessageOutcome.FAILED and SolEnum.MessageOutcome.REJECTED message settlement outcomes not supported on the Solace Message Router.
AD_PUB_ROUTER_WINDOWED_ACK - Static variable in class com.solacesystems.solclientj.core.handle.SessionHandle.PROPERTIES: When disabled, initiate a window size of 1 to appliance, but do not wait for acknowledgements before transmitting up to the actual window size.
AES128_GCM_SHA256 - Static variable in class com.solacesystems.solclientj.core.SolEnum.SSLCipher
AES128_SHA - Static variable in class com.solacesystems.solclientj.core.SolEnum.SSLCipher
AES128_SHA256 - Static variable in class com.solacesystems.solclientj.core.SolEnum.SSLCipher
AES256_GCM_SHA384 - Static variable in class com.solacesystems.solclientj.core.SolEnum.SSLCipher
AES256_SHA - Static variable in class com.solacesystems.solclientj.core.SolEnum.SSLCipher
AES256_SHA256 - Static variable in class com.solacesystems.solclientj.core.SolEnum.SSLCipher
ALERT - Static variable in class com.solacesystems.solclientj.core.SolEnum.LogLevel: This level is not used by the API.
ALL - Static variable in class com.solacesystems.solclientj.core.SolEnum.LogCategory: ALL is a category that can be used for filters to select all logging cateogries.
ALLOC_CONTAINERS - Static variable in class com.solacesystems.solclientj.core.SolEnum.MessageLevelStat: The number of currently allocated containers (for example, stream or map).
ALLOC_DATA_BLOCKS - Static variable in class com.solacesystems.solclientj.core.SolEnum.QuantaLevelStat: The number of allocated data blocks (of specified quanta size).
ALLOC_MEMORY - Static variable in class com.solacesystems.solclientj.core.SolEnum.MessageLevelStat: Approximate amount of allocated memory (in-use; not on free list)
ALLOC_MSGS - Static variable in class com.solacesystems.solclientj.core.SolEnum.MessageLevelStat: The number of currently allocated messages
Allocator() - Constructor for class com.solacesystems.solclientj.core.Solclient.Allocator
ALREADY_CUT_THROUGH - Static variable in class com.solacesystems.solclientj.core.SolEnum.StatRx: Deprecated - Not Supported - On a cut-through Flow, the number of Guaranteed messages discarded because they had already been received on the cut-through Flow.
APP - Static variable in class com.solacesystems.solclientj.core.SolEnum.LogCategory: The APP category is not used by JavaRTO
APPLICATION_DESCRIPTION - Static variable in class com.solacesystems.solclientj.core.handle.SessionHandle.PROPERTIES: A string that uniquely describes the application instance.
ASSURED_DELIVERY_DOWN - Static variable in class com.solacesystems.solclientj.core.SolEnum.SessionEventCode: Guaranteed Delivery publishing is not available.
ASSURED_MESSAGING_NOT_ESTABLISHED - Static variable in class com.solacesystems.solclientj.core.SolEnum.SubCode: A send call was made to send a Guaranteed message before Guaranteed Delivery is established (Deprecated).
ASSURED_MESSAGING_STATE_ERROR - Static variable in class com.solacesystems.solclientj.core.SolEnum.SubCode: An attempt was made to start Guaranteed Delivery when it is already started.
AUTHENTICATION_SCHEME - Static variable in class com.solacesystems.solclientj.core.handle.SessionHandle.PROPERTIES: This property specifies the authentication scheme.
AuthenticationScheme() - Constructor for class com.solacesystems.solclientj.core.SolEnum.AuthenticationScheme
AUTO - Static variable in class com.solacesystems.solclientj.core.SolEnum.AckMode: Automatic application acknowledgement of all received messages.
AUTO_RETRY - Static variable in class com.solacesystems.solclientj.core.SolEnum.GdReconnectFailAction: Clear the publisher state and reconnect the publisher flow.

B

BASIC - Static variable in class com.solacesystems.solclientj.core.SolEnum.AuthenticationScheme: use basic (username/password) authentication
BASIC_AUTHENTICATION_IS_SHUTDOWN - Static variable in class com.solacesystems.solclientj.core.SolEnum.SubCode: The client attempted to connect to an Appliance that has the basic authentication shutdown.
BEGINNING - Static variable in class com.solacesystems.solclientj.core.SolEnum.ReplayStartLocation: Replay all messages in the replay log
BIND_BLOCKING - Static variable in class com.solacesystems.solclientj.core.handle.FlowHandle.PROPERTIES: This property controls whether or not to block in SessionHandle#createFlowForHandle.
Possible values in SolEnum.BooleanValue
Default: SolEnum.BooleanValue#ENABLE
BIND_FAILED_ERROR - Static variable in class com.solacesystems.solclientj.core.SolEnum.FlowEventCode: The Flow attempted to connect but was unsuccessful.
BIND_IP - Static variable in class com.solacesystems.solclientj.core.handle.SessionHandle.PROPERTIES: (Optional) The hostname or IP address of the machine on which the application is running.
BIND_TIMEOUT_MS - Static variable in class com.solacesystems.solclientj.core.handle.FlowHandle.PROPERTIES: The timeout (in milliseconds) used when creating a Flow in blocking mode.
BLOCK_WHILE_CONNECTING - Static variable in class com.solacesystems.solclientj.core.handle.SessionHandle.PROPERTIES: 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.
BLOCKED_ON_SEND - Static variable in class com.solacesystems.solclientj.core.SolEnum.StatTx: The number of times Session blocked on socket full (blocking only) occurred.
BLOCKING_WRITE_TIMEOUT_MS - Static variable in class com.solacesystems.solclientj.core.handle.SessionHandle.PROPERTIES: The timeout period (in milliseconds) for blocking write operation.
BooleanValue() - Constructor for class com.solacesystems.solclientj.core.SolEnum.BooleanValue
BRIEF - Static variable in class com.solacesystems.solclientj.core.SolEnum.MessageDumpMode: Display only the length of the binary attachment, XML attachment, and user property map.
BROWSER - Static variable in class com.solacesystems.solclientj.core.handle.FlowHandle.PROPERTIES: Set browser mode on flow and signal it is a browser flow to appliance on bind.
BROWSING_NOT_SUPPORTED_ON_PARTITIONED_QUEUE - Static variable in class com.solacesystems.solclientj.core.SolEnum.SubCode: The client attempted to use a browser flow on a partitioned queue.
BUFFER_SIZE - Static variable in class com.solacesystems.solclientj.core.handle.SessionHandle.PROPERTIES: The maximum amount of messages to buffer (in bytes) when the TCP session is flow controlled.

C

CACHE_ALREADY_IN_PROGRESS - Static variable in class com.solacesystems.solclientj.core.SolEnum.SubCode: A cache request has been made when there is already a cache request outstanding on the same Topic and SolEnum.CacheLiveDataAction.FLOWTHRU was not set.
CACHE_ERROR_RESPONSE - Static variable in class com.solacesystems.solclientj.core.SolEnum.SubCode: The cache instance has returned an error response to the request.
CACHE_INVALID_MESSAGE - Static variable in class com.solacesystems.solclientj.core.SolEnum.MessageCacheStatus: Message Handle is invalid
CACHE_INVALID_SESSION - Static variable in class com.solacesystems.solclientj.core.SolEnum.SubCode: The cache session operation failed because the Session has been destroyed.
CACHE_LIVE_MESSAGE - Static variable in class com.solacesystems.solclientj.core.SolEnum.MessageCacheStatus: The message was received from the message bus diretly and is not part of a cache response.
CACHE_LIVEDATA_FULFILL - Static variable in class com.solacesystems.solclientj.core.SolEnum.SubCode: The cache session operation completed when live data arrived on the Topic requested.
CACHE_MESSAGE - Static variable in class com.solacesystems.solclientj.core.SolEnum.MessageCacheStatus: The message was received as part of a good cache response.
CACHE_NAME - Static variable in class com.solacesystems.solclientj.core.handle.CacheSessionHandle.PROPERTIES: The identifier for the Distributed Cache to send cache requests to.
CACHE_NO_DATA - Static variable in class com.solacesystems.solclientj.core.SolEnum.SubCode: When the cache request returns SolEnum.ReturnCode.INCOMPLETE, this SubCode indicates there is no cached data in the designated cache.
CACHE_REQUEST_CANCELLED - Static variable in class com.solacesystems.solclientj.core.SolEnum.SubCode: The cache request has been cancelled by the client.
CACHE_SUSPECT_DATA - Static variable in class com.solacesystems.solclientj.core.SolEnum.SubCode: When the designated cache responds to a cache request with suspect data the API returns SolEnum.ReturnCode.INCOMPLETE with this SubCode.
CACHE_SUSPECT_MESSAGE - Static variable in class com.solacesystems.solclientj.core.SolEnum.MessageCacheStatus: The message was received as part of a suspect cache response.
CACHE_TIMEOUT - Static variable in class com.solacesystems.solclientj.core.SolEnum.SubCode: The cache session operation failed because the request timeout expired.
CacheLiveDataAction() - Constructor for class com.solacesystems.solclientj.core.SolEnum.CacheLiveDataAction
CACHEMSG - Static variable in class com.solacesystems.solclientj.core.SolEnum.StatRx: Cached messages delivered to application.
CacheRequest() - Constructor for class com.solacesystems.solclientj.core.SolEnum.CacheRequest
CACHEREQUEST_DISCARD_RESPONSE - Static variable in class com.solacesystems.solclientj.core.SolEnum.StatRx: Cache request response discarded due to errors in response format or no outstanding cache request.
CACHEREQUEST_ERROR_RESPONSE - Static variable in class com.solacesystems.solclientj.core.SolEnum.StatRx: Cache requests failed due to solCache error response.
CACHEREQUEST_FULFILL_DATA - Static variable in class com.solacesystems.solclientj.core.SolEnum.StatRx: Cache requests fulfilled by live data.
CACHEREQUEST_OK_RESPONSE - Static variable in class com.solacesystems.solclientj.core.SolEnum.StatRx: Cache requests completed OK.
CACHEREQUEST_SENT - Static variable in class com.solacesystems.solclientj.core.SolEnum.StatTx: The cache requests sent.
CacheRequestEventCode() - Constructor for class com.solacesystems.solclientj.core.SolEnum.CacheRequestEventCode
CacheSessionEvent - Interface in com.solacesystems.solclientj.core.event: An object with the CacheSessionEvent interface is returned by CacheSessionHandle.getCacheSessionEvent().
CacheSessionEventCallback - Interface in com.solacesystems.solclientj.core.event: The cacheSession event callback is called by the API for asynchronous cache requests (see NO_WAIT_REPLY in CacheRequest Options).
CacheSessionHandle - Interface in com.solacesystems.solclientj.core.handle: The CacheSessionHandle interface allows applications to send messages to a Solace Cache Cluster.
CacheSessionHandle.PROPERTIES - Class in com.solacesystems.solclientj.core.handle: Defines the property names used to create a Session handle
CALCULATE_MESSAGE_EXPIRATION - Static variable in class com.solacesystems.solclientj.core.handle.SessionHandle.PROPERTIES: 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()
CAN_SEND - Static variable in class com.solacesystems.solclientj.core.SolEnum.SessionEventCode: The send is no longer blocked.
cancelCacheRequests() - Method in interface com.solacesystems.solclientj.core.handle.CacheSessionHandle: Cancel all in progress cache requests for a given cache session.
CANNOT_BIND_TO_QUEUE - Static variable in class com.solacesystems.solclientj.core.SolEnum.SubCode: Already bound to the queue, or not authorized to bind to the queue.
CANNOT_BLOCK_IN_CONTEXT - Static variable in class com.solacesystems.solclientj.core.SolEnum.SubCode: An API function was invoked in the Context thread that would have blocked otherwise.
CANNOT_MODIFY_WHILE_NOT_IDLE - Static variable in class com.solacesystems.solclientj.core.SolEnum.SubCode: An attempt was made to modify a property that cannot be modified while Session is not idle.
CAPABILITY_ACTIVE_FLOW_INDICATION - Static variable in class com.solacesystems.solclientj.core.SolEnum.CapabilityName
CAPABILITY_AD_APP_ACK_FAILED - Static variable in class com.solacesystems.solclientj.core.SolEnum.CapabilityName
CAPABILITY_BROWSER - Static variable in class com.solacesystems.solclientj.core.SolEnum.CapabilityName
CAPABILITY_COMPRESSED_SSL - Static variable in class com.solacesystems.solclientj.core.SolEnum.CapabilityName
CAPABILITY_COMPRESSION - Static variable in class com.solacesystems.solclientj.core.SolEnum.CapabilityName
CAPABILITY_ENDPOINT_DISCARD_BEHAVIOR - Static variable in class com.solacesystems.solclientj.core.SolEnum.CapabilityName
CAPABILITY_ENDPOINT_MANAGEMENT - Static variable in class com.solacesystems.solclientj.core.SolEnum.CapabilityName
CAPABILITY_ENDPOINT_MESSAGE_TTL - Static variable in class com.solacesystems.solclientj.core.SolEnum.CapabilityName
CAPABILITY_JNDI - Static variable in class com.solacesystems.solclientj.core.SolEnum.CapabilityName
CAPABILITY_LONG_SELECTORS - Static variable in class com.solacesystems.solclientj.core.SolEnum.CapabilityName
CAPABILITY_MAX_DIRECT_MSG_SIZE - Static variable in class com.solacesystems.solclientj.core.SolEnum.CapabilityName
CAPABILITY_MAX_GUARANTEED_MSG_SIZE - Static variable in class com.solacesystems.solclientj.core.SolEnum.CapabilityName
CAPABILITY_MESSAGE_ELIDING - Static variable in class com.solacesystems.solclientj.core.SolEnum.CapabilityName
CAPABILITY_MESSAGE_REPLAY - Static variable in class com.solacesystems.solclientj.core.SolEnum.CapabilityName
CAPABILITY_NO_LOCAL - Static variable in class com.solacesystems.solclientj.core.SolEnum.CapabilityName
CAPABILITY_PER_TOPIC_SEQUENCE_NUMBERING - Static variable in class com.solacesystems.solclientj.core.SolEnum.CapabilityName
CAPABILITY_PUB_GUARANTEED - Static variable in class com.solacesystems.solclientj.core.SolEnum.CapabilityName
CAPABILITY_QUEUE_SUBSCRIPTIONS - Static variable in class com.solacesystems.solclientj.core.SolEnum.CapabilityName
CAPABILITY_SELECTOR - Static variable in class com.solacesystems.solclientj.core.SolEnum.CapabilityName
CAPABILITY_SHARED_SUBSCRIPTIONS - Static variable in class com.solacesystems.solclientj.core.SolEnum.CapabilityName
CAPABILITY_SUB_FLOW_GUARANTEED - Static variable in class com.solacesystems.solclientj.core.SolEnum.CapabilityName
CAPABILITY_SUBSCRIPTION_MANAGER - Static variable in class com.solacesystems.solclientj.core.SolEnum.CapabilityName
CAPABILITY_SUPPORTS_XPE_SUBSCRIPTIONS - Static variable in class com.solacesystems.solclientj.core.SolEnum.CapabilityName
CAPABILITY_TEMP_ENDPOINT - Static variable in class com.solacesystems.solclientj.core.SolEnum.CapabilityName
CAPABILITY_TRANSACTED_SESSION - Static variable in class com.solacesystems.solclientj.core.SolEnum.CapabilityName
CapabilityName() - Constructor for class com.solacesystems.solclientj.core.SolEnum.CapabilityName
CERTIFICATE_DATE_INVALID - Static variable in class com.solacesystems.solclientj.core.SolEnum.SubCode: The client attempted to connect to an Appliance that does not have a valid certificate date.
clearStats() - Method in interface com.solacesystems.solclientj.core.handle.StatsSupport: Clears statistics
CLIENT - Static variable in class com.solacesystems.solclientj.core.SolEnum.AckMode: Client must call solClient_flow_sendAck() to acknowledge the Message contained in the MessageHandle
CLIENT_ACL_DENIED - Static variable in class com.solacesystems.solclientj.core.SolEnum.SubCode: The client login to the Appliance was denied because the IP address/netmask combination used for the client is designated in the ACL (Access Control List) as a deny connection for the given Message VPN and username.
CLIENT_CERTIFICATE - Static variable in class com.solacesystems.solclientj.core.SolEnum.AuthenticationScheme: Client provides a signed certificate for authentication
CLIENT_CERTIFICATE_AUTHENTICATION_IS_SHUTDOWN - Static variable in class com.solacesystems.solclientj.core.SolEnum.SubCode: The client attempted to connect to an Appliance that has the client certificate authentication shutdown.
CLIENT_CERTIFICATE_DATE_INVALID - Static variable in class com.solacesystems.solclientj.core.SolEnum.SubCode: The client failed to connect to an Appliance as it does not have a valid client certificate date.
CLIENT_DELETE_IN_PROGRESS - Static variable in class com.solacesystems.solclientj.core.SolEnum.SubCode: The client login not currently possible as previous instance of same client still being deleted.
CLIENT_INITIATED_REPLAY_BROWSER_FLOW_NOT_ALLOWED - Static variable in class com.solacesystems.solclientj.core.SolEnum.SubCode: The client attempted to bind with both FlowHandle.PROPERTIES.BROWSER enabled and FlowHandle.PROPERTIES.REPLAY_START_LOCATION set.
CLIENT_INITIATED_REPLAY_INACTIVE_FLOW_NOT_ALLOWED - Static variable in class com.solacesystems.solclientj.core.SolEnum.SubCode: The client attempted to start replay on an inactive flow.
CLIENT_INITIATED_REPLAY_NON_EXCLUSIVE_NOT_ALLOWED - Static variable in class com.solacesystems.solclientj.core.SolEnum.SubCode: The client attempted to start replay on a flow bound to a non-exclusive endpoint.
CLIENT_NAME - Static variable in class com.solacesystems.solclientj.core.handle.SessionHandle.PROPERTIES: The Session client name that is used during client login to create a unique Session.
CLIENT_NAME_ALREADY_IN_USE - Static variable in class com.solacesystems.solclientj.core.SolEnum.SubCode: The Session is attempting to use a client, publisher name, or subscriber name that is in use by another client, publisher, or subscriber, and the Appliance is configured to reject the new Session.
CLIENT_NAME_INVALID - Static variable in class com.solacesystems.solclientj.core.SolEnum.SubCode: The client name chosen has been rejected as invalid by the Appliance.
CLIENT_USERNAME_IS_SHUTDOWN - Static variable in class com.solacesystems.solclientj.core.SolEnum.SubCode: The username for the client is administratively shutdown on the Appliance.
ClientName - Interface in com.solacesystems.solclientj.core.resource: ClientName is an Endpoint for Subscribe and Unsubscribe Requests
com.solacesystems.solclientj.core - package com.solacesystems.solclientj.core: Entry point into the Solace Java RTO Messaging API (Solclient).
com.solacesystems.solclientj.core.event - package com.solacesystems.solclientj.core.event: Messaging API Event and Callback Interfaces
com.solacesystems.solclientj.core.handle - package com.solacesystems.solclientj.core.handle: Handles for wrapping the various concepts managed in the messaging API.
com.solacesystems.solclientj.core.resource - package com.solacesystems.solclientj.core.resource: Interface definitions for key messaging objects.
commit() - Method in interface com.solacesystems.solclientj.core.handle.TransactedSessionHandle: Commit the active transaction of a specified Transacted Session.
COMMIT_OR_ROLLBACK_IN_PROGRESS - Static variable in class com.solacesystems.solclientj.core.SolEnum.SubCode: The client attempted to send/receive a message or commit/rollback a transaction when a transaction commit/rollback is in progress.
COMMIT_STATUS_UNKNOWN - Static variable in class com.solacesystems.solclientj.core.SolEnum.SubCode: The commit response was lost due to a transport layer reconnection to an alternate host in the host list.
COMMUNICATION_ERROR - Static variable in class com.solacesystems.solclientj.core.SolEnum.SubCode: An API call failed due to a communication error.
compare(ReplicationGroupMessageIdHandle) - Method in interface com.solacesystems.solclientj.core.handle.ReplicationGroupMessageIdHandle: Compares this instance of the ReplicationGroupMessageIdHandle object with the passed in other ReplicationGroupMessageIdHandle object.
COMPRESSED_BYTES - Static variable in class com.solacesystems.solclientj.core.SolEnum.StatRx: The number of bytes received before decompression.
COMPRESSED_BYTES - Static variable in class com.solacesystems.solclientj.core.SolEnum.StatTx: The number of bytes transmitted after compression.
COMPRESSED_SSL_NOT_SUPPORTED - Static variable in class com.solacesystems.solclientj.core.SolEnum.SubCode: The client attempted to establish a Session or Flow with ssl and compression, but the capability is not supported by the appliance.
COMPRESSION_LEVEL - Static variable in class com.solacesystems.solclientj.core.handle.SessionHandle.PROPERTIES: Enables messages to be compressed with ZLIB before transmission and decompressed on receive.
connect() - Method in interface com.solacesystems.solclientj.core.handle.SessionHandle: Connects the session.
CONNECT_BLOCKING - Static variable in class com.solacesystems.solclientj.core.handle.SessionHandle.PROPERTIES: A blocking connect operation suspends until the Session is successfully connected, including restoring all remembered subscriptions if REAPPLY_SUBSCRIPTIONS is enabled.
CONNECT_FAILED_ERROR - Static variable in class com.solacesystems.solclientj.core.SolEnum.SessionEventCode: The Session attempted to connect but was unsuccessful.
CONNECT_RETRIES - Static variable in class com.solacesystems.solclientj.core.handle.SessionHandle.PROPERTIES: How many times to try to connect to the host appliance (or list of appliances) during connection setup.
CONNECT_RETRIES_PER_HOST - Static variable in class com.solacesystems.solclientj.core.handle.SessionHandle.PROPERTIES: 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.
CONNECT_TIMEOUT_MS - Static variable in class com.solacesystems.solclientj.core.handle.SessionHandle.PROPERTIES: The timeout period (in milliseconds) for a connect operation to a given host (per host).
CONSUME - Static variable in class com.solacesystems.solclientj.core.SolEnum.EndpointPermission: Consumer permission, other clients may read and consume messages.
CONTAINER_BUSY - Static variable in class com.solacesystems.solclientj.core.SolEnum.SubCode: An attempt was made to add a field to a map or stream while a sub map or stream is being built.
CONTEXT_PROPERTIES() - Constructor for class com.solacesystems.solclientj.core.handle.IPCSupport.CONTEXT_PROPERTIES
ContextHandle - Interface in com.solacesystems.solclientj.core.handle: The ContextHandle interface represents a processing context in which session instances are created.
CONTROL_OTHER - Static variable in class com.solacesystems.solclientj.core.SolEnum.SubCode: The Appliance rejected a control message for another reason not separately enumerated.
COS_1 - Static variable in class com.solacesystems.solclientj.core.SolEnum.UserCos: The lowest class of service value.
COS_2 - Static variable in class com.solacesystems.solclientj.core.SolEnum.UserCos: The middle class of service value.
COS_3 - Static variable in class com.solacesystems.solclientj.core.SolEnum.UserCos: The highest class of service value.
CREATE_MESSAGE_DISPATCHER - Static variable in class com.solacesystems.solclientj.core.handle.TransactedSessionHandle.PROPERTIES: When this property is enabled, a TransactedSession-bound Message Dispatcher is lazily created for asynchronous message delivery within a Transacted Session.
createCacheSessionForHandle(CacheSessionHandle, String[], CacheSessionEventCallback) - Method in interface com.solacesystems.solclientj.core.handle.SessionHandle: Creates a CacheSessionHandle instance
createContextForHandle(ContextHandle, String[]) - Static method in class com.solacesystems.solclientj.core.Solclient: Allocates a new Context which will be bound to a given unbound ContextHandle.
createFlowForHandle(FlowHandle, String[], Endpoint, Subscription, MessageCallback, FlowEventCallback) - Method in interface com.solacesystems.solclientj.core.handle.SessionHandle: Allocates a new flow instance which will be bound to an unbound FlowHandle within a specified Session.
createFlowForHandle(FlowHandle, String[], Endpoint, Subscription, MessageCallback, FlowEventCallback) - Method in interface com.solacesystems.solclientj.core.handle.TransactedSessionHandle: Create a transacted consumer Flow within a specified Transacted Session.
createMessageForHandle(MessageHandle) - Static method in class com.solacesystems.solclientj.core.Solclient: Allocate a new message that can be used for storing and sending messages to and from the Solace Messaging Appliance.
The allocated message will be bound to a given unbound MessageHandle
Applications are responsible for releasing all messages allocated by this method, by calling MessageHandle.destroy()
createNativeDestinationForHandle(NativeDestinationHandle, Destination) - Static method in class com.solacesystems.solclientj.core.Solclient: Allocates a NativeDestination resource for the given Destination and binds it to an unbound NativeDestinationHandle.
createNewMessageAndHandle() - Static method in class com.solacesystems.solclientj.core.Solclient: A convenience factory method that produces a MessageHandle with an newly allocated message in the handle.
createNonDurableTopicEndpoint() - Method in interface com.solacesystems.solclientj.core.handle.SessionHandle: Creates a non-durable Topic Endpoint (with auto generated name).
createNonDurableTopicEndpoint(String[]) - Method in interface com.solacesystems.solclientj.core.handle.SessionHandle: Creates a non-durable Topic Endpoint (with auto generated name).
createNonDurableTopicEndpoint(String) - Method in interface com.solacesystems.solclientj.core.handle.SessionHandle: Creates a non-durable Topic Endpoint with the given name.
createNonDurableTopicEndpoint(String, String[]) - Method in interface com.solacesystems.solclientj.core.handle.SessionHandle: Creates a non-durable Topic Endpoint with the given name.
createReplicationGroupMessageIdForHandle(ReplicationGroupMessageIdHandle, String) - Static method in class com.solacesystems.solclientj.core.Solclient: Allocates a new ReplicationGroupMessageId resource using the serialized ReplicationGroupMessageId String and binds it to an unbound ReplicationGroupMessageIdHandle.
createSessionForHandle(SessionHandle, String[], MessageCallback, SessionEventCallback) - Method in interface com.solacesystems.solclientj.core.handle.ContextHandle: Allocates a new session instance which will be bound to an unbound SessionHandle within a specified Context.
createTemporaryQueue() - Method in interface com.solacesystems.solclientj.core.handle.SessionHandle: Creates a temporary Queue for this session.
createTemporaryQueue(String[]) - Method in interface com.solacesystems.solclientj.core.handle.SessionHandle: Creates a temporary Queue for this session.
createTemporaryQueue(String) - Method in interface com.solacesystems.solclientj.core.handle.SessionHandle: Creates a temporary Queue for this session with a given name.
createTemporaryQueue(String, String[]) - Method in interface com.solacesystems.solclientj.core.handle.SessionHandle: Creates a temporary Queue for this session with a given name.
createTemporaryTopic() - Method in interface com.solacesystems.solclientj.core.handle.SessionHandle: Creates a temporary Topic for this session (with auto generated name).
createTransactedSessionForHandle(TransactedSessionHandle, String[]) - Method in interface com.solacesystems.solclientj.core.handle.SessionHandle: Creates a transacted session on the given Session instance.
CRITICAL - Static variable in class com.solacesystems.solclientj.core.SolEnum.LogLevel: A serious error that can make the API unusable.
CRYPTO_LIB - Static variable in class com.solacesystems.solclientj.core.Solclient.GLOBAL_PROPERTIES: The Cryptography library name, this library contains ciphers and algorithms used by Solclient.GLOBAL_PROPERTIES.SSL_LIB.
Default: Operating System dependent: Linux - "libcrypto.so" Windows - "libeay32.dll" MacOSX - "libcrypto.dylib"
CTL_BYTES - Static variable in class com.solacesystems.solclientj.core.SolEnum.StatRx: The number of bytes received in control (non-data) messages.
CTL_BYTES - Static variable in class com.solacesystems.solclientj.core.SolEnum.StatTx: The number of bytes transmitted in control (non-data) messages.
CTL_MSGS - Static variable in class com.solacesystems.solclientj.core.SolEnum.StatRx: The number of control (non-data) messages received.
CTL_MSGS - Static variable in class com.solacesystems.solclientj.core.SolEnum.StatTx: The number of control (non-data) messages transmitted.

D

DATA_OTHER - Static variable in class com.solacesystems.solclientj.core.SolEnum.SubCode: The Appliance rejected a data message for another reason not separately enumerated.
DBLOCK_ALREADY_EXISTS - Static variable in class com.solacesystems.solclientj.core.SolEnum.SubCode: An attempt was made to allocate a datablock for a msg element when one already exists.
DBQUANTASIZE_0 - Static variable in class com.solacesystems.solclientj.core.Solclient.GLOBAL_PROPERTIES: The size (in bytes) of data buffers in the pool of smallest buffers.
DBQUANTASIZE_1 - Static variable in class com.solacesystems.solclientj.core.Solclient.GLOBAL_PROPERTIES: The size (in bytes) of data buffers in the second pool of buffers.
DBQUANTASIZE_2 - Static variable in class com.solacesystems.solclientj.core.Solclient.GLOBAL_PROPERTIES: The size (in bytes) of data buffers in the third pool of buffers.
DBQUANTASIZE_3 - Static variable in class com.solacesystems.solclientj.core.Solclient.GLOBAL_PROPERTIES: The size (in bytes) of data buffers in the fourth pool of buffers.
DBQUANTASIZE_4 - Static variable in class com.solacesystems.solclientj.core.Solclient.GLOBAL_PROPERTIES: The size (in bytes) of data buffers in the fifth (last) pool of buffers.
DEBUG - Static variable in class com.solacesystems.solclientj.core.SolEnum.LogLevel: Debugging information generally useful to API developers (very verbose).
DELETE - Static variable in class com.solacesystems.solclientj.core.SolEnum.EndpointPermission: Delete permission, other clients may read and consume messages, modify the Topic on a Topic Endpoint, and delete the endpoint.
deleteApplicationMessageId() - Method in interface com.solacesystems.solclientj.core.handle.MessageHandle: Deletes the previously set Application Message Id
deleteApplicationMessageType() - Method in interface com.solacesystems.solclientj.core.handle.MessageHandle: Deletes the previously set Application Message Type
deleteCorrelationId() - Method in interface com.solacesystems.solclientj.core.handle.MessageHandle: Deletes the previously set Correlation Id
deleteHttpContentEncoding() - Method in interface com.solacesystems.solclientj.core.handle.MessageHandle: Deletes the previously set HTTP Content Encoding
deleteHttpContentType() - Method in interface com.solacesystems.solclientj.core.handle.MessageHandle: Deletes the previously set HTTP Content Type
deleteQueuePartitionKey() - Method in interface com.solacesystems.solclientj.core.handle.MessageHandle: This method allows the application to delete the queue partition key for the message.
deleteSenderId() - Method in interface com.solacesystems.solclientj.core.handle.MessageHandle: Deletes the previously set senderId
deleteSenderTimestamp() - Method in interface com.solacesystems.solclientj.core.handle.MessageHandle: Deletes a previously set Sender Timestamp
deleteSequenceNumber() - Method in interface com.solacesystems.solclientj.core.handle.MessageHandle: Deletes a previously set Sequence Number
DELIVER_TO_ONE_INVALID - Static variable in class com.solacesystems.solclientj.core.SolEnum.SubCode: Deprecated.
New applications should use shared subscriptions instead.
DELIVERY_COUNT_NOT_SUPPORTED - Static variable in class com.solacesystems.solclientj.core.SolEnum.SubCode: The message was received from endpoint that does not support delivery count
DELIVERY_MODE_UNSUPPORTED - Static variable in class com.solacesystems.solclientj.core.SolEnum.SubCode: Attempt was made from a Transacted Session to send a message with the delivery mode SolEnum.MessageDeliveryMode.DIRECT.
deprovision(Endpoint, int, long) - Method in interface com.solacesystems.solclientj.core.handle.SessionHandle: Deprovisions or removes a durable TopicEndpoint or Queue from the Appliance.
DES_CBC3_SHA - Static variable in class com.solacesystems.solclientj.core.SolEnum.SSLCipher
Destination - Interface in com.solacesystems.solclientj.core.resource: The Destination interface exists for objects that publishers can set as targets.
destroy() - Method in interface com.solacesystems.solclientj.core.handle.Handle: This method will destroy the native object associated with this Handle instance.
destroy() - Method in interface com.solacesystems.solclientj.core.handle.MessageDispatchTargetHandle: This method will destroy the the message dispatch associated with this instance.
destroy() - Method in interface com.solacesystems.solclientj.core.handle.MutableMessageDispatchTargetHandle: This method will destroy the the message dispatch associated with this instance.
DIRECT - Static variable in class com.solacesystems.solclientj.core.SolEnum.MessageDeliveryMode: Direct message.
DIRECT_BYTES - Static variable in class com.solacesystems.solclientj.core.SolEnum.StatRx: The number of bytes received.
DIRECT_BYTES - Static variable in class com.solacesystems.solclientj.core.SolEnum.StatTx: The number of bytes transmitted in Direct messages.
DIRECT_MSGS - Static variable in class com.solacesystems.solclientj.core.SolEnum.StatRx: The number of messages received.
DIRECT_MSGS - Static variable in class com.solacesystems.solclientj.core.SolEnum.StatTx: The number of Direct messages transmitted.
DISABLE - Static variable in class com.solacesystems.solclientj.core.SolEnum.BooleanValue: Property is disabled.
DISCARD_BEHAVIOR - Static variable in class com.solacesystems.solclientj.core.resource.Endpoint.PROPERTIES: When a message cannot be added to an endpoint (for example, maximum quota (Endpoint.PROPERTIES.QUOTA_MB) exceeded), this property controls the action the appliance will perform towards the publisher.
DISCARD_CHANNEL_ERROR - Static variable in class com.solacesystems.solclientj.core.SolEnum.StatTx: Messages discarded due to channel failure
DISCARD_DUPLICATE - Static variable in class com.solacesystems.solclientj.core.SolEnum.StatRx: The number of Guaranteed messages dropped for being duplicates.
DISCARD_FROM_CTSYNC - Static variable in class com.solacesystems.solclientj.core.SolEnum.StatRx: Deprecated - Not Supported - On a cut-through Flow, the number of messages discarded from the synchronization list other than those discarded due to overflow.
DISCARD_IND - Static variable in class com.solacesystems.solclientj.core.SolEnum.StatRx: The number of receive messages with discard indication set.
DISCARD_MSG_FLOW_UNBOUND_PENDING - Static variable in class com.solacesystems.solclientj.core.SolEnum.StatRx: On a transacted flow, the number of messages discarded because the flow is in a UNBOUND pending state.
DISCARD_MSG_TOO_BIG - Static variable in class com.solacesystems.solclientj.core.SolEnum.StatRx: The number of messages discarded due to msg too large.
DISCARD_MSG_TRANSACTION_ROLLBACK - Static variable in class com.solacesystems.solclientj.core.SolEnum.StatRx: On a transacted flow, the number of messages discarded after a transaction rollback and becomes a message comes in with prevMsgId=0.
DISCARD_NO_MATCH - Static variable in class com.solacesystems.solclientj.core.SolEnum.StatTx: When the IPC add-on is in use, the counter of messages discarded due to no subscription match with connected peers
DISCARD_NO_MATCHING_FLOW - Static variable in class com.solacesystems.solclientj.core.SolEnum.StatRx: The number of Guaranteed messages discarded due to no match on the flowId.
DISCARD_OUTOFORDER - Static variable in class com.solacesystems.solclientj.core.SolEnum.StatRx: The number of Guaranteed messages discarded for being received out of order.
DISCARD_SMF_UNKNOWN_ELEMENT - Static variable in class com.solacesystems.solclientj.core.SolEnum.StatRx: The number of messages discarded due to the presence of an unknown element or unknown protocol in the Solace Message Format (SMF) header.
DISCARD_TRANSACTION_RESPONSE - Static variable in class com.solacesystems.solclientj.core.SolEnum.StatRx: On a transacted session, the number of transaction responses discarded due to reconnection.
disconnect() - Method in interface com.solacesystems.solclientj.core.handle.SessionHandle: Disconnects the session.
DISCONNECT - Static variable in class com.solacesystems.solclientj.core.SolEnum.GdReconnectFailAction: Disconnect the session, even if RECONNECT_RETRIES is configured to a non-zero value.
DISCONNECT - Static variable in class com.solacesystems.solclientj.core.SolEnum.UnbindFailAction: disconnect the session, the application must call SessionHandle.connect()
DOWN_ERROR - Static variable in class com.solacesystems.solclientj.core.SolEnum.FlowEventCode: The Flow was established and then disconnected by the Appliance, likely due to operator intervention.
DOWN_ERROR - Static variable in class com.solacesystems.solclientj.core.SolEnum.SessionEventCode: The Session was established and then went down.
dump(int) - Method in interface com.solacesystems.solclientj.core.handle.MessageHandle: Display the contents of a message in human-readable form.
dump(int, int) - Method in interface com.solacesystems.solclientj.core.handle.MessageHandle: Display the contents of a message in human-readable form.
DYNAMIC_CLIENTS_NOT_ALLOWED - Static variable in class com.solacesystems.solclientj.core.SolEnum.SubCode: The username for the Session has not been set and dynamic clients are not allowed.

E

ECDHE_RSA_AES128_GCM_SHA256 - Static variable in class com.solacesystems.solclientj.core.SolEnum.SSLCipher
ECDHE_RSA_AES128_SHA - Static variable in class com.solacesystems.solclientj.core.SolEnum.SSLCipher
ECDHE_RSA_AES128_SHA256 - Static variable in class com.solacesystems.solclientj.core.SolEnum.SSLCipher
ECDHE_RSA_AES256_GCM_SHA384 - Static variable in class com.solacesystems.solclientj.core.SolEnum.SSLCipher
ECDHE_RSA_AES256_SHA - Static variable in class com.solacesystems.solclientj.core.SolEnum.SSLCipher
ECDHE_RSA_AES256_SHA384 - Static variable in class com.solacesystems.solclientj.core.SolEnum.SSLCipher
ECDHE_RSA_DES_CBC3_SHA - Static variable in class com.solacesystems.solclientj.core.SolEnum.SSLCipher
EMERGENCY - Static variable in class com.solacesystems.solclientj.core.SolEnum.LogLevel: This level is not used by the API.
ENABLE - Static variable in class com.solacesystems.solclientj.core.SolEnum.BooleanValue: Property is enabled.
Endpoint - Interface in com.solacesystems.solclientj.core.resource: The Endpoint interface provides a Java representation of an endpoint description.
Endpoint.PROPERTIES - Class in com.solacesystems.solclientj.core.resource: Defines properties used in endpoint provisioning (explicit and implicit provisioning)
ENDPOINT_ALREADY_EXISTS - Static variable in class com.solacesystems.solclientj.core.SolEnum.SubCode: An attempt was made to create a Queue or Topic Endpoint that already exists.
ENDPOINT_MODIFIED - Static variable in class com.solacesystems.solclientj.core.SolEnum.SubCode: The client attempted to commit a transaction with an Endpoint being shutdown or deleted.
ENDPOINT_PROPERTY_MISMATCH - Static variable in class com.solacesystems.solclientj.core.SolEnum.SubCode: An attempt was made to create a dynamic durable endpoint and it was found to exist with different properties.
EndpointAccessType() - Constructor for class com.solacesystems.solclientj.core.SolEnum.EndpointAccessType
EndpointDiscardBehavior() - Constructor for class com.solacesystems.solclientj.core.SolEnum.EndpointDiscardBehavior
EndpointPermission() - Constructor for class com.solacesystems.solclientj.core.SolEnum.EndpointPermission
EOS - Static variable in class com.solacesystems.solclientj.core.SolEnum.ReturnCode: A get next operation on structured container returned End-of-Stream.
ERROR - Static variable in class com.solacesystems.solclientj.core.SolEnum.LogLevel: An unexpected condition within the API that can affect its operation.
Event - Interface in com.solacesystems.solclientj.core.event: An object with the Event interface has access to the underlying Native SDK ResponseCode and information string.
EXCLUSIVE - Static variable in class com.solacesystems.solclientj.core.SolEnum.EndpointAccessType: An exclusive Queue.

F

FAIL - Static variable in class com.solacesystems.solclientj.core.SolEnum.ReturnCode: The API call failed.
FAILED - Static variable in class com.solacesystems.solclientj.core.SolEnum.MessageOutcome: Represents a negative acknowledgement outcome, used to signal that the application failed to process the message.
FAILED_LOADING_CERTIFICATE_AND_KEY - Static variable in class com.solacesystems.solclientj.core.SolEnum.SubCode: The client failed to load certificate and/or private key files.
FAILED_LOADING_TRUSTSTORE - Static variable in class com.solacesystems.solclientj.core.SolEnum.SubCode: The client failed to load the trust store.
FLOW_ACTIVE_FLOW_INDICATION_UNSUPPORTED - Static variable in class com.solacesystems.solclientj.core.SolEnum.SubCode: The client attempted to establish a Flow with Active Flow Indication ( FlowHandle.PROPERTIES.ACTIVE_FLOW_IND) enabled and the capability is not supported by the appliance.
FLOW_UNBOUND - Static variable in class com.solacesystems.solclientj.core.SolEnum.SubCode: The client attempted to receive message from an UNBOUND Flow with no queued messages in memory.
FlowEvent - Interface in com.solacesystems.solclientj.core.event: An object with the FlowEvent interface is returned by FlowHandle.getFlowEvent().
FlowEventCallback - Interface in com.solacesystems.solclientj.core.event: The callback interface for Flow events.
FlowEventCode() - Constructor for class com.solacesystems.solclientj.core.SolEnum.FlowEventCode
FlowHandle - Interface in com.solacesystems.solclientj.core.handle: The FlowHandle interface allows applications to receive messages and events on a flow.
FlowHandle.PROPERTIES - Class in com.solacesystems.solclientj.core.handle: Defines the property names used to configure a Flow handle
FLOWTHRU - Static variable in class com.solacesystems.solclientj.core.SolEnum.CacheLiveDataAction: The cache request completes when the cache response is returned.
FOUND_CTSYNC - Static variable in class com.solacesystems.solclientj.core.SolEnum.StatRx: Deprecated - Not Supported - On a cut-through Flow, the number of times the Flow entered cut-through delivery mode.
FREE_CONTAINERS - Static variable in class com.solacesystems.solclientj.core.SolEnum.MessageLevelStat: The number of containers (streams or maps) on container free list.
FREE_DATA_BLOCKS - Static variable in class com.solacesystems.solclientj.core.SolEnum.QuantaLevelStat: The number of free data blocks (of specified quanta size from 0 to SolEnum.QuantaLevelStat.NUM_MSG_QUANTA - 1)
FREE_MSGS - Static variable in class com.solacesystems.solclientj.core.SolEnum.MessageLevelStat: The number of messages on message free list
FULFILL - Static variable in class com.solacesystems.solclientj.core.SolEnum.CacheLiveDataAction: The cache request completes when the cache response is returned or when live data that matches the cache request topic arrives, whichever happens first.
FULL - Static variable in class com.solacesystems.solclientj.core.SolEnum.MessageDumpMode: Display the entire message.

G

GD_RECONNECT_FAIL_ACTION - Static variable in class com.solacesystems.solclientj.core.handle.SessionHandle.PROPERTIES: A property to define the behavior when the CCSMP API is unable to reconnect guaranteed delivery after reconnecting the session.
GdReconnectFailAction() - Constructor for class com.solacesystems.solclientj.core.SolEnum.GdReconnectFailAction
GENERATE_RCV_TIMESTAMPS - Static variable in class com.solacesystems.solclientj.core.handle.SessionHandle.PROPERTIES: When enabled, a receive timestamp is recorded for each message and can be retrieved with MessageHandle.getReceiveTimestamp().
GENERATE_SEND_TIMESTAMPS - Static variable in class com.solacesystems.solclientj.core.handle.SessionHandle.PROPERTIES: When enabled, a send timestamp is automatically included (if not already present) in the Solace-defined fields for each message sent.
GENERATE_SENDER_ID - Static variable in class com.solacesystems.solclientj.core.handle.SessionHandle.PROPERTIES: When enabled, a sender ID is automatically included (if not already present) in the Solace-defined fields for each message sent.
GENERATE_SEQUENCE_NUMBER - Static variable in class com.solacesystems.solclientj.core.handle.SessionHandle.PROPERTIES: When enabled, a sequence number is automatically included (if not already present) in the Solace-defined fields for each message sent.
getAckImmediately() - Method in interface com.solacesystems.solclientj.core.handle.MessageHandle: Returns the ACK Immediately message property.
getApplicationMessageId() - Method in interface com.solacesystems.solclientj.core.handle.MessageHandle: This method allows the application to retrieve the string that is the ApplicationMessageId.
getApplicationMessageType() - Method in interface com.solacesystems.solclientj.core.handle.MessageHandle: This method allows the application to retrieve the String that is the ApplicationMessageType.
getAsBytes(ByteBuffer) - Method in interface com.solacesystems.solclientj.core.resource.ClientName: Relative put method on byteBuffer.
getBinaryAttachment(ByteBuffer) - Method in interface com.solacesystems.solclientj.core.handle.MessageHandle: Retrieve the contents of the binary attachment part into a given ByteBuffer.
getBinaryAttachmentSize() - Method in interface com.solacesystems.solclientj.core.handle.MessageHandle: Retrieve the size of the Binary Attachment
getBuildDate() - Method in interface com.solacesystems.solclientj.core.Version
getCacheRequestId(MutableLong) - Method in interface com.solacesystems.solclientj.core.handle.MessageHandle: If a received message contains a message returned from SolCache due to a previously issued cache request ( CacheSessionHandle.sendCacheRequest), then the received message will also contain the cache requestId set by the application in the cache request.
getCacheSessionEvent() - Method in interface com.solacesystems.solclientj.core.handle.CacheSessionHandle: This method returns a CacheSessionEvent instance in the context of CacheSessionEventCallback.onCacheSessionEvent(CacheSessionHandle)
getCacheStatus() - Method in interface com.solacesystems.solclientj.core.handle.MessageHandle
getCapability(String) - Method in interface com.solacesystems.solclientj.core.handle.SessionHandle: Returns the value of a given CapabilityName on the given session
getClientName() - Method in interface com.solacesystems.solclientj.core.handle.SessionHandle: Returns the ClientName reflecting the currently assigned client name by the Appliance.
getCorrelationId() - Method in interface com.solacesystems.solclientj.core.handle.MessageHandle: This method allows the application to retrieve the string that is the CorrelationId.
getCorrelationKey() - Method in interface com.solacesystems.solclientj.core.event.SessionEvent: The correlation key passed in SessionHandle methods.
getCorrelationKey(MutableLong) - Method in interface com.solacesystems.solclientj.core.handle.MessageHandle: Fetch the CorrelationKey into a MutableLong if available.
getDeliverToOne() - Method in interface com.solacesystems.solclientj.core.handle.MessageHandle: Deprecated.
New applications should use shared subscriptions instead.
getDeliveryCount() - Method in interface com.solacesystems.solclientj.core.handle.MessageHandle: Get message delivery count
getDestination() - Method in interface com.solacesystems.solclientj.core.handle.FlowHandle: Returns the Destination to which messages should be published to get to this flow's bound Endpoint.
getDestination() - Method in interface com.solacesystems.solclientj.core.handle.MessageHandle: Get the Destination field (queue or topic), which is the destination this message was published to.
getDestination(MutableTopic) - Method in interface com.solacesystems.solclientj.core.handle.MessageHandle: Get the Destination field (mutable topic), which is the destination this message was published to.
getDestinationTopicSuffix(SessionHandle) - Method in interface com.solacesystems.solclientj.core.handle.MessageHandle: This method returns the suffix of the topic string.
getDiscardIndication() - Method in interface com.solacesystems.solclientj.core.handle.MessageHandle: Test the discard indication status.
getDMQEligible() - Method in interface com.solacesystems.solclientj.core.handle.MessageHandle: Test the Dead Message Queue (DMQ) eligible property.
getElidingEligible() - Method in interface com.solacesystems.solclientj.core.handle.MessageHandle: Test the ElidingEligible attribute.
getEnumCacheRequestEventCode() - Method in interface com.solacesystems.solclientj.core.event.CacheSessionEvent
getEnumCount() - Static method in class com.solacesystems.solclientj.core.SolEnum.CapabilityName: Counts how many enums are present
getEnumCount() - Static method in class com.solacesystems.solclientj.core.SolEnum.StatRx: Counts how many Receive statistics are available.
getEnumCount() - Static method in class com.solacesystems.solclientj.core.SolEnum.StatTx: Counts how many Transmit statistics are available.
getErrorStr() - Method in class com.solacesystems.solclientj.core.SolclientErrorInfo: An information error string for certain types of subcodes (an empty string if not used).
getExpiration() - Method in interface com.solacesystems.solclientj.core.handle.MessageHandle: Return the Message Expiration timestamp.
getFlowEvent() - Method in interface com.solacesystems.solclientj.core.handle.FlowHandle: This method returns a FlowEvent instance in the context of FlowEventCallback.onEvent().
getFlowEventEnum() - Method in interface com.solacesystems.solclientj.core.event.FlowEvent
getGuaranteedMessageId() - Method in interface com.solacesystems.solclientj.core.handle.MessageHandle: The Guaranteed MessageId is a identifier in each received message on a FlowHanlde.
getHttpContentEncoding() - Method in interface com.solacesystems.solclientj.core.handle.MessageHandle
getHttpContentType() - Method in interface com.solacesystems.solclientj.core.handle.MessageHandle
getInfo() - Method in interface com.solacesystems.solclientj.core.event.Event: An optional string that provides further information about the event.
getLastErrorInfo() - Static method in class com.solacesystems.solclientj.core.Solclient: Returns a SolclientErrorInfo instance, which contains the last captured error information for the calling thread.
getMessage() - Method in exception com.solacesystems.solclientj.core.SolclientException: Returns a formatted error message with the numerical and string representation of the SolEnum.ReturnCode
Details of the SolclientErrorInfo may be ommited in the message if none was available.
getMessageCallback() - Method in interface com.solacesystems.solclientj.core.handle.MessageDispatchTargetHandle
getMessageDeliveryMode() - Method in interface com.solacesystems.solclientj.core.handle.MessageHandle
getMessageLevelStat(int) - Static method in class com.solacesystems.solclientj.core.Solclient: Returns the value of the specified message statistic.
getName() - Method in interface com.solacesystems.solclientj.core.resource.Destination
getName() - Method in interface com.solacesystems.solclientj.core.resource.Endpoint: The name of the Endpoint.
getNameBuffer() - Method in interface com.solacesystems.solclientj.core.resource.MutableTopic: Retrieves the reference of the nameBuffer in order to allow applications to modify contents of the nameBuffer directly.
getNativeBuildDate() - Method in interface com.solacesystems.solclientj.core.Version
getNativeVariant() - Method in interface com.solacesystems.solclientj.core.Version
getNativeVersion() - Method in interface com.solacesystems.solclientj.core.Version
getPriority() - Method in interface com.solacesystems.solclientj.core.handle.MessageHandle: Get message priority.
getProperty(String) - Method in interface com.solacesystems.solclientj.core.handle.FlowHandle: Gets the value of the specified Flow property for the Flow.
getProperty(String) - Method in interface com.solacesystems.solclientj.core.handle.SessionHandle: Returns the property value for a given session property
getQuantaLevelStat(int, int) - Static method in class com.solacesystems.solclientj.core.Solclient: Returns the quanta level statistic for the given quantaIdx
getQueuePartitionKey() - Method in interface com.solacesystems.solclientj.core.handle.MessageHandle: This method allows the application to retrieve the queue partition key for the message.
getReceiveTimestamp() - Method in interface com.solacesystems.solclientj.core.handle.MessageHandle: Gets the receive timestamp (in milliseconds, from midnight, January 1, 1970 UTC).
getReplicationGroupMessageIdForHandle(ReplicationGroupMessageIdHandle) - Method in interface com.solacesystems.solclientj.core.handle.MessageHandle: Sets the Replication Group Message Id (ReplicationGroupMessageId) of the message into the passed in ReplicationGroupMessageIdHandle.
getReplyTo() - Method in interface com.solacesystems.solclientj.core.handle.MessageHandle
getReplyTo(MutableTopic) - Method in interface com.solacesystems.solclientj.core.handle.MessageHandle
getRequestId() - Method in interface com.solacesystems.solclientj.core.event.CacheSessionEvent
getResponseCode() - Method in interface com.solacesystems.solclientj.core.event.Event: A response code returned by the appliance for some events; otherwise zero.
getResponseCode() - Method in class com.solacesystems.solclientj.core.SolclientErrorInfo: A response code that is returned by the Appliance for some SolEnum.SubCode otherwise zero.
getReturnCode() - Method in interface com.solacesystems.solclientj.core.event.CacheSessionEvent
getReturnCode() - Method in exception com.solacesystems.solclientj.core.SolclientException: Returns the SolEnum.ReturnCode at the time of the exception.
getRxMessage() - Method in interface com.solacesystems.solclientj.core.handle.MessageSupport: This method returns a MessageHandle reference valid only in the context of the of MessageCallback.onMessage().
getRxStats(long[]) - Method in interface com.solacesystems.solclientj.core.handle.StatsSupport: Fill out all the available Receive statisticss in the given long[] array
The array needs to be long enough (SolEnum.StatRx.getEnumCount()) to fit all the values shown in SolEnum.StatRx
getSenderId() - Method in interface com.solacesystems.solclientj.core.handle.MessageHandle: This method allows the application to retrieve the string that is the SenderID.
getSenderTimestamp(MutableLong) - Method in interface com.solacesystems.solclientj.core.handle.MessageHandle
getSequenceNumber(MutableLong) - Method in interface com.solacesystems.solclientj.core.handle.MessageHandle: Get message sequence number into the MutableLong parameter.
getSession() - Method in interface com.solacesystems.solclientj.core.handle.FlowHandle: Returns the SessionHandle associated with this flow
getSession() - Method in interface com.solacesystems.solclientj.core.handle.TransactedSessionHandle: Returns the associated SessionHandle
getSessionEvent() - Method in interface com.solacesystems.solclientj.core.handle.SessionHandle: This method returns a SessionEvent instance in the context of SessionEventCallback.onEvent().
getSessionEventCode() - Method in interface com.solacesystems.solclientj.core.event.SessionEvent
getSessionName() - Method in interface com.solacesystems.solclientj.core.handle.TransactedSessionHandle
getSolclientErrorInfo() - Method in exception com.solacesystems.solclientj.core.SolclientException: Returns the available SolclientErrorInfo when the exception was raised.
getSubCode() - Method in interface com.solacesystems.solclientj.core.event.CacheSessionEvent
getSubCode() - Method in class com.solacesystems.solclientj.core.SolclientErrorInfo
getSubscription() - Method in interface com.solacesystems.solclientj.core.handle.MessageDispatchTargetHandle
getTimeToLive() - Method in interface com.solacesystems.solclientj.core.handle.MessageHandle: get the Time To Live (TTL) from a message.
getTransactedSession() - Method in interface com.solacesystems.solclientj.core.handle.FlowHandle: Returns the TransactedSessionHandle.
getTxStats(long[]) - Method in interface com.solacesystems.solclientj.core.handle.StatsSupport: Fill out all the available Transmit statistics in the given long[] array
The array needs to be long enough (SolEnum.StatTx.getEnumCount()) to fit all the values shown in SolEnum.StatTx
getUserCos() - Method in interface com.solacesystems.solclientj.core.handle.MessageHandle: Get the Class of Service from a message.
getUserData(ByteBuffer) - Method in interface com.solacesystems.solclientj.core.handle.MessageHandle: Copies the User Data header bytes into the userDataBuffer.
getValue() - Method in class com.solacesystems.solclientj.core.handle.MutableInteger
getValue() - Method in class com.solacesystems.solclientj.core.handle.MutableLong
getVersion() - Static method in class com.solacesystems.solclientj.core.Solclient: Returns the Java RTO Version information
getVersion() - Method in interface com.solacesystems.solclientj.core.Version
GLOBAL_PROPERTIES() - Constructor for class com.solacesystems.solclientj.core.Solclient.GLOBAL_PROPERTIES
GSS_KRB - Static variable in class com.solacesystems.solclientj.core.SolEnum.AuthenticationScheme: Client is authenticated by Kerberos and an authentication token exists.
GSS_KRB_LIB - Static variable in class com.solacesystems.solclientj.core.Solclient.GLOBAL_PROPERTIES: The GSS Kerberos library name.
Default: Operating System dependent: Linux - "libgssapi_krb5.so.2" Windows - "secur32.dll"
GUARANTEED_MSGS_SENT_CONFIRMED - Static variable in class com.solacesystems.solclientj.core.SolEnum.StatTx: Guaranteed messages (Persistent/Non-Persistent) published that have been acknowledged.
GUARANTEED_WITH_WEB_TRANSPORT - Static variable in class com.solacesystems.solclientj.core.handle.SessionHandle.PROPERTIES: Enables guaranteed messaging with web transport protocols.

H

Handle - Interface in com.solacesystems.solclientj.core.handle: Abstraction of a native object.
HAS_PUBLISHER - Static variable in class com.solacesystems.solclientj.core.handle.TransactedSessionHandle.PROPERTIES: When this property is enabled, a publisher flow is created when a Transacted Session is created successfully.
HOST - Static variable in class com.solacesystems.solclientj.core.handle.SessionHandle.PROPERTIES: The IPv4 or IPv6 address or host name to connect to.
HTTP_BINARY - Static variable in class com.solacesystems.solclientj.core.SolEnum.WebTransportProtocol: Binary-encoded, responses are received in COMET style
HTTP_BINARY_STREAMING - Static variable in class com.solacesystems.solclientj.core.SolEnum.WebTransportProtocol: Binary encoded, responses are received in streaming mode for higher efficiency

I

IGNORE_DUP_SUBSCRIPTION_ERROR - Static variable in class com.solacesystems.solclientj.core.handle.SessionHandle.PROPERTIES: Enable this property to ignore errors for duplicate subscription/topic on subscribe or subscription not found errors on unsubscribe.
IGNORE_EXIST_ERRORS - Static variable in class com.solacesystems.solclientj.core.SolEnum.ProvisionFlags: An error will not be raised during provisioning if the requested endpoint already exists.
IN_PROGRESS - Static variable in class com.solacesystems.solclientj.core.SolEnum.ReturnCode: The API call is in progress (non-blocking mode).
INACTIVE - Static variable in class com.solacesystems.solclientj.core.SolEnum.FlowEventCode: The flow has become inactive
INCOMPLETE - Static variable in class com.solacesystems.solclientj.core.SolEnum.ReturnCode: The API call completed some, but not all, of the requested function.
INFO - Static variable in class com.solacesystems.solclientj.core.SolEnum.LogLevel: Informational messages about the normal operation of the API.
init(String[]) - Static method in class com.solacesystems.solclientj.core.Solclient: Initializes the Messaging APIs.
This function must be called before any other API interface call is made, with the exception of Solclient.setLogLevel(), which can be called first to set the Log level.
INIT_NOT_CALLED - Static variable in class com.solacesystems.solclientj.core.SolEnum.SubCode: An API call failed due to solClient_initialize() not being called first.
INSUFFICIENT_SPACE - Static variable in class com.solacesystems.solclientj.core.SolEnum.SubCode: An API call failed due to insufficient space to accept more data.
INTERNAL_ERROR - Static variable in class com.solacesystems.solclientj.core.SolEnum.SubCode: An API call had an internal error (not an application fault).
INVALID_CONNECTION_OWNER - Static variable in class com.solacesystems.solclientj.core.SolEnum.SubCode: The client attempted to commit a transaction with an unknown connection ID.
INVALID_DATA_CONVERSION - Static variable in class com.solacesystems.solclientj.core.SolEnum.SubCode: An attempt was made to retrieve structured data with wrong type.
INVALID_DURABILITY - Static variable in class com.solacesystems.solclientj.core.SolEnum.SubCode: The client has attempted to bind a flow to a durable queue or topic endpoint with SOLCLIENT_FLOW_PROP_BIND_ENTITY_DURABLE disabled.
INVALID_FLOW_OPERATION - Static variable in class com.solacesystems.solclientj.core.SolEnum.SubCode: An API call failed due to the attempted operation not being valid for the Flow.
INVALID_SELECTOR - Static variable in class com.solacesystems.solclientj.core.SolEnum.SubCode: An attempt was made to bind to a Queue or Topic Endpoint with an invalid selector.
INVALID_SESSION_OPERATION - Static variable in class com.solacesystems.solclientj.core.SolEnum.SubCode: An API call failed due to the attempted operation not being valid for the Session.
INVALID_SMF_MESSAGE - Static variable in class com.solacesystems.solclientj.core.SolEnum.SubCode: Unused by JavaRTO
INVALID_TOPIC_NAME_FOR_TE - Static variable in class com.solacesystems.solclientj.core.SolEnum.SubCode: An attempt was made to bind to a Topic Endpoint with an invalid topic.
INVALID_TOPIC_SYNTAX - Static variable in class com.solacesystems.solclientj.core.SolEnum.SubCode: An attempt was made to use a Topic that has a syntax which is not supported.
INVALID_TRANSACTED_SESSION_ID - Static variable in class com.solacesystems.solclientj.core.SolEnum.SubCode: The client attempted to commit or rollback a transaction with an invalid Transacted Session Id.
INVALID_TRANSACTION_ID - Static variable in class com.solacesystems.solclientj.core.SolEnum.SubCode: The client attempted to commit or rollback a transaction with an invalid transaction Id.
INVALID_VIRTUAL_ADDRESS - Static variable in class com.solacesystems.solclientj.core.SolEnum.SubCode: An attempt was made to connect to the wrong IP address on the Appliance (must use CVRID if configured) or the Appliance CVRID has changed and this was detected on reconnect.
IPC_SHM_SPIN - Static variable in class com.solacesystems.solclientj.core.handle.IPCSupport.CONTEXT_PROPERTIES: Use -1 to hard spin, and >= 0 to spin that many times before blocking.
IPC_SHM_THREAD_AFFINITY - Static variable in class com.solacesystems.solclientj.core.handle.IPCSupport.CONTEXT_PROPERTIES: The desired affinity mask for the Context IPC shared memory thread.
IPC_SHM_THREAD_AFFINITY_CPU_LIST - Static variable in class com.solacesystems.solclientj.core.handle.IPCSupport.CONTEXT_PROPERTIES: The desired thread affinity CPU list for the Context IPC shared memory thread.
IPCSupport - Interface in com.solacesystems.solclientj.core.handle: Inter-Process Communications
IPCSupport.CONTEXT_PROPERTIES - Class in com.solacesystems.solclientj.core.handle: Defines property names that support IPC settings for a ContextHandle, these settings are used to create a Context Solclient.createContextForHandle()
IPCSupport.SESSION_PROPERTIES - Class in com.solacesystems.solclientj.core.handle: Defines property names that support IPC settings for a SessionHandle, these settings can be combined with SessionHandle.PROPERTIES and used to create a Session (ContextHandle.createSessionForHandle())
isBound() - Method in interface com.solacesystems.solclientj.core.handle.Handle: Returns true if this Handle object is bound to native object.
isCapable(String) - Method in interface com.solacesystems.solclientj.core.handle.SessionHandle: Checks if the specified capability type is set on the given session
isDurable() - Method in interface com.solacesystems.solclientj.core.resource.Endpoint: When false, the endpoint's life span is dependent on the flow that creates the endpoint.
isInitialized() - Static method in class com.solacesystems.solclientj.core.Solclient: Returns a boolean indicating if Messaging APIs has been initialized.
isInitilized() - Static method in class com.solacesystems.solclientj.core.Solclient: Deprecated.
use Solclient.isInitialized() instead.
isLocalDispatchOnly() - Method in interface com.solacesystems.solclientj.core.handle.MessageDispatchTargetHandle: The Local Dispatch Only attribute can be set on MessageDispatchTargetHandle when the object is created.
isRedelivered() - Method in interface com.solacesystems.solclientj.core.handle.MessageHandle: Applies only when SolEnum.MessageDeliveryMode is SolEnum.MessageDeliveryMode.PERSISTENT or SolEnum.MessageDeliveryMode.NONPERSISTENT.
isReplyMessage() - Method in interface com.solacesystems.solclientj.core.handle.MessageHandle
isTemporary() - Method in interface com.solacesystems.solclientj.core.resource.Destination
isValid() - Method in interface com.solacesystems.solclientj.core.handle.ReplicationGroupMessageIdHandle: Validates if the ReplicationGroupMessageIdHandle object is valid.

K

KEEP_ALIVE_FAILURE - Static variable in class com.solacesystems.solclientj.core.SolEnum.SubCode: The Session Keep-Alive detected a failed Session.
KEEP_ALIVE_INT_MS - Static variable in class com.solacesystems.solclientj.core.handle.SessionHandle.PROPERTIES: The amount of time (in milliseconds) to wait between sending out Keep-Alive messages.
KEEP_ALIVE_LIMIT - Static variable in class com.solacesystems.solclientj.core.handle.SessionHandle.PROPERTIES: The maximum number of consecutive Keep-Alive messages that can be sent without receiving a response before the connection is closed by the API.
KERBEROS_AUTHENTICATION_IS_SHUTDOWN - Static variable in class com.solacesystems.solclientj.core.SolEnum.SubCode: The client attempted to connect to an Appliance that has the Kerberos authentication shutdown.
KRB_SERVICE_NAME - Static variable in class com.solacesystems.solclientj.core.handle.SessionHandle.PROPERTIES: 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).

L

LIBRARY_NOT_LOADED - Static variable in class com.solacesystems.solclientj.core.SolEnum.SubCode: The client failed to find the library or symbol.
LogCategory() - Constructor for class com.solacesystems.solclientj.core.SolEnum.LogCategory
LOGIN_FAILURE - Static variable in class com.solacesystems.solclientj.core.SolEnum.SubCode: The client could not log into the Appliance (bad username or password).
LogLevel() - Constructor for class com.solacesystems.solclientj.core.SolEnum.LogLevel
LOST_CTSYNC - Static variable in class com.solacesystems.solclientj.core.SolEnum.StatRx: Deprecated - Not Supported - On a cut-through Flow, the number of times the Flow left cut-through delivery mode to resynchronize with the Guaranteed message storage on the broker
LOST_CTSYNC_GM - Static variable in class com.solacesystems.solclientj.core.SolEnum.StatRx: Deprecated - Not Supported - On a cut-through Flow, the number of times the Flow left cut-through delivery mode to resynchronize with the Guaranteed message storage due to receiving a Guaranteed message that was not previously received as Direct.
LOW_PRIORITY_MSG_CONGESTION - Static variable in class com.solacesystems.solclientj.core.SolEnum.SubCode: The message was rejected by the Appliance as one or more matching endpoints exceeded the reject-low-priority-msg-limit.

M

MAX_AGE - Static variable in class com.solacesystems.solclientj.core.handle.CacheSessionHandle.PROPERTIES: The oldest message (in seconds) to retrieve from the cache.
MAX_BIND_TRIES - Static variable in class com.solacesystems.solclientj.core.handle.FlowHandle.PROPERTIES: When creating a non-blocking Flow, or a Flow that is bound due to Session-connect, the maximum number of bind attempts to make.
MAX_CLIENT_NAME_SIZE - Static variable in class com.solacesystems.solclientj.core.SolEnum.SolConstants: The maximum size allowed for a Client Name (not including the terminating NULL).
MAX_CLIENTS_FOR_QUEUE - Static variable in class com.solacesystems.solclientj.core.SolEnum.SubCode: An attempt was made to bind to a Queue that already has a maximum number of clients.
MAX_CLIENTS_FOR_TE - Static variable in class com.solacesystems.solclientj.core.SolEnum.SubCode: An attempt was made to bind to a Topic Endpoint that already has a maximum number of clients.
MAX_MESSAGE_USAGE_EXCEEDED - Static variable in class com.solacesystems.solclientj.core.SolEnum.SubCode: Publishing of message denied because the maximum spooled message count was exceeded.
MAX_MSGS - Static variable in class com.solacesystems.solclientj.core.handle.CacheSessionHandle.PROPERTIES: The maximum number of messages to retrieve from the cache for any one Topic.
MAX_RECONNECT_TRIES - Static variable in class com.solacesystems.solclientj.core.handle.FlowHandle.PROPERTIES: When a connected flow receives an unsolicited unbind event with subcode REPLAY_STARTED or GM_UNAVAILABLE, the SDK can reconnect the flow automatically.
MAX_TOPIC_SIZE - Static variable in class com.solacesystems.solclientj.core.SolEnum.SolConstants: The maximum size allowed for the topic (not including the terminating NULL).
MAX_TOTAL_MSGSIZE_EXCEEDED - Static variable in class com.solacesystems.solclientj.core.SolEnum.SubCode: An attempt was made to send a message with a total size greater than that supported by the protocol.
MAX_TRANSACTED_SESSIONS_EXCEEDED - Static variable in class com.solacesystems.solclientj.core.SolEnum.SubCode: The client failed to open a Transacted Session as it exceeded the max Transacted Sessions.
MAX_TRANSACTIONS_EXCEEDED - Static variable in class com.solacesystems.solclientj.core.SolEnum.SubCode: The client failed to open a Transacted Session as the maximum number of transactions was exceeded.
MAX_UNACKED_MESSAGES - Static variable in class com.solacesystems.solclientj.core.handle.FlowHandle.PROPERTIES: This property may only be set when the Flow property FlowHandle.PROPERTIES.ACKMODE is set to SolEnum.AckMode.CLIENT.
MAXMSG_REDELIVERY - Static variable in class com.solacesystems.solclientj.core.resource.Endpoint.PROPERTIES: Defines how many message redelivery retries before discarding or moving the message to the DMQ.
MAXMSG_SIZE - Static variable in class com.solacesystems.solclientj.core.resource.Endpoint.PROPERTIES: Maximum size (in bytes) for any one message stored in the endpoint.
MAXPOOLMEM - Static variable in class com.solacesystems.solclientj.core.Solclient.GLOBAL_PROPERTIES: The maximum amount of memory (in bytes) the API can save in its data and message pools.
Once it reaches this size, data blocks are released back to the heap and are not kept in a API pool.
The valid range is > 0.
Default: 1073741824 (1 GB)
MESSAGE_CONSUME_FAILURE - Static variable in class com.solacesystems.solclientj.core.SolEnum.SubCode: The client attempted to commit a transaction with a consume failure encountered.
MESSAGE_ID_NOT_COMPARABLE - Static variable in class com.solacesystems.solclientj.core.SolEnum.SubCode: Replication Group Message Id are not comparable.
MESSAGE_PUBLISH_FAILURE - Static variable in class com.solacesystems.solclientj.core.SolEnum.SubCode: The client attempted to commit a transaction with a GD publish failure encountered.
MESSAGE_TOO_LARGE - Static variable in class com.solacesystems.solclientj.core.SolEnum.SubCode: The client attempted to send a message larger than that supported by the Appliance.
MessageCacheStatus() - Constructor for class com.solacesystems.solclientj.core.SolEnum.MessageCacheStatus
MessageCallback - Interface in com.solacesystems.solclientj.core.event: The callback interface for receiving messages.
MessageDeliveryMode() - Constructor for class com.solacesystems.solclientj.core.SolEnum.MessageDeliveryMode
MessageDispatcher - Interface in com.solacesystems.solclientj.core.event: Interface to add a per topic MessageCallback to a SessionHandle or FlowHandle
MessageDispatchTargetHandle - Interface in com.solacesystems.solclientj.core.handle: The MessageDispatchTargetHandle interface allows an application to receive messages on a specific Subscription.
MessageDumpMode() - Constructor for class com.solacesystems.solclientj.core.SolEnum.MessageDumpMode
MessageHandle - Interface in com.solacesystems.solclientj.core.handle: The MessageHandle interface allows applications access and modify the native Solace Message Buffers.
MessageLevelStat() - Constructor for class com.solacesystems.solclientj.core.SolEnum.MessageLevelStat
MessageOutcome() - Constructor for class com.solacesystems.solclientj.core.SolEnum.MessageOutcome
MessageSupport - Interface in com.solacesystems.solclientj.core.handle: The MessageSupport interface provides a common API for handling received messages.
MISMATCHED_ENDPOINT_ERROR_ID - Static variable in class com.solacesystems.solclientj.core.SolEnum.SubCode: Endpoint error ID in the bind request does not match the endpoint's error ID.
MISSING_REPLY_TO - Static variable in class com.solacesystems.solclientj.core.SolEnum.SubCode: A message does not have the required reply-to field.
MODIFY_TOPIC - Static variable in class com.solacesystems.solclientj.core.SolEnum.EndpointPermission: Modify Topic permission, other clients may read and consume messages, and modify Topic on a Topic Endpoint.
modifyClientInfo(String[], int, long) - Method in interface com.solacesystems.solclientj.core.handle.SessionHandle: Allows the following client info properties of a Session to be modified after the Session has been created.
MODIFYPROP_FAIL - Static variable in class com.solacesystems.solclientj.core.SolEnum.SessionEventCode: The session property modification failed.
MODIFYPROP_OK - Static variable in class com.solacesystems.solclientj.core.SolEnum.SessionEventCode: The session property modification completed.
MODIFYPROP_TIMEOUT_MS - Static variable in class com.solacesystems.solclientj.core.handle.SessionHandle.PROPERTIES: Maximum amount of time (in milliseconds) to wait for session property modification.
modifyProperties(String[]) - Method in interface com.solacesystems.solclientj.core.handle.SessionHandle: Allows the following properties of a Session to be modified after the Session has been created.
ModifyPropertyFlags() - Constructor for class com.solacesystems.solclientj.core.SolEnum.ModifyPropertyFlags
MSG_ALLOCS - Static variable in class com.solacesystems.solclientj.core.SolEnum.MessageLevelStat: The number of message allocations performed -- calls to SolClient.createMessageForHandle() or SolClient.createNewMessageAndHandle()
MSG_DUPS - Static variable in class com.solacesystems.solclientj.core.SolEnum.MessageLevelStat: The number of message dups performed -- not used in JavaRTO
MSG_FREES - Static variable in class com.solacesystems.solclientj.core.SolEnum.MessageLevelStat: The number of message frees performed -- calls to MessageHandle.destroy()
MSG_REALLOCS - Static variable in class com.solacesystems.solclientj.core.SolEnum.MessageLevelStat: The number of message re-allocations performed (growth in a message buffer)
MSG_VPN_NOT_ALLOWED - Static variable in class com.solacesystems.solclientj.core.SolEnum.SubCode: The Message VPN name configured for the session does not exist.
MSG_VPN_UNAVAILABLE - Static variable in class com.solacesystems.solclientj.core.SolEnum.SubCode: The Message VPN name set for the Session (or the default Message VPN, if none was set) is currently shutdown on the Appliance.
MULTIPOINT - Static variable in class com.solacesystems.solclientj.core.handle.IPCSupport.SESSION_PROPERTIES: Used to create a Session that is allowed to have multiple underlying sessions/transports.
MutableInteger - Class in com.solacesystems.solclientj.core.handle: Mutable integer
MutableInteger(int) - Constructor for class com.solacesystems.solclientj.core.handle.MutableInteger
MutableInteger() - Constructor for class com.solacesystems.solclientj.core.handle.MutableInteger
MutableLong - Class in com.solacesystems.solclientj.core.handle: Mutable long
MutableLong(long) - Constructor for class com.solacesystems.solclientj.core.handle.MutableLong
MutableLong() - Constructor for class com.solacesystems.solclientj.core.handle.MutableLong
MutableMessageDispatchTargetHandle - Interface in com.solacesystems.solclientj.core.handle: The MutableMessageDispatchTargetHandle interface allows an application to receive messages on a specific MutableTopic.
MutableTopic - Interface in com.solacesystems.solclientj.core.resource: Objects with the MutableTopic Interface represent a mutable solace topic.

N

NativeDestinationHandle - Interface in com.solacesystems.solclientj.core.handle: The NativeDestinationHandle interface allows applications to create Destinations in the Native API.
newCacheSessionEvent() - Static method in class com.solacesystems.solclientj.core.Solclient.Allocator: Allocates a new CacheSessionEvent, this instance is to be used with the CacheSessionHandle.takeCacheSessionEvent() method.
newCacheSessionHandle() - Static method in class com.solacesystems.solclientj.core.Solclient.Allocator: Allocates a new CacheSessionHandle, this is an "unbound" handle that can be used with SessionHandle.createCacheSessionForHandle() method to allocate and "bind" a native resource with this handle.
newClientName(String) - Static method in class com.solacesystems.solclientj.core.Solclient.Allocator: Creates a representation of ClientName with the given clientName.
newContextHandle() - Static method in class com.solacesystems.solclientj.core.Solclient.Allocator: Allocates a new ContextHandle, this is an "unbound" handle that can be used with Solclient.createContextForHandle().
newFlowEvent() - Static method in class com.solacesystems.solclientj.core.Solclient.Allocator: Allocates a new FlowEvent, this instance is to be used with the FlowHandle.takeFlowEvent() method.
newFlowHandle() - Static method in class com.solacesystems.solclientj.core.Solclient.Allocator: Allocates a new FlowHandle, this is an "unbound" handle that can be used with SessionHandle.createFlowForHandle() TransactedSessionHandle.createFlowForHandle()
newMessageDispatchTargetHandle(Subscription, MessageCallback, boolean) - Static method in class com.solacesystems.solclientj.core.Solclient.Allocator: Allocates a new MessageDispatchTargetHandle for the given Subscription having a MessageCallback.
newMessageHandle() - Static method in class com.solacesystems.solclientj.core.Solclient.Allocator: Allocates a new MessageHandle, this is an "unbound" handle that can be used with Solclient.createMessageForHandle().
newMutableMessageDispatchTargetHandle() - Static method in class com.solacesystems.solclientj.core.Solclient.Allocator: Allocates a new MessageDispatchTargetHandle
newMutableTopic(ByteBuffer) - Static method in class com.solacesystems.solclientj.core.Solclient.Allocator: Creates a representation of a MutableTopic destination with the given topicName stored in a ByteBuffer.
newMutableTopic() - Static method in class com.solacesystems.solclientj.core.Solclient.Allocator: Creates a representation of a MutableTopic destination and allocates an empty name byteBuffer of max-topic-size (250 bytes).
newNativeDestinationHandle() - Static method in class com.solacesystems.solclientj.core.Solclient.Allocator: Allocates a new NativeDestinationHandle, this is an "unbound" handle that can be used with Solclient.createNativeDestinationForHandle().
newQueue(String) - Static method in class com.solacesystems.solclientj.core.Solclient.Allocator: Creates a representation of a Durable Queue destination with the given queueName but no set Endpoint.PROPERTIES.
newQueue(String, String[]) - Static method in class com.solacesystems.solclientj.core.Solclient.Allocator: Creates a representation of a Durable Queue destination with the given queueName and Endpoint.PROPERTIES.
newReplicationGroupMessageIdHandle() - Static method in class com.solacesystems.solclientj.core.Solclient.Allocator: Allocates a new ReplicationGroupMessageIdHandle, this is an "unbound" handle that can be used with Solclient.createReplicationGroupMessageIdForHandle().
newSessionEvent() - Static method in class com.solacesystems.solclientj.core.Solclient.Allocator: Allocates a new SessionEvent, this instance is to be used with the SessionHandle.takeSessionEvent() method.
newSessionHandle() - Static method in class com.solacesystems.solclientj.core.Solclient.Allocator: Allocates a new SessionHandle, this is an "unbound" handle that can be used with ContextHandle.createSessionForHandle().
newTopic(String) - Static method in class com.solacesystems.solclientj.core.Solclient.Allocator: Creates a representation of non-temporary Topic destination wih the given topicName.
newTopicEndpoint(String) - Static method in class com.solacesystems.solclientj.core.Solclient.Allocator: Creates a representation of Durable Topic Endpoint (DTE) TopicEndpoint in the API, having the given topicEndpointName, but no set Endpoint.PROPERTIES.
newTopicEndpoint(String, String[]) - Static method in class com.solacesystems.solclientj.core.Solclient.Allocator: Creates a representation of Durable Topic Endpoint (DTE) TopicEndpoint in the API, having the given topicEndpointName and Endpoint.PROPERTIES.
newTransactedSessionHandle() - Static method in class com.solacesystems.solclientj.core.Solclient.Allocator: Allocates a new TransactedSessionHandle, this is an "unbound" handle that can be used with SessionHandle.createTransactedSessionForHandle() method to allocate and "bind" a native resource with this handle.
NO_LOCAL - Static variable in class com.solacesystems.solclientj.core.handle.FlowHandle.PROPERTIES: When a Flow has the No Local property enabled, messages published on the Session cannot appear in a Flow created in the same Session, even if the endpoint contains a subscription that matches the published message.
NO_LOCAL - Static variable in class com.solacesystems.solclientj.core.handle.SessionHandle.PROPERTIES: 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.
NO_LOCAL_NOT_SUPPORTED - Static variable in class com.solacesystems.solclientj.core.SolEnum.SubCode: The client attempted to establish a Session or Flow with No Local enabled and the capability is not supported by the Appliance.
NO_MORE_NON_DURABLE_QUEUE_OR_TE - Static variable in class com.solacesystems.solclientj.core.SolEnum.SubCode: An attempt was made to bind to a non-durable Queue or Topic Endpoint, and the Appliance is out of resources.
NO_STRUCTURED_DATA - Static variable in class com.solacesystems.solclientj.core.SolEnum.SubCode: An attempt was made to create a container to read structured data where none exists.
NO_SUBSCRIBE - Static variable in class com.solacesystems.solclientj.core.SolEnum.CacheRequest: Do not send a subscription request to the Appliance before sending the cache request.
NO_SUBSCRIPTION_MATCH - Static variable in class com.solacesystems.solclientj.core.SolEnum.SubCode: The client attempted to publish a guaranteed message to a topic that did not have any guaranteed subscription matches or only matched a replicated topic.
NO_SUSBSCRIBE - Static variable in class com.solacesystems.solclientj.core.SolEnum.CacheRequest: Deprecated.
use NO_SUBSCRIBE instead
NO_TRANSACTION_STARTED - Static variable in class com.solacesystems.solclientj.core.SolEnum.SubCode: The client attempted to commit an unknown transaction.
NO_WAIT_REPLY - Static variable in class com.solacesystems.solclientj.core.SolEnum.CacheRequest: By default, CacheSessionHandle.sendCacheRequest() blocks until the cache request completes and then returns the cache request status.
NOEVENT - Static variable in class com.solacesystems.solclientj.core.SolEnum.ReturnCode: The context had no events to process.
NONE - Static variable in class com.solacesystems.solclientj.core.SolEnum.EndpointPermission: No permissions for other clients
NONEXCLUSIVE - Static variable in class com.solacesystems.solclientj.core.SolEnum.EndpointAccessType: A non-exclusive (shared) Queue.
NONPERSISTENT - Static variable in class com.solacesystems.solclientj.core.SolEnum.MessageDeliveryMode: Non-Persistent message.
NONPERSISTENT_BYTES - Static variable in class com.solacesystems.solclientj.core.SolEnum.StatRx: The number of Persistent bytes received on the Flow.
NONPERSISTENT_BYTES - Static variable in class com.solacesystems.solclientj.core.SolEnum.StatTx: The number of bytes transmitted in Non-Persistent messages.
NONPERSISTENT_BYTES_REDELIVERED - Static variable in class com.solacesystems.solclientj.core.SolEnum.StatTx: The number of bytes redelivered in Non-Persistent messages.
NONPERSISTENT_MSGS - Static variable in class com.solacesystems.solclientj.core.SolEnum.StatRx: The number of Persistent messages received on the Flow.
NONPERSISTENT_MSGS - Static variable in class com.solacesystems.solclientj.core.SolEnum.StatTx: The number of Non-Persistent messages transmitted.
NONPERSISTENT_REDELIVERED - Static variable in class com.solacesystems.solclientj.core.SolEnum.StatTx: The number of Non-Persistent messages redelivered.
NOT_FOUND - Static variable in class com.solacesystems.solclientj.core.SolEnum.ReturnCode: An operation could not be performed because the message component was not present.
NOT_READY - Static variable in class com.solacesystems.solclientj.core.SolEnum.ReturnCode: The API could not complete because the object is not ready (for example, the session is not connected)
NOTICE - Static variable in class com.solacesystems.solclientj.core.SolEnum.LogLevel: Significant informational messages about the unusual operation of the API.
NOTIFY_SENDER_OFF - Static variable in class com.solacesystems.solclientj.core.SolEnum.EndpointDiscardBehavior: Discard the message and acknowledge it.
NOTIFY_SENDER_ON - Static variable in class com.solacesystems.solclientj.core.SolEnum.EndpointDiscardBehavior: Send the publisher a message reject notification SolEnum.SessionEventCode.REJECTED_MSG_ERROR.
NULL - Static variable in class com.solacesystems.solclientj.core.SolEnum.WebTransportProtocol: An empty value for WEB_TRANSPORT_PROTOCOL means "use best available".
NUM_MSG_QUANTA - Static variable in class com.solacesystems.solclientj.core.SolEnum.QuantaLevelStat: The number of different fixed sizes that are supported in the Native SDK.

O

OAUTH2 - Static variable in class com.solacesystems.solclientj.core.SolEnum.AuthenticationScheme: OAUTH 2.0 authentication with a token.
OAUTH2_ACCESS_TOKEN - Static variable in class com.solacesystems.solclientj.core.handle.SessionHandle.PROPERTIES: The OAUTH2 access token.
OAUTH2_ISSUER_IDENTIFIER - Static variable in class com.solacesystems.solclientj.core.handle.SessionHandle.PROPERTIES: The optional Issuer identifier URI for OAUTH2 access token based authentication.
OBJECT_DESTROYED - Static variable in class com.solacesystems.solclientj.core.SolEnum.SubCode: The operation cannot be completed because the object (context, session, flow) for the method has been destroyed in another thread.
OIDC_ID_TOKEN - Static variable in class com.solacesystems.solclientj.core.handle.SessionHandle.PROPERTIES: The OIDC (OpenId Connect) ID Token.
OK - Static variable in class com.solacesystems.solclientj.core.SolEnum.ReturnCode: The API call was successful
OK - Static variable in class com.solacesystems.solclientj.core.SolEnum.SubCode: No error.
onCacheSessionEvent(CacheSessionHandle) - Method in interface com.solacesystems.solclientj.core.event.CacheSessionEventCallback
onEvent(FlowHandle) - Method in interface com.solacesystems.solclientj.core.event.FlowEventCallback
onEvent(SessionHandle) - Method in interface com.solacesystems.solclientj.core.event.SessionEventCallback: Invoked upon receiving a session event from the API
onMessage(Handle) - Method in interface com.solacesystems.solclientj.core.event.MessageCallback: Invoked when a message is received on a flow or a session
OS_ERROR - Static variable in class com.solacesystems.solclientj.core.SolEnum.SubCode: An API call failed due to a failed operating system call; an error string can be retrieved with Solclient.getLastErrorInfo().
OUT_OF_MEMORY - Static variable in class com.solacesystems.solclientj.core.SolEnum.SubCode: An API call failed due to inability to allocate memory.
OUT_OF_REPLAY_RESOURCES - Static variable in class com.solacesystems.solclientj.core.SolEnum.SubCode: A replay was requested, but the router does not have sufficient resources to fulfill the request, due to too many active replays.
OUT_OF_RESOURCES - Static variable in class com.solacesystems.solclientj.core.SolEnum.SubCode: An API call failed due to lack of resources (for example, starting a timer when all timers are in use).
OVERFLOW_CTSYNC_BUFFER - Static variable in class com.solacesystems.solclientj.core.SolEnum.StatRx: Deprecated - Not Supported - On a cut-through Flow, the number of times the synchronization buffer overflowed, delaying synchronization.

P

P2PINBOX_IN_USE - Static variable in class com.solacesystems.solclientj.core.handle.SessionHandle.PROPERTIES: 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.
PARAM_CONFLICT - Static variable in class com.solacesystems.solclientj.core.SolEnum.SubCode: An API call was made with a parameter combination that is not valid.
PARAM_NULL_PTR - Static variable in class com.solacesystems.solclientj.core.SolEnum.SubCode: An API call was made with a null or invalid pointer parameter.
PARAM_OUT_OF_RANGE - Static variable in class com.solacesystems.solclientj.core.SolEnum.SubCode: An API call was made with an out-of-range parameter.
PASSWORD - Static variable in class com.solacesystems.solclientj.core.handle.SessionHandle.PROPERTIES: The password required for authentication.
PAYLOAD_COMPRESSION_LEVEL - Static variable in class com.solacesystems.solclientj.core.handle.SessionHandle.PROPERTIES: This property must be set to enable payload compression.
PEER_PLATFORM - Static variable in class com.solacesystems.solclientj.core.SolEnum.CapabilityName
PEER_PORT_SPEED - Static variable in class com.solacesystems.solclientj.core.SolEnum.CapabilityName
PEER_PORT_TYPE - Static variable in class com.solacesystems.solclientj.core.SolEnum.CapabilityName
PEER_ROUTER_NAME - Static variable in class com.solacesystems.solclientj.core.SolEnum.CapabilityName
PEER_SOFTWARE_DATE - Static variable in class com.solacesystems.solclientj.core.SolEnum.CapabilityName
PEER_SOFTWARE_VERSION - Static variable in class com.solacesystems.solclientj.core.SolEnum.CapabilityName
PER_MSG - Static variable in class com.solacesystems.solclientj.core.SolEnum.AckEventMode: Solace Message router acknowledges every guaranteed message
PERMISSION - Static variable in class com.solacesystems.solclientj.core.resource.Endpoint.PROPERTIES: Permissions that will be set when the Endpoint is created.
PERMISSION_NOT_ALLOWED - Static variable in class com.solacesystems.solclientj.core.SolEnum.SubCode: An attempt was made to delete or create a Queue or Topic Endpoint when the Session does not have authorization for the action.
PERSISTENT - Static variable in class com.solacesystems.solclientj.core.SolEnum.MessageDeliveryMode: Persistent message.
PERSISTENT_BYTES - Static variable in class com.solacesystems.solclientj.core.SolEnum.StatRx: The number of Persistent bytes received on the Flow.
PERSISTENT_BYTES - Static variable in class com.solacesystems.solclientj.core.SolEnum.StatTx: The number of bytes transmitted in Persistent messages.
PERSISTENT_BYTES_REDELIVERED - Static variable in class com.solacesystems.solclientj.core.SolEnum.StatTx: The number of bytes redelivered in Persistent messages.
PERSISTENT_MSGS - Static variable in class com.solacesystems.solclientj.core.SolEnum.StatRx: The number of Persistent messages received on the Flow.
PERSISTENT_MSGS - Static variable in class com.solacesystems.solclientj.core.SolEnum.StatTx: The number of Persistent messages transmitted.
PERSISTENT_REDELIVERED - Static variable in class com.solacesystems.solclientj.core.SolEnum.StatTx: The number of Persistent messages redelivered.
PLAIN_TEXT - Static variable in class com.solacesystems.solclientj.core.SolEnum.SSLDowngradeTransportProtocol
PROPERTIES() - Constructor for class com.solacesystems.solclientj.core.handle.CacheSessionHandle.PROPERTIES
PROPERTIES() - Constructor for class com.solacesystems.solclientj.core.handle.FlowHandle.PROPERTIES
PROPERTIES() - Constructor for class com.solacesystems.solclientj.core.handle.SessionHandle.PROPERTIES
PROPERTIES() - Constructor for class com.solacesystems.solclientj.core.handle.TransactedSessionHandle.PROPERTIES
PROPERTIES() - Constructor for class com.solacesystems.solclientj.core.resource.Endpoint.PROPERTIES
PROTOCOL_ERROR - Static variable in class com.solacesystems.solclientj.core.SolEnum.SubCode: An API call failed due to a protocol error with the Appliance (not an application fault).
provision(Endpoint, int, long) - Method in interface com.solacesystems.solclientj.core.handle.SessionHandle: Provisions or creates a durable TopicEndpoint or Queue on the Appliance.
PROVISION_ERROR - Static variable in class com.solacesystems.solclientj.core.SolEnum.SessionEventCode: The endpoint create/delete command failed.
PROVISION_OK - Static variable in class com.solacesystems.solclientj.core.SolEnum.SessionEventCode: The endpoint create/delete command completed.
PROVISION_TIMEOUT_MS - Static variable in class com.solacesystems.solclientj.core.handle.SessionHandle.PROPERTIES: Maximum amount of time (in milliseconds) to wait for a provision command (create or delete an endpoint)
ProvisionFlags() - Constructor for class com.solacesystems.solclientj.core.SolEnum.ProvisionFlags
PROXY_AUTH_FAILURE - Static variable in class com.solacesystems.solclientj.core.SolEnum.SubCode: The host entry contained invalid proxy authentication when required by the proxy server.
PROXY_AUTH_REQUIRED - Static variable in class com.solacesystems.solclientj.core.SolEnum.SubCode: The host entry did not contain proxy authentication when required by the proxy server.
PUB_ACK_TIMER - Static variable in class com.solacesystems.solclientj.core.handle.SessionHandle.PROPERTIES: The duration of publisher acknowledgement timer (in milliseconds).
PUB_WINDOW_SIZE - Static variable in class com.solacesystems.solclientj.core.handle.SessionHandle.PROPERTIES: The publisher window size for Guaranteed messages.
PUB_WINDOW_SIZE - Static variable in class com.solacesystems.solclientj.core.handle.TransactedSessionHandle.PROPERTIES: Transacted publisher window size, if supported by broker.
PUBLISH_ACL_DENIED - Static variable in class com.solacesystems.solclientj.core.SolEnum.SubCode: A message could not be published because its Topic matched a Topic defined on the ACL (Access Control List).
PUBLISHER_NOT_CREATED - Static variable in class com.solacesystems.solclientj.core.SolEnum.SubCode: Client attempted to send a message from a Transacted Session without creating a default publisher flow.
PUBLISHER_NOT_ESTABLISHED - Static variable in class com.solacesystems.solclientj.core.SolEnum.SubCode: A send call was made on a transacted session before its publisher is established.

Q

QuantaLevelStat() - Constructor for class com.solacesystems.solclientj.core.SolEnum.QuantaLevelStat
Queue - Interface in com.solacesystems.solclientj.core.resource: Objects with the Queue interface can represent a guaranteed delivery queue on the solace appliance, either as a target (Destination) or as a Endpoint for a consumer flow (FlowHandle).
QUEUE - Static variable in class com.solacesystems.solclientj.core.SolEnum.CacheLiveDataAction: The cache request completes when the cache response is returned.
QUEUE_NOT_FOUND - Static variable in class com.solacesystems.solclientj.core.SolEnum.SubCode: The specified Queue was not found when publishing a message.
QUEUE_SHUTDOWN - Static variable in class com.solacesystems.solclientj.core.SolEnum.SubCode: An attempt was made to operate on a shutdown queue.
QUEUENAME_INVALID_MODE - Static variable in class com.solacesystems.solclientj.core.SolEnum.SubCode: An attempt was made to use a Queue name on a non-Guaranteed message.
QUEUENAME_TOO_LARGE - Static variable in class com.solacesystems.solclientj.core.SolEnum.SubCode: An attempt was made to use a Queue name which is longer than the maximum supported length.
QUEUENAME_TOPIC_CONFLICT - Static variable in class com.solacesystems.solclientj.core.SolEnum.SubCode: Both Queue Name and Topic are specified in solClient_session_send.
QUOTA_MB - Static variable in class com.solacesystems.solclientj.core.resource.Endpoint.PROPERTIES: Maximum quota (in megabytes) for the endpoint.
QUOTA_OUT_OF_RANGE - Static variable in class com.solacesystems.solclientj.core.SolEnum.SubCode: An attempt was made to provision an endpoint with a quota that is out of range.

R

RC4_MD5 - Static variable in class com.solacesystems.solclientj.core.SolEnum.SSLCipher
RC4_SHA - Static variable in class com.solacesystems.solclientj.core.SolEnum.SSLCipher
READ_ONLY - Static variable in class com.solacesystems.solclientj.core.SolEnum.EndpointPermission: Read-only permission, other clients may not consume messages.
READS - Static variable in class com.solacesystems.solclientj.core.SolEnum.StatRx: The number of non-empty reads.
REAPPLY_SUBSCRIPTIONS - Static variable in class com.solacesystems.solclientj.core.handle.SessionHandle.PROPERTIES: Enable this property to have the API remember subscriptions and reapply them upon a Session reconnect.
receive(MessageHandle, int) - Method in interface com.solacesystems.solclientj.core.handle.FlowHandle: Note: This operation is only supported on a Transacted Flow, which must have been created on a TransactedSessionHandle
RECONNECT_RETRIES - Static variable in class com.solacesystems.solclientj.core.handle.SessionHandle.PROPERTIES: How many times to retry to reconnect to the host appliance (or list of appliances) after a connected Session goes down.
RECONNECT_RETRY_INTERVAL_MS - Static variable in class com.solacesystems.solclientj.core.handle.FlowHandle.PROPERTIES: Time to wait between flow auto reconnect attempts, in milliseconds.
RECONNECTED - Static variable in class com.solacesystems.solclientj.core.SolEnum.FlowEventCode: Flow auto rebind was successful, the flow is up again.
RECONNECTED_NOTICE - Static variable in class com.solacesystems.solclientj.core.SolEnum.SessionEventCode: The automatic reconnect of the Session was successful, and the Session was established again.
RECONNECTING - Static variable in class com.solacesystems.solclientj.core.SolEnum.FlowEventCode: The flow is attempting auto rebind
RECONNECTING_NOTICE - Static variable in class com.solacesystems.solclientj.core.SolEnum.SessionEventCode: The Session has gone down, and an automatic reconnect attempt is in progress.
REJECTED - Static variable in class com.solacesystems.solclientj.core.SolEnum.MessageOutcome: Represents a negative acknowledgement outcome, used to signal that the application has rejected the message such as when application determines the message is invalid.
REJECTED_MSG_ERROR - Static variable in class com.solacesystems.solclientj.core.SolEnum.FlowEventCode: This event is deprecated and will never be raised.
REJECTED_MSG_ERROR - Static variable in class com.solacesystems.solclientj.core.SolEnum.SessionEventCode: The Appliance rejected a published message.
REPLAY_CANCELLED - Static variable in class com.solacesystems.solclientj.core.SolEnum.SubCode: A replay in progress on a flow was administratively cancelled, causing the flow to be unbound.
REPLAY_DISABLED - Static variable in class com.solacesystems.solclientj.core.SolEnum.SubCode: Replay is not enabled in the message-vpn.
REPLAY_FAILED - Static variable in class com.solacesystems.solclientj.core.SolEnum.SubCode: A replay in progress on a flow failed.
REPLAY_LOG_MODIFIED - Static variable in class com.solacesystems.solclientj.core.SolEnum.SubCode: A replay in progress on a flow failed because the replay log was modified.
REPLAY_MESSAGE_REJECTED - Static variable in class com.solacesystems.solclientj.core.SolEnum.SubCode: The Solace Message Router attempted to replay a message, but the queue/topic endpoint rejected the message to the sender.
REPLAY_MESSAGE_UNAVAILABLE - Static variable in class com.solacesystems.solclientj.core.SolEnum.SubCode: A replay in progress on a flow failed because messages to be replayed were trimmed from the replay log.
REPLAY_NOT_SUPPORTED - Static variable in class com.solacesystems.solclientj.core.SolEnum.SubCode: Replay is not supported on the Solace Message Router.
REPLAY_START_LOCATION - Static variable in class com.solacesystems.solclientj.core.handle.FlowHandle.PROPERTIES: When a Flow is created, the application may request replay of messages from the replay log, even messages that have been previously delivered and removed from the topic endpoint or queue.
REPLAY_START_MESSAGE_UNAVAILABLE - Static variable in class com.solacesystems.solclientj.core.SolEnum.SubCode: A replay was requested but the requested start message is not available in the replay log.
REPLAY_START_TIME_NOT_AVAILABLE - Static variable in class com.solacesystems.solclientj.core.SolEnum.SubCode: A replay was requested but the requested start time is not available in the replay log.
REPLAY_STARTED - Static variable in class com.solacesystems.solclientj.core.SolEnum.SubCode: A replay was started on the queue/topic endpoint, either by another client or by an adminstrator on the message router.
REPLAY_TEMPORARY_NOT_SUPPORTED - Static variable in class com.solacesystems.solclientj.core.SolEnum.SubCode: Replay is not supported on temporary endpoints.
ReplayStartLocation() - Constructor for class com.solacesystems.solclientj.core.SolEnum.ReplayStartLocation
REPLICATION_IS_STANDBY - Static variable in class com.solacesystems.solclientj.core.SolEnum.SubCode: An attempt to perform an operation using a VPN that is configured to be STANDBY for replication.
ReplicationGroupMessageIdHandle - Interface in com.solacesystems.solclientj.core.handle: The ReplicationGroupMessageIdHandle interface allows applications to serialize a ReplicationGroupMessageId object into a ReplicationGroupMessageId formatted String, compare ReplicationGroupMessageId objects and validate ReplicationGroupMessageId objects in the Native API.
REPLY_MSG - Static variable in class com.solacesystems.solclientj.core.SolEnum.StatRx: The reply messages received.
REPLY_MSG_DISCARD - Static variable in class com.solacesystems.solclientj.core.SolEnum.StatRx: The reply messages (including cache request response) discarded due to errors in response format or no outstanding request.
REPUBLISH_UNACKED_MESSAGES - Static variable in class com.solacesystems.solclientj.core.SolEnum.SessionEventCode: After successfully reconnecting a disconnected session, the SDK received an unknown publisher flow name response when reconnecting the GD publisher flow.
REQUEST_COMPLETED_NOTICE - Static variable in class com.solacesystems.solclientj.core.SolEnum.CacheRequestEventCode: Cache Request has finished.
REQUEST_CONFIRM - Static variable in class com.solacesystems.solclientj.core.SolEnum.SubscribeFlags: Requests a confirmation for the subscribe/unsubscribe operation.
REQUEST_SENT - Static variable in class com.solacesystems.solclientj.core.SolEnum.StatTx: The request messages sent.
REQUEST_TIMEOUT - Static variable in class com.solacesystems.solclientj.core.SolEnum.StatTx: The request messages sent that did not receive a reply due to timeout.
REQUESTREPLY_TIMEOUT_MS - Static variable in class com.solacesystems.solclientj.core.handle.CacheSessionHandle.PROPERTIES: The timeout period (in milliseconds) to wait for a response from the cache.
REQUESTREPLY_TIMEOUT_MS - Static variable in class com.solacesystems.solclientj.core.handle.TransactedSessionHandle.PROPERTIES: Timeout (in milliseconds) to wait for a response.
REQUIRED_OUTCOME_FAILED - Static variable in class com.solacesystems.solclientj.core.handle.FlowHandle.PROPERTIES: This property allows the flow to use FlowHandle.settle(long, int) or FlowHandle.settle(MessageHandle, int) with SolEnum.MessageOutcome.FAILED outcome.
REQUIRED_OUTCOME_REJECTED - Static variable in class com.solacesystems.solclientj.core.handle.FlowHandle.PROPERTIES: This property allows the flow to use FlowHandle.settle(long, int) or FlowHandle.settle(MessageHandle, int) with SolEnum.MessageOutcome.REJECTED outcome.
RESPECTS_MSG_TTL - Static variable in class com.solacesystems.solclientj.core.resource.Endpoint.PROPERTIES: The endpoint observes message Time-to-Live (TTL) values and can remove expired messages.
RETRY - Static variable in class com.solacesystems.solclientj.core.SolEnum.UnbindFailAction: Retry the unbind request
RETRY_WAIT_MS - Static variable in class com.solacesystems.solclientj.core.handle.SessionHandle.PROPERTIES: How much time (in ms) to wait between each attempt to connect or reconnect to a host.
ReturnCode() - Constructor for class com.solacesystems.solclientj.core.SolEnum.ReturnCode
rollback() - Method in interface com.solacesystems.solclientj.core.handle.TransactedSessionHandle: Rollback the active transaction of a specified Transacted Session.
ROLLBACK - Static variable in class com.solacesystems.solclientj.core.SolEnum.ReturnCode: Commit() returns this when the transaction has already been rolled back.
RX_ALL_DELIVER_TO_ONE - Static variable in class com.solacesystems.solclientj.core.SolEnum.SubscribeFlags: Deprecated.
New applications should use shared subscriptions instead.
RX_MSG_TOO_BIG_ERROR - Static variable in class com.solacesystems.solclientj.core.SolEnum.SessionEventCode: The API discarded a received message that exceeded the Session buffer size.

S

SDK - Static variable in class com.solacesystems.solclientj.core.SolEnum.LogCategory: Logs generated by JavaRTO will be in the SDK category.
SELECTOR - Static variable in class com.solacesystems.solclientj.core.handle.FlowHandle.PROPERTIES: A Java Message System (JMS) defined selector.
SELECTOR_MATCH_ERROR - Static variable in class com.solacesystems.solclientj.core.SolEnum.SubCode: The client attempted to bind to a non-exclusive topic endpoint that is already bound with a different ingress selector.
SELECTORS_NOT_SUPPORTED_ON_PARTITIONED_QUEUE - Static variable in class com.solacesystems.solclientj.core.SolEnum.SubCode: The client attempted to use an egress selector when binding to a partitioned queue.
send(MessageHandle) - Method in interface com.solacesystems.solclientj.core.handle.SessionHandle: Sends a message over the session.
send(MessageHandle[], int, int, MutableInteger) - Method in interface com.solacesystems.solclientj.core.handle.SessionHandle: Sends an array of messages over the session.
send(MessageHandle) - Method in interface com.solacesystems.solclientj.core.handle.TransactedSessionHandle: Sends a Guaranteed Delivery message on the specified Transacted Session.
SEND_BLOCKING - Static variable in class com.solacesystems.solclientj.core.handle.SessionHandle.PROPERTIES: A blocking send operation suspends when the Session is transport flow controlled, otherwise the send operation returns SolEnum.ReturnCode.WOULD_BLOCK.
sendCacheRequest(long, Topic, int, int, int) - Method in interface com.solacesystems.solclientj.core.handle.CacheSessionHandle: Sends a cache request.
sendCacheRequest(long, ByteBuffer, int, int, int) - Method in interface com.solacesystems.solclientj.core.handle.CacheSessionHandle: Deprecated.
Applications should use a MutableTopic. A MutableTopic may be set/changed by the application as needed. The MutableTopic can then be passed into CacheSessionHandle.sendCacheRequest(long, Topic, int, int, int).
sendReply(MessageHandle, MessageHandle) - Method in interface com.solacesystems.solclientj.core.handle.SessionHandle: Sends a Reply Message.
sendRequest(MessageHandle, MessageHandle, int) - Method in interface com.solacesystems.solclientj.core.handle.SessionHandle: Sends a Request message for a given Topic.
SERVICE_UNAVAILABLE - Static variable in class com.solacesystems.solclientj.core.SolEnum.SubCode: Guaranteed Delivery services are not enabled on the Appliance.
SESSION_DOWN - Static variable in class com.solacesystems.solclientj.core.SolEnum.FlowEventCode: The Session for the Flow was disconnected.
SESSION_NOT_ESTABLISHED - Static variable in class com.solacesystems.solclientj.core.SolEnum.SubCode: An API call failed due to the Session not being established.
SESSION_PROPERTIES() - Constructor for class com.solacesystems.solclientj.core.handle.IPCSupport.SESSION_PROPERTIES
SessionEvent - Interface in com.solacesystems.solclientj.core.event: An object with the SessionEvent interface is returned by SessionHandle.getSessionEvent().
SessionEventCallback - Interface in com.solacesystems.solclientj.core.event: When a Session event is received that indicates an error condition (such as the Session going down), additional error information is recorded and can be retrieved through SolClient.getLastErrorInfo() The callback interface for Session events.
SessionEventCode() - Constructor for class com.solacesystems.solclientj.core.SolEnum.SessionEventCode
SessionHandle - Interface in com.solacesystems.solclientj.core.handle: The SessionHandle interface represents a messaging API session which abstracts a client connection to the Appliance.
SessionHandle.PROPERTIES - Class in com.solacesystems.solclientj.core.handle: Defines the property names used to create a SessionHandle.
setAckImmediately(boolean) - Method in interface com.solacesystems.solclientj.core.handle.MessageHandle: Set the optional ACK Immediately message property.
setApplicationMessageId(String) - Method in interface com.solacesystems.solclientj.core.handle.MessageHandle
setApplicationMessageType(String) - Method in interface com.solacesystems.solclientj.core.handle.MessageHandle: This method allows the application to set the ApplicationMessageType.
setAsReplyMessage(boolean) - Method in interface com.solacesystems.solclientj.core.handle.MessageHandle: Set the reply attribute of the message.
setBinaryAttachment(ByteBuffer) - Method in interface com.solacesystems.solclientj.core.handle.MessageHandle: Set the contents of the binary attachment part by copying in from the given ByteBuffer.
setBinaryAttachment(byte[]) - Method in interface com.solacesystems.solclientj.core.handle.MessageHandle: Set the contents of the binary attachment part by copying in from the given byte[] array.
setBinaryAttachment(byte[], int, int) - Method in interface com.solacesystems.solclientj.core.handle.MessageHandle: Set the contents of the binary attachment part by copying in a range of data from the given byte[] array.
setCorrelationId(String) - Method in interface com.solacesystems.solclientj.core.handle.MessageHandle: Set the Correlation Id in the binary meta data header.
setCorrelationIdFromMessage(MessageHandle) - Method in interface com.solacesystems.solclientj.core.handle.MessageHandle: This convenience method is a shortcut that allows an application to populate the CorrelationId of an MessageHandler by copying the CorrelationId of the given MessageHandle.
setCorrelationKey(long) - Method in interface com.solacesystems.solclientj.core.handle.MessageHandle: Sets the correlation key on the given message.
setDeliverToOne(boolean) - Method in interface com.solacesystems.solclientj.core.handle.MessageHandle: Deprecated.
New applications should use shared subscriptions instead.
setDestination(Destination) - Method in interface com.solacesystems.solclientj.core.handle.MessageHandle: Sets the destination field ( Queue, Topic or MutableTopic) on the given message.
setDestinationFromMessageReplyTo(MessageHandle) - Method in interface com.solacesystems.solclientj.core.handle.MessageHandle: This convenience method is a shortcut that allows an application to set the Destination of an MessageHandler by copying the Reply-To of the given MessageHandle.
setDMQEligible(boolean) - Method in interface com.solacesystems.solclientj.core.handle.MessageHandle: Set the Dead Message Queue (DMQ) eligible property on a message.
setElidingEligible(boolean) - Method in interface com.solacesystems.solclientj.core.handle.MessageHandle: Set the ElidingEligible property on a message.
setExpiration(long) - Method in interface com.solacesystems.solclientj.core.handle.MessageHandle: Set the expiration time field.
setHttpContentEncoding(String) - Method in interface com.solacesystems.solclientj.core.handle.MessageHandle: Set the HTTP Content Encoding in the binary meta data header.
setHttpContentType(String) - Method in interface com.solacesystems.solclientj.core.handle.MessageHandle: Set the HTTP Content Type in the binary meta data header.
setLogLevel(Level) - Static method in class com.solacesystems.solclientj.core.Solclient: Sets the log level to the desired java logging level.
setMaxUnacked(int) - Method in interface com.solacesystems.solclientj.core.handle.FlowHandle: Changes the maximum number of unacknowledged messages that may be received on the specified Flow.
setMessageDeliveryMode(int) - Method in interface com.solacesystems.solclientj.core.handle.MessageHandle
setPriority(int) - Method in interface com.solacesystems.solclientj.core.handle.MessageHandle: Set message priority.
setQueuePartitionKey(String) - Method in interface com.solacesystems.solclientj.core.handle.MessageHandle: This method allows the application to set the queue partition key for the message.
setReplyTo(Destination) - Method in interface com.solacesystems.solclientj.core.handle.MessageHandle: * Performance Tip: If your application is setting the ReplyTo address on many messages to the same destination or set of destinations consider using NativeDestinationHandle to create a set of NativeDestination objects that can be re-used.
setReplyToSuffix(SessionHandle, String) - Method in interface com.solacesystems.solclientj.core.handle.MessageHandle: Append an application-specified suffix to the default topic destination for the Session.
setSenderId(String) - Method in interface com.solacesystems.solclientj.core.handle.MessageHandle: Set the SenderId.
setSenderTimestamp(long) - Method in interface com.solacesystems.solclientj.core.handle.MessageHandle: Set the Sender Timestamp field.
setSequenceNumber(long) - Method in interface com.solacesystems.solclientj.core.handle.MessageHandle: Set the Sequence Number in the message.
setTimeToLive(long) - Method in interface com.solacesystems.solclientj.core.handle.MessageHandle: Set the Time To Live (TTL) for a message.
settle(long, int) - Method in interface com.solacesystems.solclientj.core.handle.FlowHandle: Settles a message in a requested way.
settle(MessageHandle, int) - Method in interface com.solacesystems.solclientj.core.handle.FlowHandle: Settles a message in a requested way.
SETTLE_ACCEPTED - Static variable in class com.solacesystems.solclientj.core.SolEnum.StatRx: The number of messages that are settled with SolEnum.MessageOutcome.ACCEPTED
SETTLE_FAILED - Static variable in class com.solacesystems.solclientj.core.SolEnum.StatRx: The number of messages that are settled with SolEnum.MessageOutcome.FAILED
SETTLE_REJECTED - Static variable in class com.solacesystems.solclientj.core.SolEnum.StatRx: The number of messages that are settled with SolEnum.MessageOutcome.REJECTED
setUserCos(int) - Method in interface com.solacesystems.solclientj.core.handle.MessageHandle: Set the Class of Service to use for transmission.
setUserData(ByteBuffer) - Method in interface com.solacesystems.solclientj.core.handle.MessageHandle: Set the contents of the message User Data header by copying in from the given ByteBuffer.
setUserData(byte[]) - Method in interface com.solacesystems.solclientj.core.handle.MessageHandle: Set the contents of the User Data header by copying in from the given byte[] array.
setUserData(byte[], int, int) - Method in interface com.solacesystems.solclientj.core.handle.MessageHandle: Set the contents of the User Data header by copying in a range of data from the given byte[] array.
setValue(int) - Method in class com.solacesystems.solclientj.core.handle.MutableInteger
setValue(long) - Method in class com.solacesystems.solclientj.core.handle.MutableLong
SHARED_SUBSCRIPTIONS_ENDPOINT_NOT_ALLOWED - Static variable in class com.solacesystems.solclientj.core.SolEnum.SubCode: The client attempted to add a shared subscription to a queue or topic endpoint.
SHARED_SUBSCRIPTIONS_NOT_ALLOWED - Static variable in class com.solacesystems.solclientj.core.SolEnum.SubCode: The client attempted to add a shared subscription on a client that is not permitted to use shared subscriptions.
SHARED_SUBSCRIPTIONS_NOT_SUPPORTED - Static variable in class com.solacesystems.solclientj.core.SolEnum.SubCode: The client attempted to add a shared subscription, but the capability is not supported by the appliance.
SOCKET_FULL - Static variable in class com.solacesystems.solclientj.core.SolEnum.StatTx: The number of times the socket was full when send done (data buffered).
SOCKET_RCV_BUF_SIZE - Static variable in class com.solacesystems.solclientj.core.handle.SessionHandle.PROPERTIES: The value for socket receive buffer size (in bytes).
SOCKET_SEND_BUF_SIZE - Static variable in class com.solacesystems.solclientj.core.handle.SessionHandle.PROPERTIES: The value for the socket send buffer size (in bytes).
Solclient - Class in com.solacesystems.solclientj.core: This is the entry point of Java RTO messaging API.
Solclient() - Constructor for class com.solacesystems.solclientj.core.Solclient
Solclient.Allocator - Class in com.solacesystems.solclientj.core: Used to group the set of allocation factory methods for the different object types
Solclient.GLOBAL_PROPERTIES - Class in com.solacesystems.solclientj.core: Global Configuration Properties.
SOLCLIENT_SUBCODE_LOG_FILE_ERROR - Static variable in class com.solacesystems.solclientj.core.SolEnum.SubCode: Could not open the log file name specified by the application for writing (Deprecated - SolEnum.SubCode.OS_ERROR is used).
SOLCLIENT_SUBCODE_REPLAY_ANONYMOUS_NOT_SUPPORTED - Static variable in class com.solacesystems.solclientj.core.SolEnum.SubCode: The client attempted to start replay on a flow bound to an anonymous queue.
SOLCLIENT_SUBCODE_SYNC_REPLICATION_INELIGIBLE - Static variable in class com.solacesystems.solclientj.core.SolEnum.SubCode: A guaranteed message was rejected because the broker has been configured to reject messages when sync replication mode is ineligible.
SolclientErrorInfo - Class in com.solacesystems.solclientj.core: This data structure holds detailed error information based on the underlying API implementation and as relayed from the Appliance.
The last SolclientErrorInfo can be obtained from Solclient.getLastErrorInfo().
When available the last SolclientErrorInfo accompanies a raised SolclientException
SolclientErrorInfo(int, int, String) - Constructor for class com.solacesystems.solclientj.core.SolclientErrorInfo: Constructs this data structure with the provided attributes.
SolclientException - Exception in com.solacesystems.solclientj.core: Represents a runtime exception that can be raised from the API.
It encapsulates the details that were available at the time the exception was raised: A message A SolEnum.ReturnCode An optional SolclientErrorInfo Note: The SolclientException object is allocated from the heap and could cause garbage collection interruptions when it is no longer referenced.
SolclientException(String, SolclientErrorInfo, int) - Constructor for exception com.solacesystems.solclientj.core.SolclientException: Constructs the exception based on the message parameter with appended details of SolclientErrorInfo and the SolEnum.ReturnCode
SolclientException(SolclientErrorInfo, int) - Constructor for exception com.solacesystems.solclientj.core.SolclientException: Constructs the exception having a message based on the details of SolclientErrorInfo and the SolEnum.ReturnCode
SolclientException(String, int) - Constructor for exception com.solacesystems.solclientj.core.SolclientException: Constructs the exception having a message and a SolEnum.ReturnCode
SolConstants() - Constructor for class com.solacesystems.solclientj.core.SolEnum.SolConstants
SolEnum - Interface in com.solacesystems.solclientj.core: Main interface of all public enumerations.
SolEnum.AckEventMode - Class in com.solacesystems.solclientj.core: The AckEventMode class contains the static enumerations that may be used for SessionHandle.PROPERTIES.ACK_EVENT_MODE
SolEnum.AckMode - Class in com.solacesystems.solclientj.core: The AckMode class contains the static enumerations that may be used for FlowHandle.PROPERTIES.ACKMODE
SolEnum.AuthenticationScheme - Class in com.solacesystems.solclientj.core: The AuthenticationScheme class contains the static enumerations that may be used for SessionHandle.PROPERTIES.AUTHENTICATION_SCHEME
SolEnum.BooleanValue - Class in com.solacesystems.solclientj.core: Boolean values used in properties
SolEnum.CacheLiveDataAction - Class in com.solacesystems.solclientj.core: Cache live data action.
SolEnum.CacheRequest - Class in com.solacesystems.solclientj.core: Cache Request Options control the API operation when cacheSessionHandle.sendCacheRequest is invoked.
SolEnum.CacheRequestEventCode - Class in com.solacesystems.solclientj.core: Cache request event code
SolEnum.CapabilityName - Class in com.solacesystems.solclientj.core: When the application connects to the solace appliance with SessionHandle.connect(), the session capabilities are negotiated.
SolEnum.EndpointAccessType - Class in com.solacesystems.solclientj.core: The EndpointAccessType class contains the static enumerations that may be used for Endpoint.PROPERTIES.ACCESSTYPE
SolEnum.EndpointDiscardBehavior - Class in com.solacesystems.solclientj.core: The EndpointDiscardBehavior class contains the static enumerations that may be used for Endpoint.PROPERTIES.DISCARD_BEHAVIOR
SolEnum.EndpointPermission - Class in com.solacesystems.solclientj.core: The EndpointPermissions class contains the static enumerations that may be used for Endpoint.PROPERTIES.PERMISSIONS
SolEnum.FlowEventCode - Class in com.solacesystems.solclientj.core: Flow event codes that can be retrieved from a FlowEvent
SolEnum.GdReconnectFailAction - Class in com.solacesystems.solclientj.core: Guaranteed Delivery Reconnect Fail Actions
Defines the valid set of actions the API will take if it is unable to reconnect guaranteed delivery after a session reconnect.
SolEnum.LogCategory - Class in com.solacesystems.solclientj.core: Logs generated by JavaRTO and the underlying C SDK all appear in the #SDK category.
SolEnum.LogLevel - Class in com.solacesystems.solclientj.core: Log level
SolEnum.MessageCacheStatus - Class in com.solacesystems.solclientj.core: Cache Status of received message, returned by MessageHandle.getCacheStatus()
SolEnum.MessageDeliveryMode - Class in com.solacesystems.solclientj.core: The MessageDeliveryMode class contains the static enumerations that may be used for MessageHandle.setMessageDeliveryMode
SolEnum.MessageDumpMode - Class in com.solacesystems.solclientj.core: Flags used in MessageHandle.dump(int)
SolEnum.MessageLevelStat - Class in com.solacesystems.solclientj.core: Statistics associated with message memory management.
SolEnum.MessageOutcome - Class in com.solacesystems.solclientj.core: Represents the type for supported message settlement outcome.
SolEnum.ModifyPropertyFlags - Class in com.solacesystems.solclientj.core: Flags used in modify client info operation SessionHandle.modifyClientInfo()
SolEnum.ProvisionFlags - Class in com.solacesystems.solclientj.core: Flags used in provision operations
SolEnum.QuantaLevelStat - Class in com.solacesystems.solclientj.core: Statistics associated with the Native SDK message data memory (Quanta).
SolEnum.ReplayStartLocation - Class in com.solacesystems.solclientj.core: The ReplayStartLocation class contains the static enumerations that may be used for FlowHandle.PROPERTIES.REPLAY_START_LOCATION
SolEnum.ReturnCode - Class in com.solacesystems.solclientj.core: Return code from API calls
SolEnum.SessionEventCode - Class in com.solacesystems.solclientj.core: Session event code that can be retrieved from a SessionEvent
SolEnum.SolConstants - Class in com.solacesystems.solclientj.core: SolClient Constants in the API
SolEnum.SSLCipher - Class in com.solacesystems.solclientj.core: Supported SSL ciphers
SolEnum.SSLDowngradeTransportProtocol - Class in com.solacesystems.solclientj.core: Supported transport protocols for SSL downgrade
SolEnum.SSLProtocol - Class in com.solacesystems.solclientj.core: Supported SSL protocols
SolEnum.StatRx - Class in com.solacesystems.solclientj.core: Receive statistics
SolEnum.StatTx - Class in com.solacesystems.solclientj.core: Transmit statistics
SolEnum.SubCode - Class in com.solacesystems.solclientj.core: A subcode that provides more detailed error information.
SolEnum.SubscribeFlags - Class in com.solacesystems.solclientj.core: Flags used in subscribe operations
SolEnum.UnbindFailAction - Class in com.solacesystems.solclientj.core: Unbind fail action values for SessionHandle.PROPERTIES.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.
SolEnum.UserCos - Class in com.solacesystems.solclientj.core: The UserCos class contains the static enumerations that may be used for MessageHandle.setUserCos
SolEnum.WebTransportProtocol - Class in com.solacesystems.solclientj.core: Session transport protocol types.
Defines the the valid set of transport protocols when setting WEB_TRANSPORT_PROTOCOL, or returned via the read-only session property WEB_TRANSPORT_PROTOCOL_IN_USE Note: the use of GUARANTEED_WITH_WEB_TRANSPORT effects what protocol are available for properties WEB_TRANSPORT_PROTOCOL_LIST and WEB_TRANSPORT_PROTOCOL
SPOOL_OVER_QUOTA - Static variable in class com.solacesystems.solclientj.core.SolEnum.SubCode: Message was not delivered because the Guaranteed message spool is over its allotted space quota.
SSL_CIPHER_SUITES - Static variable in class com.solacesystems.solclientj.core.handle.SessionHandle.PROPERTIES: This property specifies a comma separated list of the cipher suites.
SSL_CLIENT_CERTIFICATE_FILE - Static variable in class com.solacesystems.solclientj.core.handle.SessionHandle.PROPERTIES: This property specifies the client certificate file name.
SSL_CLIENT_PRIVATE_KEY_FILE - Static variable in class com.solacesystems.solclientj.core.handle.SessionHandle.PROPERTIES: This property specifies the client private key file name.
SSL_CLIENT_PRIVATE_KEY_FILE_PASSWORD - Static variable in class com.solacesystems.solclientj.core.handle.SessionHandle.PROPERTIES: This property specifies the password used to encrypt the client private key file.
SSL_CONNECTION_DOWNGRADE_TO - Static variable in class com.solacesystems.solclientj.core.handle.SessionHandle.PROPERTIES: This property specifies a transport protocol that SSL connection will be downgraded to after client authentication.
SSL_EXCLUDED_PROTOCOLS - Static variable in class com.solacesystems.solclientj.core.handle.SessionHandle.PROPERTIES: This property specifies a comma separated list of SSL protocol(s) not to use.
SSL_LIB - Static variable in class com.solacesystems.solclientj.core.Solclient.GLOBAL_PROPERTIES: The TLS (Transport Layer Security) and SSL (Secure Sockets Layer) library name.
Default: Operating System dependent: Linux - "libssl.so" Windows - "ssleay32.dll" MacOSX - "libssl.dylib"
SSL_PROTOCOL - Static variable in class com.solacesystems.solclientj.core.handle.SessionHandle.PROPERTIES: Deprecated.
SSL_READ_CALLS - Static variable in class com.solacesystems.solclientj.core.SolEnum.StatRx: The number of SSL read calls
SSL_READ_EVENTS - Static variable in class com.solacesystems.solclientj.core.SolEnum.StatRx: The number of SSL read events
SSL_RSA_WITH_3DES_EDE_CBC_SHA - Static variable in class com.solacesystems.solclientj.core.SolEnum.SSLCipher
SSL_RSA_WITH_RC4_128_MD5 - Static variable in class com.solacesystems.solclientj.core.SolEnum.SSLCipher
SSL_RSA_WITH_RC4_128_SHA - Static variable in class com.solacesystems.solclientj.core.SolEnum.SSLCipher
SSL_TRUST_STORE_DIR - Static variable in class com.solacesystems.solclientj.core.handle.SessionHandle.PROPERTIES: This property specifies the directory where the trusted certificates are.
SSL_TRUSTED_COMMON_NAME_LIST - Static variable in class com.solacesystems.solclientj.core.handle.SessionHandle.PROPERTIES: NOT RECOMMENDED Per RFC-6125 section 6.4.4, the Common Name (CN) of a certificate should not be used to validate the certificate.
SSL_VALIDATE_CERTIFICATE - Static variable in class com.solacesystems.solclientj.core.handle.SessionHandle.PROPERTIES: This property indicates if the certificate validation with certificates in the truststore is enabled.
SSL_VALIDATE_CERTIFICATE_DATE - Static variable in class com.solacesystems.solclientj.core.handle.SessionHandle.PROPERTIES: This property indicates if the session connection should fail when a certificate with an invalid date is received.
SSL_VALIDATE_CERTIFICATE_HOST - Static variable in class com.solacesystems.solclientj.core.handle.SessionHandle.PROPERTIES: This property indicates if the sesssion connection should fail when a certificate with an invalid host is received.
SSLCipher() - Constructor for class com.solacesystems.solclientj.core.SolEnum.SSLCipher
SSLDowngradeTransportProtocol() - Constructor for class com.solacesystems.solclientj.core.SolEnum.SSLDowngradeTransportProtocol
SSLProtocol() - Constructor for class com.solacesystems.solclientj.core.SolEnum.SSLProtocol
SSLV3 - Static variable in class com.solacesystems.solclientj.core.SolEnum.SSLProtocol
start() - Method in interface com.solacesystems.solclientj.core.handle.FlowHandle: Opens the receiver on the specified Flow.
START_STATE - Static variable in class com.solacesystems.solclientj.core.handle.FlowHandle.PROPERTIES: This property controls whether the Flow should be created in a start or stop state with respect to receiving messages.
StatRx() - Constructor for class com.solacesystems.solclientj.core.SolEnum.StatRx
StatsSupport - Interface in com.solacesystems.solclientj.core.handle: The StatsSupport interface provides a common API for retrieving and clearing API statistics.
StatTx() - Constructor for class com.solacesystems.solclientj.core.SolEnum.StatTx
stop() - Method in interface com.solacesystems.solclientj.core.handle.FlowHandle: Closes the receiver on the specified Flow.
SubCode() - Constructor for class com.solacesystems.solclientj.core.SolEnum.SubCode
SUBCONFIRM_TIMEOUT_MS - Static variable in class com.solacesystems.solclientj.core.handle.SessionHandle.PROPERTIES: The timeout period (in milliseconds) for subscription confirm (add or remove).
subscribe(MessageDispatchTargetHandle, int, long) - Method in interface com.solacesystems.solclientj.core.event.MessageDispatcher
subscribe(MutableMessageDispatchTargetHandle, MutableTopic, MessageCallback, boolean, int, long) - Method in interface com.solacesystems.solclientj.core.event.MessageDispatcher
subscribe(Subscription, int, long) - Method in interface com.solacesystems.solclientj.core.handle.SessionHandle: Adds a Subscription to a Session.
subscribe(ByteBuffer, int, long) - Method in interface com.solacesystems.solclientj.core.handle.SessionHandle: Deprecated.
Applications should use a MutableTopic. A MutableTopic may be set/changed by the application as needed. The MutableTopic can then be passed into SessionHandle.subscribe(Subscription, int, long).
subscribe(Endpoint, Subscription, int, long) - Method in interface com.solacesystems.solclientj.core.handle.SessionHandle: Adds a Topic Subscription on the given Endpoint (if supported), Typically this is done on a Queue or ClientName
subscribe(Endpoint, ByteBuffer, int, long) - Method in interface com.solacesystems.solclientj.core.handle.SessionHandle: Deprecated.
Applications should use a MutableTopic. A MutableTopic may be set/changed by the application as needed. The MutableTopic can then be passed into SessionHandle.subscribe(Endpoint, Subscription, int, long).
SUBSCRIBE_BLOCKING - Static variable in class com.solacesystems.solclientj.core.handle.SessionHandle.PROPERTIES: A blocking subscribe operation will suspend when the Session is transport flow controlled, otherwise the subscribe operation returns SolEnum.ReturnCode.WOULD_BLOCK.
SubscribeFlags() - Constructor for class com.solacesystems.solclientj.core.SolEnum.SubscribeFlags
subscribeOnBehalfOfClient(ByteBuffer, ByteBuffer, int, long) - Method in interface com.solacesystems.solclientj.core.handle.SessionHandle: Adds a Topic Subscription to a given ClientName
SUBSCRIBER_LOCAL_PRIORITY - Static variable in class com.solacesystems.solclientj.core.handle.SessionHandle.PROPERTIES: Deprecated.
New applications should use shared subscriptions instead.
SUBSCRIBER_NETWORK_PRIORITY - Static variable in class com.solacesystems.solclientj.core.handle.SessionHandle.PROPERTIES: Deprecated.
New applications should use shared subscriptions instead.
Subscription - Interface in com.solacesystems.solclientj.core.resource: The Subscription interface exists for objects that consumers can use to subscribe or unsubscribe to.
SUBSCRIPTION_ACL_DENIED - Static variable in class com.solacesystems.solclientj.core.SolEnum.SubCode: Adding a subscription was denied because it matched a subscription that was defined on the ACL (Access Control List).
SUBSCRIPTION_ALREADY_PRESENT - Static variable in class com.solacesystems.solclientj.core.SolEnum.SubCode: The client attempted to add a subscription which already exists.
SUBSCRIPTION_ATTRIBUTES_CONFLICT - Static variable in class com.solacesystems.solclientj.core.SolEnum.SubCode: The client attempted to add a subscription which already exists but it has different properties, Consider switching to shared subscriptions instead of deliver to one
SUBSCRIPTION_ERROR - Static variable in class com.solacesystems.solclientj.core.SolEnum.SessionEventCode: The Appliance rejected a subscription (add or remove).
SUBSCRIPTION_INVALID - Static variable in class com.solacesystems.solclientj.core.SolEnum.SubCode: The client attempted to add/remove a subscription that is not valid.
SUBSCRIPTION_MANAGER_DENIED - Static variable in class com.solacesystems.solclientj.core.SolEnum.SubCode: An attempt was made to add a subscription to another client when Session does not have subscription manager privileges.
SUBSCRIPTION_MATCH_ERROR - Static variable in class com.solacesystems.solclientj.core.SolEnum.SubCode: The client attempted to bind to a non-exclusive topic endpoint that is already bound with a different subscription.
SUBSCRIPTION_NOT_FOUND - Static variable in class com.solacesystems.solclientj.core.SolEnum.SubCode: The client attempted to remove a subscription which did not exist.
SUBSCRIPTION_OK - Static variable in class com.solacesystems.solclientj.core.SolEnum.SessionEventCode: The subscribe or unsubscribe operation has succeeded.
SUBSCRIPTION_OTHER - Static variable in class com.solacesystems.solclientj.core.SolEnum.SubCode: The Appliance rejected a subscription add or remove request for a reason not separately enumerated.
SUBSCRIPTION_TOO_MANY - Static variable in class com.solacesystems.solclientj.core.SolEnum.SubCode: The client attempted to add a subscription that exceeded the maximum number allowed.

T

takeCacheSessionEvent(CacheSessionEvent) - Method in interface com.solacesystems.solclientj.core.handle.CacheSessionHandle: This method clones the last CacheSessionEvent into the given CacheSessionEvent The given CacheSessionEvent is implementation specific and is expected to be the one produced by Allocator.newCacheSessionEvent() This call is valid while on the same thread and in context of CacheSessionEventCallback.onCacheSessionEvent() .
takeFlowEvent(FlowEvent, boolean) - Method in interface com.solacesystems.solclientj.core.handle.FlowHandle: This method clones the last FlowEvent into the given FlowEvent The given FlowEvent is implementation specific and is expected to be the one produced by Allocator.newFlowEvent() This call is valid while on the same thread and in context of FlowEventCallback.onEvent().
takeRxMessage(MessageHandle) - Method in interface com.solacesystems.solclientj.core.handle.MessageSupport: Use this method to make the received message available outside the scope of MessageCallback.onMessage() Note: client applications must call Handle.destroy() on the MessageHandle reference when they are done with it
takeSessionEvent(SessionEvent, boolean) - Method in interface com.solacesystems.solclientj.core.handle.SessionHandle: This method clones the last SessionEvent into the given SessionEvent The given SessionEvent must be one produced by Allocator.newSessionEvent() This call is valid while on the same thread and in context of SessionEventCallback.onEvent().
TCP_NODELAY - Static variable in class com.solacesystems.solclientj.core.handle.SessionHandle.PROPERTIES: Enable this property to enable TCP no delay.
TE_SHUTDOWN - Static variable in class com.solacesystems.solclientj.core.SolEnum.SubCode: An attempt was made to bind to a shutdown Topic Endpoint.
TE_UNSUBSCRIBE_ERROR - Static variable in class com.solacesystems.solclientj.core.SolEnum.SessionEventCode: The Topic Endpoint unsubscribe command failed.
TE_UNSUBSCRIBE_OK - Static variable in class com.solacesystems.solclientj.core.SolEnum.SessionEventCode: The Topic Endpoint unsubscribe completed.
THREAD_AFFINITY - Static variable in class com.solacesystems.solclientj.core.handle.IPCSupport.CONTEXT_PROPERTIES: The desired thread affinity mask for the Context thread.
THREAD_AFFINITY_CPU_LIST - Static variable in class com.solacesystems.solclientj.core.handle.IPCSupport.CONTEXT_PROPERTIES: The desired thread affinity CPU list for the Context thread.
TIMEOUT - Static variable in class com.solacesystems.solclientj.core.SolEnum.SubCode: An API call failed due to a timeout.
TLS_ECDHE_RSA_WITH_3DES_EDE_CBC_SHA - Static variable in class com.solacesystems.solclientj.core.SolEnum.SSLCipher
TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA - Static variable in class com.solacesystems.solclientj.core.SolEnum.SSLCipher
TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA256 - Static variable in class com.solacesystems.solclientj.core.SolEnum.SSLCipher
TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256 - Static variable in class com.solacesystems.solclientj.core.SolEnum.SSLCipher
TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA - Static variable in class com.solacesystems.solclientj.core.SolEnum.SSLCipher
TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA384 - Static variable in class com.solacesystems.solclientj.core.SolEnum.SSLCipher
TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384 - Static variable in class com.solacesystems.solclientj.core.SolEnum.SSLCipher
TLS_RSA_WITH_AES_128_CBC_SHA - Static variable in class com.solacesystems.solclientj.core.SolEnum.SSLCipher
TLS_RSA_WITH_AES_128_CBC_SHA256 - Static variable in class com.solacesystems.solclientj.core.SolEnum.SSLCipher
TLS_RSA_WITH_AES_128_GCM_SHA256 - Static variable in class com.solacesystems.solclientj.core.SolEnum.SSLCipher
TLS_RSA_WITH_AES_256_CBC_SHA - Static variable in class com.solacesystems.solclientj.core.SolEnum.SSLCipher
TLS_RSA_WITH_AES_256_CBC_SHA256 - Static variable in class com.solacesystems.solclientj.core.SolEnum.SSLCipher
TLS_RSA_WITH_AES_256_GCM_SHA384 - Static variable in class com.solacesystems.solclientj.core.SolEnum.SSLCipher
TLSV1 - Static variable in class com.solacesystems.solclientj.core.SolEnum.SSLProtocol: Deprecated.
TLSV1_1 - Static variable in class com.solacesystems.solclientj.core.SolEnum.SSLProtocol
TLSV1_2 - Static variable in class com.solacesystems.solclientj.core.SolEnum.SSLProtocol
TOO_MANY_CLIENTS - Static variable in class com.solacesystems.solclientj.core.SolEnum.SubCode: The client login not currently possible becuase the maximum number of active clients on Appliance has already been reached.
Topic - Interface in com.solacesystems.solclientj.core.resource: Objects with the Topic Interface represent a solace topic.
TOPIC_DISPATCH - Static variable in class com.solacesystems.solclientj.core.handle.SessionHandle.PROPERTIES: Enable this property to have the API dispatch messages based on Topic (see event.MessageDispatcher)
TOPIC_MISSING - Static variable in class com.solacesystems.solclientj.core.SolEnum.SubCode: A send call was made that did not have a Topic in a mode where one is required (for example, client mode).
TOPIC_OR_SELECTOR_MODIFIED_ON_DURABLE_TOPIC_ENDPOINT - Static variable in class com.solacesystems.solclientj.core.SolEnum.SubCode: A replay was in progress on a Durable Topic Endpoint (DTE) when its topic or selector was modified, causing the replay to fail.
TOPIC_TOO_LARGE - Static variable in class com.solacesystems.solclientj.core.SolEnum.SubCode: An attempt was made to use a Topic that is longer than the maximum that is supported.
TopicEndpoint - Interface in com.solacesystems.solclientj.core.resource: Objects with the TopicEndpoint interface can represent a guaranteed delivery topic endpoint on the solace appliance as a Endpoint for a consumer flow (FlowHandle).
toString() - Method in interface com.solacesystems.solclientj.core.handle.ReplicationGroupMessageIdHandle: Serializes the ReplicationGroupMessageIdHandle object into a ReplicationGroupMessageId formatted String.
toString() - Method in class com.solacesystems.solclientj.core.SolclientErrorInfo: Provides a formatted representation of the error, containing the errorStr, a numerical and String representation of the SolEnum.SubCode , and the numerical representation of the responseCode.
toString(String) - Static method in class com.solacesystems.solclientj.core.SolEnum.AckEventMode
toString(String) - Static method in class com.solacesystems.solclientj.core.SolEnum.AckMode
toString(String) - Static method in class com.solacesystems.solclientj.core.SolEnum.AuthenticationScheme
toString(String) - Static method in class com.solacesystems.solclientj.core.SolEnum.BooleanValue
toString(int) - Static method in class com.solacesystems.solclientj.core.SolEnum.CacheLiveDataAction
toString(int) - Static method in class com.solacesystems.solclientj.core.SolEnum.CacheRequest
toString(int) - Static method in class com.solacesystems.solclientj.core.SolEnum.CacheRequestEventCode
toString(String) - Static method in class com.solacesystems.solclientj.core.SolEnum.CapabilityName
toString(String) - Static method in class com.solacesystems.solclientj.core.SolEnum.EndpointAccessType
toString(String) - Static method in class com.solacesystems.solclientj.core.SolEnum.EndpointDiscardBehavior
toString(String) - Static method in class com.solacesystems.solclientj.core.SolEnum.EndpointPermission
toString(int) - Static method in class com.solacesystems.solclientj.core.SolEnum.FlowEventCode
toString(String) - Static method in class com.solacesystems.solclientj.core.SolEnum.GdReconnectFailAction
toString(int) - Static method in class com.solacesystems.solclientj.core.SolEnum.LogCategory
toString(int) - Static method in class com.solacesystems.solclientj.core.SolEnum.LogLevel
toString(int) - Static method in class com.solacesystems.solclientj.core.SolEnum.MessageCacheStatus
toString(int) - Static method in class com.solacesystems.solclientj.core.SolEnum.MessageDeliveryMode
toString(int) - Static method in class com.solacesystems.solclientj.core.SolEnum.MessageDumpMode
toString(int) - Static method in class com.solacesystems.solclientj.core.SolEnum.MessageLevelStat
toString(int) - Static method in class com.solacesystems.solclientj.core.SolEnum.ModifyPropertyFlags
toString(int) - Static method in class com.solacesystems.solclientj.core.SolEnum.ProvisionFlags
toString(int) - Static method in class com.solacesystems.solclientj.core.SolEnum.QuantaLevelStat
toString(String) - Static method in class com.solacesystems.solclientj.core.SolEnum.ReplayStartLocation
toString(int) - Static method in class com.solacesystems.solclientj.core.SolEnum.ReturnCode
toString(int) - Static method in class com.solacesystems.solclientj.core.SolEnum.SessionEventCode
toString(int) - Static method in class com.solacesystems.solclientj.core.SolEnum.SolConstants
toString(String) - Static method in class com.solacesystems.solclientj.core.SolEnum.SSLCipher
toString(String) - Static method in class com.solacesystems.solclientj.core.SolEnum.SSLDowngradeTransportProtocol
toString(String) - Static method in class com.solacesystems.solclientj.core.SolEnum.SSLProtocol
toString(int) - Static method in class com.solacesystems.solclientj.core.SolEnum.StatRx
toString(int) - Static method in class com.solacesystems.solclientj.core.SolEnum.StatTx
toString(int) - Static method in class com.solacesystems.solclientj.core.SolEnum.SubCode
toString(int) - Static method in class com.solacesystems.solclientj.core.SolEnum.SubscribeFlags
toString(String) - Static method in class com.solacesystems.solclientj.core.SolEnum.UnbindFailAction
toString(int) - Static method in class com.solacesystems.solclientj.core.SolEnum.UserCos
toString(String) - Static method in class com.solacesystems.solclientj.core.SolEnum.WebTransportProtocol
TOTAL_CONNECTION_ATTEMPTS - Static variable in class com.solacesystems.solclientj.core.SolEnum.StatTx: The total number of TCP connections attempted by this Session.
TOTAL_DATA_BYTES - Static variable in class com.solacesystems.solclientj.core.SolEnum.StatRx: The total number of data bytes received.
TOTAL_DATA_BYTES - Static variable in class com.solacesystems.solclientj.core.SolEnum.StatTx: The number of data bytes transmitted in total.
TOTAL_DATA_MSGS - Static variable in class com.solacesystems.solclientj.core.SolEnum.StatRx: The total number of data messages received.
TOTAL_DATA_MSGS - Static variable in class com.solacesystems.solclientj.core.SolEnum.StatTx: The number of data messages transmitted in total.
TOTAL_MEMORY - Static variable in class com.solacesystems.solclientj.core.SolEnum.MessageLevelStat: Approximate amount of total memory consumed for message pool \ (allocated and on free list)
TRANSACTED_SESSION_NAME_IN_USE - Static variable in class com.solacesystems.solclientj.core.SolEnum.SubCode: The client failed to open a Transacted Session as the Transacted Session name provided is being used by another opened session.
TransactedSessionHandle - Interface in com.solacesystems.solclientj.core.handle: The TransactedSessionHandle interface represents a messaging API -transacted-session which provides interfaces for local transacations with the Appliance.
TransactedSessionHandle.PROPERTIES - Class in com.solacesystems.solclientj.core.handle: Defines the property names used to create a transacted session handle
TRANSACTION_FAILURE - Static variable in class com.solacesystems.solclientj.core.SolEnum.SubCode: The client attempted to commit a transaction with too many transaction steps.
TRANSPORT_PROTOCOL_DOWNGRADE_TIMEOUT_MS - Static variable in class com.solacesystems.solclientj.core.handle.SessionHandle.PROPERTIES: 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.

U

UNBIND_FAIL_ACTION - Static variable in class com.solacesystems.solclientj.core.handle.SessionHandle.PROPERTIES: 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.
UNBIND_RESPONSE_LOST - Static variable in class com.solacesystems.solclientj.core.SolEnum.SubCode: The application called solClient_flow_destroy() and the unbind-response was not received.
UnbindFailAction() - Constructor for class com.solacesystems.solclientj.core.SolEnum.UnbindFailAction
UNEXPECTED_UNBIND - Static variable in class com.solacesystems.solclientj.core.SolEnum.SubCode: An unexpected unbind response was received for a Queue or Topic Endpoint (for example, the Queue or Topic Endpoint was deleted from the Appliance).
UNKNOWN_CLIENT_NAME - Static variable in class com.solacesystems.solclientj.core.SolEnum.SubCode: An attempt was made to add a subscription to another client that is unknown on the Appliance.
UNKNOWN_FLOW_NAME - Static variable in class com.solacesystems.solclientj.core.SolEnum.SubCode: The session was disconnected due to loss of the publisher flow state.
UNKNOWN_QUEUE_NAME - Static variable in class com.solacesystems.solclientj.core.SolEnum.SubCode: An attempt was made to bind to an unknown Queue name (for example, not configured on Appliance).
UNKNOWN_START_LOCATION - Static variable in class com.solacesystems.solclientj.core.SolEnum.SubCode: The client attempted to start a replay but provided an unknown start location type.
UNKNOWN_TE_NAME - Static variable in class com.solacesystems.solclientj.core.SolEnum.SubCode: An attempt was made to bind to an unknown Topic Endpoint name (for example, not configured on Appliance).
UNRESOLVED_HOST - Static variable in class com.solacesystems.solclientj.core.SolEnum.SubCode: The client failed to connect because the host name could not be resolved.
unsubscribe(MessageDispatchTargetHandle, int, long) - Method in interface com.solacesystems.solclientj.core.event.MessageDispatcher
unsubscribe(MutableMessageDispatchTargetHandle, int, long) - Method in interface com.solacesystems.solclientj.core.event.MessageDispatcher
unsubscribe(Subscription, int, long) - Method in interface com.solacesystems.solclientj.core.handle.SessionHandle: Removes a Subscription from a Session.
unsubscribe(ByteBuffer, int, long) - Method in interface com.solacesystems.solclientj.core.handle.SessionHandle: Deprecated.
Applications should use a MutableTopic. A MutableTopic may be set/changed by the application as needed. The MutableTopic can then be passed into SessionHandle.unsubscribe(Subscription, int, long).
unsubscribe(Endpoint, Subscription, int, long) - Method in interface com.solacesystems.solclientj.core.handle.SessionHandle: Removes a Topic Subscription from the given Endpoint (if supported).
unsubscribe(Endpoint, ByteBuffer, int, long) - Method in interface com.solacesystems.solclientj.core.handle.SessionHandle: Deprecated.
Applications should use a MutableTopic. A MutableTopic may be set/changed by the application as needed. The MutableTopic can then be passed into SessionHandle.unsubscribe(Endpoint, Subscription, int, long).
unsubscribe(TopicEndpoint, long) - Method in interface com.solacesystems.solclientj.core.handle.SessionHandle: Unsubscribes from a durable Topic Endpoint.
UNSUBSCRIBE_NOT_ALLOWED_CLIENTS_BOUND - Static variable in class com.solacesystems.solclientj.core.SolEnum.SubCode: The client attempted to unsubscribe a Topic from a Topic Endpoint while there were still Flows bound to the endpoint.
unsubscribeOnBehalfOfClient(ByteBuffer, ByteBuffer, int, long) - Method in interface com.solacesystems.solclientj.core.handle.SessionHandle: Removes a Topic Subscription from a given ClientName
UNTRUSTED_CERTIFICATE - Static variable in class com.solacesystems.solclientj.core.SolEnum.SubCode: The client attempted to connect to an Appliance that has a suspect certficate.
UNTRUSTED_CLIENT_CERTIFICATE - Static variable in class com.solacesystems.solclientj.core.SolEnum.SubCode: The client failed to connect to an Appliance as it has a suspect client certificate.
UNTRUSTED_COMMONNAME - Static variable in class com.solacesystems.solclientj.core.SolEnum.SubCode: The client attempted to connect to an Appliance that has a suspect common name.
UP_NOTICE - Static variable in class com.solacesystems.solclientj.core.SolEnum.FlowEventCode: The Flow is established.
UP_NOTICE - Static variable in class com.solacesystems.solclientj.core.SolEnum.SessionEventCode: The Session is established
USER_DATA_TOO_LARGE - Static variable in class com.solacesystems.solclientj.core.SolEnum.SubCode: An attempt was made to send a message with user data larger than the maximum that is supported.
USER_ID - Static variable in class com.solacesystems.solclientj.core.handle.SessionHandle.PROPERTIES: 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.
UserCos() - Constructor for class com.solacesystems.solclientj.core.SolEnum.UserCos
USERNAME - Static variable in class com.solacesystems.solclientj.core.handle.SessionHandle.PROPERTIES: The username required for authentication.

V

validateTopic(String) - Method in interface com.solacesystems.solclientj.core.handle.SessionHandle: This method checks a topic string against topic encoding rules for the Appliance.
validateTopic(ByteBuffer) - Method in interface com.solacesystems.solclientj.core.handle.SessionHandle: This method checks a topic name byte buffer against topic encoding rules for the Appliance.
Version - Interface in com.solacesystems.solclientj.core: API version details.
VIRTUAL_ROUTER_NAME - Static variable in class com.solacesystems.solclientj.core.handle.SessionHandle.PROPERTIES: A read-only property that indicates the connected appliance's virtual router name.
VIRTUAL_ROUTER_NAME_CHANGED - Static variable in class com.solacesystems.solclientj.core.SolEnum.SessionEventCode: The Appliance's Virtual Router Name changed during a reconnect operation.
VPN_NAME - Static variable in class com.solacesystems.solclientj.core.handle.SessionHandle.PROPERTIES: The name of the Message VPN to attempt to join when connecting to an Appliance.
VPN_NAME_IN_USE - Static variable in class com.solacesystems.solclientj.core.handle.SessionHandle.PROPERTIES: A read-only Session property that indicates which Message VPN the Session is connected to.

W

WAIT_FOR_CONFIRM - Static variable in class com.solacesystems.solclientj.core.SolEnum.ModifyPropertyFlags: The modifyClientInfo API call blocks until a confirmation is received or its associated timer SessionHandle.PROPERTIES.MODIFYPROP_TIMEOUT_MS expires.
WAIT_FOR_CONFIRM - Static variable in class com.solacesystems.solclientj.core.SolEnum.ProvisionFlags: Causes the current the calling thread to block until a confirmation is received from the Appliance
WAIT_FOR_CONFIRM - Static variable in class com.solacesystems.solclientj.core.SolEnum.SubscribeFlags: The subscribe/unsubscribe call blocks until a confirmation is received.
WARNING - Static variable in class com.solacesystems.solclientj.core.SolEnum.LogLevel: An input error to the API that is not expected to affect its operation.
WEB_TRANSPORT_PROTOCOL - Static variable in class com.solacesystems.solclientj.core.handle.SessionHandle.PROPERTIES: This property specifies a WEB Transport Protocol in the default WEB Transport Protocol downgrade list to use for the session connection.
WEB_TRANSPORT_PROTOCOL_IN_USE - Static variable in class com.solacesystems.solclientj.core.handle.SessionHandle.PROPERTIES: Read-only property which returns the WEB Transport Protocol curently in use for web messaging.
WEB_TRANSPORT_PROTOCOL_LIST - Static variable in class com.solacesystems.solclientj.core.handle.SessionHandle.PROPERTIES: This property specifies a comma separated list of WEB Transport Protocols to use for session connection.
WebTransportProtocol() - Constructor for class com.solacesystems.solclientj.core.SolEnum.WebTransportProtocol
WINDOW_CLOSE - Static variable in class com.solacesystems.solclientj.core.SolEnum.StatTx: The number of times the transmit window closed.
WINDOWED - Static variable in class com.solacesystems.solclientj.core.SolEnum.AckEventMode: Solace Message router generates windowed acknowledgements.
WINDOWSIZE - Static variable in class com.solacesystems.solclientj.core.handle.FlowHandle.PROPERTIES: The Guaranteed message window size for the Flow.
WOULD_BLOCK - Static variable in class com.solacesystems.solclientj.core.SolEnum.ReturnCode: An API call would block, but non-blocking was requested.
WOULD_BLOCK - Static variable in class com.solacesystems.solclientj.core.SolEnum.StatTx: The number of messages not accepted due to would block (non-blocking only).
WS_BINARY - Static variable in class com.solacesystems.solclientj.core.SolEnum.WebTransportProtocol: Binary-encoded, using the WebSocket protocol, supports guaranteed web transport

X

XML_PARSE_ERROR - Static variable in class com.solacesystems.solclientj.core.SolEnum.SubCode: The Appliance could not parse an XML message.

A B C D E F G H I K L M N O P Q R S T U V W X