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.

See: Description

Interface Summary

Interface	Description
Browser	A Browser allows client applications to look at messages spooled on Endpoints without removing them.
BytesMessage	BytesMessage is used to send a message containing a stream of uninterpreted bytes.
BytesXMLMessage	BytesXMLMessage describes a message that is sent or received.
CacheEventMessage	An event that signals the termination of a cache request.
CacheRequestListener	Listener that is notified on asynchronous cache request completion.
CacheSession	A Session for performing cache requests.
Consumer	Consumer objects are used to receive messages from the Solace Messaging Platform.
Context	A Context is used for organizing communications between applications and a Solace appliance.
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.
Endpoint	An Endpoint represents a appliance resource for consuming messages.
EventMessage	Base Interface for Event Messages sent through the datapath.
FlowEventHandler	A callback handler for flow events.
FlowReceiver	An interface for applications to receive messages from an Endpoint on a Solace appliance.
JCSMPProducerEventHandler	A callback handler for producer events ProducerEvent.
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.
JCSMPSendMultipleEntry	Represents a {Message, Destination} tuple used as part of a batch send operation.
JCSMPSession	JCSMPSession
JCSMPStreamingPublishCorrelatingEventHandler	A callback interface to handle responses from send operations asynchronously.
JCSMPStreamingPublishEventHandler	Deprecated Use JCSMPStreamingPublishCorrelatingEventHandler instead.
MapMessage	MapMessage is used to send a message containing a SDTMap.
Message	Message describes a message that is sent or received.
Producer	Producer is the super class of XMLMessageProducer.
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.
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.
SDTUnknownType	An unknown structured data type that can be used to provide compatibility with new structured data types.
Session	Session represents the main application interface.
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.
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.
XMLContentMessage	XMLContentMessage is used to send a message containing XML data.
XMLMessage	XMLMessage describes a message that is sent or received.
XMLMessage.MessageUserPropertyConstants	An interface contains the Solace-defined message user properties.
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.

Class Summary

Class	Description
BrowserProperties	Properties used for the creation of a Browser.
CacheSessionProperties	The cache properties used when creating a CacheSession.
ClientName	An Endpoint representing a remote client.
ConsumerFlowProperties	Properties for binding a consumer flow, used in JCSMPSession.createFlow(XMLMessageListener, ConsumerFlowProperties).
ContextProperties	Properties for configuring a Context upon creation.
DestinationUtils	Utility class for working with Destinations and marshaling them to Strings (network names).
DurableTopicEndpoint	Identifier for Solace appliance durable Topic Endpoints.
EndpointProperties	Endpoint properties used for provisioning durable endpoints, and for provisioning non-durable endpoints created through JCSMPSession.createFlow(XMLMessageListener listener, ConsumerFlowProperties flowProps).
FlowEventArgs	Represents a flow event notification.
JCSMPChannelProperties	JCSMPChannelProperties describes the properties required to create a channel connection with a Solace appliance.
JCSMPErrorResponseSubcodeEx	Subcode that gives more detailed information about an error response.
JCSMPFactory	Factory for obtaining instances of messaging system entities such as JCSMPSessions, Contexts, Endpoints, Destinations, and Subscriptions.
JCSMPGlobalProperties	This class exposes tunable settings for some of the Messaging API's internal functionality.
JCSMPProperties	Properties for customizing Session.
JCSMPPropertyMap
JCSMPRuntime	JCSMPRuntime provides JCSMP VM-wide runtime information, such as JCSMP version information, supported protocol stacks, and global statistics.
JCSMPSessionStats	Statistics associated with a Session.
JCSMPStats	Represents a set of message statistics.
JCSMPVersion	JCSMP version information.
MessageType	Deprecated Replaced by DeliveryMode.
ProducerEventArgs	Represents a producer event notification.
ProducerFlowProperties	Properties used for creating producer flows.
Queue	Identifier for Solace appliance Queue names.
SessionEventArgs	Represents a session event notification.
SubscriberEndpoint	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.
SubscriptionState	Deprecated SubscriptionState is no longer supported and its use has no effect.
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.

Enum Summary

