org.hibernate

Interface SessionFactory

All Superinterfaces:

AutoCloseable, Closeable, EntityManagerFactory, HibernateEntityManagerFactory, Referenceable, Serializable

All Known Subinterfaces:

SessionFactoryImplementor

All Known Implementing Classes:

SessionFactoryDelegatingImpl, SessionFactoryImpl

public interface SessionFactory
extends EntityManagerFactory, HibernateEntityManagerFactory, Referenceable, Serializable, Closeable

The main contract here is the creation of 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.

Author:

Gavin King, Steve Ebersole

See Also:

Configuration

Method Summary

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.
Map<String,ClassMetadata>	getAllClassMetadata() Deprecated. Use the descriptors from EntityManagerFactory.getMetamodel() instead
Map	getAllCollectionMetadata() Deprecated. Use the descriptors from EntityManagerFactory.getMetamodel() instead
Cache	getCache() Obtain direct access to the underlying cache regions.
ClassMetadata	getClassMetadata(Class entityClass) Deprecated. Use the descriptors from EntityManagerFactory.getMetamodel() instead
ClassMetadata	getClassMetadata(String entityName) Deprecated. Use the descriptors from EntityManagerFactory.getMetamodel() instead
CollectionMetadata	getCollectionMetadata(String roleName) Deprecated. Use the descriptors from EntityManagerFactory.getMetamodel() instead
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.
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.

Methods inherited from interface org.hibernate.jpa.HibernateEntityManagerFactory

findEntityGraphsByType, getEntityManagerFactoryName, getEntityTypeByName, getMetamodel, 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

Method Detail

getSessionFactoryOptions

SessionFactoryOptions getSessionFactoryOptions()

Get the special options used to build the factory.

Returns:

The special options used to build the factory.

withOptions

SessionBuilder withOptions()

Obtain a Session builder.

Returns:

The session builder

openSession

Session openSession()
             throws HibernateException

Open a Session.

JDBC connection(s will be obtained from the configured ConnectionProvider as needed to perform requested work.

Returns:

The created session.

Throws:

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

getCurrentSession

Session getCurrentSession()
                   throws HibernateException

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.

Returns:

The current session.

Throws:

HibernateException - Indicates an issue locating a suitable current session.

withStatelessOptions

StatelessSessionBuilder withStatelessOptions()

Obtain a StatelessSession builder.

Returns:

The stateless session builder

openStatelessSession

StatelessSession openStatelessSession()

Open a new stateless session.

Returns:

The created stateless session.

openStatelessSession

StatelessSession openStatelessSession(Connection connection)

Open a new stateless session, utilizing the specified JDBC Connection.

Parameters:

connection - Connection provided by the application.

Returns:

The created stateless session.

getStatistics

Statistics getStatistics()

Retrieve the statistics fopr this factory.

Returns:

The statistics.

close

void close()
    throws HibernateException

Destroy this SessionFactory and release all resources (caches, connection pools, etc).

It is the responsibility of the application to ensure that there are no open sessions before calling this method as the impact on those sessions is indeterminate.

No-ops if already closed.

Specified by:

close in interface AutoCloseable

Specified by:

close in interface Closeable

Specified by:

close in interface EntityManagerFactory

Throws:

HibernateException - Indicates an issue closing the factory.

isClosed

boolean isClosed()

Is this factory already closed?

Returns:

True if this factory is already closed; false otherwise.

getCache

Cache getCache()

Obtain direct access to the underlying cache regions.

Specified by:

getCache in interface EntityManagerFactory

Returns:

The direct cache access API.

getDefinedFilterNames

Set getDefinedFilterNames()

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

Returns:

The set of filter names.

getFilterDefinition

FilterDefinition getFilterDefinition(String filterName)
                              throws HibernateException

Obtain the definition of a filter by name.

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

boolean containsFetchProfileDefinition(String name)

Determine if this session factory contains a fetch profile definition registered under the given name.

Parameters:

name - The name to check

Returns:

True if there is such a fetch profile; false otherwise.

getTypeHelper

TypeHelper getTypeHelper()

Retrieve this factory's TypeHelper.

Returns:

The factory's TypeHelper

getClassMetadata

@Deprecated
ClassMetadata getClassMetadata(Class entityClass)

Deprecated. Use the descriptors from EntityManagerFactory.getMetamodel() instead

Retrieve the ClassMetadata associated with the given entity class.

Parameters:

entityClass - 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.

getClassMetadata

@Deprecated
ClassMetadata getClassMetadata(String entityName)

Deprecated. Use the descriptors from EntityManagerFactory.getMetamodel() instead

Retrieve the ClassMetadata associated with the given entity class.

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.

Since:

3.0

getCollectionMetadata

@Deprecated
CollectionMetadata getCollectionMetadata(String roleName)

Deprecated. Use the descriptors from EntityManagerFactory.getMetamodel() instead

Get the CollectionMetadata associated with the named collection role.

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.

getAllClassMetadata

@Deprecated
Map<String,ClassMetadata> getAllClassMetadata()

Deprecated. Use the descriptors from EntityManagerFactory.getMetamodel() instead

Retrieve the ClassMetadata for all mapped entities.

Returns:

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

Throws:

HibernateException - Generally empty map is returned instead of throwing.

Since:

3.0 changed key from Class to String.

getAllCollectionMetadata

@Deprecated
Map getAllCollectionMetadata()

Deprecated. Use the descriptors from EntityManagerFactory.getMetamodel() instead

Get the CollectionMetadata for all mapped collections.

Returns:

a map from String to CollectionMetadata

Throws:

HibernateException - Generally empty map is returned instead of throwing.