SessionFactoryImplementor (Hibernate JavaDocs)

All Superinterfaces:

AutoCloseable, Closeable, jakarta.persistence.EntityManagerFactory, HibernateEntityManagerFactory, Mapping, QueryParameterBindingTypeResolver, Referenceable, Serializable, SessionFactory, SqlAstCreationContext, SqmCreationContext

All Known Implementing Classes:

SessionFactoryDelegatingImpl, SessionFactoryImpl
```
public interface SessionFactoryImplementor
extends Mapping, SessionFactory, SqmCreationContext, SqlAstCreationContext, QueryParameterBindingTypeResolver
```
Defines the internal contract between the SessionFactory and other parts of Hibernate such as implementors of Type.

See Also:

SessionFactory, SessionFactoryImpl

Nested Class Summary

Nested Classes
Modifier and Type	Interface and Description
`static interface`	`SessionFactoryImplementor.DeserializationResolver<T extends SessionFactoryImplementor>` Contract for resolving this SessionFactory on deserialization

Nested classes/interfaces inherited from interface org.hibernate.SessionFactory
SessionFactory.TransactionManagementException

Method Summary

All Methods Instance Methods Abstract Methods Default Methods Deprecated Methods
Modifier and Type	Method and Description
`void`	`addObserver(SessionFactoryObserver observer)`
`RootGraphImplementor<?>`	`findEntityGraphByName(String name)`
`<T> List<RootGraphImplementor<? super T>>`	`findEntityGraphsByJavaType(Class<T> entityClass)`
`default <T> List<jakarta.persistence.EntityGraph<? super T>>`	`findEntityGraphsByType(Class<T> entityClass)` Find all `EntityGraph`s associated with a given entity type.
`CacheImplementor`	`getCache()` Obtain direct access to the underlying cache regions.
`default CollectionPersister`	`getCollectionPersister(String role)` Deprecated. (since 5.2) Use `MetamodelImplementor.collectionPersister(String)` instead.
`default Map<String,CollectionPersister>`	`getCollectionPersisters()` Deprecated. (since 5.2) Use `MetamodelImplementor.collectionPersisters()` instead.
`default Set<String>`	`getCollectionRolesByEntityParticipant(String entityName)` Deprecated. (since 5.2) Use `MetamodelImplementor.collectionPersisters()` instead. Retrieves a set of all the collection roles in which the given entity is a participant, as either an index or an element.
`HibernateCriteriaBuilder`	`getCriteriaBuilder()`
`CurrentTenantIdentifierResolver`	`getCurrentTenantIdentifierResolver()`
`CustomEntityDirtinessStrategy`	`getCustomEntityDirtinessStrategy()`
`SessionFactoryImplementor.DeserializationResolver`	`getDeserializationResolver()`
`default Dialect`	`getDialect()` Deprecated. (since 5.2) instead, use `JdbcServices.getDialect()`
`default MappingMetamodel`	`getDomainModel()`
`EntityNotFoundDelegate`	`getEntityNotFoundDelegate()`
`default EntityPersister`	`getEntityPersister(String entityName)` Deprecated. (since 5.2) Use `MetamodelImplementor.entityPersister(Class)` instead.
`default Map<String,EntityPersister>`	`getEntityPersisters()` Deprecated. (since 5.2) Use `MetamodelImplementor.entityPersisters()` instead.
`EventEngine`	`getEventEngine()` Get the EventEngine associated with this SessionFactory
`FastSessionServices`	`getFastSessionServices()`
`FetchProfile`	`getFetchProfile(String name)` Retrieve fetch profile by name.
`IdentifierGenerator`	`getIdentifierGenerator(String rootEntityName)` Get the identifier generator for the hierarchy
`default String[]`	`getImplementors(String entityName)` Deprecated. Use `Metamodel.getImplementors(String)` instead
`default String`	`getImportedClassName(String name)` Deprecated. Use `Metamodel.getImportedClassName(String)` instead
`JdbcServices`	`getJdbcServices()` Get the JdbcServices.
`MetamodelImplementor`	`getMetamodel()`
`String`	`getName()` Access to the name (if one) assigned to the SessionFactory
`QueryEngine`	`getQueryEngine()`
`RuntimeMetamodels`	`getRuntimeMetamodels()`
`ServiceRegistryImplementor`	`getServiceRegistry()` Access to the ServiceRegistry for this SessionFactory.
`default SessionFactoryImplementor`	`getSessionFactory()` Obtain the underlying Hibernate SessionFactory.
`Settings`	`getSettings()` Deprecated. since 5.0; use `SessionFactory.getSessionFactoryOptions()` instead
`default SQLExceptionConverter`	`getSQLExceptionConverter()` Deprecated. since 5.0; use `JdbcServices.getSqlExceptionHelper()` -> `SqlExceptionHelper.getSqlExceptionConverter()` instead as obtained from `getServiceRegistry()`
`default SqlExceptionHelper`	`getSQLExceptionHelper()` Deprecated. since 5.0; use `JdbcServices.getSqlExceptionHelper()` instead as obtained from `getServiceRegistry()`
`StatisticsImplementor`	`getStatistics()` Retrieve the statistics for this factory.
`default StatisticsImplementor`	`getStatisticsImplementor()` Deprecated. (since 5.2) Just use `getStatistics()` (with covariant return here as `StatisticsImplementor`).
`TypeConfiguration`	`getTypeConfiguration()`
`String`	`getUuid()` Get the UUID for this SessionFactory.
`WrapperOptions`	`getWrapperOptions()`
`default Iterable<EntityNameResolver>`	`iterateEntityNameResolvers()` Deprecated. (since 5.2) use `getMetamodel()` -> `MetamodelImplementor.getEntityNameResolvers()`
`default EntityPersister`	`locateEntityPersister(Class byClass)` Deprecated. (since 5.2) Use `MetamodelImplementor.locateEntityPersister(Class)` instead.
`default EntityPersister`	`locateEntityPersister(String byName)` Deprecated. (since 5.2) Use `MetamodelImplementor.locateEntityPersister(String)` instead.
`Session`	`openTemporarySession()` Get a non-transactional "current" session (used by hibernate-envers)
`SessionBuilderImplementor`	`withOptions()` Obtain a `Session` builder.

