JCSMPBasicSession (Solace JMS API v10.10.0)

java.lang.Object
- com.solacesystems.jcsmp.impl.JCSMPBasicSession

All Implemented Interfaces:

SessionSubscriptionEventListener, JCSMPDestinationSession, JCSMPSession, Session
```
public class JCSMPBasicSession
extends Object
implements JCSMPSession, JCSMPDestinationSession, SessionSubscriptionEventListener
```
JCSMPBasicSession The base class of JCSMPSession implementation

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class JCSMPBasicSession.InternalBindProperties

static class JCSMPBasicSession.TransientData

Nested Classes
Modifier and Type	Class and Description
`static class`	`JCSMPBasicSession.InternalBindProperties`
`static class`	`JCSMPBasicSession.TransientData`

Field Summary
- Fields inherited from interface com.solacesystems.jcsmp.JCSMPSession
  FLAG_IGNORE_ALREADY_EXISTS, FLAG_IGNORE_DOES_NOT_EXIST, WAIT_FOR_CONFIRM

Constructor Summary

Constructors
Constructor and Description
`JCSMPBasicSession(JCSMPProperties properties, SecureProperties secureProps, ContextImpl parentCtx, SessionEventHandler eventHandler)`
`JCSMPBasicSession(JCSMPProperties properties, SecureProperties secureProps, ContextImpl parentCtx, SessionEventHandler eventHandler, boolean allowSharedClientId)`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`void`	`addSubscriber()` Deprecated.
`void`	`addSubscription(Endpoint endpoint, Subscription subscription, int subscribeFlags)` Adds a subscription to an Endpoint on the appliance.
`void`	`addSubscription(Endpoint endpoint, Subscription subscription, JCSMPResponseListener listener, Object key)` Adds a subscription asynchronously to an Endpoint on the appliance.
`void`	`addSubscription(Subscription subscription)` Adds a subscription to the appliance.
`void`	`addSubscription(Subscription subscription, boolean waitForConfirm)` Adds a subscription to an appliance.
`void`	`addSubscription(Subscription subscription, JCSMPResponseListener listener, Object key)` Adds a subscription asynchronously to the appliance.
`Consumer`	`addSubscription(Subscription subscription, XMLMessageListener listener, ConsumerNotificationDispatcherFactory dispatcherFactory)` [SolReserved] For Topic Dispatching.
`void`	`applySubscriptions(Set<Subscription> subscriptions)` 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.
`void`	`clearSubscriber()` Removes a subscriber's CSMP-created subscriptions from the appliance.
`void`	`closeSession()` Closes the session.
`void`	`connect()` Connect to the appliance.
`Browser`	`createBrowser(BrowserProperties properties)` Creates a `Browser`, which can be used for browsing the contents of a Queue.
`Browser`	`createBrowser(BrowserProperties properties, FlowEventHandler flowEventHandler)` Creates a `Browser`, which can be used for browsing the contents of a Queue.
`CacheSession`	`createCacheSession(CacheSessionProperties properties)` Creates a CacheSession using the provided CacheSession properties.
`FlowReceiver`	`createFlow(Endpoint endpoint, Subscription newSubscription, XMLMessageListener listener)` Get an instance of `FlowReceiver` bound to a appliance Endpoint, such as a `Queue` or `TopicEndpoint`.
`FlowReceiver`	`createFlow(XMLMessageListener listener, ConsumerFlowProperties flowProperties)` Get an instance of `FlowReceiver` bound to an appliance Endpoint, such as a `Queue` or `TopicEndpoint`.
`FlowReceiver`	`createFlow(XMLMessageListener listener, ConsumerFlowProperties flowProperties, EndpointProperties endpointProps)` Get an instance of `FlowReceiver` bound to an appliance Endpoint, such as a `Queue` or `TopicEndpoint`.
`FlowReceiver`	`createFlow(XMLMessageListener listener, ConsumerFlowProperties flowProperties, EndpointProperties endpointProps, FlowEventHandler flowEventHandler)` Get an instance of `FlowReceiver` bound to an appliance Endpoint, such as a `Queue` or `TopicEndpoint`.
`FlowReceiver`	`createFlow(XMLMessageListener listener, ConsumerFlowProperties flowProperties, EndpointProperties endpointProps, JCSMPBasicSession.InternalBindProperties int_bind_prop)`
`FlowReceiver`	`createFlow(XMLMessageListener listener, ConsumerFlowProperties flowProperties, EndpointProperties endpointProps, JCSMPBasicSession.InternalBindProperties int_bind_prop, FlowEventHandler flowEventHandler)`
`static JCSMPGenericXMLMessage`	`createGenericXMLMessage(int contentSize, boolean useDirectBuffers, boolean isPub)`
`static JCSMPGenericXMLMessage`	`createGenericXMLMessage(JCSMPGenericXMLMessage toclone, boolean useDirect, boolean resetContent)`
`TopicEndpoint`	`createNonDurableTopicEndpoint()` Creates a non-durable Topic Endpoint.
`TopicEndpoint`	`createNonDurableTopicEndpoint(String name)` Creates a non-durable Topic Endpoint based on the given name.
`XMLMessageProducer`	`createProducer(ProducerFlowProperties fprop, JCSMPStreamingPublishEventHandler callback)` [SolReserved] Open a new producer flow using the specified properties.
`XMLMessageProducer`	`createProducer(ProducerFlowProperties fprop, JCSMPStreamingPublishEventHandler callback, JCSMPProducerEventHandler eventCallback)` [SolReserved] Open a new producer flow using the specified properties.
`XMLMessageProducer`	`createProducer(ProducerFlowProperties fprop, JCSMPStreamingPublishEventHandler streamCallback, JCSMPProducerEventHandler eventCallback, JCSMPBasicSession.InternalBindProperties internalBindProperties)`
`Requestor`	`createRequestor()` Creates a new `Requestor` for this Session.
`Queue`	`createTemporaryQueue()` Creates a temporary Queue for this Session.
`Queue`	`createTemporaryQueue(String name)` Creates a temporary Queue with the given name.
`Topic`	`createTemporaryTopic()` Creates a temporary Topic for this Session.
`TransactedSession`	`createTransactedSession()` Creates a new `TransactedSession` with the connected appliance.
`TransactedSession`	`createTransactedSessionInternal()`
`XASession`	`createXASession()` SolReserved - Creates a new `XASession` with the connected appliance.
`void`	`deleteSubscriber()`
`void`	`deprovision(Endpoint endpoint, long deprovisionFlags)` Deprovisions an Endpoint on the appliance.
`JndiMessage`	`executeJndiQuery(JndiMessage request)` SolReserved - Executes a JNDI query against the appliance, opening the control channel, if required.
`AssuredCtrlFactory`	`getAssuredCtrlFactory()`
`Object`	`getCapability(CapabilityType type)` Gets the value of a capability for the currently connected Session.
`TcpClientChannel`	`getClientChannel()`
`ClientInfoProvider`	`getClientInfoProvider()`
`JCSMPXMLMessageConsumer`	`getConsumer()`
`ContextImpl`	`getContext()`
`String`	`getGdReconnectFailAction()`
`JCSMPProperties`	`getJCSMPProperties()`
`XMLMessageConsumer`	`getMessageConsumer()` Deprecated.
`DestinationConsumer`	`getMessageConsumer(DestinationListener listener)` Get the instance of `DestinationConsumer`.
`DestinationConsumer`	`getMessageConsumer(DestinationSubscriptionStateProvider destinationSubscriptionStateProvider, DestinationListener listener)` Get the instance of `DestinationConsumer` with subscriptions out-of-sync checking.
`DestinationConsumer`	`getMessageConsumer(DestinationSubscriptionStateProvider destinationSubscriptionStateProvider, JCSMPReconnectEventHandler reconnectHandler, DestinationListener listener)` Get the instance of `DestinationConsumer` with subscriptions out-of-sync checking and reconnect event handler.
`XMLMessageConsumer`	`getMessageConsumer(JCSMPReconnectEventHandler reconnectHandler)` Deprecated.
`DestinationConsumer`	`getMessageConsumer(JCSMPReconnectEventHandler reconnectHandler, DestinationListener listener)` Get the instance of `DestinationConsumer` with a reconnect event handler.
`XMLMessageConsumer`	`getMessageConsumer(JCSMPReconnectEventHandler reconnectHandler, XMLMessageListener listener)` Get an instance of `XMLMessageConsumer` with a reconnect event handler.
`XMLMessageConsumer`	`getMessageConsumer(SubscriptionStateProvider subscriptionStateProvider)` Deprecated.
`XMLMessageConsumer`	`getMessageConsumer(SubscriptionStateProvider subscriptionStateProvider, JCSMPReconnectEventHandler reconnectHandler)` Deprecated.
`XMLMessageConsumer`	`getMessageConsumer(SubscriptionStateProvider subscriptionStateProvider, JCSMPReconnectEventHandler reconnectHandler, XMLMessageListener listener)` Deprecated.
`XMLMessageConsumer`	`getMessageConsumer(SubscriptionStateProvider subscriptionStateProvider, XMLMessageListener listener)` Deprecated.
`XMLMessageConsumer`	`getMessageConsumer(XMLMessageListener listener)` Get an instance of `XMLMessageConsumer`.
`XMLMessageProducer`	`getMessageProducer()`
`XMLMessageProducer`	`getMessageProducer(JCSMPStreamingPublishEventHandler callback)` Get an instance of `XMLMessageProducer`.
`DestinationProducer`	`getMessageProducer(JCSMPStreamingPublishEventHandler callback, Destination defaultTopic)` Get the instance of `DestinationProducer`.
`XMLMessageProducer`	`getMessageProducer(JCSMPStreamingPublishEventHandler callback, JCSMPProducerEventHandler eventCallback)` Get an instance of `XMLMessageProducer`.
`int`	`getNegotiatedMaxADCtrlVersion()`
`int`	`getNegotiatedMaxXAVersion()`
`int`	`getNegotiatedMinADCtrlVersion()`
`int`	`getNegotiatedMinXAVersion()`
`String`	`getP2pTopicDescriptionBase()`
`JCSMPXMLMessageProducer`	`getProducer()`
`Object`	`getProperty(String property)` Gets a Session property.
`PubFlowManager`	`getPubFlowManager()`
`TargetRouterMode`	`getRouterMode()`
`SecureProperties`	`getSecureProperties()`
`JCSMPException`	`getSessionAbortException()`
`String`	`getSessionID()`
`String`	`getSessionName()` If the session name is specified by `JCSMPProperties.SESSION_NAME`, this method returns the name specified.
`JCSMPSessionStats`	`getSessionStats()` Get this session's statistics.
`Set<Subscription>`	`getSubscriptionCache()` Gets an unmodifiable view of the Session's subscription cache.
`Object`	`getTransientData(JCSMPBasicSession.TransientData key)`
`String`	`getVirtualRouterName()`
`void`	`handleSessionEvent(SessionEventArgs event)`
`boolean`	`hasSessionEventHandler()`
`boolean`	`isCapable(CapabilityType ctype)` Checks if the specified capability is set on the currently connected Session.
`boolean`	`isClosed()` SolReserved - Checks if this session has been closed.
`boolean`	`isSessionReconnectAborted()`
`void`	`logFlowInfo(JCSMPLogLevel level)` Outputs a log at the specified log level that contains the flow state information for flows in this Session.
`void`	`logSessionStats(JCSMPLogLevel level)` Outputs a log at the specified log level containing a textual representation of the session statistics.
`void`	`notifySessionReconnectAborted(JCSMPException e)`
`void`	`notifySubscriptionEvent(SessionSubscriptionEvent ev)` Call here to process user subscription events for the Subscription Cache.
`void`	`notifyVridChange()`
`void`	`provision(Endpoint endpoint, EndpointProperties props, long provisionFlags)` Provisions an Endpoint on the appliance.
`void`	`putTransientData(JCSMPBasicSession.TransientData key, Object value, boolean noreplace)`
`boolean`	`reconnectInProgress()`
`void`	`reconnectInProgress(boolean status)`
`void`	`reestablishSubCache()` Reestablishes the subscription cache using non-retryable, non-blocking subscription adds.
`void`	`removeSubscriber()` Deprecated.
`void`	`removeSubscription(Endpoint endpoint, Subscription subscription, int unsubscribeFlags)` Removes a subscription from an Endpoint on the appliance.
`void`	`removeSubscription(Endpoint endpoint, Subscription subscription, JCSMPResponseListener listener, Object key)` Removes a subscription asynchronously from an Endpoint on the appliance.
`void`	`removeSubscription(Subscription subscription)` Removes a subscription from the appliance.
`void`	`removeSubscription(Subscription subscription, boolean waitForConfirm)` Removes a subscription from the appliance.
`void`	`removeSubscription(Subscription subscription, JCSMPResponseListener listener, Object key)` Removes a subscription asynchronously from the appliance.
`void`	`setJmsClientId(String clientId, boolean allowSharedClientId)`
`void`	`setP2pTopicDescriptionBase(String p2pTopicDescriptionBase)`
`void`	`setProperty(String property, Object value)` Sets a modifiable Session property once the Session has been constructed.
`void`	`unsubscribeDurableTopicEndpoint(DurableTopicEndpoint endpoint)` Unsubscribe from the durable Topic Endpoint.
`void`	`waitUntilSessionReconnectDone(String caller)`
`void`	`xaSessionMessageIdRenumbering(PubADManager adMgr)`

Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - JCSMPBasicSession
```
public JCSMPBasicSession(JCSMPProperties properties,
                         SecureProperties secureProps,
                         ContextImpl parentCtx,
                         SessionEventHandler eventHandler)
```
  - JCSMPBasicSession
