org.apache.commons.dbcp
Class ManagedBasicDataSourceFactory

java.lang.Object
  org.apache.commons.dbcp.BasicDataSourceFactory
      org.apache.commons.dbcp.ManagedBasicDataSourceFactory

All Implemented Interfaces:

ObjectFactory

public class ManagedBasicDataSourceFactory
extends org.apache.commons.dbcp.BasicDataSourceFactory

Factory for ManagedBasicDataSource.

This is almost a copy/paste of BasicDataSourceFactory, since most of the required fields in BasicDataSourceFactory are private. It only adds the PROP_MBEANNAME property to the datasource configuration properties set.

Since:

0.1

Author:

Julien Nicoulaud

See Also:

ManagedBasicDataSource, BasicDataSourceFactory

Field Summary

static String[]	ALL_PROPERTIES TODO Add Javadoc comment.
static String	PROP_ACCESSTOUNDERLYINGCONNECTIONALLOWED TODO Add Javadoc comment.
static String	PROP_CONNECTIONPROPERTIES TODO Add Javadoc comment.
static String	PROP_DEFAULTAUTOCOMMIT TODO Add Javadoc comment.
static String	PROP_DEFAULTCATALOG TODO Add Javadoc comment.
static String	PROP_DEFAULTREADONLY TODO Add Javadoc comment.
static String	PROP_DEFAULTTRANSACTIONISOLATION TODO Add Javadoc comment.
static String	PROP_DRIVERCLASSNAME TODO Add Javadoc comment.
static String	PROP_INITCONNECTIONSQLS TODO Add Javadoc comment.
static String	PROP_INITIALSIZE TODO Add Javadoc comment.
static String	PROP_LOGABANDONED TODO Add Javadoc comment.
static String	PROP_MAXACTIVE TODO Add Javadoc comment.
static String	PROP_MAXIDLE TODO Add Javadoc comment.
static String	PROP_MAXOPENPREPAREDSTATEMENTS TODO Add Javadoc comment.
static String	PROP_MAXWAIT TODO Add Javadoc comment.
static String	PROP_MBEANNAME The key for the property where one can specify the name of the ManagedBasicDataSource Mbean.
static String	PROP_MINEVICTABLEIDLETIMEMILLIS TODO Add Javadoc comment.
static String	PROP_MINIDLE TODO Add Javadoc comment.
static String	PROP_NUMTESTSPEREVICTIONRUN TODO Add Javadoc comment.
static String	PROP_PASSWORD TODO Add Javadoc comment.
static String	PROP_POOLPREPAREDSTATEMENTS TODO Add Javadoc comment.
static String	PROP_REMOVEABANDONED TODO Add Javadoc comment.
static String	PROP_REMOVEABANDONEDTIMEOUT TODO Add Javadoc comment.
static String	PROP_TESTONBORROW TODO Add Javadoc comment.
static String	PROP_TESTONRETURN TODO Add Javadoc comment.
static String	PROP_TESTWHILEIDLE TODO Add Javadoc comment.
static String	PROP_TIMEBETWEENEVICTIONRUNSMILLIS TODO Add Javadoc comment.
static String	PROP_URL TODO Add Javadoc comment.
static String	PROP_USERNAME TODO Add Javadoc comment.
static String	PROP_VALIDATIONQUERY TODO Add Javadoc comment.
static String	PROP_VALIDATIONQUERY_TIMEOUT TODO Add Javadoc comment.

Constructor Summary

ManagedBasicDataSourceFactory()

Method Summary

static DataSource	createDataSource(Properties properties) Create and configures a ManagedBasicDataSource instance based on the given properties.
Object	getObjectInstance(Object obj, Name name, Context nameCtx, Hashtable environment) Create and return a new ManagedBasicDataSource instance.

Methods inherited from class java.lang.Object

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

Field Detail

PROP_DEFAULTAUTOCOMMIT

public static final String PROP_DEFAULTAUTOCOMMIT

TODO Add Javadoc comment.

See Also:

Constant Field Values

PROP_DEFAULTREADONLY

public static final String PROP_DEFAULTREADONLY

TODO Add Javadoc comment.

See Also:

Constant Field Values

PROP_DEFAULTTRANSACTIONISOLATION

public static final String PROP_DEFAULTTRANSACTIONISOLATION

TODO Add Javadoc comment.

See Also:

Constant Field Values

PROP_DEFAULTCATALOG

public static final String PROP_DEFAULTCATALOG

TODO Add Javadoc comment.

See Also:

Constant Field Values

PROP_DRIVERCLASSNAME

public static final String PROP_DRIVERCLASSNAME

TODO Add Javadoc comment.

See Also:

Constant Field Values

PROP_MAXACTIVE

public static final String PROP_MAXACTIVE

TODO Add Javadoc comment.

See Also:

Constant Field Values

PROP_MAXIDLE

public static final String PROP_MAXIDLE

TODO Add Javadoc comment.

See Also:

Constant Field Values

