org.hawkular.bus.common

Class ConnectionContextFactory

java.lang.Object

org.hawkular.bus.common.ConnectionContextFactory

All Implemented Interfaces:

AutoCloseable

public class ConnectionContextFactory
extends Object
implements AutoCloseable

Provides convenience functionality to create producer or consumer contexts. You can then pass these created contexts to MessageProcessor to send and receive messages. This class can reuse a connection so that it is shared across multiple contexts. See createOrReuseConnection(ConnectionContext, boolean). If this object was told not to reuse its connection, it will create a new connection for each context is creates. When you are done with sending and receiving messages through the created contexts, you should call close() to free up resources and close the connection to the broker. Subclasses are free to extend this class to add or override functionality or to provide stricter type-checking.

Field Summary

Fields

Modifier and Type	Field and Description
protected javax.jms.ConnectionFactory	connectionFactory

Constructor Summary

Constructors

Constructor and Description
ConnectionContextFactory(boolean reuseConnection, javax.jms.ConnectionFactory connectionFactory) Initializes with the given factory.
ConnectionContextFactory(boolean reuseConnection, String brokerURL) Initializes the factory with the given broker URL.
ConnectionContextFactory(boolean reuseConnection, String brokerURL, String username, String password) Initializes the factory with the given broker URL and the given security credentials.
ConnectionContextFactory(javax.jms.ConnectionFactory connectionFactory) Initializes with the given factory.
ConnectionContextFactory(String brokerURL) Initializes the factory with the given broker URL.
ConnectionContextFactory(String brokerURL, String username, String password) Initializes the factory with the given broker URL and the given security credentials.

Method Summary

Modifier and Type	Method and Description
protected void	cacheConnection(javax.jms.Connection connection, boolean closeExistingConnection) To store a connection in this processor object, call this setter.
void	close() This will close its open connection that it has cached, thus freeing up resources.
protected void	createConnection(ConnectionContext context) Creates a connection using this object's connection factory and stores that connection in the given context object.
protected void	createConsumer(ConsumerConnectionContext context, String messageSelector) Creates a message consumer using the context's session and destination.
ConsumerConnectionContext	createConsumerConnectionContext(Endpoint endpoint) Creates a new consumer connection context, reusing any existing connection that might have already been created.
ConsumerConnectionContext	createConsumerConnectionContext(Endpoint endpoint, String messageSelector) Creates a new consumer connection context, reusing any existing connection that might have already been created.
protected void	createDestination(ConnectionContext context, Endpoint endpoint) Creates a destination using the context's session.
protected void	createOrReuseConnection(ConnectionContext context, boolean start) This method provides a way to cache and share a connection across multiple contexts.
protected void	createProducer(ProducerConnectionContext context) Creates a message producer using the context's session and destination.
ProducerConnectionContext	createProducerConnectionContext(Endpoint endpoint) Creates a new producer connection context, reusing any existing connection that might have already been created.
protected void	createSession(ConnectionContext context) Creates a default session using the context's connection.
protected javax.jms.Connection	getConnection() The stored connection.
protected javax.jms.ConnectionFactory	getConnectionFactory()
protected boolean	isReuseConnection()

Methods inherited from class java.lang.Object

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

Field Detail

connectionFactory

protected final javax.jms.ConnectionFactory connectionFactory

Constructor Detail

ConnectionContextFactory

public ConnectionContextFactory(String brokerURL)
                         throws javax.jms.JMSException

Initializes the factory with the given broker URL.

Parameters:

brokerURL - the broker that is used for the contexts created by this factory; all messages sent and received through the contexts will go through this broker.

Throws:

javax.jms.JMSException - any error

ConnectionContextFactory

public ConnectionContextFactory(boolean reuseConnection,
                                String brokerURL)
                         throws javax.jms.JMSException

Initializes the factory with the given broker URL.

Parameters:

reuseConnection - if true this factory will reuse its connection so contexts it creates can share it. Use this with caution because if a shared connection is closed, all contexts created with that connection will no longer work.