```
public JCSMPBasicSession(JCSMPProperties properties,
                         SecureProperties secureProps,
                         ContextImpl parentCtx,
                         SessionEventHandler eventHandler,
                         boolean allowSharedClientId)
```
- Method Detail
  - notifySessionReconnectAborted
```
public void notifySessionReconnectAborted(JCSMPException e)
```
  - isSessionReconnectAborted
```
public boolean isSessionReconnectAborted()
```
  - getSessionAbortException
```
public JCSMPException getSessionAbortException()
```
  - getNegotiatedMinXAVersion
```
public int getNegotiatedMinXAVersion()
```
  - notifyVridChange
```
public void notifyVridChange()
```
  - getNegotiatedMaxXAVersion
```
public int getNegotiatedMaxXAVersion()
```
  - getPubFlowManager
```
public PubFlowManager getPubFlowManager()
```
  - xaSessionMessageIdRenumbering
```
public void xaSessionMessageIdRenumbering(PubADManager adMgr)
```
  - getNegotiatedMinADCtrlVersion
```
public int getNegotiatedMinADCtrlVersion()
```
  - getNegotiatedMaxADCtrlVersion
```
public int getNegotiatedMaxADCtrlVersion()
```
  - getGdReconnectFailAction
```
public String getGdReconnectFailAction()
```
  - getTransientData
```
public Object getTransientData(JCSMPBasicSession.TransientData key)
```
  - putTransientData
```
public void putTransientData(JCSMPBasicSession.TransientData key,
                             Object value,
                             boolean noreplace)
```
  - getContext
```
public ContextImpl getContext()
```
  - getSessionName
```
public String getSessionName()
```
    Description copied from interface: Session
    
    If the session name is specified by JCSMPProperties.SESSION_NAME, this method returns the name specified. Otherwise, a default name is returned.
    
    Specified by:
    
    getSessionName in interface Session
    
    Returns:
    
    The session name.
  - getRouterMode
```
public TargetRouterMode getRouterMode()
```
  - createGenericXMLMessage
```
public static JCSMPGenericXMLMessage createGenericXMLMessage(int contentSize,
                                                             boolean useDirectBuffers,
                                                             boolean isPub)
```
  - createGenericXMLMessage
```
public static JCSMPGenericXMLMessage createGenericXMLMessage(JCSMPGenericXMLMessage toclone,
                                                             boolean useDirect,
                                                             boolean resetContent)
```
  - closeSession
```
public void closeSession()
```
    Description copied from interface: Session
    
    Closes the session. Once a session is closed it must not be used again, an application must instead acquire a new session.
    Any XMLMessageProducer, XMLMessageConsumer, and channel connections associated with the session are also closed.
    
    Specified by:
    
    closeSession in interface Session
    
    See Also:
    
    Session.closeSession()
  - isClosed
```
public boolean isClosed()
```
    Description copied from interface: Session
    
    SolReserved - Checks if this session has been closed. Once a session is closed it must not be used again, an application must instead acquire a new session.
    
    Specified by:
    
    isClosed in interface Session
    
    Returns:
    
    true if the session has been closed, false otherwise.
  - getSessionStats
```
public JCSMPSessionStats getSessionStats()
```
    Description copied from interface: Session
    
    Get this session's statistics.
    
    Specified by:
    
    getSessionStats in interface Session
    
    Returns:
    
    The session statistics.
    
    See Also:
    
    Session.getSessionStats()
  - logSessionStats
```
public void logSessionStats(JCSMPLogLevel level)
```
    Description copied from interface: Session
    
    Outputs a log at the specified log level containing a textual representation of the session statistics.
    
    Specified by:
    
    logSessionStats in interface Session
    
    Parameters:
    
    level - The level (corresponding to org.apache.commons.logging levels) at which to output the log.
  - logFlowInfo
```
public void logFlowInfo(JCSMPLogLevel level)
```
    Description copied from interface: JCSMPSession
    
    Outputs a log at the specified log level that contains the flow state information for flows in this Session.
    
    Specified by:
    
    logFlowInfo in interface JCSMPSession
    
    Parameters:
    
    level - The level (corresponding to org.apache.commons.logging levels) at which to output the log.
  - addSubscriber
```
@Deprecated
public void addSubscriber()
                               throws JCSMPException
```
    Deprecated.
    
    Description copied from interface: Session
    
    Adds a subscriber to the appliance using the user information associated with the Session.
    If the user already exists on the appliance, this method still returns success.
    
    Specified by:
    
    addSubscriber in interface Session
    
    Throws:
    
    JCSMPException - If there was an error adding the subscriber.
    
    See Also:
    
    Session.addSubscriber()
  - removeSubscriber
```
@Deprecated
public void removeSubscriber()
                                  throws JCSMPException
```
    Deprecated.
    
    Description copied from interface: Session
    
    Removes a subscriber from the appliance using the user information associated with the Session.
    
    Specified by:
    
    removeSubscriber in interface Session
    
    Throws:
    
    JCSMPException - If there was an error removing the subscriber.
    
    See Also:
    
    Session.removeSubscriber()
  - clearSubscriber
```
public void clearSubscriber()
                     throws JCSMPException
```
    Description copied from interface: Session
    
    Removes a subscriber's CSMP-created subscriptions from the appliance.
    Note that if the subscriber has a large number of subscriptions, this operation can take a long time to return. If your application creates subscribers with several thousand subscriptions, it is advisable to increase the session's response timeout from the default, otherwise this operation could fail while waiting for the appliance to respond.
    
    Specified by:
    
    clearSubscriber in interface Session
    
    Throws:
    
    JCSMPException - If there was an error clearing the subscriber.
    
    OperationNotSupportedException - If performed on a closed session or a session not configured for this operation.
  - deleteSubscriber
```
public void deleteSubscriber()
                      throws JCSMPException
```
    Specified by:
    
    deleteSubscriber in interface Session
    
    Throws:
    
    JCSMPException
  - createProducer
```
public XMLMessageProducer createProducer(ProducerFlowProperties fprop,
                                         JCSMPStreamingPublishEventHandler callback)
                                  throws JCSMPException
```
    Description copied from interface: JCSMPSession
    
    [SolReserved] Open a new producer flow using the specified properties. Only streaming producers are allowed, so callback must not be null. A producer flow can only be used to send Guaranteed messages.
    
    Specified by:
    
    createProducer in interface JCSMPSession
    
    Parameters:
    
    fprop - The producer flow properties.
    
    callback - The streaming event handler.
    
    Returns:
    
    a new producer with its own producer flow
    
    Throws:
    
    InvalidOperationException - If the peer capabilities do not support features requested in this operation.
    
    JCSMPException - On other errors.
  - createProducer
```
public XMLMessageProducer createProducer(ProducerFlowProperties fprop,
                                         JCSMPStreamingPublishEventHandler callback,
                                         JCSMPProducerEventHandler eventCallback)
                                  throws JCSMPException
```
    Description copied from interface: JCSMPSession
    
    [SolReserved] Open a new producer flow using the specified properties. Only streaming producers are allowed, so callback must not be null. A producer flow can only be used to send Guaranteed messages.
    
    Specified by:
    
    createProducer in interface JCSMPSession
    
    Parameters:
    
    fprop - The producer flow properties.
    
    callback - The streaming event handler.
    
    eventCallback - A producer event handler.
    
    Returns:
    
    a new producer with its own producer flow
    
    Throws:
    
    InvalidOperationException - If the peer capabilities do not support features requested in this operation.
    
    JCSMPException - On other errors.
  - createProducer
