Hibernate ORM - hibernate-core 6.4.4.Final · org.hibernate.boot.registry.BootstrapServiceRegistryBuilder

Builder for BootstrapServiceRegistry instances.

An instance of this class may be obtained simply by instantiation. Then a new BootstrapServiceRegistry may be obtained by calling build(). It should be later destroyed by calling destroy(ServiceRegistry). Alternatively, auto-close may be enabled.

Provides a registry of services needed for most operations. Manages a ClassLoaderService, a set of Integrators, and a StrategySelectorBuilder responsible for creation and management of org.hibernate.boot.registry.selector.spi.StrategySelectors.

Modifier and Type	Field and Description
private boolean	autoCloseRegistry
private List<ClassLoader>	providedClassLoaders
private ClassLoaderService	providedClassLoaderService
private final LinkedHashSet<Integrator>	providedIntegrators
private final StrategySelectorBuilder	strategySelectorBuilder
private TcclLookupPrecedence	tcclLookupPrecedence

Constructor Summary

Access	Constructor and Description
public	BootstrapServiceRegistryBuilder()

Method Summary

Modifier and Type	Method and Description
public BootstrapServiceRegistryBuilder	Returns: `this`, for method chaining applyClassLoader(ClassLoader The class loader to use classLoader) Adds a provided `ClassLoader` for use in classloading and resource lookup.
public BootstrapServiceRegistryBuilder	Returns: `this`, for method chaining applyClassLoaderService(ClassLoaderService The class loader service to use classLoaderService) Adds a provided `ClassLoaderService` for use in classloading and resource lookup.
public BootstrapServiceRegistryBuilder	Returns: `this`, for method chaining applyIntegrator(Integrator The integrator to add. integrator) Add an `Integrator` to be applied to the bootstrap registry.
public < Defines the strategy type and makes sure that the strategy and implementation are of compatible types. T> BootstrapServiceRegistryBuilder	Returns: `this`, for method chaining applyStrategySelector(Class<T> The strategy strategy, String The registered name name, Class<? extends T> The strategy implementation Class implementation) Applies a named strategy implementation to the bootstrap registry.
public BootstrapServiceRegistryBuilder	Returns: `this`, for method chaining applyStrategySelectors(StrategyRegistrationProvider A provider for one or more available selectors strategyRegistrationProvider) Applies one or more strategy selectors announced as available by the passed announcer.
public void	applyTcclLookupPrecedence(TcclLookupPrecedence The lookup precedence precedence) Defines when the lookup in the thread context `ClassLoader` is done.
public BootstrapServiceRegistry	Returns: The built bootstrap registry build() Build the bootstrap registry.
public static void	destroy(ServiceRegistry The registry to be closed. serviceRegistry) Destroy a service registry.
public BootstrapServiceRegistryBuilder	Returns: this, for method chaining disableAutoClose() By default, when a `ServiceRegistry` is no longer referenced by any other registries as a parent it will be closed.
public BootstrapServiceRegistryBuilder	Returns: this, for method chaining enableAutoClose() See the discussion on `disableAutoClose`.

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Field Detail

autoCloseRegistry	back to summary
private boolean autoCloseRegistry

providedClassLoaders	back to summary
private List<ClassLoader> providedClassLoaders

providedClassLoaderService	back to summary
private ClassLoaderService providedClassLoaderService

providedIntegrators	back to summary
private final LinkedHashSet<Integrator> providedIntegrators

strategySelectorBuilder	back to summary
private final StrategySelectorBuilder strategySelectorBuilder

tcclLookupPrecedence	back to summary
private TcclLookupPrecedence tcclLookupPrecedence

Constructor Detail

BootstrapServiceRegistryBuilder	back to summary
public BootstrapServiceRegistryBuilder()

Method Detail

applyClassLoader back to summary

applyClassLoader	back to summary
public BootstrapServiceRegistryBuilder applyClassLoader(ClassLoader classLoader) Adds a provided `ClassLoader` for use in classloading and resource lookup. Parameters classLoader:ClassLoader The class loader to use Returns:BootstrapServiceRegistryBuilder `this`, for method chaining

public BootstrapServiceRegistryBuilder applyClassLoader(ClassLoader classLoader)

Adds a provided ClassLoader for use in classloading and resource lookup.

Parameters

classLoader:ClassLoader: The class loader to use

Returns:BootstrapServiceRegistryBuilder

this, for method chaining

applyClassLoaderService back to summary

applyClassLoaderService	back to summary
public BootstrapServiceRegistryBuilder applyClassLoaderService(ClassLoaderService classLoaderService) Adds a provided `ClassLoaderService` for use in classloading and resource lookup. Parameters classLoaderService:ClassLoaderService The class loader service to use Returns:BootstrapServiceRegistryBuilder `this`, for method chaining

public BootstrapServiceRegistryBuilder applyClassLoaderService(ClassLoaderService classLoaderService)

Adds a provided ClassLoaderService for use in classloading and resource lookup.

Parameters

classLoaderService:ClassLoaderService: The class loader service to use

Returns:BootstrapServiceRegistryBuilder

this, for method chaining

applyIntegrator back to summary

