Package org.jdbi.v3.core

Interface HandleScope

public interface HandleScope

Jdbi manages Handles to allow transaction nesting and extension objects to share the same handle as long as they are within a specific scope.
The default scope is "per thread", which is managed by the default implementation of this interface.
It is possible to provide a different implementation by calling Jdbi.setHandleScope(HandleScope) to support e.g. structured concurrency in modern Java or Kotlin coroutines.

Method Summary

Modifier and Type	Method	Description
void	clear()	Remove a current association.
HandleSupplier	get()	Returns a HandleSupplier that provides a Handle in the given context.
void	set(HandleSupplier handleSupplier)	Associate a HandleSupplier with the current scope.
default void	set(Handle handle)	Associate a Handle with the current scope.
static HandleScope	threadLocal()

Method Details

threadLocal

static HandleScope threadLocal()

get

HandleSupplier get()

Returns a HandleSupplier that provides a Handle in the given context.

Returns:

A handle object or null.

set

void set(HandleSupplier handleSupplier)

Associate a HandleSupplier with the current scope.

Parameters:

handleSupplier - A HandleSupplier object. Must not be null.

set

default void set(Handle handle)

Associate a Handle with the current scope.

Parameters:

handle - A Handle object. Must not be null.

clear

void clear()

Remove a current association. The get() method will return null after calling this method.