Package org.apache.commons.dbcp2.datasources

Class InstanceKeyDataSourceFactory

java.lang.Object

org.apache.commons.dbcp2.datasources.InstanceKeyDataSourceFactory

All Implemented Interfaces:

ObjectFactory

Direct Known Subclasses:

PerUserPoolDataSourceFactory, SharedPoolDataSourceFactory

abstract class InstanceKeyDataSourceFactory
extends Object
implements ObjectFactory

A JNDI ObjectFactory which creates SharedPoolDataSources or PerUserPoolDataSources

Since:

2.0

Field Summary

Fields

Modifier and Type	Field	Description
private static final Map<String,InstanceKeyDataSource>	INSTANCE_MAP

Constructor Summary

Constructors

Constructor	Description
InstanceKeyDataSourceFactory()

Method Summary

Modifier and Type	Method	Description
static void	closeAll()	Closes all pools associated with this class.
protected static final Object	deserialize(byte[] data)	Deserializes the provided byte array to create an object.
protected abstract InstanceKeyDataSource	getNewInstance(Reference ref)	Creates an instance of the subclass and sets any properties contained in the Reference.
Object	getObjectInstance(Object refObj, Name name, Context context, Hashtable<?,?> env)	Implements ObjectFactory to create an instance of SharedPoolDataSource or PerUserPoolDataSource
protected abstract boolean	isCorrectClass(String className)	Tests if className is the value returned from getClass().getName().toString().
(package private) boolean	parseBoolean(RefAddr refAddr)
(package private) int	parseInt(RefAddr refAddr)
(package private) long	parseLong(RefAddr refAddr)
(package private) static String	registerNewInstance(InstanceKeyDataSource ds)
(package private) static void	removeInstance(String key)
private void	setCommonProperties(Reference ref, InstanceKeyDataSource ikds)
(package private) String	toString(RefAddr refAddr)

Methods inherited from class java.lang.Object

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

Field Details

INSTANCE_MAP

private static final Map<String,InstanceKeyDataSource> INSTANCE_MAP

Constructor Details

InstanceKeyDataSourceFactory

InstanceKeyDataSourceFactory()

Method Details

closeAll

public static void closeAll()
                     throws ListException

Closes all pools associated with this class.

Throws:

ListException - a ListException containing all exceptions thrown by InstanceKeyDataSource.close()

Since:

2.4.0 throws a ListException instead of, in 2.3.0 and before, the first exception thrown by InstanceKeyDataSource.close().

See Also:

• InstanceKeyDataSource.close()

deserialize

protected static final Object deserialize(byte[] data)
                                   throws IOException,
ClassNotFoundException

Deserializes the provided byte array to create an object.

Parameters:

data - Data to deserialize to create the configuration parameter.

Returns:

The Object created by deserializing the data.

Throws:

ClassNotFoundException - If a class cannot be found during the deserialization of a configuration parameter.

IOException - If an I/O error occurs during the deserialization of a configuration parameter.

registerNewInstance

static String registerNewInstance(InstanceKeyDataSource ds)

removeInstance

static void removeInstance(String key)

getNewInstance

protected abstract InstanceKeyDataSource getNewInstance(Reference ref)
                                                 throws IOException,
ClassNotFoundException

Creates an instance of the subclass and sets any properties contained in the Reference.

Parameters:

ref - The properties to be set on the created DataSource

Returns:

A configured DataSource of the appropriate type.

Throws:

ClassNotFoundException - If a class cannot be found during the deserialization of a configuration parameter.

IOException - If an I/O error occurs during the deserialization of a configuration parameter.

getObjectInstance

public Object getObjectInstance(Object refObj,
 Name name,
 Context context,
 Hashtable<?,?> env)
                         throws IOException,
ClassNotFoundException

Implements ObjectFactory to create an instance of SharedPoolDataSource or PerUserPoolDataSource

Specified by:

getObjectInstance in interface ObjectFactory

Throws:

IOException

ClassNotFoundException

isCorrectClass

protected abstract boolean isCorrectClass(String className)

Tests if className is the value returned from getClass().getName().toString().

Parameters:

className - The class name to test.

Returns:

true if and only if className is the value returned from getClass().getName().toString()

parseBoolean

boolean parseBoolean(RefAddr refAddr)

parseInt

int parseInt(RefAddr refAddr)

parseLong

long parseLong(RefAddr refAddr)

setCommonProperties

private void setCommonProperties(Reference ref,
 InstanceKeyDataSource ikds)
                          throws IOException,
ClassNotFoundException

Throws:

IOException

ClassNotFoundException

toString

String toString(RefAddr refAddr)