org.hibernate.internal

Class SessionFactoryImpl

java.lang.Object

org.hibernate.internal.SessionFactoryImpl

All Implemented Interfaces:

java.io.Closeable, java.io.Serializable, java.lang.AutoCloseable, javax.naming.Referenceable, javax.persistence.EntityManagerFactory, Mapping, SessionFactoryImplementor, HibernateEntityManagerFactory, QueryParameterBindingTypeResolver, SessionFactory

public final class SessionFactoryImpl
extends java.lang.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 and Description
static class	SessionFactoryImpl.StatelessSessionBuilderImpl

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

SessionFactoryImplementor.DeserializationResolver<T extends SessionFactoryImplementor>

Constructor Summary

Constructors

Constructor and Description
SessionFactoryImpl(MetadataImplementor metadata, SessionFactoryOptions options)

Method Summary

Modifier and Type	Method and Description
<T> void	addNamedEntityGraph(java.lang.String graphName, javax.persistence.EntityGraph<T> entityGraph)
void	addNamedQuery(java.lang.String name, javax.persistence.Query query)
void	addObserver(SessionFactoryObserver observer)
void	close() Closes the session factory, releasing all held resources.
static Interceptor	configuredInterceptor(Interceptor interceptor, SessionFactoryOptions options)
boolean	containsFetchProfileDefinition(java.lang.String name) Determine if this session factory contains a fetch profile definition registered under the given name.
Session	createEntityManager()
Session	createEntityManager(java.util.Map map)
Session	createEntityManager(javax.persistence.SynchronizationType synchronizationType)
Session	createEntityManager(javax.persistence.SynchronizationType synchronizationType, java.util.Map map)
javax.persistence.EntityGraph	findEntityGraphByName(java.lang.String name)
<T> java.util.List<javax.persistence.EntityGraph<? super T>>	findEntityGraphsByType(java.lang.Class<T> entityClass) Find all EntityGraphs associated with a given entity type.
java.util.Map<java.lang.String,ClassMetadata>	getAllClassMetadata() Retrieve the ClassMetadata for all mapped entities.
java.util.Map	getAllCollectionMetadata() Get the CollectionMetadata for all mapped collections.
java.util.Map	getAllSecondLevelCacheRegions() Get a map of all the second level cache regions currently maintained in this session factory.
CacheImplementor	getCache() Obtain direct access to the underlying cache regions.
ClassMetadata	getClassMetadata(java.lang.Class persistentClass) Retrieve the ClassMetadata associated with the given entity class.
ClassMetadata	getClassMetadata(java.lang.String entityName) Retrieve the ClassMetadata associated with the given entity class.
CollectionMetadata	getCollectionMetadata(java.lang.String roleName) Get the CollectionMetadata associated with the named collection role.
javax.persistence.criteria.CriteriaBuilder	getCriteriaBuilder()
Session	getCurrentSession() Obtains the current session.
CurrentTenantIdentifierResolver	getCurrentTenantIdentifierResolver()
CustomEntityDirtinessStrategy	getCustomEntityDirtinessStrategy()
java.util.Set	getDefinedFilterNames() Obtain a set of the names of all filters defined on this SessionFactory.
SessionFactoryImplementor.DeserializationResolver	getDeserializationResolver()
EntityNotFoundDelegate	getEntityNotFoundDelegate()
FetchProfile	getFetchProfile(java.lang.String name) Retrieve fetch profile by name.
FilterDefinition	getFilterDefinition(java.lang.String filterName) Obtain the definition of a filter by name.
IdentifierGenerator	getIdentifierGenerator(java.lang.String rootEntityName) Get the identifier generator for the hierarchy
IdentifierGeneratorFactory	getIdentifierGeneratorFactory() Allow access to the id generator factory, though this is only needed/allowed from configuration.
java.lang.String	getIdentifierPropertyName(java.lang.String className)
Type	getIdentifierType(java.lang.String className)
Interceptor	getInterceptor() Get the factory scoped interceptor for this factory.
JdbcServices	getJdbcServices() Get the JdbcServices.
MetamodelImplementor	getMetamodel()
java.lang.String	getName() Access to the name (if one) assigned to the SessionFactory
NamedQueryRepository	getNamedQueryRepository() Provides access to the named query repository
javax.persistence.PersistenceUnitUtil	getPersistenceUnitUtil()
java.util.Map<java.lang.String,java.lang.Object>	getProperties()
QueryPlanCache	getQueryPlanCache() Access to the cachres of HQL/JPQL and native query plans.
javax.naming.Reference	getReference()
Type	getReferencedPropertyType(java.lang.String className, java.lang.String propertyName)
java.lang.String[]	getReturnAliases(java.lang.String queryString) Get the return aliases of a query
Type[]	getReturnTypes(java.lang.String queryString) Get the return types of a query
ServiceRegistryImplementor	getServiceRegistry() Access to the ServiceRegistry for this SessionFactory.
SessionFactoryOptions	getSessionFactoryOptions() Get the special options used to build the factory.
Settings	getSettings()
SQLFunctionRegistry	getSqlFunctionRegistry()
StatisticsImplementor	getStatistics() Retrieve the statistics fopr this factory.
TypeHelper	getTypeHelper() Retrieve this factory's TypeHelper.
TypeResolver	getTypeResolver() Retrieve the Type resolver associated with this factory.
java.lang.String	getUuid() Get the UUID for this SessionFactory.
boolean	isClosed() Is this factory already closed?
boolean	isOpen()
Session	openSession() Open a Session.
StatelessSession	openStatelessSession() Open a new stateless session.
StatelessSession	openStatelessSession(java.sql.Connection connection) Open a new stateless session, utilizing the specified JDBC Connection.
Session	openTemporarySession() Get a non-transactional "current" session (used by hibernate-envers)
Type	resolveParameterBindType(java.lang.Class clazz)
Type	resolveParameterBindType(java.lang.Object bindValue)
<T> T	unwrap(java.lang.Class<T> type)
protected void	validateNotClosed()
SessionBuilderImplementor	withOptions() Obtain a Session builder.
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.engine.spi.SessionFactoryImplementor

