org.apache.qpid.jms

Class JmsConnection

java.lang.Object

org.apache.qpid.jms.JmsConnection

All Implemented Interfaces:

AutoCloseable, javax.jms.Connection, javax.jms.QueueConnection, javax.jms.TopicConnection, ProviderListener

Direct Known Subclasses:

JmsQueueConnection, JmsTopicConnection

public class JmsConnection
extends Object
implements AutoCloseable, javax.jms.Connection, javax.jms.TopicConnection, javax.jms.QueueConnection, ProviderListener

Implementation of a JMS Connection

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	JmsConnection(String connectionId, Provider provider, IdGenerator clientIdGenerator)

Method Summary

Methods

Modifier and Type	Method and Description
void	addConnectionListener(JmsConnectionListener listener) Adds a JmsConnectionListener so that a client can be notified of events in the underlying connection and its state.
protected void	addSession(JmsSessionInfo sessionInfo, JmsSession session)
protected void	checkClosed()
protected void	checkClosedOrFailed()
protected void	checkConsumeFromTemporaryDestination(JmsTemporaryDestination destination)
void	close()
javax.jms.ConnectionConsumer	createConnectionConsumer(javax.jms.Destination destination, String messageSelector, javax.jms.ServerSessionPool sessionPool, int maxMessages)
javax.jms.ConnectionConsumer	createConnectionConsumer(javax.jms.Queue queue, String messageSelector, javax.jms.ServerSessionPool sessionPool, int maxMessages)
javax.jms.ConnectionConsumer	createConnectionConsumer(javax.jms.Topic topic, String messageSelector, javax.jms.ServerSessionPool sessionPool, int maxMessages)
javax.jms.ConnectionConsumer	createDurableConnectionConsumer(javax.jms.Topic topic, String subscriptionName, String messageSelector, javax.jms.ServerSessionPool sessionPool, int maxMessages)
javax.jms.QueueSession	createQueueSession(boolean transacted, int acknowledgeMode)
javax.jms.Session	createSession(boolean transacted, int acknowledgeMode)
protected javax.jms.TemporaryQueue	createTemporaryQueue()
protected javax.jms.TemporaryTopic	createTemporaryTopic()
javax.jms.TopicSession	createTopicSession(boolean transacted, int acknowledgeMode)
protected void	deleteTemporaryDestination(JmsTemporaryDestination destination)
String	getClientID()
long	getCloseTimeout()
URI	getConfiguredURI()
URI	getConnectedURI()
long	getConnectTimeout()
JmsDeserializationPolicy	getDeserializationPolicy()
javax.jms.ExceptionListener	getExceptionListener()
JmsConnectionId	getId()
JmsMessageFactory	getMessageFactory()
JmsMessageIDPolicy	getMessageIDPolicy()
javax.jms.ConnectionMetaData	getMetaData()
protected JmsSessionId	getNextSessionId()
protected JmsTransactionId	getNextTransactionId()
String	getPassword()
JmsPrefetchPolicy	getPrefetchPolicy()
JmsPresettlePolicy	getPresettlePolicy()
String	getQueuePrefix()
JmsRedeliveryPolicy	getRedeliveryPolicy()
long	getRequestTimeout()
long	getSendTimeout()
protected int	getSessionAcknowledgeMode(boolean transacted, int acknowledgeMode)
String	getTopicPrefix()
String	getUsername()
boolean	isClosed()
boolean	isConnected()
protected boolean	isExplicitClientID()
boolean	isFailed()
boolean	isForceAsyncAcks()
boolean	isForceAsyncSend()
boolean	isForceSyncSend()
boolean	isLocalMessageExpiry()
boolean	isLocalMessagePriority()
boolean	isPopulateJMSXUserID()
boolean	isReceiveLocalOnly()
boolean	isReceiveNoWaitLocalOnly()
boolean	isStarted()
protected boolean	isTemporaryDestinationDeleted(JmsDestination destination)
boolean	isValidatePropertyNames()
void	onAsyncException(Throwable error) Handles any asynchronous errors that occur from the JMS framework classes.
void	onConnectionEstablished(URI remoteURI) Called to indicate that the underlying connection to the Broker has been established for the first time.
void	onConnectionFailure(IOException ex) Called to indicate that the underlying connection to the Broker has been lost and the Provider will not perform any reconnect.
void	onConnectionInterrupted(URI remoteURI) Called from a fault tolerant Provider instance to signal that the underlying connection to the Broker has been lost.
void	onConnectionRecovered(Provider provider) Called to indicate that a connection to the Broker has been reestablished and that all recovery operations have succeeded and the connection will now be transitioned to a recovered state.
void	onConnectionRecovery(Provider provider) Called to indicate that a connection to the Broker has been reestablished and that notified listener should start to recover it's state.
void	onConnectionRestored(URI remoteURI) Called to signal that all recovery operations are now complete and the Provider is again in a normal connected state.
void	onException(Exception ex)
void	onException(javax.jms.JMSException ex)
void	onInboundMessage(JmsInboundMessageDispatch envelope) Called when a new Message has arrived for a registered consumer.
void	onProviderException(Exception cause) Called to indicate that a some client operation caused or received an error that is not considered fatal at the provider level.
void	onResourceClosed(JmsResource resource, Exception cause) Called to indicate that a currently active resource has been closed due to some error condition, management request or some other action.
protected void	providerFailed(IOException error)
boolean	removeConnectionListener(JmsConnectionListener listener) Removes a JmsConnectionListener that was previously registered.
protected void	removeSession(JmsSessionInfo sessionInfo)
void	setClientID(String clientID)
void	setCloseTimeout(long closeTimeout)
void	setConnectTimeout(long connectTimeout)
void	setDeserializationPolicy(JmsDeserializationPolicy deserializationPolicy)
void	setExceptionListener(javax.jms.ExceptionListener listener)
void	setForceAsyncAcks(boolean forceAsyncAcks)
void	setForceAsyncSend(boolean forceAsyncSend)
void	setForceSyncSend(boolean alwaysSyncSend)
void	setLocalMessageExpiry(boolean localMessageExpiry)
void	setLocalMessagePriority(boolean localMessagePriority)
void	setMessageIDPolicy(JmsMessageIDPolicy messageIDPolicy)
void	setPopulateJMSXUserID(boolean populateJMSXUserID)
void	setPrefetchPolicy(JmsPrefetchPolicy prefetchPolicy)
void	setPresettlePolicy(JmsPresettlePolicy presettlePolicy)
void	setQueuePrefix(String queuePrefix)
void	setReceiveLocalOnly(boolean receiveLocalOnly)
void	setReceiveNoWaitLocalOnly(boolean receiveNoWaitLocalOnly)
void	setRedeliveryPolicy(JmsRedeliveryPolicy redeliveryPolicy)
void	setRequestTimeout(long requestTimeout)
void	setSendTimeout(long sendTimeout)
void	setTopicPrefix(String topicPrefix)
void	setValidatePropertyNames(boolean validatePropertyNames)
protected void	shutdown() Called to free all Connection resources.
protected void	shutdown(Exception cause) Called to free all Connection resources.
void	start()
void	stop()

