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

A

AccessDeniedException - Exception in com.solacesystems.jcsmp
 
AccessDeniedException(String, Throwable) - Constructor for exception com.solacesystems.jcsmp.AccessDeniedException
 
AccessDeniedException(String) - Constructor for exception com.solacesystems.jcsmp.AccessDeniedException
 
ACCESSTYPE_EXCLUSIVE - Static variable in class com.solacesystems.jcsmp.EndpointProperties
The first client to bind receives the messages.
ACCESSTYPE_NONEXCLUSIVE - Static variable in class com.solacesystems.jcsmp.EndpointProperties
Each client bound receives messages in a round-robin fashion.
ACK_EVENT_MODE - Static variable in class com.solacesystems.jcsmp.JCSMPProperties
 
ackMessage() - Method in interface com.solacesystems.jcsmp.XMLMessage
Acknowledges the message.
addSubscriber() - Method in interface com.solacesystems.jcsmp.Session
Deprecated.
It is no longer necessary to call this function. This function might be removed in a future version of JCSMP.
addSubscription(Subscription) - Method in interface com.solacesystems.jcsmp.JCSMPSession
Adds a subscription to the appliance.
addSubscription(Subscription, boolean) - Method in interface com.solacesystems.jcsmp.JCSMPSession
Adds a subscription to an appliance.
addSubscription(Endpoint, Subscription, int) - Method in interface com.solacesystems.jcsmp.JCSMPSession
Adds a subscription to an Endpoint on the appliance.
addSubscription(Subscription, JCSMPResponseListener, Object) - Method in interface com.solacesystems.jcsmp.JCSMPSession
Adds a subscription asynchronously to the appliance.
addSubscription(Endpoint, Subscription, JCSMPResponseListener, Object) - Method in interface com.solacesystems.jcsmp.JCSMPSession
Adds a subscription asynchronously to an Endpoint on the appliance.
APPLICATION_DESCRIPTION - Static variable in class com.solacesystems.jcsmp.JCSMPProperties
 
applySubscriptions(Set<Subscription>) - Method in interface com.solacesystems.jcsmp.JCSMPSession
Uses the subscription refresh feature to override the subscriptions and subscription filters associated with a subscriber on the appliance with a given list of subscriptions.
AUTHENTICATION_SCHEME - Static variable in class com.solacesystems.jcsmp.JCSMPProperties
 
AUTHENTICATION_SCHEME_BASIC - Static variable in class com.solacesystems.jcsmp.JCSMPProperties
Username/Password based Authentication Scheme.
AUTHENTICATION_SCHEME_CLIENT_CERTIFICATE - Static variable in class com.solacesystems.jcsmp.JCSMPProperties
Client-side certificate base Authentication Scheme.
AUTHENTICATION_SCHEME_GSS_KRB - Static variable in class com.solacesystems.jcsmp.JCSMPProperties
Kerberos based Authentication Scheme.

B

BASIC_AUTHENTICATION_IS_SHUTDOWN - Static variable in class com.solacesystems.jcsmp.JCSMPErrorResponseSubcodeEx
The client attempted to connect to an appliance that has the basic authentication shutdown.
Browser - Interface in com.solacesystems.jcsmp
A Browser allows client applications to look at messages spooled on Endpoints without removing them.
BrowserProperties - Class in com.solacesystems.jcsmp
Properties used for the creation of a Browser.
BrowserProperties() - Constructor for class com.solacesystems.jcsmp.BrowserProperties
Constructs BrowserProperties with default values.
BytesMessage - Interface in com.solacesystems.jcsmp
BytesMessage is used to send a message containing a stream of uninterpreted bytes.
BytesXMLMessage - Interface in com.solacesystems.jcsmp
BytesXMLMessage describes a message that is sent or received.

C

CACHE_FULFILL_REPLIES_DISCARDED - Static variable in class com.solacesystems.jcsmp.statistics.StatType
The number of cache replies discarded because a request has been fulfilled.
CACHE_REQUESTS_FULFILLED - Static variable in class com.solacesystems.jcsmp.statistics.StatType
The number of cache requests that have been fulfilled with a live message.
CACHE_REQUESTS_SENT - Static variable in class com.solacesystems.jcsmp.statistics.StatType
The number of cache requests.
CACHED_MSGS_RECVED - Static variable in class com.solacesystems.jcsmp.statistics.StatType
The number of cache messages retrieved from caches.
CacheEventMessage - Interface in com.solacesystems.jcsmp
An event that signals the termination of a cache request.
CacheLiveDataAction - Enum in com.solacesystems.jcsmp
The live data action dictates the disposition of live data received while the cache request is outstanding to the solCache.
CachePrefix - Static variable in class com.solacesystems.jcsmp.CacheSessionProperties
 
CacheRequestListener - Interface in com.solacesystems.jcsmp
Listener that is notified on asynchronous cache request completion.
CacheRequestResult - Enum in com.solacesystems.jcsmp
Result of a cache request.
CacheSession - Interface in com.solacesystems.jcsmp
A Session for performing cache requests.
CacheSessionProperties - Class in com.solacesystems.jcsmp
The cache properties used when creating a CacheSession.
CacheSessionProperties(String) - Constructor for class com.solacesystems.jcsmp.CacheSessionProperties
Create CacheProperties with default values of: Maximum messages per topic = 1, Maximum message age in seconds = 0, Timeout for a cache request = 10000.
CacheSessionProperties(String, int, int, int) - Constructor for class com.solacesystems.jcsmp.CacheSessionProperties
Create CacheProperties.
CacheSessionProperties(String, int, int, int, boolean) - Constructor for class com.solacesystems.jcsmp.CacheSessionProperties
Create CacheProperties.
CALCULATE_MESSAGE_EXPIRATION - Static variable in class com.solacesystems.jcsmp.JCSMPProperties
 
cancelCacheRequests() - Method in interface com.solacesystems.jcsmp.CacheSession
Cancels outstanding cache requests.
CANNOT_BIND_TO_QUEUE - Static variable in class com.solacesystems.jcsmp.JCSMPErrorResponseSubcodeEx
Already bound to the Guaranteed Delivery Queue or not authorized to bind to the Guaranteed Delivery Queue.
CapabilityType - Enum in com.solacesystems.jcsmp
 
clear() - Method in interface com.solacesystems.jcsmp.SDTMap
Removes all mappings from the map.
clear() - Method in interface com.solacesystems.jcsmp.SDTStream
Clears the current contents of the stream.
clearAttachment() - Method in interface com.solacesystems.jcsmp.XMLMessage
Deletes the attachment to the message.
clearContent() - Method in interface com.solacesystems.jcsmp.XMLMessage
Clears the message content.
clearSubscriber() - Method in interface com.solacesystems.jcsmp.Session
Deprecated.
This method is no longer supported. The recommended way to delete subscriptions from the appliance is to perform an applySubscriptions() on the session with an empty subscription list.
CLIENT_ACL_DENIED - Static variable in class com.solacesystems.jcsmp.JCSMPErrorResponseSubcodeEx
The client denied login to appliance due to matching a client ACL (Access Control List).
CLIENT_CERTIFICATE_AUTHENTICATION_IS_SHUTDOWN - Static variable in class com.solacesystems.jcsmp.JCSMPErrorResponseSubcodeEx
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.jcsmp.JCSMPErrorResponseSubcodeEx
The client failed to connect to an appliance as it does not have a valid client certificate date.
CLIENT_CHANNEL_PROPERTIES - Static variable in class com.solacesystems.jcsmp.JCSMPProperties
 
CLIENT_DELETE_IN_PROGRESS - Static variable in class com.solacesystems.jcsmp.JCSMPErrorResponseSubcodeEx
Client login is not currently possible because a previous instance of the same client is still being deleted.
CLIENT_INITIATED_REPLAY_BROWSER_FLOW_NOT_ALLOWED - Static variable in class com.solacesystems.jcsmp.JCSMPErrorResponseSubcodeEx
The request attempted to start replay as a browser flow, which is not permitted.
CLIENT_INITIATED_REPLAY_INACTIVE_FLOW_NOT_ALLOWED - Static variable in class com.solacesystems.jcsmp.JCSMPErrorResponseSubcodeEx
Client Initiated Replay from Inactive Flow Not Allowed This subCode is used for the following error response: - 403 Client Initiated Replay from Inactive Flow Not Allowed
CLIENT_INITIATED_REPLAY_NON_EXCLUSIVE_NOT_ALLOWED - Static variable in class com.solacesystems.jcsmp.JCSMPErrorResponseSubcodeEx
Client Initiated Replay Not Allowed on Non-Exclusive Queue/Topic Endpoint.
CLIENT_MODE - Static variable in class com.solacesystems.jcsmp.JCSMPProperties
Deprecated.
CLIENT_NAME - Static variable in class com.solacesystems.jcsmp.JCSMPProperties
 
CLIENT_NAME_ALREADY_IN_USE - Static variable in class com.solacesystems.jcsmp.JCSMPErrorResponseSubcodeEx
The session is attempting to use a client name that is in use by another client in the Message VPN, and the appliance is configured to reject the new session.
CLIENT_NAME_INVALID - Static variable in class com.solacesystems.jcsmp.JCSMPErrorResponseSubcodeEx
Attempted to set CLIENT_NAME property to an invalid value.
CLIENT_USERNAME_IS_SHUTDOWN - Static variable in class com.solacesystems.jcsmp.JCSMPErrorResponseSubcodeEx
The username for the client is administratively shutdown on the appliance.
ClientName - Class in com.solacesystems.jcsmp
An Endpoint representing a remote client.
clone() - Method in class com.solacesystems.jcsmp.CacheSessionProperties
 
clone() - Method in class com.solacesystems.jcsmp.JCSMPChannelProperties
Copy properties to a newly-created instance.
clone() - Method in class com.solacesystems.jcsmp.JCSMPGlobalProperties
 
close() - Method in interface com.solacesystems.jcsmp.Browser
Closes the Browser.
close() - Method in interface com.solacesystems.jcsmp.CacheSession
Closes the cache session and cancels any outstanding cache requests.
close() - Method in interface com.solacesystems.jcsmp.Consumer
Closes the message consumer, rendering it unusable.
close() - Method in interface com.solacesystems.jcsmp.Producer
Closes the message producer.
close() - Method in interface com.solacesystems.jcsmp.transaction.TransactedSession
Rollback the active transaction and close the TransactedSession.
ClosedFacilityException - Exception in com.solacesystems.jcsmp
ClosedFacilityException indicates that the requested operation cannot be fulfilled because the facility providing the operation was closed.
ClosedFacilityException(String) - Constructor for exception com.solacesystems.jcsmp.ClosedFacilityException
 
ClosedFacilityException(String, Throwable) - Constructor for exception com.solacesystems.jcsmp.ClosedFacilityException
 
closeSession() - Method in interface com.solacesystems.jcsmp.Session
Closes the session.
com.solacesystems.common.config - package com.solacesystems.common.config
Software versioning configuration.
com.solacesystems.jcsmp - package com.solacesystems.jcsmp
The Solace Messaging API for Java (also referred to as JCSMP) is a 100% pure Java implementation that provides an object-oriented API for delivering high message throughput.
com.solacesystems.jcsmp.statistics - package com.solacesystems.jcsmp.statistics
JCSMP runtime and session statistics.
com.solacesystems.jcsmp.transaction - package com.solacesystems.jcsmp.transaction
 
commit() - Method in interface com.solacesystems.jcsmp.transaction.TransactedSession
Commit the active transaction.
compare(ReplicationGroupMessageId) - Method in interface com.solacesystems.jcsmp.ReplicationGroupMessageId
Compare with the other ReplicationGroupMessageId
COMPRESSION_LEVEL - Static variable in class com.solacesystems.jcsmp.JCSMPChannelProperties
 
connect() - Method in interface com.solacesystems.jcsmp.JCSMPSession
Connect to the appliance.
CONNECT_RETRIES - Static variable in class com.solacesystems.jcsmp.JCSMPChannelProperties
 
CONNECT_RETRIES_PER_HOST - Static variable in class com.solacesystems.jcsmp.JCSMPChannelProperties
 
CONNECT_TIMEOUT_IN_MILLIS - Static variable in class com.solacesystems.jcsmp.JCSMPChannelProperties
 
Consumer - Interface in com.solacesystems.jcsmp
Consumer objects are used to receive messages from the Solace Messaging Platform.
ConsumerFlowProperties - Class in com.solacesystems.jcsmp
Properties for binding a consumer flow, used in JCSMPSession.createFlow(XMLMessageListener, ConsumerFlowProperties).
ConsumerFlowProperties() - Constructor for class com.solacesystems.jcsmp.ConsumerFlowProperties
Creates a new instance of ConsumerFlowProperties.
containsKey(String) - Method in interface com.solacesystems.jcsmp.SDTMap
Returns true if this map contains a mapping with the specified key.
containsValue(Object) - Method in interface com.solacesystems.jcsmp.SDTMap
Returns true if this map contains one or more mappings with the specified value.
Context - Interface in com.solacesystems.jcsmp
A Context is used for organizing communications between applications and a Solace appliance.
ContextProperties - Class in com.solacesystems.jcsmp
Properties for configuring a Context upon creation.
ContextProperties() - Constructor for class com.solacesystems.jcsmp.ContextProperties
 
CONTROL_CHANNEL_PROPERTIES - Static variable in class com.solacesystems.jcsmp.JCSMPProperties
Deprecated.
These channel properties are deprecated in favor of JCSMPProperties.CLIENT_CHANNEL_PROPERTIES. If the default settings for CLIENT_CHANNEL_PROPERTIES are modified in any way, they override these legacy channel properties.
createBrowser(BrowserProperties) - Method in interface com.solacesystems.jcsmp.JCSMPSession
Creates a Browser, which can be used for browsing the contents of a Queue.
createBrowser(BrowserProperties, FlowEventHandler) - Method in interface com.solacesystems.jcsmp.JCSMPSession
Creates a Browser, which can be used for browsing the contents of a Queue.
createBytesMessage() - Method in interface com.solacesystems.jcsmp.Producer
Applications use this method to create a BytesMessage.
createBytesXMLMessage() - Method in interface com.solacesystems.jcsmp.Producer
Applications use this method to create a BytesXMLMessage.
createBytesXMLMessage(byte[]) - Method in interface com.solacesystems.jcsmp.Producer
Applications use this method to create a BytesXMLMessage.
createCacheSession(CacheSessionProperties) - Method in interface com.solacesystems.jcsmp.JCSMPSession
Creates a CacheSession using the provided CacheSession properties.
createClientName(String) - Method in class com.solacesystems.jcsmp.JCSMPFactory
Creates a representation of a remote client Endpoint, which can be used to manage subscriptions on behalf of that client.
createContext(ContextProperties) - Method in class com.solacesystems.jcsmp.JCSMPFactory
Creates a new Context with the provided properties.
createDurableTopicEndpoint(String) - Method in class com.solacesystems.jcsmp.JCSMPFactory
Creates a new DurableTopicEndpoint instance for name.
createDurableTopicEndpointEx(String) - Method in class com.solacesystems.jcsmp.JCSMPFactory
Creates a new TopicEndpoint instance for name, representing a durable Topic Endpoint(DTE) in the API.
createFlow(Endpoint, Subscription, XMLMessageListener) - Method in interface com.solacesystems.jcsmp.JCSMPSession
Get an instance of FlowReceiver bound to a appliance Endpoint, such as a Queue or TopicEndpoint.
createFlow(XMLMessageListener, ConsumerFlowProperties) - Method in interface com.solacesystems.jcsmp.JCSMPSession
Get an instance of FlowReceiver bound to an appliance Endpoint, such as a Queue or TopicEndpoint.
createFlow(XMLMessageListener, ConsumerFlowProperties, EndpointProperties) - Method in interface com.solacesystems.jcsmp.JCSMPSession
Get an instance of FlowReceiver bound to an appliance Endpoint, such as a Queue or TopicEndpoint.
createFlow(XMLMessageListener, ConsumerFlowProperties, EndpointProperties, FlowEventHandler) - Method in interface com.solacesystems.jcsmp.JCSMPSession
Get an instance of FlowReceiver bound to an appliance Endpoint, such as a Queue or TopicEndpoint.
createFlow(XMLMessageListener, ConsumerFlowProperties, EndpointProperties) - Method in interface com.solacesystems.jcsmp.transaction.TransactedSession
Creates a consumer flow within this TransactedSession and associates it to this session.
createFlow(XMLMessageListener, ConsumerFlowProperties, EndpointProperties, FlowEventHandler) - Method in interface com.solacesystems.jcsmp.transaction.TransactedSession
Creates a consumer flow within this TransactedSession and associates it to this session.
createMap() - Method in class com.solacesystems.jcsmp.JCSMPFactory
Create maps for use as user properties or as structured payload.
createMap() - Method in interface com.solacesystems.jcsmp.Producer
Create maps for use as user properties or as structured payload.
createMapMessage() - Method in interface com.solacesystems.jcsmp.Producer
Applications use this method to create a MapMessage.
createMessage(Class<M>) - Method in class com.solacesystems.jcsmp.JCSMPFactory
Creates a session-independent message of type M that may be reused and published multiple times.
createMessage(BytesXMLMessage) - Method in class com.solacesystems.jcsmp.JCSMPFactory
Creates a session-independent message that may be published multiple times.
createNonDurableTopicEndpoint() - Method in interface com.solacesystems.jcsmp.JCSMPSession
Creates a non-durable Topic Endpoint.
createNonDurableTopicEndpoint(String) - Method in interface com.solacesystems.jcsmp.JCSMPSession
Creates a non-durable Topic Endpoint based on the given name.
createProducer(ProducerFlowProperties, JCSMPStreamingPublishEventHandler) - Method in interface com.solacesystems.jcsmp.transaction.TransactedSession
Creates a producer flow within this TransactedSession and associates it to this session.
createProducer(ProducerFlowProperties, JCSMPStreamingPublishEventHandler, JCSMPProducerEventHandler) - Method in interface com.solacesystems.jcsmp.transaction.TransactedSession
Creates a producer flow within this TransactedSession and associates it to this session.
createQueue(String) - Method in class com.solacesystems.jcsmp.JCSMPFactory
Creates a new durable/non-temporary Queue instance for name.
createQueue(String, String) - Method in class com.solacesystems.jcsmp.JCSMPFactory
createReplayStartLocationBeginning() - Method in class com.solacesystems.jcsmp.JCSMPFactory
Create a message replay start location to start replay from the oldest message available in the replay log.
createReplayStartLocationDate(Date) - Method in class com.solacesystems.jcsmp.JCSMPFactory
Create a date and time based message replay start location.
createReplicationGroupMessageId(String) - Method in class com.solacesystems.jcsmp.JCSMPFactory
Create a replication group message ID based message replay start location.
createRequestor() - Method in interface com.solacesystems.jcsmp.JCSMPSession
Creates a new Requestor for this Session.
createSendMultipleEntry(XMLMessage, Destination) - Method in class com.solacesystems.jcsmp.JCSMPFactory
Creates a JCSMPSendMultipleEntry from a provided message and destination.
createSession(JCSMPProperties) - Method in class com.solacesystems.jcsmp.JCSMPFactory
Acquires a JCSMPSession implementation for the specified properties in the default Context.
createSession(JCSMPProperties, Context) - Method in class com.solacesystems.jcsmp.JCSMPFactory
Acquires a JCSMPSession and associates it to the given Context.
createSession(JCSMPProperties, Context, SessionEventHandler) - Method in class com.solacesystems.jcsmp.JCSMPFactory
Acquires a JCSMPSession and associates it to the given Context.
createStream() - Method in class com.solacesystems.jcsmp.JCSMPFactory
Create streams for use as structured payload.
createStream() - Method in interface com.solacesystems.jcsmp.Producer
Create streams for use as structured payload.
createStreamMessage() - Method in interface com.solacesystems.jcsmp.Producer
Applications use this method to create a StreamMessage.
createStreamXMLMessage() - Method in interface com.solacesystems.jcsmp.Producer
Deprecated. 
createStreamXMLMessage(InputStream) - Method in interface com.solacesystems.jcsmp.Producer
Deprecated. 
createSubscriberEndpoint(JCSMPSession) - Method in class com.solacesystems.jcsmp.JCSMPFactory
Returns the SubscriberEndpoint for a session.
createTemporaryQueue() - Method in interface com.solacesystems.jcsmp.JCSMPSession
Creates a temporary Queue for this Session.
createTemporaryQueue(String) - Method in interface com.solacesystems.jcsmp.JCSMPSession
Creates a temporary Queue with the given name.
createTemporaryTopic() - Method in interface com.solacesystems.jcsmp.JCSMPSession
Creates a temporary Topic for this Session.
createTextMessage() - Method in interface com.solacesystems.jcsmp.Producer
Applications use this method to create a TextMessage.
createTextXMLMessage() - Method in interface com.solacesystems.jcsmp.Producer
Deprecated. 
createTextXMLMessage(String) - Method in interface com.solacesystems.jcsmp.Producer
Deprecated. 
createTopic(String) - Method in class com.solacesystems.jcsmp.JCSMPFactory
Creates a new Topic instance for name.
createTopic(TopicProperties) - Method in class com.solacesystems.jcsmp.JCSMPFactory
Creates a new Topic instance from props.
createTransactedSession() - Method in interface com.solacesystems.jcsmp.JCSMPSession
Creates a new TransactedSession with the connected appliance.
createUniqueName(String) - Method in class com.solacesystems.jcsmp.JCSMPFactory
Provided for convenience only; creates a unique ID, to be used by applications when naming Topic or Queue instances.
createXMLContentMessage() - Method in interface com.solacesystems.jcsmp.Producer
Applications use this method to create a XMLContentMessage.

