com.solacesystems.jcsmp.impl

Class SessionModeSupportClient

java.lang.Object

com.solacesystems.jcsmp.impl.SessionModeSupport

com.solacesystems.jcsmp.impl.SessionModeSupportClient

All Implemented Interfaces:

SessionSubscriptionEventListener, JCSMPSession, Session

public class SessionModeSupportClient
extends SessionModeSupport

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
SessionModeSupportClient(CSMPControllerChannel controlChannel, CSMPPublisherChannel publisherChannel, CSMPSubscriberChannel subscriberChannel, TcpClientChannel clientChannel, SubFlowManagerImpl flowMgr, JCSMPBasicSession session)

Method Summary

Modifier and Type	Method and Description
void	addSubscriber() Adds a subscriber to the appliance using the user information associated with the Session.
void	addSubscription(Endpoint endpoint, Subscription subscription, int subscribeFlags) Adds a subscription to an Endpoint on the appliance.
void	addSubscription(Endpoint endpoint, Subscription subscription, JCSMPResponseListener handler, 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, boolean waitForConfirm, boolean notifySubCache)
void	addSubscription(Subscription subscription, JCSMPResponseListener handler, 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	closeControlChannel()
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.
TransactedSession	createTransactedSession() Creates a new TransactedSession with the connected appliance.
XASession	createXASession() SolReserved - Creates a new XASession with the connected appliance.
void	deleteSubscriber()
JndiMessage	executeJndiQuery(JndiMessage request) SolReserved - Executes a JNDI query against the appliance, opening the control channel, if required.
XMLMessageProducer	getMessageProducer(JCSMPStreamingPublishEventHandler callback) Get an instance of XMLMessageProducer.
XMLMessageProducer	getMessageProducer(JCSMPStreamingPublishEventHandler callback, JCSMPProducerEventHandler eventCallback) Get an instance of XMLMessageProducer.
WireMessage	performDeleteEndpointCommad(WireMessage delEpCommand)
WireMessage	performProvisionEndpointCommand(WireMessage provEpCommand)
void	reestablishSubCache() Reestablishes the subscription cache using non-retryable, non-blocking subscription adds.
void	removeSubscription(Endpoint endpoint, Subscription subscription, int unsubscribeFlags) Removes a subscription from an Endpoint on the appliance.
void	removeSubscription(Endpoint endpoint, Subscription subscription, JCSMPResponseListener handler, 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 handler, Object key) Removes a subscription asynchronously from the appliance.
void	setJmsClientId(String clientId, boolean allowSharedClientId)
void	setProperty(String property, Object value) Sets a modifiable Session property once the Session has been constructed.
void	validateBindTopicOrQueue(AbstractDestination dest)
void	validateSubscriberEndpointValidEndpoint()

Methods inherited from class com.solacesystems.jcsmp.impl.SessionModeSupport

closeSession, connect, createFlow, createFlow, createFlow, createFlow, createFlow, createFlow, createFlow, createNonDurableTopicEndpoint, createNonDurableTopicEndpoint, createProducer, createProducer, createRequestor, createTemporaryQueue, createTemporaryQueue, createTemporaryTopic, deprovision, getCapability, getConsumer, getHostId, getMessageConsumer, getMessageConsumer, getMessageConsumer, getMessageConsumer, getMessageConsumer, getMessageConsumer, getMessageConsumer, getMessageConsumer, getMessageProducer, getProducer, getProperty, getSessionName, getSessionStats, getSubscriptionCache, isCapable, isClosed, logFlowInfo, logSessionStats, notifySubscriptionEvent, provision, removeSubscriber, unsubscribeDurableTopicEndpoint

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

SessionModeSupportClient

public SessionModeSupportClient(CSMPControllerChannel controlChannel,
                                CSMPPublisherChannel publisherChannel,
                                CSMPSubscriberChannel subscriberChannel,
                                TcpClientChannel clientChannel,
                                SubFlowManagerImpl flowMgr,
                                JCSMPBasicSession session)

Method Detail

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.

Parameters:

request - The JNDI request to execute.

Returns:

A new JndiMessage object containing the response.

Throws:

JCSMPException - on error

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

Specified by:

addSubscription in class SessionModeSupport

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

Specified by:

addSubscription in class SessionModeSupport

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 void addSubscription(Subscription subscription,
                            boolean waitForConfirm,
                            boolean notifySubCache)
                     throws JCSMPException

Specified by:

addSubscription in class SessionModeSupport

Throws:

JCSMPException

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

Specified by:

addSubscription in class SessionModeSupport

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

Specified by:

removeSubscription in class SessionModeSupport

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

Specified by:

removeSubscription in class SessionModeSupport

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.

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.

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.

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:

APPLICATION_DESCRIPTION (in TBRM only)
• 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.

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.

addSubscriber

public void addSubscriber()
                   throws JCSMPException

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.

Throws:

JCSMPException - If there was an error adding the subscriber.

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.

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.

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).

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.

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).

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.

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.

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.

deleteSubscriber

public void deleteSubscriber()
                      throws JCSMPException

Throws:

JCSMPException

createCacheSession

public CacheSession createCacheSession(CacheSessionProperties properties)

Description copied from interface: JCSMPSession

Creates a CacheSession using the provided CacheSession properties.

Parameters:

properties - Properties for the CacheSession.

Returns:

The created CacheSession.

closeControlChannel

public void closeControlChannel()

Specified by:

closeControlChannel in class SessionModeSupport

validateSubscriberEndpointValidEndpoint

public void validateSubscriberEndpointValidEndpoint()
                                             throws JCSMPException

Specified by:

validateSubscriberEndpointValidEndpoint in class SessionModeSupport

Throws:

JCSMPException

validateBindTopicOrQueue

public void validateBindTopicOrQueue(AbstractDestination dest)
                              throws JCSMPException

Specified by:

validateBindTopicOrQueue in class SessionModeSupport

Throws:

JCSMPException

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.

Specified by:

reestablishSubCache in class SessionModeSupport

Throws:

JCSMPException

performProvisionEndpointCommand

public WireMessage performProvisionEndpointCommand(WireMessage provEpCommand)
                                            throws JCSMPException

Specified by:

performProvisionEndpointCommand in class SessionModeSupport

Throws:

JCSMPException

performDeleteEndpointCommad

public WireMessage performDeleteEndpointCommad(WireMessage delEpCommand)
                                        throws JCSMPException

Specified by:

performDeleteEndpointCommad in class SessionModeSupport

Throws:

JCSMPException

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.

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.

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.

Returns:

A new TransactedSession.

Throws:

JCSMPException - on error

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.

Returns:

A new XASession

Throws:

JCSMPException - on error

setJmsClientId

public void setJmsClientId(String clientId,
                           boolean allowSharedClientId)
                    throws JCSMPException

Throws:

JCSMPException

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.

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.

addSubscription

public void addSubscription(Subscription subscription,
                            JCSMPResponseListener handler,
                            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.

Parameters:

subscription - The subscription to add.

handler - 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 handler,
                            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.

Parameters:

endpoint - The Endpoint to add the subscription on.

subscription - The subscription to add.

handler - 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 handler,
                               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.

Parameters:

subscription - The subscription to remove.

handler - 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 handler,
                               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.

Parameters:

endpoint - The Endpoint to remove the subscription from.

subscription - The subscription to remove.

handler - 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.