Package org.hibernate.internal

Class SessionFactoryImpl

java.lang.Object

org.hibernate.internal.QueryParameterBindingTypeResolverImpl

org.hibernate.internal.SessionFactoryImpl

All Implemented Interfaces:

EntityManagerFactory, Closeable, Serializable, AutoCloseable, Referenceable, Mapping, SessionFactoryImplementor, QueryParameterBindingTypeResolver, SqmCreationContext, SessionFactory, SqlAstCreationContext

public class SessionFactoryImpl
extends QueryParameterBindingTypeResolverImpl
implements SessionFactoryImplementor

Concrete implementation of the SessionFactory API.

Exposes two interfaces:

• SessionFactory to the application, and
• SessionImplementor (an SPI interface) to other subsystems.

This class is thread-safe.

See Also:

Serialized Form

Implementation Note:

This class must appear immutable to clients, even if it does all kinds of caching and pooling under the covers. It is crucial that the class is not only thread-safe, but also highly concurrent. Synchronization must be used extremely sparingly.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	SessionFactoryImpl.SessionBuilderImpl
static class	SessionFactoryImpl.StatelessSessionBuilderImpl

Nested classes/interfaces inherited from interface org.hibernate.engine.spi.SessionFactoryImplementor

SessionFactoryImplementor.DeserializationResolver<T extends SessionFactoryImplementor>

Constructor Summary

Constructors

Constructor	Description
SessionFactoryImpl(MetadataImplementor bootMetamodel, SessionFactoryOptions options)	Deprecated, for removal: This API element is subject to removal in a future version. This constructor will be removed
SessionFactoryImpl(MetadataImplementor bootMetamodel, SessionFactoryOptions options, BootstrapContext bootstrapContext)

Method Summary

Modifier and Type	Method	Description
<T> void	addNamedEntityGraph(String graphName, EntityGraph<T> entityGraph)
void	addNamedQuery(String name, Query query)
void	addObserver(SessionFactoryObserver observer)
String	bestGuessEntityName(Object object)	The best guess entity name for an entity not in an association
void	close()	Closes the session factory, releasing all held resources.
static Interceptor	configuredInterceptor(Interceptor interceptor, boolean explicitNoInterceptor, SessionFactoryOptions options)
static Interceptor	configuredInterceptor(Interceptor interceptor, SessionFactoryOptions options)	Deprecated. use configuredInterceptor(Interceptor, boolean, SessionFactoryOptions)
boolean	containsFetchProfileDefinition(String name)	Determine if there is a fetch profile definition registered under the given name.
Session	createEntityManager()
Session	createEntityManager(SynchronizationType synchronizationType)
Session	createEntityManager(SynchronizationType synchronizationType, Map map)
Session	createEntityManager(Map map)
RootGraphImplementor<?>	findEntityGraphByName(String name)	Return the root EntityGraph with the given name, or null if there is no graph with the given name.
<T> List<EntityGraph<? super T>>	findEntityGraphsByType(Class<T> entityClass)	Return all EntityGraphs registered for the given entity type.
CacheImplementor	getCache()	Obtain direct access to the underlying cache regions.
CollectionMetadata	getCollectionMetadata(String roleName)
NodeBuilder	getCriteriaBuilder()	Obtain a HibernateCriteriaBuilder which may be used to construct criteria queries.
Session	getCurrentSession()	Obtains the current session, an instance of Session implicitly associated with some context or scope.
CurrentTenantIdentifierResolver<Object>	getCurrentTenantIdentifierResolver()
CustomEntityDirtinessStrategy	getCustomEntityDirtinessStrategy()
Set<String>	getDefinedFetchProfileNames()	Obtain the set of names of all defined fetch profiles.
Set<String>	getDefinedFilterNames()	Obtain the set of names of all defined filters.
SessionFactoryImplementor.DeserializationResolver<?>	getDeserializationResolver()	Deprecated.
EntityNotFoundDelegate	getEntityNotFoundDelegate()
EventEngine	getEventEngine()	Get the EventEngine associated with this SessionFactory
FastSessionServices	getFastSessionServices()
FetchProfile	getFetchProfile(String name)	Retrieve fetch profile by name.
FilterDefinition	getFilterDefinition(String filterName)	Obtain the definition of a filter by name.
Generator	getGenerator(String rootEntityName)	Deprecated.
IdentifierGenerator	getIdentifierGenerator(String rootEntityName)	Deprecated.
IdentifierGeneratorFactory	getIdentifierGeneratorFactory()
String	getIdentifierPropertyName(String className)
Type	getIdentifierType(String className)
Interceptor	getInterceptor()
JdbcServices	getJdbcServices()	Get the JdbcServices.
JpaMetamodelImplementor	getJpaMetamodel()	Access to the domain model metadata
Integer	getMaximumFetchDepth()	When creating Fetch references, defines a limit to how deep we should join for fetches.
MetamodelImplementor	getMetamodel()
String	getName()	Access to the name (if one) assigned to the SessionFactory
PersistenceUnitUtil	getPersistenceUnitUtil()
Map<String,Object>	getProperties()
QueryEngine	getQueryEngine()
Reference	getReference()
Type	getReferencedPropertyType(String className, String propertyName)
RuntimeMetamodelsImplementor	getRuntimeMetamodels()
SchemaManager	getSchemaManager()	A SchemaManager with the same default catalog and schema as pooled connections belonging to this factory.
ServiceRegistryImplementor	getServiceRegistry()	Access to the ServiceRegistry for this SessionFactory.
SessionFactoryOptions	getSessionFactoryOptions()	Get the options used to build this factory.
SqlStringGenerationContext	getSqlStringGenerationContext()
StatisticsImplementor	getStatistics()	Retrieve the statistics for this factory.
JavaType<Object>	getTenantIdentifierJavaType()	The java type to use for a tenant identifier.
TypeConfiguration	getTypeConfiguration()
String	getUuid()	Get the UUID for this SessionFactory.
WrapperOptions	getWrapperOptions()
boolean	isClosed()	Is this factory already closed?
boolean	isOpen()
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.
StatelessSession	openStatelessSession()	Open a new stateless session.
StatelessSession	openStatelessSession(Connection connection)	Open a new stateless session, utilizing the specified JDBC Connection.
SessionImpl	openTemporarySession()	Get a non-transactional "current" session (used by hibernate-envers)
<T> T	unwrap(Class<T> type)
protected void	validateNotClosed()
SessionFactoryImpl.SessionBuilderImpl	withOptions()	Obtain a session builder for creating new Sessions with certain customized options.
StatelessSessionBuilder	withStatelessOptions()	Obtain a StatelessSession builder.

