com.solacesystems.jcsmp.impl

Class SessionModeSupport

java.lang.Object

com.solacesystems.jcsmp.impl.SessionModeSupport

All Implemented Interfaces:

SessionSubscriptionEventListener, JCSMPSession, Session

Direct Known Subclasses:

SessionModeSupportClient

public abstract class SessionModeSupport
extends Object
implements JCSMPSession, SessionSubscriptionEventListener

Field Summary

Fields inherited from interface com.solacesystems.jcsmp.JCSMPSession

FLAG_IGNORE_ALREADY_EXISTS, FLAG_IGNORE_DOES_NOT_EXIST, WAIT_FOR_CONFIRM

Method Summary

Modifier and Type	Method and Description
abstract void	addSubscription(Subscription subscription) Adds a subscription to the appliance.
abstract void	addSubscription(Subscription subscription, boolean waitForConfirm) Adds a subscription to an appliance.
abstract void	addSubscription(Subscription subscription, boolean waitForConfirm, boolean notifySubCache)
abstract Consumer	addSubscription(Subscription subscription, XMLMessageListener listener, ConsumerNotificationDispatcherFactory dispatcherFactory) [SolReserved] For Topic Dispatching.
abstract void	closeControlChannel()
void	closeSession() Closes the session.
void	connect() Connect to the appliance.
FlowReceiver	createFlow(BrowserProperties b_prop)
FlowReceiver	createFlow(BrowserProperties b_prop, FlowEventHandler flowEventHandler, BrowserImpl browser)
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 f_prop) Get an instance of FlowReceiver bound to an appliance Endpoint, such as a Queue or TopicEndpoint.
FlowReceiver	createFlow(XMLMessageListener listener, ConsumerFlowProperties f_prop, EndpointProperties e_prop) Get an instance of FlowReceiver bound to an appliance Endpoint, such as a Queue or TopicEndpoint.
FlowReceiver	createFlow(XMLMessageListener listener, ConsumerFlowProperties f_prop, EndpointProperties e_prop, FlowEventHandler flowEventHandler) Get an instance of FlowReceiver bound to an appliance Endpoint, such as a Queue or TopicEndpoint.
FlowReceiver	createFlow(XMLMessageListener listener, ConsumerFlowProperties f_prop, EndpointProperties e_prop, JCSMPBasicSession.InternalBindProperties internalBindProp, FlowEventHandler flowEventHandler)
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.
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.
void	deprovision(Endpoint endpoint, long deprovisionFlags) Deprovisions an Endpoint on the appliance.
Object	getCapability(CapabilityType type) Gets the value of a capability for the currently connected Session.
JCSMPXMLMessageConsumer	getConsumer()
String	getHostId()
XMLMessageConsumer	getMessageConsumer()
XMLMessageConsumer	getMessageConsumer(JCSMPReconnectEventHandler reconnectHandler)
XMLMessageConsumer	getMessageConsumer(JCSMPReconnectEventHandler reconnectHandler, XMLMessageListener listener) Get an instance of XMLMessageConsumer with a reconnect event handler.
XMLMessageConsumer	getMessageConsumer(SubscriptionStateProvider subscriptionStateProvider)
XMLMessageConsumer	getMessageConsumer(SubscriptionStateProvider subscriptionStateProvider, JCSMPReconnectEventHandler reconnectHandler)
XMLMessageConsumer	getMessageConsumer(SubscriptionStateProvider subscriptionStateProvider, JCSMPReconnectEventHandler reconnectHandler, XMLMessageListener listener) Get an instance of XMLMessageConsumer with subscriptions out-of-sync checking and reconnect event handler.
XMLMessageConsumer	getMessageConsumer(SubscriptionStateProvider subscriptionStateProvider, XMLMessageListener listener) Get an instance of XMLMessageConsumer with subscriptions out-of-sync checking.
XMLMessageConsumer	getMessageConsumer(XMLMessageListener listener) Get an instance of XMLMessageConsumer.
XMLMessageProducer	getMessageProducer()
JCSMPXMLMessageProducer	getProducer()
Object	getProperty(String property) Gets a Session property.
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.
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.
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	notifySubscriptionEvent(SessionSubscriptionEvent ev)
abstract WireMessage	performDeleteEndpointCommad(WireMessage del_ep_command)
abstract WireMessage	performProvisionEndpointCommand(WireMessage prov_ep_command)
void	provision(Endpoint endpoint, EndpointProperties props, long provisionFlags) Provisions an Endpoint on the appliance.
abstract void	reestablishSubCache()
void	removeSubscriber() Removes a subscriber from the appliance using the user information associated with the Session.
abstract void	removeSubscription(Subscription subscription) Removes a subscription from the appliance.
abstract void	removeSubscription(Subscription subscription, boolean waitForConfirm) Removes a subscription from the appliance.
void	unsubscribeDurableTopicEndpoint(DurableTopicEndpoint endpoint) Unsubscribe from the durable Topic Endpoint.
abstract void	validateBindTopicOrQueue(AbstractDestination dest)
abstract void	validateSubscriberEndpointValidEndpoint()

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.solacesystems.jcsmp.JCSMPSession