getCollectionPersister, getCollectionPersisters, getCollectionRolesByEntityParticipant, getDialect, getEntityPersister, getEntityPersisters, getImplementors, getImportedClassName, getNamedQuery, getNamedSQLQuery, getNaturalIdCacheRegion, getNaturalIdCacheRegionAccessStrategy, getQueryCache, getQueryCache, getResultSetMapping, getSecondLevelCacheRegion, getSecondLevelCacheRegionAccessStrategy, getSQLExceptionConverter, getSQLExceptionHelper, getStatisticsImplementor, getUpdateTimestampsCache, iterateEntityNameResolvers, locateEntityPersister, locateEntityPersister, registerNamedQueryDefinition, registerNamedSQLQueryDefinition

Methods inherited from interface org.hibernate.jpa.HibernateEntityManagerFactory

getEntityTypeByName, getSessionFactory

Constructor Detail

SessionFactoryImpl

public SessionFactoryImpl(MetadataImplementor metadata,
                          SessionFactoryOptions options)

Method Detail

openSession

public Session openSession()
                    throws HibernateException

Description copied from interface: SessionFactory

Open a Session.

JDBC connection(s will be obtained from the configured 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. The definition of what exactly "current" means controlled by the CurrentSessionContext impl configured for use.

Note that for backwards compatibility, if a CurrentSessionContext is not configured but JTA is configured this will default to the JTASessionContext impl.

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.

Specified by:

withOptions in interface SessionFactoryImplementor

Specified by:

withOptions in interface SessionFactory

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(java.sql.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 java.util.Map<java.lang.String,java.lang.Object> getProperties()

Specified by:

getProperties in interface javax.persistence.EntityManagerFactory

validateNotClosed

protected void validateNotClosed()

getUuid

public java.lang.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 java.lang.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

getJdbcServices

public JdbcServices getJdbcServices()

Description copied from interface: SessionFactoryImplementor

Get the JdbcServices.

Specified by:

getJdbcServices in interface SessionFactoryImplementor

Returns:

the JdbcServices

getIdentifierGeneratorFactory

public IdentifierGeneratorFactory getIdentifierGeneratorFactory()

Description copied from interface: Mapping

Allow access to the id generator factory, though this is only needed/allowed from configuration.

Specified by:

getIdentifierGeneratorFactory in interface Mapping

Returns:

Access to the identifier generator factory

getTypeResolver

public TypeResolver getTypeResolver()

Description copied from interface: SessionFactoryImplementor

Retrieve the Type resolver associated with this factory.

Specified by:

getTypeResolver in interface SessionFactoryImplementor

Returns:

The type resolver

getQueryPlanCache

public QueryPlanCache getQueryPlanCache()

Description copied from interface: SessionFactoryImplementor

Access to the cachres of HQL/JPQL and native query plans.

Specified by:

getQueryPlanCache in interface SessionFactoryImplementor

Returns:

The query plan cache

getDeserializationResolver

public SessionFactoryImplementor.DeserializationResolver getDeserializationResolver()

Specified by:

getDeserializationResolver in interface SessionFactoryImplementor

getSettings

public Settings getSettings()

Specified by:

getSettings in interface SessionFactoryImplementor

findEntityGraphsByType

public <T> java.util.List<javax.persistence.EntityGraph<? super T>> findEntityGraphsByType(java.lang.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.

createEntityManager

public Session createEntityManager()

Specified by:

createEntityManager in interface javax.persistence.EntityManagerFactory

createEntityManager

public Session createEntityManager(java.util.Map map)

Specified by:

createEntityManager in interface javax.persistence.EntityManagerFactory

createEntityManager

public Session createEntityManager(javax.persistence.SynchronizationType synchronizationType)

Specified by:

createEntityManager in interface javax.persistence.EntityManagerFactory

createEntityManager

public Session createEntityManager(javax.persistence.SynchronizationType synchronizationType,
                                   java.util.Map map)

Specified by:

createEntityManager in interface javax.persistence.EntityManagerFactory

getCriteriaBuilder

public javax.persistence.criteria.CriteriaBuilder getCriteriaBuilder()

Specified by:

getCriteriaBuilder in interface javax.persistence.EntityManagerFactory

getMetamodel

public MetamodelImplementor getMetamodel()

Specified by:

getMetamodel in interface javax.persistence.EntityManagerFactory

Specified by:

getMetamodel in interface SessionFactoryImplementor

Specified by:

getMetamodel in interface HibernateEntityManagerFactory

isOpen

public boolean isOpen()

Specified by:

isOpen in interface javax.persistence.EntityManagerFactory

findEntityGraphByName

public javax.persistence.EntityGraph findEntityGraphByName(java.lang.String name)

Specified by:

findEntityGraphByName in interface SessionFactoryImplementor

getAllSecondLevelCacheRegions

public java.util.Map getAllSecondLevelCacheRegions()

Description copied from interface: SessionFactoryImplementor

Get a map of all the second level cache regions currently maintained in this session factory. The map is structured with the region name as the key and the Region instances as the values.

Specified by:

getAllSecondLevelCacheRegions in interface SessionFactoryImplementor

Returns:

The map of regions

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

Description copied from interface: SessionFactoryImplementor

Get the factory scoped interceptor for this factory.

Specified by:

getInterceptor in interface SessionFactoryImplementor

Returns:

The factory scope interceptor, or null if none.

getReference

public javax.naming.Reference getReference()

Specified by:

getReference in interface javax.naming.Referenceable

getNamedQueryRepository

public NamedQueryRepository getNamedQueryRepository()

Description copied from interface: SessionFactoryImplementor

Provides access to the named query repository

Specified by:

getNamedQueryRepository in interface SessionFactoryImplementor

Returns:

The repository for named query definitions

getIdentifierType

public Type getIdentifierType(java.lang.String className)
                       throws MappingException

Specified by:

getIdentifierType in interface Mapping

Throws:

MappingException

getIdentifierPropertyName

public java.lang.String getIdentifierPropertyName(java.lang.String className)
                                           throws MappingException

Specified by:

getIdentifierPropertyName in interface Mapping

Throws:

MappingException

getReturnTypes

public Type[] getReturnTypes(java.lang.String queryString)
                      throws HibernateException

Description copied from interface: SessionFactoryImplementor

Get the return types of a query

Specified by:

getReturnTypes in interface SessionFactoryImplementor

Throws:

HibernateException

getReturnAliases

public java.lang.String[] getReturnAliases(java.lang.String queryString)
                                    throws HibernateException

Description copied from interface: SessionFactoryImplementor

Get the return aliases of a query

Specified by:

getReturnAliases in interface SessionFactoryImplementor

Throws:

HibernateException

getClassMetadata

public ClassMetadata getClassMetadata(java.lang.Class persistentClass)
                               throws HibernateException

Description copied from interface: SessionFactory

Retrieve the ClassMetadata associated with the given entity class.

Specified by:

getClassMetadata in interface SessionFactory

Parameters:

persistentClass - The entity class

Returns:

The metadata associated with the given entity; may be null if no such entity was mapped.

Throws:

HibernateException - Generally null is returned instead of throwing.

getCollectionMetadata

public CollectionMetadata getCollectionMetadata(java.lang.String roleName)
                                         throws HibernateException

Description copied from interface: SessionFactory

Get the CollectionMetadata associated with the named collection role.

Specified by:

getCollectionMetadata in interface SessionFactory

Parameters:

roleName - The collection role (in form [owning-entity-name].[collection-property-name]).

Returns:

The metadata associated with the given collection; may be null if no such collection was mapped.

Throws:

HibernateException - Generally null is returned instead of throwing.

getClassMetadata

public ClassMetadata getClassMetadata(java.lang.String entityName)
                               throws HibernateException

Description copied from interface: SessionFactory

Retrieve the ClassMetadata associated with the given entity class.

Specified by:

getClassMetadata in interface SessionFactory

Parameters:

entityName - The entity class

Returns:

The metadata associated with the given entity; may be null if no such entity was mapped.

Throws:

HibernateException - Generally null is returned instead of throwing.

getAllClassMetadata

public java.util.Map<java.lang.String,ClassMetadata> getAllClassMetadata()
                                                                  throws HibernateException

Description copied from interface: SessionFactory

Retrieve the ClassMetadata for all mapped entities.

Specified by:

getAllClassMetadata in interface SessionFactory

Returns:

A map containing all ClassMetadata keyed by the corresponding String entity-name.

Throws:

HibernateException - Generally empty map is returned instead of throwing.

getAllCollectionMetadata

public java.util.Map getAllCollectionMetadata()
                                       throws HibernateException

Description copied from interface: SessionFactory

Get the CollectionMetadata for all mapped collections.

Specified by:

getAllCollectionMetadata in interface SessionFactory

Returns:

a map from String to CollectionMetadata

Throws:

HibernateException - Generally empty map is returned instead of throwing.

getReferencedPropertyType

public Type getReferencedPropertyType(java.lang.String className,
                                      java.lang.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 java.io.Closeable

Specified by:

close in interface java.lang.AutoCloseable

Specified by:

close in interface javax.persistence.EntityManagerFactory

Specified by:

close in interface SessionFactory

Throws:

HibernateException

getCache

public CacheImplementor getCache()

Description copied from interface: SessionFactory

Obtain direct access to the underlying cache regions.

Specified by:

getCache in interface javax.persistence.EntityManagerFactory

Specified by:

getCache in interface SessionFactoryImplementor

Specified by:

getCache in interface SessionFactory

Returns:

The direct cache access API.

getPersistenceUnitUtil

public javax.persistence.PersistenceUnitUtil getPersistenceUnitUtil()

Specified by:

getPersistenceUnitUtil in interface javax.persistence.EntityManagerFactory

addNamedQuery

public void addNamedQuery(java.lang.String name,
                          javax.persistence.Query query)

Specified by:

addNamedQuery in interface javax.persistence.EntityManagerFactory

unwrap

public <T> T unwrap(java.lang.Class<T> type)

Specified by:

unwrap in interface javax.persistence.EntityManagerFactory

addNamedEntityGraph

public <T> void addNamedEntityGraph(java.lang.String graphName,
                                    javax.persistence.EntityGraph<T> entityGraph)

Specified by:

addNamedEntityGraph in interface javax.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 fopr this factory.

Specified by:

getStatistics in interface SessionFactoryImplementor

Specified by:

getStatistics in interface SessionFactory

Returns:

The statistics.

getFilterDefinition

public FilterDefinition getFilterDefinition(java.lang.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(java.lang.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 java.util.Set getDefinedFilterNames()

Description copied from interface: SessionFactory

Obtain a set of the names of all filters defined on this SessionFactory.

Specified by:

getDefinedFilterNames in interface SessionFactory

Returns:

The set of filter names.

getIdentifierGenerator

public IdentifierGenerator getIdentifierGenerator(java.lang.String rootEntityName)

Description copied from interface: SessionFactoryImplementor

Get the identifier generator for the hierarchy

Specified by:

getIdentifierGenerator in interface SessionFactoryImplementor

getServiceRegistry

public ServiceRegistryImplementor getServiceRegistry()

Description copied from interface: SessionFactoryImplementor

Access to the ServiceRegistry for this SessionFactory.

Specified by:

getServiceRegistry in interface SessionFactoryImplementor

Returns:

The factory's ServiceRegistry

getEntityNotFoundDelegate

public EntityNotFoundDelegate getEntityNotFoundDelegate()

Specified by:

getEntityNotFoundDelegate in interface SessionFactoryImplementor

getSqlFunctionRegistry

public SQLFunctionRegistry getSqlFunctionRegistry()

Specified by:

getSqlFunctionRegistry in interface SessionFactoryImplementor

getFetchProfile

public FetchProfile getFetchProfile(java.lang.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

getTypeHelper

public TypeHelper getTypeHelper()

Description copied from interface: SessionFactory

Retrieve this factory's TypeHelper.

Specified by:

getTypeHelper in interface SessionFactory

Returns:

The factory's TypeHelper

resolveParameterBindType

public Type resolveParameterBindType(java.lang.Object bindValue)

Specified by:

resolveParameterBindType in interface QueryParameterBindingTypeResolver

resolveParameterBindType

public Type resolveParameterBindType(java.lang.Class clazz)

Specified by:

resolveParameterBindType in interface QueryParameterBindingTypeResolver

configuredInterceptor

public static Interceptor configuredInterceptor(Interceptor interceptor,
                                                SessionFactoryOptions options)

getCustomEntityDirtinessStrategy

public CustomEntityDirtinessStrategy getCustomEntityDirtinessStrategy()

Specified by:

getCustomEntityDirtinessStrategy in interface SessionFactoryImplementor

getCurrentTenantIdentifierResolver

public CurrentTenantIdentifierResolver getCurrentTenantIdentifierResolver()

Specified by:

getCurrentTenantIdentifierResolver in interface SessionFactoryImplementor