D

DEFAULT_SESSION_NAME - Static variable in class com.solacesystems.jcsmp.JCSMPProperties
 
DELETE_IN_PROGRESS - Static variable in class com.solacesystems.jcsmp.JCSMPErrorResponseSubcodeEx
An attempt was made to provision an Endpoint that is being deleted.
deliverEvtsThruBlockingRecv() - Method in class com.solacesystems.jcsmp.CacheSessionProperties
Gets whether the cache request complete event will be delivered through the API's synchronous receive interface.
DeliveryMode - Enum in com.solacesystems.jcsmp
Represents the message delivery mode.
deprovision(Endpoint, long) - Method in interface com.solacesystems.jcsmp.JCSMPSession
Deprovisions an Endpoint on the appliance.
Destination - Interface in com.solacesystems.jcsmp
A Destination object represents an appliance entity, such as a Topic (publish/subscribe) or a Queue (point-to-point), that messages can be sent to.
DestinationUtils - Class in com.solacesystems.jcsmp
Utility class for working with Destinations and marshaling them to Strings (network names).
destroy() - Method in interface com.solacesystems.jcsmp.Context
Closes all sessions in this context and signals Context threads to shutdown.
DIRECT - Static variable in class com.solacesystems.jcsmp.MessageType
Deprecated.
Message type making use of best-effort delivery features.
DISCARD_NOTIFY_SENDER_OFF - Static variable in class com.solacesystems.jcsmp.EndpointProperties
Do not notify sender if a message fails to be enqueued to the endpoint.
DISCARD_NOTIFY_SENDER_ON - Static variable in class com.solacesystems.jcsmp.EndpointProperties
Notify sender if a message fails to be enqueued to the endpoint.
dump() - Method in interface com.solacesystems.jcsmp.XMLMessage
Produces a human-readable dump of the message properties and its contents (can be quite large).
dump(int) - Method in interface com.solacesystems.jcsmp.XMLMessage
Produces a human-readable dump of the message properties and its contents.
DurableTopicEndpoint - Class in com.solacesystems.jcsmp
Identifier for Solace appliance durable Topic Endpoints.
DYNAMIC_CLIENTS_NOT_ALLOWED - Static variable in class com.solacesystems.jcsmp.JCSMPErrorResponseSubcodeEx
The username for the session has not been set, and dynamic clients are not allowed.

E

elements() - Static method in class com.solacesystems.jcsmp.MessageType
Deprecated.
 
elements() - Static method in class com.solacesystems.jcsmp.statistics.RuntimeStatType
 
elements() - Static method in class com.solacesystems.jcsmp.statistics.StatType
 
Endpoint - Interface in com.solacesystems.jcsmp
An Endpoint represents a appliance resource for consuming messages.
ENDPOINT_ALREADY_EXISTS - Static variable in class com.solacesystems.jcsmp.JCSMPErrorResponseSubcodeEx
An attempt was made to provision an Endpoint that already existed.
ENDPOINT_MODIFIED - Static variable in class com.solacesystems.jcsmp.JCSMPErrorResponseSubcodeEx
A transaction failed due to attempting to commit on an Endpoint that changed state.
ENDPOINT_PROPERTY_MISMATCH - Static variable in class com.solacesystems.jcsmp.JCSMPErrorResponseSubcodeEx
An attempt was made to provision an Endpoint that already existed with different properties.
EndpointProperties - Class in com.solacesystems.jcsmp
Endpoint properties used for provisioning durable endpoints, and for provisioning non-durable endpoints created through JCSMPSession.createFlow(XMLMessageListener listener, ConsumerFlowProperties flowProps).
EndpointProperties() - Constructor for class com.solacesystems.jcsmp.EndpointProperties
EndpointProperties constructor using default values of null.
EndpointProperties(Integer, Integer, Integer, Integer) - Constructor for class com.solacesystems.jcsmp.EndpointProperties
EndpointProperties constructor.
EndpointProperties(Integer, Integer, Integer, Integer, Boolean) - Constructor for class com.solacesystems.jcsmp.EndpointProperties
EndpointProperties constructor.
EndpointProperties(Integer, Integer, Integer, Integer, Boolean, Integer) - Constructor for class com.solacesystems.jcsmp.EndpointProperties
EndpointProperties constructor.
EndpointProperties(Integer, Integer, Integer, Integer, Boolean, Integer, Integer) - Constructor for class com.solacesystems.jcsmp.EndpointProperties
EndpointProperties constructor.
equals(Object) - Method in class com.solacesystems.jcsmp.CacheSessionProperties
 
equals(Object) - Method in class com.solacesystems.jcsmp.JCSMPChannelProperties
 
equals(Object) - Method in class com.solacesystems.jcsmp.MessageType
Deprecated.
Test for equality
equals(Object) - Method in class com.solacesystems.jcsmp.Queue
 
equals(Object) - Method in class com.solacesystems.jcsmp.statistics.RuntimeStatType
Test for equality.
equals(Object) - Method in class com.solacesystems.jcsmp.statistics.StatType
Test for equality
equals(Object) - Method in class com.solacesystems.jcsmp.Topic
Tests if equal to another topic.
equals(Object) - Method in class com.solacesystems.jcsmp.TopicEndpoint
 
EventMessage - Interface in com.solacesystems.jcsmp
Base Interface for Event Messages sent through the datapath.

F

FLAG_IGNORE_ALREADY_EXISTS - Static variable in interface com.solacesystems.jcsmp.JCSMPSession
 
FLAG_IGNORE_DOES_NOT_EXIST - Static variable in interface com.solacesystems.jcsmp.JCSMPSession
 
FLOW_UNBOUND - Static variable in class com.solacesystems.jcsmp.JCSMPErrorResponseSubcodeEx
The client operation failed due to UNBOUND consumer flows.
FlowEvent - Enum in com.solacesystems.jcsmp
Flow event types that can be given to the flow event callback handler ( FlowEventHandler) registered for a flow.
FlowEventArgs - Class in com.solacesystems.jcsmp
Represents a flow event notification.
FlowEventArgs(FlowEvent, String, Exception, int) - Constructor for class com.solacesystems.jcsmp.FlowEventArgs
 
FlowEventHandler - Interface in com.solacesystems.jcsmp
A callback handler for flow events.
FlowReceiver - Interface in com.solacesystems.jcsmp
An interface for applications to receive messages from an Endpoint on a Solace appliance.
fromProperties(Properties) - Static method in class com.solacesystems.jcsmp.JCSMPProperties
Construct a new instance of JCSMPProperties from textual Properties.
fromString(String) - Static method in class com.solacesystems.jcsmp.statistics.StatType
Look up a StatType instance from its label.

G

GD_RECONNECT_FAIL_ACTION - Static variable in class com.solacesystems.jcsmp.JCSMPProperties
A string property to define the behavior when the API is unable to reconnect guaranteed delivery after reconnecting the session.
GD_RECONNECT_FAIL_ACTION_AUTO_RETRY - Static variable in class com.solacesystems.jcsmp.JCSMPProperties
Clear the publisher state and reconnect the publisher flow.
GD_RECONNECT_FAIL_ACTION_DISCONNECT - Static variable in class com.solacesystems.jcsmp.JCSMPProperties
Close the session, even if the reconnectRetries is configured to a non-zero value.
GENERATE_RCV_TIMESTAMPS - Static variable in class com.solacesystems.jcsmp.JCSMPProperties
 
GENERATE_SEND_TIMESTAMPS - Static variable in class com.solacesystems.jcsmp.JCSMPProperties
 
GENERATE_SENDER_ID - Static variable in class com.solacesystems.jcsmp.JCSMPProperties
 
GENERATE_SEQUENCE_NUMBERS - Static variable in class com.solacesystems.jcsmp.JCSMPProperties
 
get(String) - Method in interface com.solacesystems.jcsmp.SDTMap
Returns the value mapped to the specified case-sensitive key.
getAccessType() - Method in class com.solacesystems.jcsmp.EndpointProperties
Returns the access type for the endpoint.
getAckMode() - Method in class com.solacesystems.jcsmp.ConsumerFlowProperties
Gets the flow's acknowledgement mode.
getAckThreshold() - Method in class com.solacesystems.jcsmp.ConsumerFlowProperties
Gets the flow's acknowledgement threshold.
getAckTimerInMsecs() - Method in class com.solacesystems.jcsmp.ConsumerFlowProperties
Gets the flow's acknowledgement timer value (in milliseconds).
getApplicationMessageId() - Method in interface com.solacesystems.jcsmp.XMLMessage
Gets the application message ID, a string for an application-specific message identifier.
getApplicationMessageType() - Method in interface com.solacesystems.jcsmp.XMLMessage
Gets the application message type.
getAppMessageID() - Method in interface com.solacesystems.jcsmp.XMLMessage
Deprecated.
getAppMessageType() - Method in interface com.solacesystems.jcsmp.XMLMessage
getAttachmentByteBuffer() - Method in interface com.solacesystems.jcsmp.XMLMessage
Gets a ByteBuffer containing the message's binary attachment.
getAttachmentContentLength() - Method in interface com.solacesystems.jcsmp.XMLMessage
Gets the length of the attachment.
getBoolean(String) - Method in interface com.solacesystems.jcsmp.SDTMap
Returns the Boolean value mapped to the specified case-sensitive key.
getBooleanProperty(String) - Method in class com.solacesystems.jcsmp.JCSMPChannelProperties
 
getBooleanProperty(String) - Method in class com.solacesystems.jcsmp.JCSMPPropertyMap
Searches for the property with the specified key in the property list and converts to Boolean.
getBuildDate() - Method in interface com.solacesystems.common.config.Version
 
getBuildDate() - Method in class com.solacesystems.common.config.VersionBean
 
getBuildTag() - Method in interface com.solacesystems.common.config.Version
 
getBuildTag() - Method in class com.solacesystems.common.config.VersionBean
 
getByte(String) - Method in interface com.solacesystems.jcsmp.SDTMap
Returns the Byte value mapped to the specified case-sensitive key.
getBytes() - Method in interface com.solacesystems.jcsmp.BytesXMLMessage
Gets a byte array with the message content of the XML part.
getBytes(String) - Method in interface com.solacesystems.jcsmp.SDTMap
Returns the byte[] value mapped to the specified case-sensitive key.
getCacheName() - Method in class com.solacesystems.jcsmp.CacheSessionProperties
Gets the cache name of the cache to send the request to.
getCacheRequestException() - Method in interface com.solacesystems.jcsmp.CacheEventMessage
Returns the exception that occurred when a cache request failed.
getCacheRequestId() - Method in interface com.solacesystems.jcsmp.XMLMessage
Return the request ID set in the cache request.
getCacheRequestResult() - Method in interface com.solacesystems.jcsmp.CacheEventMessage
Returns the result of the cache request.
getCacheRequestTopic() - Method in interface com.solacesystems.jcsmp.CacheEventMessage
Returns the topic the cache data was for.
getCacheTopic() - Method in class com.solacesystems.jcsmp.CacheSessionProperties
Gets the Topic for the cache request.
getCapability(CapabilityType) - Method in interface com.solacesystems.jcsmp.JCSMPSession
Gets the value of a capability for the currently connected Session.
getCause() - Method in exception com.solacesystems.jcsmp.StaleSessionException
 
getCharacter(String) - Method in interface com.solacesystems.jcsmp.SDTMap
Returns the Character value mapped to the specified case-sensitive key.
getCompressionLevel() - Method in class com.solacesystems.jcsmp.JCSMPChannelProperties
 
getConnectionInfoString() - Method in exception com.solacesystems.jcsmp.JCSMPErrorResponseException
 
getConnectRetries() - Method in class com.solacesystems.jcsmp.JCSMPChannelProperties
 
getConnectRetriesPerHost() - Method in class com.solacesystems.jcsmp.JCSMPChannelProperties
 
getConnectTimeoutInMillis() - Method in class com.solacesystems.jcsmp.JCSMPChannelProperties
 
getConsumerDefaultFlowCongestionLimit() - Method in class com.solacesystems.jcsmp.JCSMPGlobalProperties
Gets the default consumer's congestion limit.
getConsumerDefaultFlowUncongestedLimit() - Method in class com.solacesystems.jcsmp.JCSMPGlobalProperties
Gets the default consumer's uncongested threshold (calculated as 0.2 * getConsumerDefaultFlowCongestionLimit()).
getConsumerDispatcherQueueSize() - Method in class com.solacesystems.jcsmp.JCSMPGlobalProperties
Gets the size of the consumer notification dispatcher queue.
getConsumerIdList() - Method in interface com.solacesystems.jcsmp.XMLMessage
Gets a read-only list of consumer IDs set on this message.
getContentLength() - Method in interface com.solacesystems.jcsmp.XMLMessage
The length of the message content.
getCorrelationId() - Method in interface com.solacesystems.jcsmp.XMLMessage
Gets the correlation ID.
getCorrelationKey() - Method in interface com.solacesystems.jcsmp.XMLMessage
Gets the correlation key for the message.
getCos() - Method in interface com.solacesystems.jcsmp.XMLMessage
Gets the Class of Service (CoS) value for this message.
getData() - Method in interface com.solacesystems.jcsmp.BytesMessage
Gets the message content of the attachment part.
getDate() - Method in interface com.solacesystems.jcsmp.ReplayStartLocationDate
 
getDefaultContext() - Method in class com.solacesystems.jcsmp.JCSMPFactory
Returns a reference to the default Context.
getDeliverToOne() - Method in interface com.solacesystems.jcsmp.XMLMessage
Deprecated. 
getDeliveryCount() - Method in interface com.solacesystems.jcsmp.XMLMessage
Get message delivery count.
getDeliveryMode() - Method in interface com.solacesystems.jcsmp.XMLMessage
Gets the delivery mode of the message.
getDescription(int) - Static method in class com.solacesystems.jcsmp.JCSMPErrorResponseSubcodeEx
Deprecated.
This method is no longer supported, and its use is discouraged. Refer to API documentation for explanations of these error subcodes.
getDestination() - Method in interface com.solacesystems.jcsmp.FlowReceiver
Returns the Destination to which messages should be published to get routed to this flow's bound Endpoint.
getDestination() - Method in interface com.solacesystems.jcsmp.JCSMPSendMultipleEntry
Gets the destination to send the message to.
getDestination(String) - Method in interface com.solacesystems.jcsmp.SDTMap
Returns the Destination value mapped to the specified case-sensitive key.
getDestination() - Method in interface com.solacesystems.jcsmp.XMLMessage
Gets the destination this message was published to.
getDestinationTopicSuffix() - Method in interface com.solacesystems.jcsmp.XMLMessage
Returns the string, without a leading delimiter, that is found after the session's default ReplyTo base topic in an incoming message.
getDiscardBehavior() - Method in class com.solacesystems.jcsmp.EndpointProperties
Whether to notify sender if a message fails to be enqueued to the endpoint.
getDiscardIndication() - Method in interface com.solacesystems.jcsmp.XMLMessage
Returns true if one or more messages have been discarded prior to the current message, else false.
getDouble(String) - Method in interface com.solacesystems.jcsmp.SDTMap
Returns the Double value mapped to the specified case-sensitive key.
getEncodedName(Destination) - Method in class com.solacesystems.jcsmp.DestinationUtils
getEndpoint() - Method in class com.solacesystems.jcsmp.BrowserProperties
Returns the Endpoint to browse.
getEndpoint() - Method in class com.solacesystems.jcsmp.ConsumerFlowProperties
Gets the remote Endpoint to bind to.
getEndpoint() - Method in interface com.solacesystems.jcsmp.FlowReceiver
Returns the appliance Endpoint this flow is bound to.
getEvent() - Method in class com.solacesystems.jcsmp.FlowEventArgs
Gets the type of the event.
getEvent() - Method in class com.solacesystems.jcsmp.ProducerEventArgs
Gets the type of the event.
getEvent() - Method in class com.solacesystems.jcsmp.SessionEventArgs
Gets the type of the event.
getEventObject() - Method in class com.solacesystems.jcsmp.ProducerEventArgs
 
getException() - Method in class com.solacesystems.jcsmp.FlowEventArgs
Gets the optional exception that raised the event, null if not applicable.
getException() - Method in class com.solacesystems.jcsmp.ProducerEventArgs
Gets the optional exception that raised the event, null if unapplicable.
getException() - Method in class com.solacesystems.jcsmp.SessionEventArgs
Gets the optional exception that raised the event, null if unapplicable.
getExpiration() - Method in interface com.solacesystems.jcsmp.XMLMessage
The UTC time (in milliseconds, from midnight, January 1, 1970 UTC) when the message is supposed to expire.
getExtraInfo() - Method in exception com.solacesystems.jcsmp.JCSMPException
 
getFloat(String) - Method in interface com.solacesystems.jcsmp.SDTMap
Returns the Float value mapped to the specified case-sensitive key.
getGlobalProperties() - Method in class com.solacesystems.jcsmp.JCSMPFactory
Gets a copy of the JCSMPGlobalProperties instance for this factory.
getHTTPContentEncoding() - Method in interface com.solacesystems.jcsmp.XMLMessage
Gets the HTTP content encoding header value from interaction with an HTTP client.
getHTTPContentType() - Method in interface com.solacesystems.jcsmp.XMLMessage
Gets the HTTP content type header value from interaction with an HTTP client.
getInfo() - Method in class com.solacesystems.jcsmp.FlowEventArgs
Gets the optional string providing additional information about the event, null if unavailable.
getInfo() - Method in class com.solacesystems.jcsmp.ProducerEventArgs
Gets the optional string providing additional information about the event, null if unavailable.
getInfo() - Method in class com.solacesystems.jcsmp.SessionEventArgs
Gets the optional string providing additional information about the event, null if unavailable.
getInteger(String) - Method in interface com.solacesystems.jcsmp.SDTMap
Returns the Integer value mapped to the specified case-sensitive key.
getIntegerProperty(String) - Method in class com.solacesystems.jcsmp.JCSMPChannelProperties
 