Methods inherited from class java.lang.Object

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

Constructor Detail

JmsConnection

protected JmsConnection(String connectionId,
             Provider provider,
             IdGenerator clientIdGenerator)
                 throws javax.jms.JMSException

Throws:

javax.jms.JMSException

Method Detail

close

public void close()
           throws javax.jms.JMSException

Specified by:

close in interface AutoCloseable

Specified by:

close in interface javax.jms.Connection

Throws:

javax.jms.JMSException

shutdown

protected void shutdown()
                 throws javax.jms.JMSException

Called to free all Connection resources.

Throws:

javax.jms.JMSException

shutdown

protected void shutdown(Exception cause)
                 throws javax.jms.JMSException

Called to free all Connection resources.

Throws:

javax.jms.JMSException

createSession

public javax.jms.Session createSession(boolean transacted,
                              int acknowledgeMode)
                                throws javax.jms.JMSException

Specified by:

createSession in interface javax.jms.Connection

Throws:

javax.jms.JMSException

getClientID

public String getClientID()
                   throws javax.jms.JMSException

Specified by:

getClientID in interface javax.jms.Connection

Throws:

javax.jms.JMSException

getMetaData

public javax.jms.ConnectionMetaData getMetaData()
                                         throws javax.jms.JMSException

Specified by:

getMetaData in interface javax.jms.Connection

Throws:

javax.jms.JMSException

setClientID

public void setClientID(String clientID)
                 throws javax.jms.JMSException

Specified by:

setClientID in interface javax.jms.Connection

Throws:

javax.jms.JMSException

start

public void start()
           throws javax.jms.JMSException

Specified by:

start in interface javax.jms.Connection

Throws:

