org.apache.qpid.client

Class AMQConnection

java.lang.Object

org.apache.qpid.client.Closeable

org.apache.qpid.client.AMQConnection

All Implemented Interfaces:

javax.jms.Connection, javax.jms.QueueConnection, javax.jms.TopicConnection, Referenceable, CommonConnection, ClassLoadingAwareObjectInputStream.TrustedClassFilter

Direct Known Subclasses:

XAConnectionImpl

public class AMQConnection
extends Closeable
implements CommonConnection, Referenceable, ClassLoadingAwareObjectInputStream.TrustedClassFilter

Field Summary

Fields

Modifier and Type	Field and Description
static String	JNDI_ADDRESS_CONNECTION_URL

Constructor Summary

Constructors

Constructor and Description
AMQConnection(ConnectionURL connectionURL)
AMQConnection(String connection)
AMQConnection(String host, int port, String username, String password, String clientName, String virtualHost)
AMQConnection(String broker, String username, String password, String clientName, String virtualHost)

Method Summary

Methods

Modifier and Type	Method and Description
boolean	attemptReconnection()
boolean	attemptReconnection(String host, int port, boolean useFailoverConfigOnFailure)
void	blockUntilNotFailingOver() If failover is taking place this will block until it has completed.
void	bytesReceived(long receivedBytes)
void	bytesSent(long writtenBytes)
boolean	channelLimitReached()
void	close() Closes this object.
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) Returns an AMQQueueSessionAdaptor which wraps an AMQSession and throws IllegalStateExceptions where specified in the JMS spec
Session	createSession(boolean transacted, int acknowledgeMode)
Session	createSession(boolean transacted, int acknowledgeMode, int prefetch) Create a session specifying the prefetch limit of messages.
Session	createSession(boolean transacted, int acknowledgeMode, int prefetchHigh, int prefetchLow) Create a session specifying the prefetch limit of messages.
javax.jms.TopicSession	createTopicSession(boolean transacted, int acknowledgeMode) Returns an AMQTopicSessionAdapter which wraps an AMQSession and throws IllegalStateExceptions where specified in the JMS spec
void	deregisterSession(int channelId)
void	exceptionReceived(Throwable cause) Invoked by the AMQProtocolSession when a protocol session exception has occurred.
<T,E extends Exception> T	executeRetrySupport(FailoverProtectedOperation<T,E> operation)
boolean	failoverAllowed()
void	fireFailoverComplete() Fires a failover complete event to the registered connection listener (if any).
boolean	firePreFailover(boolean redirect) Fire the preFailover event to the registered connection listener (if any)
boolean	firePreResubscribe() Fire the preResubscribe event to the registered connection listener (if any).
BrokerDetails	getActiveBrokerDetails() Get the details of the currently active broker
KeyStore	getBrokerSuppliedTrustStore(String name)
String	getBrokerUUID()
String	getClientID()
ConnectionListener	getConnectionListener() Get the connection listener that has been registered with this connection, if any
Long	getConnectionNumber()
ConnectionSettings	getConnectionSettings()
ConnectionURL	getConnectionURL() Returns connection url.
String	getDefaultQueueExchangeName()
String	getDefaultTopicExchangeName()
protected AMQConnectionDelegate	getDelegate()
javax.jms.ExceptionListener	getExceptionListener()
protected javax.jms.ExceptionListener	getExceptionListenerNoCheck()
Object	getFailoverMutex() In order to protect the consistency of the connection and its child sessions, consumers and producers, the "failover mutex" must be held when doing any operations that could be corrupted during failover.
FailoverPolicy	getFailoverPolicy()
long	getLastFailoverTime()
long	getMaximumChannelCount()
long	getMaximumFrameSize()
long	getMaxPrefetch() Get the maximum number of messages that this connection can pre-fetch.
int	getMessageCompressionThresholdSize()
javax.jms.ConnectionMetaData	getMetaData()
int	getNextChannelID()
String	getPassword()
AMQProtocolHandler	getProtocolHandler()
ProtocolVersion	getProtocolVersion()
Reference	getReference()
AMQSession	getSession(int channelId)
ChannelToSessionMap	getSessions()
boolean	getSyncAck() Indicates whether we need to sync on every message ack
boolean	getSyncPersistence() Indicates whether persistent messages are synchronized
String	getSyncPublish()
String	getTemporaryQueueExchangeName()
String	getTemporaryQueuePrefix()
String	getTemporaryTopicExchangeName()
String	getUsername()
String	getVirtualHost()
boolean	isConnected()
boolean	isFailingOver()
boolean	isMessageCompressionDesired()
boolean	isPopulateUserId()
boolean	isTrusted(Class<?> clazz)
boolean	isUseLegacyMapMessageFormat()
boolean	isUseLegacyStreamMessageFormat()
protected void	logConnected(SocketAddress localAddress, SocketAddress remoteAddress)
ProtocolVersion	makeBrokerConnection(BrokerDetails brokerDetail)
void	performConnectionTask(Runnable task)
void	resubscribeSessions()
void	setClientID(String clientID)
protected void	setConnected(boolean connected)
void	setConnectionListener(ConnectionListener listener)
void	setConnectionSettings(ConnectionSettings connectionSettings)
void	setDefaultQueueExchangeName(String defaultQueueExchangeName)
void	setDefaultTopicExchangeName(String defaultTopicExchangeName)
void	setExceptionListener(javax.jms.ExceptionListener listener)
void	setFailoverPolicy(FailoverPolicy policy)
void	setMaximumChannelCount(long maximumChannelCount)
void	setMaximumFrameSize(long frameMax)
void	setTemporaryQueueExchangeName(String temporaryQueueExchangeName)
void	setTemporaryTopicExchangeName(String temporaryTopicExchangeName)
void	setUsername(String id)
void	start() Start the connection, i.e.
boolean	started()
void	stop()
String	toString()
String	toURL() Returns stringified connection url.
boolean	validateQueueOnSend()

