de.hybris.platform.jdbcwrapper

Class DataSourceImpl

java.lang.Object

de.hybris.platform.jdbcwrapper.DataSourceImpl

All Implemented Interfaces:

HybrisDataSource, Wrapper, CommonDataSource, DataSource

Direct Known Subclasses:

FlexibleSearchDataSourceImpl, SlaveTenantDataSource

public class DataSourceImpl
extends Object
implements HybrisDataSource

DataSource connection factory for JDBC Connections. CAUTION: Please be aware that this file will be compiled by using jdk 1.6 and jdk 1.7,
for being successful in both cases we have to suppress the generation of the @override annotation. So please DONT OPEN/SAVE this file by using eclipse !!!!

Field Summary

Fields

Modifier and Type	Field and Description
protected static Integer	OBJ_POOL_V1_WHEN_EXHAUSTED_BLOCK
protected static Integer	OBJ_POOL_V1_WHEN_EXHAUSTED_FAIL
protected static Integer	OBJ_POOL_V1_WHEN_EXHAUSTED_GROW

Constructor Summary

Constructors

Modifier	Constructor and Description
	DataSourceImpl(Tenant tenant, String id, Map<String,String> params, boolean readOnly, DataSourceFactory factory) Creates a new data source using connection parameters.
protected	DataSourceImpl(Tenant tenant, String id, Map<String,String> params, String jndiName, boolean readOnly, DataSourceFactory factory)
	DataSourceImpl(Tenant tenant, String id, String jndiName, boolean readOnly, DataSourceFactory factory) Creates a new data source using a existing JNDI data source.

Method Summary

Modifier and Type	Method and Description
boolean	cannotConnect()
protected GenericObjectPoolConfig	createNewPoolConfig()
protected GenericObjectPool.Config	createPoolConfig() Deprecated. Database connection pool now uses version 2 of Apache Commons Pool, so please use createNewPoolConfig() to create GenericObjectPoolConfig instead.
void	destroy()
protected boolean	determineBlockingFromV1Property(int whenExhaustedAction)
protected Connection	doGetConnection(boolean transactionBound)
Connection	getConnection() Fetches a new connection from connection pool.
Connection	getConnection(boolean transactionBound) Fetches a new connection from connection pool.
Connection	getConnection(String username, String password)
Map<String,String>	getConnectionParameters()
JDBCConnectionPool	getConnectionPool()
String	getCustomSessionSQL()
String	getDatabaseName()
String	getDatabaseURL()
String	getDatabaseUser()
String	getDatabaseVersion()
DataSourceFactory	getDataSourceFactory()
String	getDriverVersion()
String	getID()
String	getJNDIName()
int	getLoginTimeout()
JDBCLogUtils	getLogUtils()
PrintWriter	getLogWriter()
int	getMaxAllowedPhysicalOpen()
int	getMaxInUse()
int	getMaxPhysicalOpen()
int	getMaxPreparedParameterCount()
long	getMillisWaitedForConnection()
int	getNumInUse()
int	getNumPhysicalOpen()
Logger	getParentLogger()
String	getSchemaName() Tries to get the used schema name for a given SQLserver or oracle connection.
String	getTablePrefix()
Tenant	getTenant()
static String	getUserNameFromDatabaseMetaData(DatabaseMetaData dmd, String fallback)
void	invalidate(ConnectionImpl conn)
boolean	isDBLogActive() returns the value of the project.properties property 'db.log.active', which tells if the logging into the jdbc.log is activated or not.
boolean	isDBLogAppendStackTraceActive() returns the value of the project.properties setting 'db.log.appendStackTrace', which tells if the logging of stacktraces for each statement into the jdbc.log is activated or not.
boolean	isReadOnly()
boolean	isWrapperFor(Class<?> arg0)
protected String	readSchemaName()
void	resetStats() Reset the statistics.
void	returnToPool(ConnectionImpl conn)
void	setDBLog(boolean active) set the value of the project.properties setting 'db.log.active'
void	setDBLogAppendStackTrace(boolean active) set the value of the project.properties setting 'db.log.appendStackTrace'
void	setLoginTimeout(int arg0)
void	setLogWriter(PrintWriter arg0)
String	toString()
long	totalGets()
DataAccessException	translateToDataAccessException(SQLException e) Translates the given raw SQL exception into a Spring DataAccessException exactly like it would have been done when using Spring JdbcTemplate.
<T> T	unwrap(Class<T> arg0)

Methods inherited from class java.lang.Object

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

Field Detail

OBJ_POOL_V1_WHEN_EXHAUSTED_FAIL

protected static final Integer OBJ_POOL_V1_WHEN_EXHAUSTED_FAIL

OBJ_POOL_V1_WHEN_EXHAUSTED_BLOCK

protected static final Integer OBJ_POOL_V1_WHEN_EXHAUSTED_BLOCK