getIntegerProperty(String) - Method in class com.solacesystems.jcsmp.JCSMPPropertyMap
Searches for the property with the specified key in the property list and converts to Integer.
getJCSMPSession() - Method in interface com.solacesystems.jcsmp.CacheSession
Gets the JCSMPSession that created this CacheSession.
getKeepAliveIntervalInMillis() - Method in class com.solacesystems.jcsmp.JCSMPChannelProperties
 
getKeepAliveLimit() - Method in class com.solacesystems.jcsmp.JCSMPChannelProperties
 
getLastStatsReset() - Method in class com.solacesystems.jcsmp.JCSMPStats
Gets the date/time of the last reset of this instance.
getLong(String) - Method in interface com.solacesystems.jcsmp.SDTMap
Returns the Long value mapped to the specified case-sensitive key.
getMap() - Method in interface com.solacesystems.jcsmp.MapMessage
Gets the message content.
getMap(String) - Method in interface com.solacesystems.jcsmp.SDTMap
Returns the SDTMap value mapped to the specified case-sensitive key.
getMaxAge() - Method in class com.solacesystems.jcsmp.CacheSessionProperties
Gets the maximum message age (in seconds).
getMaxMsgRedelivery() - Method in class com.solacesystems.jcsmp.EndpointProperties
Defines the maximum message redelivery count on the queue or topic endpoint.
getMaxMsgs() - Method in class com.solacesystems.jcsmp.CacheSessionProperties
Gets the maximum messages per Topic.
getMaxMsgSize() - Method in class com.solacesystems.jcsmp.EndpointProperties
Returns the maximum message size for the endpoint.
getMessage() - Method in interface com.solacesystems.jcsmp.JCSMPSendMultipleEntry
Gets the message to send.
getMessageConsumer(XMLMessageListener) - Method in interface com.solacesystems.jcsmp.JCSMPSession
Get an instance of XMLMessageConsumer.
getMessageConsumer() - Method in interface com.solacesystems.jcsmp.JCSMPSession
getMessageConsumer(JCSMPReconnectEventHandler, XMLMessageListener) - Method in interface com.solacesystems.jcsmp.JCSMPSession
Get an instance of XMLMessageConsumer with a reconnect event handler.
getMessageConsumer(JCSMPReconnectEventHandler) - Method in interface com.solacesystems.jcsmp.JCSMPSession
getMessageConsumer(SubscriptionStateProvider, XMLMessageListener) - Method in interface com.solacesystems.jcsmp.JCSMPSession
Deprecated.
Subscriptions out-of-sync checking is no longer supported. This method will be removed in a future version.
getMessageConsumer(SubscriptionStateProvider) - Method in interface com.solacesystems.jcsmp.JCSMPSession
getMessageConsumer(SubscriptionStateProvider, JCSMPReconnectEventHandler, XMLMessageListener) - Method in interface com.solacesystems.jcsmp.JCSMPSession
Deprecated.
Subscriptions out-of-sync checking is no longer supported. This method will be removed in a future version.
getMessageConsumer(SubscriptionStateProvider, JCSMPReconnectEventHandler) - Method in interface com.solacesystems.jcsmp.JCSMPSession
getMessageId() - Method in interface com.solacesystems.jcsmp.XMLMessage
Deprecated.
Use XMLMessage.ackMessage() to acknowledge messages. The message ID is only to be used for the purpose of acknowledgements. No other meaning should be inferred from the value of the guaranteed message ID.

Returns the message ID set by JCSMP during send or reception. The message ID is the String representation of a 64-bit unsigned integer value identifying the message.

On the receiving side, if messages received do not have message ID set by the appliance, JCSMP automatically assigns one and guarantees its uniqueness for a particular <subscriber; message type>.

Guaranteed messages delivered from the appliance have a appliance-assigned message ID. Messages sent or received over the Direct delivery mode are assigned a message ID by the API, but its value is not meaningful.

getMessageIdLong() - Method in interface com.solacesystems.jcsmp.XMLMessage
Deprecated.
Use XMLMessage.ackMessage() to acknowledge messages. The message ID is only to be used for the purpose of acknowledgements. No other meaning should be inferred from the value of the guaranteed message ID.

Returns the message ID set by JCSMP during send or reception. For discussion of message ID assignment, see XMLMessage.getMessageId().

getMessageListener() - Method in interface com.solacesystems.jcsmp.XMLMessageConsumer
Gets the message consumer's message listener.
getMessageProducer(JCSMPStreamingPublishEventHandler) - Method in interface com.solacesystems.jcsmp.JCSMPSession
Get an instance of XMLMessageProducer.
getMessageProducer(JCSMPStreamingPublishEventHandler, JCSMPProducerEventHandler) - Method in interface com.solacesystems.jcsmp.JCSMPSession
Get an instance of XMLMessageProducer.
getMessageProducer() - Method in interface com.solacesystems.jcsmp.JCSMPSession
Deprecated.
Please see JCSMPSession.getMessageProducer(JCSMPStreamingPublishEventHandler). Note that using this deprecated method can introduce a performance penalty during a streaming publishing Session because it forces the appliance to transmit acknowledgements to every message. Using the recommended JCSMPSession.getMessageProducer(JCSMPStreamingPublishEventHandler) form eliminates this problem.
getMessageType() - Method in interface com.solacesystems.jcsmp.XMLMessage
Deprecated.
See XMLMessage.getDeliveryMode(). Gets the type of the message. Valid types are enumerated in MessageType:
  • MessageType.NON_PERSISTENT
  • MessageType.PERSISTENT
  • MessageType.DIRECT (default)
getName() - Method in class com.solacesystems.jcsmp.ClientName
 
getName() - Method in class com.solacesystems.jcsmp.ContextProperties
Gets the name of the Context.
getName() - Method in interface com.solacesystems.jcsmp.Destination
Gets the destination name specified at creation time.
getName() - Method in interface com.solacesystems.jcsmp.Endpoint
Gets the name of the Endpoint.
getName() - Method in class com.solacesystems.jcsmp.Queue
 
getName() - Method in class com.solacesystems.jcsmp.SubscriberEndpoint
 
getName() - Method in class com.solacesystems.jcsmp.TopicEndpoint
 
getName() - Method in class com.solacesystems.jcsmp.TopicProperties
Gets the name of this Topic.
getName() - Method in interface com.solacesystems.jcsmp.transaction.TransactedSession
Gets the name of this session.
getNetworkName(Destination) - Method in class com.solacesystems.jcsmp.DestinationUtils
Returns the String representing a Queue or Topic destination in an encoded network name form.
getNewSubscription() - Method in class com.solacesystems.jcsmp.ConsumerFlowProperties
If binding to a TopicEndpoint, the subscription to set on the Endpoint.
getNext() - Method in interface com.solacesystems.jcsmp.Browser
Retrieve the next message from the Browser's local message buffer, if one is available, waiting if necessary up to the timeout configured in BrowserProperties.
getNext(int) - Method in interface com.solacesystems.jcsmp.Browser
Retrieve the next message from the Browser's local message buffer, if one is available, waiting if necessary up to timeoutInMillis ms.
getNextNoWait() - Method in interface com.solacesystems.jcsmp.Browser
If there is at least one message available in the Browser's local message buffer, return it immediately; otherwise, return null.
getNumOfSubscriptions() - Method in class com.solacesystems.jcsmp.SubscriptionState
Deprecated.
 
getPermission() - Method in class com.solacesystems.jcsmp.EndpointProperties
Returns the permission for this endpoint.
getPriority() - Method in interface com.solacesystems.jcsmp.XMLMessage
Returns priority value in the range of 0–255, or -1 if it is not set.
getProducerDispatcherQueueSize() - Method in class com.solacesystems.jcsmp.JCSMPGlobalProperties
Gets the size of the producer notification dispatcher queue.
getProperties() - Method in interface com.solacesystems.jcsmp.CacheSession
Gets the properties for this Session.
getProperties() - Method in class com.solacesystems.jcsmp.JCSMPChannelProperties
 
getProperties() - Method in class com.solacesystems.jcsmp.JCSMPPropertyMap
Returns the property map.
getProperties() - Method in interface com.solacesystems.jcsmp.XMLMessage
Gets the user properties map.
getProperty(String) - Method in class com.solacesystems.jcsmp.JCSMPChannelProperties
 
getProperty(String) - Method in class com.solacesystems.jcsmp.JCSMPPropertyMap
Searches for the property with the specified key in the property list.
getProperty(String) - Method in interface com.solacesystems.jcsmp.JCSMPSession
Gets a Session property.
getProperty() - Method in exception com.solacesystems.jcsmp.PropertyMismatchException
Gets the property that caused the mismatch exception.
getPropertyValue() - Method in exception com.solacesystems.jcsmp.PropertyMismatchException
Gets the property value that caused the mismatch exception.
getQuota() - Method in class com.solacesystems.jcsmp.EndpointProperties
Returns the quota for the endpoint.
getReadTimeoutInMillis() - Method in class com.solacesystems.jcsmp.JCSMPChannelProperties
 
getReceiveBuffer() - Method in class com.solacesystems.jcsmp.JCSMPChannelProperties
 
getReceiveTimestamp() - Method in interface com.solacesystems.jcsmp.XMLMessage
Gets the receive timestamp (in milliseconds, from midnight, January 1, 1970 UTC).
getReconnectFreqManagerMaxReconnects() - Method in class com.solacesystems.jcsmp.JCSMPGlobalProperties
Gets the maximum number of reconnects to allow before the reconnect frequency manager kills a connection.
getReconnectRetries() - Method in class com.solacesystems.jcsmp.JCSMPChannelProperties
 
getReconnectRetryIntervalInMsecs() - Method in class com.solacesystems.jcsmp.BrowserProperties
Gets how much time (in ms) to wait between each attempt to reconnect to an endpoint.
getReconnectRetryIntervalInMsecs() - Method in class com.solacesystems.jcsmp.ConsumerFlowProperties
Gets how much time (in ms) to wait between each attempt to reconnect to an endpoint.
getReconnectRetryWaitInMillis() - Method in class com.solacesystems.jcsmp.JCSMPChannelProperties
 
getReconnectTries() - Method in class com.solacesystems.jcsmp.BrowserProperties
Gets number of times to attempt to reconnect to an endpoint after the initial bound flow goes down.
getReconnectTries() - Method in class com.solacesystems.jcsmp.ConsumerFlowProperties
Gets number of times to attempt to reconnect to an endpoint after the initial bound flow goes down.
getRedelivered() - Method in interface com.solacesystems.jcsmp.XMLMessage
Indicates if the message has been delivered by the appliance to the API before.
getReplayStartLocation() - Method in class com.solacesystems.jcsmp.ConsumerFlowProperties
Gets the message replay start location, or null if it is not set.
getReplicationGroupMessageId() - Method in interface com.solacesystems.jcsmp.XMLMessage
Get the Replication Group Message ID for the received message.
getReplyTo() - Method in interface com.solacesystems.jcsmp.XMLMessage
Gets the replyTo destination
getReplyToSuffix() - Method in interface com.solacesystems.jcsmp.XMLMessage
Returns the appended suffix to the session's default ReplyTo base topic set as part of this message's ReplyTo topic destination.
getResponseBody() - Method in exception com.solacesystems.jcsmp.JCSMPErrorResponseException
 
getResponseCode() - Method in class com.solacesystems.jcsmp.FlowEventArgs
Gets the optional appliance response code, 0 if unavailable.
getResponseCode() - Method in exception com.solacesystems.jcsmp.JCSMPErrorResponseException
 
getResponseCode() - Method in exception com.solacesystems.jcsmp.JCSMPLoginFailureException
Get the SMF response code.
getResponseCode() - Method in class com.solacesystems.jcsmp.ProducerEventArgs
Gets the optional appliance response code, 0 if unavailable.
getResponseCode() - Method in class com.solacesystems.jcsmp.SessionEventArgs
Gets the optional appliance response code, 0 if unavailable.
getResponsePhrase() - Method in exception com.solacesystems.jcsmp.JCSMPErrorResponseException
 
getResponsePhrase() - Method in exception com.solacesystems.jcsmp.JCSMPLoginFailureException
Get the response phrase.
getSegmentMsgQueueName() - Method in exception com.solacesystems.jcsmp.JCSMPIncompleteLargeMessageReceivedException
 
getSegmentMsgSelector() - Method in exception com.solacesystems.jcsmp.JCSMPIncompleteLargeMessageReceivedException
 
getSelector() - Method in class com.solacesystems.jcsmp.BrowserProperties
Returns the browse selector string.
getSelector() - Method in class com.solacesystems.jcsmp.ConsumerFlowProperties
Gets the message selector, if one is set.
getSendBuffer() - Method in class com.solacesystems.jcsmp.JCSMPChannelProperties
 
getSenderID() - Method in interface com.solacesystems.jcsmp.XMLMessage
Deprecated.
getSenderId() - Method in interface com.solacesystems.jcsmp.XMLMessage
Returns the Sender's ID.
getSenderTimestamp() - Method in interface com.solacesystems.jcsmp.XMLMessage
Gets the send timestamp (in milliseconds, from midnight, January 1, 1970 UTC).
getSendTimestamp() - Method in interface com.solacesystems.jcsmp.XMLMessage
Deprecated.
getSequenceNumber() - Method in interface com.solacesystems.jcsmp.XMLMessage
Gets the sequence number.
getSessionName() - Method in interface com.solacesystems.jcsmp.Session
If the session name is specified by JCSMPProperties.SESSION_NAME, this method returns the name specified.
getSessionStats() - Method in interface com.solacesystems.jcsmp.Session
Get this session's statistics.
getShort(String) - Method in interface com.solacesystems.jcsmp.SDTMap
Returns the Short value mapped to the specified case-sensitive key.
getSignalMsgDump() - Method in exception com.solacesystems.jcsmp.JCSMPIncompleteLargeMessageReceivedException
 
getSignalMsgQueueName() - Method in exception com.solacesystems.jcsmp.JCSMPIncompleteLargeMessageReceivedException
 
getSignalMsgSelector() - Method in exception com.solacesystems.jcsmp.JCSMPIncompleteLargeMessageReceivedException
 
getSmfPort() - Method in class com.solacesystems.jcsmp.JCSMPChannelProperties
Deprecated.
Use of this setting is discouraged, the recommended way of selecting ports is through the "Host:Port" syntax of the JCSMPProperties.HOST property.
getStack() - Method in class com.solacesystems.jcsmp.JCSMPChannelProperties
 
getStat(StatType) - Method in class com.solacesystems.jcsmp.JCSMPStats
Poll a specific statistic.
getStatus() - Method in interface com.solacesystems.jcsmp.transaction.TransactedSession
Gets the status of the current transaction.
getStream(String) - Method in interface com.solacesystems.jcsmp.SDTMap
Returns the SDTStream value mapped to the specified case-sensitive key.
getStream() - Method in interface com.solacesystems.jcsmp.StreamMessage
Gets the message content.
getStream() - Method in interface com.solacesystems.jcsmp.StreamXMLMessage
Deprecated.
Get the InputStream from which the message content can be read.
getStreamingCallbackHandler() - Method in interface com.solacesystems.jcsmp.Producer
Deprecated. 
getString(String) - Method in interface com.solacesystems.jcsmp.SDTMap
Returns the String value mapped to the specified case-sensitive key.
getStringProperty(String) - Method in class com.solacesystems.jcsmp.JCSMPChannelProperties
 
getStringProperty(String) - Method in class com.solacesystems.jcsmp.JCSMPPropertyMap
Searches for the property with the specified key in the property list and converts to String.
getSubcode() - Method in exception com.solacesystems.jcsmp.JCSMPErrorResponseException
getSubcode() - Method in exception com.solacesystems.jcsmp.JCSMPFlowTransportUnsolicitedUnbindException
Gets the normalized subcode (JCSMPErrorResponseSubcodeEx).
getSubcodeAsString(int) - Static method in class com.solacesystems.jcsmp.JCSMPErrorResponseSubcodeEx
Gets the name of the subcode (useful for logging subcodes).
getSubcodeEx() - Method in exception com.solacesystems.jcsmp.JCSMPErrorResponseException
Gets the normalized subcode (JCSMPErrorResponseSubcodeEx) for this error response.
getSubscription() - Method in interface com.solacesystems.jcsmp.FlowReceiver
Returns the subscription associated to the Endpoint when bound to a TopicEndpoint.
getSubscriptionCache() - Method in interface com.solacesystems.jcsmp.JCSMPSession
Gets an unmodifiable view of the Session's subscription cache.
getSubscriptionState() - Method in interface com.solacesystems.jcsmp.SubscriptionStateProvider
Deprecated.
This method returns the most recent subscription state of a subscriber.
getSupportedMaxNumOfXpesInOneRequest() - Method in class com.solacesystems.jcsmp.JCSMPRuntime
Deprecated. 
getSupportedProtocolStacks() - Method in class com.solacesystems.jcsmp.JCSMPRuntime
 
getSwVersion() - Method in interface com.solacesystems.common.config.Version
 
getSwVersion() - Method in class com.solacesystems.common.config.VersionBean
 
getText() - Method in interface com.solacesystems.jcsmp.TextMessage
Gets the message content.
getText() - Method in interface com.solacesystems.jcsmp.TextXMLMessage
Deprecated.
Get the message content as text.
getTimeout() - Method in class com.solacesystems.jcsmp.CacheSessionProperties
Gets the timeout for a cache request (in milliseconds).
getTimeToLive() - Method in interface com.solacesystems.jcsmp.XMLMessage
The number of milliseconds before the message is discarded or moved to Dead Message Queue.
getTitle() - Method in class com.solacesystems.jcsmp.JCSMPStats
Gets the title this instance of JCSMPStats was initialized with.
getTopicSequenceNumber() - Method in interface com.solacesystems.jcsmp.XMLMessage
Gets the topic sequence number generated by the appliance.
getTransportWindowSize() - Method in class com.solacesystems.jcsmp.BrowserProperties
The TransportWindowSize affects the number of local messages that are pre-fetched by the Browser.
getTransportWindowSize() - Method in class com.solacesystems.jcsmp.ConsumerFlowProperties
Returns the Guaranteed message transport window size for the flow.
getUserData() - Method in interface com.solacesystems.jcsmp.XMLMessage
When an application sends a message, it can optionally attach application-specific data along with the message, such as user data.
getValueType() - Method in enum com.solacesystems.jcsmp.CapabilityType
The type of value returned when accessing this capability.
getVersion() - Method in class com.solacesystems.jcsmp.JCSMPRuntime
Get the version of the JCSMP API.
getVirtualRouterName() - Method in class com.solacesystems.jcsmp.ClientName
Not available for ClientName.
getVirtualRouterName() - Method in interface com.solacesystems.jcsmp.Endpoint
The virtual router name identifier for the Endpoint.
getVirtualRouterName() - Method in class com.solacesystems.jcsmp.SubscriberEndpoint
 
getVirtualRouterName() - Method in class com.solacesystems.jcsmp.TopicEndpoint
 
getWaitTimeout() - Method in class com.solacesystems.jcsmp.BrowserProperties
Returns the WaitTimeout in msecs.
getWindowSize() - Method in class com.solacesystems.jcsmp.ProducerFlowProperties
The size of the sliding publisher window for Guaranteed messages.
getXMLContent() - Method in interface com.solacesystems.jcsmp.XMLContentMessage
Gets the message content.

H

handleError(Object, Exception) - Method in interface com.solacesystems.jcsmp.JCSMPResponseListener
This method is invoked whenever a subscription operation fails.
handleError(String, JCSMPException, long) - Method in interface com.solacesystems.jcsmp.JCSMPStreamingPublishCorrelatingEventHandler
 
