com.speedment.runtime.core.component.connectionpool

Class SingletonConnectionPoolComponent

java.lang.Object

com.speedment.runtime.core.component.connectionpool.SingletonConnectionPoolComponent

All Implemented Interfaces:

ConnectionPoolComponent

public final class SingletonConnectionPoolComponent
extends Object
implements ConnectionPoolComponent

Alternative implementation of ConnectionPoolComponent that uses a semaphore to make sure that only one connection is able to communicate with the database at a time. This is useful for file based databases where locking is an issue.

To enable the SingletonConnectionPoolComponent, add the following to the Speedment application builder:

     var app = new DemoApplicationBuilder()
         .withComponent(SingletonConnectionPoolComponent.class)
         .build();
 

It will automatically replace the default connection pool. There are two modes in which the pool can work. It can either block until a connection becomes available or throw an exception. To control this behaviour, use the configuration flag connectionpool.blocking=true. The default value is false, meaning that the pool will throw an exception instead of blocking if multiple connections to the same Dbms are requested.

Since:

3.1.10

Author:

Emil Forslund

Constructor Summary

Constructors

Constructor and Description
SingletonConnectionPoolComponent()

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 user, 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 user, 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 poolableConnection) Returns a PoolableConnection to the pool.

Methods inherited from class java.lang.Object

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

Constructor Detail

SingletonConnectionPoolComponent

public SingletonConnectionPoolComponent()

Method Detail

getConnection

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

Description copied from interface: ConnectionPoolComponent

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

Specified by:

getConnection in interface ConnectionPoolComponent

Parameters:

dbms - the dbms to connect to

Returns:

a PoolableConnection from this connection pool

getConnection

public PoolableConnection getConnection(String uri,
                                        String user,
                                        char[] password)

Description copied from interface: ConnectionPoolComponent

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

Specified by:

getConnection in interface ConnectionPoolComponent

Parameters:

uri - the connection URI for the connector

user - the user for the connector

password - the password for the connector

Returns:

a PoolableConnection from this connection pool

newConnection

public Connection newConnection(String uri,
                                String user,
                                char[] password)

Description copied from interface: ConnectionPoolComponent

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

Specified by:

newConnection in interface ConnectionPoolComponent

Parameters:

uri - the connection URI for the connector

user - the user for the connector

password - the password for the connector

Returns:

a new Connection for the given parameters

newConnection

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

Description copied from interface: ConnectionPoolComponent

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

Specified by:

newConnection in interface ConnectionPoolComponent

Parameters:

dbms - the dbms to connect to

Returns:

a new Connection for the given parameters

returnConnection

public void returnConnection(PoolableConnection poolableConnection)

Description copied from interface: ConnectionPoolComponent

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

Specified by:

returnConnection in interface ConnectionPoolComponent

Parameters:

poolableConnection - to return to the pool

poolSize

public int poolSize()

Description copied from interface: ConnectionPoolComponent

Returns the current number of idle connections in the pool.

Specified by:

poolSize in interface ConnectionPoolComponent

Returns:

the current number of idle connections in the pool

leaseSize

public int leaseSize()

Description copied from interface: ConnectionPoolComponent

Returns the current number of leased connections from the pool.

Specified by:

leaseSize in interface ConnectionPoolComponent

Returns:

the current number of leased connections from the pool

getMaxRetainSize

public int getMaxRetainSize()

Description copied from interface: ConnectionPoolComponent

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.

Specified by:

getMaxRetainSize in interface ConnectionPoolComponent

Returns:

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

getMaxAge

public long getMaxAge()

Description copied from interface: ConnectionPoolComponent

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

Specified by:

getMaxAge in interface ConnectionPoolComponent

Returns:

the maximum age for recyclable connections