Methods inherited from interface org.hibernate.engine.spi.Mapping
getIdentifierGeneratorFactory, getIdentifierPropertyName, getIdentifierType, getReferencedPropertyType

Methods inherited from interface org.hibernate.jpa.HibernateEntityManagerFactory
getEntityManagerFactoryName, getEntityTypeByName

Methods inherited from interface jakarta.persistence.EntityManagerFactory
addNamedEntityGraph, addNamedQuery, createEntityManager, createEntityManager, createEntityManager, createEntityManager, getPersistenceUnitUtil, getProperties, isOpen, unwrap

Methods inherited from interface javax.naming.Referenceable
getReference

Methods inherited from interface org.hibernate.query.sqm.spi.SqmCreationContext
getJpaMetamodel, getNodeBuilder

Methods inherited from interface org.hibernate.sql.ast.spi.SqlAstCreationContext
getMaximumFetchDepth

Methods inherited from interface org.hibernate.query.spi.QueryParameterBindingTypeResolver
resolveParameterBindType, resolveParameterBindType

- Method Detail
  - getUuid
```
String getUuid()
```
    Get the UUID for this SessionFactory. The value is generated as a UUID, but kept as a String.
    
    Returns:
    
    The UUID for this SessionFactory.
    
    See Also:
    
    SessionFactoryRegistry.getSessionFactory(java.lang.String)
  - getName
```
String getName()
```
    Access to the name (if one) assigned to the SessionFactory
    
    Returns:
    
    The name for the SessionFactory
  - getTypeConfiguration
```
TypeConfiguration getTypeConfiguration()
```
    Specified by:
    
    getTypeConfiguration in interface QueryParameterBindingTypeResolver
  - getSessionFactory
```
default SessionFactoryImplementor getSessionFactory()
```
    Description copied from interface: HibernateEntityManagerFactory
    
    Obtain the underlying Hibernate SessionFactory.
    
    Specified by:
    
    getSessionFactory in interface HibernateEntityManagerFactory
    
    Specified by:
    
    getSessionFactory in interface SqlAstCreationContext
    
    Returns:
    
    The underlying Hibernate SessionFactory
  - getDomainModel
```
default MappingMetamodel getDomainModel()
```
    Specified by:
    
    getDomainModel in interface SqlAstCreationContext
  - getQueryEngine
```
QueryEngine getQueryEngine()
```
    Specified by:
    
    getQueryEngine in interface SqmCreationContext
  - getCriteriaBuilder
```
HibernateCriteriaBuilder getCriteriaBuilder()
```
    Specified by:
    
    getCriteriaBuilder in interface jakarta.persistence.EntityManagerFactory
  - withOptions
```
SessionBuilderImplementor withOptions()
```
    Description copied from interface: SessionFactory
    
    Obtain a Session builder.
    
    Specified by:
    
    withOptions in interface SessionFactory
    
    Returns:
    
    The session builder
  - openTemporarySession
```
Session openTemporarySession()
                      throws HibernateException
```
    Get a non-transactional "current" session (used by hibernate-envers)
    
    Throws:
    
    HibernateException
  - getCache