javax.jms.JMSException

stop

public void stop()
          throws javax.jms.JMSException

Specified by:

stop in interface javax.jms.Connection

Throws:

javax.jms.JMSException

createDurableConnectionConsumer

public javax.jms.ConnectionConsumer createDurableConnectionConsumer(javax.jms.Topic topic,
                                                           String subscriptionName,
                                                           String messageSelector,
                                                           javax.jms.ServerSessionPool sessionPool,
                                                           int maxMessages)
                                                             throws javax.jms.JMSException

Specified by:

createDurableConnectionConsumer in interface javax.jms.Connection

Specified by:

createDurableConnectionConsumer in interface javax.jms.TopicConnection

Throws:

javax.jms.JMSException

createConnectionConsumer

public javax.jms.ConnectionConsumer createConnectionConsumer(javax.jms.Destination destination,
                                                    String messageSelector,
                                                    javax.jms.ServerSessionPool sessionPool,
                                                    int maxMessages)
                                                      throws javax.jms.JMSException

Specified by:

createConnectionConsumer in interface javax.jms.Connection

Throws:

javax.jms.JMSException

createConnectionConsumer

public javax.jms.ConnectionConsumer createConnectionConsumer(javax.jms.Topic topic,
                                                    String messageSelector,
                                                    javax.jms.ServerSessionPool sessionPool,
                                                    int maxMessages)
                                                      throws javax.jms.JMSException

Specified by:

createConnectionConsumer in interface javax.jms.TopicConnection

Throws:

javax.jms.JMSException

createConnectionConsumer

public javax.jms.ConnectionConsumer createConnectionConsumer(javax.jms.Queue queue,
                                                    String messageSelector,
                                                    javax.jms.ServerSessionPool sessionPool,
                                                    int maxMessages)
                                                      throws javax.jms.JMSException

Specified by:

createConnectionConsumer in interface javax.jms.QueueConnection

Throws:

javax.jms.JMSException

createTopicSession

public javax.jms.TopicSession createTopicSession(boolean transacted,
                                        int acknowledgeMode)
                                          throws javax.jms.JMSException

Specified by:

createTopicSession in interface javax.jms.TopicConnection

Throws:

javax.jms.JMSException

createQueueSession

public javax.jms.QueueSession createQueueSession(boolean transacted,
                                        int acknowledgeMode)
                                          throws javax.jms.JMSException

Specified by:

createQueueSession in interface javax.jms.QueueConnection

Throws:

javax.jms.JMSException

onException

public void onException(Exception ex)

onException

public void onException(javax.jms.JMSException ex)

getSessionAcknowledgeMode

protected int getSessionAcknowledgeMode(boolean transacted,
                            int acknowledgeMode)
                                 throws javax.jms.JMSException

Throws:

javax.jms.JMSException

removeSession

protected void removeSession(JmsSessionInfo sessionInfo)
                      throws javax.jms.JMSException

Throws:

javax.jms.JMSException

addSession

protected void addSession(JmsSessionInfo sessionInfo,
              JmsSession session)

createTemporaryQueue

protected javax.jms.TemporaryQueue createTemporaryQueue()
                                                 throws javax.jms.JMSException

Returns:

a newly initialized TemporaryQueue instance.

Throws:

javax.jms.JMSException

createTemporaryTopic

protected javax.jms.TemporaryTopic createTemporaryTopic()
                                                 throws javax.jms.JMSException

Returns:

a newly initialized TemporaryTopic instance.

Throws:

javax.jms.JMSException

deleteTemporaryDestination

protected void deleteTemporaryDestination(JmsTemporaryDestination destination)
                                   throws javax.jms.JMSException

Throws:

javax.jms.JMSException

checkClosedOrFailed

protected void checkClosedOrFailed()
                            throws javax.jms.JMSException

Throws:

javax.jms.JMSException

checkConsumeFromTemporaryDestination

protected void checkConsumeFromTemporaryDestination(JmsTemporaryDestination destination)
                                             throws javax.jms.JMSException

Throws:

javax.jms.JMSException

isTemporaryDestinationDeleted

protected boolean isTemporaryDestinationDeleted(JmsDestination destination)

checkClosed

protected void checkClosed()
                    throws javax.jms.IllegalStateException

Throws:

javax.jms.IllegalStateException

getNextSessionId

protected JmsSessionId getNextSessionId()

getNextTransactionId

protected JmsTransactionId getNextTransactionId()

isExplicitClientID

