SessionFactoryImplementor (Red Hat JBoss Enterprise Application Platform 7.3.0.CD18 public API)

All Superinterfaces:

AutoCloseable, Closeable, EntityManagerFactory, HibernateEntityManagerFactory, Mapping, QueryParameterBindingTypeResolver, Referenceable, 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.

Author:

Gavin King, Steve Ebersole

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

All Methods Instance Methods Abstract Methods Default Methods Deprecated Methods
Modifier and Type	Method and Description
`void`	`addObserver(SessionFactoryObserver observer)`
`EntityGraph`	`findEntityGraphByName(String name)`
`CacheImplementor`	`getCache()` Obtain direct access to the underlying cache regions.
`default CollectionPersister`	`getCollectionPersister(String role)` Deprecated. (since 5.2) Use `MetamodelImplementor.collectionPersister(String)` instead.
`default Map<String,CollectionPersister>`	`getCollectionPersisters()` Deprecated. (since 5.2) Use `MetamodelImplementor.collectionPersisters()` instead.
`default Set<String>`	`getCollectionRolesByEntityParticipant(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 `JdbcServices.getDialect()`
`EntityNotFoundDelegate`	`getEntityNotFoundDelegate()`
`default EntityPersister`	`getEntityPersister(String entityName)` Deprecated. (since 5.2) Use `MetamodelImplementor.entityPersister(Class)` instead.
`default Map<String,EntityPersister>`	`getEntityPersisters()` Deprecated. (since 5.2) Use `MetamodelImplementor.entityPersisters()` instead.
`FetchProfile`	`getFetchProfile(String name)` Retrieve fetch profile by name.
`IdentifierGenerator`	`getIdentifierGenerator(String rootEntityName)` Get the identifier generator for the hierarchy
`default String[]`	`getImplementors(String entityName)` Deprecated. Use `Metamodel.getImplementors(java.lang.String)` instead
`default String`	`getImportedClassName(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()` Return an instance of `Metamodel` interface for access to the metamodel of the persistence unit.
`String`	`getName()` Access to the name (if one) assigned to the SessionFactory
`default NamedQueryDefinition`	`getNamedQuery(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(String queryName)` Deprecated. (since 5.2) Use `NamedQueryRepository.getNamedSQLQueryDefinition(java.lang.String)` instead.
`QueryPlanCache`	`getQueryPlanCache()` Deprecated. (since 5.2) it will be replaced with the new QueryEngine concept introduced in 6.0
`default ResultSetMappingDefinition`	`getResultSetMapping(String name)` Deprecated. (since 5.2) Use `NamedQueryRepository.getResultSetMappingDefinition(java.lang.String)` instead.
`default String[]`	`getReturnAliases(String queryString)` Deprecated. No replacement.
`default Type[]`	`getReturnTypes(String queryString)` Deprecated. No replacement.
`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. (since 5.2) 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
`String`	`getUuid()` Get the UUID for this SessionFactory.
`default Iterable<EntityNameResolver>`	`iterateEntityNameResolvers()` Deprecated. (since 5.2) use `getMetamodel()` -> `MetamodelImplementor.getEntityNameResolvers()`
`default EntityPersister`	`locateEntityPersister(Class byClass)` Deprecated. (since 5.2) Use `MetamodelImplementor.locateEntityPersister(Class)` instead.
`default EntityPersister`	`locateEntityPersister(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(String name, NamedQueryDefinition definition)` Deprecated. (since 5.2) Use `NamedQueryRepository.registerNamedQueryDefinition(java.lang.String, org.hibernate.engine.spi.NamedQueryDefinition)` instead.
`default void`	`registerNamedSQLQueryDefinition(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, getEntityManagerFactoryName, 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
```
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
```
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 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(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(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 Iterable<EntityNameResolver> iterateEntityNameResolvers()
```
    Deprecated. (since 5.2) use getMetamodel() -> MetamodelImplementor.getEntityNameResolvers()
  - getDeserializationResolver
```
SessionFactoryImplementor.DeserializationResolver getDeserializationResolver()
```
  - getReturnTypes
```
@Deprecated
default Type[] getReturnTypes(String queryString)
```
    Deprecated. No replacement.
    
    Get the return types of a query
  - getReturnAliases
```
@Deprecated
default String[] getReturnAliases(String queryString)
```
    Deprecated. No replacement.
    
    Get the return aliases of a query
  - getStatisticsImplementor
```
@Deprecated
default StatisticsImplementor getStatisticsImplementor()
```
    Deprecated. (since 5.2) Just use getStatistics() (with covariant return here as StatisticsImplementor).
  - getNamedQuery
```
@Deprecated
default NamedQueryDefinition getNamedQuery(String queryName)
```
    Deprecated. (since 5.2) Use NamedQueryRepository.getNamedQueryDefinition(java.lang.String) instead.
  - registerNamedQueryDefinition
```
@Deprecated
default void registerNamedQueryDefinition(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(String queryName)
```
    Deprecated. (since 5.2) Use NamedQueryRepository.getNamedSQLQueryDefinition(java.lang.String) instead.
  - registerNamedSQLQueryDefinition
```
@Deprecated
default void registerNamedSQLQueryDefinition(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(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 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()
```
    Description copied from interface: EntityManagerFactory
    
    Return an instance of Metamodel interface for access to the metamodel of the persistence unit.
    
    Specified by:
    
    getMetamodel in interface EntityManagerFactory
    
    Specified by:
    
    getMetamodel in interface HibernateEntityManagerFactory
    
    Returns:
    
    Metamodel instance
  - getEntityPersister
```
@Deprecated
default EntityPersister getEntityPersister(String entityName)
                                                throws MappingException
```
    Deprecated. (since 5.2) Use MetamodelImplementor.entityPersister(Class) instead.
    
    Throws:
    
    MappingException
  - getEntityPersisters
```
@Deprecated
default Map<String,EntityPersister> getEntityPersisters()
```
    Deprecated. (since 5.2) Use MetamodelImplementor.entityPersisters() instead.
  - getCollectionPersister
```
@Deprecated
default CollectionPersister getCollectionPersister(String role)
                                                        throws MappingException
```
    Deprecated. (since 5.2) Use MetamodelImplementor.collectionPersister(String) instead.
    
    Throws:
    
    MappingException
  - getCollectionPersisters
```
@Deprecated
default Map<String,CollectionPersister> getCollectionPersisters()
```
    Deprecated. (since 5.2) Use MetamodelImplementor.collectionPersisters() instead.
  - getCollectionRolesByEntityParticipant
```
@Deprecated
default Set<String> getCollectionRolesByEntityParticipant(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(Class byClass)
```
    Deprecated. (since 5.2) Use MetamodelImplementor.locateEntityPersister(Class) instead.
  - locateEntityPersister
```
@Deprecated
default EntityPersister locateEntityPersister(String byName)
```
    Deprecated. (since 5.2) Use MetamodelImplementor.locateEntityPersister(String) instead.
  - getImplementors
```
@Deprecated
default String[] getImplementors(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 String getImportedClassName(String name)
```
    Deprecated. Use Metamodel.getImportedClassName(java.lang.String) instead
    
    Get a class name, using query language imports
  - findEntityGraphByName
```
EntityGraph findEntityGraphByName(String name)
```

Interface SessionFactoryImplementor

Nested Class Summary

Method Summary

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

Methods inherited from interface org.hibernate.SessionFactory

Methods inherited from interface org.hibernate.jpa.HibernateEntityManagerFactory

Methods inherited from interface javax.persistence.EntityManagerFactory

Methods inherited from interface javax.naming.Referenceable

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

Method Detail

getUuid

getName

withOptions

openTemporarySession

getCache

getStatistics

getServiceRegistry

getInterceptor

getQueryPlanCache

getNamedQueryRepository

getFetchProfile

getTypeResolver

getIdentifierGenerator

getEntityNotFoundDelegate

getSqlFunctionRegistry

addObserver

getCustomEntityDirtinessStrategy

getCurrentTenantIdentifierResolver

iterateEntityNameResolvers

getDeserializationResolver

getReturnTypes

getReturnAliases

getStatisticsImplementor

getNamedQuery

registerNamedQueryDefinition

getNamedSQLQuery

registerNamedSQLQueryDefinition

getResultSetMapping

getJdbcServices

getDialect

getSQLExceptionConverter

getSQLExceptionHelper

getSettings

getMetamodel

getEntityPersister

getEntityPersisters

getCollectionPersister

getCollectionPersisters

getCollectionRolesByEntityParticipant

locateEntityPersister

locateEntityPersister

getImplementors

getImportedClassName

findEntityGraphByName