Franz Inc, AllegroGraph

com.franz.agraph.pool
Enum AGPoolProp

java.lang.Object
  extended by java.lang.Enum<AGPoolProp>
      extended by com.franz.agraph.pool.AGPoolProp
All Implemented Interfaces:
Serializable, Comparable<AGPoolProp>

public enum AGPoolProp
extends Enum<AGPoolProp>

Property names for AGPoolConfig. Property names to open a AGRepositoryConnection.

TODO: AGRepositoryConnection.setSessionLoadInitFile(boolean)

TODO: AGRepositoryConnection.addSessionLoadScript(String)

Many of these properties are specified and used by GenericObjectPool.

See Also:
GenericObjectPool, GenericKeyedObjectPool.Config

Enum Constant Summary
initialSize
          When the pool is created, this many connections will be initialized, then returned to the pool.
maxActive
          Max number of connections that can be allocated by the pool.
maxIdle
           
maxWait
          milliseconds to wait to borrow before throwing NoSuchElementException
minEvictableIdleTimeMillis
           
minIdle
           
numTestsPerEvictionRun
           
shutdownHook
          When the pool is created, if this is true (default is false), a hook will be registered to close the pool.
softMinEvictableIdleTimeMillis
           
testOnBorrow
          Calls AGRepositoryConnection.size(org.openrdf.model.Resource...).
testOnReturn
          Calls AGRepositoryConnection.size(org.openrdf.model.Resource...).
testWhileIdle
           
timeBetweenEvictionRunsMillis
           
 
Method Summary
static AGPoolProp valueOf(String name)
          Returns the enum constant of this type with the specified name.
static AGPoolProp[] values()
          Returns an array containing the constants of this enum type, in the order they are declared.
 
Methods inherited from class java.lang.Enum
compareTo, equals, getDeclaringClass, hashCode, name, ordinal, toString, valueOf
 
Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait
 

Enum Constant Detail

initialSize

public static final AGPoolProp initialSize
When the pool is created, this many connections will be initialized, then returned to the pool.

See Also:
AGPoolConfig.initialSize

shutdownHook

public static final AGPoolProp shutdownHook
When the pool is created, if this is true (default is false), a hook will be registered to close the pool. Connections will be closed whether idle or not.

When the pool is closed, from outside of the hook, the hook will be removed so it is not leaked in the list of hooks.

See Also:
AGPoolConfig.shutdownHook, Runtime.addShutdownHook(Thread)

minIdle

public static final AGPoolProp minIdle
See Also:
GenericObjectPool.setMinIdle(int)

maxIdle

public static final AGPoolProp maxIdle
See Also:
GenericObjectPool.setMaxIdle(int)

maxActive

public static final AGPoolProp maxActive
Max number of connections that can be allocated by the pool. If multiple clients (or different pools), are using the same AllegroGraph Server, this value should be set to something less than the SessionPorts. See Session Port Setup.

See Also:
GenericObjectPool.setMaxActive(int)

maxWait

public static final AGPoolProp maxWait
milliseconds to wait to borrow before throwing NoSuchElementException

See Also:
GenericObjectPool.setMaxWait(long)

testOnBorrow

public static final AGPoolProp testOnBorrow
Calls AGRepositoryConnection.size(org.openrdf.model.Resource...). Redundant because AGConnFactory.activateObject(Object) always calls AGRepositoryConnection.rollback().

See Also:
GenericObjectPool.setTestOnBorrow(boolean), AGConnFactory.validateObject(Object)

testOnReturn

public static final AGPoolProp testOnReturn
Calls AGRepositoryConnection.size(org.openrdf.model.Resource...).

See Also:
GenericObjectPool.setTestOnReturn(boolean), AGConnFactory.validateObject(Object)

timeBetweenEvictionRunsMillis

public static final AGPoolProp timeBetweenEvictionRunsMillis
See Also:
GenericObjectPool.setTimeBetweenEvictionRunsMillis(long)

minEvictableIdleTimeMillis

public static final AGPoolProp minEvictableIdleTimeMillis
See Also:
GenericObjectPool.setMinEvictableIdleTimeMillis(long)

testWhileIdle

public static final AGPoolProp testWhileIdle
See Also:
GenericObjectPool.setTestWhileIdle(boolean)

softMinEvictableIdleTimeMillis

public static final AGPoolProp softMinEvictableIdleTimeMillis
See Also:
GenericObjectPool.setSoftMinEvictableIdleTimeMillis(long)

numTestsPerEvictionRun

public static final AGPoolProp numTestsPerEvictionRun
See Also:
GenericObjectPool.setNumTestsPerEvictionRun(int)
Method Detail

values

public static AGPoolProp[] values()
Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:
for (AGPoolProp c : AGPoolProp.values())
    System.out.println(c);

Returns:
an array containing the constants of this enum type, in the order they are declared

valueOf

public static AGPoolProp valueOf(String name)
Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:
name - the name of the enum constant to be returned.
Returns:
the enum constant with the specified name
Throws:
IllegalArgumentException - if this enum type has no constant with the specified name
NullPointerException - if the argument is null

Copyright © 2008-2016 Franz Inc.