com.speedment.runtime.core.component.connectionpool

Interface ConnectionPoolComponent

All Known Implementing Classes:

SingletonConnectionPoolComponent

public interface ConnectionPoolComponent

This Component interface is used for holding the connection pool that is being used by Speedment.

Since:

2.1.0

Author:

pemi

Method Summary

Modifier and Type	Method and Description
PoolableConnection	getConnection(com.speedment.runtime.config.Dbms dbms) Returns a {link PoolableConnection} from this connection pool.
PoolableConnection	getConnection(String uri, String username, char[] password) Returns a {link PoolableConnection} from this connection pool.
long	getMaxAge() Returns the maximum age for recyclable connections.
int	getMaxRetainSize() Returns the maximum number of connection this pool will retain when connections are returned.
int	leaseSize() Returns the current number of leased connections from the pool.
Connection	newConnection(com.speedment.runtime.config.Dbms dbms) Creates and returns a new Connection for the given parameters.
Connection	newConnection(String uri, String username, char[] password) Creates and returns a new Connection for the given parameters.
int	poolSize() Returns the current number of idle connections in the pool.
void	returnConnection(PoolableConnection connection) Returns a PoolableConnection to the pool.

Method Detail

getConnection

PoolableConnection getConnection(String uri,
                                 String username,
                                 char[] password)

Returns a {link PoolableConnection} from this connection pool. If a connection is not present in the connection pool, a new one will be created.

Parameters:

uri - the connection URI for the connector

username - the user for the connector

password - the password for the connector

Returns:

a PoolableConnection from this connection pool

getConnection

PoolableConnection getConnection(com.speedment.runtime.config.Dbms dbms)

Returns a {link PoolableConnection} from this connection pool. If a connection is not present in the connection pool, a new one will be created.

Parameters:

dbms - the dbms to connect to

Returns:

a PoolableConnection from this connection pool

newConnection

Connection newConnection(String uri,
                         String username,
                         char[] password)

Creates and returns a new Connection for the given parameters. This method is called whenever the pool needs to allocate a new Connection.

Parameters:

uri - the connection URI for the connector

username - the user for the connector

password - the password for the connector

Returns:

a new Connection for the given parameters

newConnection

Connection newConnection(com.speedment.runtime.config.Dbms dbms)

Creates and returns a new Connection for the given parameters. This method is called whenever the pool needs to allocate a new Connection.

Parameters:

dbms - the dbms to connect to

Returns:

a new Connection for the given parameters

returnConnection

void returnConnection(PoolableConnection connection)

Returns a PoolableConnection to the pool. If the PoolableConnection has expired or has a closed underlying connection, it will be discarded from the pool.

Parameters:

connection - to return to the pool

poolSize

int poolSize()

Returns the current number of idle connections in the pool.

Returns:

the current number of idle connections in the pool

leaseSize

int leaseSize()

Returns the current number of leased connections from the pool.

Returns:

the current number of leased connections from the pool

getMaxRetainSize

int getMaxRetainSize()

Returns the maximum number of connection this pool will retain when connections are returned. If the number of connections in the pool exceeds this number of connections, a connection that is returned will be discarded and will not be recycled.

Returns:

the maximum number of connection this pool will retain when connections are returned

getMaxAge

long getMaxAge()

Returns the maximum age for recyclable connections. Connections older that this age will be discarded.

Returns:

the maximum age for recyclable connections