protected boolean isExplicitClientID()

getExceptionListener

public javax.jms.ExceptionListener getExceptionListener()
                                                 throws javax.jms.JMSException

Specified by:

getExceptionListener in interface javax.jms.Connection

Throws:

javax.jms.JMSException

setExceptionListener

public void setExceptionListener(javax.jms.ExceptionListener listener)
                          throws javax.jms.JMSException

Specified by:

setExceptionListener in interface javax.jms.Connection

Throws:

javax.jms.JMSException

addConnectionListener

public void addConnectionListener(JmsConnectionListener listener)

Adds a JmsConnectionListener so that a client can be notified of events in the underlying connection and its state.

Parameters:

listener - the new listener to add to the collection.

removeConnectionListener

public boolean removeConnectionListener(JmsConnectionListener listener)

Removes a JmsConnectionListener that was previously registered.

Parameters:

listener - the listener to remove from the collection.

Returns:

true if the given listener was removed from the current set.

isForceAsyncSend

public boolean isForceAsyncSend()

setForceAsyncSend

public void setForceAsyncSend(boolean forceAsyncSend)

isForceSyncSend

public boolean isForceSyncSend()

setForceSyncSend

public void setForceSyncSend(boolean alwaysSyncSend)

getTopicPrefix

public String getTopicPrefix()

setTopicPrefix

public void setTopicPrefix(String topicPrefix)

getQueuePrefix

public String getQueuePrefix()

setQueuePrefix

public void setQueuePrefix(String queuePrefix)

isValidatePropertyNames

public boolean isValidatePropertyNames()

setValidatePropertyNames

public void setValidatePropertyNames(boolean validatePropertyNames)

getPrefetchPolicy

public JmsPrefetchPolicy getPrefetchPolicy()

setPrefetchPolicy

public void setPrefetchPolicy(JmsPrefetchPolicy prefetchPolicy)

getRedeliveryPolicy

public JmsRedeliveryPolicy getRedeliveryPolicy()

setRedeliveryPolicy

public void setRedeliveryPolicy(JmsRedeliveryPolicy redeliveryPolicy)

getPresettlePolicy

public JmsPresettlePolicy getPresettlePolicy()

setPresettlePolicy

public void setPresettlePolicy(JmsPresettlePolicy presettlePolicy)

getDeserializationPolicy

public JmsDeserializationPolicy getDeserializationPolicy()

setDeserializationPolicy

public void setDeserializationPolicy(JmsDeserializationPolicy deserializationPolicy)

isReceiveLocalOnly

public boolean isReceiveLocalOnly()

setReceiveLocalOnly

public void setReceiveLocalOnly(boolean receiveLocalOnly)

isReceiveNoWaitLocalOnly

public boolean isReceiveNoWaitLocalOnly()

setReceiveNoWaitLocalOnly

public void setReceiveNoWaitLocalOnly(boolean receiveNoWaitLocalOnly)

isLocalMessagePriority

public boolean isLocalMessagePriority()

setLocalMessagePriority

public void setLocalMessagePriority(boolean localMessagePriority)

getCloseTimeout

public long getCloseTimeout()

setCloseTimeout

public void setCloseTimeout(long closeTimeout)

getConnectTimeout

public long getConnectTimeout()

setConnectTimeout

public void setConnectTimeout(long connectTimeout)

getSendTimeout

public long getSendTimeout()

setSendTimeout

public void setSendTimeout(long sendTimeout)

getRequestTimeout

public long getRequestTimeout()

setRequestTimeout

public void setRequestTimeout(long requestTimeout)

getConfiguredURI

public URI getConfiguredURI()

getConnectedURI

public URI getConnectedURI()

getUsername

public String getUsername()

getPassword

public String getPassword()

isConnected

public boolean isConnected()

isStarted

public boolean isStarted()

isClosed

public boolean isClosed()

isFailed

public boolean isFailed()

getId

public JmsConnectionId getId()

getMessageFactory

public JmsMessageFactory getMessageFactory()

isForceAsyncAcks

public boolean isForceAsyncAcks()

setForceAsyncAcks

public void setForceAsyncAcks(boolean forceAsyncAcks)

isLocalMessageExpiry

public boolean isLocalMessageExpiry()

setLocalMessageExpiry

public void setLocalMessageExpiry(boolean localMessageExpiry)

getMessageIDPolicy

public JmsMessageIDPolicy getMessageIDPolicy()

setMessageIDPolicy

