org.hibernate.engine.spi

Interface SessionFactoryImplementor

All Superinterfaces:

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

All Known Implementing Classes:

SessionFactoryDelegatingImpl, SessionFactoryImpl

public interface SessionFactoryImplementor
extends Mapping, SessionFactory, QueryParameterBindingTypeResolver

Defines the internal contract between the SessionFactory and other parts of Hibernate such as implementors of Type.

See Also:

SessionFactory, SessionFactoryImpl

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	SessionFactoryImplementor.DeserializationResolver<T extends SessionFactoryImplementor> Contract for resolving this SessionFactory on deserialization

Method Summary

Modifier and Type	Method and Description
void	addObserver(SessionFactoryObserver observer)
javax.persistence.EntityGraph	findEntityGraphByName(java.lang.String name)
java.util.Map	getAllSecondLevelCacheRegions() Deprecated. (since 5.2) with no direct replacement; use this factory's getCache() reference to access cache objects as needed.
CacheImplementor	getCache() Obtain direct access to the underlying cache regions.
default CollectionPersister	getCollectionPersister(java.lang.String role) Deprecated. (since 5.2) Use MetamodelImplementor.collectionPersister(String) instead.
default java.util.Map<java.lang.String,CollectionPersister>	getCollectionPersisters() Deprecated. (since 5.2) Use MetamodelImplementor.collectionPersisters() instead.
default java.util.Set<java.lang.String>	getCollectionRolesByEntityParticipant(java.lang.String entityName) Deprecated. (since 5.2) Use MetamodelImplementor.collectionPersisters() instead. Retrieves a set of all the collection roles in which the given entity is a participant, as either an index or an element.
CurrentTenantIdentifierResolver	getCurrentTenantIdentifierResolver()
CustomEntityDirtinessStrategy	getCustomEntityDirtinessStrategy()
SessionFactoryImplementor.DeserializationResolver	getDeserializationResolver()
default Dialect	getDialect() Deprecated. (since 5.2) instead, use this factory's {getServiceRegistry()} -> JdbcServices.getDialect()
EntityNotFoundDelegate	getEntityNotFoundDelegate()
default EntityPersister	getEntityPersister(java.lang.String entityName) Deprecated. (since 5.2) Use MetamodelImplementor.entityPersister(Class) instead.
default java.util.Map<java.lang.String,EntityPersister>	getEntityPersisters() Deprecated. (since 5.2) Use MetamodelImplementor.entityPersisters() instead.
FetchProfile	getFetchProfile(java.lang.String name) Retrieve fetch profile by name.
IdentifierGenerator	getIdentifierGenerator(java.lang.String rootEntityName) Get the identifier generator for the hierarchy
default java.lang.String[]	getImplementors(java.lang.String entityName) Deprecated. Use Metamodel.getImplementors(java.lang.String) instead
default java.lang.String	getImportedClassName(java.lang.String name) Deprecated. Use Metamodel.getImportedClassName(java.lang.String) instead
Interceptor	getInterceptor() Deprecated. (since 5.2) if access to the SessionFactory-scoped Interceptor is needed, use SessionFactoryOptions.getInterceptor() instead. However, generally speaking this access is not needed.
JdbcServices	getJdbcServices() Get the JdbcServices.
MetamodelImplementor	getMetamodel()
java.lang.String	getName() Access to the name (if one) assigned to the SessionFactory
default NamedQueryDefinition	getNamedQuery(java.lang.String queryName) Deprecated. (since 5.2) Use NamedQueryRepository.getNamedQueryDefinition(java.lang.String) instead.
NamedQueryRepository	getNamedQueryRepository() Deprecated. (since 5.2) it will be replaced with the new QueryEngine concept introduced in 6.0
default NamedSQLQueryDefinition	getNamedSQLQuery(java.lang.String queryName) Deprecated. (since 5.2) Use NamedQueryRepository.getNamedSQLQueryDefinition(java.lang.String) instead.
default Region	getNaturalIdCacheRegion(java.lang.String regionName) Deprecated. (since 5.2) Use this factory's getCache() -> CacheImplementor.getNaturalIdCacheRegionAccessStrategy(String) -> NaturalIdRegionAccessStrategy.getRegion() instead.
default RegionAccessStrategy	getNaturalIdCacheRegionAccessStrategy(java.lang.String regionName) Deprecated. (since 5.2) Use this factory's getCache() -> CacheImplementor.getNaturalIdCacheRegionAccessStrategy(String) instead.
default QueryCache	getQueryCache() Deprecated. Use CacheImplementor.getDefaultQueryCache() instead
default QueryCache	getQueryCache(java.lang.String regionName) Deprecated. Use CacheImplementor.getQueryCache(String) instead
QueryPlanCache	getQueryPlanCache() Deprecated. (since 5.2) it will be replaced with the new QueryEngine concept introduced in 6.0
default ResultSetMappingDefinition	getResultSetMapping(java.lang.String name) Deprecated. (since 5.2) Use NamedQueryRepository.getResultSetMappingDefinition(java.lang.String) instead.
default java.lang.String[]	getReturnAliases(java.lang.String queryString) Deprecated. No replacement.
default Type[]	getReturnTypes(java.lang.String queryString) Deprecated. No replacement.
default Region	getSecondLevelCacheRegion(java.lang.String regionName) Deprecated. (since 5.2) Use this factory's getCache() reference to access Region via CacheImplementor.determineEntityRegionAccessStrategy(org.hibernate.mapping.PersistentClass) or CacheImplementor.determineCollectionRegionAccessStrategy(org.hibernate.mapping.Collection) instead.
default RegionAccessStrategy	getSecondLevelCacheRegionAccessStrategy(java.lang.String regionName) Deprecated. (since 5.2) Use this factory's getCache() reference to access CacheImplementor.determineEntityRegionAccessStrategy(org.hibernate.mapping.PersistentClass) or CacheImplementor.determineCollectionRegionAccessStrategy(org.hibernate.mapping.Collection) instead.
ServiceRegistryImplementor	getServiceRegistry() Access to the ServiceRegistry for this SessionFactory.
Settings	getSettings() Deprecated. since 5.0; use SessionFactory.getSessionFactoryOptions() instead
default SQLExceptionConverter	getSQLExceptionConverter() Deprecated. since 5.0; use JdbcServices.getSqlExceptionHelper() -> SqlExceptionHelper.getSqlExceptionConverter() instead as obtained from getServiceRegistry()
default SqlExceptionHelper	getSQLExceptionHelper() Deprecated. since 5.0; use JdbcServices.getSqlExceptionHelper() instead as obtained from getServiceRegistry()
SQLFunctionRegistry	getSqlFunctionRegistry()
StatisticsImplementor	getStatistics() Retrieve the statistics fopr this factory.
default StatisticsImplementor	getStatisticsImplementor() Deprecated. Just use getStatistics() (with covariant return here as StatisticsImplementor).
TypeResolver	getTypeResolver() Deprecated. (since 5.2) No replacement, access to and handling of Types will be much different in 6.0
default UpdateTimestampsCache	getUpdateTimestampsCache() Deprecated. Use CacheImplementor.getUpdateTimestampsCache() instead
java.lang.String	getUuid() Get the UUID for this SessionFactory.
default java.lang.Iterable<EntityNameResolver>	iterateEntityNameResolvers() Deprecated. (since 5.2) use getMetamodel() -> MetamodelImplementor.getEntityNameResolvers()
default EntityPersister	locateEntityPersister(java.lang.Class byClass) Deprecated. (since 5.2) Use MetamodelImplementor.locateEntityPersister(Class) instead.
default EntityPersister	locateEntityPersister(java.lang.String byName) Deprecated. (since 5.2) Use MetamodelImplementor.locateEntityPersister(String) instead.
Session	openTemporarySession() Get a non-transactional "current" session (used by hibernate-envers)
default void	registerNamedQueryDefinition(java.lang.String name, NamedQueryDefinition definition) Deprecated. (since 5.2) Use NamedQueryRepository.registerNamedQueryDefinition(java.lang.String, org.hibernate.engine.spi.NamedQueryDefinition) instead.
default void	registerNamedSQLQueryDefinition(java.lang.String name, NamedSQLQueryDefinition definition) Deprecated. (since 5.2) Use NamedQueryRepository.registerNamedSQLQueryDefinition(java.lang.String, org.hibernate.engine.spi.NamedSQLQueryDefinition) instead.
SessionBuilderImplementor	withOptions() Obtain a Session builder.

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

