com.avaje.ebean.config

Class DataSourceConfig

java.lang.Object

com.avaje.ebean.config.DataSourceConfig

public class DataSourceConfig
extends Object

Used to config a DataSource when using the internal Ebean DataSource implementation.

If a DataSource instance is already defined via ServerConfig.setDataSource(javax.sql.DataSource) or defined as JNDI dataSource via ServerConfig.setDataSourceJndiName(String) then those will used and not this DataSourceConfig.

Field Summary

Fields

Modifier and Type	Field and Description
protected Map<String,String>	customProperties

Constructor Summary

Constructors

Constructor and Description
DataSourceConfig()

Method Summary

Methods

Modifier and Type	Method and Description
int	getCstmtCacheSize() Return the size of the CallableStatement cache (per connection).
Map<String,String>	getCustomProperties() Return a map of custom properties for the jdbc driver connection.
String	getDriver() Return the database driver.
int	getHeartbeatFreqSecs() Return the heartbeat frequency in seconds.
String	getHeartbeatSql() Return a SQL statement used to test the database is accessible.
int	getHeartbeatTimeoutSeconds() Return the heart beat timeout in seconds.
int	getIsolationLevel() Return the transaction isolation level.
int	getLeakTimeMinutes() Return the time in minutes after which a connection could be considered to have leaked.
int	getMaxAgeMinutes() Return the maximum age a connection is allowed to be before it is closed.
int	getMaxConnections() Return the maximum number of connections the pool can reach.
int	getMaxInactiveTimeSecs() Return the time in seconds a connection can be idle after which it can be trimmed from the pool.
int	getMaxStackTraceSize() Return the max size for reporting stack traces on busy connections.
int	getMinConnections() Return the minimum number of connections the pool should maintain.
String	getPassword() Return the database password.
String	getPoolListener() Return the pool listener.
int	getPstmtCacheSize() Return the size of the PreparedStatement cache (per connection).
int	getTransactionIsolationLevel(String level) return the isolation level for a given string description.
int	getTrimPoolFreqSecs() Return the minimum time gap between pool trim checks.
String	getUrl() Return the connection URL.
String	getUsername() Return the database username.
int	getWaitTimeoutMillis() Return the time in millis to wait for a connection before timing out once the pool has reached its maximum size.
boolean	isCaptureStackTrace() Return true if a stack trace should be captured when obtaining a connection from the pool.
boolean	isOffline() Return true if the DataSource should be left offline.
void	loadSettings(String serverName)
void	loadSettingsCustomPrefix(String prefix, GlobalProperties.PropertySource properties) Load the settings from ebean.properties.
void	setCaptureStackTrace(boolean captureStackTrace) Set to true if a stack trace should be captured when obtaining a connection from the pool.
void	setCstmtCacheSize(int cstmtCacheSize) Set the size of the CallableStatement cache (per connection).
void	setCustomProperties(Map<String,String> customProperties) Set custom properties for the jdbc driver connection.
void	setDriver(String driver) Set the database driver.
void	setHeartbeatFreqSecs(int heartbeatFreqSecs) Set the expected heartbeat frequency in seconds.
void	setHeartbeatSql(String heartbeatSql) Set a SQL statement used to test the database is accessible.
void	setHeartbeatTimeoutSeconds(int heartbeatTimeoutSeconds) Set the heart beat timeout in seconds.
void	setIsolationLevel(int isolationLevel) Set the transaction isolation level.
void	setLeakTimeMinutes(int leakTimeMinutes) Set the time in minutes after which a connection could be considered to have leaked.
void	setMaxAgeMinutes(int maxAgeMinutes) Set the maximum age a connection can be in minutes.
void	setMaxConnections(int maxConnections) Set the maximum number of connections the pool can reach.
void	setMaxInactiveTimeSecs(int maxInactiveTimeSecs) Set the time in seconds a connection can be idle after which it can be trimmed from the pool.
void	setMaxStackTraceSize(int maxStackTraceSize) Set the max size for reporting stack traces on busy connections.
void	setMinConnections(int minConnections) Set the minimum number of connections the pool should maintain.
void	setOffline(boolean offline) Set to true if the DataSource should be left offline.
void	setPassword(String password) Set the database password.
void	setPoolListener(String poolListener) Set a pool listener.
void	setPstmtCacheSize(int pstmtCacheSize) Set the size of the PreparedStatement cache (per connection).
void	setTrimPoolFreqSecs(int trimPoolFreqSecs) Set the minimum trim gap between pool trim checks.
void	setUrl(String url) Set the connection URL.
void	setUsername(String username) Set the database username.
void	setWaitTimeoutMillis(int waitTimeoutMillis) Set the time in millis to wait for a connection before timing out once the pool has reached its maximum size.

Methods inherited from class java.lang.Object

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

Field Detail

customProperties

protected Map<String,String> customProperties

Constructor Detail

DataSourceConfig

public DataSourceConfig()

Method Detail

getUrl

public String getUrl()

Return the connection URL.

setUrl

public void setUrl(String url)

Set the connection URL.

getUsername

public String getUsername()

Return the database username.

setUsername

public void setUsername(String username)

Set the database username.

getPassword

public String getPassword()

Return the database password.

setPassword

public void setPassword(String password)

Set the database password.

getDriver

public String getDriver()

Return the database driver.

setDriver

public void setDriver(String driver)

Set the database driver.

getIsolationLevel

public int getIsolationLevel()

Return the transaction isolation level.

setIsolationLevel

public void setIsolationLevel(int isolationLevel)

Set the transaction isolation level.

getMinConnections

public int getMinConnections()

