Package org.jdbi.v3.core.extension

Interface HandleSupplier

All Superinterfaces:

AutoCloseable

public interface HandleSupplier
extends AutoCloseable

A handle supplier for extension implementors.

Method Summary

Modifier and Type	Method	Description
default void	close()
ConfigRegistry	getConfig()	Returns the current Jdbi config.
Handle	getHandle()	Returns a handle, possibly creating it lazily.
Jdbi	getJdbi()	Returns the owning Jdbi instance.
<V> V	invokeInContext(ExtensionContext extensionContext, Callable<V> task)	Bind a new ExtensionContext to the Handle, invoke the given task, then restore the Handle's extension state.

Method Details

getHandle

Handle getHandle()

Returns a handle, possibly creating it lazily. A Handle holds a database connection, so extensions should only call this method in order to interact with the database.

Returns:

An open Handle.

getJdbi

Jdbi getJdbi()

Returns the owning Jdbi instance.

Returns:

The owning Jdbi instance.

getConfig

ConfigRegistry getConfig()

Returns the current Jdbi config.

Returns:

The current Jdbi configuration.

invokeInContext

<V> V invokeInContext(ExtensionContext extensionContext,
 Callable<V> task)
               throws Exception

Bind a new ExtensionContext to the Handle, invoke the given task, then restore the Handle's extension state.

Type Parameters:

V - the result type of the task

Parameters:

extensionContext - An ExtensionContext object that manages the extension state.

task - the code to execute in an extension context

Returns:

the callable's result

Throws:

Exception - if any exception is thrown

close

default void close()

Specified by:

close in interface AutoCloseable