C D G I L O P R S U

C

copy() - Method in class io.ebean.datasource.DataSourceConfig

Return a copy of the DataSourceConfig.

create(String, DataSourceConfig) - Static method in interface io.ebean.datasource.DataSourceFactory

Create the DataSourcePool given the name and configuration.

createAlert() - Method in interface io.ebean.datasource.DataSourceAlertFactory

Create a DataSourceAlert for notifications when DataSource down and up are detected.

createPool(String, DataSourceConfig) - Method in interface io.ebean.datasource.DataSourceFactory

Create the DataSourcePool with the given configuration.

D

DataSourceAlert - Interface in io.ebean.datasource

Listener for notifications about the DataSource such as when the DataSource goes down, up or gets close to it's maximum size.

DataSourceAlertFactory - Interface in io.ebean.datasource

Service factory for creating DataSourceAlert implementation.

DataSourceConfig - Class in io.ebean.datasource

Configuration information for a DataSource.

DataSourceConfig() - Constructor for class io.ebean.datasource.DataSourceConfig

DataSourceConfigurationException - Exception in io.ebean.datasource

Exception that can be thrown when the datasource is not correctly configured.

DataSourceConfigurationException(String) - Constructor for exception io.ebean.datasource.DataSourceConfigurationException

DataSourceConfigurationException(String, Throwable) - Constructor for exception io.ebean.datasource.DataSourceConfigurationException

dataSourceDown(DataSource, SQLException) - Method in interface io.ebean.datasource.DataSourceAlert

Send an alert to say the dataSource is down.

DataSourceFactory - Interface in io.ebean.datasource

Factory that creates DataSourcePool's.

DataSourceInitialiseException - Exception in io.ebean.datasource

Exception that can be thrown when the datasource fails to be created.

DataSourceInitialiseException(String) - Constructor for exception io.ebean.datasource.DataSourceInitialiseException

DataSourceInitialiseException(String, Throwable) - Constructor for exception io.ebean.datasource.DataSourceInitialiseException

DataSourcePool - Interface in io.ebean.datasource

DataSource pool API.

DataSourcePoolListener - Interface in io.ebean.datasource

A DataSourcePool listener which allows you to hook on the borrow/return process of getting or returning connections from the pool.

dataSourceUp(DataSource) - Method in interface io.ebean.datasource.DataSourceAlert

Send an alert to say the dataSource is back up.

dataSourceWarning(DataSource, String) - Method in interface io.ebean.datasource.DataSourceAlert

Send an alert to say the dataSource is getting close to its max size.

G

get() - Static method in interface io.ebean.datasource.DataSourceFactory

Return the DataSourceFactory.

getAlert() - Method in class io.ebean.datasource.DataSourceConfig

Return the alert implementation to use.

getAvgMicros() - Method in interface io.ebean.datasource.PoolStatistics

Return the average connection use in micros.

getBusy() - Method in interface io.ebean.datasource.PoolStatus

Return number of busy connections.

getCollectionStart() - Method in interface io.ebean.datasource.PoolStatistics

Return the epoch millis when these statistics start from.

getCount() - Method in interface io.ebean.datasource.PoolStatistics

Return the hit count against the pool.

getCstmtCacheSize() - Method in class io.ebean.datasource.DataSourceConfig

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

getCustomProperties() - Method in class io.ebean.datasource.DataSourceConfig

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

getDataSourceDownReason() - Method in interface io.ebean.datasource.DataSourcePool

Returns the reason, why the dataSource is down.

getDriver() - Method in class io.ebean.datasource.DataSourceConfig

Return the database driver.

getErrorCount() - Method in interface io.ebean.datasource.PoolStatistics

Return the error count against the pool.

getFree() - Method in interface io.ebean.datasource.PoolStatus

Return number of free connections.

getHeartbeatFreqSecs() - Method in class io.ebean.datasource.DataSourceConfig

Return the heartbeat frequency in seconds.

getHeartbeatSql() - Method in class io.ebean.datasource.DataSourceConfig

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

getHeartbeatTimeoutSeconds() - Method in class io.ebean.datasource.DataSourceConfig

Return the heart beat timeout in seconds.

getHighWaterMark() - Method in interface io.ebean.datasource.PoolStatus

Return the busy connection high water mark.

getHitCount() - Method in interface io.ebean.datasource.PoolStatus

Return the hit count against the pool.

getHwmMicros() - Method in interface io.ebean.datasource.PoolStatistics

Return the high water mark for connection use in micros.

getInitDatabase() - Method in class io.ebean.datasource.DataSourceConfig

Return the InitDatabase to use with ownerUsername.

getInitSql() - Method in class io.ebean.datasource.DataSourceConfig

Return a list of init queries, that are executed after a connection is opened.

getIsolationLevel() - Method in class io.ebean.datasource.DataSourceConfig

Return the transaction isolation level.

getLeakTimeMinutes() - Method in class io.ebean.datasource.DataSourceConfig

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

getListener() - Method in class io.ebean.datasource.DataSourceConfig

Return the listener to use.