Methods inherited from class org.hibernate.internal.QueryParameterBindingTypeResolverImpl

resolveParameterBindType, resolveParameterBindType

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

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

getMappingMetamodel

Methods inherited from interface org.hibernate.SessionFactory

fromSession, fromStatelessSession, fromStatelessTransaction, fromTransaction, inSession, inStatelessSession, inStatelessTransaction, inTransaction

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

getMappingMetamodel, getSessionFactory, resolveParameterBindType, resolveParameterBindType

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

getNodeBuilder

Constructor Detail

SessionFactoryImpl

@Deprecated(since="6.2",
            forRemoval=true)
public SessionFactoryImpl(MetadataImplementor bootMetamodel,
                          SessionFactoryOptions options)

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

This constructor will be removed

SessionFactoryImpl

public SessionFactoryImpl(MetadataImplementor bootMetamodel,
                          SessionFactoryOptions options,
                          BootstrapContext bootstrapContext)

Method Detail

openSession

public SessionImplementor openSession()
                               throws HibernateException

Description copied from interface: SessionFactoryImplementor

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

Specified by:

openSession in interface SessionFactoryImplementor

Returns:

the opened Session.

Throws:

HibernateException - Indicates a problem opening the session; pretty rare here.

openTemporarySession

public SessionImpl openTemporarySession()
                                 throws HibernateException

Description copied from interface: SessionFactoryImplementor

Get a non-transactional "current" session (used by hibernate-envers)

Specified by:

openTemporarySession in interface SessionFactoryImplementor

Throws:

HibernateException

getCurrentSession

public Session getCurrentSession()
                          throws HibernateException

Description copied from interface: SessionFactory

Obtains the current session, an instance of Session implicitly associated with some context or scope. For example, the session might be associated with the current thread, or with the current JTA transaction.

The context used for scoping the current session (that is, the definition of what precisely "current" means here) is determined by an implementation of CurrentSessionContext. An implementation may be selected using the configuration property "hibernate.current_session_context_class".

If no CurrentSessionContext is explicitly configured, but JTA support is enabled, then JTASessionContext is used, and the current session is scoped to the active JTA transaction.

Specified by:

getCurrentSession in interface SessionFactory

Returns:

The current session.

Throws:

HibernateException - Indicates an issue locating a suitable current session.

See Also:

CurrentSessionContext, AvailableSettings.CURRENT_SESSION_CONTEXT_CLASS

withOptions

public SessionFactoryImpl.SessionBuilderImpl withOptions()

Description copied from interface: SessionFactory