getIdentifierGeneratorFactory, getIdentifierPropertyName, getIdentifierType, getReferencedPropertyType

Methods inherited from interface org.hibernate.SessionFactory

close, containsFetchProfileDefinition, getAllClassMetadata, getAllCollectionMetadata, getClassMetadata, getClassMetadata, getCollectionMetadata, getCurrentSession, getDefinedFilterNames, getFilterDefinition, getSessionFactoryOptions, getTypeHelper, isClosed, openSession, openStatelessSession, openStatelessSession, withStatelessOptions

Methods inherited from interface org.hibernate.jpa.HibernateEntityManagerFactory

findEntityGraphsByType, getEntityTypeByName, getSessionFactory

Methods inherited from interface javax.persistence.EntityManagerFactory

addNamedEntityGraph, addNamedQuery, createEntityManager, createEntityManager, createEntityManager, createEntityManager, getCriteriaBuilder, getPersistenceUnitUtil, getProperties, isOpen, unwrap

Methods inherited from interface javax.naming.Referenceable

getReference

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

resolveParameterBindType, resolveParameterBindType

Method Detail

getUuid

java.lang.String getUuid()

Get the UUID for this SessionFactory. The value is generated as a UUID, but kept as a String.

Returns:

The UUID for this SessionFactory.