getMaxAgeMinutes() - Method in class io.ebean.datasource.DataSourceConfig

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

getMaxConnections() - Method in class io.ebean.datasource.DataSourceConfig

Return the maximum number of connections the pool can reach.

getMaxInactiveTimeSecs() - Method in class io.ebean.datasource.DataSourceConfig

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

getMaxSize() - Method in interface io.ebean.datasource.PoolStatus

Return the pools maximum size.

getMaxStackTraceSize() - Method in class io.ebean.datasource.DataSourceConfig

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

getMinConnections() - Method in class io.ebean.datasource.DataSourceConfig

Return the minimum number of connections the pool should maintain.

getMinSize() - Method in interface io.ebean.datasource.PoolStatus

Return the pools minimum size.

getName() - Method in interface io.ebean.datasource.DataSourcePool

Return the dataSource name.

getOwnerPassword() - Method in class io.ebean.datasource.DataSourceConfig

Return the database owner password.

getOwnerUsername() - Method in class io.ebean.datasource.DataSourceConfig

Return the database owner username.

getPassword() - Method in class io.ebean.datasource.DataSourceConfig

Return the database password.

getPlatform() - Method in class io.ebean.datasource.DataSourceConfig

Return the database platform.

getPoolListener() - Method in class io.ebean.datasource.DataSourceConfig

Return the pool listener.

getPstmtCacheSize() - Method in class io.ebean.datasource.DataSourceConfig

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

getSchema() - Method in class io.ebean.datasource.DataSourceConfig

Return the database username.

getStatistics(boolean) - Method in interface io.ebean.datasource.DataSourcePool

Return the aggregated execution statistics collected on all the connections in the pool.

getStatus(boolean) - Method in interface io.ebean.datasource.DataSourcePool

Return the current status of the connection pool.

getTotalMicros() - Method in interface io.ebean.datasource.PoolStatistics

Return the total connection use in micros.

getTrimPoolFreqSecs() - Method in class io.ebean.datasource.DataSourceConfig

Return the minimum time gap between pool trim checks.

getUrl() - Method in class io.ebean.datasource.DataSourceConfig

Return the connection URL.

getUsername() - Method in class io.ebean.datasource.DataSourceConfig

Return the database username.

getWaitCount() - Method in interface io.ebean.datasource.PoolStatus

Return the number of times threads had to wait for connections.

getWaiting() - Method in interface io.ebean.datasource.PoolStatus

Return the number of threads waiting for connections.

getWaitTimeoutMillis() - Method in class io.ebean.datasource.DataSourceConfig

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

getWarningSize() - Method in interface io.ebean.datasource.DataSourcePool

Return the warning size.

I

InitDatabase - Interface in io.ebean.datasource

Run database initialisation when a pool can't create the initial connections (user may not exist).

io.ebean.datasource - package io.ebean.datasource

isAutoCommit() - Method in class io.ebean.datasource.DataSourceConfig

Return autoCommit setting.

isAutoCommit() - Method in interface io.ebean.datasource.DataSourcePool

Return true if the pool defaults to using autocommit.

isCaptureStackTrace() - Method in class io.ebean.datasource.DataSourceConfig

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

isDataSourceUp() - Method in interface io.ebean.datasource.DataSourcePool

Returns false when the dataSource is down.

isEmpty() - Method in class io.ebean.datasource.DataSourceConfig

Return true if there are no values set for any of url, driver, username and password.

isFailOnStart() - Method in class io.ebean.datasource.DataSourceConfig

Return true (default) if the DataSource should be fail on start.

isOffline() - Method in class io.ebean.datasource.DataSourceConfig

Return true if the DataSource should be left offline.

isOnline() - Method in interface io.ebean.datasource.DataSourcePool

Return true if the DataSource is online.

isReadOnly() - Method in class io.ebean.datasource.DataSourceConfig

Return the read only setting.

L

loadSettings(Properties, String) - Method in class io.ebean.datasource.DataSourceConfig

Load the settings from the properties supplied.

O

offline() - Method in interface io.ebean.datasource.DataSourcePool

Take the DataSource offline closing all connections and stopping heart beat checking.

onAfterBorrowConnection(Connection) - Method in interface io.ebean.datasource.DataSourcePoolListener

Called after a connection has been retrieved from the connection pool

onBeforeReturnConnection(Connection) - Method in interface io.ebean.datasource.DataSourcePoolListener

Called before a connection will be put back to the connection pool

online() - Method in interface io.ebean.datasource.DataSourcePool

Bring the DataSource online ensuring min connections and start heart beat checking.

P

PoolStatistics - Interface in io.ebean.datasource

Execution statistics from the DataSourcePool.

PoolStatus - Interface in io.ebean.datasource

Current status of the DataSourcePool.

PostgresInitDatabase - Class in io.ebean.datasource

Creates a schema and role using the database owner.

PostgresInitDatabase() - Constructor for class io.ebean.datasource.PostgresInitDatabase

R

run(Connection, DataSourceConfig) - Method in interface io.ebean.datasource.InitDatabase