```
public XMLMessageProducer createProducer(ProducerFlowProperties fprop,
                                         JCSMPStreamingPublishEventHandler streamCallback,
                                         JCSMPProducerEventHandler eventCallback,
                                         JCSMPBasicSession.InternalBindProperties internalBindProperties)
                                  throws JCSMPException
```
    Throws:
    
    JCSMPException
  - getMessageProducer
```
public XMLMessageProducer getMessageProducer()
                                      throws JCSMPException
```
    Specified by:
    
    getMessageProducer in interface JCSMPSession
    
    Throws:
    
    JCSMPException
  - getMessageProducer
```
public XMLMessageProducer getMessageProducer(JCSMPStreamingPublishEventHandler callback)
                                      throws JCSMPException
```
    Description copied from interface: JCSMPSession
    
    Get an instance of XMLMessageProducer.
    NOTE: For a given JCSMPSession, this method returns a new XMLMessageProducer object on each call, closing the existing producer if it exists.
    NOTE: To monitor transport events in publish only applications it is necessary to create an empty XMLMessageConsumer. see JCSMPSession.getMessageConsumer(JCSMPReconnectEventHandler, XMLMessageListener).
    
    Specified by:
    
    getMessageProducer in interface JCSMPSession
    
    Parameters:
    
    callback - A mandatory callback handler to set. By setting a callback handler, any send returns immediately without confirming the successful delivery of the message. Applications receive a response (when applicable) to the send asynchronously through the callback. For TR-mode clients, blocking publishing mode is not supported and the callback cannot be null. For legacy CR-mode clients, setting this to (JCSMPStreamingPublishEventHandler)null puts the producer in blocking mode.
    
    Returns:
    
    The message producer.
    
    Throws:
    
    JCSMPException - If acquiring the message producer failed.
    
    OperationNotSupportedException - If performed on a closed Session or a Session not configured for this operation.
    
    JCSMPErrorResponseException - If the operation fails with an error response, see JCSMPErrorResponseSubcodeEx for login failures.
    
    See Also:
    
    JCSMPSession.getMessageProducer(JCSMPStreamingPublishEventHandler)
  - getMessageProducer
```
public XMLMessageProducer getMessageProducer(JCSMPStreamingPublishEventHandler callback,
                                             JCSMPProducerEventHandler eventCallback)
                                      throws JCSMPException
```
    Description copied from interface: JCSMPSession
    
    Get an instance of XMLMessageProducer.
    NOTE: For a given JCSMPSession, this method returns a new XMLMessageProducer object on each call, closing the existing producer if it exists.
    NOTE: To monitor transport events in publish only applications it is necessary to create an empty XMLMessageConsumer. see JCSMPSession.getMessageConsumer(JCSMPReconnectEventHandler, XMLMessageListener).
    
    Specified by:
    
    getMessageProducer in interface JCSMPSession
    
    Parameters:
    
    callback - A mandatory stream callback handler to set. By setting a callback handler, any send returns immediately without confirming the successful delivery of the message. Applications receive a response (when applicable) to the send asynchronously through the callback. For TR-mode clients, blocking publishing mode is not supported and the callback cannot be null. For legacy CR-mode clients, setting this to (JCSMPStreamingPublishEventHandler)null puts the producer in blocking mode.
    
    eventCallback - A producer event handler.
    
    Returns:
    
    The message producer.
    
    Throws:
    
    JCSMPException - If acquiring the message producer failed.
    
    OperationNotSupportedException - If performed on a closed Session or a Session not configured for this operation.
    
    JCSMPErrorResponseException - If the operation fails with an error response, see JCSMPErrorResponseSubcodeEx for login failures.
    
    See Also:
    
    JCSMPSession.getMessageProducer(JCSMPStreamingPublishEventHandler)
  - getMessageConsumer
```
@Deprecated
public XMLMessageConsumer getMessageConsumer()
                                                  throws JCSMPException
```
    Deprecated.
    
    Specified by:
    
    getMessageConsumer in interface JCSMPSession
    
    Throws:
    
    JCSMPException
  - getMessageConsumer
```
public XMLMessageConsumer getMessageConsumer(XMLMessageListener listener)
                                      throws JCSMPException
```
    Description copied from interface: JCSMPSession
    
    Get an instance of XMLMessageConsumer.
    NOTE: For a given JCSMPSession, this method returns a new XMLMessageConsumer object on each call, closing the existing consumer if it exists.
    
    Specified by:
    
    getMessageConsumer in interface JCSMPSession
    
    Parameters:
    
    listener - Sets the message consumer's message listener. By setting a message listener, the message consumer works in asynchronous mode. Setting the message listener to ((XMLMessageListener)null) puts the message consumer in synchronous delivery mode.
    
    Returns:
    
    The message consumer.
    
    Throws:
    
    JCSMPException - If acquiring the message consumer failed.
    
    JCSMPErrorResponseException - If the operation fails with an error response, see JCSMPErrorResponseSubcodeEx for login failures.
    
    OperationNotSupportedException - If performed on a closed Session or a Session not configured for this operation.
    
    See Also:
    
    JCSMPSession.getMessageConsumer(XMLMessageListener)
  - getMessageConsumer
```
@Deprecated
public XMLMessageConsumer getMessageConsumer(SubscriptionStateProvider subscriptionStateProvider)
                                                  throws JCSMPException
```
    Deprecated.
    
    Specified by:
    
    getMessageConsumer in interface JCSMPSession
    
    Throws:
    
    JCSMPException
  - getMessageConsumer
```
@Deprecated
public XMLMessageConsumer getMessageConsumer(SubscriptionStateProvider subscriptionStateProvider,
                                                         XMLMessageListener listener)
                                                  throws JCSMPException
```
    Deprecated.
    
    Description copied from interface: JCSMPSession
    
    Get an instance of XMLMessageConsumer with subscriptions out-of-sync checking.
    If the subscriptions on the appliance are not in sync with the SubscriptionState returned from SubscriptionStateProvider, SubscriptionsOutOfSynchException is raised.
    NOTE: For a given JCSMPSession, this method returns a new XMLMessageConsumer object on each call, closing the existing consumer, if applicable.
    
    Specified by:
    
    getMessageConsumer in interface JCSMPSession
    
    Parameters:
    
    subscriptionStateProvider - An implementation of SubscriptionStateProvider.
    
    listener - Sets the message consumer's message listener. By setting a message listener, the message consumer works in asynchronous mode. Setting the message listener to null puts the message consumer in synchronous delivery mode.
    
    Returns:
    
    The message consumer.
    
    Throws:
    
    JCSMPException - If acquiring the message consumer failed.
    
    OperationNotSupportedException - If performed on a closed Session or a Session not configured for this operation.
  - getMessageConsumer
```
@Deprecated
public XMLMessageConsumer getMessageConsumer(JCSMPReconnectEventHandler reconnectHandler)
                                                  throws JCSMPException
```
    Deprecated.
    
    Specified by:
    
    getMessageConsumer in interface JCSMPSession
    
    Throws:
    
    JCSMPException
  - getMessageConsumer
```
public XMLMessageConsumer getMessageConsumer(JCSMPReconnectEventHandler reconnectHandler,
                                             XMLMessageListener listener)
                                      throws JCSMPException
```
    Description copied from interface: JCSMPSession
    
    Get an instance of XMLMessageConsumer with a reconnect event handler.
    If auto-reconnect is enabled through the subscriber data channel's reconnectRetries in JCSMPChannelProperties, upon detecting the loss of the connection, JCSMPReconnectEventHandler.preReconnect() is called before JCSMP attempts to reestablish the connection with the appliance. If the method call returns the value false, the auto-reconnect process aborts. If the method call returns the value true, auto-reconnect process starts. When the connection is established successfully, JCSMPReconnectEventHandler.postReconnect() is called. To detect a permanent loss of a connection (when retries are exhausted) the method XMLMessageListener.onException(JCSMPException) will be called.
    NOTE: For a given JCSMPSession, this method returns a new XMLMessageConsumer object on each call, closing the existing consumer if it exists.
    
    Specified by:
    
    getMessageConsumer in interface JCSMPSession
    
    Parameters:
    
    reconnectHandler - An implementation of JCSMPReconnectEventHandler. This is strongly recommended when operating in client mode, since topic subscriptions do not persist between connections on the appliance.
    
    listener - Sets the message consumer's message listener. By setting a message listener, the message consumer works in asynchronous mode. Setting the message listener to null puts the message consumer in synchronous delivery mode.
    
    Returns:
    
    The message consumer.
    
    Throws:
    
    JCSMPException - If acquiring the message consumer failed.
    
    JCSMPErrorResponseException - If the operation fails with an error response, see JCSMPErrorResponseSubcodeEx for login failures.
    
    OperationNotSupportedException - If performed on a closed Session or a Session not configured for this operation.
  - getMessageConsumer
```
@Deprecated
public XMLMessageConsumer getMessageConsumer(SubscriptionStateProvider subscriptionStateProvider,
                                                         JCSMPReconnectEventHandler reconnectHandler)
                                                  throws JCSMPException
```
    Deprecated.
    
    Specified by:
    
    getMessageConsumer in interface JCSMPSession
    
    Throws:
    
    JCSMPException
  - getMessageConsumer
```
@Deprecated
public XMLMessageConsumer getMessageConsumer(SubscriptionStateProvider subscriptionStateProvider,
                                                         JCSMPReconnectEventHandler reconnectHandler,
                                                         XMLMessageListener listener)
                                                  throws JCSMPException
```
    Deprecated.
    
    Description copied from interface: JCSMPSession
    
    Get an instance of XMLMessageConsumer with subscriptions out-of-sync checking and reconnect event handler.
    If the subscriptions on the appliance are not in sync with the SubscriptionState returned from SubscriptionStateProvider, SubscriptionsOutOfSynchException is raised.
    If auto-reconnect is enabled through the subscriber data channel's reconnectRetries in JCSMPChannelProperties, when detecting the loss of the connection, JCSMPReconnectEventHandler.preReconnect() is called before JCSMP attempts to re-establish the connection with the appliance. If the method call returns the value false, the auto-reconnect process aborts. If the method call returns the value true, the auto-reconnect process starts. When the connection is established successfully, JCSMPReconnectEventHandler.postReconnect() is called.
    NOTE: For a given JCSMPSession, this method returns a new XMLMessageConsumer object on each call, closing the existing consumer, if applicable.
    
    Specified by:
    
    getMessageConsumer in interface JCSMPSession
    
    Parameters:
    
    subscriptionStateProvider - An implementation of SubscriptionStateProvider.
    
    listener - Sets the message consumer's message listener. By setting a message listener, the message consumer works in asynchronous mode. Setting the message listener to null puts the message consumer in synchronous delivery mode.
    
    Returns:
    
    The message consumer.
    
    Throws:
    
    JCSMPException - If acquiring the message consumer failed.
    
    OperationNotSupportedException - If performed on a closed Session or a Session not configured for this operation.
  - applySubscriptions
