Package org.jdbi.v3.core.extension

Interface HandleSupplier

All Superinterfaces:

Configurable<HandleSupplier>

public interface HandleSupplier
extends Configurable<HandleSupplier>

A handle supplier for extension implementors.

Method Summary

Modifier and Type	Method	Description
Handle	getHandle()	Returns a handle, possibly creating it lazily.
Jdbi	getJdbi()	Returns the owning Jdbi instance.
<V> V	invokeInContext(ExtensionMethod extensionMethod, ConfigRegistry config, Callable<V> task)	Bind an extension method and configuration registry to the Handle, invoke the given task, then reset the Handle's extension state.

Methods inherited from interface org.jdbi.v3.core.config.Configurable

addCustomizer, configure, define, getConfig, getConfig, registerArgument, registerArgument, registerArrayType, registerArrayType, registerArrayType, registerArrayType, registerCodecFactory, registerCollector, registerColumnMapper, registerColumnMapper, registerColumnMapper, registerColumnMapper, registerColumnMapper, registerColumnMapper, registerExtension, registerRowMapper, registerRowMapper, registerRowMapper, registerRowMapper, setMapKeyColumn, setMapValueColumn, setSqlArrayArgumentStrategy, setSqlLogger, setSqlParser, setTemplateEngine

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.

invokeInContext

<V> V invokeInContext(ExtensionMethod extensionMethod,
 ConfigRegistry config,
 Callable<V> task)
               throws Exception

Bind an extension method and configuration registry to the Handle, invoke the given task, then reset the Handle's extension state. Note that the binding is done by a thread local, so the binding will not propagate to other threads you may call out to.

Type Parameters:

V - the result type of the task

Parameters:

extensionMethod - the method invoked

config - the configuration registry

task - the code to execute in an extension context

Returns:

the callable's result

Throws:

Exception - if any exception is thrown