com.adaptris.jdbc.connection

Class FailoverDataSource

java.lang.Object

com.adaptris.jdbc.connection.FailoverDataSource

All Implemented Interfaces:

java.sql.Wrapper, javax.sql.CommonDataSource, javax.sql.DataSource

public class FailoverDataSource
extends java.lang.Object
implements javax.sql.DataSource

Datasource that has a connection capable of failover to an alternate database.

Because of we want to failover to an alternate database, the implementation of getConnection(String username, String password) simply discards the username and password and relies on the configuration that was supplied when constructing this class. This is the desired behaviour.

The underlying pool implementation is a org.apache.commons.pool.impl.GenericObjectPool. The default size of the pool is 10 with a wait time of 20seconds. If the pool is exhausted, then a NoSuchElementException will be thrown after the wait time.

See Also:

DataSource, FailoverConnection, FailoverConfig

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected class	FailoverDataSource.ConnectionProxy This class proxies the underlying FailoverConnection class.
protected class	FailoverDataSource.PoolAttendant This class is reponsible for creating swimmers who swim in the Datasource Pool.

Field Summary

Fields

Modifier and Type	Field and Description
protected org.slf4j.Logger	logR
static java.lang.String	POOL_MAX_SIZE Resource Key for the maximum size of the pool.
static java.lang.String	POOL_TIME_TO_WAIT Resource Key for the time to wait for an available connection.

Constructor Summary

Constructors

Constructor and Description
FailoverDataSource(java.util.Properties p)

Method Summary

Modifier and Type	Method and Description
protected FailoverConfig	config()
protected void	destroy()
java.sql.Connection	getConnection() Get the configured connection.
java.sql.Connection	getConnection(java.lang.String username, java.lang.String password) Get the configured connection.
int	getLoginTimeout()
java.io.PrintWriter	getLogWriter()
java.util.logging.Logger	getParentLogger()
boolean	isWrapperFor(java.lang.Class<?> iface)
protected int	maxPoolSize()
protected void	overrideObjectPool(org.apache.commons.pool.impl.GenericObjectPool p)
void	setLoginTimeout(int loginTimeout)
void	setLogWriter(java.io.PrintWriter logWriter)
protected long	timeToWait()
<T> T	unwrap(java.lang.Class<T> iface)
protected static java.sql.SQLClientInfoException	wrapSQLClientInfoException(java.lang.Exception e)
protected static java.sql.SQLException	wrapSQLException(java.lang.Exception e)

Methods inherited from class java.lang.Object

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

Field Detail

POOL_MAX_SIZE

public static final java.lang.String POOL_MAX_SIZE

Resource Key for the maximum size of the pool.

See Also:

Constant Field Values

POOL_TIME_TO_WAIT

public static final java.lang.String POOL_TIME_TO_WAIT

Resource Key for the time to wait for an available connection.

See Also:

Constant Field Values

logR

protected transient org.slf4j.Logger logR

Constructor Detail

FailoverDataSource

public FailoverDataSource(java.util.Properties p)

Method Detail

config

protected FailoverConfig config()

maxPoolSize

protected int maxPoolSize()

timeToWait

protected long timeToWait()

overrideObjectPool

protected void overrideObjectPool(org.apache.commons.pool.impl.GenericObjectPool p)
                           throws java.lang.Exception

Throws:

java.lang.Exception

destroy

protected void destroy()
                throws java.lang.Exception

Throws:

java.lang.Exception

getConnection

public java.sql.Connection getConnection()
                                  throws java.sql.SQLException

Get the configured connection.

Specified by:

getConnection in interface javax.sql.DataSource

Throws:

java.sql.SQLException

See Also:

DataSource.getConnection()

getConnection

public java.sql.Connection getConnection(java.lang.String username,
                                         java.lang.String password)
                                  throws java.sql.SQLException

Get the configured connection.

This class will ignore the supplied credentials, relying on the configuration used to create this source instead.

This can be considered breaking the javax.sql.DataSource contract, however, this is the desired behaviour when you are failing over to multiple databases.

Specified by:

getConnection in interface javax.sql.DataSource

Throws:

java.sql.SQLException

See Also:

DataSource.getConnection(String, String)

setLoginTimeout

public void setLoginTimeout(int loginTimeout)
                     throws java.sql.SQLException

Specified by:

setLoginTimeout in interface javax.sql.CommonDataSource

Throws:

java.sql.SQLException

See Also:

CommonDataSource.setLoginTimeout(int)

getLoginTimeout

public int getLoginTimeout()
                    throws java.sql.SQLException

Specified by:

getLoginTimeout in interface javax.sql.CommonDataSource

Throws:

java.sql.SQLException

See Also:

CommonDataSource.getLoginTimeout()

setLogWriter

public void setLogWriter(java.io.PrintWriter logWriter)
                  throws java.sql.SQLException

Specified by:

setLogWriter in interface javax.sql.CommonDataSource

Throws:

java.sql.SQLException

See Also:

CommonDataSource.setLogWriter(java.io.PrintWriter)

getLogWriter

public java.io.PrintWriter getLogWriter()
                                 throws java.sql.SQLException

Specified by:

getLogWriter in interface javax.sql.CommonDataSource

Throws:

java.sql.SQLException

See Also:

CommonDataSource.getLogWriter()

isWrapperFor

public boolean isWrapperFor(java.lang.Class<?> iface)
                     throws java.sql.SQLException

Specified by:

isWrapperFor in interface java.sql.Wrapper

Throws:

java.sql.SQLException

See Also:

Wrapper.isWrapperFor(java.lang.Class)

unwrap

public <T> T unwrap(java.lang.Class<T> iface)
             throws java.sql.SQLException

Specified by:

unwrap in interface java.sql.Wrapper

Throws:

java.sql.SQLException

See Also:

Wrapper.unwrap(java.lang.Class)

getParentLogger

public java.util.logging.Logger getParentLogger()
                                         throws java.sql.SQLFeatureNotSupportedException

Specified by:

getParentLogger in interface javax.sql.CommonDataSource

Throws:

java.sql.SQLFeatureNotSupportedException

wrapSQLClientInfoException

protected static java.sql.SQLClientInfoException wrapSQLClientInfoException(java.lang.Exception e)

wrapSQLException

protected static java.sql.SQLException wrapSQLException(java.lang.Exception e)