handleError(String, JCSMPException, long) - Method in interface com.solacesystems.jcsmp.JCSMPStreamingPublishEventHandler
Deprecated.
Use JCSMPStreamingPublishCorrelatingEventHandler instead. This method is invoked during streaming publishing if there is an error in reading the response, or if a non-OK response is read.

Note: Handler processing should be kept to a minimum because it blocks the thread from which the error originated.

Error responses from the appliance

If an error response is available, it is represented as a JCSMPErrorResponseException. The subcodes discussed in JCSMPStreamingPublishCorrelatingEventHandler might be present to provide further information about why the message was rejected.
handleErrorEx(Object, JCSMPException, long) - Method in interface com.solacesystems.jcsmp.JCSMPStreamingPublishCorrelatingEventHandler
This method is invoked during streaming publishing if there is an error in reading the response, or if a non-OK response is read.
handleEvent(Object, FlowEventArgs) - Method in interface com.solacesystems.jcsmp.FlowEventHandler
Called when a flow event notification is available.
handleEvent(ProducerEventArgs) - Method in interface com.solacesystems.jcsmp.JCSMPProducerEventHandler
Called when a producer event notification is available.
handleEvent(SessionEventArgs) - Method in interface com.solacesystems.jcsmp.SessionEventHandler
Called when a session event notification is available.
handleSuccess(Object) - Method in interface com.solacesystems.jcsmp.JCSMPResponseListener
This method is invoked whenever an OK subscription response is received.
hasAttachment() - Method in interface com.solacesystems.jcsmp.XMLMessage
Checks whether the message has an attachment.
hasContent() - Method in interface com.solacesystems.jcsmp.XMLMessage
Checks whether the message has content.
hashCode() - Method in class com.solacesystems.jcsmp.CacheSessionProperties
 
hashCode() - Method in class com.solacesystems.jcsmp.JCSMPChannelProperties
 
hashCode() - Method in class com.solacesystems.jcsmp.MessageType
Deprecated.
 
hashCode() - Method in class com.solacesystems.jcsmp.Topic
Gets the hashcode.
hashCode() - Method in class com.solacesystems.jcsmp.TopicEndpoint
 
hasMore() - Method in interface com.solacesystems.jcsmp.Browser
Returns true if there is at least one message available in the Browser's local message buffer.
hasRemaining() - Method in interface com.solacesystems.jcsmp.SDTStream
Returns true if there is more to be read on the stream.
hasUserData() - Method in interface com.solacesystems.jcsmp.XMLMessage
Checks whether a received message includes user data.
HOST - Static variable in class com.solacesystems.jcsmp.JCSMPProperties
The IP address (or host name) to connect to.

I

IGNORE_DUPLICATE_SUBSCRIPTION_ERROR - Static variable in class com.solacesystems.jcsmp.JCSMPProperties
 
IGNORE_SUBSCRIPTION_NOT_FOUND_ERROR - Static variable in class com.solacesystems.jcsmp.JCSMPProperties
 
IN_PROGRESS - Static variable in class com.solacesystems.jcsmp.JCSMPErrorResponseSubcodeEx
Operation is in progress.
INVALID_FLOWID - Static variable in class com.solacesystems.jcsmp.JCSMPErrorResponseSubcodeEx
The client has attempted to unbind from a FlowId which the client is not bound to - 400 Invalid FlowId
INVALID_PARAMETER_COMBINATION - Static variable in class com.solacesystems.jcsmp.JCSMPErrorResponseSubcodeEx
An attempt was made to provision a #DEAD_MSG_QUEUE with respectTTL set to true.
INVALID_TOPIC_NAME_FOR_TE - Static variable in class com.solacesystems.jcsmp.JCSMPErrorResponseSubcodeEx
An attempt was made to bind to a Topic Endpoint with an invalid Topic.
INVALID_TOPIC_SYNTAX - Static variable in class com.solacesystems.jcsmp.JCSMPErrorResponseSubcodeEx
An attempt was made to use a topic that uses a syntax that is not supported.
INVALID_TRANSACTION_ID - Static variable in class com.solacesystems.jcsmp.JCSMPErrorResponseSubcodeEx
A transaction failed due to attempting to commit with an invalid or expired transaction ID.
INVALID_VIRTUAL_ADDRESS - Static variable in class com.solacesystems.jcsmp.JCSMPErrorResponseSubcodeEx
An attempt was made to connect to wrong IP address on appliance (must use CVRID if configured).
InvalidMessageReceivedException - Exception in com.solacesystems.jcsmp
InvalidMessageReceivedException is raised when the message received from the Solace appliance is not valid.
InvalidMessageReceivedException(String) - Constructor for exception com.solacesystems.jcsmp.InvalidMessageReceivedException
 
InvalidOperationException - Exception in com.solacesystems.jcsmp
InvalidOperationException indicates that the requested operation cannot be fulfilled because the object on which it was performed is not in a state to support such an operation.
InvalidOperationException(String) - Constructor for exception com.solacesystems.jcsmp.InvalidOperationException
 
InvalidOperationException(String, Throwable) - Constructor for exception com.solacesystems.jcsmp.InvalidOperationException
 
InvalidPropertiesException - Exception in com.solacesystems.jcsmp
InvalidPropertiesException indicates invalid properties are specified in JCSMPProperties.
InvalidPropertiesException(String) - Constructor for exception com.solacesystems.jcsmp.InvalidPropertiesException
 
InvalidPropertiesException(String, Throwable) - Constructor for exception com.solacesystems.jcsmp.InvalidPropertiesException
 
isAckImmediately() - Method in interface com.solacesystems.jcsmp.XMLMessage
Test if the ACK Immediately message property is set or not.
isActiveFlowIndication() - Method in class com.solacesystems.jcsmp.ConsumerFlowProperties
Gets the flow's active flow indication state.
isCacheMessage() - Method in interface com.solacesystems.jcsmp.XMLMessage
Returns true if this message was part of a cache reply.
isCapable(CapabilityType) - Method in interface com.solacesystems.jcsmp.JCSMPSession
Checks if the specified capability is set on the currently connected Session.
isClosed() - Method in interface com.solacesystems.jcsmp.CacheSession
Returns true if this cache session has been closed.
isClosed() - Method in interface com.solacesystems.jcsmp.Consumer
Checks if message consumer is closed
isClosed() - Method in interface com.solacesystems.jcsmp.Producer
Checks if message producer is closed
isDMQEligible() - Method in interface com.solacesystems.jcsmp.XMLMessage
The method returns whether the message is eligible to be moved to a Dead Message Queue (DMQ) upon expiration.
isDurable() - Method in class com.solacesystems.jcsmp.ClientName
Not available for ClientName.
isDurable() - Method in interface com.solacesystems.jcsmp.Endpoint
Whether this Endpoint is durable.
isDurable() - Method in class com.solacesystems.jcsmp.Queue
 
isDurable() - Method in class com.solacesystems.jcsmp.SubscriberEndpoint
 
isDurable() - Method in class com.solacesystems.jcsmp.TopicEndpoint
 
isElidingEligible() - Method in interface com.solacesystems.jcsmp.XMLMessage
Checks whether the message is eligible for eliding.
isEmpty() - Method in interface com.solacesystems.jcsmp.SDTMap
Returns true if there are no mappings.
isNoLocal() - Method in class com.solacesystems.jcsmp.ConsumerFlowProperties
Gets the flow's noLocal setting.
isReadOnly() - Method in interface com.solacesystems.jcsmp.XMLMessage
Tests if the message is read only.
isReplyMessage() - Method in interface com.solacesystems.jcsmp.XMLMessage
Returns whether the message's reply field is set, indicating that this message is a reply.
isRespectsMsgTTL() - Method in class com.solacesystems.jcsmp.EndpointProperties
The method returns whether the endpoint respects a message's Time-to-Live (TTL) value.
isRxAllDeliverToOne() - Method in class com.solacesystems.jcsmp.Topic
Deprecated. 
isRxAllDeliverToOne() - Method in class com.solacesystems.jcsmp.TopicProperties
Deprecated. 
isSecureChannel() - Method in class com.solacesystems.jcsmp.JCSMPChannelProperties
Deprecated.
isStartState() - Method in class com.solacesystems.jcsmp.ConsumerFlowProperties
Checks whether a newly created flow should be in the started state upon creation.
isSuspect() - Method in interface com.solacesystems.jcsmp.XMLMessage
Return true if this message was part of a cache reply that had the suspect flag set.
isTcpNoDelay() - Method in class com.solacesystems.jcsmp.JCSMPChannelProperties
 
isTemporary() - Method in interface com.solacesystems.jcsmp.Destination
A flag indicating whether this is a temporary destination.
isTemporary() - Method in class com.solacesystems.jcsmp.Queue
 
isTemporary() - Method in class com.solacesystems.jcsmp.Topic
 

J

JAAS_CONFIG_FILE_RELOAD_ENABLED - Static variable in class com.solacesystems.jcsmp.JCSMPProperties
A boolean property when true indicates that the login configuration file is reloaded before connect or reconnect to the router.
JAAS_LOGIN_CONTEXT - Static variable in class com.solacesystems.jcsmp.JCSMPProperties
A session property that specifies a name that applications use to refer to the entry in a login configuration file when they instantiate a LoginContext.
JCSMPChannelProperties - Class in com.solacesystems.jcsmp
JCSMPChannelProperties describes the properties required to create a channel connection with a Solace appliance.
JCSMPChannelProperties() - Constructor for class com.solacesystems.jcsmp.JCSMPChannelProperties
Construct a default JCSMPChannelProperties.
JCSMPChannelProperties(String, int, int, int, int, int, int) - Constructor for class com.solacesystems.jcsmp.JCSMPChannelProperties
 
JCSMPErrorResponseException - Exception in com.solacesystems.jcsmp
JCSMPErrorResponseException is used to capture Solace Message Format (SMF) response codes.
JCSMPErrorResponseException(int, String, String, String) - Constructor for exception com.solacesystems.jcsmp.JCSMPErrorResponseException
Construct a JCSMPErrorResponseException
JCSMPErrorResponseSubcode - Enum in com.solacesystems.jcsmp
Deprecated.
JCSMPErrorResponseSubcodeEx - Class in com.solacesystems.jcsmp
Subcode that gives more detailed information about an error response.
JCSMPException - Exception in com.solacesystems.jcsmp
The base class of JCSMP exceptions.
JCSMPException(String, Throwable) - Constructor for exception com.solacesystems.jcsmp.JCSMPException
Constructs a JCSMPException with the specified detailed message and nested exception.
JCSMPException(String, Throwable, String) - Constructor for exception com.solacesystems.jcsmp.JCSMPException
Constructs a JCSMPException with the specified detailed message and nested exception.
JCSMPException(String) - Constructor for exception com.solacesystems.jcsmp.JCSMPException
Constructs a JCSMPException with the specified detailed message.
JCSMPFactory - Class in com.solacesystems.jcsmp
Factory for obtaining instances of messaging system entities such as JCSMPSessions, Contexts, Endpoints, Destinations, and Subscriptions.
JCSMPFatalErrorException - Exception in com.solacesystems.jcsmp
JCSMPFatalErrorException indicates an unrecoverable error condition.
JCSMPFatalErrorException(String) - Constructor for exception com.solacesystems.jcsmp.JCSMPFatalErrorException
 
JCSMPFatalErrorException(String, Throwable) - Constructor for exception com.solacesystems.jcsmp.JCSMPFatalErrorException
 
JCSMPFlowTransportException - Exception in com.solacesystems.jcsmp
Indicates a transport error condition for a specific flow, while the parent session is not necessarily closed.
JCSMPFlowTransportException(String) - Constructor for exception com.solacesystems.jcsmp.JCSMPFlowTransportException
Construct an instance with message.
JCSMPFlowTransportException(String, Throwable) - Constructor for exception com.solacesystems.jcsmp.JCSMPFlowTransportException
Construct an instance with cause.
JCSMPFlowTransportUnsolicitedUnbindException - Exception in com.solacesystems.jcsmp
This exception is used to indicate that a Guaranteed Delivery flow (FlowReceiver) was closed by the appliance due to a unsolicited unbind for the resource it requires.
JCSMPFlowTransportUnsolicitedUnbindException(String) - Constructor for exception com.solacesystems.jcsmp.JCSMPFlowTransportUnsolicitedUnbindException
Construct an instance with message.
JCSMPFlowTransportUnsolicitedUnbindException(String, Throwable) - Constructor for exception com.solacesystems.jcsmp.JCSMPFlowTransportUnsolicitedUnbindException
Construct an instance with cause.
JCSMPGlobalProperties - Class in com.solacesystems.jcsmp
This class exposes tunable settings for some of the Messaging API's internal functionality.
JCSMPGlobalProperties() - Constructor for class com.solacesystems.jcsmp.JCSMPGlobalProperties
Constructs a new instance with default values.
JCSMPIncompleteLargeMessageReceivedException - Exception in com.solacesystems.jcsmp
Indicates that an incomplete large message is received due to segments not received in time.
JCSMPIncompleteLargeMessageReceivedException(String, String, String, String, String, String) - Constructor for exception com.solacesystems.jcsmp.JCSMPIncompleteLargeMessageReceivedException
 
JCSMPIncompleteLargeMessageReceivedException(String, Throwable, String, String, String, String, String) - Constructor for exception com.solacesystems.jcsmp.JCSMPIncompleteLargeMessageReceivedException
 
JCSMPInterruptedException - Exception in com.solacesystems.jcsmp
 
JCSMPInterruptedException(String, Throwable) - Constructor for exception com.solacesystems.jcsmp.JCSMPInterruptedException
Create a new JCSMPInterruptedException with message and cause.
JCSMPInterruptedException(String) - Constructor for exception com.solacesystems.jcsmp.JCSMPInterruptedException
Create a new JCSMPInterruptedException with message.
JCSMPLoginFailureException - Exception in com.solacesystems.jcsmp
Indicates a producer or consumer was unable to login to the 3200 Series appliance.
JCSMPLoginFailureException(int, String, int, String) - Constructor for exception com.solacesystems.jcsmp.JCSMPLoginFailureException
Construct a JCSMPLoginFailureException
JCSMPLogLevel - Enum in com.solacesystems.jcsmp
Represents a logging level in org.apache.commons.logging.
JCSMPNotComparableException - Exception in com.solacesystems.jcsmp
NotComparableException indicates that the comparison operation failed because the two objects being compared are semantically not comparable.
JCSMPNotComparableException(String) - Constructor for exception com.solacesystems.jcsmp.JCSMPNotComparableException
 
JCSMPNotComparableException(String, Throwable) - Constructor for exception com.solacesystems.jcsmp.JCSMPNotComparableException
 
JCSMPOperationException - Exception in com.solacesystems.jcsmp
JCSMPOperationException indicates an error condition related to Content Subscription Management Protocol (CSMP) operation.
JCSMPOperationException(String) - Constructor for exception com.solacesystems.jcsmp.JCSMPOperationException
 
JCSMPOperationException(String, Throwable) - Constructor for exception com.solacesystems.jcsmp.JCSMPOperationException
 
JCSMPProducerEventHandler - Interface in com.solacesystems.jcsmp
A callback handler for producer events ProducerEvent.
JCSMPProperties - Class in com.solacesystems.jcsmp
Properties for customizing Session.
JCSMPProperties() - Constructor for class com.solacesystems.jcsmp.JCSMPProperties
Construct a JCSMPProperties object with default settings.
JCSMPProperties(String, int, String, String, SecureSessionProperties) - Constructor for class com.solacesystems.jcsmp.JCSMPProperties
Construct a JCSMPProperties object.
JCSMPPropertyMap - Class in com.solacesystems.jcsmp
 
JCSMPPropertyMap() - Constructor for class com.solacesystems.jcsmp.JCSMPPropertyMap
 
JCSMPReconnectEventHandler - Interface in com.solacesystems.jcsmp
JCSMPReconnectEventHandler is a callback interface called before and after the subscriber data channel is reestablished.
JCSMPRequestTimeoutException - Exception in com.solacesystems.jcsmp
Indicates that a blocking request operation timed out.
JCSMPRequestTimeoutException(String) - Constructor for exception com.solacesystems.jcsmp.JCSMPRequestTimeoutException
 
JCSMPRequestTimeoutException(String, Throwable) - Constructor for exception com.solacesystems.jcsmp.JCSMPRequestTimeoutException
 
JCSMPResponseListener - Interface in com.solacesystems.jcsmp
A callback interface to handle responses from asynchronous subscription operations.
JCSMPResponseTimeoutException - Exception in com.solacesystems.jcsmp
JCSMPResponseTimeoutException is used for client request timeout.
JCSMPResponseTimeoutException(String) - Constructor for exception com.solacesystems.jcsmp.JCSMPResponseTimeoutException
 
JCSMPResponseTimeoutException(String, Throwable) - Constructor for exception com.solacesystems.jcsmp.JCSMPResponseTimeoutException
 
JCSMPRuntime - Class in com.solacesystems.jcsmp
JCSMPRuntime provides JCSMP VM-wide runtime information, such as JCSMP version information, supported protocol stacks, and global statistics.
JCSMPSecurityException - Exception in com.solacesystems.jcsmp
Thrown when a security restriction prevents an operation from being performed.
JCSMPSecurityException(String) - Constructor for exception com.solacesystems.jcsmp.JCSMPSecurityException
Constructs a JCSMPSecurityException with the specified message.
JCSMPSecurityException(String, Throwable) - Constructor for exception com.solacesystems.jcsmp.JCSMPSecurityException
Constructs a JCSMPSecurityException with the specified message and cause.
JCSMPSendMultipleEntry - Interface in com.solacesystems.jcsmp
Represents a {Message, Destination} tuple used as part of a batch send operation.
JCSMPSession - Interface in com.solacesystems.jcsmp
JCSMPSession
JCSMPSessionStats - Class in com.solacesystems.jcsmp
Statistics associated with a Session.
JCSMPSessionStats(JCSMPSession) - Constructor for class com.solacesystems.jcsmp.JCSMPSessionStats
Constructs a JCSMPSessionStats object for a session.
JCSMPSessionStats() - Constructor for class com.solacesystems.jcsmp.JCSMPSessionStats
 
JCSMPStateException - Exception in com.solacesystems.jcsmp
JCSMPStateException indicates that the program logic cannot proceed based on the current JCSMPSession state.
JCSMPStateException(String) - Constructor for exception com.solacesystems.jcsmp.JCSMPStateException
 
JCSMPStateException(String, Throwable) - Constructor for exception com.solacesystems.jcsmp.JCSMPStateException
 
JCSMPStats - Class in com.solacesystems.jcsmp
Represents a set of message statistics.
JCSMPStats(String) - Constructor for class com.solacesystems.jcsmp.JCSMPStats
Constructs a JCSMPSessionStats object.
JCSMPStreamingPublishCorrelatingEventHandler - Interface in com.solacesystems.jcsmp
A callback interface to handle responses from send operations asynchronously.
JCSMPStreamingPublishEventHandler - Interface in com.solacesystems.jcsmp
Deprecated.
Use JCSMPStreamingPublishCorrelatingEventHandler instead. MessageIDs used to identify published messages by the interface can changed between publish and acknowledgement in the event of a DR failover.

Therefore, it is recommended that applications use its extension JCSMPStreamingPublishCorrelatingEventHandler instead.

By providing an implementation of JCSMPStreamingPublishEventHandler to Producer, an application can send messages without waiting for responses (streaming publishing mode). The response (when applicable) of the send operation is delivered asynchronously through this callback handler, however in the event of a DR failover the messageID may have changed and so cannot be used.

JCSMPTransportException - Exception in com.solacesystems.jcsmp
JCSMPTransportException indicates an error condition regarding communication with the Solace appliance.
JCSMPTransportException(String) - Constructor for exception com.solacesystems.jcsmp.JCSMPTransportException
 
JCSMPTransportException(String, Throwable) - Constructor for exception com.solacesystems.jcsmp.JCSMPTransportException
 
