io.rdbc.japi

Interface ConnectionFactory

public interface ConnectionFactory

Provides access to a database Connection.

Implementors are required to make the implementation of this interface thread-safe.

Method Summary

Modifier and Type	Method and Description
java.util.concurrent.CompletionStage<Connection>	getConnection() Returns a CompletionStage of a Connection.
java.util.concurrent.CompletionStage<Connection>	getConnection(java.time.Duration timeout) Returns a CompletionStage of a Connection.
java.util.concurrent.CompletionStage<java.lang.Void>	shutdown() Shuts down this connection factory.
<T> java.util.concurrent.CompletionStage<T>	withConnection(java.time.Duration connGetTimeout, ThrowingFunction<Connection,java.util.concurrent.CompletionStage<T>> body) Executes a function in a context of a connection.
<T> java.util.concurrent.CompletionStage<T>	withConnection(ThrowingFunction<Connection,java.util.concurrent.CompletionStage<T>> body) Executes a function in a context of a connection.
<T> java.util.concurrent.CompletionStage<T>	withTransaction(java.time.Duration txManageTimeout, ThrowingFunction<Connection,java.util.concurrent.CompletionStage<T>> body) Executes a function in a context of a transaction.
<T> java.util.concurrent.CompletionStage<T>	withTransaction(ThrowingFunction<Connection,java.util.concurrent.CompletionStage<T>> body) Executes a function in a context of a transaction.

Method Detail

getConnection

java.util.concurrent.CompletionStage<Connection> getConnection()

Returns a CompletionStage of a Connection.

getConnection

java.util.concurrent.CompletionStage<Connection> getConnection(java.time.Duration timeout)

Returns a CompletionStage of a Connection.

withConnection

<T> java.util.concurrent.CompletionStage<T> withConnection(ThrowingFunction<Connection,java.util.concurrent.CompletionStage<T>> body)

Executes a function in a context of a connection.

Executes a function in a context of a connection obtained via connection method, and releases the connection afterwards.

withConnection

<T> java.util.concurrent.CompletionStage<T> withConnection(java.time.Duration connGetTimeout,
                                                           ThrowingFunction<Connection,java.util.concurrent.CompletionStage<T>> body)

Executes a function in a context of a connection.

Executes a function in a context of a connection obtained via connection method, and releases the connection afterwards.

Parameters:

connGetTimeout - Timeout for obtaining new connection.

withTransaction

<T> java.util.concurrent.CompletionStage<T> withTransaction(ThrowingFunction<Connection,java.util.concurrent.CompletionStage<T>> body)

Executes a function in a context of a transaction.

Executes a function in a context of a connection obtained via connection method. Before the function is executed, transaction is started. After the function finishes, transaction is committed in case of a success and rolled back in case of a failure - after that, the connection is released.

withTransaction

<T> java.util.concurrent.CompletionStage<T> withTransaction(java.time.Duration txManageTimeout,
                                                            ThrowingFunction<Connection,java.util.concurrent.CompletionStage<T>> body)

Executes a function in a context of a transaction.

Executes a function in a context of a connection obtained via connection method. Before the function is executed, transaction is started. After the function finishes, transaction is committed in case of a success and rolled back in case of a failure - after that, the connection is released.

Parameters:

txManageTimeout - Timeout for operations managing transaction state.

shutdown

java.util.concurrent.CompletionStage<java.lang.Void> shutdown()

Shuts down this connection factory.

Returned CompletionStage never fails - it completes on finished shutdown attempt. After the factory is shut down it is illegal to request new connections from it.