DataSourceConfig (ebean-datasource-api 4.6 API)

java.lang.Object
- io.ebean.datasource.DataSourceConfig

public class DataSourceConfig
extends Object

Configuration information for a DataSource.

Constructor Summary

Constructors
Constructor and Description

DataSourceConfig()

Constructors
Constructor and Description
`DataSourceConfig()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`DataSourceConfig`	`copy()` Return a copy of the DataSourceConfig.
`DataSourceAlert`	`getAlert()` Return the alert implementation to use.
`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.
`InitDatabase`	`getInitDatabase()` Return the InitDatabase to use with ownerUsername.
`List<String>`	`getInitSql()` Return a list of init queries, that are executed after a connection is opened.
`int`	`getIsolationLevel()` Return the transaction isolation level.
`int`	`getLeakTimeMinutes()` Return the time in minutes after which a connection could be considered to have leaked.
`DataSourcePoolListener`	`getListener()` Return the listener to use.
`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`	`getOwnerPassword()` Return the database owner password.
`String`	`getOwnerUsername()` Return the database owner username.
`String`	`getPassword()` Return the database password.
`String`	`getPlatform()` Return the database platform.
`String`	`getPoolListener()` Return the pool listener.
`int`	`getPstmtCacheSize()` Return the size of the PreparedStatement cache (per connection).
`String`	`getSchema()` Return the database username.
`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`	`isAutoCommit()` Return autoCommit setting.
`boolean`	`isCaptureStackTrace()` Return true if a stack trace should be captured when obtaining a connection from the pool.
`boolean`	`isEmpty()` Return true if there are no values set for any of url, driver, username and password.
`boolean`	`isFailOnStart()` Return true (default) if the DataSource should be fail on start.
`boolean`	`isOffline()` Return true if the DataSource should be left offline.
`boolean`	`isReadOnly()` Return the read only setting.
`DataSourceConfig`	`loadSettings(Properties properties, String serverName)` Load the settings from the properties supplied.
`DataSourceConfig`	`setAlert(DataSourceAlert alert)` Set the alert implementation to use.
`DataSourceConfig`	`setAutoCommit(boolean autoCommit)` Set to true to turn on autoCommit.
`DataSourceConfig`	`setCaptureStackTrace(boolean captureStackTrace)` Set to true if a stack trace should be captured when obtaining a connection from the pool.
`DataSourceConfig`	`setCstmtCacheSize(int cstmtCacheSize)` Set the size of the CallableStatement cache (per connection).
`DataSourceConfig`	`setCustomProperties(Map<String,String> customProperties)` Set custom properties for the jdbc driver connection.
`DataSourceConfig`	`setDefaults(DataSourceConfig other)` Default the values for driver, url, username and password from another config if they have not been set.
`DataSourceConfig`	`setDriver(String driver)` Set the database driver.
`DataSourceConfig`	`setFailOnStart(boolean failOnStart)` Set to false, if DataSource should not fail on start.
`DataSourceConfig`	`setHeartbeatFreqSecs(int heartbeatFreqSecs)` Set the expected heartbeat frequency in seconds.
`DataSourceConfig`	`setHeartbeatSql(String heartbeatSql)` Set a SQL statement used to test the database is accessible.
`DataSourceConfig`	`setHeartbeatTimeoutSeconds(int heartbeatTimeoutSeconds)` Set the heart beat timeout in seconds.
`DataSourceConfig`	`setInitDatabase(InitDatabase initDatabase)` Set the InitDatabase to use with ownerUsername.
`DataSourceConfig`	`setInitDatabaseForPlatform(String platform)` Set InitDatabase based on the database platform.
`DataSourceConfig`	`setInitSql(List<String> initSql)` Set custom init queries for each query.
`DataSourceConfig`	`setIsolationLevel(int isolationLevel)` Set the transaction isolation level.
`DataSourceConfig`	`setLeakTimeMinutes(int leakTimeMinutes)` Set the time in minutes after which a connection could be considered to have leaked.
`DataSourceConfig`	`setListener(DataSourcePoolListener listener)` Set the listener to use.
`DataSourceConfig`	`setMaxAgeMinutes(int maxAgeMinutes)` Set the maximum age a connection can be in minutes.
`DataSourceConfig`	`setMaxConnections(int maxConnections)` Set the maximum number of connections the pool can reach.
`DataSourceConfig`	`setMaxInactiveTimeSecs(int maxInactiveTimeSecs)` Set the time in seconds a connection can be idle after which it can be trimmed from the pool.
`DataSourceConfig`	`setMaxStackTraceSize(int maxStackTraceSize)` Set the max size for reporting stack traces on busy connections.
`DataSourceConfig`	`setMinConnections(int minConnections)` Set the minimum number of connections the pool should maintain.
`DataSourceConfig`	`setOffline(boolean offline)` Set to true if the DataSource should be left offline.
`DataSourceConfig`	`setOwnerPassword(String ownerPassword)` Set the database owner password (used to create connection for use with InitDatabase).
`DataSourceConfig`	`setOwnerUsername(String ownerUsername)` Set the database owner username (used to create connection for use with InitDatabase).
`DataSourceConfig`	`setPassword(String password)` Set the database password.
`DataSourceConfig`	`setPlatform(String platform)` Set the database platform (for use with ownerUsername and InitDatabase.
`DataSourceConfig`	`setPoolListener(String poolListener)` Set a pool listener.
`DataSourceConfig`	`setPstmtCacheSize(int pstmtCacheSize)` Set the size of the PreparedStatement cache (per connection).
`DataSourceConfig`	`setReadOnly(boolean readOnly)` Set to true to for read only.
`DataSourceConfig`	`setSchema(String schema)` Set the default database schema to use.
`DataSourceConfig`	`setTrimPoolFreqSecs(int trimPoolFreqSecs)` Set the minimum trim gap between pool trim checks.
`DataSourceConfig`	`setUrl(String url)` Set the connection URL.
`DataSourceConfig`	`setUsername(String username)` Set the database username.
`DataSourceConfig`	`setWaitTimeoutMillis(int waitTimeoutMillis)` Set the time in millis to wait for a connection before timing out once the pool has reached its maximum size.
`boolean`	`useInitDatabase()` Return true if InitDatabase should be used (when the pool initialises and a connection can't be obtained).

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

- Constructor Detail
  - DataSourceConfig
```
public DataSourceConfig()
```
- Method Detail
  - copy
```
public DataSourceConfig copy()
```
    Return a copy of the DataSourceConfig.
  - setDefaults
```
public DataSourceConfig setDefaults(DataSourceConfig other)
```
    Default the values for driver, url, username and password from another config if they have not been set.
  - isEmpty
```
public boolean isEmpty()
```
    Return true if there are no values set for any of url, driver, username and password.
  - getUrl
```
public String getUrl()
```
    Return the connection URL.
  - setUrl
```
public DataSourceConfig setUrl(String url)
```
    Set the connection URL.
  - getUsername
```
public String getUsername()
```
    Return the database username.
  - setUsername
```
public DataSourceConfig setUsername(String username)
```
    Set the database username.
  - getPassword
```
public String getPassword()
```
    Return the database password.
  - setPassword
```
public DataSourceConfig setPassword(String password)
```
    Set the database password.
  - getSchema
```
public String getSchema()
```
    Return the database username.
  - setSchema
```
public DataSourceConfig setSchema(String schema)
```
    Set the default database schema to use.
  - getDriver
```
public String getDriver()
```
    Return the database driver.
  - setDriver
```
public DataSourceConfig setDriver(String driver)
```
    Set the database driver.
  - getIsolationLevel
```
public int getIsolationLevel()
```
    Return the transaction isolation level.
  - setIsolationLevel
```
public DataSourceConfig setIsolationLevel(int isolationLevel)
```
    Set the transaction isolation level.
  - isAutoCommit
```
public boolean isAutoCommit()
```
    Return autoCommit setting.
  - setAutoCommit
```
public DataSourceConfig setAutoCommit(boolean autoCommit)
```
    Set to true to turn on autoCommit.
  - isReadOnly
```
public boolean isReadOnly()
```
    Return the read only setting.
  - setReadOnly
```
public DataSourceConfig setReadOnly(boolean readOnly)
```
    Set to true to for read only.
  - getMinConnections
```
public int getMinConnections()
```
    Return the minimum number of connections the pool should maintain.
  - setMinConnections
```
public DataSourceConfig 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 DataSourceConfig setMaxConnections(int maxConnections)
```
    Set the maximum number of connections the pool can reach.
  - getAlert
```
public DataSourceAlert getAlert()
```
    Return the alert implementation to use.
  - setAlert
```
public DataSourceConfig setAlert(DataSourceAlert alert)
```
    Set the alert implementation to use.
  - getListener
```
public DataSourcePoolListener getListener()
```
    Return the listener to use.
  - setListener
```
public DataSourceConfig setListener(DataSourcePoolListener listener)
```
    Set the listener to use.
  - 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 DataSourceConfig 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 DataSourceConfig setHeartbeatFreqSecs(int heartbeatFreqSecs)
```
    Set the expected heartbeat frequency in seconds.
  - getHeartbeatTimeoutSeconds
```
public int getHeartbeatTimeoutSeconds()
```
    Return the heart beat timeout in seconds.
  - setHeartbeatTimeoutSeconds
```
public DataSourceConfig 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 DataSourceConfig 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 DataSourceConfig 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 DataSourceConfig 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 DataSourceConfig 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 DataSourceConfig 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 DataSourceConfig 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 DataSourceConfig setMaxAgeMinutes(int maxAgeMinutes)
```
    Set the maximum age a connection can be in minutes.
  - setMaxInactiveTimeSecs
```
public DataSourceConfig 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 DataSourceConfig setTrimPoolFreqSecs(int trimPoolFreqSecs)
```
    Set the minimum trim gap between pool trim checks.
  - getPoolListener
```
public String getPoolListener()
```
    Return the pool listener.
  - setPoolListener
```
public DataSourceConfig 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.
  - isFailOnStart
```
public boolean isFailOnStart()
```
    Return true (default) if the DataSource should be fail on start.
    This enables to initialize the Ebean-Server if the db-server is not yet up. (DataSourceAlert.dataSourceUp(javax.sql.DataSource) is fired when DS gets up later.)
  - setFailOnStart
```
public DataSourceConfig setFailOnStart(boolean failOnStart)
```
    Set to false, if DataSource should not fail on start. (e.g. DataSource is not available)
  - setOffline
```
public DataSourceConfig setOffline(boolean offline)
```
    Set to true if the DataSource should be left offline.
  - getCustomProperties
```
public Map<String,String> getCustomProperties()
```
    Return a map of custom properties for the jdbc driver connection.
  - getInitSql
```
public List<String> getInitSql()
```
    Return a list of init queries, that are executed after a connection is opened.
  - setInitSql
```
public DataSourceConfig setInitSql(List<String> initSql)
```
    Set custom init queries for each query.
  - setCustomProperties
```
public DataSourceConfig setCustomProperties(Map<String,String> customProperties)
```
    Set custom properties for the jdbc driver connection.
  - getOwnerUsername
```
public String getOwnerUsername()
```
    Return the database owner username.
  - setOwnerUsername
```
public DataSourceConfig setOwnerUsername(String ownerUsername)
```
    Set the database owner username (used to create connection for use with InitDatabase).
  - getOwnerPassword
```
public String getOwnerPassword()
```
    Return the database owner password.
  - setOwnerPassword
```
public DataSourceConfig setOwnerPassword(String ownerPassword)
```
    Set the database owner password (used to create connection for use with InitDatabase).
  - getPlatform
```
public String getPlatform()
```
    Return the database platform.
  - setPlatform
```
public DataSourceConfig setPlatform(String platform)
```
    Set the database platform (for use with ownerUsername and InitDatabase.
  - getInitDatabase
```
public InitDatabase getInitDatabase()
```
    Return the InitDatabase to use with ownerUsername.
  - setInitDatabase
```
public DataSourceConfig setInitDatabase(InitDatabase initDatabase)
```
    Set the InitDatabase to use with ownerUsername.
  - setInitDatabaseForPlatform
```
public DataSourceConfig setInitDatabaseForPlatform(String platform)
```
    Set InitDatabase based on the database platform.
  - useInitDatabase
```
public boolean useInitDatabase()
```
    Return true if InitDatabase should be used (when the pool initialises and a connection can't be obtained).
    
    Returns:
    
    True to obtain a connection using ownerUsername and run InitDatabase.
  - loadSettings
```
public DataSourceConfig loadSettings(Properties properties,
                                     String serverName)
```
    Load the settings from the properties supplied.
    You can use this when you have your own properties to use for configuration.
    
    Parameters:
    
    properties - the properties to configure the dataSource
    
    serverName - the name of the specific dataSource (optional)

Class DataSourceConfig

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

DataSourceConfig

Method Detail

copy

setDefaults

isEmpty

getUrl

setUrl

getUsername

setUsername

getPassword

setPassword

getSchema

setSchema

getDriver

setDriver

getIsolationLevel

setIsolationLevel

isAutoCommit

setAutoCommit

isReadOnly

setReadOnly

getMinConnections

setMinConnections

getMaxConnections

setMaxConnections

getAlert

setAlert

getListener

setListener

getHeartbeatSql

setHeartbeatSql

getHeartbeatFreqSecs

setHeartbeatFreqSecs

getHeartbeatTimeoutSeconds

setHeartbeatTimeoutSeconds

isCaptureStackTrace

setCaptureStackTrace

getMaxStackTraceSize

setMaxStackTraceSize

getLeakTimeMinutes

setLeakTimeMinutes

getPstmtCacheSize

setPstmtCacheSize

getCstmtCacheSize

setCstmtCacheSize

getWaitTimeoutMillis

setWaitTimeoutMillis

getMaxInactiveTimeSecs

getMaxAgeMinutes

setMaxAgeMinutes

setMaxInactiveTimeSecs

getTrimPoolFreqSecs

setTrimPoolFreqSecs

getPoolListener

setPoolListener

isOffline

isFailOnStart

setFailOnStart

setOffline

getCustomProperties

getInitSql

setInitSql

setCustomProperties

getOwnerUsername

setOwnerUsername

getOwnerPassword

setOwnerPassword

getPlatform

setPlatform

getInitDatabase

setInitDatabase

setInitDatabaseForPlatform

useInitDatabase

loadSettings