Solclient
).See: Description
Interface | Description |
---|---|
SolEnum |
Main interface of all public enumerations.
|
Version |
API version details.
|
Class | Description |
---|---|
Solclient |
This is the entry point of Java RTO messaging API.
|
Solclient.Allocator |
Used to group the set of allocation factory methods for the different
object types
|
Solclient.GLOBAL_PROPERTIES |
Global Configuration Properties.
|
SolclientErrorInfo |
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 |
SolEnum.AckEventMode |
The AckEventMode class contains the static enumerations that may be used
for
SessionHandle.PROPERTIES.ACK_EVENT_MODE |
SolEnum.AckMode |
The AckMode class contains the static enumerations that may be used for
FlowHandle.PROPERTIES.ACKMODE |
SolEnum.AuthenticationScheme |
The AuthenticationScheme class contains the static enumerations that may
be used for
SessionHandle.PROPERTIES.AUTHENTICATION_SCHEME |
SolEnum.BooleanValue |
Boolean values used in properties
|
SolEnum.CacheLiveDataAction |
Cache live data action.
|
SolEnum.CacheRequest |
Cache Request Options control the API operation when
cacheSessionHandle.sendCacheRequest is invoked. |
SolEnum.CacheRequestEventCode |
Cache request event code
|
SolEnum.CapabilityName |
When the application connects to the solace appliance with
SessionHandle.connect() , the session capabilities are negotiated. |
SolEnum.EndpointAccessType |
The EndpointAccessType class contains the static enumerations that may be
used for
Endpoint.PROPERTIES.ACCESSTYPE |
SolEnum.EndpointDiscardBehavior |
The EndpointDiscardBehavior class contains the static enumerations that
may be used for
Endpoint.PROPERTIES.DISCARD_BEHAVIOR |
SolEnum.EndpointPermission |
The EndpointPermissions class contains the static enumerations that may
be used for
Endpoint.PROPERTIES.PERMISSIONS |
SolEnum.FlowEventCode |
Flow event codes that can be retrieved from a
FlowEvent |
SolEnum.GdReconnectFailAction |
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 |
Logs generated by JavaRTO and the underlying C SDK all appear in the #SDK
category.
|
SolEnum.LogLevel |
Log level
|
SolEnum.MessageCacheStatus |
Cache Status of received message, returned by
MessageHandle.getCacheStatus() |
SolEnum.MessageDeliveryMode |
The MessageDeliveryMode class contains the static enumerations that may
be used for
MessageHandle.setMessageDeliveryMode |
SolEnum.MessageDumpMode |
Flags used in
MessageHandle.dump(int) |
SolEnum.MessageLevelStat |
Statistics associated with message memory management.
|
SolEnum.MessageOutcome |
Represents the type for supported message settlement outcome.
|
SolEnum.ModifyPropertyFlags |
Flags used in modify client info operation
SessionHandle.modifyClientInfo() |
SolEnum.ProvisionFlags |
Flags used in provision operations
|
SolEnum.QuantaLevelStat |
Statistics associated with the Native SDK message data memory (Quanta).
|
SolEnum.ReplayStartLocation |
The ReplayStartLocation class contains the static enumerations that may be used
for
FlowHandle.PROPERTIES.REPLAY_START_LOCATION |
SolEnum.ReturnCode |
Return code from API calls
|
SolEnum.SessionEventCode |
Session event code that can be retrieved from a
SessionEvent |
SolEnum.SolConstants |
SolClient Constants in the API
|
SolEnum.SSLCipher |
Supported SSL ciphers
|
SolEnum.SSLDowngradeTransportProtocol |
Supported transport protocols for SSL downgrade
|
SolEnum.SSLProtocol |
Supported SSL protocols
|
SolEnum.StatRx |
Receive statistics
|
SolEnum.StatTx |
Transmit statistics
|
SolEnum.SubCode |
A subcode that provides more detailed error information.
|
SolEnum.SubscribeFlags |
Flags used in subscribe operations
|
SolEnum.UnbindFailAction |
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 |
The UserCos class contains the static enumerations that may be used for
MessageHandle.setUserCos |
SolEnum.WebTransportProtocol |
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 |
Exception | Description |
---|---|
SolclientException |
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. |
Solclient
).Copyright 2004-2024 Solace Corporation. All rights reserved.