DataSourceFactory (Dropwizard Database Support 2.1.0-beta.8 API)

java.lang.Object
- io.dropwizard.db.DataSourceFactory

All Implemented Interfaces:: PooledDataSourceFactory

public class DataSourceFactory
extends Object
implements PooledDataSourceFactory

A factory for pooled ManagedDataSources.

Configuration Parameters:

Name	Default	Description
`url`	REQUIRED	The URL of the server.
`driverClass`	none	The fully qualified class name of the JDBC driver class. Only required if there were no JDBC drivers registered in `META-INF/services/java.sql.Driver`.
`user`	none	The username used to connect to the server.
`password`	none	The password used to connect to the server.
`removeAbandoned`	`false`	Remove abandoned connections if they exceed the `removeAbandonedTimeout`. If set to `true` a connection is considered abandoned and eligible for removal if it has been in use longer than the `removeAbandonedTimeout` and the condition for `abandonWhenPercentageFull` is met.
`removeAbandonedTimeout`	60 seconds	The time before a database connection can be considered abandoned.
`abandonWhenPercentageFull`	0	Connections that have been abandoned (timed out) won't get closed and reported up unless the number of connections in use are above the percentage defined by `abandonWhenPercentageFull`. The value should be between 0-100.
`alternateUsernamesAllowed`	`false`	Set to true if the call `getConnection(username,password)` is allowed. This is used for when the pool is used by an application accessing multiple schemas. There is a performance impact turning this option on, even when not used.
`commitOnReturn`	`false`	Set to true if you want the connection pool to commit any pending transaction when a connection is returned.
`rollbackOnReturn`	`false`	Set to true if you want the connection pool to rollback any pending transaction when a connection is returned.
`autoCommitByDefault`	JDBC driver's default	The default auto-commit state of the connections.
`readOnlyByDefault`	JDBC driver's default	The default read-only state of the connections.
`properties`	none	Any additional JDBC driver parameters.
`defaultCatalog`	none	The default catalog to use for the connections.
`defaultTransactionIsolation`	JDBC driver default	The default transaction isolation to use for the connections. Can be one of `none`, `default`, `read-uncommitted`, `read-committed`, `repeatable-read`, or `serializable`.
`useFairQueue`	`true`	If `true`, calls to `getConnection` are handled in a FIFO manner.
`initialSize`	10	The initial size of the connection pool. May be zero, which will allow you to start the connection pool without requiring the DB to be up. In the latter case the `minSize` must also be set to zero.
`minSize`	10	The minimum size of the connection pool.
`maxSize`	100	The maximum size of the connection pool.
`initializationQuery`	none	A custom query to be run when a connection is first created.
`logAbandonedConnections`	`false`	If `true`, logs stack traces of abandoned connections.
`logValidationErrors`	`false`	If `true`, logs errors when connections fail validation.
`maxConnectionAge`	none	If set, connections which have been open for longer than `maxConnectionAge` are closed when returned.
`maxWaitForConnection`	30 seconds	If a request for a connection is blocked for longer than this period, an exception will be thrown.
`minIdleTime`	1 minute	The minimum amount of time an connection must sit idle in the pool before it is eligible for eviction.
`validationQuery`	`SELECT 1`	The SQL query that will be used to validate connections from this pool before returning them to the caller or pool. If specified, this query does not have to return any data, it just can't throw a SQLException.
`validationQueryTimeout`	none	The timeout before a connection validation queries fail.
`checkConnectionWhileIdle`	`true`	Set to true if query validation should take place while the connection is idle.
`checkConnectionOnBorrow`	`false`	Whether or not connections will be validated before being borrowed from the pool. If the connection fails to validate, it will be dropped from the pool, and another will be borrowed.
`checkConnectionOnConnect`	`true`	Whether or not connections will be validated before being added to the pool. If the connection fails to validate, it won't be added to the pool.
`checkConnectionOnReturn`	`false`	Whether or not connections will be validated after being returned to the pool. If the connection fails to validate, it will be dropped from the pool.
`autoCommentsEnabled`	`true`	Whether or not ORMs should automatically add comments.
`evictionInterval`	5 seconds	The amount of time to sleep between runs of the idle connection validation, abandoned cleaner and idle pool resizing.
`validationInterval`	30 seconds	To avoid excess validation, only run validation once every interval.
`validatorClassName`	(none)	Name of a class of a custom `Validator` implementation, which will be used for validating connections.
`jdbcInterceptors`	(none)	A semicolon separated list of classnames extending `JdbcInterceptor`
`ignoreExceptionOnPreLoad`	`false`	Flag whether ignore error of connection creation while initializing the pool. Set to true if you want to ignore error of connection creation while initializing the pool. Set to false if you want to fail the initialization of the pool by throwing exception.

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class DataSourceFactory.TransactionIsolation