JCSMPVersion - Class in com.solacesystems.jcsmp
JCSMP version information.
JCSMPVersion() - Constructor for class com.solacesystems.jcsmp.JCSMPVersion
Constructs a JCSMP Version object.

K

KEEP_ALIVE_INTERVAL_IN_MILLIS - Static variable in class com.solacesystems.jcsmp.JCSMPChannelProperties
 
KEEP_ALIVE_LIMIT - Static variable in class com.solacesystems.jcsmp.JCSMPChannelProperties
 
KERBEROS_AUTHENTICATION_IS_SHUTDOWN - Static variable in class com.solacesystems.jcsmp.JCSMPErrorResponseSubcodeEx
The client attempted to connect to an appliance that has the Kerberos authentication shutdown.
keySet() - Method in interface com.solacesystems.jcsmp.SDTMap
Returns a Set of all the keys in the map.
KRB_SERVICE_DEFAULT - Static variable in class com.solacesystems.jcsmp.JCSMPProperties
 
KRB_SERVICE_NAME - Static variable in class com.solacesystems.jcsmp.JCSMPProperties
 

L

LOCALHOST - Static variable in class com.solacesystems.jcsmp.JCSMPProperties
 
logFlowInfo(JCSMPLogLevel) - Method in interface com.solacesystems.jcsmp.FlowReceiver
Outputs a log containing the flow state information for the flow at a specified log level.
logFlowInfo(JCSMPLogLevel) - Method in interface com.solacesystems.jcsmp.JCSMPSession
Outputs a log at the specified log level that contains the flow state information for flows in this Session.
LOGIN_FAILURE - Static variable in class com.solacesystems.jcsmp.JCSMPErrorResponseSubcodeEx
The client could not login to appliance.
logSessionStats(JCSMPLogLevel) - Method in interface com.solacesystems.jcsmp.Session
Outputs a log at the specified log level containing a textual representation of the session statistics.
LOW_PRIORITY_MSG_CONGESTION - Static variable in class com.solacesystems.jcsmp.JCSMPErrorResponseSubcodeEx
The message was rejected by the appliance if one or more matching endpoints reject-low-priority-msg-limit is exceeded.

M

main(String[]) - Static method in class com.solacesystems.jcsmp.JCSMPVersion
 
MapMessage - Interface in com.solacesystems.jcsmp
MapMessage is used to send a message containing a SDTMap.
mark() - Method in interface com.solacesystems.jcsmp.SDTStream
Marks the current read pointer for later use by reset().
MAX_CLIENTS_FOR_QUEUE - Static variable in class com.solacesystems.jcsmp.JCSMPErrorResponseSubcodeEx
An attempt was made to bind to a Guaranteed Delivery queue that already has already reached its maximum number of clients.
MAX_CLIENTS_FOR_TE - Static variable in class com.solacesystems.jcsmp.JCSMPErrorResponseSubcodeEx
An attempt was made to bind to a Topic Endpoint (TE) that has already reached its maximum number of clients.
MAX_MESSAGE_USAGE_EXCEEDED - Static variable in class com.solacesystems.jcsmp.JCSMPErrorResponseSubcodeEx
The publishing of a message was denied due to exceeding the maximum spooled message count.
MAX_RESENDS - Static variable in class com.solacesystems.jcsmp.JCSMPProperties
Deprecated.
MAX_TRANSACTED_SESSIONS_EXCEEDED - Static variable in class com.solacesystems.jcsmp.JCSMPErrorResponseSubcodeEx
The appliance cannot accept any more transacted sessions.
MAX_TRANSACTIONS_EXCEEDED - Static variable in class com.solacesystems.jcsmp.JCSMPErrorResponseSubcodeEx
The appliance cannot accept any more transactions.
Message - Interface in com.solacesystems.jcsmp
Message describes a message that is sent or received.
MESSAGE_ACK_MODE - Static variable in class com.solacesystems.jcsmp.JCSMPProperties
 
MESSAGE_CALLBACK_ON_REACTOR - Static variable in class com.solacesystems.jcsmp.JCSMPProperties
 
MESSAGE_PUBLISH_FAILURE - Static variable in class com.solacesystems.jcsmp.JCSMPErrorResponseSubcodeEx
A transaction failed due to an error publishing messages.
MESSAGE_TOO_LARGE - Static variable in class com.solacesystems.jcsmp.JCSMPErrorResponseSubcodeEx
The client attempted to send a message larger than that supported by the appliance.
MESSAGES_DISCARDED_INTERNAL - Static variable in class com.solacesystems.jcsmp.statistics.StatType
The number of incoming messages dropped by the API due to their Consumer being stopped.
MESSAGES_REJECTED_BY_APPLIANCE - Static variable in class com.solacesystems.jcsmp.statistics.StatType
The number of messages rejected by the appliance.
MessageType - Class in com.solacesystems.jcsmp
Deprecated.
Replaced by DeliveryMode.
MISMATCHED_ENDPOINT_ERROR_ID - Static variable in class com.solacesystems.jcsmp.JCSMPErrorResponseSubcodeEx
Endpoint error ID in the bind request does not match the endpoint's error ID.
MSG_VPN_NOT_ALLOWED - Static variable in class com.solacesystems.jcsmp.JCSMPErrorResponseSubcodeEx
The Message VPN name set for the session does not exist.
MSG_VPN_UNAVAILABLE - Static variable in class com.solacesystems.jcsmp.JCSMPErrorResponseSubcodeEx
The Message VPN name set for the session (or the default Message VPN, if none was set) is currently shutdown on the appliance.
MSGDUMP_BRIEF - Static variable in interface com.solacesystems.jcsmp.XMLMessage
A flag to control output of XMLMessage.dump(int); display only the length of the binary attachment, xml attachment, and user property maps.
MSGDUMP_FULL - Static variable in interface com.solacesystems.jcsmp.XMLMessage
A flag to control output of XMLMessage.dump(int); display the entire message contents.

N

NO_LOCAL - Static variable in class com.solacesystems.jcsmp.JCSMPProperties
 
NO_MORE_NON_DURABLE_QUEUE_OR_TE - Static variable in class com.solacesystems.jcsmp.JCSMPErrorResponseSubcodeEx
Reached the maximum possible number of non-durable endpoints on the appliance; no more non-durable endpoints can be created.
NO_SUBSCRIPTION_MATCH - Static variable in class com.solacesystems.jcsmp.JCSMPErrorResponseSubcodeEx
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.
NON_PERSISTENT - Static variable in class com.solacesystems.jcsmp.MessageType
Deprecated.
Message type making use of Guaranteed delivery features: guaranteed once and only once delivery, guaranteed in-order delivery.
NOT_READY - Static variable in class com.solacesystems.jcsmp.JCSMPErrorResponseSubcodeEx
An attempt was made to perform a Guaranteed Delivery operation, but the appliance's Guaranteed Delivery system is not yet in an operational state.

O

onComplete(Long, Topic, CacheRequestResult) - Method in interface com.solacesystems.jcsmp.CacheRequestListener
Called when an asynchronous cache request completes.
onException(Long, Topic, JCSMPException) - Method in interface com.solacesystems.jcsmp.CacheRequestListener
Called when an asynchronous cache request ends with an error.
onException(JCSMPException) - Method in interface com.solacesystems.jcsmp.XMLMessageListener
On error, this method is invoked.
onlyInstance() - Static method in class com.solacesystems.jcsmp.DestinationUtils
Get a concrete instance of this utility class.
onlyInstance() - Static method in class com.solacesystems.jcsmp.JCSMPFactory
Returns an instance of JCSMPFactory.
onlyInstance() - Static method in class com.solacesystems.jcsmp.JCSMPRuntime
Returns the JCSMP runtime for the current JVM.
onReceive(BytesXMLMessage) - Method in interface com.solacesystems.jcsmp.XMLMessageListener
The callback method to handle messages received by the XMLMessageConsumer.
OperationNotSupportedException - Exception in com.solacesystems.jcsmp
OperationNotSupportedException indicates the requested operation is not supported based on the current Session configuration.
OperationNotSupportedException(String) - Constructor for exception com.solacesystems.jcsmp.OperationNotSupportedException
 
OUT_OF_REPLAY_RESOURCES - Static variable in class com.solacesystems.jcsmp.JCSMPErrorResponseSubcodeEx
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.jcsmp.JCSMPErrorResponseSubcodeEx
The call failed due to lack of resources.

P

P2PINBOX_IN_USE - Static variable in class com.solacesystems.jcsmp.JCSMPProperties
 
PASSWORD - Static variable in class com.solacesystems.jcsmp.JCSMPProperties
 
PERMISSION_CONSUME - Static variable in class com.solacesystems.jcsmp.EndpointProperties
Permission to consume messages from the endpoint.
PERMISSION_DELETE - Static variable in class com.solacesystems.jcsmp.EndpointProperties
Permission to delete an endpoint.
PERMISSION_MODIFY_TOPIC - Static variable in class com.solacesystems.jcsmp.EndpointProperties
Permission to modify the topic on a Topic endpoint.
PERMISSION_NONE - Static variable in class com.solacesystems.jcsmp.EndpointProperties
No permission on the endpoint.
PERMISSION_NOT_ALLOWED - Static variable in class com.solacesystems.jcsmp.JCSMPErrorResponseSubcodeEx
An attempt was made to bind to, deprovision, consume a message, or deprovision an Endpoint without permission.
PERMISSION_READ_ONLY - Static variable in class com.solacesystems.jcsmp.EndpointProperties
Permission to only read from an endpoint.
PERSISTENT - Static variable in class com.solacesystems.jcsmp.MessageType
Deprecated.
Message type making use of Guaranteed delivery features: guaranteed once and only once delivery, guaranteed in-order delivery.
postReconnect() - Method in interface com.solacesystems.jcsmp.JCSMPReconnectEventHandler
Called after each reconnection.
preReconnect() - Method in interface com.solacesystems.jcsmp.JCSMPReconnectEventHandler
Called before each reconnection attempt.
Producer - Interface in com.solacesystems.jcsmp
Producer is the super class of XMLMessageProducer.
ProducerEvent - Enum in com.solacesystems.jcsmp
Producer event types that can be given to the producer event callback handler ( JCSMPProducerEventHandler).
ProducerEventArgs - Class in com.solacesystems.jcsmp
Represents a producer event notification.
ProducerFlowProperties - Class in com.solacesystems.jcsmp
Properties used for creating producer flows.
ProducerFlowProperties() - Constructor for class com.solacesystems.jcsmp.ProducerFlowProperties
ProducerFlowProperties constructor.
ProducerFlowProperties(ProducerFlowProperties) - Constructor for class com.solacesystems.jcsmp.ProducerFlowProperties
ProducerFlowProperties copy constructor.
PropertyMismatchException - Exception in com.solacesystems.jcsmp
A general exception for property mismatch problems.
PropertyMismatchException(String, String, Object, Throwable) - Constructor for exception com.solacesystems.jcsmp.PropertyMismatchException
Constructor for the property mismatch exception.
PropertyMismatchException(String, String, Object) - Constructor for exception com.solacesystems.jcsmp.PropertyMismatchException
Constructor for the property mismatch exception.
PropertyMismatchException(String, Object) - Constructor for exception com.solacesystems.jcsmp.PropertyMismatchException
Constructor for the property mismatch exception.
propertyNames() - Method in class com.solacesystems.jcsmp.JCSMPChannelProperties
 
propertyNames() - Method in class com.solacesystems.jcsmp.JCSMPPropertyMap
Gets the set of property names (keys) currently in the property map.
provision(Endpoint, EndpointProperties, long) - Method in interface com.solacesystems.jcsmp.JCSMPSession
Provisions an Endpoint on the appliance.
PUB_ACK_TIME - Static variable in class com.solacesystems.jcsmp.JCSMPProperties
 
PUB_ACK_WINDOW_SIZE - Static variable in class com.solacesystems.jcsmp.JCSMPProperties
 
PUB_MULTI_THREAD - Static variable in class com.solacesystems.jcsmp.JCSMPProperties
 
PUB_USE_INTERMEDIATE_DIRECT_BUF - Static variable in class com.solacesystems.jcsmp.JCSMPProperties
 
PUBLISH_ACL_DENIED - Static variable in class com.solacesystems.jcsmp.JCSMPErrorResponseSubcodeEx
The publishing of message was denied due to topic matching a publish ACL (Access Control List).
PUBLISH_NO_VALID_CLOSED_USER_GROUP - Static variable in class com.solacesystems.jcsmp.JCSMPErrorResponseSubcodeEx
The publishing of a message was denied due to the publisher having no valid closed user group.
PUBLISHER_DATA_CHANNEL_PROPERTIES - Static variable in class com.solacesystems.jcsmp.JCSMPProperties
Deprecated.
These channel properties are deprecated in favor of JCSMPProperties.CLIENT_CHANNEL_PROPERTIES. If the default settings for CLIENT_CHANNEL_PROPERTIES are modified in any way, they override these legacy channel properties.
PUBLISHER_WINDOW_CLOSED - Static variable in class com.solacesystems.jcsmp.statistics.StatType
Counts the number of times an application attempted to enqueue a Guaranteed Delivery message for publishing and found the publisher window full.
putAll(SDTMap) - Method in interface com.solacesystems.jcsmp.SDTMap
Copies the mappings from the given SDTMap and puts them in this SDTMap.
putBoolean(String, Boolean) - Method in interface com.solacesystems.jcsmp.SDTMap
Associates the specified case-sensitive key with the value in the map.
putByte(String, Byte) - Method in interface com.solacesystems.jcsmp.SDTMap
Associates the specified case-sensitive key with the value in the map.
putBytes(String, byte[]) - Method in interface com.solacesystems.jcsmp.SDTMap
Associates the specified case-sensitive key with the value in the map.
putBytes(String, byte[], int, int) - Method in interface com.solacesystems.jcsmp.SDTMap
Associates the specified case-sensitive key with the value in the map.
putCharacter(String, Character) - Method in interface com.solacesystems.jcsmp.SDTMap
Associates the specified case-sensitive key with the value in the map.
putDestination(String, Destination) - Method in interface com.solacesystems.jcsmp.SDTMap
Associates the specified case-sensitive key with the value in the map.
putDouble(String, Double) - Method in interface com.solacesystems.jcsmp.SDTMap
Associates the specified case-sensitive key with the value in the map.
putFloat(String, Float) - Method in interface com.solacesystems.jcsmp.SDTMap
Associates the specified case-sensitive key with the value in the map.
putInteger(String, Integer) - Method in interface com.solacesystems.jcsmp.SDTMap
Associates the specified case-sensitive key with the value in the map.
putLong(String, Long) - Method in interface com.solacesystems.jcsmp.SDTMap
Associates the specified case-sensitive key with the value in the map.
putMap(String, SDTMap) - Method in interface com.solacesystems.jcsmp.SDTMap
Associates the specified case-sensitive key with the value in the map.
putObject(String, Object) - Method in interface com.solacesystems.jcsmp.SDTMap
Associates the specified case-sensitive key with the value in the map.
putShort(String, Short) - Method in interface com.solacesystems.jcsmp.SDTMap
Associates the specified case-sensitive key with the value in the map.
putStream(String, SDTStream) - Method in interface com.solacesystems.jcsmp.SDTMap
Associates the specified case-sensitive key with the value in the map.
putString(String, String) - Method in interface com.solacesystems.jcsmp.SDTMap
Associates the specified case-sensitive key with the value in the map.

Q

Queue - Class in com.solacesystems.jcsmp
Identifier for Solace appliance Queue names.
QUEUE_NOT_FOUND - Static variable in class com.solacesystems.jcsmp.JCSMPErrorResponseSubcodeEx
The specified Guaranteed Delivery queue was not found when publishing a message.
QUEUE_SHUTDOWN - Static variable in class com.solacesystems.jcsmp.JCSMPErrorResponseSubcodeEx
An attempt was made to bind to a shutdown Guaranteed Delivery queue.
queueFromEncodedName(String) - Method in class com.solacesystems.jcsmp.DestinationUtils
queueFromNetworkName(String) - Method in class com.solacesystems.jcsmp.DestinationUtils
Creates an (optionally temporary) Queue from the supplied name.
QUOTA_OUT_OF_RANGE - Static variable in class com.solacesystems.jcsmp.JCSMPErrorResponseSubcodeEx
An attempt was made to bind to, or provision an Endpoint with a quota that is out of range.

R

read() - Method in interface com.solacesystems.jcsmp.SDTStream
Reads the next object on the stream.
READ_TIMEOUT_IN_MILLIS - Static variable in class com.solacesystems.jcsmp.JCSMPChannelProperties
 
readAttachmentBytes(byte[]) - Method in interface com.solacesystems.jcsmp.XMLMessage
Reads bytes from an attachment, copying the data to the supplied byte array.
readAttachmentBytes(byte[], int) - Method in interface com.solacesystems.jcsmp.XMLMessage
Reads length bytes from an attachment, copying the data to the supplied byte array.
readAttachmentBytes(int, byte[], int, int) - Method in interface com.solacesystems.jcsmp.XMLMessage
Reads length bytes from an attachment, copying the data to the supplied byte array.
readBoolean() - Method in interface com.solacesystems.jcsmp.SDTStream
Reads a Boolean from a Stream.
readByte() - Method in interface com.solacesystems.jcsmp.SDTStream
Reads a Byte from a Stream.
readBytes(byte[]) - Method in interface com.solacesystems.jcsmp.BytesXMLMessage
Deprecated.
As of release 4.5, use XMLMessage.readContentBytes(int, byte[], int, int). This function used a read pointer stored in the message and therefore was not thread-safe when called by consumers of the message.
readBytes(byte[], int) - Method in interface com.solacesystems.jcsmp.BytesXMLMessage
Deprecated.
As of release 4.5, use XMLMessage.readContentBytes(int, byte[], int, int). This function used a read pointer stored in the message and therefore was not thread-safe when called by consumers of the message.
readBytes() - Method in interface com.solacesystems.jcsmp.SDTStream
Reads a byte[] from a Stream.
readCharacter() - Method in interface com.solacesystems.jcsmp.SDTStream
Reads a Character from a Stream.
readContentBytes(int, byte[], int, int) - Method in interface com.solacesystems.jcsmp.XMLMessage
Reads length bytes from the message content, copying the data to the supplied byte array.
readContentBytes(byte[]) - Method in interface com.solacesystems.jcsmp.XMLMessage
Reads from the message content, copying the data to the supplied byte array.
readContentBytes(byte[], int) - Method in interface com.solacesystems.jcsmp.XMLMessage
Reads length bytes from the message content, copying the data to the supplied byte array.
readDestination() - Method in interface com.solacesystems.jcsmp.SDTStream
Reads a Destination from a Stream.
readDouble() - Method in interface com.solacesystems.jcsmp.SDTStream
Reads a Double from a Stream.
readFloat() - Method in interface com.solacesystems.jcsmp.SDTStream
Reads a Float from a Stream.
readInteger() - Method in interface com.solacesystems.jcsmp.SDTStream
Reads an Integer from a Stream.
readLong() - Method in interface com.solacesystems.jcsmp.SDTStream
Reads a Long from a Stream.
readMap() - Method in interface com.solacesystems.jcsmp.SDTStream
Reads a SDTMap from a Stream.
readShort() - Method in interface com.solacesystems.jcsmp.SDTStream
Reads a Short from a Stream.
readStream() - Method in interface com.solacesystems.jcsmp.SDTStream
Reads a SDTStream from a Stream.
readString() - Method in interface com.solacesystems.jcsmp.SDTStream
Reads a String from a Stream.
REAPPLY_SUBSCRIPTIONS - Static variable in class com.solacesystems.jcsmp.JCSMPProperties
 
