Package org.hibernate.internal

Class SessionFactoryImpl

java.lang.Object

org.hibernate.internal.SessionFactoryImpl

All Implemented Interfaces:

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

public class SessionFactoryImpl
extends Object
implements SessionFactoryImplementor

Concrete implementation of the SessionFactory interface. Has the following responsibilities

• caches configuration settings (immutably)
• caches "compiled" mappings ie. EntityPersisters and CollectionPersisters (immutable)
• caches "compiled" queries (memory sensitive cache)
• manages PreparedStatements
• delegates JDBC Connection management to the ConnectionProvider
• factory for instances of SessionImpl

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.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	SessionFactoryImpl.SessionBuilderImpl<T extends SessionBuilder>
static class	SessionFactoryImpl.StatelessSessionBuilderImpl

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

SessionFactory.TransactionManagementException

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)

Method Summary

Modifier and Type	Method	Description
<T> void	addNamedEntityGraph(String graphName, jakarta.persistence.EntityGraph<T> entityGraph)
void	addNamedQuery(String name, jakarta.persistence.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 this session factory contains a fetch profile definition registered under the given name.
Session	createEntityManager()
Session	createEntityManager(jakarta.persistence.SynchronizationType synchronizationType)
Session	createEntityManager(jakarta.persistence.SynchronizationType synchronizationType, Map map)
Session	createEntityManager(Map map)
RootGraphImplementor<?>	findEntityGraphByName(String name)
<T> List<jakarta.persistence.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()
Session	getCurrentSession()	Obtains the current session, an instance of Session implicitly associated with some context.
CurrentTenantIdentifierResolver	getCurrentTenantIdentifierResolver()
CustomEntityDirtinessStrategy	getCustomEntityDirtinessStrategy()
Set<String>	getDefinedFilterNames()	Obtain the set of names of all defined filters.
SessionFactoryImplementor.DeserializationResolver	getDeserializationResolver()
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.
IdentifierGenerator	getIdentifierGenerator(String rootEntityName)	Get the identifier generator for the hierarchy
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
jakarta.persistence.PersistenceUnitUtil	getPersistenceUnitUtil()
Map<String,Object>	getProperties()
QueryEngine	getQueryEngine()
Reference	getReference()
Type	getReferencedPropertyType(String className, String propertyName)
RuntimeMetamodelsImplementor	getRuntimeMetamodels()
ServiceRegistryImplementor	getServiceRegistry()	Access to the ServiceRegistry for this SessionFactory.
SessionFactoryOptions	getSessionFactoryOptions()	Get the special options used to build the factory.
SqlStringGenerationContext	getSqlStringGenerationContext()
StatisticsImplementor	getStatistics()	Retrieve the statistics for this factory.
TypeConfiguration	getTypeConfiguration()
String	getUuid()	Get the UUID for this SessionFactory.
WrapperOptions	getWrapperOptions()
boolean	isClosed()	Is this factory already closed?
boolean	isOpen()
Session	openSession()	Open a Session.
StatelessSession	openStatelessSession()	Open a new stateless session.
StatelessSession	openStatelessSession(Connection connection)	Open a new stateless session, utilizing the specified JDBC Connection.
Session	openTemporarySession()	Get a non-transactional "current" session (used by hibernate-envers)
<T> BindableType<T>	resolveParameterBindType(Class<T> javaType)
<T> BindableType<? extends T>	resolveParameterBindType(T bindValue)
<T> T	unwrap(Class<T> type)
protected void	validateNotClosed()
SessionBuilderImplementor	withOptions()	Obtain a session builder for creating new Sessions with certain customized options.
StatelessSessionBuilder	withStatelessOptions()	Obtain a StatelessSession builder.

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.hibernate.SessionFactory

fromSession, fromTransaction, inSession, inTransaction

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

getMappingMetamodel, getSessionFactory

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

getNodeBuilder

Constructor Detail

SessionFactoryImpl

public SessionFactoryImpl(MetadataImplementor bootMetamodel,
                          SessionFactoryOptions options)

Method Detail

openSession

public Session openSession()
                    throws HibernateException

Description copied from interface: SessionFactory

Open a Session.

Any JDBC connection will be obtained lazily from the ConnectionProvider as needed to perform requested work.

Specified by:

openSession in interface SessionFactory

Returns:

The created session.

Throws:

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

openTemporarySession

public Session 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. 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 is configured, then JTASessionContext is used.

Specified by:

getCurrentSession in interface SessionFactory

Returns:

The current session.

Throws:

HibernateException - Indicates an issue locating a suitable current session.

withOptions

public SessionBuilderImplementor 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 jakarta.persistence.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

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

public SessionFactoryImplementor.DeserializationResolver getDeserializationResolver()

Specified by:

getDeserializationResolver in interface SessionFactoryImplementor

findEntityGraphsByType

public <T> List<jakarta.persistence.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 jakarta.persistence.EntityManagerFactory

createEntityManager

public Session createEntityManager(Map map)

Specified by:

createEntityManager in interface jakarta.persistence.EntityManagerFactory

createEntityManager

public Session createEntityManager(jakarta.persistence.SynchronizationType synchronizationType)

Specified by:

createEntityManager in interface jakarta.persistence.EntityManagerFactory

createEntityManager

public Session createEntityManager(jakarta.persistence.SynchronizationType synchronizationType,
                                   Map map)

Specified by:

createEntityManager in interface jakarta.persistence.EntityManagerFactory

getCriteriaBuilder

public NodeBuilder getCriteriaBuilder()

Specified by:

getCriteriaBuilder in interface jakarta.persistence.EntityManagerFactory

Specified by:

getCriteriaBuilder in interface SessionFactoryImplementor

getMetamodel

public MetamodelImplementor getMetamodel()

Specified by:

getMetamodel in interface jakarta.persistence.EntityManagerFactory

Specified by:

getMetamodel in interface SessionFactoryImplementor

isOpen

public boolean isOpen()

Specified by:

isOpen in interface jakarta.persistence.EntityManagerFactory

findEntityGraphByName

public RootGraphImplementor<?> findEntityGraphByName(String name)

Specified by:

findEntityGraphByName in interface SessionFactoryImplementor

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 special options used to build the factory.

Specified by:

getSessionFactoryOptions in interface SessionFactory

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 jakarta.persistence.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 jakarta.persistence.EntityManagerFactory

Specified by:

getCache in interface SessionFactory

Specified by:

getCache in interface SessionFactoryImplementor

Returns:

The direct cache access API.

getPersistenceUnitUtil

public jakarta.persistence.PersistenceUnitUtil getPersistenceUnitUtil()

Specified by:

getPersistenceUnitUtil in interface jakarta.persistence.EntityManagerFactory

addNamedQuery

public void addNamedQuery(String name,
                          jakarta.persistence.Query query)

Specified by:

addNamedQuery in interface jakarta.persistence.EntityManagerFactory

unwrap

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

Specified by:

unwrap in interface jakarta.persistence.EntityManagerFactory

addNamedEntityGraph

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

Specified by:

addNamedEntityGraph in interface jakarta.persistence.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

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 this session factory contains 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.

getIdentifierGenerator

public IdentifierGenerator getIdentifierGenerator(String rootEntityName)

Description copied from interface: SessionFactoryImplementor

Get the identifier generator for the hierarchy

Specified by:

getIdentifierGenerator 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

resolveParameterBindType

public <T> BindableType<? extends T> resolveParameterBindType(T bindValue)

Specified by:

resolveParameterBindType in interface QueryParameterBindingTypeResolver

resolveParameterBindType

public <T> BindableType<T> resolveParameterBindType(Class<T> javaType)

Specified by:

resolveParameterBindType in interface QueryParameterBindingTypeResolver

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 getCurrentTenantIdentifierResolver()

Specified by:

getCurrentTenantIdentifierResolver 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