Package org.hibernate.boot

package org.hibernate.boot

This package contains the interfaces that make up the bootstrap API for Hibernate. They collectively provide a way to specify configuration information and construct a new instance of SessionFactory.

Configuring Hibernate using these APIs usually involves working with:

1. StandardServiceRegistryBuilder, then
2. MetadataSources and MetadataBuilder, and
3. finally, with SessionFactoryBuilder.

StandardServiceRegistry standardRegistry =
        new StandardServiceRegistryBuilder()
                // supply a configuration
                .configure("org/hibernate/example/hibernate.cfg.xml")
                // set a configuration property
                .applySetting(AvailableSettings.HBM2DDL_AUTO,
                              SchemaAutoTooling.CREATE_DROP.externalForm())
                .build();
MetadataBuilder metadataBuilder =
        new MetadataSources(standardRegistry)
                // supply annotated classes
                .addAnnotatedClass(MyEntity.class)
                .addAnnotatedClassName("org.hibernate.example.Customer")
                // supply XML-based mappings
                .addResource("org/hibernate/example/Order.hbm.xml")
                .addResource("org/hibernate/example/Product.orm.xml")
                .getMetadataBuilder();
Metadata metadata =
        metadataBuilder
                // set the naming strategies
                .applyImplicitNamingStrategy(ImplicitNamingStrategyJpaCompliantImpl.INSTANCE)
                .applyPhysicalNamingStrategy(new CustomPhysicalNamingStrategy())
                // add a TypeContributor
                .applyTypes(new CustomTypeContributor())
                .build();
SessionFactoryBuilder sessionFactoryBuilder =
        metadata.getSessionFactoryBuilder();
SessionFactory sessionFactory =
        sessionFactoryBuilder
                // supply a factory-level Interceptor
                .applyInterceptor(new CustomSessionFactoryInterceptor());
                // add a custom observer
                .addSessionFactoryObservers(new CustomSessionFactoryObserver());
                // apply a CDI BeanManager (for JPA event listeners)
                .applyBeanManager(getBeanManager());
                .build();

In more advanced scenarios, BootstrapServiceRegistryBuilder might also be used.

See the Native Bootstrapping guide for more details.

Included in subpackages under this namespace are:

• implementations of ServiceRegistry used during the bootstrap process,
• implementations of MetadataBuilder and Metadata, and SessionFactoryBuilder,
• support for ImplicitNamingStrategy and PhysicalNamingStrategy,
• a range of SPIs allowing integration with the process of building metadata,
• internal code for parsing and interpreting mapping information declared in XML or using annotations,
• support for integrating an implementation of Bean Validation, such as Hibernate Validator, and
• some SPIs used for schema management, including support for exporting auxiliary database objects, and for determining the order of columns in generated DDL statements.

Related Packages

Package	Description
org.hibernate	This package defines the central Hibernate APIs, beginning with SessionFactory, which represents an instance of Hibernate at runtime and is the source of new instances of Session and StatelessSession, the most important APIs exposing persistence-related operations for entities.
org.hibernate.boot.beanvalidation	Support for integrating Jakarta Bean Validation.
org.hibernate.boot.model	This package defines the boot-time metamodel, which is an interpretation of the domain model (entity classes, embeddable classes, and attributes) and the mapping of these "domain model parts" to the database.
org.hibernate.boot.models	Overall, this module is responsible for taking managed-resources and building the hibernate-models model (ClassDetails, etc.) to ultimately be bound into Hibernate's boot-time model.
org.hibernate.boot.query	Support for handling named queries during the bootstrap process.
org.hibernate.boot.registry	Defines service registry contracts a program may use for configuring Hibernate.
org.hibernate.boot.spi	A range of SPIs allowing integration with—and customization of—the process of building metadata.
org.hibernate.boot.xsd	Support for XSD handling.

Class	Description
BootLogging	Logging related to Hibernate bootstrapping
CacheRegionDefinition	Models the definition of caching settings for a particular region.
CacheRegionDefinition.CacheRegionType
InvalidMappingException	Indicates a problem parsing the mapping document at a given Origin.
MappingException	Indicates a problem parsing a mapping document.
MappingNotFoundException	Indicates that a mapping document could not be found at a given Origin.
Metadata	Represents the ORM model as determined by aggregating the provided mapping sources.
MetadataBuilder	Contract for specifying various overrides to be used in metamodel building.
MetadataSources	Entry point for working with sources of O/R mapping metadata, either in the form of annotated classes, or as XML mapping documents.
ResourceLocator	Abstraction for locating class-path resources
ResourceStreamLocator	Abstraction for locating class-path resources
SchemaAutoTooling	Deprecated, for removal: This API element is subject to removal in a future version. This enumeration is currently unused and will be removed.
SessionFactoryBuilder	The contract for building a SessionFactory given a specified set of options.
TempTableDdlTransactionHandling	Deprecated. All dialects currently use TempTableDdlTransactionHandling.NONE, so it's obsolete.
UnsupportedOrmXsdVersionException	Specialized exception indicating that an unsupported orm.xml XSD version was specified