com.franz.agraph.pool

Class AGConnPool

java.lang.Object

com.franz.util.Closer

com.franz.agraph.pool.AGConnPool

All Implemented Interfaces:

AutoCloseable, org.apache.commons.pool.ObjectPool

public class AGConnPool
extends Closer
implements org.apache.commons.pool.ObjectPool, AutoCloseable

Pooling for AGRepositoryConnections. The recommended way to create a pool is by create(Object...) or by configuring a AGConnPoolJndiFactory with your appserver.

 	AGConnPool pool = AGConnPool.create(
 		AGConnProp.serverUrl, "http://localhost:10035",
 		AGConnProp.username, "test",
 		AGConnProp.password, "xyzzy",
 		AGConnProp.catalog, "/",
 		AGConnProp.repository, "my_repo",
 		AGConnProp.session, AGConnProp.Session.DEDICATED,
 		AGPoolProp.shutdownHook, true,
 		AGPoolProp.maxActive, 10,
 		AGPoolProp.initialSize, 2);
 	AGRepositoryConnection conn = pool.borrowConnection();
 	try {
 		...
 		conn.commit();
 	} finally {
 		conn.close();
 		// or equivalently
 		pool.returnObject(conn);
 	}
 

This pool delegates the pooling implementation to another pool (a GenericObjectPool). When Connections are borrowed, they are wrapped so that AutoCloseable.close() will call returnObject(Object) instead of actually closing.

Closing the connection pool is important because server sessions will stay active until AGConnProp.sessionLifetime. The option to use a Runtime shutdownHook is built-in with AGPoolProp.shutdownHook. Another option is to use ServletContextListener - this is appropriate if the agraph jar is deployed within your webapp and not with the webserver. With tomcat, a Lifecycle Listener can be configured, but the implementation to do this is not included in this library.

Note, when close() is called on a AGConnPool, connections will be closed whether they are idle (have been returned) or not. This is different from GenericObjectPool.close().

Since:

v4.3.3

Method Summary

Modifier and Type	Method and Description
void	addObject()
AGRepositoryConnection	borrowConnection()
Object	borrowObject()
void	clear()
void	close() Closes all resources registered with Closer.closeLater(AutoCloseable).
static AGConnPool	create(AGConnFactory factory, AGPoolConfig poolConfig) A GenericObjectPool is used.
static AGConnPool	create(Map<AGConnProp,String> connProps, Map<AGPoolProp,String> poolProps) Create a pool from configuration properties.
static AGConnPool	create(Object... keyValuePairs) Create a pool from configuration properties.
void	ensureIdle(int n)
int	getNumActive()
int	getNumIdle()
void	invalidateObject(Object obj)
void	returnObject(Object obj)
void	setFactory(org.apache.commons.pool.PoolableObjectFactory obj) Deprecated.
String	toString()
static Object	unwrap(Object obj)

Methods inherited from class com.franz.util.Closer

close, close, closeLater, remove

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Method Detail

create

public static AGConnPool create(AGConnFactory factory,
                                AGPoolConfig poolConfig)

A GenericObjectPool is used.

Parameters:

factory - an AGConnFactory

poolConfig - an AGPoolConfig

Returns:

AGConnPool the connection pool object

create

public static AGConnPool create(Map<AGConnProp,String> connProps,
                                Map<AGPoolProp,String> poolProps)
                         throws RepositoryException

Create a pool from configuration properties.

Parameters:

connProps - keys are AGConnProp

poolProps - keys are AGPoolProp

Returns:

AGConnPool the connection pool object

Throws:

RepositoryException - if an error occurs during pool creation

create

public static AGConnPool create(Object... keyValuePairs)
                         throws RepositoryException

Create a pool from configuration properties.

Parameters:

keyValuePairs - alternating key/value pairs where keys are AGConnProp and AGPoolProp

Returns:

AGConnPool the connection pool object

Throws:

RepositoryException - if an error occurs during pool creation

addObject

public void addObject()
               throws Exception,
                      IllegalStateException,
                      UnsupportedOperationException

Specified by:

addObject in interface org.apache.commons.pool.ObjectPool

Throws:

Exception

IllegalStateException

UnsupportedOperationException

borrowObject

public Object borrowObject()
                    throws Exception,
                           NoSuchElementException,
                           IllegalStateException

Specified by:

borrowObject in interface org.apache.commons.pool.ObjectPool

Throws:

Exception

NoSuchElementException

IllegalStateException

borrowConnection

public AGRepositoryConnection borrowConnection()
                                        throws RepositoryException

Throws:

RepositoryException

clear

public void clear()
           throws Exception,
                  UnsupportedOperationException

Specified by:

clear in interface org.apache.commons.pool.ObjectPool

Throws:

Exception

UnsupportedOperationException

getNumActive

public int getNumActive()
                 throws UnsupportedOperationException

Specified by:

getNumActive in interface org.apache.commons.pool.ObjectPool

Throws:

UnsupportedOperationException

getNumIdle

public int getNumIdle()
               throws UnsupportedOperationException

Specified by:

getNumIdle in interface org.apache.commons.pool.ObjectPool

Throws:

UnsupportedOperationException

invalidateObject

public void invalidateObject(Object obj)
                      throws Exception

Specified by:

invalidateObject in interface org.apache.commons.pool.ObjectPool

Throws:

Exception

returnObject

public void returnObject(Object obj)
                  throws Exception

Specified by:

returnObject in interface org.apache.commons.pool.ObjectPool

Throws:

Exception

unwrap

public static Object unwrap(Object obj)

setFactory

@Deprecated
public void setFactory(org.apache.commons.pool.PoolableObjectFactory obj)
                            throws IllegalStateException,
                                   UnsupportedOperationException

Deprecated.

Specified by:

setFactory in interface org.apache.commons.pool.ObjectPool

Throws:

IllegalStateException

UnsupportedOperationException

ensureIdle

public void ensureIdle(int n)
                throws Exception

Throws:

Exception

close

public void close()

Description copied from class: Closer

Closes all resources registered with Closer.closeLater(AutoCloseable).

Specified by:

close in interface AutoCloseable

Specified by:

close in interface org.apache.commons.pool.ObjectPool

Overrides:

close in class Closer

toString

public String toString()

Overrides:

toString in class Closer