Enum	Description
CacheLiveDataAction	The live data action dictates the disposition of live data received while the cache request is outstanding to the solCache.
CacheRequestResult	Result of a cache request.
CapabilityType
DeliveryMode	Represents the message delivery mode.
FlowEvent	Flow event types that can be given to the flow event callback handler ( FlowEventHandler) registered for a flow.
JCSMPErrorResponseSubcode	Deprecated Replaced by JCSMPErrorResponseSubcodeEx
JCSMPLogLevel	Represents a logging level in org.apache.commons.logging.
ProducerEvent	Producer event types that can be given to the producer event callback handler ( JCSMPProducerEventHandler).
SessionEvent	Session event types that can be given to the session event callback handler ( SessionEventHandler) registered for a session.
User_Cos	Defines the possible Class of Service level of a given message.
XMLMessage.Outcome	Represents the type for supported message settlement outcome

Exception Summary

Exception	Description
AccessDeniedException
ClosedFacilityException	ClosedFacilityException indicates that the requested operation cannot be fulfilled because the facility providing the operation was closed.
InvalidMessageReceivedException	InvalidMessageReceivedException is raised when the message received from the Solace appliance is not valid.
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.
JCSMPErrorResponseException	JCSMPErrorResponseException is used to capture Solace Message Format (SMF) response codes.
JCSMPException	The base class of JCSMP exceptions.
JCSMPFatalErrorException	JCSMPFatalErrorException indicates an unrecoverable error condition.
JCSMPFlowTransportException	Indicates a transport error condition for a specific flow, while the parent session is not necessarily closed.
JCSMPFlowTransportUnsolicitedUnbindException	This exception is used to indicate that a Guaranteed Delivery Flow (FlowReceiver) encountered a terminal condition making the flow unusable and must be closed/destroyed due to an unsolicited unbind for the resource it requires.
JCSMPInterruptedException
JCSMPLoginFailureException	Indicates a producer or consumer was unable to login to the 3200 Series appliance.
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.
JCSMPRequestTimeoutException	Indicates that a blocking request operation timed out.
JCSMPResponseTimeoutException	JCSMPResponseTimeoutException is used for client request timeout.
JCSMPSecurityException	Thrown when a security restriction prevents an operation from being performed.
JCSMPStateException	JCSMPStateException indicates that the program logic cannot proceed based on the current JCSMPSession state.
JCSMPTransportException	JCSMPTransportException indicates an error condition regarding communication with the Solace appliance.
OperationNotSupportedException	OperationNotSupportedException indicates the requested operation is not supported based on the current Session configuration.
PropertyMismatchException	A general exception for property mismatch problems.
SDTEOFException	SDTEOFException indicates a read operation was performed on an SDTStream which has no more data to read.
SDTException	The base class of SDT exceptions.
SDTFormatException	SDTFormatException indicates a type conversion error occurred retrieving data from an SDTMap or SDTStream.
StaleSessionException	StaleSessionException indicates that the requested operation cannot be fulfilled because the underlying session was stale.
SubscriptionsOutOfSynchException	Deprecated This class is no longer supported and will be removed in a future release.
VersionNotSupportException	Exception thrown when the appliance version is not compatible with the JCSMP version.

Package com.solacesystems.jcsmp Description

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. The Messaging API for Java is designed to be used as a base messaging layer, helping various client applications to communicate over the message bus of the Solace appliance.

The Messaging API supports both Point-to-Point (P2P) and Publish and Subscribe (Pub/Sub) messaging domains.

• Point-to-Point -- P2P messaging is built around the concept of message Queues that clients can publish messages to. Each message is addressed to a specific Queue. Consuming clients can also extract messages from Queues that hold messages for them.
• Publish and Subscribe -- Pub/Sub clients address messages to some node in a content hierarchy. These nodes are defined Topics. Publishers and subscribers are generally anonymous and may dynamically publish or subscribe to the content hierarchy. The Solace message bus distributes the messages published to a node to those clients that have subscribed to the same node.

The Messaging API for Java provides many features, including:

• Automatic connection management to Solace appliances
• Addition and removal of topic-based and content-based subscriptions
• Sending and receiving Direct and Guaranteed messages
• Structured data types that do not rely on a specific architecture or programming language
• Extensive support for logging and customizing through property parameters
• Request/Reply messaging support
• Queue Browser support
• SolCache client API support (for information, refer to SolCache—User Guide)

The current release of the API supports Solace appliances running software of version 4.4.x and above.