receive() - Method in interface com.solacesystems.jcsmp.Consumer
Receives the next available message, waiting until one is available.
receive(int) - Method in interface com.solacesystems.jcsmp.Consumer
Receives the next available message.
RECEIVE_BUFFER - Static variable in class com.solacesystems.jcsmp.JCSMPChannelProperties
 
receiveNoWait() - Method in interface com.solacesystems.jcsmp.Consumer
Receives the next available message.
RECONNECT_RETRIES - Static variable in class com.solacesystems.jcsmp.JCSMPChannelProperties
 
RECONNECT_RETRY_WAIT_IN_MILLIS - Static variable in class com.solacesystems.jcsmp.JCSMPChannelProperties
 
rejectMessage() - Method in interface com.solacesystems.jcsmp.XMLMessage
Deprecated.
As of version 4.0, rejectMessage has no separate effect from ackMessage. Applications should avoid using this method as it will be removed in a future release.
RELIABLE_BYTES_RECVED - Static variable in class com.solacesystems.jcsmp.statistics.StatType
A count of bytes received through TCP.
RELIABLE_BYTES_RESENT - Static variable in class com.solacesystems.jcsmp.statistics.StatType
A count of bytes in reliable messages that were retransmitted to the appliance.
RELIABLE_BYTES_SENT - Static variable in class com.solacesystems.jcsmp.statistics.StatType
Total count of bytes sent through TCP.
RELIABLE_DIRECT_BYTES_RECVED - Static variable in class com.solacesystems.jcsmp.statistics.StatType
A count of bytes received as DeliveryMode.DIRECT messages.
RELIABLE_DIRECT_BYTES_SENT - Static variable in class com.solacesystems.jcsmp.statistics.StatType
A count of bytes sent as DeliveryMode.DIRECT messages.
RELIABLE_DIRECT_MSGS_RECVED - Static variable in class com.solacesystems.jcsmp.statistics.StatType
A count of DeliveryMode.DIRECT messages received.
RELIABLE_DIRECT_MSGS_SENT - Static variable in class com.solacesystems.jcsmp.statistics.StatType
A count of DeliveryMode.DIRECT messages sent.
RELIABLE_MSGS_DISCARDED_DUPLICATES - Static variable in class com.solacesystems.jcsmp.statistics.StatType
A count of messages received through TCP and dropped for being received as duplicate.
RELIABLE_MSGS_DISCARDED_NO_MATCHING_FLOW - Static variable in class com.solacesystems.jcsmp.statistics.StatType
The number of messages discarded due to arriving on a message flow that did not match any local open message flows.
RELIABLE_MSGS_DISCARDED_OUTOFORDER - Static variable in class com.solacesystems.jcsmp.statistics.StatType
A count of messages received through TCP and dropped for being received out-of-order.
RELIABLE_MSGS_RECVED - Static variable in class com.solacesystems.jcsmp.statistics.StatType
A count of messages received through TCP.
RELIABLE_MSGS_RECVED_ACKED - Static variable in class com.solacesystems.jcsmp.statistics.StatType
A count of messages received through TCP that were acknowledged, indicating successful delivery to the application.
RELIABLE_MSGS_RESENT - Static variable in class com.solacesystems.jcsmp.statistics.StatType
A count of reliable messages that were retransmitted to the appliance.
RELIABLE_MSGS_SENT - Static variable in class com.solacesystems.jcsmp.statistics.StatType
Total count of messages sent through TCP.
RELIABLE_MSGS_SENT_CONFIRMED - Static variable in class com.solacesystems.jcsmp.statistics.StatType
Total count of messages sent through TCP acknowledged by the appliance.
RELIABLE_NONPERSISTENT_BYTES_RECVED - Static variable in class com.solacesystems.jcsmp.statistics.StatType
A count of bytes received as DeliveryMode.NON_PERSISTENT messages.
RELIABLE_NONPERSISTENT_BYTES_RESENT - Static variable in class com.solacesystems.jcsmp.statistics.StatType
A count of bytes in DeliveryMode.NON_PERSISTENT messages that were retransmitted to the appliance.
RELIABLE_NONPERSISTENT_BYTES_SENT - Static variable in class com.solacesystems.jcsmp.statistics.StatType
A count of bytes sent as DeliveryMode.NON_PERSISTENT messages.
RELIABLE_NONPERSISTENT_MSGS_RECVED - Static variable in class com.solacesystems.jcsmp.statistics.StatType
A count of DeliveryMode.NON_PERSISTENT messages received.
RELIABLE_NONPERSISTENT_MSGS_RECVED_ACKED - Static variable in class com.solacesystems.jcsmp.statistics.StatType
A count of DeliveryMode.NON_PERSISTENT messages received that were acknowledged, indicating successful delivery to the application.
RELIABLE_NONPERSISTENT_MSGS_RESENT - Static variable in class com.solacesystems.jcsmp.statistics.StatType
A count of DeliveryMode.NON_PERSISTENT messages that were retransmitted to the appliance.
RELIABLE_NONPERSISTENT_MSGS_SENT - Static variable in class com.solacesystems.jcsmp.statistics.StatType
A count of DeliveryMode.NON_PERSISTENT messages sent.
RELIABLE_PERSISTENT_BYTES_RECVED - Static variable in class com.solacesystems.jcsmp.statistics.StatType
A count of bytes received as DeliveryMode.PERSISTENT messages.
RELIABLE_PERSISTENT_BYTES_RESENT - Static variable in class com.solacesystems.jcsmp.statistics.StatType
A count of bytes in DeliveryMode.PERSISTENT messages that were retransmitted to the appliance.
RELIABLE_PERSISTENT_BYTES_SENT - Static variable in class com.solacesystems.jcsmp.statistics.StatType
A count of bytes sent as DeliveryMode.PERSISTENT messages.
RELIABLE_PERSISTENT_MSGS_RECVED - Static variable in class com.solacesystems.jcsmp.statistics.StatType
A count of DeliveryMode.PERSISTENT messages received.
RELIABLE_PERSISTENT_MSGS_RECVED_ACKED - Static variable in class com.solacesystems.jcsmp.statistics.StatType
A count of DeliveryMode.PERSISTENT messages received that were acknowledged, indicating successful delivery to the application.
RELIABLE_PERSISTENT_MSGS_RESENT - Static variable in class com.solacesystems.jcsmp.statistics.StatType
A count of DeliveryMode.PERSISTENT messages that were retransmitted to the appliance.
RELIABLE_PERSISTENT_MSGS_SENT - Static variable in class com.solacesystems.jcsmp.statistics.StatType
A count of DeliveryMode.PERSISTENT messages sent.
remove(BytesXMLMessage) - Method in interface com.solacesystems.jcsmp.Browser
Remove a message from the appliance's Queue Endpoint.
remove(String) - Method in interface com.solacesystems.jcsmp.SDTMap
Removes the mapping for the specified key if present.
removeSubscriber() - Method in interface com.solacesystems.jcsmp.Session
Deprecated.
Subscribers are now created and removed only through the appliance's management interface. This method has the same effect as Session.clearSubscriber()
removeSubscription(Subscription) - Method in interface com.solacesystems.jcsmp.JCSMPSession
Removes a subscription from the appliance.
removeSubscription(Subscription, boolean) - Method in interface com.solacesystems.jcsmp.JCSMPSession
Removes a subscription from the appliance.
removeSubscription(Endpoint, Subscription, int) - Method in interface com.solacesystems.jcsmp.JCSMPSession
Removes a subscription from an Endpoint on the appliance.
removeSubscription(Subscription, JCSMPResponseListener, Object) - Method in interface com.solacesystems.jcsmp.JCSMPSession
Removes a subscription asynchronously from the appliance.
removeSubscription(Endpoint, Subscription, JCSMPResponseListener, Object) - Method in interface com.solacesystems.jcsmp.JCSMPSession
Removes a subscription asynchronously from an Endpoint on the appliance.
REPLAY_CANCELLED - Static variable in class com.solacesystems.jcsmp.JCSMPErrorResponseSubcodeEx
The flow was replaying messages as requested by an earlier bind request, but the replay was administratively cancelled.
REPLAY_DISABLED - Static variable in class com.solacesystems.jcsmp.JCSMPErrorResponseSubcodeEx
Replay log is not created on message VPN.
REPLAY_FAILED - Static variable in class com.solacesystems.jcsmp.JCSMPErrorResponseSubcodeEx
An unexpected error has happened during message replay on the queue or DTE.
REPLAY_LOG_MODIFIED - Static variable in class com.solacesystems.jcsmp.JCSMPErrorResponseSubcodeEx
A replay was ongoing on the queue or DTE and the replay log was modified.
REPLAY_MESSAGE_UNAVAILABLE - Static variable in class com.solacesystems.jcsmp.JCSMPErrorResponseSubcodeEx
The flow was replaying messages as requested by an earlier bind request, but the replay failed because messages to be replayed were trimmed from the replay log.
REPLAY_START_MESSAGE_UNAVAILABLE - Static variable in class com.solacesystems.jcsmp.JCSMPErrorResponseSubcodeEx
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.jcsmp.JCSMPErrorResponseSubcodeEx
A replay was requested, but the requested start time is not available in the replay log.
REPLAY_STARTED - Static variable in class com.solacesystems.jcsmp.JCSMPErrorResponseSubcodeEx
A replay was started on the queue or DTE, either by another client or by the router.
REPLAY_TEMPORARY_NOT_SUPPORTED - Static variable in class com.solacesystems.jcsmp.JCSMPErrorResponseSubcodeEx
Replay Not Supported on Temporary Queue/Topic Endpoint This subCode is used for the following error responses: - 403 Replay Not Supported on Temporary Queue - 403 Replay Not Supported on Temporary Topic Endpoint
REPLAYED_MESSAGE_REJECTED - Static variable in class com.solacesystems.jcsmp.JCSMPErrorResponseSubcodeEx
The router attempted to replay a message, but the queue/topic endpoint rejected the message to sender.
ReplayStartLocation - Interface in com.solacesystems.jcsmp
ReplayStartLocation specifies a message replay start location.
ReplayStartLocationDate - Interface in com.solacesystems.jcsmp
JCSMPReplayStartLocationDate specifies a date and time based message replay start location.
REPLICATION_IS_STANDBY - Static variable in class com.solacesystems.jcsmp.JCSMPErrorResponseSubcodeEx
An attempt to perform an operation using a VPN that is configured to be STANDBY for replication.
ReplicationGroupMessageId - Interface in com.solacesystems.jcsmp
ReplicationGroupMessageId specifies a Replication Group Message ID as a replay start location.
REPLIES_DISCARDED - Static variable in class com.solacesystems.jcsmp.statistics.StatType
The number of replies that have been discarded because there was no outstanding request.
REPLIES_RECVED - Static variable in class com.solacesystems.jcsmp.statistics.StatType
The number of replies to requests that have been received.
request(XMLMessage, long, Destination) - Method in interface com.solacesystems.jcsmp.Requestor
Performs a request to the specified destination.
Requestor - Interface in com.solacesystems.jcsmp
An interface for submitting requests to the Solace appliance network.
REQUESTS_SENT - Static variable in class com.solacesystems.jcsmp.statistics.StatType
The number of requests that have been sent.
REQUESTS_TIMED_OUT - Static variable in class com.solacesystems.jcsmp.statistics.StatType
The number of requests that have timed out waiting for a reply.
reset() - Method in class com.solacesystems.jcsmp.ContextProperties
Resets the state.
reset() - Method in interface com.solacesystems.jcsmp.SDTStream
Resets the read pointer to the last position saved by mark().
reset() - Method in class com.solacesystems.jcsmp.TopicProperties
Resets all properties to default values.
reset() - Method in interface com.solacesystems.jcsmp.XMLMessage
Resets the message, clearing all fields, preparing it for publishing again.
resetStats() - Method in class com.solacesystems.jcsmp.JCSMPRuntime
Reset the global JCSMP statistics.
resetStats() - Method in class com.solacesystems.jcsmp.JCSMPStats
Reset the statistics in this instance of JCSMPStats.
responseReceived(String) - Method in interface com.solacesystems.jcsmp.JCSMPStreamingPublishCorrelatingEventHandler
 
responseReceived(String) - Method in interface com.solacesystems.jcsmp.JCSMPStreamingPublishEventHandler
Deprecated.
Use JCSMPStreamingPublishCorrelatingEventHandler instead. This method is invoked whenever an OK response is received.

When publishing PERSISTENT and NON_PERSISTENT messages, the messageID is passed as an argument to this callback when an acknowledgement is received.

Note: This method is not invoked for DIRECT messages because they do not receive acknowledgements.

responseReceivedEx(Object) - Method in interface com.solacesystems.jcsmp.JCSMPStreamingPublishCorrelatingEventHandler
This method is invoked whenever an OK response is received.
rewind() - Method in interface com.solacesystems.jcsmp.SDTStream
Rewinds the read pointer to the beginning of the stream.
rewindAttachment() - Method in interface com.solacesystems.jcsmp.XMLMessage
Deprecated.
This method no longer has any effect.
rewindContent() - Method in interface com.solacesystems.jcsmp.BytesXMLMessage
Deprecated.
As of release 4.5, use XMLMessage.readContentBytes(int, byte[], int, int). This function used a read pointer stored in the message and therefore was not thread-safe when called by consumers of the message.
rollback() - Method in interface com.solacesystems.jcsmp.transaction.TransactedSession
Rollback the active transaction.
RollbackException - Exception in com.solacesystems.jcsmp.transaction
An exception thrown when a transaction rolls back unexpectedly.
RollbackException(String) - Constructor for exception com.solacesystems.jcsmp.transaction.RollbackException
 
RollbackException(String, Throwable) - Constructor for exception com.solacesystems.jcsmp.transaction.RollbackException
 
ROUTER_DISCARD_NOTIFICATIONS - Static variable in class com.solacesystems.jcsmp.statistics.StatType
The number of messages received with the Discard Notification bit set.
RuntimeStatType - Class in com.solacesystems.jcsmp.statistics
Named statistics supported by JCSMPRuntime.

S

SDTEOFException - Exception in com.solacesystems.jcsmp
SDTEOFException indicates a read operation was performed on an SDTStream which has no more data to read.
SDTEOFException(String, Throwable) - Constructor for exception com.solacesystems.jcsmp.SDTEOFException
Constructs a MessageEOFException with the specified detailed message and nested exception.
SDTEOFException(String) - Constructor for exception com.solacesystems.jcsmp.SDTEOFException
Constructs a MessageEOFException with the specified detailed message.
SDTException - Exception in com.solacesystems.jcsmp
The base class of SDT exceptions.
SDTException(String, Throwable) - Constructor for exception com.solacesystems.jcsmp.SDTException
Constructs a MessageException with the specified detailed message and nested exception.
SDTException(String) - Constructor for exception com.solacesystems.jcsmp.SDTException
Constructs a MessageException with the specified detailed message.
SDTFormatException - Exception in com.solacesystems.jcsmp
SDTFormatException indicates a type conversion error occurred retrieving data from an SDTMap or SDTStream.
SDTFormatException(String, Throwable) - Constructor for exception com.solacesystems.jcsmp.SDTFormatException
Constructs a MessageFormatException with the specified detailed message and nested exception.
SDTFormatException(String) - Constructor for exception com.solacesystems.jcsmp.SDTFormatException
Constructs a MessageFormatException with the specified detailed message.
SDTMap - Interface in com.solacesystems.jcsmp
Map Structured Data Type (SDT) that maps case-sensitive Strings to a supported data type.
SDTStream - Interface in com.solacesystems.jcsmp
Stream Structured Data Type (SDT) that supports the following data types: Boolean, Byte, byte[], Character, Destination, Double, Float, Integer, Long, SDTMap, Short, SDTStream, String.
SDTUnknownType - Interface in com.solacesystems.jcsmp
An unknown structured data type that can be used to provide compatibility with new structured data types.
SECURE_PROPS - Static variable in class com.solacesystems.jcsmp.JCSMPProperties
Deprecated.
SELECTOR_INVALID - Static variable in class com.solacesystems.jcsmp.JCSMPErrorResponseSubcodeEx
The client attempted to bind to a topic endpoint witn an improperly formatted selector.
SELECTOR_MATCH_ERROR - Static variable in class com.solacesystems.jcsmp.JCSMPErrorResponseSubcodeEx
The client attempted to bind to a non-exclusive topic endpoint that is already bound with a different ingress selector.
send(XMLMessage) - Method in interface com.solacesystems.jcsmp.XMLMessageProducer
Deprecated. 
send(XMLMessage, Destination) - Method in interface com.solacesystems.jcsmp.XMLMessageProducer
Sends a message to a destination, such as a Queue or Topic.
SEND_BUFFER - Static variable in class com.solacesystems.jcsmp.JCSMPChannelProperties
 
sendCacheRequest(Long, Topic, boolean, CacheLiveDataAction) - Method in interface com.solacesystems.jcsmp.CacheSession
Send a synchronous cache request message.
sendCacheRequest(Long, Topic, boolean, CacheLiveDataAction, CacheRequestListener) - Method in interface com.solacesystems.jcsmp.CacheSession
Send an asynchronous cache request message.
sendCacheRequest(Long, Topic, long, long, boolean, CacheLiveDataAction) - Method in interface com.solacesystems.jcsmp.CacheSession
Send a synchronous cache request message.
sendCacheRequest(Long, Topic, long, long, boolean, CacheLiveDataAction, CacheRequestListener) - Method in interface com.solacesystems.jcsmp.CacheSession
Send an asynchronous cache request message.
sendMultiple(JCSMPSendMultipleEntry[], int, int, int) - Method in interface com.solacesystems.jcsmp.XMLMessageProducer
Sends a batch of messages.
sendReply(XMLMessage, XMLMessage) - Method in interface com.solacesystems.jcsmp.XMLMessageProducer
Convenience function for sending a reply message.
SERVICE_UNAVAILABLE - Static variable in class com.solacesystems.jcsmp.JCSMPErrorResponseSubcodeEx
A control operation failed due to Service Unavailable.
Session - Interface in com.solacesystems.jcsmp
Session represents the main application interface.
SESSION_NAME - Static variable in class com.solacesystems.jcsmp.JCSMPProperties
Deprecated.
SessionEvent - Enum in com.solacesystems.jcsmp
Session event types that can be given to the session event callback handler ( SessionEventHandler) registered for a session.
SessionEventArgs - Class in com.solacesystems.jcsmp
Represents a session event notification.
SessionEventHandler - Interface in com.solacesystems.jcsmp
A callback handler for session events.
setAccessType(Integer) - Method in class com.solacesystems.jcsmp.EndpointProperties
Sets the access type for the endpoint.
setAckImmediately(boolean) - Method in interface com.solacesystems.jcsmp.XMLMessage
Set the ACK Immediately message property.
setAckMode(String) - Method in class com.solacesystems.jcsmp.ConsumerFlowProperties
Indicates whether the acknowledgement of receiving a message is done by JCSMP automatically or by the application explicitly calling XMLMessage.ackMessage().
setAckThreshold(int) - Method in class com.solacesystems.jcsmp.ConsumerFlowProperties
Sets threshold for sending an acknowledgement, as a percentage of window size.
setAckTimerInMsecs(int) - Method in class com.solacesystems.jcsmp.ConsumerFlowProperties
Sets the acknowledgement timer for the flow (in milliseconds).
setActiveFlowIndication(boolean) - Method in class com.solacesystems.jcsmp.ConsumerFlowProperties
Applications that require a separate message for active or inactive flow indication must set this property to true when creating the flow.
setApplicationMessageId(String) - Method in interface com.solacesystems.jcsmp.XMLMessage
Sets the message ID (a string for an application-specific message identifier).
setApplicationMessageType(String) - Method in interface com.solacesystems.jcsmp.XMLMessage
Sets the application message type.
setAppMessageID(String) - Method in interface com.solacesystems.jcsmp.XMLMessage
setAppMessageType(String) - Method in interface com.solacesystems.jcsmp.XMLMessage
setAsReplyMessage(boolean) - Method in interface com.solacesystems.jcsmp.XMLMessage
Sets the reply field of the message.
setBooleanProperty(String, boolean) - Method in class com.solacesystems.jcsmp.JCSMPChannelProperties
 
