Tomcat 10.1.19 · org.apache.tomcat.jdbc.pool.DataSourceFactory

JNDI object factory that creates an instance of BasicDataSource that has been configured based on the RefAddr values of the specified Reference, which must match the names and data types of the BasicDataSource bean properties.

Properties available for configuration:
Commons DBCP properties

initSQL - A query that gets executed once, right after the connection is established.
testOnConnect - run validationQuery after connection has been established.
validationInterval - avoid excess validation, only run validation at most at this frequency - time in milliseconds.
jdbcInterceptors - a semicolon separated list of classnames extending JdbcInterceptor class.
jmxEnabled - true of false, whether to register the pool with JMX.
fairQueue - true of false, whether the pool should sacrifice a little bit of performance for true fairness.

Field Summary

Modifier and Type	Field and Description
protected static final String[]	ALL_PROPERTIES
private static final Log	log
public static final String	OBJECT_NAME
protected static final String	PROP_ABANDONWHENPERCENTAGEFULL
protected static final String	PROP_ACCESSTOUNDERLYINGCONNECTIONALLOWED
protected static final String	PROP_ALTERNATE_USERNAME_ALLOWED
protected static final String	PROP_COMMITONRETURN
protected static final String	PROP_CONNECTIONPROPERTIES
protected static final String	PROP_DATASOURCE
protected static final String	PROP_DATASOURCE_JNDI
protected static final String	PROP_DEFAULTAUTOCOMMIT
protected static final String	PROP_DEFAULTCATALOG
protected static final String	PROP_DEFAULTREADONLY
protected static final String	PROP_DEFAULTTRANSACTIONISOLATION
protected static final String	PROP_DRIVERCLASSNAME
protected static final String	PROP_FAIR_QUEUE
protected static final String	PROP_IGNOREEXCEPTIONONPRELOAD
protected static final String	PROP_INITIALSIZE
protected static final String	PROP_INITSQL
protected static final String	PROP_INTERCEPTORS
protected static final String	PROP_JMX_ENABLED
protected static final String	PROP_LOGABANDONED
protected static final String	PROP_LOGVALIDATIONERRORS
protected static final String	PROP_MAXACTIVE
protected static final String	PROP_MAXAGE
protected static final String	PROP_MAXIDLE
protected static final String	PROP_MAXOPENPREPAREDSTATEMENTS
protected static final String	PROP_MAXWAIT
protected static final String	PROP_MINEVICTABLEIDLETIMEMILLIS
protected static final String	PROP_MINIDLE
protected static final String	PROP_NUMTESTSPEREVICTIONRUN
protected static final String	PROP_PASSWORD
protected static final String	PROP_POOLPREPAREDSTATEMENTS
protected static final String	PROP_PROPAGATEINTERRUPTSTATE
protected static final String	PROP_REMOVEABANDONED
protected static final String	PROP_REMOVEABANDONEDTIMEOUT
protected static final String	PROP_ROLLBACKONRETURN
protected static final String	PROP_SUSPECT_TIMEOUT
protected static final String	PROP_TESTONBORROW
protected static final String	PROP_TESTONCONNECT
protected static final String	PROP_TESTONRETURN
protected static final String	PROP_TESTWHILEIDLE
protected static final String	PROP_TIMEBETWEENEVICTIONRUNSMILLIS
protected static final String	PROP_URL
protected static final String	PROP_USE_CON_LOCK
protected static final String	PROP_USE_EQUALS
protected static final String	PROP_USEDISPOSABLECONNECTIONFACADE
protected static final String	PROP_USERNAME
protected static final String	PROP_USESTATEMENTFACADE
protected static final String	PROP_VALIDATIONINTERVAL
protected static final String	PROP_VALIDATIONQUERY
protected static final String	PROP_VALIDATIONQUERY_TIMEOUT
protected static final String	PROP_VALIDATOR_CLASS_NAME
public static final int	UNKNOWN_TRANSACTIONISOLATION

Constructor Summary

Access	Constructor and Description
public	DataSourceFactory()

Method Summary

