oracle.ifs.server

Class ConnectionPoolConfiguration

java.lang.Object

oracle.ifs.server.ConnectionPoolConfiguration

All Implemented Interfaces:

Serializable

public class ConnectionPoolConfiguration
extends Object
implements Serializable

A ConnectionPoolConfiguration is a bucket of parameters that govern the operation of a ConnectionPool.

Version:

1.0

Author:

David Pitfield

See Also:

Serialized Form

(Unpublished)

Constructor Summary

Constructors

Constructor and Description
ConnectionPoolConfiguration() Constructs a ConnectionPoolConfiguration.

Method Summary

Modifier and Type	Method and Description
DataSource	getDataSource() Returns the data source used by this connection pool config.
int	getDefaultRowPrefetch() Gets the default number of prefetched rows.
PrintStream	getJdbcLogStream() Gets the PrintStream to which the JDBC log will be sent.
int	getMaximumSize() Gets the absolute maximum number of LibraryConnections in the ConnectionPool.
long	getMaximumSizeTimeout() Gets the period of time, in milliseconds, that attempting to acquire a LibraryConnection will wait before throwing an exception if the ConnectionPool size has reached its absolute maximum.
int	getMinimumSize() Gets the minimum number of LibraryConnections in the ConnectionPool.
String	getName() Gets the name of the ConnectionPool.
int	getStatementCacheSizeTrigger() Gets the number of statements that need to be cached before a purge is triggered.
int	getStatementCacheTarget() Gets the target maximum number of statements we wish to keep cached.
int	getStatementResetLimit() Gets the access limit at which statements saved in LibraryConnections will be closed and re-opened.
int	getTargetSize() Gets the target maximum number of LibraryConnections in the ConnectionPool.
long	getTargetSizeTimeout() Gets the period of time, in milliseconds, that attempting to acquire a LibraryConnection will wait before creating a new LibraryConnection if the ConnectionPool size has reached its target maximum.
void	setDataSource(DataSource dataSource) Sets the DataSource for this Connection pool configuration.
void	setDefaultRowPrefetch(int prefetch) Sets the default number of prefetched rows.
void	setJdbcLogStream(PrintStream stream) Sets the PrintStream to which the JDBC log will be sent.
void	setMaximumSize(int maximumSize) Sets the absolute maximum number of LibraryConnections in the ConnectionPool.
void	setMaximumSizeTimeout(long timeout) Sets the period of time, in milliseconds, that attempting to acquire a LibraryConnection will wait before throwing an exception if the ConnectionPool size has reached its absolute maximum.
void	setMinimumSize(int minimumSize) Sets the minimum number of LibraryConnections in the ConnectionPool.
void	setName(String name) Sets the name of the ConnectionPool.
void	setStatementCacheSizeTrigger(int trigger) Sets the number of statements that need to be cached before a purge is triggered.
void	setStatementCacheTarget(int target) Sets the target maximum number of statements we wish to keep cached.
void	setStatementResetLimit(int statementResetLimit) Sets the access limit at which statements saved in LibraryConnections will be closed and re-opened.
void	setTargetSize(int targetSize) Sets the target maximum number of LibraryConnections in the ConnectionPool.
void	setTargetSizeTimeout(long timeout) Sets the period of time, in milliseconds, that attempting to acquire a LibraryConnection will wait before creating a new LibraryConnection if the ConnectionPool size has reached its target maximum.

Methods inherited from class java.lang.Object

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

Constructor Detail

ConnectionPoolConfiguration

public ConnectionPoolConfiguration()
                            throws IfsException

Constructs a ConnectionPoolConfiguration.

Throws:

IfsException - if the operation fails

(Unpublished)

Method Detail

setName

public void setName(String name)
             throws IfsException

Sets the name of the ConnectionPool.

Parameters:

name - the name

Throws:

IfsException - if the operation fails

(Unpublished)

getName

public String getName()
               throws IfsException

Gets the name of the ConnectionPool.

Returns:

the name

Throws:

IfsException - if the operation fails

(Unpublished)

setJdbcLogStream

public void setJdbcLogStream(PrintStream stream)
                      throws IfsException

Sets the PrintStream to which the JDBC log will be sent.

Parameters:

stream - the stream, or null to disable JDBC logging

Throws:

IfsException - if the operation fails

(Unpublished)

getJdbcLogStream

public PrintStream getJdbcLogStream()
                             throws IfsException

Gets the PrintStream to which the JDBC log will be sent.

Returns:

the stream, or null if JDBC logging is disabled

Throws:

IfsException - if the operation fails

(Unpublished)

setDefaultRowPrefetch

public void setDefaultRowPrefetch(int prefetch)
                           throws IfsException

Sets the default number of prefetched rows.

Parameters:

prefetch - the default row prefetch

Throws:

IfsException - if the operation fails

(Unpublished)

getDefaultRowPrefetch

public int getDefaultRowPrefetch()
                          throws IfsException

Gets the default number of prefetched rows.

Returns:

the default row prefetch

Throws:

IfsException - if the operation fails

(Unpublished)

setStatementResetLimit

