Package org.jdbi.v3.core.extension

Interface ExtensionFactory

All Known Implementing Classes:

AbstractSqlObjectFactory, ExtensionFactoryDelegate, GeneratorSqlObjectFactory, SqlObjectFactory

Functional Interface:

This is a functional interface and can therefore be used as the assignment target for a lambda expression or method reference.

@FunctionalInterface
public interface ExtensionFactory

Factory interface used to produce Jdbi extension objects. A factory can provide additional pieces of information by overriding the various default methods.

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static class	ExtensionFactory.FactoryFlag	Flags that the factory can return to control aspects of the extension framework.

Method Summary

Modifier and Type	Method	Description
boolean	accepts(java.lang.Class<?> extensionType)	Returns true if the factory can process the given extension type.
default <E> E	attach(java.lang.Class<E> extensionType, HandleSupplier handleSupplier)	Attaches an extension type.
default void	buildExtensionMetadata(ExtensionMetadata.Builder builder)	Receives the ExtensionMetadata.Builder when the ExtensionMetadata object for this extension is created.
default java.util.Collection<ConfigCustomizerFactory>	getConfigCustomizerFactories(ConfigRegistry config)	Returns a collection of ConfigCustomizerFactory objects.
default java.util.Collection<ExtensionHandlerCustomizer>	getExtensionHandlerCustomizers(ConfigRegistry config)	Returns a collection of ExtensionHandlerCustomizer objects.
default java.util.Collection<ExtensionHandlerFactory>	getExtensionHandlerFactories(ConfigRegistry config)	Returns a collection of ExtensionHandlerFactory objects.
default java.util.Set<ExtensionFactory.FactoryFlag>	getFactoryFlags()	Returns a set of ExtensionFactory.FactoryFlags that describe the extension factory.

Method Detail

accepts

boolean accepts(java.lang.Class<?> extensionType)

Returns true if the factory can process the given extension type.

Parameters:

extensionType - the extension type

Returns:

whether the factory can produce an extension of the given type

attach

default <E> E attach(java.lang.Class<E> extensionType,
                     HandleSupplier handleSupplier)

Attaches an extension type. This method is not called if getFactoryFlags() contains ExtensionFactory.FactoryFlag.NON_VIRTUAL_FACTORY.

Type Parameters:

E - the extension type

Parameters:

extensionType - The extension type

handleSupplier - Supplies the database handle. This supplier may lazily open a Handle on the first invocation. Extension implementors should take care not to fetch the handle before it is needed, to avoid opening handles unnecessarily

Returns:

An extension of the given type, attached to the given handle

Throws:

java.lang.IllegalArgumentException - if the extension type is not supported by this factory

See Also:

Jdbi.onDemand(Class)

getExtensionHandlerFactories

@Alpha
default java.util.Collection<ExtensionHandlerFactory> getExtensionHandlerFactories(ConfigRegistry config)

Returns a collection of ExtensionHandlerFactory objects. These factories are used in addition to the factories that have been registered with Extensions.registerHandlerFactory(org.jdbi.v3.core.extension.ExtensionHandlerFactory).
Handler factories returned here can customize the behavior of the Extension factory itself.

Parameters:

config - A Configuration registry object that can be used to look up additional information

Returns:

A collection of ExtensionHandlerFactory objects. Can be empty, must not be null

Since:

3.38.0

getExtensionHandlerCustomizers

@Alpha
default java.util.Collection<ExtensionHandlerCustomizer> getExtensionHandlerCustomizers(ConfigRegistry config)

Returns a collection of ExtensionHandlerCustomizer objects. These customizers are used in addition to the customizers that have been registered with Extensions.registerHandlerCustomizer(org.jdbi.v3.core.extension.ExtensionHandlerCustomizer).
Handler customizers returned here can customize the behavior of the Handlers returned by the handler factories.

Parameters:

config - A Configuration registry object that can be used to look up additional information

Returns:

A collection of ExtensionHandlerCustomizer objects. Can be empty, must not be null

Since:

3.38.0

getConfigCustomizerFactories

@Alpha
default java.util.Collection<ConfigCustomizerFactory> getConfigCustomizerFactories(ConfigRegistry config)

Returns a collection of ConfigCustomizerFactory objects.
Each factory is called once for every type that is attached by the factory and once for each method in the type. They can return ConfigCustomizer instances that will affect the specific configuration for each method and extension type.

Parameters:

config - A Configuration registry object that can be used to look up additional information

Returns:

A collection of ConfigCustomizerFactory objects. Can be empty, must not be null

Since:

3.38.0

buildExtensionMetadata

@Alpha
default void buildExtensionMetadata(ExtensionMetadata.Builder builder)

Receives the ExtensionMetadata.Builder when the ExtensionMetadata object for this extension is created. The factory can add additional method handlers or specific instance and method customizers as needed.
Code here can call methods on the builder to configure the metadata object.

Parameters:

builder - The builder object that is used to create the ExtensionMetadata object

Since:

3.38.0

getFactoryFlags

@Alpha
default java.util.Set<ExtensionFactory.FactoryFlag> getFactoryFlags()

Returns a set of ExtensionFactory.FactoryFlags that describe the extension factory.

Returns:

A set of ExtensionFactory.FactoryFlag elements. Default is the empty set

Since:

3.38.0