Nested Classes
Modifier and Type	Class and Description
`static class`	`DataSourceFactory.TransactionIsolation`

Constructor Summary

Constructors
Constructor and Description

DataSourceFactory()

Constructors
Constructor and Description
`DataSourceFactory()`

Method Summary

All Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`void`	`asSingleConnectionPool()` Configures the pool as a single connection pool.
`ManagedDataSource`	`build(com.codahale.metrics.MetricRegistry metricRegistry, String name)` Builds a new JDBC data source backed by the connection pool and managed by Dropwizard.
`int`	`getAbandonWhenPercentageFull()`
`Boolean`	`getAutoCommitByDefault()`
`boolean`	`getCheckConnectionOnBorrow()`
`boolean`	`getCheckConnectionOnConnect()`
`boolean`	`getCheckConnectionOnReturn()`
`boolean`	`getCheckConnectionWhileIdle()`
`boolean`	`getCommitOnReturn()`
`String`	`getDefaultCatalog()`
`DataSourceFactory.TransactionIsolation`	`getDefaultTransactionIsolation()`
`String`	`getDriverClass()` Returns the Java class of the database driver.
`Duration`	`getEvictionInterval()`
`String`	`getHealthCheckValidationQuery()` Deprecated. use `getValidationQuery()` instead
`Optional<Duration>`	`getHealthCheckValidationTimeout()` Deprecated. use `getValidationQueryTimeout()` instead
`String`	`getInitializationQuery()`
`int`	`getInitialSize()`
`Optional<String>`	`getJdbcInterceptors()`
`boolean`	`getLogAbandonedConnections()`
`boolean`	`getLogValidationErrors()`
`Optional<Duration>`	`getMaxConnectionAge()`
`int`	`getMaxSize()`
`Duration`	`getMaxWaitForConnection()`
`Duration`	`getMinIdleTime()`
`int`	`getMinSize()`
`String`	`getPassword()`
`Map<String,String>`	`getProperties()` Returns the configuration properties for ORM tools.
`Boolean`	`getReadOnlyByDefault()`
`Duration`	`getRemoveAbandonedTimeout()`
`boolean`	`getRollbackOnReturn()`
`String`	`getUrl()` Returns the JDBC connection URL.
`boolean`	`getUseFairQueue()`
`String`	`getUser()`
`Duration`	`getValidationInterval()`
`Optional<String>`	`getValidationQuery()` Returns the SQL query, which is being used for the database connection health check.
`Optional<Duration>`	`getValidationQueryTimeout()` Returns the timeout for awaiting a response from the database during connection health checks.
`Optional<String>`	`getValidatorClassName()`
`boolean`	`isAlternateUsernamesAllowed()`
`boolean`	`isAutoCommentsEnabled()` Whether ORM tools allowed to add comments to SQL queries.
`boolean`	`isDefaultReadOnly()` Deprecated. use `getReadOnlyByDefault()` instead
`boolean`	`isIgnoreExceptionOnPreLoad()`
`boolean`	`isInitialSizeGreaterThanMinSize()`
`boolean`	`isInitialSizeLessThanMaxSize()`
`boolean`	`isMinSizeLessThanMaxSize()`
`boolean`	`isRemoveAbandoned()`
`void`	`setAbandonWhenPercentageFull(int percentage)`
`void`	`setAlternateUsernamesAllowed(boolean allow)`
`void`	`setAutoCommentsEnabled(boolean autoCommentsEnabled)`
`void`	`setAutoCommitByDefault(Boolean autoCommit)`
`void`	`setCheckConnectionOnBorrow(boolean checkConnectionOnBorrow)`
`void`	`setCheckConnectionOnConnect(boolean checkConnectionOnConnect)`
`void`	`setCheckConnectionOnReturn(boolean checkConnectionOnReturn)`
`void`	`setCheckConnectionWhileIdle(boolean checkConnectionWhileIdle)`
`void`	`setCommitOnReturn(boolean commitOnReturn)`
`void`	`setDefaultCatalog(String defaultCatalog)`
`void`	`setDefaultReadOnly(boolean defaultReadOnly)` Deprecated. use `setReadOnlyByDefault(Boolean)` instead
`void`	`setDefaultTransactionIsolation(DataSourceFactory.TransactionIsolation isolation)`
`void`	`setDriverClass(String driverClass)`
`void`	`setEvictionInterval(Duration interval)`
`void`	`setIgnoreExceptionOnPreLoad(boolean ignoreExceptionOnPreLoad)`
`void`	`setInitializationQuery(String query)`
`void`	`setInitialSize(int initialSize)`
`void`	`setJdbcInterceptors(Optional<String> jdbcInterceptors)`
`void`	`setLogAbandonedConnections(boolean log)`
`void`	`setLogValidationErrors(boolean log)`
`void`	`setMaxConnectionAge(Duration age)`
`void`	`setMaxSize(int maxSize)`
`void`	`setMaxWaitForConnection(Duration maxWaitForConnection)`
`void`	`setMinIdleTime(Duration time)`
`void`	`setMinSize(int minSize)`
`void`	`setPassword(String password)`
`void`	`setProperties(Map<String,String> properties)`
`void`	`setReadOnlyByDefault(Boolean readOnlyByDefault)`
`void`	`setRemoveAbandoned(boolean removeAbandoned)`
`void`	`setRemoveAbandonedTimeout(Duration removeAbandonedTimeout)`
`void`	`setRollbackOnReturn(boolean rollbackOnReturn)`
`void`	`setUrl(String url)`
`void`	`setUseFairQueue(boolean fair)`
`void`	`setUser(String user)`
`void`	`setValidationInterval(Duration validationInterval)`
`void`	`setValidationQuery(String validationQuery)`
`void`	`setValidationQueryTimeout(Duration validationQueryTimeout)`
`void`	`setValidatorClassName(Optional<String> validatorClassName)`

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