public void setMessageIDPolicy(JmsMessageIDPolicy messageIDPolicy)

isPopulateJMSXUserID

public boolean isPopulateJMSXUserID()

setPopulateJMSXUserID

public void setPopulateJMSXUserID(boolean populateJMSXUserID)

onInboundMessage

public void onInboundMessage(JmsInboundMessageDispatch envelope)

Description copied from interface: ProviderListener

Called when a new Message has arrived for a registered consumer.

Specified by:

onInboundMessage in interface ProviderListener

Parameters:

envelope - The dispatch object containing the message and delivery information.

onConnectionInterrupted

public void onConnectionInterrupted(URI remoteURI)

Description copied from interface: ProviderListener

Called from a fault tolerant Provider instance to signal that the underlying connection to the Broker has been lost. The Provider will attempt to reconnect following this event unless closed. It is considered a programming error to allow any exceptions to be thrown from this notification method.

Specified by:

onConnectionInterrupted in interface ProviderListener

Parameters:

remoteURI - The URI of the Broker whose connection was lost.

onConnectionRecovery

public void onConnectionRecovery(Provider provider)
                          throws Exception

Description copied from interface: ProviderListener

Called to indicate that a connection to the Broker has been reestablished and that notified listener should start to recover it's state. The provider will not transition to the recovered state until the listener notifies the provider that recovery is complete.

Specified by:

onConnectionRecovery in interface ProviderListener

Parameters:

provider - The new Provider instance that will become active after the state has been recovered.

Throws:

Exception - if an error occurs during recovery attempt, this will fail the Provider that's being used for recovery.

onConnectionRecovered

public void onConnectionRecovered(Provider provider)
                           throws Exception

Description copied from interface: ProviderListener

Called to indicate that a connection to the Broker has been reestablished and that all recovery operations have succeeded and the connection will now be transitioned to a recovered state. This method gives the listener a chance so send any necessary post recovery commands such as consumer start or message pull for a zero prefetch consumer etc.

Specified by:

onConnectionRecovered in interface ProviderListener

Parameters:

provider - The new Provider instance that will become active after the state has been recovered.

Throws:

Exception - if an error occurs during recovery attempt, this will fail the Provider that's being used for recovery.

onConnectionRestored

public void onConnectionRestored(URI remoteURI)

Description copied from interface: ProviderListener

Called to signal that all recovery operations are now complete and the Provider is again in a normal connected state. It is considered a programming error to allow any exceptions to be thrown from this notification method.

Specified by:

onConnectionRestored in interface ProviderListener

Parameters:

remoteURI - The URI of the Broker that the client has now connected to.

onConnectionEstablished

public void onConnectionEstablished(URI remoteURI)

Description copied from interface: ProviderListener

Called to indicate that the underlying connection to the Broker has been established for the first time. For a fault tolerant provider this event should only ever be triggered once with the interruption and recovery events following on for future

Specified by:

onConnectionEstablished in interface ProviderListener

Parameters:

remoteURI - The URI of the Broker that the client has now connected to.

onConnectionFailure

public void onConnectionFailure(IOException ex)

Description copied from interface: ProviderListener

Called to indicate that the underlying connection to the Broker has been lost and the Provider will not perform any reconnect. Following this call the provider is in a failed state and further calls to it will throw an Exception.

Specified by:

onConnectionFailure in interface ProviderListener

Parameters:

ex - The exception that indicates the cause of this Provider failure.

onResourceClosed

public void onResourceClosed(JmsResource resource,
                    Exception cause)

Description copied from interface: ProviderListener

Called to indicate that a currently active resource has been closed due to some error condition, management request or some other action. This can either be initiated remotely or locally depending on the condition that triggers the close.

Specified by:

onResourceClosed in interface ProviderListener

Parameters:

resource - the JmsResource instance that has been closed.

cause - optional exception object that indicates the cause of the close.

onProviderException

public void onProviderException(Exception cause)

Description copied from interface: ProviderListener

Called to indicate that a some client operation caused or received an error that is not considered fatal at the provider level.

Specified by:

onProviderException in interface ProviderListener

Parameters:

cause - the exception object that is being reported to the listener.

onAsyncException

public void onAsyncException(Throwable error)

Handles any asynchronous errors that occur from the JMS framework classes. If any listeners are registered they will be notified of the error from a thread in the Connection's Executor service.

Parameters:

error - The exception that triggered this error.

providerFailed

protected void providerFailed(IOException error)