org.datanucleus.store.rdbms.datasource.dbcp.datasources

Class InstanceKeyDataSource

java.lang.Object

org.datanucleus.store.rdbms.datasource.dbcp.datasources.InstanceKeyDataSource

All Implemented Interfaces:

Serializable, Wrapper, Referenceable, CommonDataSource, DataSource

Direct Known Subclasses:

PerUserPoolDataSource, SharedPoolDataSource

public abstract class InstanceKeyDataSource
extends Object
implements DataSource, Referenceable, Serializable

The base class for SharedPoolDataSource and PerUserPoolDataSource.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected String	instanceKey Instance key
protected static int	UNKNOWN_TRANSACTIONISOLATION Internal constant to indicate the level is not set.

Constructor Summary

Constructors

Constructor and Description
InstanceKeyDataSource()

Method Summary

Modifier and Type	Method and Description
protected void	assertInitializationAllowed()
abstract void	close()
Connection	getConnection()
Connection	getConnection(String username, String password)
protected abstract org.datanucleus.store.rdbms.datasource.dbcp.datasources.PooledConnectionManager	getConnectionManager(org.datanucleus.store.rdbms.datasource.dbcp.datasources.UserPassKey upkey)
ConnectionPoolDataSource	getConnectionPoolDataSource()
String	getDataSourceName()
int	getDefaultTransactionIsolation()
String	getDescription()
String	getJndiEnvironment(String key)
int	getLoginTimeout()
PrintWriter	getLogWriter()
int	getMinEvictableIdleTimeMillis()
int	getNumTestsPerEvictionRun()
protected abstract org.datanucleus.store.rdbms.datasource.dbcp.datasources.PooledConnectionAndInfo	getPooledConnectionAndInfo(String username, String password)
Reference	getReference()
boolean	getTestOnBorrow()
boolean	getTestOnReturn()
boolean	getTestWhileIdle()
int	getTimeBetweenEvictionRunsMillis()
String	getValidationQuery()
boolean	isDefaultAutoCommit()
boolean	isDefaultReadOnly()
boolean	isRollbackAfterValidation()
boolean	isTestOnBorrow()
boolean	isTestOnReturn()
boolean	isTestWhileIdle()
boolean	isWrapperFor(Class<?> iface)
void	setConnectionPoolDataSource(ConnectionPoolDataSource v)
void	setDataSourceName(String v)
void	setDefaultAutoCommit(boolean v)
void	setDefaultReadOnly(boolean v)
void	setDefaultTransactionIsolation(int v)
void	setDescription(String v)
void	setJndiEnvironment(String key, String value)
void	setLoginTimeout(int v)
void	setLogWriter(PrintWriter v)
void	setMinEvictableIdleTimeMillis(int minEvictableIdleTimeMillis)
void	setNumTestsPerEvictionRun(int numTestsPerEvictionRun)
void	setRollbackAfterValidation(boolean rollbackAfterValidation)
void	setTestOnBorrow(boolean testOnBorrow)
void	setTestOnReturn(boolean testOnReturn)
void	setTestWhileIdle(boolean testWhileIdle)
void	setTimeBetweenEvictionRunsMillis(int timeBetweenEvictionRunsMillis)
protected abstract void	setupDefaults(Connection con, String username)
void	setValidationQuery(String validationQuery)
protected ConnectionPoolDataSource	testCPDS(String username, String password)
<T> T	unwrap(Class<T> iface)
protected byte	whenExhaustedAction(int maxActive, int maxWait)

Methods inherited from class java.lang.Object

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

Methods inherited from interface javax.sql.CommonDataSource

getParentLogger

Field Detail

UNKNOWN_TRANSACTIONISOLATION

protected static final int UNKNOWN_TRANSACTIONISOLATION

Internal constant to indicate the level is not set.

See Also:

Constant Field Values

instanceKey

protected String instanceKey

Instance key

Constructor Detail

InstanceKeyDataSource

public InstanceKeyDataSource()

Method Detail

assertInitializationAllowed

protected void assertInitializationAllowed()
                                    throws IllegalStateException

Throws:

IllegalStateException

close

public abstract void close()
                    throws Exception

Throws:

Exception

getConnectionManager

protected abstract org.datanucleus.store.rdbms.datasource.dbcp.datasources.PooledConnectionManager getConnectionManager(org.datanucleus.store.rdbms.datasource.dbcp.datasources.UserPassKey upkey)

isWrapperFor