Modifier and Type	Method and Description
public DataSource	Returns: the datasource createDataSource(Properties the datasource configuration properties properties) Creates and configures a `DataSource` instance based on the given properties.
public DataSource	createDataSource(Properties properties, Context context, boolean XA)
public Object	getObjectInstance(Object The possibly null object containing location or reference information that can be used in creating an object obj, Name The name of this object relative to `nameCtx` name, Context The context relative to which the `name` parameter is specified, or `null` if `name` is relative to the default initial context nameCtx, Hashtable<?, ?> The possibly null environment that is used in creating this object environment) Implements javax.naming.spi.ObjectFactory.getObjectInstance. Create and return a new `BasicDataSource` instance.
protected static Properties	Returns: the properties getProperties(String The properties string propText) Parse properties from the string.
public static PoolConfiguration	parsePoolProperties(Properties properties)
public void	performJNDILookup(Context context, PoolConfiguration poolProperties)

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Field Detail

ALL_PROPERTIES	back to summary
protected static final String[] ALL_PROPERTIES

log	back to summary
private static final Log log

OBJECT_NAME	back to summary
public static final String OBJECT_NAME

PROP_ABANDONWHENPERCENTAGEFULL	back to summary
protected static final String PROP_ABANDONWHENPERCENTAGEFULL

PROP_ACCESSTOUNDERLYINGCONNECTIONALLOWED	back to summary
protected static final String PROP_ACCESSTOUNDERLYINGCONNECTIONALLOWED

PROP_ALTERNATE_USERNAME_ALLOWED	back to summary
protected static final String PROP_ALTERNATE_USERNAME_ALLOWED

PROP_COMMITONRETURN	back to summary
protected static final String PROP_COMMITONRETURN

PROP_CONNECTIONPROPERTIES	back to summary
protected static final String PROP_CONNECTIONPROPERTIES

PROP_DATASOURCE	back to summary
protected static final String PROP_DATASOURCE

PROP_DATASOURCE_JNDI	back to summary
protected static final String PROP_DATASOURCE_JNDI

PROP_DEFAULTAUTOCOMMIT	back to summary
protected static final String PROP_DEFAULTAUTOCOMMIT

PROP_DEFAULTCATALOG	back to summary
protected static final String PROP_DEFAULTCATALOG

PROP_DEFAULTREADONLY	back to summary
protected static final String PROP_DEFAULTREADONLY

PROP_DEFAULTTRANSACTIONISOLATION	back to summary
protected static final String PROP_DEFAULTTRANSACTIONISOLATION

PROP_DRIVERCLASSNAME	back to summary
protected static final String PROP_DRIVERCLASSNAME

PROP_FAIR_QUEUE	back to summary
protected static final String PROP_FAIR_QUEUE

PROP_IGNOREEXCEPTIONONPRELOAD	back to summary
protected static final String PROP_IGNOREEXCEPTIONONPRELOAD

PROP_INITIALSIZE	back to summary
protected static final String PROP_INITIALSIZE

PROP_INITSQL	back to summary
protected static final String PROP_INITSQL

PROP_INTERCEPTORS	back to summary
protected static final String PROP_INTERCEPTORS

PROP_JMX_ENABLED	back to summary
protected static final String PROP_JMX_ENABLED

PROP_LOGABANDONED	back to summary
protected static final String PROP_LOGABANDONED

PROP_LOGVALIDATIONERRORS	back to summary
protected static final String PROP_LOGVALIDATIONERRORS

PROP_MAXACTIVE	back to summary
protected static final String PROP_MAXACTIVE

PROP_MAXAGE	back to summary
protected static final String PROP_MAXAGE

PROP_MAXIDLE	back to summary
protected static final String PROP_MAXIDLE

PROP_MAXOPENPREPAREDSTATEMENTS	back to summary
protected static final String PROP_MAXOPENPREPAREDSTATEMENTS

PROP_MAXWAIT	back to summary
protected static final String PROP_MAXWAIT