addSubscription, applySubscriptions, createBrowser, createBrowser, createCacheSession, createTransactedSession, createXASession, executeJndiQuery, getMessageProducer, getMessageProducer, removeSubscription, setJmsClientId, setProperty

Methods inherited from interface com.solacesystems.jcsmp.Session

addSubscriber, clearSubscriber, deleteSubscriber

Method Detail

getProducer

public JCSMPXMLMessageProducer getProducer()

getConsumer

public JCSMPXMLMessageConsumer getConsumer()

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

addSubscription

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

Throws:

JCSMPException

addSubscription

public abstract 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 abstract 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 abstract 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.

closeControlChannel

public abstract void closeControlChannel()

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

f_prop - 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 f_prop,
                               EndpointProperties e_prop)
                        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.

f_prop - Consumer flow properties, like Guaranteed message window size, Endpoint to bind to, and so on.

e_prop - (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 f_prop,
                               EndpointProperties e_prop,
                               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.

f_prop - Consumer flow properties, like Guaranteed message window size, Endpoint to bind to, and so on.

e_prop - (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 f_prop,
                               EndpointProperties e_prop,
                               JCSMPBasicSession.InternalBindProperties internalBindProp,
                               FlowEventHandler flowEventHandler)
                        throws JCSMPException

Throws:

JCSMPException

createFlow

public FlowReceiver createFlow(BrowserProperties b_prop)
                        throws JCSMPException

Throws:

JCSMPException

createFlow

public FlowReceiver createFlow(BrowserProperties b_prop,
                               FlowEventHandler flowEventHandler,
                               BrowserImpl browser)
                        throws JCSMPException

Throws:

JCSMPException

validateSubscriberEndpointValidEndpoint

public abstract void validateSubscriberEndpointValidEndpoint()
                                                      throws JCSMPException

Throws:

JCSMPException

validateBindTopicOrQueue

public abstract void validateBindTopicOrQueue(AbstractDestination dest)
                                       throws JCSMPException

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.

getMessageConsumer

public XMLMessageConsumer getMessageConsumer()
                                      throws JCSMPException

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

public XMLMessageConsumer getMessageConsumer(JCSMPReconnectEventHandler reconnectHandler)
                                      throws JCSMPException

Specified by:

getMessageConsumer in interface JCSMPSession

Throws:

JCSMPException

getMessageConsumer

public XMLMessageConsumer getMessageConsumer(SubscriptionStateProvider subscriptionStateProvider,
                                             XMLMessageListener listener)
                                      throws JCSMPException

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

public XMLMessageConsumer getMessageConsumer(SubscriptionStateProvider subscriptionStateProvider)
                                      throws JCSMPException

Specified by:

getMessageConsumer in interface JCSMPSession

Throws:

JCSMPException

getMessageConsumer

public XMLMessageConsumer getMessageConsumer(SubscriptionStateProvider subscriptionStateProvider,
                                             JCSMPReconnectEventHandler reconnectHandler,
                                             XMLMessageListener listener)
                                      throws JCSMPException

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.

getMessageConsumer

public XMLMessageConsumer getMessageConsumer(SubscriptionStateProvider subscriptionStateProvider,
                                             JCSMPReconnectEventHandler reconnectHandler)
                                      throws JCSMPException

Specified by:

getMessageConsumer in interface JCSMPSession

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.

getMessageProducer

public XMLMessageProducer getMessageProducer()
                                      throws JCSMPException

Specified by:

getMessageProducer in interface JCSMPSession

Throws:

JCSMPException

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.

getSessionStats

public JCSMPSessionStats getSessionStats()

Description copied from interface: Session

Get this session's statistics.

Specified by:

getSessionStats in interface Session

Returns:

The session statistics.

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.

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.

removeSubscriber

public void removeSubscriber()
                      throws JCSMPException

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.

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.

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.

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

getCapability

public Object getCapability(CapabilityType type)

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.

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:

• JCSMPSession.createNonDurableTopicEndpoint()
• JCSMPSession.createTemporaryQueue()
• JCSMPSession.createTemporaryTopic()
• JCSMPSession.getCapability(CapabilityType)

Specified by:

connect in interface JCSMPSession

Throws:

JCSMPTransportException - If a connection exception occurs.

JCSMPException - On other failures.

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(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

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

notifySubscriptionEvent

public void notifySubscriptionEvent(SessionSubscriptionEvent ev)

Specified by:

notifySubscriptionEvent in interface SessionSubscriptionEventListener

reestablishSubCache

public abstract void reestablishSubCache()
                                  throws JCSMPException

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.

performProvisionEndpointCommand

public abstract WireMessage performProvisionEndpointCommand(WireMessage prov_ep_command)
                                                     throws JCSMPException

Throws:

JCSMPException

performDeleteEndpointCommad

public abstract WireMessage performDeleteEndpointCommad(WireMessage del_ep_command)
                                                 throws JCSMPException

Throws:

JCSMPException

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

getHostId

public String getHostId()