```
CacheImplementor getCache()
```
    Description copied from interface: SessionFactory
    
    Obtain direct access to the underlying cache regions.
    
    Specified by:
    
    getCache in interface jakarta.persistence.EntityManagerFactory
    
    Specified by:
    
    getCache in interface SessionFactory
    
    Returns:
    
    The direct cache access API.
  - getStatistics
```
StatisticsImplementor getStatistics()
```
    Description copied from interface: SessionFactory
    
    Retrieve the statistics for this factory.
    
    Specified by:
    
    getStatistics in interface SessionFactory
    
    Returns:
    
    The statistics.
  - getRuntimeMetamodels
```
RuntimeMetamodels getRuntimeMetamodels()
```
  - getServiceRegistry
```
ServiceRegistryImplementor getServiceRegistry()
```
    Access to the ServiceRegistry for this SessionFactory.
    
    Specified by:
    
    getServiceRegistry in interface SqlAstCreationContext
    
    Specified by:
    
    getServiceRegistry in interface SqmCreationContext
    
    Returns:
    
    The factory's ServiceRegistry
  - getEventEngine
```
EventEngine getEventEngine()
```
    Get the EventEngine associated with this SessionFactory
  - getFetchProfile
```
FetchProfile getFetchProfile(String name)
```
    Retrieve fetch profile by name.
    
    Parameters:
    
    name - The name of the profile to retrieve.
    
    Returns:
    
    The profile definition
  - getIdentifierGenerator
```
IdentifierGenerator getIdentifierGenerator(String rootEntityName)
```
    Get the identifier generator for the hierarchy
  - getEntityNotFoundDelegate
```
EntityNotFoundDelegate getEntityNotFoundDelegate()
```
  - addObserver
```
void addObserver(SessionFactoryObserver observer)
```
  - getCustomEntityDirtinessStrategy
```
CustomEntityDirtinessStrategy getCustomEntityDirtinessStrategy()
```
  - getCurrentTenantIdentifierResolver
```
CurrentTenantIdentifierResolver getCurrentTenantIdentifierResolver()
```
  - iterateEntityNameResolvers
```
@Deprecated
default Iterable<EntityNameResolver> iterateEntityNameResolvers()
```
    Deprecated. (since 5.2) use getMetamodel() -> MetamodelImplementor.getEntityNameResolvers()
  - getFastSessionServices
```
FastSessionServices getFastSessionServices()
```
    Returns:
    
    the FastSessionServices instance associated with this SessionFactory
  - getWrapperOptions
```
WrapperOptions getWrapperOptions()
```
  - getDeserializationResolver
```
SessionFactoryImplementor.DeserializationResolver getDeserializationResolver()
```
  - getStatisticsImplementor
```
@Deprecated
default StatisticsImplementor getStatisticsImplementor()
```
    Deprecated. (since 5.2) Just use getStatistics() (with covariant return here as StatisticsImplementor).
  - getJdbcServices
```
JdbcServices getJdbcServices()
```
    Get the JdbcServices.
    
    Returns:
    
    the JdbcServices
  - getDialect
```
@Deprecated
default Dialect getDialect()
```
    Deprecated. (since 5.2) instead, use JdbcServices.getDialect()
    
    Get the SQL dialect.
    Shorthand for getJdbcServices().getDialect()
    
    Returns:
    
    The dialect
  - getSQLExceptionConverter
```
@Deprecated
default SQLExceptionConverter getSQLExceptionConverter()
```
    Deprecated. since 5.0; use JdbcServices.getSqlExceptionHelper() -> SqlExceptionHelper.getSqlExceptionConverter() instead as obtained from getServiceRegistry()
    
    Retrieves the SQLExceptionConverter in effect for this SessionFactory.
    
    Returns:
    
    The SQLExceptionConverter for this SessionFactory.
  - getSQLExceptionHelper
```
@Deprecated
default SqlExceptionHelper getSQLExceptionHelper()
```
    Deprecated. since 5.0; use JdbcServices.getSqlExceptionHelper() instead as obtained from getServiceRegistry()
    
    Retrieves the SqlExceptionHelper in effect for this SessionFactory.
    
    Returns:
    
    The SqlExceptionHelper for this SessionFactory.
  - getSettings
```
@Deprecated
Settings getSettings()
```
    Deprecated. since 5.0; use SessionFactory.getSessionFactoryOptions() instead
  - getMetamodel
```
MetamodelImplementor getMetamodel()
```
    Specified by:
    
    getMetamodel in interface jakarta.persistence.EntityManagerFactory
    
    Specified by:
    
    getMetamodel in interface HibernateEntityManagerFactory
  - findEntityGraphsByType