Return the minimum number of connections the pool should maintain.

setMinConnections

public void setMinConnections(int minConnections)

Set the minimum number of connections the pool should maintain.

getMaxConnections

public int getMaxConnections()

Return the maximum number of connections the pool can reach.

setMaxConnections

public void setMaxConnections(int maxConnections)

Set the maximum number of connections the pool can reach.

getHeartbeatSql

public String getHeartbeatSql()

Return a SQL statement used to test the database is accessible.

Note that if this is not set then it can get defaulted from the DatabasePlatform.

setHeartbeatSql

public void setHeartbeatSql(String heartbeatSql)

Set a SQL statement used to test the database is accessible.

Note that if this is not set then it can get defaulted from the DatabasePlatform.

getHeartbeatFreqSecs

public int getHeartbeatFreqSecs()

Return the heartbeat frequency in seconds.

This is the expected frequency in which the DataSource should be checked to make sure it is healthy and trim idle connections.

setHeartbeatFreqSecs

public void setHeartbeatFreqSecs(int heartbeatFreqSecs)

Set the expected heartbeat frequency in seconds.

getHeartbeatTimeoutSeconds

public int getHeartbeatTimeoutSeconds()

Return the heart beat timeout in seconds.

setHeartbeatTimeoutSeconds

public void setHeartbeatTimeoutSeconds(int heartbeatTimeoutSeconds)

Set the heart beat timeout in seconds.

isCaptureStackTrace

public boolean isCaptureStackTrace()

Return true if a stack trace should be captured when obtaining a connection from the pool.

This can be used to diagnose a suspected connection pool leak.

Obviously this has a performance overhead.

setCaptureStackTrace

public void setCaptureStackTrace(boolean captureStackTrace)

Set to true if a stack trace should be captured when obtaining a connection from the pool.

This can be used to diagnose a suspected connection pool leak.

Obviously this has a performance overhead.

getMaxStackTraceSize

public int getMaxStackTraceSize()

Return the max size for reporting stack traces on busy connections.

setMaxStackTraceSize

public void setMaxStackTraceSize(int maxStackTraceSize)

Set the max size for reporting stack traces on busy connections.

getLeakTimeMinutes

public int getLeakTimeMinutes()

Return the time in minutes after which a connection could be considered to have leaked.

setLeakTimeMinutes

public void setLeakTimeMinutes(int leakTimeMinutes)

Set the time in minutes after which a connection could be considered to have leaked.

getPstmtCacheSize

public int getPstmtCacheSize()

Return the size of the PreparedStatement cache (per connection).

setPstmtCacheSize

public void setPstmtCacheSize(int pstmtCacheSize)

Set the size of the PreparedStatement cache (per connection).

getCstmtCacheSize

public int getCstmtCacheSize()

Return the size of the CallableStatement cache (per connection).

setCstmtCacheSize

public void setCstmtCacheSize(int cstmtCacheSize)

Set the size of the CallableStatement cache (per connection).

getWaitTimeoutMillis

public int getWaitTimeoutMillis()

Return the time in millis to wait for a connection before timing out once the pool has reached its maximum size.

setWaitTimeoutMillis

public void setWaitTimeoutMillis(int waitTimeoutMillis)

Set the time in millis to wait for a connection before timing out once the pool has reached its maximum size.

getMaxInactiveTimeSecs

public int getMaxInactiveTimeSecs()

Return the time in seconds a connection can be idle after which it can be trimmed from the pool.

This is so that the pool after a busy period can trend over time back towards the minimum connections.

getMaxAgeMinutes

public int getMaxAgeMinutes()

Return the maximum age a connection is allowed to be before it is closed.

This can be used to close really old connections.

setMaxAgeMinutes

public void setMaxAgeMinutes(int maxAgeMinutes)

Set the maximum age a connection can be in minutes.

setMaxInactiveTimeSecs

public void setMaxInactiveTimeSecs(int maxInactiveTimeSecs)

Set the time in seconds a connection can be idle after which it can be trimmed from the pool.

This is so that the pool after a busy period can trend over time back towards the minimum connections.

getTrimPoolFreqSecs

public int getTrimPoolFreqSecs()

Return the minimum time gap between pool trim checks.

This defaults to 59 seconds meaning that the pool trim check will run every minute assuming the heart beat check runs every 30 seconds.

setTrimPoolFreqSecs

public void setTrimPoolFreqSecs(int trimPoolFreqSecs)

Set the minimum trim gap between pool trim checks.

getPoolListener

public String getPoolListener()

Return the pool listener.

setPoolListener

public void setPoolListener(String poolListener)

Set a pool listener.

isOffline

public boolean isOffline()

Return true if the DataSource should be left offline.

This is to support DDL generation etc without having a real database.

setOffline

public void setOffline(boolean offline)

Set to true if the DataSource should be left offline.

This is to support DDL generation etc without having a real database.

Note that you MUST specify the database platform name (oracle, postgres, h2, mysql etc) using ServerConfig.setDatabasePlatformName(String) when you do this.

getCustomProperties

public Map<String,String> getCustomProperties()

Return a map of custom properties for the jdbc driver connection.

setCustomProperties

public void setCustomProperties(Map<String,String> customProperties)

Set custom properties for the jdbc driver connection.

Parameters:

customProperties -

loadSettings

public void loadSettings(String serverName)

loadSettingsCustomPrefix

public void loadSettingsCustomPrefix(String prefix,
                            GlobalProperties.PropertySource properties)

Load the settings from ebean.properties.

getTransactionIsolationLevel

public int getTransactionIsolationLevel(String level)

return the isolation level for a given string description.