```
public void applySubscriptions(Set<Subscription> subscriptions)
                        throws JCSMPException
```
    Description copied from interface: 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.
    The application can call this method at any time to initiate a subscription refresh. Only valid if the Session is operating in non-client mode.
    
    Specified by:
    
    applySubscriptions in interface JCSMPSession
    
    Parameters:
    
    subscriptions - A Set<Subscription> of Subscription objects.
    
    Throws:
    
    OperationNotSupportedException - If performed on a closed Session or a Session not configured for this operation.
    
    JCSMPException - On any other error condition.
  - getSessionID
```
public String getSessionID()
```
  - getClientChannel
```
public TcpClientChannel getClientChannel()
```
  - getJCSMPProperties
```
public JCSMPProperties getJCSMPProperties()
```
  - getSecureProperties
```
public SecureProperties getSecureProperties()
```
  - addSubscription
```
public void addSubscription(Subscription subscription)
                     throws JCSMPException
```
    Description copied from interface: JCSMPSession
    
    Adds a subscription to the appliance. This method blocks until the subscription operation has been confirmed. It is equivaelent to passing TRUE as the second argument to: JCSMPSession.addSubscription(Subscription, boolean)
    Specified by:
    
    addSubscription in interface JCSMPSession
    
    Parameters:
    
    subscription - The subscription to add.
    
    Throws:
    JCSMPErrorResponseException - With detailed error information on error responses from the appliance. Error response subcodes:
    
    JCSMPErrorResponseSubcodeEx.SUBSCRIPTION_INVALID
    
    JCSMPErrorResponseSubcodeEx.SUBSCRIPTION_ALREADY_PRESENT
    
    JCSMPErrorResponseSubcodeEx.SUBSCRIPTION_TOO_MANY
    
    JCSMPErrorResponseSubcodeEx.OUT_OF_RESOURCES
    
    JCSMPErrorResponseSubcodeEx.SUBSCRIPTION_ACL_DENIED
    OperationNotSupportedException - If performed on a closed Session or a Session not configured for this operation.
    
    JCSMPException - On any other error condition.
  - addSubscription
```
public void addSubscription(Subscription subscription,
                            boolean waitForConfirm)
                     throws JCSMPException
```
    Description copied from interface: JCSMPSession
    
    Adds a subscription to an appliance. This method allows aaplications to add subscriptions choosing whether or not to wait for a confirmation.
    This method is used to add a subscription in either a blocking or non-blocking mode. Setting waitForConfirm to false prevents the API from waiting for a response before returning. In this mode, a response is only sent by the appliance if the subscription is rejected, and such a response is delivered to the session event handler. It is invalid to set waitForConfirm to false on a Session where no Session event handler is set, and such an operation throws OperationNotSupportedException. NOTE: When waitForConfirm is false the application will never receive a positive confirmation, only errors are sent by callback. When waitForConfirm is true, this method does not return until the appliance has responded to the subscription operation, it throws on error and otherwise returns to indicate the subscription operation was successful.
    Specified by:
    
    addSubscription in interface JCSMPSession
    
    Parameters:
    
    subscription - The subscription to add.
    
    waitForConfirm - Whether to request, and wait for, a response from the appliance before returning.
    
    Throws:
    JCSMPErrorResponseException - With detailed error information on error responses from the appliance. Error response subcodes:
    
    JCSMPErrorResponseSubcodeEx.SUBSCRIPTION_INVALID
    
    JCSMPErrorResponseSubcodeEx.SUBSCRIPTION_ALREADY_PRESENT
    
    JCSMPErrorResponseSubcodeEx.SUBSCRIPTION_TOO_MANY
    
    JCSMPErrorResponseSubcodeEx.OUT_OF_RESOURCES
    
    JCSMPErrorResponseSubcodeEx.SUBSCRIPTION_ACL_DENIED
    OperationNotSupportedException - If performed on a closed Session or a Session not configured for this operation.
    
    JCSMPException - On any other error condition.
  - addSubscription
```
public Consumer addSubscription(Subscription subscription,
                                XMLMessageListener listener,
                                ConsumerNotificationDispatcherFactory dispatcherFactory)
                         throws JCSMPException
```
    Description copied from interface: JCSMPSession
    
    [SolReserved] For Topic Dispatching. Adds the subscription to the topic dispatching subscription map and sends a blocking subscription add to the appliance. Adds a subscription to the appliance.
    Specified by:
    
    addSubscription in interface JCSMPSession
    
    Parameters:
    
    subscription - The subscription to add.
    
    listener - The XMLMessageListener to receive the incoming before returning.
    
    Throws:
    JCSMPErrorResponseException - With detailed error information on error responses from the appliance. Error response subcodes:
    
    JCSMPErrorResponseSubcodeEx.SUBSCRIPTION_INVALID
    
    JCSMPErrorResponseSubcodeEx.SUBSCRIPTION_ALREADY_PRESENT
    
    JCSMPErrorResponseSubcodeEx.SUBSCRIPTION_TOO_MANY
    
    JCSMPErrorResponseSubcodeEx.OUT_OF_RESOURCES
    
    JCSMPErrorResponseSubcodeEx.SUBSCRIPTION_ACL_DENIED
    OperationNotSupportedException - If performed on a closed Session or a Session not configured for this operation.
    
    JCSMPException - On any other error condition.
  - removeSubscription
```
public void removeSubscription(Subscription subscription)
                        throws JCSMPException
```
    Description copied from interface: JCSMPSession
    
    Removes a subscription from the appliance.
    Specified by:
    
    removeSubscription in interface JCSMPSession
    
    Parameters:
    
    subscription - The subscription to remove.
    
    Throws:
    JCSMPErrorResponseException - With detailed error information on error responses from the appliance. Error response subcodes:
    
    JCSMPErrorResponseSubcodeEx.SUBSCRIPTION_INVALID
    
    JCSMPErrorResponseSubcodeEx.SUBSCRIPTION_NOT_FOUND
    OperationNotSupportedException - If performed on a closed Session or a Session not configured for this operation.
    
    JCSMPException - On any other error condition.
  - removeSubscription
```
public void removeSubscription(Subscription subscription,
                               boolean waitForConfirm)
                        throws JCSMPException
```
    Description copied from interface: JCSMPSession
    
    Removes a subscription from the appliance.
    Setting waitForConfirm to false prevents the API from waiting for a response before returning. In this mode, the appliance only sends a response if the subscription is rejected, and such a response is delivered to the session event handler. It is invalid to set waitForConfirm to false on a Session where no Session event handler is set; such an operation throws OperationNotSupportedException.
    Specified by:
    
    removeSubscription in interface JCSMPSession
    
    Parameters:
    
    subscription - The subscription to remove.
    
    waitForConfirm - Whether to request, and wait for, a response from the appliance before returning.
    
    Throws:
    JCSMPErrorResponseException - With detailed error information on error responses from the appliance. Error response subcodes:
    
    JCSMPErrorResponseSubcodeEx.SUBSCRIPTION_INVALID
    
    JCSMPErrorResponseSubcodeEx.SUBSCRIPTION_NOT_FOUND
    OperationNotSupportedException - If performed on a closed Session or a Session not configured for this operation.
    
    JCSMPException - On any other error condition.
  - addSubscription
```
public void addSubscription(Endpoint endpoint,
                            Subscription subscription,
                            int subscribeFlags)
                     throws JCSMPException
```
    Description copied from interface: JCSMPSession
    Adds a subscription to an Endpoint on the appliance. The Endpoint targeted can be either a Queue or a ClientName.
    Adding subscriptions to Queues
    Guaranteed messages are published to a Queue when it is set as the destination of the message. However, you can also add one or more topic subscriptions to a durable or temporary queue so that Guaranteed messages published to those topics are also delivered to the Queue.
    - Only a Queue Endpoint can be used.
    - Only a Topic subscription can be used.
    - Must have modify-topic permissions on the Endpoint.
    Adding subscriptions to remote clients
    A subscription manager client may add subscriptions on behalf of other clients. These topic subscriptions are not retained in the subscription cache and will not be reapplied upon reconnection.
    - Only a ClientName Endpoint can be used.
    - Only a Topic subscription can be used.
    - Must have subscription-manager permissions on the client username.
    General notes
    If subscribe Flag JCSMPSession.WAIT_FOR_CONFIRM is specified, the API waits for a response before returning, otherwise the API returns immediately after sending the update to the appliance. If JCSMPSession.WAIT_FOR_CONFIRM is not specified, negative responses are delivered to the session event handler. On a Session where no Session event handler is set, an OperationNotSupportedException is thrown if JCSMPSession.WAIT_FOR_CONFIRM is not specified.
    JCSMPProperties.REAPPLY_SUBSCRIPTIONS will only apply direct topic subscriptions unpon a Session reconnect. It will not reapply topic subscriptions on durable and non-durable endpoints.
    Specified by:
    
    addSubscription in interface JCSMPSession
    
    Parameters:
    
    endpoint - The Endpoint to add the subscription on. If null, behaves like JCSMPSession.addSubscription(Subscription, boolean).
    
    subscription - The subscription to add.
    
    subscribeFlags - The valid flag is JCSMPSession.WAIT_FOR_CONFIRM
    
    Throws:
    JCSMPErrorResponseException - With detailed error information on error responses from the appliance. Error response subcodes:
    
    JCSMPErrorResponseSubcodeEx.SUBSCRIPTION_INVALID
    
    JCSMPErrorResponseSubcodeEx.SUBSCRIPTION_ALREADY_PRESENT
    
    JCSMPErrorResponseSubcodeEx.SUBSCRIPTION_TOO_MANY
    
    JCSMPErrorResponseSubcodeEx.OUT_OF_RESOURCES
    
    JCSMPErrorResponseSubcodeEx.SUBSCRIPTION_ACL_DENIED
    
    JCSMPErrorResponseSubcodeEx.UNKNOWN_QUEUE_NAME
    
    JCSMPErrorResponseSubcodeEx.UNKNOWN_CLIENT_NAME
    
    JCSMPErrorResponseSubcodeEx.SUBSCRIPTION_MANAGER_DENIED
    OperationNotSupportedException - If performed on a closed Session or a Session not configured for this operation.
    
    JCSMPException - On any other error condition.
  - removeSubscription