PROP_MINIDLE

public static final String PROP_MINIDLE

TODO Add Javadoc comment.

See Also:

Constant Field Values

PROP_INITIALSIZE

public static final String PROP_INITIALSIZE

TODO Add Javadoc comment.

See Also:

Constant Field Values

PROP_MAXWAIT

public static final String PROP_MAXWAIT

TODO Add Javadoc comment.

See Also:

Constant Field Values

PROP_TESTONBORROW

public static final String PROP_TESTONBORROW

TODO Add Javadoc comment.

See Also:

Constant Field Values

PROP_TESTONRETURN

public static final String PROP_TESTONRETURN

TODO Add Javadoc comment.

See Also:

Constant Field Values

PROP_TIMEBETWEENEVICTIONRUNSMILLIS

public static final String PROP_TIMEBETWEENEVICTIONRUNSMILLIS

TODO Add Javadoc comment.

See Also:

Constant Field Values

PROP_NUMTESTSPEREVICTIONRUN

public static final String PROP_NUMTESTSPEREVICTIONRUN

TODO Add Javadoc comment.

See Also:

Constant Field Values

PROP_MINEVICTABLEIDLETIMEMILLIS

public static final String PROP_MINEVICTABLEIDLETIMEMILLIS

TODO Add Javadoc comment.

See Also:

Constant Field Values

PROP_TESTWHILEIDLE

public static final String PROP_TESTWHILEIDLE

TODO Add Javadoc comment.

See Also:

Constant Field Values

PROP_PASSWORD

public static final String PROP_PASSWORD

TODO Add Javadoc comment.

See Also:

Constant Field Values

PROP_URL

public static final String PROP_URL

TODO Add Javadoc comment.

See Also:

Constant Field Values

PROP_USERNAME

public static final String PROP_USERNAME

TODO Add Javadoc comment.

See Also:

Constant Field Values

PROP_VALIDATIONQUERY

public static final String PROP_VALIDATIONQUERY

TODO Add Javadoc comment.

See Also:

Constant Field Values

PROP_VALIDATIONQUERY_TIMEOUT

public static final String PROP_VALIDATIONQUERY_TIMEOUT

TODO Add Javadoc comment.

See Also:

Constant Field Values

PROP_INITCONNECTIONSQLS

public static final String PROP_INITCONNECTIONSQLS

TODO Add Javadoc comment.

See Also:

Constant Field Values

PROP_ACCESSTOUNDERLYINGCONNECTIONALLOWED

public static final String PROP_ACCESSTOUNDERLYINGCONNECTIONALLOWED

TODO Add Javadoc comment.

See Also:

Constant Field Values

PROP_REMOVEABANDONED

public static final String PROP_REMOVEABANDONED

TODO Add Javadoc comment.

See Also:

Constant Field Values

PROP_REMOVEABANDONEDTIMEOUT

public static final String PROP_REMOVEABANDONEDTIMEOUT

TODO Add Javadoc comment.

See Also:

Constant Field Values

PROP_LOGABANDONED

public static final String PROP_LOGABANDONED

TODO Add Javadoc comment.

See Also:

Constant Field Values

PROP_POOLPREPAREDSTATEMENTS

public static final String PROP_POOLPREPAREDSTATEMENTS

TODO Add Javadoc comment.

See Also:

Constant Field Values

PROP_MAXOPENPREPAREDSTATEMENTS

public static final String PROP_MAXOPENPREPAREDSTATEMENTS

TODO Add Javadoc comment.

See Also:

Constant Field Values

PROP_CONNECTIONPROPERTIES

public static final String PROP_CONNECTIONPROPERTIES

TODO Add Javadoc comment.

See Also:

Constant Field Values

PROP_MBEANNAME

public static final String PROP_MBEANNAME

The key for the property where one can specify the name of the ManagedBasicDataSource Mbean.

See Also:

ManagedBasicDataSource.DEFAULT_MBEAN_NAME, Constant Field Values

ALL_PROPERTIES

public static final String[] ALL_PROPERTIES

TODO Add Javadoc comment.

Constructor Detail

ManagedBasicDataSourceFactory

public ManagedBasicDataSourceFactory()

Method Detail

getObjectInstance

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

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

Specified by:

getObjectInstance in interface ObjectFactory

Overrides:

getObjectInstance in class org.apache.commons.dbcp.BasicDataSourceFactory

Parameters:

obj - The possibly null object containing location or reference information that can be used in creating an object.

name - The name of this object relative to nameCtx.

nameCtx - The context relative to which the name parameter is specified, or null if name is relative to the default initial context.

environment - The possibly null environment that is used in creating this object.

Throws:

Exception - if an exception occurs creating the instance.

createDataSource

public static DataSource createDataSource(Properties properties)
                                   throws Exception

Create and configures a ManagedBasicDataSource instance based on the given properties.

Parameters:

properties - the datasource configuration properties.

Throws:

Exception - if an error occurs creating the data source.