org.skife.jdbi.v2

Interface IDBI

All Known Implementing Classes:

DBI

public interface IDBI

An interface for DBI instances for systems which like to work with interfaces.

Method Summary

Modifier and Type	Method and Description
void	close(Object sqlObject) Used to close a sql object which lacks a close() method.
void	define(String key, Object value) Define an attribute on every StatementContext for every statement created from a handle obtained from this DBI instance.
<ReturnType> ReturnType	inTransaction(TransactionCallback<ReturnType> callback) A convenience function which manages the lifecycle of a handle and yields it to a callback for use by clients.
<ReturnType> ReturnType	inTransaction(TransactionIsolationLevel isolation, TransactionCallback<ReturnType> callback) A convenience function which manages the lifecycle of a handle and yields it to a callback for use by clients.
<SqlObjectType> SqlObjectType	onDemand(Class<SqlObjectType> sqlObjectType) Create a new sql object which will obtain and release connections from this dbi instance, as it needs to, and can, respectively.
Handle	open() Obtain a Handle to the data source wrapped by this DBI instance
<SqlObjectType> SqlObjectType	open(Class<SqlObjectType> sqlObjectType) Open a handle and attach a new sql object of the specified type to that handle.
void	useHandle(HandleConsumer callback) A convenience function which manages the lifecycle of a handle and yields it to a callback for use by clients.
void	useTransaction(TransactionConsumer callback) A convenience function which manages the lifecycle of a handle and yields it to a callback for use by clients.
void	useTransaction(TransactionIsolationLevel isolation, TransactionConsumer callback) A convenience function which manages the lifecycle of a handle and yields it to a callback for use by clients.
<ReturnType> ReturnType	withHandle(HandleCallback<ReturnType> callback) A convenience function which manages the lifecycle of a handle and yields it to a callback for use by clients.

Method Detail

close

void close(Object sqlObject)

Used to close a sql object which lacks a close() method.

Parameters:

sqlObject - the sql object to close

define

void define(String key,
            Object value)

Define an attribute on every StatementContext for every statement created from a handle obtained from this DBI instance.

Parameters:

key - The key for the attribute

value - the value for the attribute

inTransaction

<ReturnType> ReturnType inTransaction(TransactionCallback<ReturnType> callback)
                               throws CallbackFailedException

A convenience function which manages the lifecycle of a handle and yields it to a callback for use by clients. The handle will be in a transaction when the callback is invoked, and that transaction will be committed if the callback finishes normally, or rolled back if the callback raises an exception.

Parameters:

callback - A callback which will receive an open Handle, in a transaction

Returns:

the value returned by callback

Throws:

CallbackFailedException - Will be thrown if callback raises an exception. This exception will wrap the exception thrown by the callback.

inTransaction

<ReturnType> ReturnType inTransaction(TransactionIsolationLevel isolation,
                                      TransactionCallback<ReturnType> callback)
                               throws CallbackFailedException

A convenience function which manages the lifecycle of a handle and yields it to a callback for use by clients. The handle will be in a transaction when the callback is invoked, and that transaction will be committed if the callback finishes normally, or rolled back if the callback raises an exception.

Parameters:

isolation - The transaction isolation level to set

callback - A callback which will receive an open Handle, in a transaction

Returns:

the value returned by callback

Throws:

CallbackFailedException - Will be thrown if callback raises an exception. This exception will wrap the exception thrown by the callback.

onDemand

<SqlObjectType> SqlObjectType onDemand(Class<SqlObjectType> sqlObjectType)

Create a new sql object which will obtain and release connections from this dbi instance, as it needs to, and can, respectively. You should not explicitely close this sql object

Type Parameters:

SqlObjectType -

Parameters:

sqlObjectType - an interface with annotations declaring desired behavior

Returns:

a new sql object of the specified type, with a dedicated handle

open

Handle open()

Obtain a Handle to the data source wrapped by this DBI instance

Returns:

an open Handle instance

See Also:

DBI.open()

open

<SqlObjectType> SqlObjectType open(Class<SqlObjectType> sqlObjectType)

Open a handle and attach a new sql object of the specified type to that handle. Be sure to close the sql object (via a close() method, or calling close(Object)

Type Parameters:

SqlObjectType -

Parameters:

sqlObjectType - an interface with annotations declaring desired behavior

Returns:

a new sql object of the specified type, with a dedicated handle

useHandle

void useHandle(HandleConsumer callback)
        throws CallbackFailedException

A convenience function which manages the lifecycle of a handle and yields it to a callback for use by clients.

Parameters:

callback - A callback which will receive an open Handle

Throws:

CallbackFailedException - Will be thrown if callback raises an exception. This exception will wrap the exception thrown by the callback.

useTransaction

void useTransaction(TransactionConsumer callback)
             throws CallbackFailedException

A convenience function which manages the lifecycle of a handle and yields it to a callback for use by clients. The handle will be in a transaction when the callback is invoked, and that transaction will be committed if the callback finishes normally, or rolled back if the callback raises an exception.

Parameters:

callback - A callback which will receive an open Handle, in a transaction

Throws:

CallbackFailedException - Will be thrown if callback raises an exception. This exception will wrap the exception thrown by the callback.

useTransaction

void useTransaction(TransactionIsolationLevel isolation,
                    TransactionConsumer callback)
             throws CallbackFailedException

A convenience function which manages the lifecycle of a handle and yields it to a callback for use by clients. The handle will be in a transaction when the callback is invoked, and that transaction will be committed if the callback finishes normally, or rolled back if the callback raises an exception.

Parameters:

isolation - The transaction isolation level to set

callback - A callback which will receive an open Handle, in a transaction

Throws:

CallbackFailedException - Will be thrown if callback raises an exception. This exception will wrap the exception thrown by the callback.

withHandle

<ReturnType> ReturnType withHandle(HandleCallback<ReturnType> callback)
                            throws CallbackFailedException

A convenience function which manages the lifecycle of a handle and yields it to a callback for use by clients.

Parameters:

callback - A callback which will receive an open Handle

Returns:

the value returned by callback

Throws:

CallbackFailedException - Will be thrown if callback raises an exception. This exception will wrap the exception thrown by the callback.