```
public void removeSubscription(Endpoint endpoint,
                               Subscription subscription,
                               int unsubscribeFlags)
                        throws JCSMPException
```
    Description copied from interface: JCSMPSession
    
    Removes a subscription from an Endpoint on the appliance. Used to remove subscriptions added by the JCSMPSession.addSubscription(Endpoint, Subscription, int) method. Refer to that method's documentation for operational parameters. This method cannot remove subscriptions added through the CLI.
    Specified by:
    
    removeSubscription in interface JCSMPSession
    
    Parameters:
    
    endpoint - The Endpoint to remove the subscription from. If null, behaves like JCSMPSession.removeSubscription(Subscription, boolean).
    
    subscription - The subscription to remove.
    
    unsubscribeFlags - Valid flag is JCSMPSession.WAIT_FOR_CONFIRM
    
    Throws:
    JCSMPErrorResponseException - With detailed error information on error responses from the appliance. Error response subcodes:
    
    JCSMPErrorResponseSubcodeEx.SUBSCRIPTION_INVALID
    
    JCSMPErrorResponseSubcodeEx.SUBSCRIPTION_NOT_FOUND
    
    JCSMPErrorResponseSubcodeEx.UNKNOWN_QUEUE_NAME
    
    JCSMPErrorResponseSubcodeEx.UNKNOWN_CLIENT_NAME
    
    JCSMPErrorResponseSubcodeEx.SUBSCRIPTION_MANAGER_DENIED
    OperationNotSupportedException - If performed on a closed Session or a Session not configured for this operation.
    
    JCSMPException - On any other error condition.
  - getMessageConsumer
```
public DestinationConsumer getMessageConsumer(DestinationListener listener)
                                       throws JCSMPException
```
    Description copied from interface: JCSMPDestinationSession
    
    Get the instance of DestinationConsumer.
    NOTE: For a given JCSMPDestinationSession, this method returns a new DestinationConsumer object on each call, closing the existing consumer if it exists.
    
    Specified by:
    
    getMessageConsumer in interface JCSMPDestinationSession
    
    Parameters:
    
    listener - Sets the destination consumer's message listener. By setting a message listener, the destination consumer works in asynchronous mode. Setting the message listener to null puts the message consumer in synchronous delivery mode.
    
    Returns:
    
    The destination consumer.
    
    Throws:
    
    JCSMPException - if acquiring the destination consumer failed.
    
    OperationNotSupportedException - if performed on a closed session or a session not configured for this operation.
  - getMessageConsumer
```
public DestinationConsumer getMessageConsumer(JCSMPReconnectEventHandler reconnectHandler,
                                              DestinationListener listener)
                                       throws JCSMPException
```
    Description copied from interface: JCSMPDestinationSession
    
    Get the instance of DestinationConsumer with a reconnect event handler.
    If auto-reconnect is enabled through the subscriber data channel's reconnectRetries in JCSMPChannelProperties, when connection loss is detected, JCSMPReconnectEventHandler.preReconnect() is called before JCSMP attempts to re-establish the connection with the appliance. If the method call returns the value false, the auto-reconnect process aborts. If the method call returns the value true, the auto-reconnect process starts. When the connection is established successfully, JCSMPReconnectEventHandler.postReconnect() is called.
    NOTE: For a given JCSMPDestinationSession, this method returns a new DestinationConsumer object on each call, closing the existing consumer (if it exists).
    
    Specified by:
    
    getMessageConsumer in interface JCSMPDestinationSession
    
    Parameters:
    
    reconnectHandler - an instance of a JCSMPReconnectEventHandler
    
    listener - Sets the destination consumer's message listener. By setting a message listener, the destination consumer works in asynchronous mode. Setting the message listener to null puts the message consumer in synchronous delivery mode.
    
    Returns:
    
    the destination consumer.
    
    Throws:
    
    JCSMPException - if acquiring the destination consumer failed.
    
    OperationNotSupportedException - if performed on a closed session, or a session not configured for this operation.
  - getMessageConsumer
```
public DestinationConsumer getMessageConsumer(DestinationSubscriptionStateProvider destinationSubscriptionStateProvider,
                                              DestinationListener listener)
                                       throws JCSMPException
```
    Description copied from interface: JCSMPDestinationSession
    
    Get the instance of DestinationConsumer with subscriptions out-of-sync checking.
    If the destination subscriptions on the appliance are not in sync with the DestinationSubscriptionState returned from DestinationSubscriptionStateProvider, SubscriptionsOutOfSynchException is raised.
    NOTE: For a given JCSMPDestinationSession, this method returns a new DestinationConsumer object on each call, closing the existing consumer if it exists.
    
    Specified by:
    
    getMessageConsumer in interface JCSMPDestinationSession
    
    Parameters:
    
    destinationSubscriptionStateProvider - An implementation of DestinationSubscriptionStateProvider.
    
    listener - Sets the destination consumer's message listener. By setting a message listener, the destination consumer works in asynchronous mode. Setting the message listener to null puts the message consumer in synchronous delivery mode.
    
    Returns:
    
    The destination consumer.
    
    Throws:
    
    JCSMPException - if acquiring the destination consumer failed.
    
    OperationNotSupportedException - if performed on a closed session, or a session not configured for this operation.
  - getMessageConsumer
```
public DestinationConsumer getMessageConsumer(DestinationSubscriptionStateProvider destinationSubscriptionStateProvider,
                                              JCSMPReconnectEventHandler reconnectHandler,
                                              DestinationListener listener)
                                       throws JCSMPException
```
    Description copied from interface: JCSMPDestinationSession
    
    Get the instance of DestinationConsumer with subscriptions out-of-sync checking and reconnect event handler.
    If the destination subscriptions on the appliance are not in sync with the DestinationSubscriptionState returned from DestinationSubscriptionStateProvider, SubscriptionsOutOfSynchException is raised.
    If auto-reconnect is enabled through the subscriber data channel's reconnectRetries in JCSMPChannelProperties, when detecting the loss of the connection, JCSMPReconnectEventHandler.preReconnect() is called before JCSMP attempts to re-establish the connection with the appliance. If the method call returns the value false, the auto-reconnect process aborts. If the method call returns the value true, the auto-reconnect process starts. When the connection is established successfully, JCSMPReconnectEventHandler.postReconnect() is called.
    NOTE: For a given JCSMPDestinationSession, this method returns a new DestinationConsumer object on each call, closing the existing consumer (if it exists).
    
    Specified by:
    
    getMessageConsumer in interface JCSMPDestinationSession
    
    Parameters:
    
    destinationSubscriptionStateProvider - An implementation of DestinationSubscriptionStateProvider.
    
    listener - Sets the destination consumer's message listener. By setting a message listener, the destination consumer works in asynchronous mode. Setting the message listener to null puts the message consumer in synchronous delivery mode.
    
    Returns:
    
    The destination consumer.
    
    Throws:
    
    JCSMPException - if acquiring the destination consumer failed.
    
    OperationNotSupportedException - if performed on a closed session, or a session not configured for this operation.
  - unsubscribeDurableTopicEndpoint
```
public void unsubscribeDurableTopicEndpoint(DurableTopicEndpoint endpoint)
                                     throws JCSMPException
```
    Description copied from interface: JCSMPSession
    
    Unsubscribe from the durable Topic Endpoint. This method can only be called if no clients are currently bound to the Endpoint. Unsubscribing from the durable Topic Endpoint causes any spooled messages on this Endpoint to be deleted.
    This method is only valid if the Session is operating in non-client mode.
    Specified by:
    
    unsubscribeDurableTopicEndpoint in interface JCSMPSession
    
    Parameters:
    
    endpoint - The durable Topic Endpoint on the appliance to unsubscribe from.
    
    Throws:
    JCSMPErrorResponseException - If the unsubscribe command is rejected. With detailed error information on error responses from the appliance. Error response subcodes:
    
    JCSMPErrorResponseSubcodeEx.UNKNOWN_TE_NAME
    JCSMPException - On any other error.
  - createFlow
```
public FlowReceiver createFlow(Endpoint endpoint,
                               Subscription newSubscription,
                               XMLMessageListener listener)
                        throws JCSMPException
```
    Description copied from interface: JCSMPSession
    
    Get an instance of FlowReceiver bound to a appliance Endpoint, such as a Queue or TopicEndpoint. Each time this method is called, it returns a new FlowReceiver object.
    Specified by:
    
    createFlow in interface JCSMPSession
    
    Parameters:
    
    endpoint - The appliance Endpoint to bind to.
    
    newSubscription - If binding to a TopicEndpoint the Topic to set/replace as a topic subscription on the endpoint. This must be specified for a TopicEndpoint, null otherwise.
    
    listener - (optional) A callback listener to be used for asynchronous notification. If null, synchronous notification is used.
    
    Returns:
    
    A new FlowReceiver instance.
    
    Throws:
    
    OperationNotSupportedException - If the Session configuration does not allow the operation.
    JCSMPErrorResponseException - With detailed error information on error responses from the appliance. Error response subcodes:
    
    JCSMPErrorResponseSubcodeEx.CANNOT_BIND_TO_QUEUE
    
    JCSMPErrorResponseSubcodeEx.ENDPOINT_ALREADY_EXISTS
    
    JCSMPErrorResponseSubcodeEx.PERMISSION_NOT_ALLOWED
    
    JCSMPErrorResponseSubcodeEx.MAX_CLIENTS_FOR_QUEUE
    
    JCSMPErrorResponseSubcodeEx.MAX_CLIENTS_FOR_TE
    
    JCSMPErrorResponseSubcodeEx.UNKNOWN_QUEUE_NAME
    
    JCSMPErrorResponseSubcodeEx.UNKNOWN_TE_NAME
    
    JCSMPErrorResponseSubcodeEx.QUEUE_SHUTDOWN
    
    JCSMPErrorResponseSubcodeEx.TE_SHUTDOWN
    
    JCSMPErrorResponseSubcodeEx.NO_MORE_NON_DURABLE_QUEUE_OR_TE
    
    JCSMPErrorResponseSubcodeEx.INVALID_TOPIC_NAME_FOR_TE
    InvalidOperationException - If the peer capabilities do not support features requested in this operation.
    
    JCSMPException - Other error cases.
  - createFlow