Constructor Detail
- DataSourceFactory
```
public DataSourceFactory()
```

Method Detail

isAutoCommentsEnabled
```
public boolean isAutoCommentsEnabled()
```
Description copied from interface: PooledDataSourceFactory

Whether ORM tools allowed to add comments to SQL queries.

Specified by:

isAutoCommentsEnabled in interface PooledDataSourceFactory

Returns:

true, if allowed

setAutoCommentsEnabled

public void setAutoCommentsEnabled(boolean autoCommentsEnabled)

getDriverClass
```
@Nullable
public String getDriverClass()
```
Description copied from interface: PooledDataSourceFactory

Returns the Java class of the database driver.

Specified by:

getDriverClass in interface PooledDataSourceFactory

Returns:

the JDBC driver class as a string

setDriverClass

public void setDriverClass(@Nullable
                           String driverClass)

getUser
```
@Nullable
public String getUser()
```

setUser

public void setUser(@Nullable
                    String user)

getPassword
```
@Nullable
public String getPassword()
```

setPassword

public void setPassword(@Nullable
                        String password)

getUrl
```
public String getUrl()
```
Description copied from interface: PooledDataSourceFactory

Returns the JDBC connection URL.

Specified by:

getUrl in interface PooledDataSourceFactory

Returns:

the JDBC connection URL as a string

setUrl
```
public void setUrl(String url)
```

getProperties
```
public Map<String,String> getProperties()
```
Description copied from interface: PooledDataSourceFactory

Returns the configuration properties for ORM tools.

Specified by:

getProperties in interface PooledDataSourceFactory

Returns:

configuration properties as a map

setProperties

public void setProperties(Map<String,String> properties)

getMaxWaitForConnection

public Duration getMaxWaitForConnection()

setMaxWaitForConnection

public void setMaxWaitForConnection(Duration maxWaitForConnection)

getValidationQuery
```
public Optional<String> getValidationQuery()
```
Description copied from interface: PooledDataSourceFactory

Returns the SQL query, which is being used for the database connection health check.

Specified by:

getValidationQuery in interface PooledDataSourceFactory

Returns:

the SQL query as a string

getHealthCheckValidationQuery
```
@Deprecated
public String getHealthCheckValidationQuery()
```
Deprecated. use getValidationQuery() instead

Description copied from interface: PooledDataSourceFactory

Returns the SQL query, which is being used for the database connection health check.

Specified by:

getHealthCheckValidationQuery in interface PooledDataSourceFactory

Returns:

the SQL query as a string

setValidationQuery

public void setValidationQuery(@Nullable
                               String validationQuery)

getMinSize
```
public int getMinSize()
```

setMinSize
```
public void setMinSize(int minSize)
```

getMaxSize
```
public int getMaxSize()
```

setMaxSize
```
public void setMaxSize(int maxSize)
```

