io.ebean.datasource

Interface DataSourcePool

All Superinterfaces:

CommonDataSource, DataSource, Wrapper

public interface DataSourcePool
extends DataSource

DataSource pool API.

Method Summary

Modifier and Type	Method and Description
SQLException	getDataSourceDownReason() Returns the reason, why the dataSource is down.
String	getName() Return the dataSource name.
PoolStatistics	getStatistics(boolean reset) Return the aggregated execution statistics collected on all the connections in the pool.
PoolStatus	getStatus(boolean reset) Return the current status of the connection pool.
int	getWarningSize() Return the warning size.
boolean	isAutoCommit() Return true if the pool defaults to using autocommit.
boolean	isDataSourceUp() Returns false when the dataSource is down.
boolean	isOnline() Return true if the DataSource is online.
void	offline() Take the DataSource offline closing all connections and stopping heart beat checking.
void	online() Bring the DataSource online ensuring min connections and start heart beat checking.
void	setMaxSize(int max) Set a new maximum size.
void	setWarningSize(int warningSize) Set a new maximum size.
void	shutdown() Shutdown the pool.
void	shutdown(boolean deregisterDriver) Shutdown the pool with the option to deregister the driver.

Methods inherited from interface javax.sql.DataSource

getConnection, getConnection

Methods inherited from interface javax.sql.CommonDataSource

getLoginTimeout, getLogWriter, getParentLogger, setLoginTimeout, setLogWriter

Methods inherited from interface java.sql.Wrapper

isWrapperFor, unwrap

Method Detail

getName

String getName()

Return the dataSource name.

isAutoCommit

boolean isAutoCommit()

Return true if the pool defaults to using autocommit.

isOnline

boolean isOnline()

Return true if the DataSource is online.

Effectively the same as (synonym for) isDataSourceUp().

online

void online()
     throws SQLException

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

Throws:

SQLException

offline

void offline()

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

shutdown

void shutdown()

Shutdown the pool.

This is functionally the same as offline() but generally we expect to only shutdown the pool once where as we can expect to making many calls to offline() and online().

shutdown

void shutdown(boolean deregisterDriver)

Shutdown the pool with the option to deregister the driver.

getStatus

PoolStatus getStatus(boolean reset)

Return the current status of the connection pool.

This is cheaper than getStatistics() in that it just the counts of free, busy, wait etc and does not included times (total connection time etc).

If you pass reset = true then the counters are reset.

getStatistics

PoolStatistics getStatistics(boolean reset)

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

If reset is set to true the counters are reset once the statistics have been collected.

isDataSourceUp

boolean isDataSourceUp()

Returns false when the dataSource is down.

Effectively the same as (synonym for) isOnline().

getDataSourceDownReason

SQLException getDataSourceDownReason()

Returns the reason, why the dataSource is down.

setMaxSize

void setMaxSize(int max)

Set a new maximum size. The pool should respect this new maximum immediately and not require a restart. You may want to increase the maxConnections if the pool gets large and hits the warning level.

setWarningSize

void setWarningSize(int warningSize)

Set a new maximum size. The pool should respect this new maximum immediately and not require a restart. You may want to increase the maxConnections if the pool gets large and hits the warning and or alert levels.

getWarningSize

int getWarningSize()

Return the warning size. When the pool hits this size it can send a notify message to an administrator.