org.hibernate.context.spi.CurrentSessionContext Maven / Gradle / Ivy

Go to download
/*
 * Hibernate, Relational Persistence for Idiomatic Java
 *
 * License: GNU Lesser General Public License (LGPL), version 2.1 or later.
 * See the lgpl.txt file in the root directory or .
 */
package org.hibernate.context.spi;

import java.io.Serializable;

import org.hibernate.HibernateException;
import org.hibernate.Session;

/**
 * Defines the contract for implementations which know how to scope the notion
 * of a {@link org.hibernate.SessionFactory#getCurrentSession() current session}.
 * 
 * Implementations should adhere to the following:
 * 

 * contain a constructor accepting a single argument of type
 * {@link org.hibernate.engine.spi.SessionFactoryImplementor}
 * 
should be thread safe
 * 
should be fully serializable
 * 
 * 
 * Implementors should be aware that they are also fully responsible for
 * cleanup of any generated current-sessions.
 * 
 * Note that there will be exactly one instance of the configured
 * CurrentSessionContext implementation per {@link org.hibernate.SessionFactory}.
 *
 * @author Steve Ebersole
 */
public interface CurrentSessionContext extends Serializable {
	/**
	 * Retrieve the current session according to the scoping defined
	 * by this implementation.
	 *
	 * @return The current session.
	 * @throws HibernateException Typically indicates an issue
	 * locating or creating the current session.
	 */
	public Session currentSession() throws HibernateException;
}