org.attribyte.sql.pool

Class ConnectionPool.Initializer

java.lang.Object

org.attribyte.sql.pool.ConnectionPool.Initializer

Enclosing class:

ConnectionPool

public static class ConnectionPool.Initializer
extends java.lang.Object

Initializes and creates connection pools.

Constructor Summary

Constructors

Constructor and Description
Initializer()

Method Summary

Modifier and Type	Method and Description
ConnectionPool.Initializer	addActiveSegment(ConnectionPoolSegment segment) Adds an active segment to the pool.
ConnectionPool.Initializer	addActiveSegments(java.util.List<ConnectionPoolSegment> segments) Adds active segments to the pool.
ConnectionPool.Initializer	addAlias(java.lang.String alias) Adds an alias for this pool.
ConnectionPool.Initializer	addReserveSegment(ConnectionPoolSegment segment) Adds a reserve segment to the pool.
ConnectionPool.Initializer	addReserveSegments(java.util.List<ConnectionPoolSegment> segments) Adds reserve segments to the pool.
ConnectionPool	createPool() Creates a configured pool.
static java.util.List<ConnectionPool.Initializer>	fromConfig(Config config, PasswordSource passwordSource, Logger logger) Create an Initializer for each configured pool.
static java.util.List<ConnectionPool.Initializer>	fromConfigFile(java.io.File configFile, PasswordSource passwordSource, Logger logger) Parse a config file to create an Initializer for each configured pool.
static java.util.List<ConnectionPool.Initializer>	fromProperties(java.util.Properties props, PasswordSource passwordSource, Logger logger) Parse properties to create an Initializer for each configured pool.
static java.util.List<ConnectionPool.Initializer>	fromPropertiesFile(java.io.File propsFile, PasswordSource passwordSource, Logger logger) Parse properties to create an Initializer for each configured pool.
ConnectionPool.Initializer	setIdleCheckInterval(long idleCheckInterval, java.util.concurrent.TimeUnit idleCheckIntervalUnit) Sets the interval between checks for idle segments.
ConnectionPool.Initializer	setLogger(Logger logger) Sets the logger.
ConnectionPool.Initializer	setMinActiveSegments(int minActiveSegments) Sets the minimum number of active statements.
ConnectionPool.Initializer	setMinSegmentExpansionDelay(long minSegmentExpansionDelayMillis) Sets the minimum delay between segment expansions in milliseconds.
ConnectionPool.Initializer	setName(java.lang.String name) Sets the name of the pool.
ConnectionPool.Initializer	setSaturatedAcquireTimeout(long saturatedAcquireTimeout, java.util.concurrent.TimeUnit saturatedAcquireTimeoutUnit) Sets the maximum amount of time to wait for an available connection when pool is saturated.

Methods inherited from class java.lang.Object

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

Constructor Detail

Initializer

public Initializer()

Method Detail

fromConfig

public static final java.util.List<ConnectionPool.Initializer> fromConfig(Config config,
                                                                          PasswordSource passwordSource,
                                                                          Logger logger)
                                                                   throws InitializationException

Create an Initializer for each configured pool.

Parameters:

config - The configuration.

passwordSource - The password source. May be null.

logger - The logger. May be null.

Returns:

The list of Initializers.

Throws:

InitializationException - on invalid configuration.

fromConfigFile

public static final java.util.List<ConnectionPool.Initializer> fromConfigFile(java.io.File configFile,
                                                                              PasswordSource passwordSource,
                                                                              Logger logger)
                                                                       throws InitializationException

Parse a config file to create an Initializer for each configured pool.

File format is HOCON. Configuration must appear in the path: acp

Parameters:

configFile - The config file.

passwordSource - The password source. May be null.

logger - The logger. May be null.

Returns:

The list of Initializers.

Throws:

InitializationException - on invalid file or configuration.

fromProperties

