public interface SessionFactory extends Referenceable, Serializable
Session
instances. Usually
an application has a single SessionFactory
instance and threads
servicing client requests obtain Session
instances from this factory.
The internal state of a SessionFactory
is immutable. Once it is created
this internal state is set. This internal state includes all of the metadata
about Object/Relational Mapping.
Implementors must be threadsafe.Configuration
Modifier and Type | Interface and Description |
---|---|
static interface |
SessionFactory.SessionFactoryOptions
Aggregator of special options used to build the SessionFactory.
|
Modifier and Type | Method and Description |
---|---|
void |
close()
Destroy this SessionFactory and release all resources (caches,
connection pools, etc).
|
boolean |
containsFetchProfileDefinition(String name)
Determine if this session factory contains a fetch profile definition
registered under the given name.
|
void |
evict(Class persistentClass)
Deprecated.
Use
Cache.evictEntityRegion(Class) accessed through
getCache() instead. |
void |
evict(Class persistentClass,
Serializable id)
Deprecated.
Use
Cache.containsEntity(Class, Serializable) accessed through
getCache() instead. |
void |
evictCollection(String roleName)
Deprecated.
Use
Cache.evictCollectionRegion(String) accessed through
getCache() instead. |
void |
evictCollection(String roleName,
Serializable id)
Deprecated.
Use
Cache.evictCollection(String,Serializable) accessed through
getCache() instead. |
void |
evictEntity(String entityName)
Deprecated.
Use
Cache.evictEntityRegion(String) accessed through
getCache() instead. |
void |
evictEntity(String entityName,
Serializable id)
Deprecated.
Use
Cache.evictEntity(String,Serializable) accessed through
getCache() instead. |
void |
evictQueries()
Deprecated.
Use
Cache.evictQueryRegions() accessed through
getCache() instead. |
void |
evictQueries(String cacheRegion)
Deprecated.
Use
Cache.evictQueryRegion(String) accessed through
getCache() instead. |
Map<String,ClassMetadata> |
getAllClassMetadata()
Retrieve the
ClassMetadata for all mapped entities. |
Map |
getAllCollectionMetadata()
Get the
CollectionMetadata for all mapped collections. |
Cache |
getCache()
Obtain direct access to the underlying cache regions.
|
ClassMetadata |
getClassMetadata(Class entityClass)
Retrieve the
ClassMetadata associated with the given entity class. |
ClassMetadata |
getClassMetadata(String entityName)
Retrieve the
ClassMetadata associated with the given entity class. |
CollectionMetadata |
getCollectionMetadata(String roleName)
Get the
CollectionMetadata associated with the named collection role. |
Session |
getCurrentSession()
Obtains the current session.
|
Set |
getDefinedFilterNames()
Obtain a set of the names of all filters defined on this SessionFactory.
|
FilterDefinition |
getFilterDefinition(String filterName)
Obtain the definition of a filter by name.
|
SessionFactory.SessionFactoryOptions |
getSessionFactoryOptions()
Get the special options used to build the factory.
|
Statistics |
getStatistics()
Retrieve the statistics fopr this factory.
|
TypeHelper |
getTypeHelper()
Retrieve this factory's
TypeHelper . |
boolean |
isClosed()
Is this factory already closed?
|
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 . |
SessionBuilder |
withOptions()
Obtain a
Session builder. |
StatelessSessionBuilder |
withStatelessOptions()
Obtain a
StatelessSession builder. |
getReference
SessionFactory.SessionFactoryOptions getSessionFactoryOptions()
SessionBuilder withOptions()
Session
builder.Session openSession() throws HibernateException
Session
.
JDBC connection(s
will be obtained from the
configured ConnectionProvider
as needed
to perform requested work.HibernateException
- Indicates a problem opening the session; pretty rare here.Session getCurrentSession() throws HibernateException
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.HibernateException
- Indicates an issue locating a suitable current session.StatelessSessionBuilder withStatelessOptions()
StatelessSession
builder.StatelessSession openStatelessSession()
StatelessSession openStatelessSession(Connection connection)
Connection
.connection
- Connection provided by the application.ClassMetadata getClassMetadata(Class entityClass)
ClassMetadata
associated with the given entity class.entityClass
- The entity classHibernateException
- Generally null is returned instead of throwing.ClassMetadata getClassMetadata(String entityName)
ClassMetadata
associated with the given entity class.entityName
- The entity classHibernateException
- Generally null is returned instead of throwing.CollectionMetadata getCollectionMetadata(String roleName)
CollectionMetadata
associated with the named collection role.roleName
- The collection role (in form [owning-entity-name].[collection-property-name]).HibernateException
- Generally null is returned instead of throwing.Map<String,ClassMetadata> getAllClassMetadata()
ClassMetadata
for all mapped entities.ClassMetadata
keyed by the
corresponding String
entity-name.HibernateException
- Generally empty map is returned instead of throwing.Class
to String
.Map getAllCollectionMetadata()
CollectionMetadata
for all mapped collections.HibernateException
- Generally empty map is returned instead of throwing.Statistics getStatistics()
void close() throws HibernateException
sessions
before calling this method as the impact
on those sessions
is indeterminate.
No-ops if already closed
.HibernateException
- Indicates an issue closing the factory.boolean isClosed()
Cache getCache()
@Deprecated void evict(Class persistentClass) throws HibernateException
persistentClass
- The entity class for which to evict data.HibernateException
- Generally will mean that either that
'persisttentClass' did not name a mapped entity or a problem
communicating with underlying cache impl.@Deprecated void evict(Class persistentClass, Serializable id) throws HibernateException
persistentClass
- The entity class for which to evict data.id
- The entity idHibernateException
- Generally will mean that either that
'persisttentClass' did not name a mapped entity or a problem
communicating with underlying cache impl.@Deprecated void evictEntity(String entityName) throws HibernateException
entityName
- The entity name for which to evict data.HibernateException
- Generally will mean that either that
'persisttentClass' did not name a mapped entity or a problem
communicating with underlying cache impl.@Deprecated void evictEntity(String entityName, Serializable id) throws HibernateException
entityName
- The entity name for which to evict data.id
- The entity idHibernateException
- Generally will mean that either that
'persisttentClass' did not name a mapped entity or a problem
communicating with underlying cache impl.@Deprecated void evictCollection(String roleName) throws HibernateException
roleName
- The name of the collection role whose regions should be evictedHibernateException
- Generally will mean that either that
'roleName' did not name a mapped collection or a problem
communicating with underlying cache impl.@Deprecated void evictCollection(String roleName, Serializable id) throws HibernateException
roleName
- The name of the collection roleid
- The id of the collection ownerHibernateException
- Generally will mean that either that
'roleName' did not name a mapped collection or a problem
communicating with underlying cache impl.@Deprecated void evictQueries(String cacheRegion) throws HibernateException
cacheRegion
- The named query cache region from which to evict.HibernateException
- Since a not-found 'cacheRegion' simply no-ops,
this should indicate a problem communicating with underlying cache impl.@Deprecated void evictQueries() throws HibernateException
HibernateException
- Indicate a problem communicating with
underlying cache impl.Set getDefinedFilterNames()
FilterDefinition getFilterDefinition(String filterName) throws HibernateException
filterName
- The name of the filter for which to obtain the definition.HibernateException
- If no filter defined with the given name.boolean containsFetchProfileDefinition(String name)
name
- The name to checkTypeHelper getTypeHelper()
TypeHelper
.TypeHelper
Copyright © 2001-2015 Red Hat, Inc. All Rights Reserved.