getCheckConnectionWhileIdle

public boolean getCheckConnectionWhileIdle()

setCheckConnectionWhileIdle

public void setCheckConnectionWhileIdle(boolean checkConnectionWhileIdle)

isDefaultReadOnly
```
@Deprecated
public boolean isDefaultReadOnly()
```
Deprecated. use getReadOnlyByDefault() instead

setDefaultReadOnly

@Deprecated
public void setDefaultReadOnly(boolean defaultReadOnly)

Deprecated. use setReadOnlyByDefault(Boolean) instead

isMinSizeLessThanMaxSize

@ValidationMethod(message=".minSize must be less than or equal to maxSize")
public boolean isMinSizeLessThanMaxSize()

isInitialSizeLessThanMaxSize

@ValidationMethod(message=".initialSize must be less than or equal to maxSize")
public boolean isInitialSizeLessThanMaxSize()

isInitialSizeGreaterThanMinSize

@ValidationMethod(message=".initialSize must be greater than or equal to minSize")
public boolean isInitialSizeGreaterThanMinSize()

getAbandonWhenPercentageFull

public int getAbandonWhenPercentageFull()

setAbandonWhenPercentageFull

public void setAbandonWhenPercentageFull(int percentage)

isAlternateUsernamesAllowed

public boolean isAlternateUsernamesAllowed()

setAlternateUsernamesAllowed

public void setAlternateUsernamesAllowed(boolean allow)

getCommitOnReturn
```
public boolean getCommitOnReturn()
```

getRollbackOnReturn
```
public boolean getRollbackOnReturn()
```

setCommitOnReturn

public void setCommitOnReturn(boolean commitOnReturn)

setRollbackOnReturn

public void setRollbackOnReturn(boolean rollbackOnReturn)

getAutoCommitByDefault

@Nullable
public Boolean getAutoCommitByDefault()

setAutoCommitByDefault

public void setAutoCommitByDefault(@Nullable
                                   Boolean autoCommit)

getDefaultCatalog

@Nullable
public String getDefaultCatalog()

setDefaultCatalog

public void setDefaultCatalog(@Nullable
                              String defaultCatalog)

getReadOnlyByDefault

@Nullable
public Boolean getReadOnlyByDefault()

setReadOnlyByDefault

public void setReadOnlyByDefault(@Nullable
                                 Boolean readOnlyByDefault)

getDefaultTransactionIsolation

public DataSourceFactory.TransactionIsolation getDefaultTransactionIsolation()

setDefaultTransactionIsolation

public void setDefaultTransactionIsolation(DataSourceFactory.TransactionIsolation isolation)

getUseFairQueue
```
public boolean getUseFairQueue()
```

setUseFairQueue

public void setUseFairQueue(boolean fair)

getInitialSize
```
public int getInitialSize()
```

setInitialSize

public void setInitialSize(int initialSize)

getInitializationQuery

@Nullable
public String getInitializationQuery()

setInitializationQuery

public void setInitializationQuery(@Nullable
                                   String query)

getLogAbandonedConnections

public boolean getLogAbandonedConnections()

setLogAbandonedConnections

public void setLogAbandonedConnections(boolean log)

getLogValidationErrors

public boolean getLogValidationErrors()

setLogValidationErrors

public void setLogValidationErrors(boolean log)

getMaxConnectionAge

public Optional<Duration> getMaxConnectionAge()

setMaxConnectionAge

public void setMaxConnectionAge(@Nullable
                                Duration age)

getMinIdleTime
```
public Duration getMinIdleTime()
```

setMinIdleTime

public void setMinIdleTime(Duration time)

getCheckConnectionOnBorrow

public boolean getCheckConnectionOnBorrow()

setCheckConnectionOnBorrow

public void setCheckConnectionOnBorrow(boolean checkConnectionOnBorrow)

getCheckConnectionOnConnect

public boolean getCheckConnectionOnConnect()

setCheckConnectionOnConnect

public void setCheckConnectionOnConnect(boolean checkConnectionOnConnect)

getCheckConnectionOnReturn

public boolean getCheckConnectionOnReturn()

setCheckConnectionOnReturn

public void setCheckConnectionOnReturn(boolean checkConnectionOnReturn)

getEvictionInterval
```
public Duration getEvictionInterval()
```

setEvictionInterval

public void setEvictionInterval(Duration interval)

getValidationInterval

public Duration getValidationInterval()

setValidationInterval

public void setValidationInterval(Duration validationInterval)