public void setStatementResetLimit(int statementResetLimit)
                            throws IfsException

Sets the access limit at which statements saved in LibraryConnections will be closed and re-opened. A value of zero indicates that the statements are never closed and re-opened.

Parameters:

statementResetLimit - see method description

Throws:

IfsException - if the operation fails

(Unpublished)

getStatementResetLimit

public int getStatementResetLimit()
                           throws IfsException

Gets the access limit at which statements saved in LibraryConnections will be closed and re-opened. A value of zero indicates that the statements are never closed and re-opened.

Returns:

the statement reset limit

Throws:

IfsException - if the operation fails

(Unpublished)

setStatementCacheTarget

public void setStatementCacheTarget(int target)
                             throws IfsException

Sets the target maximum number of statements we wish to keep cached.

Parameters:

target - the target maximum number of statements to cache

Throws:

IfsException - if the operation fails

(Unpublished)

getStatementCacheTarget

public int getStatementCacheTarget()
                            throws IfsException

Gets the target maximum number of statements we wish to keep cached.

Returns:

the target maximum number of statements to cache

Throws:

IfsException - if the operation fails

(Unpublished)

setStatementCacheSizeTrigger

public void setStatementCacheSizeTrigger(int trigger)
                                  throws IfsException

Sets the number of statements that need to be cached before a purge is triggered.

Parameters:

trigger - the number of statements cached that triggers a purge

Throws:

IfsException - if the operation fails

(Unpublished)

getStatementCacheSizeTrigger

public int getStatementCacheSizeTrigger()
                                 throws IfsException

Gets the number of statements that need to be cached before a purge is triggered.

Returns:

the number of statements cached that triggers a purge

Throws:

IfsException - if the operation fails

(Unpublished)

setMinimumSize

public void setMinimumSize(int minimumSize)
                    throws IfsException

Sets the minimum number of LibraryConnections in the ConnectionPool.

Parameters:

minimumSize - the minimum size

Throws:

IfsException - if the operation fails

(Unpublished)

getMinimumSize

public int getMinimumSize()
                   throws IfsException

Gets the minimum number of LibraryConnections in the ConnectionPool.

Returns:

the minimum size

Throws:

IfsException - if the operation fails

(Unpublished)

setTargetSize

public void setTargetSize(int targetSize)
                   throws IfsException

Sets the target maximum number of LibraryConnections in the ConnectionPool.

Parameters:

targetSize - the target maximum size

Throws:

IfsException - if the operation fails

(Unpublished)

getTargetSize

public int getTargetSize()
                  throws IfsException

Gets the target maximum number of LibraryConnections in the ConnectionPool.

Returns:

the target maximum size

Throws:

IfsException - if the operation fails

(Unpublished)

setMaximumSize

public void setMaximumSize(int maximumSize)
                    throws IfsException

Sets the absolute maximum number of LibraryConnections in the ConnectionPool.

Parameters:

maximumSize - the absolute maximum size

Throws:

IfsException - if the operation fails

(Unpublished)

getMaximumSize

public int getMaximumSize()
                   throws IfsException

Gets the absolute maximum number of LibraryConnections in the ConnectionPool.

Returns:

the absolute maximum size

Throws:

IfsException - if the operation fails

(Unpublished)

setTargetSizeTimeout

public void setTargetSizeTimeout(long timeout)
                          throws IfsException

Sets the period of time, in milliseconds, that attempting to acquire a LibraryConnection will wait before creating a new LibraryConnection if the ConnectionPool size has reached its target maximum.

Parameters:

timeout - the wait period, in milliseconds

Throws:

IfsException - if the operation fails

(Unpublished)

getTargetSizeTimeout

public long getTargetSizeTimeout()
                          throws IfsException

Gets the period of time, in milliseconds, that attempting to acquire a LibraryConnection will wait before creating a new LibraryConnection if the ConnectionPool size has reached its target maximum.

Returns:

the wait period, in milliseconds

Throws:

IfsException - if the operation fails

(Unpublished)

setMaximumSizeTimeout

public void setMaximumSizeTimeout(long timeout)
                           throws IfsException

Sets the period of time, in milliseconds, that attempting to acquire a LibraryConnection will wait before throwing an exception if the ConnectionPool size has reached its absolute maximum.

Parameters:

timeout - the wait period, in milliseconds

Throws:

IfsException - if the operation fails

(Unpublished)

getMaximumSizeTimeout

public long getMaximumSizeTimeout()
                           throws IfsException

Gets the period of time, in milliseconds, that attempting to acquire a LibraryConnection will wait before throwing an exception if the ConnectionPool size has reached its absolute maximum.

Returns:

the wait period, in milliseconds

Throws:

IfsException - if the operation fails

(Unpublished)

setDataSource

public void setDataSource(DataSource dataSource)
                   throws IfsException

Sets the DataSource for this Connection pool configuration.

Parameters:

dataSource - database connection factory

Throws:

IfsException - if the operation fails

getDataSource

public DataSource getDataSource()
                         throws IfsException

Returns the data source used by this connection pool config.

Returns:

data source object

Throws:

IfsException - if the operation fails