See Also:

SessionFactoryRegistry.getSessionFactory(java.lang.String)

getName

java.lang.String getName()

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

Returns:

The name for the SessionFactory

withOptions

SessionBuilderImplementor withOptions()

Description copied from interface: SessionFactory

Obtain a Session builder.

Specified by:

withOptions in interface SessionFactory

Returns:

The session builder

openTemporarySession

Session openTemporarySession()
                      throws HibernateException

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

Throws:

HibernateException

getCache

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 SessionFactory

Returns:

The direct cache access API.

getStatistics

StatisticsImplementor getStatistics()

Description copied from interface: SessionFactory

Retrieve the statistics fopr this factory.

Specified by:

getStatistics in interface SessionFactory

Returns:

The statistics.

getServiceRegistry

ServiceRegistryImplementor getServiceRegistry()

Access to the ServiceRegistry for this SessionFactory.

Returns:

The factory's ServiceRegistry

getInterceptor

@Deprecated
Interceptor getInterceptor()

Deprecated. (since 5.2) if access to the SessionFactory-scoped Interceptor is needed, use SessionFactoryOptions.getInterceptor() instead. However, generally speaking this access is not needed.

Get the factory scoped interceptor for this factory.

Returns:

The factory scope interceptor, or null if none.

getQueryPlanCache

@Deprecated
QueryPlanCache getQueryPlanCache()

Deprecated. (since 5.2) it will be replaced with the new QueryEngine concept introduced in 6.0

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

Returns:

The query plan cache

getNamedQueryRepository

@Deprecated
NamedQueryRepository getNamedQueryRepository()

Deprecated. (since 5.2) it will be replaced with the new QueryEngine concept introduced in 6.0

Provides access to the named query repository

Returns:

The repository for named query definitions

getFetchProfile

FetchProfile getFetchProfile(java.lang.String name)

Retrieve fetch profile by name.

Parameters:

name - The name of the profile to retrieve.

Returns:

The profile definition

getTypeResolver

@Deprecated
TypeResolver getTypeResolver()

Deprecated. (since 5.2) No replacement, access to and handling of Types will be much different in 6.0

Retrieve the Type resolver associated with this factory.

Returns:

The type resolver

getIdentifierGenerator

IdentifierGenerator getIdentifierGenerator(java.lang.String rootEntityName)

Get the identifier generator for the hierarchy

getEntityNotFoundDelegate

EntityNotFoundDelegate getEntityNotFoundDelegate()

getSqlFunctionRegistry

SQLFunctionRegistry getSqlFunctionRegistry()

addObserver

void addObserver(SessionFactoryObserver observer)

getCustomEntityDirtinessStrategy

CustomEntityDirtinessStrategy getCustomEntityDirtinessStrategy()

getCurrentTenantIdentifierResolver

CurrentTenantIdentifierResolver getCurrentTenantIdentifierResolver()

iterateEntityNameResolvers

@Deprecated
default java.lang.Iterable<EntityNameResolver> iterateEntityNameResolvers()

Deprecated. (since 5.2) use getMetamodel() -> MetamodelImplementor.getEntityNameResolvers()

getDeserializationResolver

SessionFactoryImplementor.DeserializationResolver getDeserializationResolver()

getReturnTypes

