Package org.hibernate.boot.spi

Interface BootstrapContext

All Known Implementing Classes:

BootstrapContextImpl, BootstrapContextImpl, MockSessionFactory, ProcessorSessionFactory

@Incubating
public interface BootstrapContext

Defines a context for things available during the process of bootstrapping a SessionFactory which are expected to be cleaned up after the SessionFactory is built.

Method Summary

Modifier and Type	Method	Description
ArchiveDescriptorFactory	getArchiveDescriptorFactory()	Access to the ArchiveDescriptorFactory used for scanning.
Collection<ConverterDescriptor>	getAttributeConverters()	Access to collected AttributeConverter definitions.
Collection<AuxiliaryDatabaseObject>	getAuxiliaryDatabaseObjectList()	Access to any AuxiliaryDatabaseObjects explicitly registered with the MetadataBuilder.
Collection<CacheRegionDefinition>	getCacheRegionDefinitions()	Access to all explicit cache region mappings.
ClassLoaderAccess	getClassLoaderAccess()	Access to class loading capabilities.
ClassmateContext	getClassmateContext()	Access to the shared ClassmateContext object used throughout the bootstrap process.
BeanInstanceProducer	getCustomTypeProducer()	The BeanInstanceProducer to use when creating custom type references.
SqmFunctionRegistry	getFunctionRegistry()	The SqmFunctionRegistry belonging to this BootstrapContext.
default IdentifierGeneratorFactory	getIdentifierGeneratorFactory()
org.jboss.jandex.IndexView	getJandexView()	Access to the Jandex index passed by call to MetadataBuilder.applyIndexView(IndexView), if any.
MutableJpaCompliance	getJpaCompliance()	In-flight form of JpaCompliance
ClassLoader	getJpaTempClassLoader()	Access the temporary ClassLoader passed to us, as defined by PersistenceUnitInfo.getNewTempClassLoader(), if any.
MetadataBuildingOptions	getMetadataBuildingOptions()	Options specific to building the boot metamodel
org.hibernate.annotations.common.reflection.ReflectionManager	getReflectionManager()	Retrieve the Hibernate Commons Annotations ReflectionManager.
ManagedTypeRepresentationResolver	getRepresentationStrategySelector()
ScanEnvironment	getScanEnvironment()	Access to the environment for scanning.
Object	getScanner()	Access to the Scanner to be used for scanning.
ScanOptions	getScanOptions()	Access to the options to be used for scanning.
StandardServiceRegistry	getServiceRegistry()	The service registry available to bootstrapping
Map<String,SqmFunctionDescriptor>	getSqlFunctions()	Access to any SQL functions explicitly registered with the MetadataBuilder.
TypeConfiguration	getTypeConfiguration()	The TypeConfiguration belonging to this BootstrapContext.
boolean	isJpaBootstrap()	Whether the bootstrap was initiated from JPA bootstrapping.
void	markAsJpaBootstrap()	Indicates that bootstrap was initiated from JPA bootstrapping.
void	registerAdHocBasicType(BasicType<?> basicType)	To support Envers.
void	release()	Releases the "bootstrap only" resources held by this BootstrapContext.
<T> BasicType<T>	resolveAdHocBasicType(String key)	To support Envers.

Method Details

getServiceRegistry

StandardServiceRegistry getServiceRegistry()

The service registry available to bootstrapping

getJpaCompliance

MutableJpaCompliance getJpaCompliance()

In-flight form of JpaCompliance

getTypeConfiguration

TypeConfiguration getTypeConfiguration()

The TypeConfiguration belonging to this BootstrapContext.

See Also:

• TypeConfiguration

getFunctionRegistry

SqmFunctionRegistry getFunctionRegistry()

The SqmFunctionRegistry belonging to this BootstrapContext.

See Also:

• SqmFunctionRegistry

getCustomTypeProducer

BeanInstanceProducer getCustomTypeProducer()

The BeanInstanceProducer to use when creating custom type references.

Implementation Note:

Usually a TypeBeanInstanceProducer.

getMetadataBuildingOptions