Obtain a session builder for creating new Sessions with certain customized options.

Specified by:

withOptions in interface SessionFactory

Specified by:

withOptions in interface SessionFactoryImplementor

Returns:

The session builder

withStatelessOptions

public StatelessSessionBuilder withStatelessOptions()

Description copied from interface: SessionFactory

Obtain a StatelessSession builder.

Specified by:

withStatelessOptions in interface SessionFactory

Returns:

The stateless session builder

openStatelessSession

public StatelessSession openStatelessSession()

Description copied from interface: SessionFactory

Open a new stateless session.

Specified by:

openStatelessSession in interface SessionFactory

Returns:

The created stateless session.

openStatelessSession

public StatelessSession openStatelessSession(Connection connection)

Description copied from interface: SessionFactory

Open a new stateless session, utilizing the specified JDBC Connection.

Specified by:

openStatelessSession in interface SessionFactory

Parameters:

connection - Connection provided by the application.

Returns:

The created stateless session.

addObserver

public void addObserver(SessionFactoryObserver observer)

Specified by:

addObserver in interface SessionFactoryImplementor

getProperties

public Map<String,Object> getProperties()

Specified by:

getProperties in interface EntityManagerFactory

validateNotClosed

protected void validateNotClosed()

getUuid

public String getUuid()

Description copied from interface: SessionFactoryImplementor

Get the UUID for this SessionFactory.

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

Specified by:

getUuid in interface SessionFactoryImplementor

Returns:

The UUID for this SessionFactory.

See Also:

SessionFactoryRegistry.getSessionFactory(java.lang.String)

getName

public String getName()

Description copied from interface: SessionFactoryImplementor

Access to the name (if one) assigned to the SessionFactory

Specified by:

getName in interface SessionFactoryImplementor

Returns:

The name for the SessionFactory

getTypeConfiguration

public TypeConfiguration getTypeConfiguration()

Specified by:

getTypeConfiguration in interface QueryParameterBindingTypeResolver

Specified by:

getTypeConfiguration in interface SessionFactoryImplementor

Specified by:

getTypeConfiguration in interface SqmCreationContext

getQueryEngine

public QueryEngine getQueryEngine()

Specified by:

getQueryEngine in interface SessionFactoryImplementor

Specified by:

getQueryEngine in interface SqmCreationContext

getEventEngine

public EventEngine getEventEngine()

Description copied from interface: SessionFactoryImplementor

Get the EventEngine associated with this SessionFactory

Specified by:

getEventEngine in interface SessionFactoryImplementor

getJdbcServices

public JdbcServices getJdbcServices()

Description copied from interface: SessionFactoryImplementor

Get the JdbcServices.

Specified by:

getJdbcServices in interface SessionFactoryImplementor

Returns:

the JdbcServices

getSqlStringGenerationContext

public SqlStringGenerationContext getSqlStringGenerationContext()

Specified by:

getSqlStringGenerationContext in interface SessionFactoryImplementor

getIdentifierGeneratorFactory

public IdentifierGeneratorFactory getIdentifierGeneratorFactory()

getDeserializationResolver

@Deprecated
public SessionFactoryImplementor.DeserializationResolver<?> getDeserializationResolver()

Deprecated.

Specified by:

getDeserializationResolver in interface SessionFactoryImplementor

findEntityGraphsByType

public <T> List<EntityGraph<? super T>> findEntityGraphsByType(Class<T> entityClass)

Description copied from interface: SessionFactory

Return all EntityGraphs registered for the given entity type.

Specified by:

findEntityGraphsByType in interface SessionFactory

See Also:

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

createEntityManager

public Session createEntityManager()

Specified by:

createEntityManager in interface EntityManagerFactory

createEntityManager

public Session createEntityManager(Map map)

Specified by:

createEntityManager in interface EntityManagerFactory

createEntityManager

public Session createEntityManager(SynchronizationType synchronizationType)

Specified by:

createEntityManager in interface EntityManagerFactory

createEntityManager

public Session createEntityManager(SynchronizationType synchronizationType,
                                   Map map)

Specified by:

createEntityManager in interface EntityManagerFactory

getCriteriaBuilder

public NodeBuilder getCriteriaBuilder()

Description copied from interface: SessionFactory

Obtain a HibernateCriteriaBuilder which may be used to construct criteria queries.

Specified by:

getCriteriaBuilder in interface EntityManagerFactory

Specified by:

getCriteriaBuilder in interface SessionFactory

Specified by:

getCriteriaBuilder in interface SessionFactoryImplementor

See Also:

SharedSessionContract.getCriteriaBuilder()

getMetamodel

public MetamodelImplementor getMetamodel()

