com.adaptris.core.jms

Class FailoverJmsConnection

java.lang.Object

com.adaptris.core.AdaptrisConnectionImp

com.adaptris.core.AllowsRetriesConnection

com.adaptris.core.jms.JmsConnection

com.adaptris.core.jms.FailoverJmsConnection

All Implemented Interfaces:

AdaptrisComponent, AdaptrisConnection, ComponentLifecycle, ComponentLifecycleExtension, ConnectionComparator<JmsConnection>, JmsConnectionConfig, JndiBindable, StateManagedComponent

@ComponentProfile(summary="Connect to a JMS 1.1 broker supporting broker failover in a vendor independent way",
                  tag="connections,jms")
public class FailoverJmsConnection
extends JmsConnection

JmsConnection implementation that wraps a list of concrete JMSConnection instances to provide failover.

This class is designed for use with JMS Brokers that do not provide any transparent failover facility. For instance, SonicMQ provides transparent failover, so you should use that instead rather than having another concrete JMSConnection instance.

Note the while this JmsConnection implementation still exposes connection configuration, these will be ignored, as all connection based activity is delegated to the underlying JmsConnections. The only configuration that overrides the underlying JmsConnection configuration is the connection-attempts and connection-wait.

In the adapter configuration file this class is aliased as failover-jms-connection which is the preferred alternative to the fully qualified classname when building your configuration.

Field Summary

Fields inherited from class com.adaptris.core.jms.JmsConnection

connection

Fields inherited from class com.adaptris.core.AdaptrisConnectionImp

log

Constructor Summary

Constructors

Constructor and Description
FailoverJmsConnection()

Method Summary

Modifier and Type	Method and Description
void	addConnection(JmsConnection c)
void	closeConnection() Close the underlying connection.
java.lang.String	configuredClientId() The client id.
java.lang.String	configuredPassword() The password.
java.lang.String	configuredUserName() The username.
VendorImplementation	configuredVendorImplementation() The vendor specific implementation.
boolean	connectionEquals(JmsConnection connection)
protected void	createConnection(javax.jms.ConnectionFactory factory)
javax.jms.Session	createSession(boolean transacted, int acknowledgeMode) Creates a new Session on the underlying JMS Connection.
javax.jms.Connection	currentConnection()
java.util.List<JmsConnection>	getConnections()
java.lang.Boolean	getRegisterOwner()
protected void	initConnection() Initialise the underlying connection.
javax.jms.ConnectionFactory	obtainConnectionFactory()
protected void	prepareConnection()
void	setConnections(java.util.List<JmsConnection> l)
void	setRegisterOwner(java.lang.Boolean b) Specify whether to register this instance or its owner with the underlying connection
protected void	startConnection() Start the underlying connection.
protected void	stopConnection() Stop the underlying connection.

Methods inherited from class com.adaptris.core.jms.JmsConnection

additionalDebug, cloneForTesting, connectionErrorHandler, getAdditionalDebug, getClientId, getPassword, getUserName, getVendorImplementation, setAdditionalDebug, setClientId, setPassword, setUserName, setVendorImplementation

Methods inherited from class com.adaptris.core.AllowsRetriesConnection

connectionAttempts, connectionRetryInterval, createLoggingStatement, getConnectionAttempts, getConnectionRetryInterval, logWarning, setConnectionAttempts, setConnectionRetryInterval

Methods inherited from class com.adaptris.core.AdaptrisConnectionImp

addExceptionListener, addMessageConsumer, addMessageProducer, changeState, close, getConnectionErrorHandler, getLookupName, getUniqueId, getWorkersFirstOnShutdown, init, prepare, requestClose, requestInit, requestStart, requestStop, retrieveComponentState, retrieveConnection, retrieveExceptionListeners, retrieveMessageConsumers, retrieveMessageProducers, setConnectionErrorHandler, setLookupName, setUniqueId, setWorkersFirstOnShutdown, start, stop, workersFirstOnShutdown