```
public FlowReceiver createFlow(XMLMessageListener listener,
                               ConsumerFlowProperties flowProperties)
                        throws JCSMPException
```
    Description copied from interface: JCSMPSession
    
    Get an instance of FlowReceiver bound to an appliance Endpoint, such as a Queue or TopicEndpoint. This method returns a new FlowReceiver object each time it is called.
    
    Note: If the flow's message acknowledge mode is JCSMPProperties.SUPPORTED_MESSAGE_ACK_AUTO (the default behaviour), then the call to this method is ignored and a warning log is generated.
    Specified by:
    
    createFlow in interface JCSMPSession
    
    Parameters:
    
    listener - (optional) A callback listener to be used for asynchronous notification. If null, synchronous notification is used.
    
    flowProperties - Consumer flow properties, like Guaranteed message window size, Endpoint to bind to, and so on.
    
    Returns:
    
    A new FlowReceiver instance.
    
    Throws:
    
    OperationNotSupportedException - If the Session configuration does not allow the operation.
    JCSMPErrorResponseException - With detailed error information on error responses from the appliance. Error response subcodes:
    
    JCSMPErrorResponseSubcodeEx.CANNOT_BIND_TO_QUEUE
    
    JCSMPErrorResponseSubcodeEx.ENDPOINT_ALREADY_EXISTS
    
    JCSMPErrorResponseSubcodeEx.PERMISSION_NOT_ALLOWED
    
    JCSMPErrorResponseSubcodeEx.MAX_CLIENTS_FOR_QUEUE
    
    JCSMPErrorResponseSubcodeEx.MAX_CLIENTS_FOR_TE
    
    JCSMPErrorResponseSubcodeEx.UNKNOWN_QUEUE_NAME
    
    JCSMPErrorResponseSubcodeEx.UNKNOWN_TE_NAME
    
    JCSMPErrorResponseSubcodeEx.QUEUE_SHUTDOWN
    
    JCSMPErrorResponseSubcodeEx.TE_SHUTDOWN
    
    JCSMPErrorResponseSubcodeEx.NO_MORE_NON_DURABLE_QUEUE_OR_TE
    
    JCSMPErrorResponseSubcodeEx.INVALID_TOPIC_NAME_FOR_TE
    
    JCSMPErrorResponseSubcodeEx.SUBSCRIPTION_MATCH_ERROR
    
    JCSMPErrorResponseSubcodeEx.SELECTOR_MATCH_ERROR
    
    JCSMPErrorResponseSubcodeEx.SELECTOR_INVALID
    InvalidOperationException - If the peer capabilities do not support features requested in this operation.
    
    JCSMPException - Other error cases.
  - createFlow
```
public FlowReceiver createFlow(XMLMessageListener listener,
                               ConsumerFlowProperties flowProperties,
                               EndpointProperties endpointProps)
                        throws JCSMPException
```
    Description copied from interface: JCSMPSession
    
    Get an instance of FlowReceiver bound to an appliance Endpoint, such as a Queue or TopicEndpoint. This method returns a new FlowReceiver object each time it is called.
    Specified by:
    
    createFlow in interface JCSMPSession
    
    Parameters:
    
    listener - (optional) A callback listener to be used for asynchronous notification. If null, synchronous notification is used.
    
    flowProperties - Consumer flow properties, like Guaranteed message window size, Endpoint to bind to, and so on.
    
    endpointProps - (optional) Endpoint properties for the created temporary Endpoint (when binding to a temporary / non-durable Endpoint). If null, default Endpoint properties are applied by the appliance.
    
    Returns:
    
    A new FlowReceiver instance.
    
    Throws:
    
    OperationNotSupportedException - If the Session configuration does not allow the operation.
    JCSMPErrorResponseException - With detailed error information on error responses from the appliance. Error response subcodes:
    
    JCSMPErrorResponseSubcodeEx.CANNOT_BIND_TO_QUEUE
    
    JCSMPErrorResponseSubcodeEx.ENDPOINT_ALREADY_EXISTS
    
    JCSMPErrorResponseSubcodeEx.PERMISSION_NOT_ALLOWED
    
    JCSMPErrorResponseSubcodeEx.MAX_CLIENTS_FOR_QUEUE
    
    JCSMPErrorResponseSubcodeEx.MAX_CLIENTS_FOR_TE
    
    JCSMPErrorResponseSubcodeEx.UNKNOWN_QUEUE_NAME
    
    JCSMPErrorResponseSubcodeEx.UNKNOWN_TE_NAME
    
    JCSMPErrorResponseSubcodeEx.QUEUE_SHUTDOWN
    
    JCSMPErrorResponseSubcodeEx.TE_SHUTDOWN
    
    JCSMPErrorResponseSubcodeEx.NO_MORE_NON_DURABLE_QUEUE_OR_TE
    
    JCSMPErrorResponseSubcodeEx.INVALID_TOPIC_NAME_FOR_TE
    InvalidOperationException - If the peer capabilities do not support features requested in this operation.
    
    JCSMPException - Other error cases.
  - createFlow
```
public FlowReceiver createFlow(XMLMessageListener listener,
                               ConsumerFlowProperties flowProperties,
                               EndpointProperties endpointProps,
                               FlowEventHandler flowEventHandler)
                        throws JCSMPException
```
    Description copied from interface: JCSMPSession
    
    Get an instance of FlowReceiver bound to an appliance Endpoint, such as a Queue or TopicEndpoint. This method returns a new FlowReceiver object each time it is called.
    Specified by:
    
    createFlow in interface JCSMPSession
    
    Parameters:
    
    listener - (optional) A callback listener to be used for asynchronous notification. If null, synchronous notification is used.
    
    flowProperties - Consumer flow properties, like Guaranteed message window size, Endpoint to bind to, and so on.
    
    endpointProps - (optional) Endpoint properties for the created temporary Endpoint (when binding to a temporary / non-durable Endpoint). If null, default Endpoint properties are applied by the appliance.
    
    flowEventHandler - (optional) A callback listener registered to a flow to receive flow active or flow inactive event if active flow indication is set to true in the consumer flow properties. See ConsumerFlowProperties.setActiveFlowIndication(boolean).
    
    Returns:
    
    A new FlowReceiver instance.
    
    Throws:
    
    OperationNotSupportedException - If the Session configuration does not allow the operation.
    JCSMPErrorResponseException - With detailed error information on error responses from the appliance. Error response subcodes:
    
    JCSMPErrorResponseSubcodeEx.CANNOT_BIND_TO_QUEUE
    
    JCSMPErrorResponseSubcodeEx.ENDPOINT_ALREADY_EXISTS
    
    JCSMPErrorResponseSubcodeEx.PERMISSION_NOT_ALLOWED
    
    JCSMPErrorResponseSubcodeEx.MAX_CLIENTS_FOR_QUEUE
    
    JCSMPErrorResponseSubcodeEx.MAX_CLIENTS_FOR_TE
    
    JCSMPErrorResponseSubcodeEx.UNKNOWN_QUEUE_NAME
    
    JCSMPErrorResponseSubcodeEx.UNKNOWN_TE_NAME
    
    JCSMPErrorResponseSubcodeEx.QUEUE_SHUTDOWN
    
    JCSMPErrorResponseSubcodeEx.TE_SHUTDOWN
    
    JCSMPErrorResponseSubcodeEx.NO_MORE_NON_DURABLE_QUEUE_OR_TE
    
    JCSMPErrorResponseSubcodeEx.INVALID_TOPIC_NAME_FOR_TE
    InvalidOperationException - If the peer capabilities do not support features requested in this operation.
    
    InvalidPropertiesException - If active flow indication is set to true in the consumer properties, but flow event handler parameter is set to null.
    
    JCSMPException - Other error cases.
  - createFlow
```
public FlowReceiver createFlow(XMLMessageListener listener,
                               ConsumerFlowProperties flowProperties,
                               EndpointProperties endpointProps,
                               JCSMPBasicSession.InternalBindProperties int_bind_prop)
                        throws JCSMPException
```
    Throws:
    
    JCSMPException
  - createFlow
```
public FlowReceiver createFlow(XMLMessageListener listener,
                               ConsumerFlowProperties flowProperties,
                               EndpointProperties endpointProps,
                               JCSMPBasicSession.InternalBindProperties int_bind_prop,
                               FlowEventHandler flowEventHandler)
                        throws JCSMPException
```
    Throws:
    
    JCSMPException
  - getMessageProducer
```
public DestinationProducer getMessageProducer(JCSMPStreamingPublishEventHandler callback,
                                              Destination defaultTopic)
                                       throws JCSMPException
```
    Description copied from interface: JCSMPDestinationSession
    
    Get the instance of DestinationProducer.
    NOTE: For a given JCSMPDestinationSession, this method returns a new DestinationProducer object on each call, closing the existing producer (if it exists).
    
    Specified by:
    
    getMessageProducer in interface JCSMPDestinationSession
    
    Parameters:
    
    callback - Callback handler to set. By setting a streaming callback handler, any send returns immediately without confirming the successful delivery of the message. Applications receive the response of the send asynchronously through the callback. Setting this to null puts the producer in blocking mode.
    
    defaultTopic - the default Destination. If null, the default Destination is left unset.
    
    Returns:
    
    The destination producer.
    
    Throws:
    
    JCSMPException - if acquiring the destination producer failed.
    
    OperationNotSupportedException - if performed on a closed session, or a session not configured for this operation.
    
    See Also:
    
    JCSMPSession.getMessageProducer(JCSMPStreamingPublishEventHandler)
  - executeJndiQuery
```
public JndiMessage executeJndiQuery(JndiMessage request)
                             throws JCSMPException
```
    Description copied from interface: JCSMPSession
    
    SolReserved - Executes a JNDI query against the appliance, opening the control channel, if required.
    
    Specified by:
    
    executeJndiQuery in interface JCSMPSession
    
    Parameters:
    
    request - The JNDI request to execute.
    
    Returns:
    
    A new JndiMessage object containing the response.
    
    Throws:
    
    JCSMPException - on error
  - setProperty
```
public void setProperty(String property,
                        Object value)
                 throws JCSMPException
```
    Description copied from interface: JCSMPSession
    Sets a modifiable Session property once the Session has been constructed.
    Modifiable properties include:
    - CLIENT_NAME (in TBRM only)
    Note: Modifying a Session property while the channel to the appliance is disconnected can cause it to connect and go through the authentication process.
    Specified by:
    
    setProperty in interface JCSMPSession
    
    Parameters:
    
    property - The name of the property to modify.
    
    value - The new value of the property.
    
    Throws:
    
    JCSMPTransportException - If a transport error occurs.
    
    JCSMPErrorResponseException - If the appliance rejects the modification.
    
    JCSMPException - On other errors.
  - getProperty