public boolean isWrapperFor(Class<?> iface)
                     throws SQLException

Specified by:

isWrapperFor in interface Wrapper

Throws:

SQLException

unwrap

public <T> T unwrap(Class<T> iface)
             throws SQLException

Specified by:

unwrap in interface Wrapper

Throws:

SQLException

getConnectionPoolDataSource

public ConnectionPoolDataSource getConnectionPoolDataSource()

setConnectionPoolDataSource

public void setConnectionPoolDataSource(ConnectionPoolDataSource v)

getDataSourceName

public String getDataSourceName()

setDataSourceName

public void setDataSourceName(String v)

isDefaultAutoCommit

public boolean isDefaultAutoCommit()

setDefaultAutoCommit

public void setDefaultAutoCommit(boolean v)

isDefaultReadOnly

public boolean isDefaultReadOnly()

setDefaultReadOnly

public void setDefaultReadOnly(boolean v)

getDefaultTransactionIsolation

public int getDefaultTransactionIsolation()

setDefaultTransactionIsolation

public void setDefaultTransactionIsolation(int v)

getDescription

public String getDescription()

setDescription

public void setDescription(String v)

getJndiEnvironment

public String getJndiEnvironment(String key)

setJndiEnvironment

public void setJndiEnvironment(String key,
                               String value)

getLoginTimeout

public int getLoginTimeout()

Specified by:

getLoginTimeout in interface CommonDataSource

setLoginTimeout

public void setLoginTimeout(int v)

Specified by:

setLoginTimeout in interface CommonDataSource

getLogWriter

public PrintWriter getLogWriter()

Specified by:

getLogWriter in interface CommonDataSource

setLogWriter

public void setLogWriter(PrintWriter v)

Specified by:

setLogWriter in interface CommonDataSource

isTestOnBorrow

public final boolean isTestOnBorrow()

getTestOnBorrow

public boolean getTestOnBorrow()

setTestOnBorrow

public void setTestOnBorrow(boolean testOnBorrow)

isTestOnReturn

public final boolean isTestOnReturn()

getTestOnReturn

public boolean getTestOnReturn()

setTestOnReturn

public void setTestOnReturn(boolean testOnReturn)

getTimeBetweenEvictionRunsMillis

public int getTimeBetweenEvictionRunsMillis()

setTimeBetweenEvictionRunsMillis

public void setTimeBetweenEvictionRunsMillis(int timeBetweenEvictionRunsMillis)

getNumTestsPerEvictionRun

public int getNumTestsPerEvictionRun()

setNumTestsPerEvictionRun

public void setNumTestsPerEvictionRun(int numTestsPerEvictionRun)

getMinEvictableIdleTimeMillis

public int getMinEvictableIdleTimeMillis()

setMinEvictableIdleTimeMillis

public void setMinEvictableIdleTimeMillis(int minEvictableIdleTimeMillis)

isTestWhileIdle

public final boolean isTestWhileIdle()

getTestWhileIdle

public boolean getTestWhileIdle()

setTestWhileIdle

public void setTestWhileIdle(boolean testWhileIdle)

getValidationQuery

public String getValidationQuery()

setValidationQuery

public void setValidationQuery(String validationQuery)

isRollbackAfterValidation

public boolean isRollbackAfterValidation()

setRollbackAfterValidation

public void setRollbackAfterValidation(boolean rollbackAfterValidation)

getConnection

public Connection getConnection()
                         throws SQLException

Specified by:

getConnection in interface DataSource

Throws:

SQLException

getConnection

public Connection getConnection(String username,
                                String password)
                         throws SQLException

Specified by:

getConnection in interface DataSource

Throws:

SQLException

getPooledConnectionAndInfo

protected abstract org.datanucleus.store.rdbms.datasource.dbcp.datasources.PooledConnectionAndInfo getPooledConnectionAndInfo(String username,
                                                                                                                              String password)
                                                                                                                       throws SQLException

Throws:

SQLException

setupDefaults

protected abstract void setupDefaults(Connection con,
                                      String username)
                               throws SQLException

Throws:

SQLException

testCPDS

protected ConnectionPoolDataSource testCPDS(String username,
                                            String password)
                                     throws NamingException,
                                            SQLException

Throws:

NamingException

SQLException

whenExhaustedAction

protected byte whenExhaustedAction(int maxActive,
                                   int maxWait)

getReference

public Reference getReference()
                       throws NamingException

Specified by:

getReference in interface Referenceable

Throws:

NamingException