Hibernate O/RM Aggregated JavaDocs

Hibernate provides both
  • a native API comprised centrally around SessionFactory and Session
  • an implementation of the Java Persistence API (JPA). See the latest JPA JSR for details.

Native API

In addition to SessionFactory and Session, applications using the native API will often utilize the following interfaces: These interfaces are fully intended to be exposed to application code.

JPA

The JPA interfaces are all defined by the JPA specification. For details see javax.persistence. Not that since 5.2 Hibernate extends JPA (e.g. SessionFactory extends EntityManagerFactory) rather than wrapping it.

Note about package categories

Hibernate categorizes packages into a number of groups based on intended consumers:
  • API - classes to which application code will generally bind directly. These are generally classes which do not have "spi" nor "internal" in their package path and are not under the "org.hibernate.testing" package
  • SPI - classes to which integrator developers will commonly bind directly in order to develop extensions to Hibernate, or to alter its behavior in some way. These are generally under packages with "spi" in the package path.
  • Testing Support - classes from the hibernate-testing artifact used in building Hibernate test cases. These are classes under the "org.hibernate.testing" package
Complete Hibernate documentation may be found online at http://hibernate.org/orm/documentation/
Packages
Package Description
org.hibernate
org.hibernate.action.spi
Defines SPI hooks into the ActionQueue.
org.hibernate.annotations
Package containing all the Hibernate specific annotations.
org.hibernate.boot
This package contains the contracts that make up the Hibernate native bootstrapping API (building a SessionFactory).
org.hibernate.boot.archive.scan.spi
org.hibernate.boot.archive.spi
Defines the SPI for support of "scanning" of "archives".
org.hibernate.boot.cfgxml.spi
org.hibernate.boot.jaxb
org.hibernate.boot.jaxb.cfg.spi
org.hibernate.boot.jaxb.hbm.spi
org.hibernate.boot.jaxb.mapping.spi
org.hibernate.boot.jaxb.spi
org.hibernate.boot.model
org.hibernate.boot.model.convert.spi
org.hibernate.boot.model.naming
Represents a proposed new approach to allowing hooks into the process of determining the name of database objects (tables, columns, constraints, etc).
org.hibernate.boot.model.process.spi
org.hibernate.boot.model.relational
org.hibernate.boot.model.source.spi
org.hibernate.boot.registry
Defines service registry contracts application are likely to want to utilize for configuring Hibernate behavior.
org.hibernate.boot.registry.classloading.spi
The class loading service SPI.
org.hibernate.boot.registry.selector
Defines a feature-set around named registration of implementations of various contracts and the ability to select those implementations.
org.hibernate.boot.registry.selector.spi
Defines actual contract used for strategy selection : StrategySelector.
org.hibernate.boot.spi
org.hibernate.boot.xsd
Support for XSD handling, specifically for ORM mappings (Hibernate's `hbm.xml` and JPA's `orm.xml`) and config files (Hibernate's `cfg.xml` and JPA's `persistence.xml`)
org.hibernate.bytecode
org.hibernate.bytecode.enhance.spi
package defining bytecode code enhancement (instrumentation) support.
org.hibernate.bytecode.enhance.spi.interceptor
interceptor implementations
org.hibernate.bytecode.spi
Package defining bytecode code enhancement (instrumentation) support.
org.hibernate.cache
org.hibernate.cache.cfg.spi
org.hibernate.cache.jcache
Hibernate caching provider for JSR-107 compliant caches.
org.hibernate.cache.spi
Defines the integration aspect of Hibernate's second-level caching allowing "caching back ends" to be plugged in as a caching provider.
org.hibernate.cache.spi.access
org.hibernate.cache.spi.entry
org.hibernate.cache.spi.support
Package intended for simplifying the worked needed to implement a caching provider.
org.hibernate.cfg
org.hibernate.cfg.annotations
org.hibernate.cfg.annotations.reflection
Defines the capability to merge mapping information from both annotations and orm.xml sources into a unified set of metadata in the Hibernate commons-annotations model.
org.hibernate.cfg.beanvalidation
org.hibernate.classic
org.hibernate.collection.spi
SPI definitions for persistent collections
org.hibernate.context
Defines support for "current session" feature.
org.hibernate.context.spi
SPI level contracts around "current session" support.
org.hibernate.criterion
org.hibernate.dialect
org.hibernate.dialect.function
org.hibernate.dialect.hint
org.hibernate.dialect.identity
org.hibernate.dialect.lock
Support for Dialect-specific locking strategies
org.hibernate.dialect.pagination
Support for Dialect-specific pagination strategies
org.hibernate.dialect.unique
Support for Dialect-specific unique constraint definition
org.hibernate.ejb
org.hibernate.engine
org.hibernate.engine.config.spi
SPI Package for the configuration service.
org.hibernate.engine.jdbc
Support for various aspects of JDBC interaction
org.hibernate.engine.jdbc.batch.spi
Defines contracts for JDBC batching support.
org.hibernate.engine.jdbc.connections.spi
Defines contracts for accessing JDBC Connections
org.hibernate.engine.jdbc.cursor.spi
Defines contracts for JDBC REF_CURSOR support.
org.hibernate.engine.jdbc.dialect.spi
Contracts supporting Dialect resolution (from JDBC metadata) and Dialect building.
org.hibernate.engine.jdbc.env.spi
org.hibernate.engine.jdbc.spi
SPI contracts for supporting various aspects of JDBC interaction
org.hibernate.engine.jndi
Support for JNDI within Hibernate
org.hibernate.engine.jndi.spi
The SPI contracts for Hibernate JNDI support
org.hibernate.engine.profile
Models the fetch profiles defined by the application
org.hibernate.engine.query
org.hibernate.engine.query.spi
Defines support for query plans and stored metadata about queries
org.hibernate.engine.query.spi.sql
org.hibernate.engine.spi
org.hibernate.engine.transaction.jta.platform.spi
org.hibernate.engine.transaction.spi
org.hibernate.envers
org.hibernate.envers.boot.spi
org.hibernate.envers.configuration
org.hibernate.envers.enhanced
org.hibernate.envers.event.spi
org.hibernate.envers.exception
org.hibernate.envers.query
org.hibernate.envers.query.criteria
org.hibernate.envers.query.order
org.hibernate.envers.query.projection
org.hibernate.envers.strategy
org.hibernate.envers.strategy.spi
org.hibernate.envers.tools
org.hibernate.event.service.spi
org.hibernate.event.spi
org.hibernate.exception
org.hibernate.exception.spi
org.hibernate.graph
Hibernate's (extended) support for JPA's entity graphs
org.hibernate.graph.spi
org.hibernate.hql.spi
org.hibernate.hql.spi.id
Support for multi-table update and delete statements via id-tables.
org.hibernate.hql.spi.id.cte
org.hibernate.hql.spi.id.global
org.hibernate.hql.spi.id.inline
org.hibernate.hql.spi.id.local
org.hibernate.hql.spi.id.persistent
Package contains an implementation of MultiTableBulkIdStrategy based on the use of a persistent (ANSI SQL term) table to hold id values.
org.hibernate.id
org.hibernate.id.enhanced
Enhanced/improved versions of table and sequence based identifier generators targeting portability and unified configuration
org.hibernate.id.factory
org.hibernate.id.factory.spi
org.hibernate.id.insert
org.hibernate.id.uuid
org.hibernate.integrator.spi
org.hibernate.jdbc
org.hibernate.jmx.spi
org.hibernate.jpa
org.hibernate.jpa.boot.spi
org.hibernate.jpa.event.spi
The SPI contracts for supporting JPA lifecycle callbacks.
org.hibernate.jpa.event.spi.jpa
org.hibernate.jpa.spi
org.hibernate.jpamodelgen
The main package of this annotation processor.
org.hibernate.jpamodelgen.annotation
Implementation of the model classes backed by annotations.
org.hibernate.jpamodelgen.model
org.hibernate.jpamodelgen.util
Helper classes for string and type processing as well as access type detection.
org.hibernate.jpamodelgen.util.xml
XML helper classes.
org.hibernate.jpamodelgen.xml
Implementation of the model classes backed by annotations.
org.hibernate.jpamodelgen.xml.jaxb
org.hibernate.loader
org.hibernate.loader.collection
org.hibernate.loader.collection.plan
org.hibernate.loader.criteria
org.hibernate.loader.custom
org.hibernate.loader.custom.sql
org.hibernate.loader.entity
org.hibernate.loader.entity.plan
Support for entity loaders built on top of the org.hibernate.loader.plan API to apply entity-graphs
org.hibernate.loader.hql
org.hibernate.loader.plan.build.spi
Defines the SPI for building a metamodel-driven LoadPlan
org.hibernate.loader.plan.exec.process.spi
org.hibernate.loader.plan.exec.query.spi
Defines the SPI for obtaining values for options that impact the load query.
org.hibernate.loader.plan.exec.spi
Defines the SPI for the load query generated for the LoadPlan and the ResultSet processor.
org.hibernate.loader.plan.spi
Defines the SPI for the building blocks that make up a LoadPlan.
org.hibernate.loader.spi
org.hibernate.lob
org.hibernate.mapping
org.hibernate.metadata
org.hibernate.metamodel.model.convert.spi
org.hibernate.metamodel.model.domain
org.hibernate.metamodel.model.domain.spi
org.hibernate.metamodel.spi
org.hibernate.orm.tooling.maven
org.hibernate.osgi
Main OSGi support classes
org.hibernate.param
org.hibernate.persister.collection
org.hibernate.persister.entity
org.hibernate.persister.spi
org.hibernate.persister.walking.spi
org.hibernate.pretty
org.hibernate.procedure
org.hibernate.procedure.spi
org.hibernate.property.access.spi
Defines strategies for accessing the persistent properties of an entity or composite.
org.hibernate.proxy
org.hibernate.proxy.map
org.hibernate.proxy.pojo
org.hibernate.proxy.pojo.bytebuddy
org.hibernate.query
org.hibernate.query.criteria
org.hibernate.query.procedure
org.hibernate.query.procedure.spi
org.hibernate.query.spi
org.hibernate.resource.beans.container.spi
org.hibernate.resource.beans.spi
org.hibernate.resource.jdbc
org.hibernate.resource.jdbc.spi
org.hibernate.resource.transaction
Defines the resource-level transaction capabilities of Hibernate, which revolves around the TransactionCoordinator contract.
org.hibernate.resource.transaction.backend.jdbc.spi
org.hibernate.resource.transaction.spi
Extended SPI contracts for the resource-level transaction capabilities of Hibernate.
org.hibernate.result
org.hibernate.result.spi
org.hibernate.secure.spi
org.hibernate.service
org.hibernate.service.spi
org.hibernate.spatial
org.hibernate.spatial.criterion
org.hibernate.spatial.dialect
org.hibernate.spatial.dialect.cockroachdb
SpatialDialects for CockroachDB
org.hibernate.spatial.dialect.db2
org.hibernate.spatial.dialect.h2geodb
org.hibernate.spatial.dialect.hana
org.hibernate.spatial.dialect.mariadb
org.hibernate.spatial.dialect.mysql
org.hibernate.spatial.dialect.oracle
org.hibernate.spatial.dialect.oracle.criterion
org.hibernate.spatial.dialect.postgis
org.hibernate.spatial.dialect.sqlserver
org.hibernate.spatial.integration
org.hibernate.spatial.jts
org.hibernate.spatial.predicate
org.hibernate.sql
org.hibernate.sql.ast
org.hibernate.sql.ordering.antlr
org.hibernate.stat
org.hibernate.stat.spi
org.hibernate.testing
org.hibernate.testing.async
org.hibernate.testing.boot
org.hibernate.testing.bytecode.enhancement
org.hibernate.testing.byteman
org.hibernate.testing.cache
org.hibernate.testing.cleaner
org.hibernate.testing.common.connections
org.hibernate.testing.env
org.hibernate.testing.jdbc
org.hibernate.testing.jdbc.leak
org.hibernate.testing.jta
org.hibernate.testing.junit4
org.hibernate.testing.logger
org.hibernate.testing.orm.domain
org.hibernate.testing.orm.domain.animal
Standard model for Hibernate's legacy Animal model used in HQL testing
org.hibernate.testing.orm.domain.contacts
org.hibernate.testing.orm.domain.gambit
org.hibernate.testing.orm.domain.helpdesk
org.hibernate.testing.orm.domain.retail
org.hibernate.testing.orm.jpa
org.hibernate.testing.orm.junit
org.hibernate.testing.orm.transaction
org.hibernate.testing.schema
org.hibernate.testing.transaction
org.hibernate.testing.util
org.hibernate.testing.util.jpa
org.hibernate.tool.enhance
org.hibernate.tool.hbm2ddl
org.hibernate.tool.schema
org.hibernate.tool.schema.ast
org.hibernate.tool.schema.extract.spi
org.hibernate.tool.schema.spi
org.hibernate.transform
org.hibernate.tuple
org.hibernate.tuple.component
org.hibernate.tuple.entity
org.hibernate.type
org.hibernate.type.descriptor
org.hibernate.type.descriptor.converter
Support for handling JPA AttributeConverter instances as part of the Hibernate Type system.
org.hibernate.type.descriptor.java
org.hibernate.type.descriptor.java.spi
org.hibernate.type.descriptor.spi
org.hibernate.type.descriptor.sql
Defines handling of the standard JDBC-defined types.
org.hibernate.type.descriptor.sql.spi
org.hibernate.type.spi
org.hibernate.usertype