getValidationQueryTimeout
```
public Optional<Duration> getValidationQueryTimeout()
```
Description copied from interface: PooledDataSourceFactory

Returns the timeout for awaiting a response from the database during connection health checks.

Specified by:

getValidationQueryTimeout in interface PooledDataSourceFactory

Returns:

the timeout as Duration

getValidatorClassName

public Optional<String> getValidatorClassName()

setValidatorClassName

public void setValidatorClassName(Optional<String> validatorClassName)

getHealthCheckValidationTimeout
```
@Deprecated
public Optional<Duration> getHealthCheckValidationTimeout()
```
Deprecated. use getValidationQueryTimeout() instead

Description copied from interface: PooledDataSourceFactory

Returns the timeout for awaiting a response from the database during connection health checks.

Specified by:

getHealthCheckValidationTimeout in interface PooledDataSourceFactory

Returns:

the timeout as Duration

setValidationQueryTimeout

public void setValidationQueryTimeout(@Nullable
                                      Duration validationQueryTimeout)

isRemoveAbandoned
```
public boolean isRemoveAbandoned()
```

setRemoveAbandoned

public void setRemoveAbandoned(boolean removeAbandoned)

getRemoveAbandonedTimeout

public Duration getRemoveAbandonedTimeout()

setRemoveAbandonedTimeout

public void setRemoveAbandonedTimeout(Duration removeAbandonedTimeout)

getJdbcInterceptors

public Optional<String> getJdbcInterceptors()

setJdbcInterceptors

public void setJdbcInterceptors(Optional<String> jdbcInterceptors)

isIgnoreExceptionOnPreLoad

public boolean isIgnoreExceptionOnPreLoad()

setIgnoreExceptionOnPreLoad

public void setIgnoreExceptionOnPreLoad(boolean ignoreExceptionOnPreLoad)

asSingleConnectionPool
```
public void asSingleConnectionPool()
```
Description copied from interface: PooledDataSourceFactory

Configures the pool as a single connection pool. It's useful for tools that use only one database connection, such as database migrations.

Specified by:

asSingleConnectionPool in interface PooledDataSourceFactory

build
```
public ManagedDataSource build(com.codahale.metrics.MetricRegistry metricRegistry,
                               String name)
```
Description copied from interface: PooledDataSourceFactory

Builds a new JDBC data source backed by the connection pool and managed by Dropwizard.

Specified by:

build in interface PooledDataSourceFactory

Parameters:

metricRegistry - the application metric registry

name - name of the connection pool

Returns:

a new JDBC data source as ManagedDataSource

Class DataSourceFactory

Nested Class Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

DataSourceFactory

Method Detail

isAutoCommentsEnabled

setAutoCommentsEnabled

getDriverClass

setDriverClass

getUser

setUser

getPassword

setPassword

getUrl

setUrl

getProperties

setProperties

getMaxWaitForConnection

setMaxWaitForConnection

getValidationQuery

getHealthCheckValidationQuery

setValidationQuery

getMinSize

setMinSize

getMaxSize

setMaxSize

getCheckConnectionWhileIdle

setCheckConnectionWhileIdle

isDefaultReadOnly

setDefaultReadOnly

isMinSizeLessThanMaxSize

isInitialSizeLessThanMaxSize

isInitialSizeGreaterThanMinSize

getAbandonWhenPercentageFull

setAbandonWhenPercentageFull

isAlternateUsernamesAllowed

setAlternateUsernamesAllowed

getCommitOnReturn

getRollbackOnReturn

setCommitOnReturn

setRollbackOnReturn

getAutoCommitByDefault

setAutoCommitByDefault

getDefaultCatalog

setDefaultCatalog

getReadOnlyByDefault

setReadOnlyByDefault

getDefaultTransactionIsolation

setDefaultTransactionIsolation

getUseFairQueue

setUseFairQueue

getInitialSize

setInitialSize

getInitializationQuery

setInitializationQuery

getLogAbandonedConnections

setLogAbandonedConnections

getLogValidationErrors

setLogValidationErrors

getMaxConnectionAge

setMaxConnectionAge

getMinIdleTime

setMinIdleTime

getCheckConnectionOnBorrow

setCheckConnectionOnBorrow

getCheckConnectionOnConnect

setCheckConnectionOnConnect

getCheckConnectionOnReturn

setCheckConnectionOnReturn

getEvictionInterval

setEvictionInterval

getValidationInterval

setValidationInterval

getValidationQueryTimeout

getValidatorClassName

setValidatorClassName

getHealthCheckValidationTimeout