@Deprecated
default Type[] getReturnTypes(java.lang.String queryString)

Deprecated. No replacement.

Get the return types of a query

getReturnAliases

@Deprecated
default java.lang.String[] getReturnAliases(java.lang.String queryString)

Deprecated. No replacement.

Get the return aliases of a query

getStatisticsImplementor

@Deprecated
default StatisticsImplementor getStatisticsImplementor()

Deprecated. Just use getStatistics() (with covariant return here as StatisticsImplementor).

getNamedQuery

@Deprecated
default NamedQueryDefinition getNamedQuery(java.lang.String queryName)

Deprecated. (since 5.2) Use NamedQueryRepository.getNamedQueryDefinition(java.lang.String) instead.

registerNamedQueryDefinition

@Deprecated
default void registerNamedQueryDefinition(java.lang.String name,
                                                      NamedQueryDefinition definition)

Deprecated. (since 5.2) Use NamedQueryRepository.registerNamedQueryDefinition(java.lang.String, org.hibernate.engine.spi.NamedQueryDefinition) instead.

getNamedSQLQuery

@Deprecated
default NamedSQLQueryDefinition getNamedSQLQuery(java.lang.String queryName)

Deprecated. (since 5.2) Use NamedQueryRepository.getNamedSQLQueryDefinition(java.lang.String) instead.

registerNamedSQLQueryDefinition

@Deprecated
default void registerNamedSQLQueryDefinition(java.lang.String name,
                                                         NamedSQLQueryDefinition definition)

Deprecated. (since 5.2) Use NamedQueryRepository.registerNamedSQLQueryDefinition(java.lang.String, org.hibernate.engine.spi.NamedSQLQueryDefinition) instead.

getResultSetMapping

@Deprecated
default ResultSetMappingDefinition getResultSetMapping(java.lang.String name)

Deprecated. (since 5.2) Use NamedQueryRepository.getResultSetMappingDefinition(java.lang.String) instead.

getJdbcServices

JdbcServices getJdbcServices()

Get the JdbcServices.

Returns:

the JdbcServices

getDialect

@Deprecated
default Dialect getDialect()

Deprecated. (since 5.2) instead, use this factory's {getServiceRegistry()} -> JdbcServices.getDialect()

Get the SQL dialect.

Shorthand for getJdbcServices().getDialect()

Returns:

The dialect

getSQLExceptionConverter

@Deprecated
default SQLExceptionConverter getSQLExceptionConverter()

Deprecated. since 5.0; use JdbcServices.getSqlExceptionHelper() -> SqlExceptionHelper.getSqlExceptionConverter() instead as obtained from getServiceRegistry()

Retrieves the SQLExceptionConverter in effect for this SessionFactory.

Returns:

The SQLExceptionConverter for this SessionFactory.

getSQLExceptionHelper

@Deprecated
default SqlExceptionHelper getSQLExceptionHelper()

Deprecated. since 5.0; use JdbcServices.getSqlExceptionHelper() instead as obtained from getServiceRegistry()

Retrieves the SqlExceptionHelper in effect for this SessionFactory.

Returns:

The SqlExceptionHelper for this SessionFactory.

getSettings

@Deprecated
Settings getSettings()

Deprecated. since 5.0; use SessionFactory.getSessionFactoryOptions() instead

getMetamodel

MetamodelImplementor getMetamodel()

Specified by:

getMetamodel in interface javax.persistence.EntityManagerFactory

Specified by:

getMetamodel in interface HibernateEntityManagerFactory

getEntityPersister

@Deprecated
default EntityPersister getEntityPersister(java.lang.String entityName)
                                                throws MappingException

Deprecated. (since 5.2) Use MetamodelImplementor.entityPersister(Class) instead.

Throws:

MappingException

getEntityPersisters

@Deprecated
default java.util.Map<java.lang.String,EntityPersister> getEntityPersisters()

Deprecated. (since 5.2) Use MetamodelImplementor.entityPersisters() instead.

getCollectionPersister

@Deprecated
default CollectionPersister getCollectionPersister(java.lang.String role)
                                                        throws MappingException

Deprecated. (since 5.2) Use MetamodelImplementor.collectionPersister(String) instead.

Throws:

MappingException

getCollectionPersisters

@Deprecated
default java.util.Map<java.lang.String,CollectionPersister> getCollectionPersisters()

Deprecated. (since 5.2) Use MetamodelImplementor.collectionPersisters() instead.