setBooleanProperty(String, boolean) - Method in class com.solacesystems.jcsmp.JCSMPPropertyMap
Sets a property with the specified key and value in the property list, wrapping the value as a Boolean.
setCacheName(String) - Method in class com.solacesystems.jcsmp.CacheSessionProperties
Sets the cache name of the cache to send the request to.
setCompressionLevel(int) - Method in class com.solacesystems.jcsmp.JCSMPChannelProperties
 
setConnectRetries(int) - Method in class com.solacesystems.jcsmp.JCSMPChannelProperties
 
setConnectRetriesPerHost(int) - Method in class com.solacesystems.jcsmp.JCSMPChannelProperties
 
setConnectTimeoutInMillis(int) - Method in class com.solacesystems.jcsmp.JCSMPChannelProperties
 
setConsumerDefaultFlowCongestionLimit(int) - Method in class com.solacesystems.jcsmp.JCSMPGlobalProperties
Sets the the default consumer's congestion limit.
setConsumerDispatcherQueueSize(int) - Method in class com.solacesystems.jcsmp.JCSMPGlobalProperties
Sets the size of the consumer notification dispatcher queue.
setCorrelationId(String) - Method in interface com.solacesystems.jcsmp.XMLMessage
Sets the correlation ID.
setCorrelationKey(Object) - Method in interface com.solacesystems.jcsmp.XMLMessage
Sets the correlation key for the message.
setCos(User_Cos) - Method in interface com.solacesystems.jcsmp.XMLMessage
Sets the Class of Service (CoS) value for this message.
setData(byte[]) - Method in interface com.solacesystems.jcsmp.BytesMessage
Sets the message content of the attachment part.
setDate(Date) - Method in interface com.solacesystems.jcsmp.ReplayStartLocationDate
 
setDeliverEvtsThruBlockingRecv(boolean) - Method in class com.solacesystems.jcsmp.CacheSessionProperties
Sets whether to deliver a cache request complete event through the API's synchronous receive interface.
setDeliverToOne(boolean) - Method in interface com.solacesystems.jcsmp.XMLMessage
Deprecated. 
setDeliveryMode(DeliveryMode) - Method in interface com.solacesystems.jcsmp.XMLMessage
Sets the delivery mode of the message.
setDestination(Destination) - Method in interface com.solacesystems.jcsmp.JCSMPSendMultipleEntry
Sets the destination to send the message to.
setDiscardBehavior(Integer) - Method in class com.solacesystems.jcsmp.EndpointProperties
If set, whether to notify sender if a message fails to be enqueued to the endpoint.
setDMQEligible(boolean) - Method in interface com.solacesystems.jcsmp.XMLMessage
Set the message to be eligible to be moved to a Dead Message Queue.
setElidingEligible(boolean) - Method in interface com.solacesystems.jcsmp.XMLMessage
Sets whether the message is eligible for eliding.
setEndpoint(Endpoint) - Method in class com.solacesystems.jcsmp.BrowserProperties
Sets the Endpoint to browse.
setEndpoint(Endpoint) - Method in class com.solacesystems.jcsmp.ConsumerFlowProperties
The appliance Endpoint to bind to.
setExpiration(long) - Method in interface com.solacesystems.jcsmp.XMLMessage
The UTC time (in milliseconds, from midnight, January 1, 1970 UTC) when the message is supposed to expire.
setExtraInfo(String) - Method in exception com.solacesystems.jcsmp.JCSMPException
 
setGlobalProperties(JCSMPGlobalProperties) - Method in class com.solacesystems.jcsmp.JCSMPFactory
Sets the JCSMPGlobalProperties instance for this factory.
setHTTPContentEncoding(String) - Method in interface com.solacesystems.jcsmp.XMLMessage
Sets the HTTP content type encoding value for interaction with an HTTP client.
setHTTPContentType(String) - Method in interface com.solacesystems.jcsmp.XMLMessage
Sets the HTTP content type header value for interaction with an HTTP client.
setIntegerProperty(String, int) - Method in class com.solacesystems.jcsmp.JCSMPChannelProperties
 
setIntegerProperty(String, int) - Method in class com.solacesystems.jcsmp.JCSMPPropertyMap
Sets a property with the specified key and value in the property list, wrapping the value as an Integer.
setKeepAliveIntervalInMillis(int) - Method in class com.solacesystems.jcsmp.JCSMPChannelProperties
 
setKeepAliveLimit(int) - Method in class com.solacesystems.jcsmp.JCSMPChannelProperties
 
setMap(SDTMap) - Method in interface com.solacesystems.jcsmp.MapMessage
Sets the message content.
setMaxAge(int) - Method in class com.solacesystems.jcsmp.CacheSessionProperties
Sets the maximum message age (in seconds).
setMaxMsgRedelivery(Integer) - Method in class com.solacesystems.jcsmp.EndpointProperties
Sets the maximum message redelivery count on the queue or topic endpoint.
setMaxMsgs(int) - Method in class com.solacesystems.jcsmp.CacheSessionProperties
Sets the maximum messages per Topic.
setMaxMsgSize(Integer) - Method in class com.solacesystems.jcsmp.EndpointProperties
Sets the maximum message size for the endpoint.
setMessage(XMLMessage) - Method in interface com.solacesystems.jcsmp.JCSMPSendMultipleEntry
Sets the message to send.
setMessageListener(XMLMessageListener) - Method in interface com.solacesystems.jcsmp.XMLMessageConsumer
Deprecated.
As of release 4.1, please provide an XMLMessageListener when acquiring an XMLMessageConsumer from a session. This method is deprecated and provided for backwards-compatibility; if using it, note that it must be called immediately after acquiring the XMLMessageConsumer, before it is started, and it may only be called once. Failure to respect these conditions will result in an IllegalStateException being thrown.
setMessageType(MessageType) - Method in interface com.solacesystems.jcsmp.XMLMessage
Deprecated.
See XMLMessage.setDeliveryMode(DeliveryMode). Sets the type of the message. Valid types are enumerated in MessageType:
  • MessageType.NON_PERSISTENT
  • MessageType.PERSISTENT
  • MessageType.DIRECT (default)
setName(String) - Method in class com.solacesystems.jcsmp.ContextProperties
Sets the name of the Context.
setName(String) - Method in class com.solacesystems.jcsmp.TopicProperties
Sets a name for the Topic.
setNewSubscription(Subscription) - Method in class com.solacesystems.jcsmp.ConsumerFlowProperties
If binding to a TopicEndpoint, the Topic to set/replace as a topic subscription on the endpoint.
setNoLocal(boolean) - Method in class com.solacesystems.jcsmp.ConsumerFlowProperties
When the flow has the noLocal flag 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.
setNumOfSubscriptions(int) - Method in class com.solacesystems.jcsmp.SubscriptionState
Deprecated.
Set the number of subscriptions.
setPermission(Integer) - Method in class com.solacesystems.jcsmp.EndpointProperties
Sets the permissions for the endpoint.
setPriority(int) - Method in interface com.solacesystems.jcsmp.XMLMessage
A message can optionally have priority set.
setProducerDispatcherQueueSize(int) - Method in class com.solacesystems.jcsmp.JCSMPGlobalProperties
Sets the size of the producer notification dispatcher queue.
setProperties(Map<String, Object>) - Method in class com.solacesystems.jcsmp.JCSMPChannelProperties
 
setProperties(Map<String, Object>) - Method in class com.solacesystems.jcsmp.JCSMPPropertyMap
Bulk set of properties, invokes the HashMap.putAll(Map) method which copies entries from the provided map to the property map.
setProperties(SDTMap) - Method in interface com.solacesystems.jcsmp.XMLMessage
This method allows users to specify their own user properties to be carried in the message separate from the payload.
setProperty(String, Object) - Method in class com.solacesystems.jcsmp.JCSMPChannelProperties
 
setProperty(String, Object) - Method in class com.solacesystems.jcsmp.JCSMPProperties
 
setProperty(String, Object) - Method in class com.solacesystems.jcsmp.JCSMPPropertyMap
Sets a property with the specified key and value in the property list.
setProperty(String, Object) - Method in interface com.solacesystems.jcsmp.JCSMPSession
Sets a modifiable Session property once the Session has been constructed.
setQuota(Integer) - Method in class com.solacesystems.jcsmp.EndpointProperties
Sets the message spool quota for an endpoint.
setReadOnly() - Method in interface com.solacesystems.jcsmp.XMLMessage
The message can be set as read only.
setReadTimeoutInMillis(int) - Method in class com.solacesystems.jcsmp.JCSMPChannelProperties
 
setReceiveBuffer(int) - Method in class com.solacesystems.jcsmp.JCSMPChannelProperties
 
setReconnectFreqManagerMaxReconnects(int) - Method in class com.solacesystems.jcsmp.JCSMPGlobalProperties
Sets the maximum number of reconnects to allow before the reconnect frequency manager kills a connection.
setReconnectRetries(int) - Method in class com.solacesystems.jcsmp.JCSMPChannelProperties
 
setReconnectRetryIntervalInMsecs(int) - Method in class com.solacesystems.jcsmp.BrowserProperties
This property specifies how much time (in ms) to wait between each attempt to reconnect to an endpoint.
setReconnectRetryIntervalInMsecs(int) - Method in class com.solacesystems.jcsmp.ConsumerFlowProperties
This property specifies how much time (in ms) to wait between each attempt to reconnect to an endpoint.
setReconnectRetryWaitInMillis(int) - Method in class com.solacesystems.jcsmp.JCSMPChannelProperties
 
setReconnectTries(int) - Method in class com.solacesystems.jcsmp.BrowserProperties
This property specifies the number of times to attempt to reconnect to an endpoint after the initial bound flow goes down.
setReconnectTries(int) - Method in class com.solacesystems.jcsmp.ConsumerFlowProperties
This property specifies the number of times to attempt to reconnect to an endpoint after the initial bound flow goes down.
setReplayStartLocation(ReplayStartLocation) - Method in class com.solacesystems.jcsmp.ConsumerFlowProperties
This property specifies a message replay start location.
setReplyTo(Destination) - Method in interface com.solacesystems.jcsmp.XMLMessage
Sets the replyTo destination for the message.
setReplyToSuffix(String) - Method in interface com.solacesystems.jcsmp.XMLMessage
Appends a String to the session's default ReplyTo base topic and creates a ReplyTo Topic Destination.
setRespectsMsgTTL(Boolean) - Method in class com.solacesystems.jcsmp.EndpointProperties
Whether the endpoint will respect messages' Time-to-Live values.
setRxAllDeliverToOne(boolean) - Method in class com.solacesystems.jcsmp.TopicProperties
Deprecated. 
setSelector(String) - Method in class com.solacesystems.jcsmp.BrowserProperties
Sets the browse selector.
setSelector(String) - Method in class com.solacesystems.jcsmp.ConsumerFlowProperties
A SQL-92 selector to use for selection of messages for delivery.
setSendBuffer(int) - Method in class com.solacesystems.jcsmp.JCSMPChannelProperties
 
setSenderID(String) - Method in interface com.solacesystems.jcsmp.XMLMessage
Deprecated.
setSenderId(String) - Method in interface com.solacesystems.jcsmp.XMLMessage
Sets the Sender ID for the message.
setSenderTimestamp(long) - Method in interface com.solacesystems.jcsmp.XMLMessage
Allows the application to set the send timestamp, if so the API will not generate a value.
setSendTimestamp(long) - Method in interface com.solacesystems.jcsmp.XMLMessage
Deprecated.
setSequenceNumber(long) - Method in interface com.solacesystems.jcsmp.XMLMessage
Sets the sequence number.
setSmfPort(int) - Method in class com.solacesystems.jcsmp.JCSMPChannelProperties
Deprecated.
Use of this setting is discouraged, the recommended way of selecting ports is through the "Host:Port" syntax of the JCSMPProperties.HOST property.
setStack(String) - Method in class com.solacesystems.jcsmp.JCSMPChannelProperties
 
setStartState(boolean) - Method in class com.solacesystems.jcsmp.ConsumerFlowProperties
Controls whether a newly created flow should be in the started state upon creation.
setStream(SDTStream) - Method in interface com.solacesystems.jcsmp.StreamMessage
Sets the message content.
setStream(InputStream) - Method in interface com.solacesystems.jcsmp.StreamXMLMessage
Deprecated.
Set the InputStream from which the message content can be read.
setStreamingCallbackHandler(JCSMPStreamingPublishEventHandler) - Method in interface com.solacesystems.jcsmp.XMLMessageProducer
Deprecated.
As of release 4.1, please provide an JCSMPStreamingPublishEventHandler when acquiring an XMLMessageProducer from a session. This method is deprecated and has no effect.
setTcpNoDelay(boolean) - Method in class com.solacesystems.jcsmp.JCSMPChannelProperties
 
setText(String) - Method in interface com.solacesystems.jcsmp.TextMessage
Sets the message content.
setText(String) - Method in interface com.solacesystems.jcsmp.TextXMLMessage
Deprecated.
Set the message content as text.
setText(String, String) - Method in interface com.solacesystems.jcsmp.TextXMLMessage
Deprecated.
Set the message content as text.
setTimeout(int) - Method in class com.solacesystems.jcsmp.CacheSessionProperties
Sets the timeout for a cache request (in milliseconds).
setTimeToLive(long) - Method in interface com.solacesystems.jcsmp.XMLMessage
The number of milliseconds before the message is discarded or moved to a Dead Message Queue.
setTransportWindowSize(int) - Method in class com.solacesystems.jcsmp.BrowserProperties
The TransportWindowSize affects the number of local messages that are pre-fetched by the Browser.
setTransportWindowSize(int) - Method in class com.solacesystems.jcsmp.ConsumerFlowProperties
Sets the Guaranteed message transport window size for the flow.
setUserData(byte[]) - Method in interface com.solacesystems.jcsmp.XMLMessage
When an application sends a message, it can optionally attach application-specific data along with the message as user data.
setWaitTimeout(int) - Method in class com.solacesystems.jcsmp.BrowserProperties
Sets the WaitTimeout in msecs.
setWindowSize(int) - Method in class com.solacesystems.jcsmp.ProducerFlowProperties
The size of the sliding publisher window for Guaranteed messages.
setXMLContent(String) - Method in interface com.solacesystems.jcsmp.XMLContentMessage
Sets the message content.
SHARED_SUBSCRIPTION_NOT_SUPPORTED - Static variable in class com.solacesystems.jcsmp.JCSMPErrorResponseSubcodeEx
The client has attempted to add a shared subscription to a queue or topic endpoint, which is not supported.
size() - Method in interface com.solacesystems.jcsmp.SDTMap
Returns the number of mappings.
SMF_DISCARDS_UNKNOWN_ELEMENT - Static variable in class com.solacesystems.jcsmp.statistics.StatType
The number of SMF messages discarded due to the presence of an unknown element in the SMF header.
SMF_PORT - Static variable in class com.solacesystems.jcsmp.JCSMPChannelProperties
 
SPOOL_OVER_QUOTA - Static variable in class com.solacesystems.jcsmp.JCSMPErrorResponseSubcodeEx
The spool is over its allotted space quota.
SSL_CIPHER_SUITES - Static variable in class com.solacesystems.jcsmp.JCSMPProperties
 
SSL_CONNECTION_DOWNGRADE_TO - Static variable in class com.solacesystems.jcsmp.JCSMPProperties
Session property specifying a transport protocol that SSL session connection will be downgraded to after client authentication.
SSL_EXCLUDED_PROTOCOLS - Static variable in class com.solacesystems.jcsmp.JCSMPProperties
 
SSL_KEY_STORE - Static variable in class com.solacesystems.jcsmp.JCSMPProperties
 
SSL_KEY_STORE_FORMAT - Static variable in class com.solacesystems.jcsmp.JCSMPProperties
 
SSL_KEY_STORE_NORMALIZED_FORMAT - Static variable in class com.solacesystems.jcsmp.JCSMPProperties
 
SSL_KEY_STORE_PASSWORD - Static variable in class com.solacesystems.jcsmp.JCSMPProperties
 
SSL_PRIVATE_KEY_ALIAS - Static variable in class com.solacesystems.jcsmp.JCSMPProperties
 
SSL_PRIVATE_KEY_PASSWORD - Static variable in class com.solacesystems.jcsmp.JCSMPProperties
 
SSL_PROTOCOL - Static variable in class com.solacesystems.jcsmp.JCSMPProperties
Deprecated.
SSL_TRUST_STORE - Static variable in class com.solacesystems.jcsmp.JCSMPProperties
 
SSL_TRUST_STORE_FORMAT - Static variable in class com.solacesystems.jcsmp.JCSMPProperties
 
SSL_TRUST_STORE_PASSWORD - Static variable in class com.solacesystems.jcsmp.JCSMPProperties
 
SSL_TRUSTED_COMMON_NAME_LIST - Static variable in class com.solacesystems.jcsmp.JCSMPProperties
 
SSL_VALIDATE_CERTIFICATE - Static variable in class com.solacesystems.jcsmp.JCSMPProperties
 
SSL_VALIDATE_CERTIFICATE_DATE - Static variable in class com.solacesystems.jcsmp.JCSMPProperties
 
STACK - Static variable in class com.solacesystems.jcsmp.JCSMPChannelProperties
 
StaleSessionException - Exception in com.solacesystems.jcsmp
StaleSessionException indicates that the requested operation cannot be fulfilled because the underlying session was stale.
StaleSessionException(String, JCSMPException) - Constructor for exception com.solacesystems.jcsmp.StaleSessionException
 
start() - Method in interface com.solacesystems.jcsmp.Consumer
Enables receiving messages from an appliance.
StatType - Class in com.solacesystems.jcsmp.statistics
Named statistics supported by JCSMPStats.
stop() - Method in interface com.solacesystems.jcsmp.Consumer
Disables receiving messages from an appliance.
StreamMessage - Interface in com.solacesystems.jcsmp
StreamMessage is used to send a message containing an SDTStream.
StreamXMLMessage - Interface in com.solacesystems.jcsmp
Deprecated.
Use of message types other than BytesXMLMessage is deprecated.
SUB_ACK_TIME - Static variable in class com.solacesystems.jcsmp.JCSMPProperties
 
SUB_ACK_WINDOW_SIZE - Static variable in class com.solacesystems.jcsmp.JCSMPProperties
 
SUB_ACK_WINDOW_THRESHOLD - Static variable in class com.solacesystems.jcsmp.JCSMPProperties
 