Specified by:

getMetamodel in interface EntityManagerFactory

Specified by:

getMetamodel in interface SessionFactoryImplementor

isOpen

public boolean isOpen()

Specified by:

isOpen in interface EntityManagerFactory

findEntityGraphByName

public 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

Specified by:

findEntityGraphByName in interface SessionFactoryImplementor

Parameters:

name - the name given to some NamedEntityGraph

Returns:

an instance of RootGraph

See Also:

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

bestGuessEntityName

public String bestGuessEntityName(Object object)

Description copied from interface: SessionFactoryImplementor

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

Specified by:

bestGuessEntityName in interface SessionFactoryImplementor

getSessionFactoryOptions

public SessionFactoryOptions getSessionFactoryOptions()

Description copied from interface: SessionFactory

Get the options used to build this factory.

Specified by:

getSessionFactoryOptions in interface SessionFactory

Specified by:

getSessionFactoryOptions in interface SessionFactoryImplementor

Returns:

The special options used to build the factory.

getInterceptor

public Interceptor getInterceptor()

getReference

public Reference getReference()

Specified by:

getReference in interface Referenceable

getIdentifierType

public Type getIdentifierType(String className)
                       throws MappingException

Specified by:

getIdentifierType in interface Mapping

Throws:

MappingException

getIdentifierPropertyName

public String getIdentifierPropertyName(String className)
                                 throws MappingException

Specified by:

getIdentifierPropertyName in interface Mapping

Throws:

MappingException

getCollectionMetadata

public CollectionMetadata getCollectionMetadata(String roleName)
                                         throws HibernateException

Throws:

HibernateException

getReferencedPropertyType

public Type getReferencedPropertyType(String className,
                                      String propertyName)
                               throws MappingException

Specified by:

getReferencedPropertyType in interface Mapping

Throws:

MappingException

close

public void close()
           throws HibernateException

Closes the session factory, releasing all held resources.

1. cleans up used cache regions and "stops" the cache provider.
2. close the JDBC connection
3. remove the JNDI binding

Note: Be aware that the sessionFactory instance still can be a "heavy" object memory wise after close() has been called. Thus it is important to not keep referencing the instance to let the garbage collector release the memory.

Specified by:

close in interface AutoCloseable

Specified by:

close in interface Closeable

Specified by:

close in interface EntityManagerFactory

Specified by:

close in interface SessionFactory

Throws:

HibernateException - Indicates an issue closing the factory.

getCache

public CacheImplementor getCache()

Description copied from interface: SessionFactory

Obtain direct access to the underlying cache regions.

Specified by:

getCache in interface EntityManagerFactory

Specified by:

getCache in interface SessionFactory

Specified by:

getCache in interface SessionFactoryImplementor

Returns:

The direct cache access API.

getPersistenceUnitUtil

public PersistenceUnitUtil getPersistenceUnitUtil()

Specified by:

getPersistenceUnitUtil in interface EntityManagerFactory

addNamedQuery

public void addNamedQuery(String name,
                          Query query)

Specified by:

addNamedQuery in interface EntityManagerFactory

unwrap

public <T> T unwrap(Class<T> type)

Specified by:

unwrap in interface EntityManagerFactory

addNamedEntityGraph

public <T> void addNamedEntityGraph(String graphName,
                                    EntityGraph<T> entityGraph)

Specified by:

addNamedEntityGraph in interface EntityManagerFactory

isClosed

public boolean isClosed()

Description copied from interface: SessionFactory

Is this factory already closed?

Specified by:

isClosed in interface SessionFactory

Returns:

True if this factory is already closed; false otherwise.

getStatistics

public StatisticsImplementor getStatistics()

Description copied from interface: SessionFactory

Retrieve the statistics for this factory.

Specified by:

getStatistics in interface SessionFactory

Specified by:

getStatistics in interface SessionFactoryImplementor

Returns:

The statistics.

getFilterDefinition

public FilterDefinition getFilterDefinition(String filterName)
                                     throws HibernateException

Description copied from interface: SessionFactory

Obtain the definition of a filter by name.

Specified by:

getFilterDefinition in interface SessionFactory

Specified by:

getFilterDefinition in interface SessionFactoryImplementor

Parameters:

filterName - The name of the filter for which to obtain the definition.

Returns:

The filter definition.

Throws:

HibernateException - If no filter defined with the given name.

containsFetchProfileDefinition

public boolean containsFetchProfileDefinition(String name)

Description copied from interface: SessionFactory

Determine if there is a fetch profile definition registered under the given name.

Specified by:

containsFetchProfileDefinition in interface SessionFactory