PROP_MINEVICTABLEIDLETIMEMILLIS	back to summary
protected static final String PROP_MINEVICTABLEIDLETIMEMILLIS

PROP_MINIDLE	back to summary
protected static final String PROP_MINIDLE

PROP_NUMTESTSPEREVICTIONRUN	back to summary
protected static final String PROP_NUMTESTSPEREVICTIONRUN

PROP_PASSWORD	back to summary
protected static final String PROP_PASSWORD

PROP_POOLPREPAREDSTATEMENTS	back to summary
protected static final String PROP_POOLPREPAREDSTATEMENTS

PROP_PROPAGATEINTERRUPTSTATE	back to summary
protected static final String PROP_PROPAGATEINTERRUPTSTATE

PROP_REMOVEABANDONED	back to summary
protected static final String PROP_REMOVEABANDONED

PROP_REMOVEABANDONEDTIMEOUT	back to summary
protected static final String PROP_REMOVEABANDONEDTIMEOUT

PROP_ROLLBACKONRETURN	back to summary
protected static final String PROP_ROLLBACKONRETURN

PROP_SUSPECT_TIMEOUT	back to summary
protected static final String PROP_SUSPECT_TIMEOUT

PROP_TESTONBORROW	back to summary
protected static final String PROP_TESTONBORROW

PROP_TESTONCONNECT	back to summary
protected static final String PROP_TESTONCONNECT

PROP_TESTONRETURN	back to summary
protected static final String PROP_TESTONRETURN

PROP_TESTWHILEIDLE	back to summary
protected static final String PROP_TESTWHILEIDLE

PROP_TIMEBETWEENEVICTIONRUNSMILLIS	back to summary
protected static final String PROP_TIMEBETWEENEVICTIONRUNSMILLIS

PROP_URL	back to summary
protected static final String PROP_URL

PROP_USE_CON_LOCK	back to summary
protected static final String PROP_USE_CON_LOCK

PROP_USE_EQUALS	back to summary
protected static final String PROP_USE_EQUALS

PROP_USEDISPOSABLECONNECTIONFACADE	back to summary
protected static final String PROP_USEDISPOSABLECONNECTIONFACADE

PROP_USERNAME	back to summary
protected static final String PROP_USERNAME

PROP_USESTATEMENTFACADE	back to summary
protected static final String PROP_USESTATEMENTFACADE

PROP_VALIDATIONINTERVAL	back to summary
protected static final String PROP_VALIDATIONINTERVAL

PROP_VALIDATIONQUERY	back to summary
protected static final String PROP_VALIDATIONQUERY

PROP_VALIDATIONQUERY_TIMEOUT	back to summary
protected static final String PROP_VALIDATIONQUERY_TIMEOUT

PROP_VALIDATOR_CLASS_NAME	back to summary
protected static final String PROP_VALIDATOR_CLASS_NAME

UNKNOWN_TRANSACTIONISOLATION	back to summary
public static final int UNKNOWN_TRANSACTIONISOLATION

Constructor Detail

DataSourceFactory	back to summary
public DataSourceFactory()

Method Detail

createDataSource back to summary

public DataSource createDataSource(Properties properties) throws Exception

Creates and configures a DataSource instance based on the given properties.

Parameters

properties:Properties: the datasource configuration properties

Returns:DataSource

the datasource

Exceptions

Exception:: if an error occurs creating the data source

createDataSource	back to summary
public DataSource createDataSource(Properties properties, Context context, boolean XA) throws Exception

getObjectInstance back to summary

public Object getObjectInstance(Object obj, Name name, Context nameCtx, Hashtable<?, ?> environment) throws Exception

Implements javax.naming.spi.ObjectFactory.getObjectInstance.

Create and return a new BasicDataSource instance. If no instance can be created, return null instead.

Parameters

obj:Object: The possibly null object containing location or reference information that can be used in creating an object
name:Name: The name of this object relative to nameCtx
nameCtx:Context: The context relative to which the name parameter is specified, or null if name is relative to the default initial context
environment:Hashtable<?, ?>: The possibly null environment that is used in creating this object

Returns:Object