Execute some database initialisation statements on a database where the user may not exist.

run(Connection, DataSourceConfig) - Method in class io.ebean.datasource.PostgresInitDatabase

S

setAlert(DataSourceAlert) - Method in class io.ebean.datasource.DataSourceConfig

Set the alert implementation to use.

setAutoCommit(boolean) - Method in class io.ebean.datasource.DataSourceConfig

Set to true to turn on autoCommit.

setCaptureStackTrace(boolean) - Method in class io.ebean.datasource.DataSourceConfig

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

setCstmtCacheSize(int) - Method in class io.ebean.datasource.DataSourceConfig

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

setCustomProperties(Map<String, String>) - Method in class io.ebean.datasource.DataSourceConfig

Set custom properties for the jdbc driver connection.

setDefaults(DataSourceConfig) - Method in class io.ebean.datasource.DataSourceConfig

Default the values for driver, url, username and password from another config if they have not been set.

setDriver(String) - Method in class io.ebean.datasource.DataSourceConfig

Set the database driver.

setFailOnStart(boolean) - Method in class io.ebean.datasource.DataSourceConfig

Set to false, if DataSource should not fail on start.

setHeartbeatFreqSecs(int) - Method in class io.ebean.datasource.DataSourceConfig

Set the expected heartbeat frequency in seconds.

setHeartbeatSql(String) - Method in class io.ebean.datasource.DataSourceConfig

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

setHeartbeatTimeoutSeconds(int) - Method in class io.ebean.datasource.DataSourceConfig

Set the heart beat timeout in seconds.

setInitDatabase(InitDatabase) - Method in class io.ebean.datasource.DataSourceConfig

Set the InitDatabase to use with ownerUsername.

setInitDatabaseForPlatform(String) - Method in class io.ebean.datasource.DataSourceConfig

Set InitDatabase based on the database platform.

setInitSql(List<String>) - Method in class io.ebean.datasource.DataSourceConfig

Set custom init queries for each query.

setIsolationLevel(int) - Method in class io.ebean.datasource.DataSourceConfig

Set the transaction isolation level.

setLeakTimeMinutes(int) - Method in class io.ebean.datasource.DataSourceConfig

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

setListener(DataSourcePoolListener) - Method in class io.ebean.datasource.DataSourceConfig

Set the listener to use.

setMaxAgeMinutes(int) - Method in class io.ebean.datasource.DataSourceConfig

Set the maximum age a connection can be in minutes.

setMaxConnections(int) - Method in class io.ebean.datasource.DataSourceConfig

Set the maximum number of connections the pool can reach.

setMaxInactiveTimeSecs(int) - Method in class io.ebean.datasource.DataSourceConfig

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

setMaxSize(int) - Method in interface io.ebean.datasource.DataSourcePool

Set a new maximum size.

setMaxStackTraceSize(int) - Method in class io.ebean.datasource.DataSourceConfig

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

setMinConnections(int) - Method in class io.ebean.datasource.DataSourceConfig

Set the minimum number of connections the pool should maintain.

setOffline(boolean) - Method in class io.ebean.datasource.DataSourceConfig

Set to true if the DataSource should be left offline.

setOwnerPassword(String) - Method in class io.ebean.datasource.DataSourceConfig

Set the database owner password (used to create connection for use with InitDatabase).

setOwnerUsername(String) - Method in class io.ebean.datasource.DataSourceConfig

Set the database owner username (used to create connection for use with InitDatabase).

setPassword(String) - Method in class io.ebean.datasource.DataSourceConfig

Set the database password.

setPlatform(String) - Method in class io.ebean.datasource.DataSourceConfig

Set the database platform (for use with ownerUsername and InitDatabase.

setPoolListener(String) - Method in class io.ebean.datasource.DataSourceConfig

Set a pool listener.

setPstmtCacheSize(int) - Method in class io.ebean.datasource.DataSourceConfig

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

setReadOnly(boolean) - Method in class io.ebean.datasource.DataSourceConfig

Set to true to for read only.

setSchema(String) - Method in class io.ebean.datasource.DataSourceConfig

Set the default database schema to use.

setTrimPoolFreqSecs(int) - Method in class io.ebean.datasource.DataSourceConfig

Set the minimum trim gap between pool trim checks.

setUrl(String) - Method in class io.ebean.datasource.DataSourceConfig

Set the connection URL.

setUsername(String) - Method in class io.ebean.datasource.DataSourceConfig

Set the database username.

setWaitTimeoutMillis(int) - Method in class io.ebean.datasource.DataSourceConfig

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

setWarningSize(int) - Method in interface io.ebean.datasource.DataSourcePool

Set a new maximum size.

shutdown() - Method in interface io.ebean.datasource.DataSourcePool

Shutdown the pool.

shutdown(boolean) - Method in interface io.ebean.datasource.DataSourcePool

Shutdown the pool with the option to deregister the driver.

U

useInitDatabase() - Method in class io.ebean.datasource.DataSourceConfig

Return true if InitDatabase should be used (when the pool initialises and a connection can't be obtained).

C D G I L O P R S U