public static final java.util.List<ConnectionPool.Initializer> fromProperties(java.util.Properties props,
                                                                              PasswordSource passwordSource,
                                                                              Logger logger)
                                                                       throws InitializationException

Parse properties to create an Initializer for each configured pool.

Parameters:

passwordSource - The password source. May be null.

logger - The logger. May be null.

Returns:

The list of Initializers.

Throws:

InitializationException - on invalid configuration.

fromPropertiesFile

public static final java.util.List<ConnectionPool.Initializer> fromPropertiesFile(java.io.File propsFile,
                                                                                  PasswordSource passwordSource,
                                                                                  Logger logger)
                                                                           throws InitializationException

Parse properties to create an Initializer for each configured pool.

Parameters:

passwordSource - The password source. May be null.

logger - The logger. May be null.

Returns:

The list of Initializers.

Throws:

InitializationException - on invalid file or configuration.

setName

public ConnectionPool.Initializer setName(java.lang.String name)

Sets the name of the pool.

Parameters:

name - The name.

Returns:

A self-reference.

addActiveSegment

public ConnectionPool.Initializer addActiveSegment(ConnectionPoolSegment segment)

Adds an active segment to the pool.

Parameters:

segment - The segment to add.

Returns:

A self-reference.

addActiveSegments

public ConnectionPool.Initializer addActiveSegments(java.util.List<ConnectionPoolSegment> segments)

Adds active segments to the pool.

Parameters:

segments - The segments to add.

Returns:

A self-reference.

addReserveSegment

public ConnectionPool.Initializer addReserveSegment(ConnectionPoolSegment segment)

Adds a reserve segment to the pool.

Parameters:

segment - The segment to add.

Returns:

A self-reference.

addReserveSegments

public ConnectionPool.Initializer addReserveSegments(java.util.List<ConnectionPoolSegment> segments)

Adds reserve segments to the pool.

Parameters:

segments - The segments to add.

Returns:

A self-reference.

setMinActiveSegments

public ConnectionPool.Initializer setMinActiveSegments(int minActiveSegments)

Sets the minimum number of active statements.

Parameters:

minActiveSegments - The minimum number of active segments.

Returns:

A self-reference.

setMinSegmentExpansionDelay

public ConnectionPool.Initializer setMinSegmentExpansionDelay(long minSegmentExpansionDelayMillis)

Sets the minimum delay between segment expansions in milliseconds.

Parameters:

minSegmentExpansionDelayMillis - The delay.

Returns:

A self-reference.

setIdleCheckInterval

public ConnectionPool.Initializer setIdleCheckInterval(long idleCheckInterval,
                                                       java.util.concurrent.TimeUnit idleCheckIntervalUnit)

Sets the interval between checks for idle segments.

Parameters:

idleCheckInterval - The idle check interval.

idleCheckIntervalUnit - The idle check interval units.

Returns:

A self-reference.

setSaturatedAcquireTimeout

public ConnectionPool.Initializer setSaturatedAcquireTimeout(long saturatedAcquireTimeout,
                                                             java.util.concurrent.TimeUnit saturatedAcquireTimeoutUnit)

Sets the maximum amount of time to wait for an available connection when pool is saturated.

Parameters:

saturatedAcquireTimeout - The saturated acquire timeout.

saturatedAcquireTimeoutUnit - The saturated acquire timeout units.

Returns:

A self-reference.

setLogger

public ConnectionPool.Initializer setLogger(Logger logger)

Sets the logger.

Parameters:

logger - The logger.

Returns:

A self-reference.

addAlias

public ConnectionPool.Initializer addAlias(java.lang.String alias)

Adds an alias for this pool.

Parameters:

alias - The alias name.

Returns:

A self-reference.

createPool

public ConnectionPool createPool()
                          throws java.sql.SQLException,
                                 InitializationException

Creates a configured pool.

Returns:

The pool.

Throws:

java.sql.SQLException - if pool could not be created.

InitializationException - if pool was improperly configured.