ConnectionProperties (DB Utils 1.3 API)

java.lang.Object
- org.beiter.michael.db.ConnectionProperties

public class ConnectionProperties
extends Object

This class specifies connection pool properties.

Constructor Summary

Constructors
Constructor and Description
`ConnectionProperties()` Constructs an empty set of connection properties, with most values being set to `null`, 0, or empty (depending on the type of the property).
`ConnectionProperties(ConnectionProperties properties)` Creates a set of connection properties from an exist set of connection properties, making a defensive copy.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Map<String,String>`	`getAdditionalProperties()`
`int`	`getDefaultTransactionIsolation()`
`String`	`getDriver()`
`long`	`getMaxConnLifetimeMillis()`
`int`	`getMaxIdle()`
`int`	`getMaxTotal()`
`long`	`getMaxWaitMillis()`
`long`	`getMinEvictableIdleTimeMillis()`
`int`	`getMinIdle()`
`int`	`getNumTestsPerEvictionRun()`
`String`	`getPassword()`
`long`	`getSoftMinEvictableIdleTimeMillis()`
`long`	`getTimeBetweenEvictionRunsMillis()`
`String`	`getUrl()`
`String`	`getUsername()`
`String`	`getValidationQuery()`
`boolean`	`isCacheState()`
`boolean`	`isDefaultAutoCommit()`
`boolean`	`isDefaultReadOnly()`
`boolean`	`isLifo()`
`boolean`	`isTestOnBorrow()`
`boolean`	`isTestOnCreate()`
`boolean`	`isTestOnReturn()`
`boolean`	`isTestWhileIdle()`
`void`	`setAdditionalProperties(Map<String,String> additionalProperties)` Any additional properties which have not been parsed, and for which no getter/setter exists, but are to be stored in this object nevertheless.
`void`	`setCacheState(boolean cacheState)` If `true`, the pooled connection will cache the current `readOnly` and `autoCommit` settings when first read or written and on all subsequent writes.
`void`	`setDefaultAutoCommit(boolean defaultAutoCommit)` The default auto-commit state of connections created by the pool.
`void`	`setDefaultReadOnly(boolean defaultReadOnly)` The default read-only state of connections created by the pool.
`void`	`setDefaultTransactionIsolation(int defaultTransactionIsolation)` The default TransactionIsolation state of connections created by this pool.
`void`	`setDriver(String driver)` The JDBC database driver class
`void`	`setLifo(boolean lifo)` `True` means that the pool returns the most recently used ("last in") connection in the pool (if there are idle connections available).
`void`	`setMaxConnLifetimeMillis(long maxConnLifetimeMillis)` The maximum lifetime in milliseconds of a connection.
`void`	`setMaxIdle(int maxIdle)` The maximum number of connections that can remain idle in the pool, without extra ones being released, or negative for no limit.
`void`	`setMaxTotal(int maxTotal)` The maximum number of active connections that can be allocated from this pool at the same time, or negative for no limit.
`void`	`setMaxWaitMillis(long maxWaitMillis)` The maximum number of milliseconds that the pool will wait (when there are no available connections) for a connection to be returned before throwing an exception, or -1 to wait indefinitely.
`void`	`setMinEvictableIdleTimeMillis(long minEvictableIdleTimeMillis)` The minimum amount of time an object may sit idle in the pool before it is eligable for eviction by the idle object evictor (if any).
`void`	`setMinIdle(int minIdle)` The minimum number of connections that can remain idle in the pool, without extra ones being created, or zero to create none.
`void`	`setNumTestsPerEvictionRun(int numTestsPerEvictionRun)` The number of objects to examine during each run of the idle object evictor thread (if any).
`void`	`setPassword(String password)` The password for the connection
`void`	`setSoftMinEvictableIdleTimeMillis(long softMinEvictableIdleTimeMillis)` The minimum amount of time a connection may sit idle in the pool before it is eligible for eviction by the idle connection evictor, with the extra condition that at least "`minIdle`" connections remain in the pool.
`void`	`setTestOnBorrow(boolean testOnBorrow)` The indication of whether objects will be validated before being borrowed from the pool.
`void`	`setTestOnCreate(boolean testOnCreate)` The indication of whether objects will be validated after creation.
`void`	`setTestOnReturn(boolean testOnReturn)` The indication of whether objects will be validated before being returned to the pool.
`void`	`setTestWhileIdle(boolean testWhileIdle)` The indication of whether objects will be validated by the idle object evictor (if any).
`void`	`setTimeBetweenEvictionRunsMillis(long timeBetweenEvictionRunsMillis)` The number of milliseconds to sleep between runs of the idle object evictor thread.
`void`	`setUrl(String url)` The JDBC database URL of the form `jdbc:subprotocol:subname`
`void`	`setUsername(String username)` The username for the connection
`void`	`setValidationQuery(String validationQuery)` The SQL query that will be used to validate connections from the pool before returning them to the caller.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - ConnectionProperties
```
public ConnectionProperties()
```
    Constructs an empty set of connection properties, with most values being set to null, 0, or empty (depending on the type of the property). Usually this constructor is used if this configuration POJO is populated in an automated fashion (e.g. injection). If you need to build them manually (possibly with defaults), use or create a properties builder.
    You can change the defaults with the setters. If you need more control over the pool than what is provided by the available setters, consider using a JNDI controlled connection pool instead.
    
    See Also:
    
    MapBasedConnPropsBuilder.buildDefault(), MapBasedConnPropsBuilder.build(java.util.Map)
  - ConnectionProperties
```
public ConnectionProperties(ConnectionProperties properties)
```
    Creates a set of connection properties from an exist set of connection properties, making a defensive copy.
    See ConnectionProperties()
    
    Parameters:
    
    properties - The set of connection properties to copy
    
    Throws:
    
    NullPointerException - When properties is null
- Method Detail
  - getDriver
```
public final String getDriver()
```
    Returns:
    
    The JDBC database driver class
    
    See Also:
    
    setDriver(String)
  - setDriver
```
public final void setDriver(String driver)
```
    The JDBC database driver class
    
    Parameters:
    
    driver - The JDBC database driver class
  - getUrl
```
public final String getUrl()
```
    Returns:
    
    The JDBC database URL of the form jdbc:subprotocol:subname
    
    See Also:
    
    setUrl(String)
  - setUrl
```
public final void setUrl(String url)
```
    The JDBC database URL of the form jdbc:subprotocol:subname
    
    Parameters:
    
    url - The JDBC database URL
  - getUsername
```
public final String getUsername()
```
    Returns:
    
    The username for the connection
    
    See Also:
    
    setUsername(String)
  - setUsername
```
public final void setUsername(String username)
```
    The username for the connection
    
    Parameters:
    
    username - The username for the connection
  - getPassword
```
public final String getPassword()
```
    Returns:
    
    The password for the connection
    
    See Also:
    
    setUrl(String)
  - setPassword
```
public final void setPassword(String password)
```
    The password for the connection
    
    Parameters:
    
    password - The password for the connection
  - getMaxTotal
```
public final int getMaxTotal()
```
    Returns:
    
    the maximum numbers of active connections
    
    See Also:
    
    setMaxTotal(int)
  - setMaxTotal
```
public final void setMaxTotal(int maxTotal)
```
    The maximum number of active connections that can be allocated from this pool at the same time, or negative for no limit.
    
    Parameters:
    
    maxTotal - the maximum numbers of active connections
  - getMaxIdle
```
public final int getMaxIdle()
```
    Returns:
    
    the maximum number of idle connections
    
    See Also:
    
    setMaxIdle(int)
  - setMaxIdle
```
public final void setMaxIdle(int maxIdle)
```
    The maximum number of connections that can remain idle in the pool, without extra ones being released, or negative for no limit.
    
    Parameters:
    
    maxIdle - the maximum number of idle connections
  - getMinIdle
```
public final int getMinIdle()
```
    Returns:
    
    the minimum number of idle connections
    
    See Also:
    
    setMinIdle(int)
  - setMinIdle
```
public final void setMinIdle(int minIdle)
```
    The minimum number of connections that can remain idle in the pool, without extra ones being created, or zero to create none.
    
    Parameters:
    
    minIdle - the minimum number of idle connections
    
    Throws:
    
    IllegalArgumentException - When the provided value of minIdle is out of range
  - getMaxWaitMillis
```
public final long getMaxWaitMillis()
```
    Returns:
    
    the maximum number of milliseconds that the pool will wait for a connection
    
    See Also:
    
    setMaxWaitMillis(long)
  - setMaxWaitMillis
```
public final void setMaxWaitMillis(long maxWaitMillis)
```
    The maximum number of milliseconds that the pool will wait (when there are no available connections) for a connection to be returned before throwing an exception, or -1 to wait indefinitely.
    
    Parameters:
    
    maxWaitMillis - the maximum number of milliseconds that the pool will wait for a connection
    
    Throws:
    
    IllegalArgumentException - When the provided value of maxWaitMillis is out of range
  - isTestOnCreate
```
public final boolean isTestOnCreate()
```
    Returns:
    
    the indication of whether objects will be validated after creation
    
    See Also:
    
    setTestOnCreate(boolean)
  - setTestOnCreate
```
public final void setTestOnCreate(boolean testOnCreate)
```
    The indication of whether objects will be validated after creation. If the object fails to validate, the borrow attempt that triggered the object creation will fail.
    
    Parameters:
    
    testOnCreate - the indication of whether objects will be validated after creation
  - isTestOnBorrow
```
public final boolean isTestOnBorrow()
```
    Returns:
    
    the indication of whether objects will be validated before being borrowed from the pool
    
    See Also:
    
    setTestOnBorrow(boolean)
  - setTestOnBorrow
```
public final void setTestOnBorrow(boolean testOnBorrow)
```
    The indication of whether objects will be validated before being borrowed from the pool. If the object fails to validate, it will be dropped from the pool, and we will attempt to borrow another.
    
    Parameters:
    
    testOnBorrow - the indication of whether objects will be validated before being borrowed from the pool
  - isTestOnReturn
```
public final boolean isTestOnReturn()
```
    Returns:
    
    the indication of whether objects will be validated before being returned to the pool
    
    See Also:
    
    setTestOnReturn(boolean)
  - setTestOnReturn
```
public final void setTestOnReturn(boolean testOnReturn)
```
    The indication of whether objects will be validated before being returned to the pool.
    
    Parameters:
    
    testOnReturn - the indication of whether objects will be validated before being returned to the pool
  - isTestWhileIdle
```
public final boolean isTestWhileIdle()
```
    Returns:
    
    the indication of whether objects will be validated by the idle object evictor (if any)
    
    See Also:
    
    setTestWhileIdle(boolean)
  - setTestWhileIdle
```
public final void setTestWhileIdle(boolean testWhileIdle)
```
    The indication of whether objects will be validated by the idle object evictor (if any). If an object fails to validate, it will be dropped from the pool.
    
    Parameters:
    
    testWhileIdle - the indication of whether objects will be validated by the idle object evictor (if any)
  - getTimeBetweenEvictionRunsMillis
```
public final long getTimeBetweenEvictionRunsMillis()
```
    Returns:
    
    the number of milliseconds to sleep between runs of the idle object evictor thread
    
    See Also:
    
    setTimeBetweenEvictionRunsMillis(long)
  - setTimeBetweenEvictionRunsMillis
```
public final void setTimeBetweenEvictionRunsMillis(long timeBetweenEvictionRunsMillis)
```
    The number of milliseconds to sleep between runs of the idle object evictor thread. When non-positive, no idle object evictor thread will be run.
    
    Parameters:
    
    timeBetweenEvictionRunsMillis - the number of milliseconds to sleep between runs of the idle object evictor thread
  - getNumTestsPerEvictionRun
```
public final int getNumTestsPerEvictionRun()
```
    Returns:
    
    the number of objects to examine during each run of the idle object evictor thread (if any)
    
    See Also:
    
    setNumTestsPerEvictionRun(int)
  - setNumTestsPerEvictionRun
```
public final void setNumTestsPerEvictionRun(int numTestsPerEvictionRun)
```
    The number of objects to examine during each run of the idle object evictor thread (if any).
    
    Parameters:
    
    numTestsPerEvictionRun - the number of objects to examine during each run of the idle object evictor thread (if any)
    
    Throws:
    
    IllegalArgumentException - When the provided value of numTestsPerEvictionRun is out of range
  - getMinEvictableIdleTimeMillis
```
public final long getMinEvictableIdleTimeMillis()
```
    Returns:
    
    the minimum amount of time an object may sit idle in the pool before it is eligable for eviction by the idle object evictor (if any)
    
    See Also:
    
    setMinEvictableIdleTimeMillis(long)
  - setMinEvictableIdleTimeMillis
```
public final void setMinEvictableIdleTimeMillis(long minEvictableIdleTimeMillis)
```
    The minimum amount of time an object may sit idle in the pool before it is eligable for eviction by the idle object evictor (if any).
    
    Parameters:
    
    minEvictableIdleTimeMillis - minimum amount of time an object may sit idle in the pool before it is eligable for eviction by the idle object evictor (if any).
  - getSoftMinEvictableIdleTimeMillis
```
public final long getSoftMinEvictableIdleTimeMillis()
```
    Returns:
    
    the minimum amount of time a connection may sit idle in the pool before it is eligible for eviction by the idle connection evictor, with the extra condition that at least "minIdle" connections remain in the pool.
    
    See Also:
    
    setSoftMinEvictableIdleTimeMillis(long)
  - setSoftMinEvictableIdleTimeMillis
```
public final void setSoftMinEvictableIdleTimeMillis(long softMinEvictableIdleTimeMillis)
```
    The minimum amount of time a connection may sit idle in the pool before it is eligible for eviction by the idle connection evictor, with the extra condition that at least "minIdle" connections remain in the pool. When miniEvictableIdleTimeMillis is set to a positive value, miniEvictableIdleTimeMillis is examined first by the idle connection evictor - i.e. when idle connections are visited by the evictor, idle time is first compared against miniEvictableIdleTimeMillis (without considering the number of idle connections in the pool) and then against softMinEvictableIdleTimeMillis, including the minIdle constraint.
    
    Parameters:
    
    softMinEvictableIdleTimeMillis - minimum amount of time a connection may sit idle in the pool before it is eligible for eviction by the idle connection evictor, with the extra condition that at least "minIdle" connections remain in the pool.
  - isLifo
```
public final boolean isLifo()
```
    Returns:
    
    true if the pool returns the most recently used ("last in") connection, false the pool behaves as a FIFO queue
    
    See Also:
    
    setLifo(boolean)
  - setLifo
```
public final void setLifo(boolean lifo)
```
    True means that the pool returns the most recently used ("last in") connection in the pool (if there are idle connections available). False means that the pool behaves as a FIFO queue - connections are taken from the idle instance pool in the order that they are returned to the pool.
    
    Parameters:
    
    lifo - true if the pool returns the most recently used ("last in") connection, false the pool behaves as a FIFO queue
  - isDefaultAutoCommit
```
public final boolean isDefaultAutoCommit()
```
    Returns:
    
    The default auto-commit state of connections created by the pool
    
    See Also:
    
    setDefaultAutoCommit(boolean)
  - setDefaultAutoCommit
```
public final void setDefaultAutoCommit(boolean defaultAutoCommit)
```
    The default auto-commit state of connections created by the pool.
    
    Parameters:
    
    defaultAutoCommit - The default auto-commit state of connections created by the pool
  - isDefaultReadOnly
```
public final boolean isDefaultReadOnly()
```
    Returns:
    
    The default read-only state of connections created by the pool
    
    See Also:
    
    setDefaultReadOnly(boolean)
  - setDefaultReadOnly
```
public final void setDefaultReadOnly(boolean defaultReadOnly)
```
    The default read-only state of connections created by the pool.
    Note that some drivers do not support read only mode.
    
    Parameters:
    
    defaultReadOnly - The default read-only state of connections created by the pool
  - getDefaultTransactionIsolation
```
public final int getDefaultTransactionIsolation()
```
    Returns:
    
    The default TransactionIsolation state of connections created by this pool
    
    See Also:
    
    setDefaultTransactionIsolation(int)
  - setDefaultTransactionIsolation
```
public final void setDefaultTransactionIsolation(int defaultTransactionIsolation)
```
    The default TransactionIsolation state of connections created by this pool.
    The following values are allowed:
    - Connection.TRANSACTION_NONE
    - Connection.TRANSACTION_READ_COMMITTED
    - Connection.TRANSACTION_READ_UNCOMMITTED
    - Connection.TRANSACTION_REPEATABLE_READ
    - Connection.TRANSACTION_SERIALIZABLE
    Parameters:
    
    defaultTransactionIsolation - The default TransactionIsolation state of connections created by this pool
    
    See Also:
    
    Connection
  - isCacheState
```
public final boolean isCacheState()
```
    Returns:
    
    If true, the pooled connection will cache the current readOnly and autoCommit settings when first read or written and on all subsequent writes
    
    See Also:
    
    setCacheState(boolean)
  - setCacheState
```
public final void setCacheState(boolean cacheState)
```
    If true, the pooled connection will cache the current readOnly and autoCommit settings when first read or written and on all subsequent writes. This removes the need for additional database queries for any further calls to the getter. If the underlying connection is accessed directly and the readOnly and/or autoCommit settings changed the cached values will not reflect the current state. In this case, caching should be disabled by setting this attribute to false.
    
    Parameters:
    
    cacheState - If true, the pooled connection will cache the current readOnly and autoCommit settings when first read or written and on all subsequent writes
  - getValidationQuery
```
public final String getValidationQuery()
```
    Returns:
    
    The SQL query that will be used to validate connections from the pool before returning them to the caller
    
    See Also:
    
    setValidationQuery(String)
  - setValidationQuery
```
public final void setValidationQuery(String validationQuery)
```
    The SQL query that will be used to validate connections from the pool before returning them to the caller. If specified, this query MUST be an SQL SELECT statement that returns at least one row. If not specified (i.e. null), connections will be validation by calling the isValid() method.
    
    Parameters:
    
    validationQuery - The SQL query that will be used to validate connections from the pool before returning them to the caller
  - getMaxConnLifetimeMillis
```
public final long getMaxConnLifetimeMillis()
```
    Returns:
    
    The maximum lifetime in milliseconds of a connection
    
    See Also:
    
    setMaxConnLifetimeMillis(long)
  - setMaxConnLifetimeMillis
```
public final void setMaxConnLifetimeMillis(long maxConnLifetimeMillis)
```
    The maximum lifetime in milliseconds of a connection. After this time is exceeded the connection will fail the next activation, passivation or validation test. A value of zero or less means the connection has an infinite lifetime.
    
    Parameters:
    
    maxConnLifetimeMillis - The maximum lifetime in milliseconds of a connection
  - getAdditionalProperties
```
public final Map<String,String> getAdditionalProperties()
```
    Returns:
    
    Any additional properties stored in this object that have not explicitly been parsed
    
    See Also:
    
    setAdditionalProperties(Map)
  - setAdditionalProperties
```
public final void setAdditionalProperties(Map<String,String> additionalProperties)
```
    Any additional properties which have not been parsed, and for which no getter/setter exists, but are to be stored in this object nevertheless.
    This property is commonly used to preserve original properties from upstream components that are to be passed on to downstream components unchanged. This properties set may or may not include properties that have been extracted from the map, and been made available through this POJO.
    Note that these additional properties may be null or empty, even in a fully populated POJO where other properties commonly have values assigned to.
    
    Parameters:
    
    additionalProperties - The additional properties to store

Class ConnectionProperties

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

ConnectionProperties

ConnectionProperties

Method Detail

getDriver

setDriver

getUrl

setUrl

getUsername

setUsername

getPassword

setPassword

getMaxTotal

setMaxTotal

getMaxIdle

setMaxIdle

getMinIdle

setMinIdle

getMaxWaitMillis

setMaxWaitMillis

isTestOnCreate

setTestOnCreate

isTestOnBorrow

setTestOnBorrow

isTestOnReturn

setTestOnReturn

isTestWhileIdle

setTestWhileIdle

getTimeBetweenEvictionRunsMillis

setTimeBetweenEvictionRunsMillis

getNumTestsPerEvictionRun

setNumTestsPerEvictionRun

getMinEvictableIdleTimeMillis

setMinEvictableIdleTimeMillis

getSoftMinEvictableIdleTimeMillis

setSoftMinEvictableIdleTimeMillis

isLifo

setLifo

isDefaultAutoCommit

setDefaultAutoCommit

isDefaultReadOnly

setDefaultReadOnly

getDefaultTransactionIsolation

setDefaultTransactionIsolation

isCacheState

setCacheState

getValidationQuery

setValidationQuery

getMaxConnLifetimeMillis

setMaxConnLifetimeMillis

getAdditionalProperties

setAdditionalProperties