OBJ_POOL_V1_WHEN_EXHAUSTED_GROW

protected static final Integer OBJ_POOL_V1_WHEN_EXHAUSTED_GROW

Constructor Detail

DataSourceImpl

public DataSourceImpl(Tenant tenant,
                      String id,
                      Map<String,String> params,
                      boolean readOnly,
                      DataSourceFactory factory)

Creates a new data source using connection parameters.

Parameters:

tenant - the owning tenant

params - the connection parameters

DataSourceImpl

public DataSourceImpl(Tenant tenant,
                      String id,
                      String jndiName,
                      boolean readOnly,
                      DataSourceFactory factory)

Creates a new data source using a existing JNDI data source.

Parameters:

tenant - the owning tenant

jndiName - the JNDI name of the actual data source

DataSourceImpl

protected DataSourceImpl(Tenant tenant,
                         String id,
                         Map<String,String> params,
                         String jndiName,
                         boolean readOnly,
                         DataSourceFactory factory)

Method Detail

getDriverVersion

public String getDriverVersion()

Specified by:

getDriverVersion in interface HybrisDataSource

Returns:

the driverVersion

determineBlockingFromV1Property

protected boolean determineBlockingFromV1Property(int whenExhaustedAction)

createPoolConfig

@Deprecated
protected GenericObjectPool.Config createPoolConfig()

Deprecated. Database connection pool now uses version 2 of Apache Commons Pool, so please use createNewPoolConfig() to create GenericObjectPoolConfig instead.

createNewPoolConfig

protected GenericObjectPoolConfig createNewPoolConfig()

getConnectionParameters

public Map<String,String> getConnectionParameters()

Specified by:

getConnectionParameters in interface HybrisDataSource

getJNDIName

public String getJNDIName()

Specified by:

getJNDIName in interface HybrisDataSource

Returns:

the JNDI name

toString

public String toString()

Overrides:

toString in class Object

getID

public String getID()

Specified by:

getID in interface HybrisDataSource

Returns:

the ID of the current data source

getConnectionPool

public JDBCConnectionPool getConnectionPool()

Specified by:

getConnectionPool in interface HybrisDataSource

getTenant

public Tenant getTenant()

Specified by:

getTenant in interface HybrisDataSource

getConnection

public Connection getConnection()
                         throws SQLException

Fetches a new connection from connection pool. If a Transaction is currently running the connection is transaction bound (the connection which BEGIN and COMMIT/ROLLBACK is called upon).

Specified by:

getConnection in interface DataSource

Throws:

SQLException

getConnection

public Connection getConnection(boolean transactionBound)
                         throws SQLException

Fetches a new connection from connection pool. If a Transaction is currently running the connection is either transaction bound (the connection which BEGIN and COMMIT/ROLLBACK is called upon) or a 'fresh' one.

Specified by:

getConnection in interface HybrisDataSource

Parameters:

transactionBound - only valid if transaction is currently running: if true connection is transaction bound, if false a 'fresh' one is returned

Throws:

SQLException

doGetConnection

protected Connection doGetConnection(boolean transactionBound)
                              throws SQLException

Throws:

SQLException

getConnection

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

Specified by:

getConnection in interface DataSource

Throws:

SQLException

returnToPool

public void returnToPool(ConnectionImpl conn)

Specified by:

returnToPool in interface HybrisDataSource

invalidate

public void invalidate(ConnectionImpl conn)

Specified by:

invalidate in interface HybrisDataSource

destroy

public void destroy()

Specified by:

destroy in interface HybrisDataSource

getNumInUse

public int getNumInUse()

Specified by:

getNumInUse in interface HybrisDataSource

Returns:

the number of instances currently borrowed from the pool.

getNumPhysicalOpen

public int getNumPhysicalOpen()

Specified by:

getNumPhysicalOpen in interface HybrisDataSource

Returns:

number of currently open JDBC connections.

getMaxInUse

public int getMaxInUse()

Specified by:

getMaxInUse in interface HybrisDataSource

Returns:

the maximum number of the 'in use' connection

getMaxPhysicalOpen

public int getMaxPhysicalOpen()

Specified by:

getMaxPhysicalOpen in interface HybrisDataSource

Returns:

the maximum number of physical SQL connections.

totalGets

public long totalGets()

Specified by:

totalGets in interface HybrisDataSource

Returns:

Total number of connections so far. Reset with HybrisDataSource.resetStats()

getMaxAllowedPhysicalOpen

public int getMaxAllowedPhysicalOpen()

Specified by:

getMaxAllowedPhysicalOpen in interface HybrisDataSource

Returns:

the maximum number of objects that can be allocated by the pool

getMillisWaitedForConnection

public long getMillisWaitedForConnection()

Specified by:

getMillisWaitedForConnection in interface HybrisDataSource