SUBSCRIBER_CONGESTED_EVENT - Static variable in class com.solacesystems.jcsmp.statistics.StatType
The number of times the subscriber was congested and suspended reads from the socket.
SUBSCRIBER_DATA_CHANNEL_PROPERTIES - Static variable in class com.solacesystems.jcsmp.JCSMPProperties
Deprecated.
These channel properties are deprecated in favor of JCSMPProperties.CLIENT_CHANNEL_PROPERTIES. If the default settings for CLIENT_CHANNEL_PROPERTIES are modified in any way, they override these legacy channel properties.
SUBSCRIBER_FLOW_WINDOW_CLOSED - Static variable in class com.solacesystems.jcsmp.statistics.StatType
Counts the number of times the subscriber window became closed, that is, the number of times a Guaranteed Delivery message was enqueued for a Consumer and that operation caused its local queue to be full.
SUBSCRIBER_LOCAL_PRIORITY - Static variable in class com.solacesystems.jcsmp.JCSMPProperties
Deprecated.
SUBSCRIBER_NETWORK_PRIORITY - Static variable in class com.solacesystems.jcsmp.JCSMPProperties
Deprecated.
SubscriberEndpoint - Class in com.solacesystems.jcsmp
The SubscriberEndpoint represents the Endpoint on the appliance to which an application must bind to create a flow for content-routed messages destined for a particular subscriber.
Subscription - Interface in com.solacesystems.jcsmp
A Subscription object is used for control operations such as adding or removing subscriptions from the appliance.
SUBSCRIPTION_ACL_DENIED - Static variable in class com.solacesystems.jcsmp.JCSMPErrorResponseSubcodeEx
The adding of a subscription was denied to due a subscription ACL (Access Control List).
SUBSCRIPTION_ALREADY_PRESENT - Static variable in class com.solacesystems.jcsmp.JCSMPErrorResponseSubcodeEx
The client attempted to add a subscription that already exists.
SUBSCRIPTION_ATTRIBUTES_CONFLICT - Static variable in class com.solacesystems.jcsmp.JCSMPErrorResponseSubcodeEx
The client attempted to add a subscription that already exists with different properties.
SUBSCRIPTION_INVALID - Static variable in class com.solacesystems.jcsmp.JCSMPErrorResponseSubcodeEx
The client attempted to add or remove a subscription that is not valid.
SUBSCRIPTION_MANAGER_DENIED - Static variable in class com.solacesystems.jcsmp.JCSMPErrorResponseSubcodeEx
An attempt was made to add or remove a subscription on behalf of a client without holding the subscription-manager client-username permission.
SUBSCRIPTION_MATCH_ERROR - Static variable in class com.solacesystems.jcsmp.JCSMPErrorResponseSubcodeEx
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.jcsmp.JCSMPErrorResponseSubcodeEx
The client attempted to remove a subscription that did not exist.
SUBSCRIPTION_TOO_MANY - Static variable in class com.solacesystems.jcsmp.JCSMPErrorResponseSubcodeEx
The client attempted to add a subscription when the maximum number of allowed has been reached.
SubscriptionsOutOfSynchException - Exception in com.solacesystems.jcsmp
Deprecated.
This class is no longer supported and will be removed in a future release.
SubscriptionsOutOfSynchException(String) - Constructor for exception com.solacesystems.jcsmp.SubscriptionsOutOfSynchException
Deprecated.
 
SubscriptionState - Class in com.solacesystems.jcsmp
Deprecated.
SubscriptionState is no longer supported and its use has no effect.
SubscriptionState() - Constructor for class com.solacesystems.jcsmp.SubscriptionState
Deprecated.
 
SubscriptionStateProvider - Interface in com.solacesystems.jcsmp
Deprecated.
SubscriptionStateProvider is no longer supported and its use has no effect.
SUPPORTED_ACK_EVENT_MODE_PER_MSG - Static variable in class com.solacesystems.jcsmp.JCSMPProperties
API sends out message acknowledgement event for a single Guaranteed message published.
SUPPORTED_ACK_EVENT_MODE_WINDOWED - Static variable in class com.solacesystems.jcsmp.JCSMPProperties
API sends out message acknowledgement event for a range of Guaranteed messages published.
SUPPORTED_MESSAGE_ACK_AUTO - Static variable in class com.solacesystems.jcsmp.JCSMPProperties
Auto-ack incoming Guaranteed messages.
SUPPORTED_MESSAGE_ACK_CLIENT - Static variable in class com.solacesystems.jcsmp.JCSMPProperties
Client acknowledgement of incoming Guaranteed messages.
SUPPORTED_PROTOCOL_STACK_SMF_TCP - Static variable in class com.solacesystems.jcsmp.JCSMPChannelProperties
 
SUPPORTED_PROTOCOL_STACK_SMFS_TCP - Static variable in class com.solacesystems.jcsmp.JCSMPChannelProperties
 

T

TCP_NO_DELAY - Static variable in class com.solacesystems.jcsmp.JCSMPChannelProperties
 
TE_SHUTDOWN - Static variable in class com.solacesystems.jcsmp.JCSMPErrorResponseSubcodeEx
An attempt was made to bind to a shutdown Guaranteed Delivery Topic Endpoint (TE).
TextMessage - Interface in com.solacesystems.jcsmp
TextMessage is used to send a message containing text.
TextXMLMessage - Interface in com.solacesystems.jcsmp
Deprecated.
Use of message types other than BytesXMLMessage is deprecated.
TOO_MANY_CLIENTS - Static variable in class com.solacesystems.jcsmp.JCSMPErrorResponseSubcodeEx
Client login is not currently possible because the maximum number of active clients on appliance has been reached.
Topic - Class in com.solacesystems.jcsmp
An identifier for Solace appliance topics and topic subscriptions.
TOPIC_OR_SELECTOR_MODIFIED_ON_DTE - Static variable in class com.solacesystems.jcsmp.JCSMPErrorResponseSubcodeEx
A replay was in progress on a Durable Topic Endpoint (DTE) when its topic or selector was modified, causing the replay to fail.
TopicEndpoint - Class in com.solacesystems.jcsmp
Represents a TopicEndpoint, either durable or non-durable.
topicFromEncodedName(String) - Method in class com.solacesystems.jcsmp.DestinationUtils
topicFromNetworkName(String) - Method in class com.solacesystems.jcsmp.DestinationUtils
Creates an (optionally temporary) Topic from the supplied name.
TopicProperties - Class in com.solacesystems.jcsmp
Gathers the properties to be used for constructing an instance of Topic.
TopicProperties() - Constructor for class com.solacesystems.jcsmp.TopicProperties
 
toProperties() - Method in class com.solacesystems.jcsmp.JCSMPProperties
Get a Properties object representing this instance, suitable for persisting to a flat file.
toString() - Method in class com.solacesystems.jcsmp.CacheSessionProperties
 
toString() - Method in class com.solacesystems.jcsmp.ClientName
 
toString() - Method in class com.solacesystems.jcsmp.FlowEventArgs
 
toString() - Method in class com.solacesystems.jcsmp.JCSMPChannelProperties
 
toString() - Method in exception com.solacesystems.jcsmp.JCSMPErrorResponseException
 
toString() - Method in class com.solacesystems.jcsmp.JCSMPProperties
Returns a string representation of the property list.
toString() - Method in class com.solacesystems.jcsmp.JCSMPStats
Returns a string representation of the statistics set.
toString() - Method in class com.solacesystems.jcsmp.ProducerEventArgs
 
toString() - Method in interface com.solacesystems.jcsmp.ReplicationGroupMessageId
Get ReplicationGroupMessageId in string format
toString() - Method in class com.solacesystems.jcsmp.SessionEventArgs
 
toString() - Method in class com.solacesystems.jcsmp.Topic
 
toString() - Method in class com.solacesystems.jcsmp.TopicEndpoint
 
toString() - Method in class com.solacesystems.jcsmp.TopicProperties
 
TOTAL_ACK_TIMEOUT - Static variable in class com.solacesystems.jcsmp.statistics.StatType
The number of times the acknowledgment timer expired.
TOTAL_BYTES_RECVED - Static variable in class com.solacesystems.jcsmp.statistics.StatType
A count of bytes received as part of subscriber messages.
TOTAL_BYTES_SENT - Static variable in class com.solacesystems.jcsmp.statistics.StatType
A count of bytes sent as part of published messages.
TOTAL_CONNECTION_ATTEMPTS - Static variable in class com.solacesystems.jcsmp.statistics.StatType
Total number of TCP connections attempted by this session.
TOTAL_ERROR_RESPONSE_CALLBACKS - Static variable in class com.solacesystems.jcsmp.statistics.StatType
TOTAL_MSGS_RECVED - Static variable in class com.solacesystems.jcsmp.statistics.StatType
A count of messages received.
TOTAL_MSGS_SENT - Static variable in class com.solacesystems.jcsmp.statistics.StatType
A count of messages sent.
TOTAL_OK_RESPONSE_CALLBACKS - Static variable in class com.solacesystems.jcsmp.statistics.StatType
TOTAL_SEND_METHOD_CALLED - Static variable in class com.solacesystems.jcsmp.statistics.StatType
TOTAL_SOCKET_BYTES_RECVED - Static variable in class com.solacesystems.jcsmp.statistics.StatType
A count of bytes received as part of subscriber messages, control messages, and protocol overhead.
TOTAL_SOCKET_BYTES_SENT - Static variable in class com.solacesystems.jcsmp.statistics.StatType
A count of bytes sent over the sockets owned by this session, including SMF protocol overhead.
TOTAL_SOCKET_COMPRESSED_BYTES_RECVED - Static variable in class com.solacesystems.jcsmp.statistics.StatType
A count of compressed bytes received (before decompression).
TOTAL_SOCKET_COMPRESSED_BYTES_SENT - Static variable in class com.solacesystems.jcsmp.statistics.StatType
A count of compressed bytes sent (after compression).
TOTAL_SOCKET_SSL_BYTES_RECVED - Static variable in class com.solacesystems.jcsmp.statistics.StatType
A count of ssl bytes received (before decryption).
TOTAL_SOCKET_SSL_BYTES_SENT - Static variable in class com.solacesystems.jcsmp.statistics.StatType
A count of ssl bytes sent (after encryption).
TRANSACTED_SESSION_NAME_IN_USE - Static variable in class com.solacesystems.jcsmp.JCSMPErrorResponseSubcodeEx
The Transacted Session Name is being used by another opened session.
TransactedSession - Interface in com.solacesystems.jcsmp.transaction
A TransactedSession groups a number of guaranteed delivery flows together to allow them to perform transactions.
TRANSACTION_FAILURE - Static variable in class com.solacesystems.jcsmp.JCSMPErrorResponseSubcodeEx
The number of messages (published and consumed) in the transaction exceeds the maximum transaction size.
TRANSACTION_MESSAGE_CONSUME_FAILURE - Static variable in class com.solacesystems.jcsmp.JCSMPErrorResponseSubcodeEx
Failure to consume a message during a transaction.
TransactionResultUnknownException - Exception in com.solacesystems.jcsmp.transaction
An exception thrown when a transaction commit result is unknown.
TransactionResultUnknownException(String) - Constructor for exception com.solacesystems.jcsmp.transaction.TransactionResultUnknownException
 
TransactionResultUnknownException(String, Throwable) - Constructor for exception com.solacesystems.jcsmp.transaction.TransactionResultUnknownException
 
TransactionStatus - Enum in com.solacesystems.jcsmp.transaction
An enumeration of the possible states of a transaction (the in-progress transaction on a TransactedSession).
TRANSPORT_PROTOCOL_PLAIN_TEXT - Static variable in class com.solacesystems.jcsmp.JCSMPProperties
Plain text transport protocol for SSL_CONNECTION_DOWNGRADE_TO.
TYPE_CONSUMER - Static variable in exception com.solacesystems.jcsmp.JCSMPLoginFailureException
 
TYPE_PRODUCER - Static variable in exception com.solacesystems.jcsmp.JCSMPLoginFailureException
 

U

UNKNOWN - Static variable in class com.solacesystems.jcsmp.JCSMPErrorResponseSubcodeEx
Unknown subcode.
UNKNOWN_CLIENT_NAME - Static variable in class com.solacesystems.jcsmp.JCSMPErrorResponseSubcodeEx
An attempt was made to reference a client name that does not exist on the appliance.
UNKNOWN_FLOW_NAME - Static variable in class com.solacesystems.jcsmp.JCSMPErrorResponseSubcodeEx
An attempt to re-establish a publisher flow failed due to lack of publisher flow state.
UNKNOWN_QUEUE_NAME - Static variable in class com.solacesystems.jcsmp.JCSMPErrorResponseSubcodeEx
An attempt was made to bind to, or deprovision, an unknown Guaranteed Delivery Queue name (for example, the queue name is not configured on the appliance).
UNKNOWN_START_LOCATION_TYPE - Static variable in class com.solacesystems.jcsmp.JCSMPErrorResponseSubcodeEx
The request attempted to start a replay but provided an unknown.
UNKNOWN_TE_NAME - Static variable in class com.solacesystems.jcsmp.JCSMPErrorResponseSubcodeEx
An attempt was made to bind to, or deprovision an unknown Topic Endpoint name (for example, if the Topic Endpoint is not configured on appliance).
UNKNOWN_TRANSACTED_SESSION_NAME - Static variable in class com.solacesystems.jcsmp.JCSMPErrorResponseSubcodeEx
An attempt to re-establish a transacted session failed.
UNSUBSCRIBE_NOT_ALLOWED_CLIENTS_BOUND - Static variable in class com.solacesystems.jcsmp.JCSMPErrorResponseSubcodeEx
The client attempted to unsubscribe (delete the topic from a Topic Endpoint) while it had at least one bound client.
unsubscribeDurableTopicEndpoint(DurableTopicEndpoint) - Method in interface com.solacesystems.jcsmp.JCSMPSession
Unsubscribe from the durable Topic Endpoint.
UNTRUSTED_CLIENT_CERTIFICATE - Static variable in class com.solacesystems.jcsmp.JCSMPErrorResponseSubcodeEx
The client failed to connect to an appliance as it has a suspect client certificate.
User_Cos - Enum in com.solacesystems.jcsmp
Defines the possible Class of Service level of a given message.
USERNAME - Static variable in class com.solacesystems.jcsmp.JCSMPProperties
 

V

value() - Method in enum com.solacesystems.jcsmp.User_Cos
 
valueOf(String) - Static method in enum com.solacesystems.jcsmp.CacheLiveDataAction
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.solacesystems.jcsmp.CacheRequestResult
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.solacesystems.jcsmp.CapabilityType
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.solacesystems.jcsmp.DeliveryMode
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.solacesystems.jcsmp.FlowEvent
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.solacesystems.jcsmp.JCSMPErrorResponseSubcode
Deprecated.
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.solacesystems.jcsmp.JCSMPLogLevel
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.solacesystems.jcsmp.ProducerEvent
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.solacesystems.jcsmp.SessionEvent
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.solacesystems.jcsmp.transaction.TransactionStatus
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.solacesystems.jcsmp.User_Cos
Returns the enum constant of this type with the specified name.
values() - Static method in enum com.solacesystems.jcsmp.CacheLiveDataAction
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum com.solacesystems.jcsmp.CacheRequestResult
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum com.solacesystems.jcsmp.CapabilityType
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum com.solacesystems.jcsmp.DeliveryMode
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum com.solacesystems.jcsmp.FlowEvent
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum com.solacesystems.jcsmp.JCSMPErrorResponseSubcode
Deprecated.
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum com.solacesystems.jcsmp.JCSMPLogLevel
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum com.solacesystems.jcsmp.ProducerEvent
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Method in interface com.solacesystems.jcsmp.SDTMap
Returns a collection of all the values in the map.
values() - Static method in enum com.solacesystems.jcsmp.SessionEvent
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum com.solacesystems.jcsmp.transaction.TransactionStatus
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum com.solacesystems.jcsmp.User_Cos
Returns an array containing the constants of this enum type, in the order they are declared.
Version - Interface in com.solacesystems.common.config
 
VersionBean - Class in com.solacesystems.common.config
 
VersionBean(String, String, String) - Constructor for class com.solacesystems.common.config.VersionBean
 
VersionNotSupportException - Exception in com.solacesystems.jcsmp
Exception thrown when the appliance version is not compatible with the JCSMP version.
VersionNotSupportException(String) - Constructor for exception com.solacesystems.jcsmp.VersionNotSupportException
 
VersionNotSupportException(String, Throwable) - Constructor for exception com.solacesystems.jcsmp.VersionNotSupportException
 
VIRTUAL_ROUTER_NAME - Static variable in class com.solacesystems.jcsmp.JCSMPProperties
 
VPN_NAME - Static variable in class com.solacesystems.jcsmp.JCSMPProperties
 
VPN_NAME_IN_USE - Static variable in class com.solacesystems.jcsmp.JCSMPProperties
 

W

WAIT_FOR_CONFIRM - Static variable in interface com.solacesystems.jcsmp.JCSMPSession
If set, operations wait for a confirmation from the appliance before returning to the application.
writeAttachment(byte[]) - Method in interface com.solacesystems.jcsmp.XMLMessage
Writes a new attachment to the message.
writeAttachment(byte[], int, int) - Method in interface com.solacesystems.jcsmp.XMLMessage
Writes a new attachment to the message.
writeAttachment(InputStream) - Method in interface com.solacesystems.jcsmp.XMLMessage
Writes a new attachment to the message.
writeBoolean(Boolean) - Method in interface com.solacesystems.jcsmp.SDTStream
Writes a Boolean to a stream.
writeByte(Byte) - Method in interface com.solacesystems.jcsmp.SDTStream
Writes a Byte to a stream.
writeBytes(byte[]) - Method in interface com.solacesystems.jcsmp.BytesXMLMessage
Writes a byte array to the message content of the XML part, appending to existing content if present.
writeBytes(byte[], int, int) - Method in interface com.solacesystems.jcsmp.BytesXMLMessage
Writes a partial byte array to the message content of the XML part, appending to existing content if present.
writeBytes(byte[]) - Method in interface com.solacesystems.jcsmp.SDTStream
Writes a byte[] to a stream.
writeBytes(byte[], int, int) - Method in interface com.solacesystems.jcsmp.SDTStream
Writes a byte[] to a stream.
writeCharacter(Character) - Method in interface com.solacesystems.jcsmp.SDTStream
Writes a Character to a stream.
writeDestination(Destination) - Method in interface com.solacesystems.jcsmp.SDTStream
Writes a Destination to a stream.
writeDouble(Double) - Method in interface com.solacesystems.jcsmp.SDTStream
Writes a Double to a stream.
writeFloat(Float) - Method in interface com.solacesystems.jcsmp.SDTStream
Writes a Float to a stream.
writeInteger(Integer) - Method in interface com.solacesystems.jcsmp.SDTStream
Writes an Integer to a stream.
writeLong(Long) - Method in interface com.solacesystems.jcsmp.SDTStream
Writes a Long to a stream.
writeMap(SDTMap) - Method in interface com.solacesystems.jcsmp.SDTStream
Writes a SDTMap to a stream.
writeNewAttachment(byte[]) - Method in interface com.solacesystems.jcsmp.XMLMessage
Deprecated.
writeNewAttachment(byte[], int, int) - Method in interface com.solacesystems.jcsmp.XMLMessage
writeNewAttachment(InputStream, int, int) - Method in interface com.solacesystems.jcsmp.XMLMessage
Deprecated.
writeNewAttachment(InputStream) - Method in interface com.solacesystems.jcsmp.XMLMessage
Deprecated.
writeObject(Object) - Method in interface com.solacesystems.jcsmp.SDTStream
Writes an Object to a stream.
writeShort(Short) - Method in interface com.solacesystems.jcsmp.SDTStream
Writes a Short to a stream.
writeStream(SDTStream) - Method in interface com.solacesystems.jcsmp.SDTStream
Writes a SDTStream to a stream.
writeString(String) - Method in interface com.solacesystems.jcsmp.SDTStream
Writes a String to a stream.

X

XML_PARSE_ERROR - Static variable in class com.solacesystems.jcsmp.JCSMPErrorResponseSubcodeEx
The appliance could not parse an XML message.
XMLContentMessage - Interface in com.solacesystems.jcsmp
XMLContentMessage is used to send a message containing XML data.
XMLMessage - Interface in com.solacesystems.jcsmp
XMLMessage describes a message that is sent or received.
XMLMessageConsumer - Interface in com.solacesystems.jcsmp
XMLMessageConsumer provides an interface for an application to receive messages from a Solace appliance.
XMLMessageListener - Interface in com.solacesystems.jcsmp
XMLMessageListener is used to receive messages asynchronously.
XMLMessageProducer - Interface in com.solacesystems.jcsmp
XMLMessageProducer provides a session-dependent interface for applications to send messages to a Solace appliance.
A B C D E F G H I J K L M N O P Q R S T U V W X 
Skip navigation links

Copyright 2004-2021 Solace Corporation. All rights reserved.