org.firebirdsql.pool

Interface ConnectionPoolConfiguration

All Known Subinterfaces:

FirebirdPool

All Known Implementing Classes:

AbstractDriverConnectionPoolDataSource, AbstractFBConnectionPoolDataSource, BasicAbstractConnectionPool, DriverConnectionPoolDataSource, FBConnectionPoolDataSource, FBWrappingDataSource

Deprecated.

@Deprecated
public interface ConnectionPoolConfiguration

This interface describes a configuration for AbstractConnectionPool instances. Motivation for separating pool configuration into interface is quite simple, it allows third-party applications to load configuration from various sources (resource bundle, XML file, etc.).

Author:

Roman Rokytskyy

Method Summary

Modifier and Type	Method and Description
int	getBlockingTimeout() Deprecated. Get time during which ConnectionPoolDataSource.getPooledConnection() can block.
int	getIdleTimeout() Deprecated. please use getMaxIdleTime() instead.
int	getMaxConnections() Deprecated. please use getMaxPoolSize() instead.
int	getMaxIdleTime() Deprecated. Get time after which idle connections will be deallocated.
int	getMaxPoolSize() Deprecated. Get maximum number of physical connections that can be simultaneously open.
int	getMinConnections() Deprecated. please use getMinPoolSize() instead.
int	getMinPoolSize() Deprecated. Get minimum number of open JDBC connections that will be created when pool is started.
int	getPingInterval() Deprecated. Get time interval after which connection should be pinged.
java.lang.String	getPingStatement() Deprecated. Get SQL statement that will be used to ping connection.
int	getRetryInterval() Deprecated. Get interval of getting connections retries.
boolean	isPingable() Deprecated. Check if this pool supports pingable connections.
boolean	isPooling() Deprecated. Check if this connection pool uses connection pooling, or just implements JDBC 2.0 SE interfaces.
boolean	isStatementPooling() Deprecated. Check if this connection pool provides also prepared statement pooling.

Method Detail

getMinConnections

int getMinConnections()

Deprecated. please use getMinPoolSize() instead.

Get minimum number of open JDBC connections that will be created when pool is started.

Returns:

minimum number of open JDBC connections to open at startup.

getMinPoolSize

int getMinPoolSize()

Deprecated.

Get minimum number of open JDBC connections that will be created when pool is started.

Returns:

minimum number of open JDBC connections to open at startup.

getMaxConnections

int getMaxConnections()

Deprecated. please use getMaxPoolSize() instead.

Get maximum number of physical connections that can be simultaneously open.

Returns:

maximum number of simultaneously open physical database connections, 0 if no limit exists.

getMaxPoolSize

int getMaxPoolSize()

Deprecated.

Get maximum number of physical connections that can be simultaneously open.

Returns:

maximum number of simultaneously open physical database connections, 0 if no limit exists.

getBlockingTimeout

int getBlockingTimeout()

Deprecated.

Get time during which ConnectionPoolDataSource.getPooledConnection() can block. By default method blocks forever.

Returns:

pool blocking timeout in milliseconds, Integer.MAX_VALUE indicates blocking forever.

getRetryInterval

int getRetryInterval()

Deprecated.

Get interval of getting connections retries. It might happen that pool contains no free connection. In order not to wait until connection is returned into the pool, pool will try to obtain connection again and again with the interval returned by this method. Default value is 1000 (1 sec).

Returns:

retry interval in milliseconds.

getIdleTimeout

int getIdleTimeout()

Deprecated. please use getMaxIdleTime() instead.

Get time after which idle connections will be deallocated.

Returns:

idle timeout in milliseconds, Integer.MAX_VALUE indicates that idle connections are not removed.

getMaxIdleTime

int getMaxIdleTime()

Deprecated.

Get time after which idle connections will be deallocated.

Returns:

idle timeout in milliseconds, Integer.MAX_VALUE indicates that idle connections are not removed.

isPooling

boolean isPooling()

Deprecated.

Check if this connection pool uses connection pooling, or just implements JDBC 2.0 SE interfaces. By default pooling is on. It might make sense to set pooling off to check performance degradation in test environment. It could be also used in the environment where physical connection must be closed right after usage, however using JDBC 2.0 SE interfaces is either a requirement or is simpler than standard java.sql.Driver.

Returns:

true if pooling is enabled.

isStatementPooling

boolean isStatementPooling()

Deprecated.

Check if this connection pool provides also prepared statement pooling. By default prepared statement pooling is enabled, however there might be situations where statement pooling is not desired, for example in environments where database can quickly run out of handles and fast handle reuse is required.

Returns:

true if prepared statement pooling is enabled.

isPingable

boolean isPingable()

Deprecated.

Check if this pool supports pingable connections. Pingable connections are used to correctly check if connection is still alive or not.

Returns:

true if this pool supports pingable connections.

getPingStatement

java.lang.String getPingStatement()

Deprecated.

Get SQL statement that will be used to ping connection. Ping SQL statement returns exactly one row without throwing an exception. Ping SQL statement must not influence the outcome of a transaction.

Examples of ping SQL statements:

• Oracle: "SELECT CAST(1 AS INTEGER) FROM DUAL"
• Firebird: "SELECT CAST(1 AS INTEGER) FROM RDB$DATABASE"

Returns:

SQL statement that will be used to ping connection.

getPingInterval

int getPingInterval()

Deprecated.

Get time interval after which connection should be pinged.

Returns:

number of milliseconds in the ping interval.