Methods inherited from class java.lang.Object

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

Constructor Detail

FailoverJmsConnection

public FailoverJmsConnection()

Method Detail

initConnection

protected void initConnection()
                       throws CoreException

Description copied from class: AdaptrisConnectionImp

Initialise the underlying connection.

Overrides:

initConnection in class JmsConnection

Throws:

CoreException - wrapping any exception.

See Also:

AdaptrisConnectionImp.init()

startConnection

protected void startConnection()
                        throws CoreException

Description copied from class: AdaptrisConnectionImp

Start the underlying connection.

Overrides:

startConnection in class JmsConnection

Throws:

CoreException - wrapping any exception.

See Also:

JmsConnection.startConnection()

stopConnection

protected void stopConnection()

Description copied from class: AdaptrisConnectionImp

Stop the underlying connection.

Overrides:

stopConnection in class JmsConnection

See Also:

JmsConnection.stopConnection()

closeConnection

public void closeConnection()

Description copied from class: AdaptrisConnectionImp

Close the underlying connection.

Overrides:

closeConnection in class JmsConnection

See Also:

JmsConnection.closeConnection()

createSession

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

Creates a new Session on the underlying JMS Connection.

Overrides:

createSession in class JmsConnection

Parameters:

transacted - true if transacted

acknowledgeMode - acknowledge mode

Returns:

a new Session

Throws:

javax.jms.JMSException - if any occurs

createConnection

protected void createConnection(javax.jms.ConnectionFactory factory)
                         throws javax.jms.JMSException

Overrides:

createConnection in class JmsConnection

Throws:

javax.jms.JMSException

getConnections

public java.util.List<JmsConnection> getConnections()

addConnection

public void addConnection(JmsConnection c)

setConnections

public void setConnections(java.util.List<JmsConnection> l)

getRegisterOwner

public java.lang.Boolean getRegisterOwner()

Returns:

the registerOwner

See Also:

setRegisterOwner(Boolean)

setRegisterOwner

public void setRegisterOwner(java.lang.Boolean b)

Specify whether to register this instance or its owner with the underlying connection

Parameters:

b - the registerOwner to set, defaults to false which registers this instance as the owner of the underlying connection.

prepareConnection

protected void prepareConnection()
                          throws CoreException

Overrides:

prepareConnection in class JmsConnection

Throws:

CoreException

obtainConnectionFactory

public javax.jms.ConnectionFactory obtainConnectionFactory()
                                                    throws java.lang.Exception

Overrides:

obtainConnectionFactory in class JmsConnection

Throws:

java.lang.Exception

currentConnection

public javax.jms.Connection currentConnection()

Overrides:

currentConnection in class JmsConnection

configuredClientId

public java.lang.String configuredClientId()

Description copied from interface: JmsConnectionConfig

The client id.

Specified by:

configuredClientId in interface JmsConnectionConfig

Overrides:

configuredClientId in class JmsConnection

Returns:

the client id

configuredPassword

public java.lang.String configuredPassword()

Description copied from interface: JmsConnectionConfig

The password.

Specified by:

configuredPassword in interface JmsConnectionConfig

Overrides:

configuredPassword in class JmsConnection

Returns:

the password

configuredUserName

public java.lang.String configuredUserName()

Description copied from interface: JmsConnectionConfig

The username.

Specified by:

configuredUserName in interface JmsConnectionConfig

Overrides:

configuredUserName in class JmsConnection

Returns:

the username

configuredVendorImplementation

public VendorImplementation configuredVendorImplementation()

Description copied from interface: JmsConnectionConfig

The vendor specific implementation.

Specified by:

configuredVendorImplementation in interface JmsConnectionConfig

Overrides:

configuredVendorImplementation in class JmsConnection

Returns:

the vendor specific implementation

connectionEquals

public boolean connectionEquals(JmsConnection connection)

Specified by:

connectionEquals in interface ConnectionComparator<JmsConnection>

Overrides:

connectionEquals in class JmsConnection