Methods inherited from class org.apache.qpid.client.Closeable

checkNotClosed, isClosed, isClosing, setClosed, setClosing

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.apache.qpid.client.CommonConnection

isClosed

Field Detail

JNDI_ADDRESS_CONNECTION_URL

public static final String JNDI_ADDRESS_CONNECTION_URL

See Also:

Constant Field Values

Constructor Detail

AMQConnection

public AMQConnection(String broker,
             String username,
             String password,
             String clientName,
             String virtualHost)
              throws QpidException,
                     URLSyntaxException

Parameters:

broker - brokerdetails

username - username

password - password

clientName - clientid

virtualHost - virtualhost

Throws:

QpidException

URLSyntaxException

AMQConnection

public AMQConnection(String host,
             int port,
             String username,
             String password,
             String clientName,
             String virtualHost)
              throws QpidException,
                     URLSyntaxException

Throws:

QpidException

URLSyntaxException

AMQConnection

public AMQConnection(String connection)
              throws QpidException,
                     URLSyntaxException

Throws:

QpidException

URLSyntaxException

AMQConnection

public AMQConnection(ConnectionURL connectionURL)
              throws QpidException

Throws:

QpidException

Method Detail

attemptReconnection

public boolean attemptReconnection(String host,
                          int port,
                          boolean useFailoverConfigOnFailure)

attemptReconnection

public boolean attemptReconnection()

makeBrokerConnection

public ProtocolVersion makeBrokerConnection(BrokerDetails brokerDetail)
                                     throws IOException,
                                            QpidException

Throws:

IOException

QpidException

executeRetrySupport

public <T,E extends Exception> T executeRetrySupport(FailoverProtectedOperation<T,E> operation)
                      throws E extends Exception

Throws:

E extends Exception

getActiveBrokerDetails

public BrokerDetails getActiveBrokerDetails()

Get the details of the currently active broker

Returns:

null if no broker is active (i.e. no successful connection has been made, or the BrokerDetail instance otherwise

failoverAllowed

public boolean failoverAllowed()

createSession

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

Specified by:

createSession in interface javax.jms.Connection

Throws:

javax.jms.JMSException

createSession

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

Description copied from interface: Connection

Create a session specifying the prefetch limit of messages.

prefetch - the maximum number of messages to buffer in the client. This applies as a total across all consumers

Returns:

Throws:

javax.jms.JMSException

createSession

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

Description copied from interface: Connection

Create a session specifying the prefetch limit of messages.

prefetchHigh - the maximum number of messages to buffer in the client. This applies as a total across all consumers

prefetchLow - the number of messages that must be in the buffer in the client to renable message flow. This applies as a total across all consumers

Returns:

Throws:

javax.jms.JMSException

getBrokerSuppliedTrustStore

public KeyStore getBrokerSuppliedTrustStore(String name)
                                     throws javax.jms.JMSException

Throws:

javax.jms.JMSException

setFailoverPolicy

public void setFailoverPolicy(FailoverPolicy policy)

getFailoverPolicy

public FailoverPolicy getFailoverPolicy()

createQueueSession

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

Returns an AMQQueueSessionAdaptor which wraps an AMQSession and throws IllegalStateExceptions where specified in the JMS spec

Specified by:

createQueueSession in interface javax.jms.QueueConnection

Parameters:

transacted -

acknowledgeMode -

Returns:

QueueSession

Throws:

javax.jms.JMSException

createTopicSession

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

Returns an AMQTopicSessionAdapter which wraps an AMQSession and throws IllegalStateExceptions where specified in the JMS spec

Specified by:

createTopicSession in interface javax.jms.TopicConnection

Parameters:

transacted -

acknowledgeMode -

Returns:

TopicSession

Throws:

javax.jms.JMSException

channelLimitReached

public boolean channelLimitReached()

getClientID

public String getClientID()
                   throws javax.jms.JMSException

Specified by:

getClientID 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

getMetaData

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

Specified by:

getMetaData in interface javax.jms.Connection

Throws:

javax.jms.JMSException

getExceptionListenerNoCheck

protected final javax.jms.ExceptionListener getExceptionListenerNoCheck()

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

start

public void start()
           throws javax.jms.JMSException

Start the connection, i.e. start flowing messages. Note that this method must be called only from a single thread and is not thread safe (which is legal according to the JMS specification).

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

close

public void close()
           throws javax.jms.JMSException

Description copied from class: Closeable

Closes this object.

Specified by:

close in interface javax.jms.Connection

Specified by:

close in class Closeable

Throws:

javax.jms.JMSException - If this cannot be closed for any reason.

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

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

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

getMaximumChannelCount

public long getMaximumChannelCount()
                            throws javax.jms.JMSException

Returns:

the maximum number of sessions supported by this Connection

Throws:

javax.jms.JMSException

setConnectionListener

public void setConnectionListener(ConnectionListener listener)

getConnectionListener

public ConnectionListener getConnectionListener()

Description copied from interface: Connection

Get the connection listener that has been registered with this connection, if any

Returns:

the listener or null if none has been set

setMaximumChannelCount

public void setMaximumChannelCount(long maximumChannelCount)

setMaximumFrameSize

public void setMaximumFrameSize(long frameMax)

getMaximumFrameSize

public long getMaximumFrameSize()

getSessions

public ChannelToSessionMap getSessions()

getUsername

public String getUsername()

setUsername

public void setUsername(String id)

getPassword

public String getPassword()

getVirtualHost

public String getVirtualHost()

getProtocolHandler

public final AMQProtocolHandler getProtocolHandler()

started

public final boolean started()

isConnected

public final boolean isConnected()

setConnected

protected final void setConnected(boolean connected)

bytesSent

public void bytesSent(long writtenBytes)

bytesReceived

public void bytesReceived(long receivedBytes)

firePreFailover

public boolean firePreFailover(boolean redirect)

Fire the preFailover event to the registered connection listener (if any)

Parameters:

redirect - true if this is the result of a redirect request rather than a connection error

Returns:

true if no listener or listener does not veto change

firePreResubscribe

public boolean firePreResubscribe()
                           throws javax.jms.JMSException

Fire the preResubscribe event to the registered connection listener (if any). If the listener vetoes resubscription then all the sessions are closed.

Returns:

true if no listener or listener does not veto resubscription.

Throws:

javax.jms.JMSException

fireFailoverComplete

public void fireFailoverComplete()

Fires a failover complete event to the registered connection listener (if any).

getFailoverMutex

public final Object getFailoverMutex()

In order to protect the consistency of the connection and its child sessions, consumers and producers, the "failover mutex" must be held when doing any operations that could be corrupted during failover.

Returns:

a mutex. Guaranteed never to change for the lifetime of this connection even if failover occurs.

resubscribeSessions

public void resubscribeSessions()
                         throws javax.jms.JMSException,
                                QpidException,
                                FailoverException

Throws:

javax.jms.JMSException

QpidException

FailoverException

blockUntilNotFailingOver

public void blockUntilNotFailingOver()
                              throws InterruptedException

If failover is taking place this will block until it has completed. If failover is not taking place it will return immediately.

Throws:

InterruptedException

exceptionReceived

public void exceptionReceived(Throwable cause)

Invoked by the AMQProtocolSession when a protocol session exception has occurred. This method sends the exception to a JMS exception listener, if configured, and propagates the exception to sessions, which in turn will propagate to consumers. This allows synchronous consumers to have exceptions thrown to them.

Parameters:

cause - the exception

deregisterSession

public void deregisterSession(int channelId)

toString

public String toString()

Overrides:

toString in class Object

getConnectionURL

public ConnectionURL getConnectionURL()

Returns connection url.

Returns:

connection url

toURL

public String toURL()

Returns stringified connection url. This url is suitable only for display as AMQConnectionURL.toString() converts any password to asterisks.

Returns:

connection url

getReference

public Reference getReference()
                       throws NamingException

Specified by:

getReference in interface Referenceable

Throws:

NamingException

getDefaultTopicExchangeName

public String getDefaultTopicExchangeName()

setDefaultTopicExchangeName

public void setDefaultTopicExchangeName(String defaultTopicExchangeName)

getDefaultQueueExchangeName

public String getDefaultQueueExchangeName()

setDefaultQueueExchangeName

public void setDefaultQueueExchangeName(String defaultQueueExchangeName)

getTemporaryTopicExchangeName

public String getTemporaryTopicExchangeName()

getTemporaryQueueExchangeName

public String getTemporaryQueueExchangeName()

setTemporaryTopicExchangeName

public void setTemporaryTopicExchangeName(String temporaryTopicExchangeName)

setTemporaryQueueExchangeName

public void setTemporaryQueueExchangeName(String temporaryQueueExchangeName)

performConnectionTask

public void performConnectionTask(Runnable task)

getSession

public AMQSession getSession(int channelId)

getProtocolVersion

public ProtocolVersion getProtocolVersion()

getBrokerUUID

public String getBrokerUUID()

isFailingOver

public boolean isFailingOver()

getMaxPrefetch

public long getMaxPrefetch()

Get the maximum number of messages that this connection can pre-fetch.

Returns:

The maximum number of messages that this connection can pre-fetch.

getSyncPersistence

public boolean getSyncPersistence()

Indicates whether persistent messages are synchronized

Returns:

true if persistent messages are synchronized false otherwise

getSyncAck

public boolean getSyncAck()

Indicates whether we need to sync on every message ack

getSyncPublish

public String getSyncPublish()

isPopulateUserId

public boolean isPopulateUserId()

isMessageCompressionDesired

public boolean isMessageCompressionDesired()

getNextChannelID

public int getNextChannelID()

isUseLegacyMapMessageFormat

public boolean isUseLegacyMapMessageFormat()

isUseLegacyStreamMessageFormat

public boolean isUseLegacyStreamMessageFormat()

getLastFailoverTime

public long getLastFailoverTime()

getDelegate

protected AMQConnectionDelegate getDelegate()

getConnectionNumber

public Long getConnectionNumber()

logConnected

protected void logConnected(SocketAddress localAddress,
                SocketAddress remoteAddress)

validateQueueOnSend

public boolean validateQueueOnSend()

getMessageCompressionThresholdSize

public int getMessageCompressionThresholdSize()

getTemporaryQueuePrefix

public String getTemporaryQueuePrefix()

setConnectionSettings

public void setConnectionSettings(ConnectionSettings connectionSettings)

getConnectionSettings

public ConnectionSettings getConnectionSettings()

isTrusted

public boolean isTrusted(Class<?> clazz)

Specified by:

isTrusted in interface ClassLoadingAwareObjectInputStream.TrustedClassFilter