Package org.hibernate.engine.spi

Interface SessionFactoryImplementor

All Superinterfaces:

AutoCloseable, EntityManagerFactory, Referenceable, Serializable, SessionFactory

All Known Implementing Classes:

SessionFactoryDelegatingImpl, SessionFactoryImpl

public interface SessionFactoryImplementor
extends SessionFactory

Defines the internal contract between the SessionFactory and the internal implementation of Hibernate.

See Also:

• SessionFactory
• SessionFactoryImpl

Method Summary

Modifier and Type	Method	Description
void	addObserver(SessionFactoryObserver observer)	Register a SessionFactoryObserver of this factory.
String	bestGuessEntityName(Object object)	The best guess entity name for an entity not in an association
default <T> RootGraphImplementor<T>	createEntityGraph(Class<T> entityType)	Create an EntityGraph for the given entity type.
RootGraph<Map<String,?>>	createGraphForDynamicEntity(String entityName)	Create an EntityGraph which may be used from loading a dynamic entity with EntityManager.find(EntityGraph, Object, FindOption...).
RootGraphImplementor<?>	findEntityGraphByName(String name)	Return the root EntityGraph with the given name, or null if there is no graph with the given name.
Collection<FilterDefinition>	getAutoEnabledFilters()	Obtain a collection of FilterDefinitions representing all the auto-enabled filters.
CacheImplementor	getCache()	Obtain the CacheImplementor.
ClassLoaderService	getClassLoaderService()	Obtain the ClassLoaderService.
CurrentTenantIdentifierResolver<Object>	getCurrentTenantIdentifierResolver()	Obtain the CurrentTenantIdentifierResolver
CustomEntityDirtinessStrategy	getCustomEntityDirtinessStrategy()	Obtain the CustomEntityDirtinessStrategy
EntityCopyObserverFactory	getEntityCopyObserver()	Obtain the EntityCopyObserverFactory service.
EntityNotFoundDelegate	getEntityNotFoundDelegate()	Obtain the EntityNotFoundDelegate
EventEngine	getEventEngine()	Get the EventEngine associated with this SessionFactory
EventListenerGroups	getEventListenerGroups()	Access to the event listener groups.
EventListenerRegistry	getEventListenerRegistry()	Obtain the EventListenerRegistry service.
FetchProfile	getFetchProfile(String name)	Deprecated, for removal: This API element is subject to removal in a future version. Use SqlAstCreationContext.getFetchProfile(String)
FilterDefinition	getFilterDefinition(String filterName)	Obtain the definition of a filter by name.
Generator	getGenerator(String rootEntityName)	Deprecated, for removal: This API element is subject to removal in a future version. Only used in one place, will be removed
JdbcServices	getJdbcServices()	Obtain the JdbcServices service.
JdbcValuesMappingProducerProvider	getJdbcValuesMappingProducerProvider()	Obtain the JdbcServices service.
default JpaMetamodel	getJpaMetamodel()	Obtain the JpaMetamodel
ManagedBeanRegistry	getManagedBeanRegistry()	Obtain the ManagedBeanRegistry service.
default MappingMetamodelImplementor	getMappingMetamodel()	Obtain the MappingMetamodelImplementor
ParameterMarkerStrategy	getParameterMarkerStrategy()	Obtain the ParameterMarkerStrategy service.
QueryEngine	getQueryEngine()	Obtain the QueryEngine
RuntimeMetamodelsImplementor	getRuntimeMetamodels()	Obtain the RuntimeMetamodelsImplementor
ServiceRegistryImplementor	getServiceRegistry()	Access to the ServiceRegistry for this SessionFactory.
SessionFactoryOptions	getSessionFactoryOptions()	Get the options used to build this factory.
SqlStringGenerationContext	getSqlStringGenerationContext()	Obtain the SqlStringGenerationContext.
SqlTranslationEngine	getSqlTranslationEngine()	Obtain the SqlTranslationEngine
StatisticsImplementor	getStatistics()	Obtain the StatisticsImplementor.
JavaType<Object>	getTenantIdentifierJavaType()	The JavaType to use for a tenant identifier.
TypeConfiguration	getTypeConfiguration()	Obtain the TypeConfiguration
String	getUuid()	The UUID assigned to this SessionFactory.
WrapperOptions	getWrapperOptions()	Return an instance of WrapperOptions which is not backed by a session, and whose functionality is therefore incomplete.
SessionImplementor	openSession()	Overrides SessionFactory.openSession() to widen the return type: this is useful for internal code depending on SessionFactoryImplementor as it would otherwise need to frequently resort to casting to the internal contract.
SessionImplementor	openTemporarySession()	Get a non-transactional "current" session.
SessionBuilderImplementor	withOptions()	Obtain a session builder for creating new instances of Session with certain customized options.

Methods inherited from interface jakarta.persistence.EntityManagerFactory

addNamedEntityGraph, addNamedQuery, callInTransaction, getMetamodel, getNamedEntityGraphs, getNamedQueries, getPersistenceUnitUtil, getProperties, getTransactionType, isOpen, runInTransaction, unwrap

Methods inherited from interface javax.naming.Referenceable

getReference

Methods inherited from interface org.hibernate.SessionFactory

addNamedQuery, close, containsFetchProfileDefinition, createEntityManager, createEntityManager, createEntityManager, createEntityManager, findEntityGraphsByType, fromSession, fromStatelessSession, fromStatelessTransaction, fromTransaction, getCriteriaBuilder, getCurrentSession, getDefinedFetchProfileNames, getDefinedFilterNames, getJndiName, getName, getSchemaManager, inSession, inStatelessSession, inStatelessTransaction, inTransaction, isClosed, openStatelessSession, openStatelessSession, parseEntityGraph, parseEntityGraph, parseEntityGraph, withStatelessOptions

Method Details

getUuid

String getUuid()

The UUID assigned to this SessionFactory.

The value is generated as a UUID, but kept as a string.

See Also:

• SessionFactoryRegistry.getSessionFactory(java.lang.String)

openSession

SessionImplementor openSession()

Overrides SessionFactory.openSession() to widen the return type: this is useful for internal code depending on SessionFactoryImplementor as it would otherwise need to frequently resort to casting to the internal contract.

Specified by:

openSession in interface SessionFactory

Returns:

the opened Session.

withOptions

SessionBuilderImplementor withOptions()

Obtain a session builder for creating new instances of Session with certain customized options.

Specified by:

withOptions in interface SessionFactory

Returns:

The session builder

openTemporarySession

SessionImplementor openTemporarySession()

Get a non-transactional "current" session.

API Note:

This is used by hibernate-envers.

getCache

CacheImplementor getCache()

Obtain the CacheImplementor.

Specified by:

getCache in interface EntityManagerFactory

Specified by:

getCache in interface SessionFactory

Returns:

The direct cache access API.

getStatistics

StatisticsImplementor getStatistics()

Obtain the StatisticsImplementor.

Specified by:

getStatistics in interface SessionFactory

Returns:

The statistics.

getTypeConfiguration

TypeConfiguration getTypeConfiguration()

Obtain the TypeConfiguration

getRuntimeMetamodels

RuntimeMetamodelsImplementor getRuntimeMetamodels()

Obtain the RuntimeMetamodelsImplementor

getMappingMetamodel

default MappingMetamodelImplementor getMappingMetamodel()

Obtain the MappingMetamodelImplementor

getJpaMetamodel

default JpaMetamodel getJpaMetamodel()

Obtain the JpaMetamodel

getQueryEngine

QueryEngine getQueryEngine()

Obtain the QueryEngine

getSqlTranslationEngine

SqlTranslationEngine getSqlTranslationEngine()

Obtain the SqlTranslationEngine

getServiceRegistry

ServiceRegistryImplementor getServiceRegistry()

Access to the ServiceRegistry for this SessionFactory.

Returns:

The factory's ServiceRegistry

getEventEngine

EventEngine getEventEngine()

Get the EventEngine associated with this SessionFactory

getFetchProfile

@Deprecated(since="7.0",
            forRemoval=true)
FetchProfile getFetchProfile(String name)

Deprecated, for removal: This API element is subject to removal in a future version.

Use SqlAstCreationContext.getFetchProfile(String)

Retrieve a fetch profile by name.

Parameters:

name - The name of the profile to retrieve.

Returns:

The profile definition

getGenerator

@Deprecated(since="7",
            forRemoval=true)
Generator getGenerator(String rootEntityName)

Deprecated, for removal: This API element is subject to removal in a future version.

Only used in one place, will be removed

Get the identifier generator for the hierarchy

getEntityNotFoundDelegate

EntityNotFoundDelegate getEntityNotFoundDelegate()

Obtain the EntityNotFoundDelegate

addObserver

void addObserver(SessionFactoryObserver observer)

Register a SessionFactoryObserver of this factory.

getCustomEntityDirtinessStrategy