```
public Object getProperty(String property)
```
    Description copied from interface: JCSMPSession
    
    Gets a Session property.
    
    Specified by:
    
    getProperty in interface JCSMPSession
    
    Parameters:
    
    property - The requested property name.
    
    Returns:
    
    The requested property, or null if it does not exist.
  - getP2pTopicDescriptionBase
```
public String getP2pTopicDescriptionBase()
```
  - setP2pTopicDescriptionBase
```
public void setP2pTopicDescriptionBase(String p2pTopicDescriptionBase)
```
  - getProducer
```
public JCSMPXMLMessageProducer getProducer()
```
  - getConsumer
```
public JCSMPXMLMessageConsumer getConsumer()
```
  - createCacheSession
```
public CacheSession createCacheSession(CacheSessionProperties properties)
                                throws JCSMPException
```
    Description copied from interface: JCSMPSession
    
    Creates a CacheSession using the provided CacheSession properties.
    
    Specified by:
    
    createCacheSession in interface JCSMPSession
    
    Parameters:
    
    properties - Properties for the CacheSession.
    
    Returns:
    
    The created CacheSession.
    
    Throws:
    
    JCSMPException - on error
  - createRequestor
```
public Requestor createRequestor()
                          throws JCSMPException
```
    Description copied from interface: JCSMPSession
    
    Creates a new Requestor for this Session. Applications are responsible for having previously created an XMLMessageProducer and XMLMessageConsumer on this Session. The XMLMessageConsumer must be started before performing a request.
    
    Specified by:
    
    createRequestor in interface JCSMPSession
    
    Returns:
    
    A new Requestor instance.
    
    Throws:
    
    JCSMPException - on error
  - hasSessionEventHandler
```
public boolean hasSessionEventHandler()
```
  - handleSessionEvent
```
public void handleSessionEvent(SessionEventArgs event)
```
  - createTemporaryQueue
```
public Queue createTemporaryQueue()
                           throws JCSMPException
```
    Description copied from interface: JCSMPSession
    
    Creates a temporary Queue for this Session. This Queue should only be bound to by a consumer on this Session; although other Sessions can publish to it.
    This operation requires that the Session be previously connected to the appliance, as appliance capabilities must be populated to create non-durable entities.
    
    Specified by:
    
    createTemporaryQueue in interface JCSMPSession
    
    Returns:
    
    A new non-durable Queue.
    
    Throws:
    
    JCSMPException - on error
  - createTemporaryQueue
```
public Queue createTemporaryQueue(String name)
                           throws JCSMPException
```
    Description copied from interface: JCSMPSession
    
    Creates a temporary Queue with the given name. This Queue should only be bound to by a consumer on this Session; although other Sessions can publish to it. This operation requires that the Session be previously connected to the appliance, as appliance capabilities must be populated to create non-durable entities.
    
    Specified by:
    
    createTemporaryQueue in interface JCSMPSession
    
    Parameters:
    
    name - The name of the temporary Queue.
    
    Returns:
    
    A new non-durable Queue.
    
    Throws:
    
    JCSMPException - on error
  - createTemporaryTopic
```
public Topic createTemporaryTopic()
                           throws JCSMPException
```
    Description copied from interface: JCSMPSession
    
    Creates a temporary Topic for this Session. This Topic should only be bound to by a consumer on this Session; although other Sessions can publish to it. This operation requires that the Session be previously connected to the appliance, as appliance capabilities must be populated to create non-durable entities. The temporary Topic's physical name is fully generated by JCSMP to provide uniqueness.
    
    Specified by:
    
    createTemporaryTopic in interface JCSMPSession
    
    Returns:
    
    A new temporary Topic.
    
    Throws:
    
    JCSMPException - on error
  - createNonDurableTopicEndpoint
```
public TopicEndpoint createNonDurableTopicEndpoint()
                                            throws JCSMPException
```
    Description copied from interface: JCSMPSession
    
    Creates a non-durable Topic Endpoint. It must be bound to by a consumer on this Session. This operation requires that the Session be previously connected to the appliance, as appliance capabilities must be populated to create non-durable entities.
    
    Specified by:
    
    createNonDurableTopicEndpoint in interface JCSMPSession
    
    Returns:
    
    A new non-durable Topic Endpoint.
    
    Throws:
    
    JCSMPException - on error
  - createNonDurableTopicEndpoint
```
public TopicEndpoint createNonDurableTopicEndpoint(String name)
                                            throws JCSMPException
```
    Description copied from interface: JCSMPSession
    
    Creates a non-durable Topic Endpoint based on the given name. The Topic Endpoint should only be bound to by a consumer on this Session. This operation requires that the Session be previously connected to the appliance, as appliance capabilities must be populated to create non-durable entities.
    
    Specified by:
    
    createNonDurableTopicEndpoint in interface JCSMPSession
    
    Parameters:
    
    name - The name of the non-durable Topic Endpoint.
    
    Returns:
    
    A new non-durable Topic Endpoint.
    
    Throws:
    
    JCSMPException - on error
  - getCapability
```
public Object getCapability(CapabilityType type)
                     throws JCSMPException
```
    Description copied from interface: JCSMPSession
    
    Gets the value of a capability for the currently connected Session.
    The returned value is an object of the type specified in CapabilityType.
    This operation requires that the Session be previously connected to the appliance. If the Session is not connected, requesting a capability will throw InvalidOperationException. Otherwise, the last known value reported is returned.
    
    Specified by:
    
    getCapability in interface JCSMPSession
    
    Returns:
    
    The value of the specified capability.
    
    Throws:
    
    JCSMPException
  - isCapable
```
public boolean isCapable(CapabilityType ctype)
```
    Description copied from interface: JCSMPSession
    
    Checks if the specified capability is set on the currently connected Session. This is a convenience function to be used with Boolean capabilities. It throws IllegalArgumentException if the provided key does not allow conversion of the value to boolean.
    If the Session has never been connected, requesting a capability returns false. Otherwise, the last known value is returned.
    
    Specified by:
    
    isCapable in interface JCSMPSession
    
    Parameters:
    
    ctype - The capability to check.
    
    Returns:
    
    Whether this capability is set.
  - connect
```
public void connect()
             throws JCSMPException
```
    Description copied from interface: JCSMPSession
    Connect to the appliance. This operation establishes channels for publishing and subscribing, and authenticates with the appliance. If the Session is already connected, this call has no effect. Although a JCSMPSession can be connected as a side effect of requesting a producer or consumer, as best practice it is recommended to always explicitly connect before.
    After connect() returns, the Session is connected to the appliance. At this point, the appliance's information and capabilities are populated, and can be queried by JCSMPSession.getCapability(CapabilityType). Some Session operations require the Session to be connected before attempting them, such as:
    Specified by:
    
    connect in interface JCSMPSession
    
    Throws:
    
    JCSMPTransportException - If a connection exception occurs.
    
    JCSMPException - On other failures.
  - reestablishSubCache
```
public void reestablishSubCache()
                         throws JCSMPException
```
    Reestablishes the subscription cache using non-retryable, non-blocking subscription adds. If a transport exception occurs, we throw it up to fail the reconnect task. Error responses are ignored.
    
    Throws:
    
    JCSMPException
  - notifySubscriptionEvent
```
public void notifySubscriptionEvent(SessionSubscriptionEvent ev)
```
    Call here to process user subscription events for the Subscription Cache. Valid to call in all cases, will ignore if the subscription caching feature is disabled.
    
    Specified by:
    
    notifySubscriptionEvent in interface SessionSubscriptionEventListener
  - getClientInfoProvider
```
public ClientInfoProvider getClientInfoProvider()
```
  - setJmsClientId
```
public void setJmsClientId(String clientId,
                           boolean allowSharedClientId)
                    throws JCSMPException
```
    Specified by:
    
    setJmsClientId in interface JCSMPSession
    
    Throws:
    
    JCSMPException
  - getSubscriptionCache
```
public Set<Subscription> getSubscriptionCache()
```
    Description copied from interface: JCSMPSession
    
    Gets an unmodifiable view of the Session's subscription cache. The set is empty if JCSMPProperties.REAPPLY_SUBSCRIPTIONS is disabled.
    
    Specified by:
    
    getSubscriptionCache in interface JCSMPSession
    
    Returns:
    
    An unmodifiable view of the Session's subscription cache.
  - getVirtualRouterName
```
public String getVirtualRouterName()
```
  - deprovision
```
public void deprovision(Endpoint endpoint,
                        long deprovisionFlags)
                 throws JCSMPException
```
    Description copied from interface: JCSMPSession
    Deprovisions an Endpoint on the appliance. Provisioning operations are not retried upon failure or timeout, regardless of Session auto-reconnection settings.
    Allowed flags for the deprovisioning operation include:
    - JCSMPSession.FLAG_IGNORE_DOES_NOT_EXIST
    Specified by:
    
    deprovision in interface JCSMPSession
    
    Parameters:
    
    endpoint - The Endpoint to deprovision.
    
    deprovisionFlags - Deprovisioning flags.
    
    Throws:
    JCSMPErrorResponseException - With detailed error information on error responses from the appliance. Error response subcodes:
    
    JCSMPErrorResponseSubcodeEx.UNKNOWN_QUEUE_NAME
    
    JCSMPErrorResponseSubcodeEx.UNKNOWN_TE_NAME
    
    JCSMPErrorResponseSubcodeEx.PERMISSION_NOT_ALLOWED
    JCSMPException - on error
  - provision
```
public void provision(Endpoint endpoint,
                      EndpointProperties props,
                      long provisionFlags)
               throws JCSMPException
```
    Description copied from interface: JCSMPSession
    Provisions an Endpoint on the appliance. Provisioning operations are not retried upon failure or timeout, regardless of Session auto-reconnection settings.
    Allowed flags for the provisioning operation include:
    - JCSMPSession.FLAG_IGNORE_ALREADY_EXISTS
    Specified by:
    
    provision in interface JCSMPSession
    
    Parameters:
    
    endpoint - Endpoint to provision.
    
    props - Properties for the provisioned Endpoint.
    
    provisionFlags - Provisioning flags.
    
    Throws:
    JCSMPErrorResponseException - With detailed error information on error responses from the appliance. Error response subcodes:
    
    JCSMPErrorResponseSubcodeEx.ENDPOINT_ALREADY_EXISTS
    
    JCSMPErrorResponseSubcodeEx.ENDPOINT_PROPERTY_MISMATCH
    
    JCSMPErrorResponseSubcodeEx.DELETE_IN_PROGRESS
    
    JCSMPErrorResponseSubcodeEx.OUT_OF_RESOURCES
    
    JCSMPErrorResponseSubcodeEx.NO_MORE_NON_DURABLE_QUEUE_OR_TE
    JCSMPException - on error
  - createBrowser
