Uses of Package
com.solacesystems.jcsmp

Packages that use com.solacesystems.jcsmp

Package	Description
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.impl
com.solacesystems.jcsmp.transaction

Classes in com.solacesystems.jcsmp used by com.solacesystems.jcsmp

Class and Description
Browser A Browser allows client applications to look at messages spooled on Endpoints without removing them.
BrowserProperties Properties used for the creation of a Browser.
BytesMessage BytesMessage is used to send a message containing a stream of uninterpreted bytes.
BytesXMLMessage BytesXMLMessage describes a message that is sent or received.
CacheLiveDataAction The live data action dictates the disposition of live data received while the cache request is outstanding to the solCache.
CacheRequestListener Listener that is notified on asynchronous cache request completion.
CacheRequestResult Result of a cache request.
CacheSession A Session for performing cache requests.
CacheSessionProperties The cache properties used when creating a CacheSession.
CapabilityType
ClientName An Endpoint representing a remote client.
Consumer Consumer objects are used to receive messages from the Solace Messaging Platform.
ConsumerFlowProperties Properties for binding a consumer flow, used in JCSMPSession.createFlow(XMLMessageListener, ConsumerFlowProperties).
Context A Context is used for organizing communications between applications and a Solace appliance.
ContextProperties Properties for configuring a Context upon creation.
DeliveryMode Represents the message delivery mode.
Destination 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 Utility class for working with Destinations and marshaling them to Strings (network names).
DurableTopicEndpoint Identifier for Solace appliance durable Topic Endpoints.
Endpoint An Endpoint represents a appliance resource for consuming messages.
EndpointProperties Endpoint properties used for provisioning durable endpoints, and for provisioning non-durable endpoints created through JCSMPSession.createFlow(XMLMessageListener listener, ConsumerFlowProperties flowProps).
EventMessage Base Interface for Event Messages sent through the datapath.
FlowEvent Flow event types that can be given to the flow event callback handler ( FlowEventHandler) registered for a flow.
FlowEventArgs Represents a flow event notification.
FlowEventHandler A callback handler for flow events.
FlowReceiver An interface for applications to receive messages from an Endpoint on a Solace appliance.
InvalidOperationException 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.
InvalidPropertiesException InvalidPropertiesException indicates invalid properties are specified in JCSMPProperties.
JCSMPErrorResponseSubcode Deprecated. Replaced by JCSMPErrorResponseSubcodeEx
JCSMPException The base class of JCSMP exceptions.
JCSMPFactory Factory for obtaining instances of messaging system entities such as JCSMPSessions, Contexts, Endpoints, Destinations, and Subscriptions.
JCSMPFlowTransportException Indicates a transport error condition for a specific flow, while the parent session is not necessarily closed.
JCSMPGlobalProperties This class exposes tunable settings for some of the Messaging API's internal functionality.
JCSMPLogLevel Represents a logging level in org.apache.commons.logging.
JCSMPNotComparableException NotComparableException indicates that the comparison operation failed because the two objects being compared are semantically not comparable.
JCSMPOperationException JCSMPOperationException indicates an error condition related to Content Subscription Management Protocol (CSMP) operation.
JCSMPProducerEventHandler A callback handler for producer events ProducerEvent.
JCSMPProperties Properties for customizing Session.
JCSMPPropertyMap
JCSMPReconnectEventHandler JCSMPReconnectEventHandler is a callback interface called before and after the subscriber data channel is reestablished.
JCSMPResponseListener A callback interface to handle responses from asynchronous subscription operations.
JCSMPRuntime JCSMPRuntime provides JCSMP VM-wide runtime information, such as JCSMP version information, supported protocol stacks, and global statistics.
JCSMPSendMultipleEntry Represents a {Message, Destination} tuple used as part of a batch send operation.
JCSMPSession JCSMPSession
JCSMPSessionStats Statistics associated with a Session.
JCSMPStateException JCSMPStateException indicates that the program logic cannot proceed based on the current JCSMPSession state.
JCSMPStats Represents a set of message statistics.
JCSMPStreamingPublishEventHandler 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 JCSMPTransportException indicates an error condition regarding communication with the Solace appliance.
MapMessage MapMessage is used to send a message containing a SDTMap.
Message Message describes a message that is sent or received.
MessageType Deprecated. Replaced by DeliveryMode.
Producer Producer is the super class of XMLMessageProducer.
ProducerEvent Producer event types that can be given to the producer event callback handler ( JCSMPProducerEventHandler).
ProducerEventArgs Represents a producer event notification.
ProducerFlowProperties Properties used for creating producer flows.
Queue Identifier for Solace appliance Queue names.
ReplayStartLocation ReplayStartLocation specifies a message replay start location.
ReplayStartLocationDate JCSMPReplayStartLocationDate specifies a date and time based message replay start location.
ReplicationGroupMessageId ReplicationGroupMessageId specifies a Replication Group Message ID as a replay start location.
Requestor An interface for submitting requests to the Solace appliance network.
SDTException The base class of SDT exceptions.
SDTMap Map Structured Data Type (SDT) that maps case-sensitive Strings to a supported data type.
SDTStream Stream Structured Data Type (SDT) that supports the following data types: Boolean, Byte, byte[], Character, Destination, Double, Float, Integer, Long, SDTMap, Short, SDTStream, String.
Session Session represents the main application interface.
SessionEvent Session event types that can be given to the session event callback handler ( SessionEventHandler) registered for a session.
SessionEventArgs Represents a session event notification.
SessionEventHandler A callback handler for session events.
StreamMessage StreamMessage is used to send a message containing an SDTStream.
StreamXMLMessage Deprecated. Use of message types other than BytesXMLMessage is deprecated.
Subscription A Subscription object is used for control operations such as adding or removing subscriptions from the appliance.
SubscriptionState Deprecated. SubscriptionState is no longer supported and its use has no effect.
SubscriptionStateProvider Deprecated. SubscriptionStateProvider is no longer supported and its use has no effect.
TextMessage TextMessage is used to send a message containing text.
TextXMLMessage Deprecated. Use of message types other than BytesXMLMessage is deprecated.
Topic An identifier for Solace appliance topics and topic subscriptions.
TopicEndpoint Represents a TopicEndpoint, either durable or non-durable.
TopicProperties Gathers the properties to be used for constructing an instance of Topic.
User_Cos Defines the possible Class of Service level of a given message.
XMLContentMessage XMLContentMessage is used to send a message containing XML data.
XMLMessage XMLMessage describes a message that is sent or received.
XMLMessage.Outcome Represents the type for supported message settlement outcome
XMLMessageConsumer XMLMessageConsumer provides an interface for an application to receive messages from a Solace appliance.
XMLMessageListener XMLMessageListener is used to receive messages asynchronously.
XMLMessageProducer XMLMessageProducer provides a session-dependent interface for applications to send messages to a Solace appliance.

Classes in com.solacesystems.jcsmp used by com.solacesystems.jcsmp.impl

Class and Description
Destination 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.

Classes in com.solacesystems.jcsmp used by com.solacesystems.jcsmp.transaction

Class and Description
ConsumerFlowProperties Properties for binding a consumer flow, used in JCSMPSession.createFlow(XMLMessageListener, ConsumerFlowProperties).
EndpointProperties Endpoint properties used for provisioning durable endpoints, and for provisioning non-durable endpoints created through JCSMPSession.createFlow(XMLMessageListener listener, ConsumerFlowProperties flowProps).
FlowEventHandler A callback handler for flow events.
FlowReceiver An interface for applications to receive messages from an Endpoint on a Solace appliance.
JCSMPException The base class of JCSMP exceptions.
JCSMPOperationException JCSMPOperationException indicates an error condition related to Content Subscription Management Protocol (CSMP) operation.
JCSMPProducerEventHandler A callback handler for producer events ProducerEvent.
JCSMPStreamingPublishEventHandler 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.
ProducerFlowProperties Properties used for creating producer flows.
XMLMessageListener XMLMessageListener is used to receive messages asynchronously.
XMLMessageProducer XMLMessageProducer provides a session-dependent interface for applications to send messages to a Solace appliance.