org.vibur.dbcp.pool

Class ConnectionFactory

java.lang.Object

org.vibur.dbcp.pool.ConnectionFactory

All Implemented Interfaces:

ViburObjectFactory, org.vibur.objectpool.PoolObjectFactory<ConnHolder>

public class ConnectionFactory
extends Object
implements ViburObjectFactory

The object factory which controls the lifecycle of the underlying JDBC Connections: creates them, validates them if needed, and destroys them. Used by ViburDBCPDataSource.

This ConnectionFactory is a versioned factory which creates versioned JDBC Connection wrappers ConnHolder(s). The version of each ConnHolder created by the factory is the same as the version of the factory at the moment of the object creation.

Author:

Simeon Malchev, Daniel Caldeweyher

See Also:

Hook, DefaultHook

Constructor Summary

Constructors

Constructor and Description
ConnectionFactory(ViburConfig config) Instantiates this object factory.

Method Summary

Modifier and Type	Method and Description
boolean	compareAndSetVersion(int expect, int update) Atomically sets the version value to the given updated value if the current value == the expected value.
ConnHolder	create()
ConnHolder	create(Connector connector) Creates a new ConnHolder object using the given connector.
void	destroy(ConnHolder connHolder)
boolean	readyToRestore(ConnHolder connHolder)
boolean	readyToTake(ConnHolder connHolder)
int	version() Gets the current version value.

Methods inherited from class java.lang.Object

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

Constructor Detail

ConnectionFactory

public ConnectionFactory(ViburConfig config)
                  throws ViburDBCPException

Instantiates this object factory.

Parameters:

config - the ViburConfig from which will initialize

Throws:

ViburDBCPException - if cannot successfully initialize/configure the underlying SQL system

Method Detail

create

public ConnHolder create()
                  throws ViburDBCPException

Description copied from interface: ViburObjectFactory

Specified by:

create in interface ViburObjectFactory

Specified by:

create in interface org.vibur.objectpool.PoolObjectFactory<ConnHolder>

Throws:

ViburDBCPException - if cannot create or initialize the raw JDBC Connection

create

public ConnHolder create(Connector connector)
                  throws ViburDBCPException

Description copied from interface: ViburObjectFactory

Creates a new ConnHolder object using the given connector. This object is presumed to be ready (and valid) for immediate use. This method never return null.

Specified by:

create in interface ViburObjectFactory

Parameters:

connector - the JDBC connector; it contains the database credentials

Throws:

ViburDBCPException - if cannot create or initialize the raw JDBC Connection

readyToTake

public boolean readyToTake(ConnHolder connHolder)

Specified by:

readyToTake in interface org.vibur.objectpool.PoolObjectFactory<ConnHolder>

readyToRestore

public boolean readyToRestore(ConnHolder connHolder)

Specified by:

readyToRestore in interface org.vibur.objectpool.PoolObjectFactory<ConnHolder>

destroy

public void destroy(ConnHolder connHolder)

Specified by:

destroy in interface org.vibur.objectpool.PoolObjectFactory<ConnHolder>

version

public int version()

Description copied from interface: ViburObjectFactory

Gets the current version value.

Specified by:

version in interface ViburObjectFactory

Returns:

the current version value

compareAndSetVersion

public boolean compareAndSetVersion(int expect,
                                    int update)

Description copied from interface: ViburObjectFactory

Atomically sets the version value to the given updated value if the current value == the expected value.

Specified by:

compareAndSetVersion in interface ViburObjectFactory

Parameters:

expect - the expected version value

update - the new version value

Returns:

true if successful. False return indicates that the actual value was not equal to the expected value.