```
public Browser createBrowser(BrowserProperties properties)
                      throws JCSMPException
```
    Description copied from interface: JCSMPSession
    
    Creates a Browser, which can be used for browsing the contents of a Queue.
    Specified by:
    
    createBrowser in interface JCSMPSession
    
    Parameters:
    
    properties - The Browser properties used for creation.
    
    Throws:
    JCSMPErrorResponseException - With detailed error information on error responses from the appliance. Error response subcodes:
    
    JCSMPErrorResponseSubcodeEx.CANNOT_BIND_TO_QUEUE
    
    JCSMPErrorResponseSubcodeEx.PERMISSION_NOT_ALLOWED
    
    JCSMPErrorResponseSubcodeEx.MAX_CLIENTS_FOR_QUEUE
    
    JCSMPErrorResponseSubcodeEx.MAX_CLIENTS_FOR_TE
    
    JCSMPErrorResponseSubcodeEx.UNKNOWN_QUEUE_NAME
    
    JCSMPErrorResponseSubcodeEx.UNKNOWN_TE_NAME
    
    JCSMPErrorResponseSubcodeEx.QUEUE_SHUTDOWN
    
    JCSMPErrorResponseSubcodeEx.TE_SHUTDOWN
    JCSMPException - on other exceptions.
  - createBrowser
```
public Browser createBrowser(BrowserProperties properties,
                             FlowEventHandler flowEventHandler)
                      throws JCSMPException
```
    Description copied from interface: JCSMPSession
    
    Creates a Browser, which can be used for browsing the contents of a Queue.
    Specified by:
    
    createBrowser in interface JCSMPSession
    
    Parameters:
    
    properties - The Browser properties used for creation.
    
    flowEventHandler - (optional) A callback listener registered to a flow to receive flow active or flow inactive event if active flow indication is set to true in the consumer flow properties. See ConsumerFlowProperties.setActiveFlowIndication(boolean).
    
    Throws:
    JCSMPErrorResponseException - With detailed error information on error responses from the appliance. Error response subcodes:
    
    JCSMPErrorResponseSubcodeEx.CANNOT_BIND_TO_QUEUE
    
    JCSMPErrorResponseSubcodeEx.PERMISSION_NOT_ALLOWED
    
    JCSMPErrorResponseSubcodeEx.MAX_CLIENTS_FOR_QUEUE
    
    JCSMPErrorResponseSubcodeEx.MAX_CLIENTS_FOR_TE
    
    JCSMPErrorResponseSubcodeEx.UNKNOWN_QUEUE_NAME
    
    JCSMPErrorResponseSubcodeEx.UNKNOWN_TE_NAME
    
    JCSMPErrorResponseSubcodeEx.QUEUE_SHUTDOWN
    
    JCSMPErrorResponseSubcodeEx.TE_SHUTDOWN
    JCSMPException - on other exceptions.
  - createTransactedSession
```
public TransactedSession createTransactedSession()
                                          throws JCSMPException
```
    Description copied from interface: JCSMPSession
    
    Creates a new TransactedSession with the connected appliance. This call blocks until the TransactedSession is successfully created.
    
    Specified by:
    
    createTransactedSession in interface JCSMPSession
    
    Returns:
    
    A new TransactedSession.
    
    Throws:
    
    JCSMPException - on error
  - createTransactedSessionInternal
```
public TransactedSession createTransactedSessionInternal()
                                                  throws JCSMPException
```
    Throws:
    
    JCSMPException
  - createXASession
```
public XASession createXASession()
                          throws JCSMPException
```
    Description copied from interface: JCSMPSession
    
    SolReserved - Creates a new XASession with the connected appliance. This call blocks until the XASession is successfully created.
    
    Specified by:
    
    createXASession in interface JCSMPSession
    
    Returns:
    
    A new XASession
    
    Throws:
    
    JCSMPException - on error
  - waitUntilSessionReconnectDone
```
public void waitUntilSessionReconnectDone(String caller)
                                   throws JCSMPException
```
    Throws:
    
    JCSMPException
  - reconnectInProgress
```
public void reconnectInProgress(boolean status)
```
  - reconnectInProgress
```
public boolean reconnectInProgress()
```
  - getAssuredCtrlFactory
```
public AssuredCtrlFactory getAssuredCtrlFactory()
```
  - addSubscription
```
public void addSubscription(Subscription subscription,
                            JCSMPResponseListener listener,
                            Object key)
                     throws JCSMPException
```
    Description copied from interface: JCSMPSession
    
    Adds a subscription asynchronously to the appliance. The API returns immediately after sending an add subscription request to the appliance. A router confirmation will be delivered to the subscription event handler instead.
    
    Specified by:
    
    addSubscription in interface JCSMPSession
    
    Parameters:
    
    subscription - The subscription to add.
    
    listener - The subscription event handler
    
    key - The correlation key of the add subscription operation
    
    Throws:
    
    OperationNotSupportedException - If performed on a closed Session or a Session not configured for this operation.
    
    JCSMPException - On any other error condition.
  - addSubscription
```
public void addSubscription(Endpoint endpoint,
                            Subscription subscription,
                            JCSMPResponseListener listener,
                            Object key)
                     throws JCSMPException
```
    Description copied from interface: JCSMPSession
    Adds a subscription asynchronously to an Endpoint on the appliance. The Endpoint targeted can be either a Queue or a ClientName.
    Guaranteed messages are published to a Queue when it is set as the destination of the message. However, you can also add one or more topic subscriptions to a durable or temporary queue so that Guaranteed messages published to those topics are also delivered to the Queue.
    
    Only a Queue Endpoint can be used.
    
    Only a Topic subscription can be used.
    
    Must have modify-topic permissions on the Endpoint.
    
    Adding subscriptions to remote clients
    A subscription manager client may add subscriptions on behalf of other clients. These topic subscriptions are not retained in the subscription cache and will not be reapplied upon reconnection.
    
    Only a ClientName Endpoint can be used.
    
    Only a Topic subscription can be used.
    
    Must have subscription-manager permissions on the client username.
    
    General notes
    The API returns immediately after sending an add subscription request to the appliance. A router confirmation will be delivered to the subscription event handler instead.
    JCSMPProperties.REAPPLY_SUBSCRIPTIONS will not reapply topic subscriptions on durable and non-durable endpoints.
    Specified by:
    
    addSubscription in interface JCSMPSession
    
    Parameters:
    
    endpoint - The Endpoint to add the subscription on.
    
    subscription - The subscription to add.
    
    listener - The subscription event handler
    
    key - The correlation key of the add subscription operation
    
    Throws:
    
    OperationNotSupportedException - If performed on a closed Session or a Session not configured for this operation.
    
    JCSMPException - On any other error condition.
  - removeSubscription
```
public void removeSubscription(Subscription subscription,
                               JCSMPResponseListener listener,
                               Object key)
                        throws JCSMPException
```
    Description copied from interface: JCSMPSession
    
    Removes a subscription asynchronously from the appliance. The API returns immediately after sending a remove subscription request to the appliance. A router confirmation will be delivered to the subscription event handler instead.
    
    Specified by:
    
    removeSubscription in interface JCSMPSession
    
    Parameters:
    
    subscription - The subscription to remove.
    
    listener - The subscription event handler
    
    key - The correlation key of the remove subscription operation
    
    Throws:
    
    OperationNotSupportedException - If performed on a closed Session or a Session not configured for this operation.
    
    JCSMPException - On any other error condition.
  - removeSubscription
```
public void removeSubscription(Endpoint endpoint,
                               Subscription subscription,
                               JCSMPResponseListener listener,
                               Object key)
                        throws JCSMPException
```
    Description copied from interface: JCSMPSession
    
    Removes a subscription asynchronously from an Endpoint on the appliance. The API returns immediately after sending a remove subscription request to the appliance. A router confirmation will be delivered to the subscription event handler instead.
    
    Specified by:
    
    removeSubscription in interface JCSMPSession
    
    Parameters:
    
    endpoint - The Endpoint to remove the subscription from.
    
    subscription - The subscription to remove.
    
    listener - The subscription event handler
    
    key - The correlation key of the remove subscription operation
    
    Throws:
    
    OperationNotSupportedException - If performed on a closed Session or a Session not configured for this operation.
    
    JCSMPException - On any other error condition.

Class JCSMPBasicSession

Nested Class Summary

Field Summary

Fields inherited from interface com.solacesystems.jcsmp.JCSMPSession

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

JCSMPBasicSession

JCSMPBasicSession

Method Detail

notifySessionReconnectAborted

isSessionReconnectAborted

getSessionAbortException

getNegotiatedMinXAVersion

notifyVridChange

getNegotiatedMaxXAVersion

getPubFlowManager

xaSessionMessageIdRenumbering

getNegotiatedMinADCtrlVersion

getNegotiatedMaxADCtrlVersion

getGdReconnectFailAction

getTransientData

putTransientData

getContext

getSessionName

getRouterMode

createGenericXMLMessage

createGenericXMLMessage

closeSession

isClosed

getSessionStats

logSessionStats

logFlowInfo

addSubscriber

removeSubscriber

clearSubscriber

deleteSubscriber

createProducer

createProducer

createProducer

getMessageProducer

getMessageProducer

getMessageProducer

getMessageConsumer

getMessageConsumer

getMessageConsumer

getMessageConsumer

getMessageConsumer

getMessageConsumer

getMessageConsumer

getMessageConsumer

applySubscriptions

getSessionID

getClientChannel

getJCSMPProperties

getSecureProperties

addSubscription

addSubscription

addSubscription

removeSubscription

removeSubscription

addSubscription

Adding subscriptions to Queues

Adding subscriptions to remote clients

General notes

removeSubscription

getMessageConsumer

getMessageConsumer

getMessageConsumer

getMessageConsumer

unsubscribeDurableTopicEndpoint

createFlow

createFlow

createFlow

createFlow

createFlow

createFlow

getMessageProducer

executeJndiQuery