```
default <T> List<jakarta.persistence.EntityGraph<? super T>> findEntityGraphsByType(Class<T> entityClass)
```
    Description copied from interface: HibernateEntityManagerFactory
    
    Find all EntityGraphs associated with a given entity type.
    
    Specified by:
    
    findEntityGraphsByType in interface HibernateEntityManagerFactory
    
    Parameters:
    
    entityClass - the entity type for which to find all EntityGraphs.
    
    Returns:
    
    A list of EntityGraph instances associated with the given entity type. The empty list is returned in case there are not entity graphs.
  - findEntityGraphsByJavaType
```
<T> List<RootGraphImplementor<? super T>> findEntityGraphsByJavaType(Class<T> entityClass)
```
  - findEntityGraphByName
```
RootGraphImplementor<?> findEntityGraphByName(String name)
```
  - getEntityPersister
```
@Deprecated
default EntityPersister getEntityPersister(String entityName)
                                                throws MappingException
```
    Deprecated. (since 5.2) Use MetamodelImplementor.entityPersister(Class) instead.
    
    Throws:
    
    MappingException
  - getEntityPersisters
```
@Deprecated
default Map<String,EntityPersister> getEntityPersisters()
```
    Deprecated. (since 5.2) Use MetamodelImplementor.entityPersisters() instead.
  - getCollectionPersister
```
@Deprecated
default CollectionPersister getCollectionPersister(String role)
                                                        throws MappingException
```
    Deprecated. (since 5.2) Use MetamodelImplementor.collectionPersister(String) instead.
    
    Throws:
    
    MappingException
  - getCollectionPersisters
```
@Deprecated
default Map<String,CollectionPersister> getCollectionPersisters()
```
    Deprecated. (since 5.2) Use MetamodelImplementor.collectionPersisters() instead.
  - getCollectionRolesByEntityParticipant
```
@Deprecated
default Set<String> getCollectionRolesByEntityParticipant(String entityName)
```
    Deprecated. (since 5.2) Use MetamodelImplementor.collectionPersisters() instead. Retrieves a set of all the collection roles in which the given entity is a participant, as either an index or an element.
    
    Parameters:
    
    entityName - The entity name for which to get the collection roles.
    
    Returns:
    
    set of all the collection roles in which the given entityName participates.
  - locateEntityPersister
```
@Deprecated
default EntityPersister locateEntityPersister(Class byClass)
```
    Deprecated. (since 5.2) Use MetamodelImplementor.locateEntityPersister(Class) instead.
  - locateEntityPersister
```
@Deprecated
default EntityPersister locateEntityPersister(String byName)
```
    Deprecated. (since 5.2) Use MetamodelImplementor.locateEntityPersister(String) instead.
  - getImplementors
```
@Deprecated
default String[] getImplementors(String entityName)
```
    Deprecated. Use Metamodel.getImplementors(String) instead
    
    Get the names of all persistent classes that implement/extend the given interface/class
  - getImportedClassName
```
@Deprecated
default String getImportedClassName(String name)
```
    Deprecated. Use Metamodel.getImportedClassName(String) instead
    
    Get a class name, using query language imports

Interface SessionFactoryImplementor

Nested Class Summary

Nested classes/interfaces inherited from interface org.hibernate.SessionFactory

Method Summary

Methods inherited from interface org.hibernate.engine.spi.Mapping

Methods inherited from interface org.hibernate.SessionFactory

Methods inherited from interface org.hibernate.jpa.HibernateEntityManagerFactory

Methods inherited from interface jakarta.persistence.EntityManagerFactory

Methods inherited from interface javax.naming.Referenceable

Methods inherited from interface org.hibernate.query.sqm.spi.SqmCreationContext

Methods inherited from interface org.hibernate.sql.ast.spi.SqlAstCreationContext

Methods inherited from interface org.hibernate.query.spi.QueryParameterBindingTypeResolver

Method Detail

getUuid

getName

getTypeConfiguration

getSessionFactory

getDomainModel

getQueryEngine

getCriteriaBuilder

withOptions

openTemporarySession

getCache

getStatistics

getRuntimeMetamodels

getServiceRegistry

getEventEngine

getFetchProfile

getIdentifierGenerator

getEntityNotFoundDelegate

addObserver

getCustomEntityDirtinessStrategy

getCurrentTenantIdentifierResolver

iterateEntityNameResolvers

getFastSessionServices

getWrapperOptions

getDeserializationResolver

getStatisticsImplementor

getJdbcServices

getDialect

getSQLExceptionConverter

getSQLExceptionHelper

getSettings

getMetamodel

findEntityGraphsByType

findEntityGraphsByJavaType

findEntityGraphByName

getEntityPersister

getEntityPersisters

getCollectionPersister

getCollectionPersisters

getCollectionRolesByEntityParticipant

locateEntityPersister

locateEntityPersister

getImplementors

getImportedClassName