Returns:

the time in milliseconds how long it took to get a connection from the pool

resetStats

public void resetStats()

Description copied from interface: HybrisDataSource

Reset the statistics. Those are HybrisDataSource.getMillisWaitedForConnection(), HybrisDataSource.getMaxInUse() and HybrisDataSource.totalGets()

Specified by:

resetStats in interface HybrisDataSource

getLogUtils

public JDBCLogUtils getLogUtils()

Specified by:

getLogUtils in interface HybrisDataSource

getDatabaseName

public String getDatabaseName()

Specified by:

getDatabaseName in interface HybrisDataSource

Returns:

the database name

getMaxPreparedParameterCount

public int getMaxPreparedParameterCount()

Specified by:

getMaxPreparedParameterCount in interface HybrisDataSource

Returns:

the maximum allowed number of parameters within one prepared statement; -1 if no limit exists

getUserNameFromDatabaseMetaData

public static String getUserNameFromDatabaseMetaData(DatabaseMetaData dmd,
                                                     String fallback)

getDatabaseVersion

public String getDatabaseVersion()

Specified by:

getDatabaseVersion in interface HybrisDataSource

Returns:

the databaseVersion

getDatabaseURL

public String getDatabaseURL()

Specified by:

getDatabaseURL in interface HybrisDataSource

Returns:

the URL of the database

getCustomSessionSQL

public String getCustomSessionSQL()

Specified by:

getCustomSessionSQL in interface HybrisDataSource

getDatabaseUser

public String getDatabaseUser()

Specified by:

getDatabaseUser in interface HybrisDataSource

Returns:

the database user

getSchemaName

public String getSchemaName()

Tries to get the used schema name for a given SQLserver or oracle connection.

Specified by:

getSchemaName in interface HybrisDataSource

Returns:

the schema name of the database

readSchemaName

protected String readSchemaName()

cannotConnect

public boolean cannotConnect()

Specified by:

cannotConnect in interface HybrisDataSource

Returns:

true if a connection the pool is not possible.

getDataSourceFactory

public DataSourceFactory getDataSourceFactory()

Specified by:

getDataSourceFactory in interface HybrisDataSource

isDBLogActive

public boolean isDBLogActive()

returns the value of the project.properties property 'db.log.active', which tells if the logging into the jdbc.log is activated or not.

Specified by:

isDBLogActive in interface HybrisDataSource

isDBLogAppendStackTraceActive

public boolean isDBLogAppendStackTraceActive()

returns the value of the project.properties setting 'db.log.appendStackTrace', which tells if the logging of stacktraces for each statement into the jdbc.log is activated or not.

Specified by:

isDBLogAppendStackTraceActive in interface HybrisDataSource

setDBLog

public void setDBLog(boolean active)

set the value of the project.properties setting 'db.log.active'

Specified by:

setDBLog in interface HybrisDataSource

setDBLogAppendStackTrace

public void setDBLogAppendStackTrace(boolean active)

set the value of the project.properties setting 'db.log.appendStackTrace'

Specified by:

setDBLogAppendStackTrace in interface HybrisDataSource

isReadOnly

public boolean isReadOnly()

Specified by:

isReadOnly in interface HybrisDataSource

Returns:

true if the datasoure is read-only

getTablePrefix

public String getTablePrefix()

Specified by:

getTablePrefix in interface HybrisDataSource

Returns:

the table prefix for all tables

getLogWriter

public PrintWriter getLogWriter()
                         throws SQLException

Specified by:

getLogWriter in interface CommonDataSource

Throws:

SQLException

setLogWriter

public void setLogWriter(PrintWriter arg0)
                  throws SQLException

Specified by:

setLogWriter in interface CommonDataSource

Throws:

SQLException

getLoginTimeout

public int getLoginTimeout()
                    throws SQLException

Specified by:

getLoginTimeout in interface CommonDataSource

Throws:

SQLException

setLoginTimeout

public void setLoginTimeout(int arg0)
                     throws SQLException

Specified by:

setLoginTimeout in interface CommonDataSource

Throws:

SQLException

isWrapperFor

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

Specified by:

isWrapperFor in interface Wrapper

Throws:

SQLException

unwrap

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

Specified by:

unwrap in interface Wrapper

Throws:

SQLException

getParentLogger

public Logger getParentLogger()
                       throws SQLFeatureNotSupportedException

Specified by:

getParentLogger in interface CommonDataSource

Throws:

SQLFeatureNotSupportedException

Since:

jdk 1.7

translateToDataAccessException

public DataAccessException translateToDataAccessException(SQLException e)

Description copied from interface: HybrisDataSource

Translates the given raw SQL exception into a Spring DataAccessException exactly like it would have been done when using Spring JdbcTemplate.

Specified by:

translateToDataAccessException in interface HybrisDataSource