Parameters:

name - The name to check

Returns:

True if there is such a fetch profile; false otherwise.

getDefinedFilterNames

public Set<String> getDefinedFilterNames()

Description copied from interface: SessionFactory

Obtain the set of names of all defined filters.

Specified by:

getDefinedFilterNames in interface SessionFactory

Returns:

The set of filter names given by FilterDef annotations

getDefinedFetchProfileNames

public Set<String> getDefinedFetchProfileNames()

Description copied from interface: SessionFactory

Obtain the set of names of all defined fetch profiles.

Specified by:

getDefinedFetchProfileNames in interface SessionFactory

Returns:

The set of fetch profile names given by FetchProfile annotations.

getIdentifierGenerator

@Deprecated
public IdentifierGenerator getIdentifierGenerator(String rootEntityName)

Deprecated.

Description copied from interface: SessionFactoryImplementor

Get the identifier generator for the hierarchy

Specified by:

getIdentifierGenerator in interface SessionFactoryImplementor

getGenerator

@Deprecated
public Generator getGenerator(String rootEntityName)

Deprecated.

Description copied from interface: SessionFactoryImplementor

Get the identifier generator for the hierarchy

Specified by:

getGenerator in interface SessionFactoryImplementor

getRuntimeMetamodels

public RuntimeMetamodelsImplementor getRuntimeMetamodels()

Specified by:

getRuntimeMetamodels in interface SessionFactoryImplementor

getJpaMetamodel

public JpaMetamodelImplementor getJpaMetamodel()

Description copied from interface: SqmCreationContext

Access to the domain model metadata

Specified by:

getJpaMetamodel in interface SqmCreationContext

getMaximumFetchDepth

public Integer getMaximumFetchDepth()

Description copied from interface: SqlAstCreationContext

When creating Fetch references, defines a limit to how deep we should join for fetches.

Specified by:

getMaximumFetchDepth in interface SqlAstCreationContext

getServiceRegistry

public ServiceRegistryImplementor getServiceRegistry()

Description copied from interface: SessionFactoryImplementor

Access to the ServiceRegistry for this SessionFactory.

Specified by:

getServiceRegistry in interface SessionFactoryImplementor

Specified by:

getServiceRegistry in interface SqlAstCreationContext

Specified by:

getServiceRegistry in interface SqmCreationContext

Returns:

The factory's ServiceRegistry

getEntityNotFoundDelegate

public EntityNotFoundDelegate getEntityNotFoundDelegate()

Specified by:

getEntityNotFoundDelegate in interface SessionFactoryImplementor

getFetchProfile

public FetchProfile getFetchProfile(String name)

Description copied from interface: SessionFactoryImplementor

Retrieve fetch profile by name.

Specified by:

getFetchProfile in interface SessionFactoryImplementor

Parameters:

name - The name of the profile to retrieve.

Returns:

The profile definition

configuredInterceptor

@Deprecated
public static Interceptor configuredInterceptor(Interceptor interceptor,
                                                SessionFactoryOptions options)

Deprecated.

use configuredInterceptor(Interceptor, boolean, SessionFactoryOptions)

configuredInterceptor

public static Interceptor configuredInterceptor(Interceptor interceptor,
                                                boolean explicitNoInterceptor,
                                                SessionFactoryOptions options)

getCustomEntityDirtinessStrategy

public CustomEntityDirtinessStrategy getCustomEntityDirtinessStrategy()

Specified by:

getCustomEntityDirtinessStrategy in interface SessionFactoryImplementor

getCurrentTenantIdentifierResolver

public CurrentTenantIdentifierResolver<Object> getCurrentTenantIdentifierResolver()

Specified by:

getCurrentTenantIdentifierResolver in interface SessionFactoryImplementor

getTenantIdentifierJavaType

public JavaType<Object> getTenantIdentifierJavaType()

Description copied from interface: SessionFactoryImplementor

The java type to use for a tenant identifier.

Specified by:

getTenantIdentifierJavaType in interface SessionFactoryImplementor

getFastSessionServices

public FastSessionServices getFastSessionServices()

Specified by:

getFastSessionServices in interface SessionFactoryImplementor

Returns:

the FastSessionServices for this SessionFactory.

getWrapperOptions

public WrapperOptions getWrapperOptions()

Specified by:

getWrapperOptions in interface SessionFactoryImplementor

getSchemaManager

public SchemaManager getSchemaManager()

Description copied from interface: SessionFactory

A SchemaManager with the same default catalog and schema as pooled connections belonging to this factory. Intended mostly as a convenience for writing tests.

Specified by:

getSchemaManager in interface SessionFactory