applyIntegrator	back to summary
public BootstrapServiceRegistryBuilder applyIntegrator(Integrator integrator) Add an `Integrator` to be applied to the bootstrap registry. Parameters integrator:Integrator The integrator to add. Returns:BootstrapServiceRegistryBuilder `this`, for method chaining

public BootstrapServiceRegistryBuilder applyIntegrator(Integrator integrator)

Add an Integrator to be applied to the bootstrap registry.

Parameters

integrator:Integrator: The integrator to add.

Returns:BootstrapServiceRegistryBuilder

this, for method chaining

applyStrategySelector back to summary

applyStrategySelector	back to summary
public <T> BootstrapServiceRegistryBuilder applyStrategySelector(Class<T> strategy, String name, Class<? extends T> implementation) Applies a named strategy implementation to the bootstrap registry. Parameters <T> Defines the strategy type and makes sure that the strategy and implementation are of compatible types. strategy:Class<T> The strategy name:String The registered name implementation:Class<? extends T> The strategy implementation Class Returns:BootstrapServiceRegistryBuilder `this`, for method chaining See Also `org.hibernate.boot.registry.selector.spi.StrategySelector#registerStrategyImplementor(Class, String, Class)`

public <T> BootstrapServiceRegistryBuilder applyStrategySelector(Class<T> strategy, String name, Class<? extends T> implementation)

Applies a named strategy implementation to the bootstrap registry.

Parameters

<T>: Defines the strategy type and makes sure that the strategy and implementation are of compatible types.
strategy:Class<T>: The strategy
name:String: The registered name
implementation:Class<? extends T>: The strategy implementation Class

Returns:BootstrapServiceRegistryBuilder

this, for method chaining

applyStrategySelectors back to summary

applyStrategySelectors	back to summary
public BootstrapServiceRegistryBuilder applyStrategySelectors(StrategyRegistrationProvider strategyRegistrationProvider) Applies one or more strategy selectors announced as available by the passed announcer. Parameters strategyRegistrationProvider:StrategyRegistrationProvider A provider for one or more available selectors Returns:BootstrapServiceRegistryBuilder `this`, for method chaining See Also `org.hibernate.boot.registry.selector.spi.StrategySelector#registerStrategyImplementor(Class, String, Class)`

public BootstrapServiceRegistryBuilder applyStrategySelectors(StrategyRegistrationProvider strategyRegistrationProvider)

Applies one or more strategy selectors announced as available by the passed announcer.

Parameters

strategyRegistrationProvider:StrategyRegistrationProvider: A provider for one or more available selectors

Returns:BootstrapServiceRegistryBuilder

this, for method chaining

applyTcclLookupPrecedence back to summary

applyTcclLookupPrecedence	back to summary
public void applyTcclLookupPrecedence(TcclLookupPrecedence precedence) Defines when the lookup in the thread context `ClassLoader` is done. Parameters precedence:TcclLookupPrecedence The lookup precedence

public void applyTcclLookupPrecedence(TcclLookupPrecedence precedence)

Defines when the lookup in the thread context ClassLoader is done.

Parameters

precedence:TcclLookupPrecedence: The lookup precedence

build	back to summary
public BootstrapServiceRegistry build() Build the bootstrap registry. Returns:BootstrapServiceRegistry The built bootstrap registry

build

back to summary

public BootstrapServiceRegistry build()

Build the bootstrap registry.

Returns:BootstrapServiceRegistry: The built bootstrap registry

destroy	back to summary
public static void destroy(ServiceRegistry serviceRegistry) Destroy a service registry. Clients should only destroy registries they have created. Parameters serviceRegistry:ServiceRegistry The registry to be closed.

destroy

back to summary

public static void destroy(ServiceRegistry serviceRegistry)

Destroy a service registry. Clients should only destroy registries they have created.

Parameters

serviceRegistry:ServiceRegistry: The registry to be closed.

disableAutoClose back to summary

disableAutoClose	back to summary
public BootstrapServiceRegistryBuilder disableAutoClose() By default, when a `ServiceRegistry` is no longer referenced by any other registries as a parent it will be closed. Some applications that explicitly build "shared registries" may want to circumvent that behavior. This method indicates that the registry being built should not be automatically closed. The caller agrees to take responsibility to close it themselves. Returns:BootstrapServiceRegistryBuilder this, for method chaining

public BootstrapServiceRegistryBuilder disableAutoClose()

By default, when a ServiceRegistry is no longer referenced by any other registries as a parent it will be closed.

Some applications that explicitly build "shared registries" may want to circumvent that behavior.

This method indicates that the registry being built should not be automatically closed. The caller agrees to take responsibility to close it themselves.

Returns:BootstrapServiceRegistryBuilder: this, for method chaining

enableAutoClose back to summary

enableAutoClose	back to summary
public BootstrapServiceRegistryBuilder enableAutoClose() See the discussion on `disableAutoClose`. This method enables the auto-closing. Returns:BootstrapServiceRegistryBuilder this, for method chaining

public BootstrapServiceRegistryBuilder enableAutoClose()

See the discussion on disableAutoClose. This method enables the auto-closing.

Returns:BootstrapServiceRegistryBuilder: this, for method chaining

public Class BootstrapServiceRegistryBuilder

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail