Interface SessionFactoryImplementor

All Superinterfaces:

AutoCloseable, EntityManagerFactory, Referenceable, Serializable, SessionFactory

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.
RootGraphImplementor<Map<String,?>>	createGraphForDynamicEntity(String entityName)	Create an EntityGraph which may be used from loading a dynamic entity with EntityHandler.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.
ActionQueueFactory	getActionQueueFactory()	Access to the factory for ActionQueue instances configured for this factory.
Collection<FilterDefinition>	getAutoEnabledFilters()	Obtain a collection of FilterDefinitions representing all the auto-enabled filters.
CacheImplementor	getCache()	Obtain the CacheImplementor.
ChangesetCoordinator	getChangesetCoordinator()	Efficient access to the ChangesetCoordinator.
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.
FilterDefinition	getFilterDefinition(String filterName)	Obtain the definition of a filter by name.
PlanningOptions	getGraphPlanningOptions()	Configuration for graph planning as part of the ActionQueue.
default JdbcSelectWithActionsBuilder	getJdbcSelectWithActionsBuilder()
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
StatementObserver	getStatementObserver()	Access to the StatementObserver associated with this factory.
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.
default <T> RootGraph<T>	parseEntityGraph(CharSequence graphText)	Creates a RootGraph based on the passed string representation.
default <T> RootGraph<T>	parseEntityGraph(Class<T> rootEntityClass, CharSequence graphText)	Creates a RootGraph for the given rootEntityClass and parses the graph text into it.
default <T> RootGraph<T>	parseEntityGraph(String rootEntityName, CharSequence graphText)	Creates a RootGraph for the given rootEntityName and parses the graph text into it.
Object	resolveTenantIdentifier()	Object the current tenant identifier using the resolver.
SessionBuilderImplementor	withOptions()	Obtain a session builder for creating new instances of Session with certain customized options.

Methods inherited from interface EntityManagerFactory

addListener, addNamedEntityGraph, addNamedQuery, addNamedStatement, callInTransaction, callInTransaction, createEntityAgent, getMetamodel, getNamedEntityGraphs, getNamedQueries, getNamedStatements, getPersistenceUnitUtil, getProperties, getResultSetMappings, getTransactionType, isOpen, runInTransaction, runInTransaction, unwrap

Methods inherited from interface Referenceable

getReference

Methods inherited from interface SessionFactory

addNamedQuery, close, containsFetchProfileDefinition, createEntityAgent, createEntityManager, createEntityManager, createEntityManager, createEntityManager, findEntityGraphsByType, fromSession, fromStatelessSession, fromStatelessTransaction, fromTransaction, getCriteriaBuilder, getCurrentSession, getDefinedFetchProfileNames, getDefinedFilterNames, getJndiName, getName, getSchemaManager, inSession, inStatelessSession, inStatelessTransaction, inTransaction, isClosed, openStatelessSession, openStatelessSession, 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(String)

openSession

@Nonnull
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

@Nonnull
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

@Nonnull
CacheImplementor getCache()

Obtain the CacheImplementor.

Specified by:

getCache in interface EntityManagerFactory

Specified by:

getCache in interface SessionFactory

Returns:

The direct cache access API, which is never null, not even when the second-level cache is disabled.

getStatistics

@Nonnull
StatisticsImplementor getStatistics()

Obtain the StatisticsImplementor.

Specified by:

getStatistics in interface SessionFactory

Returns:

The statistics.

getTypeConfiguration

@Nonnull
TypeConfiguration getTypeConfiguration()

Obtain the TypeConfiguration

getRuntimeMetamodels

@Nonnull
RuntimeMetamodelsImplementor getRuntimeMetamodels()

Obtain the RuntimeMetamodelsImplementor

getMappingMetamodel

@Nonnull
default MappingMetamodelImplementor getMappingMetamodel()

Obtain the MappingMetamodelImplementor

getJpaMetamodel

@Nonnull
default JpaMetamodel getJpaMetamodel()

Obtain the JpaMetamodel

getQueryEngine

@Nonnull
QueryEngine getQueryEngine()

Obtain the QueryEngine

getSqlTranslationEngine

@Nonnull
SqlTranslationEngine getSqlTranslationEngine()

Obtain the SqlTranslationEngine

getServiceRegistry

@Nonnull
ServiceRegistryImplementor getServiceRegistry()

Access to the ServiceRegistry for this SessionFactory.

Returns:

The factory's ServiceRegistry

getEventEngine

@Nonnull
EventEngine getEventEngine()

Get the EventEngine associated with this SessionFactory

getEntityNotFoundDelegate

@Nonnull
EntityNotFoundDelegate getEntityNotFoundDelegate()

Obtain the EntityNotFoundDelegate

addObserver

void addObserver(@Nonnull
 SessionFactoryObserver observer)

Register a SessionFactoryObserver of this factory.

getCustomEntityDirtinessStrategy

@Nullable
CustomEntityDirtinessStrategy getCustomEntityDirtinessStrategy()

Obtain the CustomEntityDirtinessStrategy

getCurrentTenantIdentifierResolver

@Nullable
CurrentTenantIdentifierResolver<Object> getCurrentTenantIdentifierResolver()

Obtain the CurrentTenantIdentifierResolver

resolveTenantIdentifier

@Incubating
@Nullable
Object resolveTenantIdentifier()

Object the current tenant identifier using the resolver.

Since:

7.2

getTenantIdentifierJavaType

JavaType<Object> getTenantIdentifierJavaType()

The JavaType to use for a tenant identifier.

Since:

6.4

getEventListenerGroups

@Internal
@Incubating
@Nonnull
EventListenerGroups getEventListenerGroups()

Access to the event listener groups.

Since:

7.0

getParameterMarkerStrategy

@Incubating
ParameterMarkerStrategy getParameterMarkerStrategy()

Obtain the ParameterMarkerStrategy service.

Since:

7.0

getJdbcValuesMappingProducerProvider

@Incubating
@Nonnull
JdbcValuesMappingProducerProvider getJdbcValuesMappingProducerProvider()

Obtain the JdbcServices service.

Since:

7.0

getEntityCopyObserver

@Incubating
@Nonnull
EntityCopyObserverFactory getEntityCopyObserver()

Obtain the EntityCopyObserverFactory service.

Since:

7.0

getClassLoaderService

@Incubating
@Nonnull
ClassLoaderService getClassLoaderService()

Obtain the ClassLoaderService.

Since:

7.0

getManagedBeanRegistry

@Incubating
@Nullable
ManagedBeanRegistry getManagedBeanRegistry()

Obtain the ManagedBeanRegistry service.

Since:

7.0

getEventListenerRegistry

@Incubating
@Nonnull
EventListenerRegistry getEventListenerRegistry()

Obtain the EventListenerRegistry service.

Since:

7.0

getChangesetCoordinator

@Nonnull
ChangesetCoordinator getChangesetCoordinator()

Efficient access to the ChangesetCoordinator.

getGraphPlanningOptions

@Nonnull
PlanningOptions getGraphPlanningOptions()

Configuration for graph planning as part of the ActionQueue.

getWrapperOptions

@Nonnull
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

@Nonnull
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.

getStatementObserver

@Nonnull
StatementObserver getStatementObserver()

Access to the StatementObserver associated with this factory.

getFilterDefinition

@Nonnull
FilterDefinition getFilterDefinition(@Nonnull
 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

@Nonnull
Collection<FilterDefinition> getAutoEnabledFilters()

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

getJdbcServices

@Nonnull
JdbcServices getJdbcServices()

Obtain the JdbcServices service.

getSqlStringGenerationContext

@Nonnull
SqlStringGenerationContext getSqlStringGenerationContext()

Obtain the SqlStringGenerationContext.

findEntityGraphByName

@Nullable
RootGraphImplementor<?> findEntityGraphByName(@Nonnull
 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(String, EntityGraph)

createEntityGraph

@Nonnull
default <T> RootGraphImplementor<T> createEntityGraph(@Nonnull
 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

@Nonnull
RootGraphImplementor<Map<String,?>> createGraphForDynamicEntity(@Nonnull
 String entityName)

Description copied from interface: SessionFactory

Create an EntityGraph which may be used from loading a dynamic entity with EntityHandler.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:

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

bestGuessEntityName

@Nullable
String bestGuessEntityName(@Nonnull
 Object object)

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

getJdbcSelectWithActionsBuilder

@Incubating
@Nullable
default JdbcSelectWithActionsBuilder getJdbcSelectWithActionsBuilder()

parseEntityGraph

@Nonnull
default <T> RootGraph<T> parseEntityGraph(@Nonnull
 Class<T> rootEntityClass,
 @Nonnull
 CharSequence graphText)

Description copied from interface: SessionFactory

Creates a RootGraph for the given rootEntityClass and parses the graph text into it.

Specified by:

parseEntityGraph in interface SessionFactory

Parameters:

rootEntityClass - The entity class to use as the base of the created root-graph

graphText - The textual representation of the graph

See Also:

• GraphParser.parse(Class, CharSequence, SessionFactory)
• SessionFactory.createEntityGraph(Class)

parseEntityGraph

@Incubating
@Nonnull
default <T> RootGraph<T> parseEntityGraph(@Nonnull
 String rootEntityName,
 @Nonnull
 CharSequence graphText)

Description copied from interface: SessionFactory

Creates a RootGraph for the given rootEntityName and parses the graph text into it.

Specified by:

parseEntityGraph in interface SessionFactory

Parameters:

rootEntityName - The name of the entity to use as the base of the created root-graph

graphText - The textual representation of the graph

See Also:

• GraphParser.parse(String, CharSequence, SessionFactory)
• SessionFactory.createEntityGraph(Class)

parseEntityGraph

@Incubating
@Nonnull
default <T> RootGraph<T> parseEntityGraph(@Nonnull
 CharSequence graphText)

Description copied from interface: SessionFactory

Creates a RootGraph based on the passed string representation. Here, the string representation is expected to include the root entity name.

Specified by:

parseEntityGraph in interface SessionFactory

Parameters:

graphText - The textual representation of the graph

getActionQueueFactory

@Nonnull
ActionQueueFactory getActionQueueFactory()

Access to the factory for ActionQueue instances configured for this factory.