getCollectionRolesByEntityParticipant

@Deprecated
default java.util.Set<java.lang.String> getCollectionRolesByEntityParticipant(java.lang.String entityName)

Deprecated. (since 5.2) Use MetamodelImplementor.collectionPersisters() instead. Retrieves a set of all the collection roles in which the given entity is a participant, as either an index or an element.

Parameters:

entityName - The entity name for which to get the collection roles.

Returns:

set of all the collection roles in which the given entityName participates.

locateEntityPersister

@Deprecated
default EntityPersister locateEntityPersister(java.lang.Class byClass)

Deprecated. (since 5.2) Use MetamodelImplementor.locateEntityPersister(Class) instead.

locateEntityPersister

@Deprecated
default EntityPersister locateEntityPersister(java.lang.String byName)

Deprecated. (since 5.2) Use MetamodelImplementor.locateEntityPersister(String) instead.

getImplementors

@Deprecated
default java.lang.String[] getImplementors(java.lang.String entityName)

Deprecated. Use Metamodel.getImplementors(java.lang.String) instead

Get the names of all persistent classes that implement/extend the given interface/class

getImportedClassName

@Deprecated
default java.lang.String getImportedClassName(java.lang.String name)

Deprecated. Use Metamodel.getImportedClassName(java.lang.String) instead

Get a class name, using query language imports

findEntityGraphByName

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

getSecondLevelCacheRegion

@Deprecated
default Region getSecondLevelCacheRegion(java.lang.String regionName)

Deprecated. (since 5.2) Use this factory's getCache() reference to access Region via CacheImplementor.determineEntityRegionAccessStrategy(org.hibernate.mapping.PersistentClass) or CacheImplementor.determineCollectionRegionAccessStrategy(org.hibernate.mapping.Collection) instead.

Get a named second-level cache region

Parameters:

regionName - The name of the region to retrieve.

Returns:

The name of the region

getSecondLevelCacheRegionAccessStrategy

@Deprecated
default RegionAccessStrategy getSecondLevelCacheRegionAccessStrategy(java.lang.String regionName)

Deprecated. (since 5.2) Use this factory's getCache() reference to access CacheImplementor.determineEntityRegionAccessStrategy(org.hibernate.mapping.PersistentClass) or CacheImplementor.determineCollectionRegionAccessStrategy(org.hibernate.mapping.Collection) instead.

Find the "access strategy" for the named cache region.

Parameters:

regionName - The name of the region

Returns:

That region's "access strategy"

getNaturalIdCacheRegion

@Deprecated
default Region getNaturalIdCacheRegion(java.lang.String regionName)

Deprecated. (since 5.2) Use this factory's getCache() -> CacheImplementor.getNaturalIdCacheRegionAccessStrategy(String) -> NaturalIdRegionAccessStrategy.getRegion() instead.

Get a named natural-id cache region

Parameters:

regionName - The name of the region to retrieve.

Returns:

The region

getNaturalIdCacheRegionAccessStrategy

@Deprecated
default RegionAccessStrategy getNaturalIdCacheRegionAccessStrategy(java.lang.String regionName)

Deprecated. (since 5.2) Use this factory's getCache() -> CacheImplementor.getNaturalIdCacheRegionAccessStrategy(String) instead.

Find the "access strategy" for the named naturalId cache region.

Parameters:

regionName - The region name

Returns:

That region's "access strategy"

getAllSecondLevelCacheRegions

@Deprecated
java.util.Map getAllSecondLevelCacheRegions()

Deprecated. (since 5.2) with no direct replacement; use this factory's getCache() reference to access cache objects as needed.

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.

Returns:

The map of regions

getQueryCache

@Deprecated
default QueryCache getQueryCache()

Deprecated. Use CacheImplementor.getDefaultQueryCache() instead

Get the default query cache.

getQueryCache

@Deprecated
default QueryCache getQueryCache(java.lang.String regionName)

Deprecated. Use CacheImplementor.getQueryCache(String) instead

Get a particular named query cache, or the default cache

Parameters:

regionName - the name of the cache region, or null for the default query cache

Returns:

the existing cache, or a newly created cache if none by that region name

getUpdateTimestampsCache

@Deprecated
default UpdateTimestampsCache getUpdateTimestampsCache()

Deprecated. Use CacheImplementor.getUpdateTimestampsCache() instead

Get the cache of table update timestamps