CustomEntityDirtinessStrategy getCustomEntityDirtinessStrategy()

Obtain the CustomEntityDirtinessStrategy

getCurrentTenantIdentifierResolver

CurrentTenantIdentifierResolver<Object> getCurrentTenantIdentifierResolver()

Obtain the CurrentTenantIdentifierResolver

getTenantIdentifierJavaType

JavaType<Object> getTenantIdentifierJavaType()

The JavaType to use for a tenant identifier.

Since:

6.4

getEventListenerGroups

@Internal
@Incubating
EventListenerGroups getEventListenerGroups()

Access to the event listener groups.

Since:

7.0

getParameterMarkerStrategy

@Incubating
ParameterMarkerStrategy getParameterMarkerStrategy()

Obtain the ParameterMarkerStrategy service.

Since:

7.0

getJdbcValuesMappingProducerProvider

@Incubating
JdbcValuesMappingProducerProvider getJdbcValuesMappingProducerProvider()

Obtain the JdbcServices service.

Since:

7.0

getEntityCopyObserver

@Incubating
EntityCopyObserverFactory getEntityCopyObserver()

Obtain the EntityCopyObserverFactory service.

Since:

7.0

getClassLoaderService

@Incubating
ClassLoaderService getClassLoaderService()

Obtain the ClassLoaderService.

Since:

7.0

getManagedBeanRegistry

@Incubating
ManagedBeanRegistry getManagedBeanRegistry()

Obtain the ManagedBeanRegistry service.

Since:

7.0

getEventListenerRegistry

@Incubating
EventListenerRegistry getEventListenerRegistry()

Obtain the EventListenerRegistry service.

Since:

7.0

getWrapperOptions

WrapperOptions getWrapperOptions()

Return an instance of WrapperOptions which is not backed by a session, and whose functionality is therefore incomplete.

API Note:

Avoid using this operation.

getSessionFactoryOptions

SessionFactoryOptions getSessionFactoryOptions()

Get the options used to build this factory.

Specified by:

getSessionFactoryOptions in interface SessionFactory

Returns:

The special options used to build the factory.

getFilterDefinition

FilterDefinition getFilterDefinition(String filterName)

Obtain the definition of a filter by name.

Specified by:

getFilterDefinition in interface SessionFactory

Parameters:

filterName - The name of a declared filter

Returns:

The filter definition.

getAutoEnabledFilters

Collection<FilterDefinition> getAutoEnabledFilters()

Obtain a collection of FilterDefinitions representing all the auto-enabled filters.

getJdbcServices

JdbcServices getJdbcServices()

Obtain the JdbcServices service.

getSqlStringGenerationContext

SqlStringGenerationContext getSqlStringGenerationContext()

Obtain the SqlStringGenerationContext.

findEntityGraphByName

RootGraphImplementor<?> findEntityGraphByName(String name)

Description copied from interface: SessionFactory

Return the root EntityGraph with the given name, or null if there is no graph with the given name.

Specified by:

findEntityGraphByName in interface SessionFactory

Parameters:

name - the name given to some NamedEntityGraph

Returns:

an instance of RootGraph

See Also:

• EntityManagerFactory.addNamedEntityGraph(java.lang.String, jakarta.persistence.EntityGraph<T>)

createEntityGraph

default <T> RootGraphImplementor<T> createEntityGraph(Class<T> entityType)

Description copied from interface: SessionFactory

Create an EntityGraph for the given entity type.

Specified by:

createEntityGraph in interface SessionFactory

Parameters:

entityType - The entity type for the graph

See Also:

• SessionFactory.createGraphForDynamicEntity(String)

createGraphForDynamicEntity

RootGraph<Map<String,?>> createGraphForDynamicEntity(String entityName)

Description copied from interface: SessionFactory

Create an EntityGraph which may be used from loading a dynamic entity with EntityManager.find(EntityGraph, Object, FindOption...).

This allows a dynamic entity to be loaded without the need for a cast.

 var MyDynamicEntity_ = factory.createGraphForDynamicEntity("MyDynamicEntity");
 Map<String,?> myDynamicEntity = session.find(MyDynamicEntity_, id);
 

Specified by:

createGraphForDynamicEntity in interface SessionFactory

Parameters:

entityName - The name of the dynamic entity

See Also:

• EntityManager.find(EntityGraph, Object, FindOption...)
• SessionFactory.createEntityGraph(Class)

bestGuessEntityName

String bestGuessEntityName(Object object)

The best guess entity name for an entity not in an association