brokerURL - the broker that is used for the contexts created by this factory; all messages sent and received through the contexts will go through this broker.

Throws:

javax.jms.JMSException - any error

ConnectionContextFactory

public ConnectionContextFactory(String brokerURL,
                                String username,
                                String password)
                         throws javax.jms.JMSException

Initializes the factory with the given broker URL and the given security credentials.

Parameters:

brokerURL - the broker that is used for the contexts created by this factory; all messages sent and received through the contexts will go through this broker.

username - user to connect to

password - credentials of user

Throws:

javax.jms.JMSException - any error

ConnectionContextFactory

public ConnectionContextFactory(boolean reuseConnection,
                                String brokerURL,
                                String username,
                                String password)
                         throws javax.jms.JMSException

Initializes the factory with the given broker URL and the given security credentials.

Parameters:

reuseConnection - if true this factory will reuse its connection so contexts it creates can share it. Use this with caution because if a shared connection is closed, all contexts created with that connection will no longer work.

brokerURL - the broker that is used for the contexts created by this factory; all messages sent and received through the contexts will go through this broker.

username - user to connect to

password - credentials of user

Throws:

javax.jms.JMSException - any error

ConnectionContextFactory

public ConnectionContextFactory(javax.jms.ConnectionFactory connectionFactory)
                         throws javax.jms.JMSException

Initializes with the given factory.

Parameters:

connectionFactory - the factory that will be used to create contexts.

Throws:

javax.jms.JMSException - any error

ConnectionContextFactory

public ConnectionContextFactory(boolean reuseConnection,
                                javax.jms.ConnectionFactory connectionFactory)
                         throws javax.jms.JMSException

Initializes with the given factory.

Parameters:

reuseConnection - if true this factory will reuse its connection so contexts it creates can share it. Use this with caution because if a shared connection is closed, all contexts created with that connection will no longer work.

connectionFactory - the factory that will be used to create contexts.

Throws:

javax.jms.JMSException - any error

Method Detail

createProducerConnectionContext

public ProducerConnectionContext createProducerConnectionContext(Endpoint endpoint)
                                                          throws javax.jms.JMSException

Creates a new producer connection context, reusing any existing connection that might have already been created. The destination of the connection's session will be that of the given endpoint.

Parameters:

endpoint - where the producer will send messages

Returns:

the new producer connection context fully populated

Throws:

javax.jms.JMSException - any error

createConsumerConnectionContext

public ConsumerConnectionContext createConsumerConnectionContext(Endpoint endpoint)
                                                          throws javax.jms.JMSException

Creates a new consumer connection context, reusing any existing connection that might have already been created. The destination of the connection's session will be that of the given endpoint.

Parameters:

endpoint - where the consumer will listen for messages

Returns:

the new consumer connection context fully populated

Throws:

javax.jms.JMSException - any error

createConsumerConnectionContext

public ConsumerConnectionContext createConsumerConnectionContext(Endpoint endpoint,
                                                                 String messageSelector)
                                                          throws javax.jms.JMSException

Creates a new consumer connection context, reusing any existing connection that might have already been created. The destination of the connection's session will be that of the given endpoint. The consumer will filter messages based on the given message selector expression (which may be null in which case the consumer will consume all messages).

Parameters:

endpoint - where the consumer will listen for messages

messageSelector - message consumer's message selector expression.

Returns:

the new consumer connection context fully populated

Throws:

javax.jms.JMSException - any error

close

public void close()
           throws javax.jms.JMSException

This will close its open connection that it has cached, thus freeing up resources. This method should be called when this context factory is no longer needed. But realize that any contexts that were created with the cached connection will be invalidated since this method will close that connection.

Specified by:

close in interface AutoCloseable

Throws:

javax.jms.JMSException - any error

isReuseConnection

protected boolean isReuseConnection()

Returns:

true if this factory will reuse its connection. Otherwise, it will always create new connections for each context it creates.

