    001// Copyright 2007, 2008 The Apache Software Foundation
    002//
    003// Licensed under the Apache License, Version 2.0 (the "License");
    004// you may not use this file except in compliance with the License.
    005// You may obtain a copy of the License at
    006//
    007//     http://www.apache.org/licenses/LICENSE-2.0
    008//
    009// Unless required by applicable law or agreed to in writing, software
    010// distributed under the License is distributed on an "AS IS" BASIS,
    011// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
    012// See the License for the specific language governing permissions and
    013// limitations under the License.
    014
    015package org.apache.tapestry5.hibernate;
    016
    017import org.apache.tapestry5.ioc.annotations.UsesOrderedConfiguration;
    018import org.hibernate.Session;
    019import org.hibernate.SessionFactory;
    020import org.hibernate.cfg.Configuration;
    021
    022/**
    023 * Responsible for creating a Hibernate session as needed. Internally, is responsible for Hibernate {@link
    024 * Configuration}, resulting in a {@link SessionFactory}.
    025 * <p/>
    026 * The service's configuration is a {@linkplain org.apache.tapestry5.ioc.services.ChainBuilder chain of command} of
    027 * configurator objects.
    028 */
    029@UsesOrderedConfiguration(HibernateConfigurer.class)
    030public interface HibernateSessionSource
    031{
    032    /**
    033     * Creates a new session using the {@link #getSessionFactory() SessionFactory} created at service startup.
    034     */
    035    Session create();
    036
    037    /**
    038     * Returns the SessionFactory from which Hibernate sessions are created.
    039     */
    040    SessionFactory getSessionFactory();
    041
    042    /**
    043     * Returns the final configuration used to create the {@link SessionFactory}. The configuration is immutable.
    044     */
    045    Configuration getConfiguration();
    046}