io.dropwizard.db

Class DataSourceFactory

java.lang.Object

io.dropwizard.db.DataSourceFactory

public class DataSourceFactory
extends Object

A factory for pooled ManagedDataSources.

Configuration Parameters:

Name	Default	Description
driverClass	REQUIRED	The full name of the JDBC driver class.
url	REQUIRED	The URL of the server.
user	REQUIRED	The username used to connect to the server.
password	none	The password used to connect to the server.
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.
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.
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	false	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.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	DataSourceFactory.TransactionIsolation

Constructor Summary

Constructors

Constructor and Description
DataSourceFactory()

Method Summary

Methods

Modifier and Type	Method and Description
ManagedDataSource	build(com.codahale.metrics.MetricRegistry metricRegistry, String name)
int	getAbandonWhenPercentageFull()
Boolean	getAutoCommitByDefault()
boolean	getCheckConnectionOnBorrow()
boolean	getCheckConnectionOnConnect()
boolean	getCheckConnectionOnReturn()
boolean	getCheckConnectionWhileIdle()
boolean	getCommitOnReturn()
String	getDefaultCatalog()
DataSourceFactory.TransactionIsolation	getDefaultTransactionIsolation()
String	getDriverClass()
io.dropwizard.util.Duration	getEvictionInterval()
String	getInitializationQuery()
int	getInitialSize()
boolean	getLogAbandonedConnections()
boolean	getLogValidationErrors()
com.google.common.base.Optional<io.dropwizard.util.Duration>	getMaxConnectionAge()
int	getMaxSize()
io.dropwizard.util.Duration	getMaxWaitForConnection()
io.dropwizard.util.Duration	getMinIdleTime()
int	getMinSize()
String	getPassword()
Map<String,String>	getProperties()
Boolean	getReadOnlyByDefault()
String	getUrl()
boolean	getUseFairQueue()
String	getUser()
io.dropwizard.util.Duration	getValidationInterval()
String	getValidationQuery()
com.google.common.base.Optional<io.dropwizard.util.Duration>	getValidationQueryTimeout()
boolean	isAlternateUsernamesAllowed()
boolean	isAutoCommentsEnabled()
boolean	isDefaultReadOnly() Deprecated.
boolean	isInitialSizeGreaterThanMinSize()
boolean	isInitialSizeLessThanMaxSize()
boolean	isMinSizeLessThanMaxSize()
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.
void	setDefaultTransactionIsolation(DataSourceFactory.TransactionIsolation isolation)
void	setDriverClass(String driverClass)
void	setEvictionInterval(io.dropwizard.util.Duration interval)
void	setInitializationQuery(String query)
void	setInitialSize(int initialSize)
void	setLogAbandonedConnections(boolean log)
void	setLogValidationErrors(boolean log)
void	setMaxConnectionAge(io.dropwizard.util.Duration age)
void	setMaxSize(int maxSize)
void	setMaxWaitForConnection(io.dropwizard.util.Duration maxWaitForConnection)
void	setMinIdleTime(io.dropwizard.util.Duration time)
void	setMinSize(int minSize)
void	setPassword(String password)
void	setProperties(Map<String,String> properties)
void	setReadOnlyByDefault(Boolean readOnlyByDefault)
void	setUrl(String url)
void	setUseFairQueue(boolean fair)
void	setUser(String user)
void	setValidationInterval(io.dropwizard.util.Duration validationInterval)
void	setValidationQuery(String validationQuery)
void	setValidationQueryTimeout(io.dropwizard.util.Duration validationQueryTimeout)

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()

setAutoCommentsEnabled

public void setAutoCommentsEnabled(boolean autoCommentsEnabled)

getDriverClass

public String getDriverClass()

setDriverClass

public void setDriverClass(String driverClass)

getUser

public String getUser()

setUser

public void setUser(String user)

getPassword

public String getPassword()

setPassword

public void setPassword(String password)

getUrl

public String getUrl()

setUrl

public void setUrl(String url)

getProperties

public Map<String,String> getProperties()

setProperties

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

getMaxWaitForConnection

public io.dropwizard.util.Duration getMaxWaitForConnection()

setMaxWaitForConnection

public void setMaxWaitForConnection(io.dropwizard.util.Duration maxWaitForConnection)

getValidationQuery

public String getValidationQuery()

setValidationQuery

public void setValidationQuery(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.

setDefaultReadOnly

@Deprecated
public void setDefaultReadOnly(boolean defaultReadOnly)

Deprecated.

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()

setCommitOnReturn

public void setCommitOnReturn(boolean commitOnReturn)

getAutoCommitByDefault

public Boolean getAutoCommitByDefault()

setAutoCommitByDefault

public void setAutoCommitByDefault(Boolean autoCommit)

getDefaultCatalog

public String getDefaultCatalog()

setDefaultCatalog

public void setDefaultCatalog(String defaultCatalog)

getReadOnlyByDefault

public Boolean getReadOnlyByDefault()

setReadOnlyByDefault

public void setReadOnlyByDefault(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

public String getInitializationQuery()

setInitializationQuery

public void setInitializationQuery(String query)

getLogAbandonedConnections

public boolean getLogAbandonedConnections()

setLogAbandonedConnections

public void setLogAbandonedConnections(boolean log)

getLogValidationErrors

public boolean getLogValidationErrors()

setLogValidationErrors

public void setLogValidationErrors(boolean log)

getMaxConnectionAge

public com.google.common.base.Optional<io.dropwizard.util.Duration> getMaxConnectionAge()

setMaxConnectionAge

public void setMaxConnectionAge(io.dropwizard.util.Duration age)

getMinIdleTime

public io.dropwizard.util.Duration getMinIdleTime()

setMinIdleTime

public void setMinIdleTime(io.dropwizard.util.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 io.dropwizard.util.Duration getEvictionInterval()

setEvictionInterval

public void setEvictionInterval(io.dropwizard.util.Duration interval)

getValidationInterval

public io.dropwizard.util.Duration getValidationInterval()

setValidationInterval

public void setValidationInterval(io.dropwizard.util.Duration validationInterval)

getValidationQueryTimeout

public com.google.common.base.Optional<io.dropwizard.util.Duration> getValidationQueryTimeout()

setValidationQueryTimeout

public void setValidationQueryTimeout(io.dropwizard.util.Duration validationQueryTimeout)

build

public ManagedDataSource build(com.codahale.metrics.MetricRegistry metricRegistry,
                      String name)