MetadataBuildingOptions getMetadataBuildingOptions()

Options specific to building the boot metamodel

getIdentifierGeneratorFactory

default IdentifierGeneratorFactory getIdentifierGeneratorFactory()

isJpaBootstrap

boolean isJpaBootstrap()

Whether the bootstrap was initiated from JPA bootstrapping.

See Also:

• markAsJpaBootstrap()

Implementation Specification:

This is used

markAsJpaBootstrap

void markAsJpaBootstrap()

Indicates that bootstrap was initiated from JPA bootstrapping.

Implementation Specification:

Internally, false is the assumed value. We only need to call this to mark it true.

getJpaTempClassLoader

ClassLoader getJpaTempClassLoader()

Access the temporary ClassLoader passed to us, as defined by PersistenceUnitInfo.getNewTempClassLoader(), if any.

Returns:

The temporary ClassLoader

getClassLoaderAccess

ClassLoaderAccess getClassLoaderAccess()

Access to class loading capabilities.

getClassmateContext

ClassmateContext getClassmateContext()

Access to the shared ClassmateContext object used throughout the bootstrap process.

Returns:

Access to the shared ClassmateContext delegates.

getArchiveDescriptorFactory

ArchiveDescriptorFactory getArchiveDescriptorFactory()

Access to the ArchiveDescriptorFactory used for scanning.

Returns:

The ArchiveDescriptorFactory

getScanOptions

ScanOptions getScanOptions()

Access to the options to be used for scanning.

Returns:

The scan options

getScanEnvironment

ScanEnvironment getScanEnvironment()

Access to the environment for scanning.

Returns:

The scan environment

API Note:

Consider this temporary; see discussion on ScanEnvironment.

getScanner

Object getScanner()

Access to the Scanner to be used for scanning.

Can be:

• An instance of Scanner,
• a Class reference to the Scanner implementor, or
• a string naming the Scanner implementor.

Returns:

The scanner

getReflectionManager

@Internal
org.hibernate.annotations.common.reflection.ReflectionManager getReflectionManager()

Retrieve the Hibernate Commons Annotations ReflectionManager.

API Note:

Supported for internal use only. This method will go away as we migrate away from Hibernate Commons Annotations to Jandex for annotation handling and XMl to annotation merging.

getJandexView

org.jboss.jandex.IndexView getJandexView()

Access to the Jandex index passed by call to MetadataBuilder.applyIndexView(IndexView), if any.

Returns:

The Jandex index

API Note:

Jandex is currently not used, see the roadmap

getSqlFunctions

Map<String,SqmFunctionDescriptor> getSqlFunctions()

Access to any SQL functions explicitly registered with the MetadataBuilder. This does not include Dialect-registered functions.

Should never return null.

Returns:

The SqmFunctionDescriptors registered via MetadataBuilder

getAuxiliaryDatabaseObjectList

Collection<AuxiliaryDatabaseObject> getAuxiliaryDatabaseObjectList()

Access to any AuxiliaryDatabaseObjects explicitly registered with the MetadataBuilder. This does not include AuxiliaryDatabaseObjects defined in mappings.

Should never return null.

Returns:

The AuxiliaryDatabaseObjects registered via MetadataBuilder

getAttributeConverters

Collection<ConverterDescriptor> getAttributeConverters()

Access to collected AttributeConverter definitions.

Should never return null.

Returns:

The ConverterDescriptors registered via MetadataBuilder

getCacheRegionDefinitions

Collection<CacheRegionDefinition> getCacheRegionDefinitions()

Access to all explicit cache region mappings.

Should never return null.

Returns:

Explicit cache region mappings

getRepresentationStrategySelector

ManagedTypeRepresentationResolver getRepresentationStrategySelector()

See Also:

• ManagedTypeRepresentationResolver

release

void release()

Releases the "bootstrap only" resources held by this BootstrapContext.

registerAdHocBasicType

void registerAdHocBasicType(BasicType<?> basicType)

To support Envers.

resolveAdHocBasicType

<T> BasicType<T> resolveAdHocBasicType(String key)

To support Envers.