getConnectionFactory

protected javax.jms.ConnectionFactory getConnectionFactory()

getConnection

protected javax.jms.Connection getConnection()

The stored connection. NOTE: This is not necessarily the connection created via calling createConnection(ConnectionContext).

Returns:

the connection

See Also:

createConnection(ConnectionContext)

cacheConnection

protected void cacheConnection(javax.jms.Connection connection,
                               boolean closeExistingConnection)

To store a connection in this processor object, call this setter. If there was already a cached connection, it will be closed. NOTE: Calling createConnection(ConnectionContext) does not set this processor's connection - that method only creates the connection and puts that connection in the context. It does not save that connection in this processor object. You must explicitly set the connection via this method if you want that connection cached here. See also createOrReuseConnection(ConnectionContext, boolean).

Parameters:

connection - the connection

closeExistingConnection - if true, and if there was already a connection cached, that connection will be closed. Otherwise it will be left alone but the new connection will take its place.

See Also:

createOrReuseConnection(ConnectionContext, boolean)

createOrReuseConnection

protected void createOrReuseConnection(ConnectionContext context,
                                       boolean start)
                                throws javax.jms.JMSException

This method provides a way to cache and share a connection across multiple contexts. It combines the creation and setting of the connection. This also can optionally start the connection immediately. Use this if you want to reuse any connection that may already be stored in this processor object (i.e. getConnection() is non-null). If there is no connection yet, one will be created. Whether the connection is created or reused, that connection will be stored in the given context. Note that if this object was told not to cache connections, this method will always create a new connection and store it in this object, overwriting any previously created connection (see cacheConnection(javax.jms.Connection, boolean)).

Parameters:

context - the connection will be stored in this context

start - if true, the created connection will be started.

Throws:

javax.jms.JMSException - any error

createConnection

protected void createConnection(ConnectionContext context)
                         throws javax.jms.JMSException

Creates a connection using this object's connection factory and stores that connection in the given context object. NOTE: this does not set the connection in this processor object. If the caller wants the created connection cached in this processor object, cacheConnection(javax.jms.Connection, boolean) must be passed the connection found in the context after this method returns. See also createOrReuseConnection(ConnectionContext, boolean).

Parameters:

context - the context where the new connection is stored

Throws:

javax.jms.JMSException - any error

IllegalStateException - if the context is null

See Also:

createOrReuseConnection(ConnectionContext, boolean), cacheConnection(javax.jms.Connection, boolean)

createSession

protected void createSession(ConnectionContext context)
                      throws javax.jms.JMSException

Creates a default session using the context's connection. This implementation creates a non-transacted, auto-acknowledged session. Subclasses are free to override this behavior.

Parameters:

context - the context where the new session is stored

Throws:

javax.jms.JMSException - any error

IllegalStateException - if the context is null or the context's connection is null

createDestination

protected void createDestination(ConnectionContext context,
                                 Endpoint endpoint)
                          throws javax.jms.JMSException

Creates a destination using the context's session. The destination correlates to the given named queue or topic.

Parameters:

context - the context where the new destination is stored

endpoint - identifies the queue or topic

Throws:

javax.jms.JMSException - any error

IllegalStateException - if the context is null or the context's session is null or endpoint is null

createProducer

protected void createProducer(ProducerConnectionContext context)
                       throws javax.jms.JMSException

Creates a message producer using the context's session and destination.

Parameters:

context - the context where the new producer is stored

Throws:

javax.jms.JMSException - any error

IllegalStateException - if the context is null or the context's session is null or the context's destination is null

createConsumer

protected void createConsumer(ConsumerConnectionContext context,
                              String messageSelector)
                       throws javax.jms.JMSException

Creates a message consumer using the context's session and destination.

Parameters:

context - the context where the new consumer is stored

messageSelector - the message selector expression that the consumer will use to filter messages

Throws:

javax.jms.JMSException - any error

IllegalStateException - if the context is null or the context's session is null or the context's destination is null