/*
 * Hibernate, Relational Persistence for Idiomatic Java
 *
 * Copyright (c) 2011, Red Hat Inc. or third-party contributors as
 * indicated by the @author tags or express copyright attribution
 * statements applied by the authors.  All third-party contributions are
 * distributed under license by Red Hat Inc.
 *
 * This copyrighted material is made available to anyone wishing to use, modify,
 * copy, or redistribute it subject to the terms and conditions of the GNU
 * Lesser General Public License, as published by the Free Software Foundation.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
 * or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU Lesser General Public License
 * for more details.
 *
 * You should have received a copy of the GNU Lesser General Public License
 * along with this distribution; if not, write to:
 * Free Software Foundation, Inc.
 * 51 Franklin Street, Fifth Floor
 * Boston, MA  02110-1301  USA
 */
package org.hibernate.service.spi;

import org.hibernate.cfg.Configuration;
import org.hibernate.engine.spi.SessionFactoryImplementor;
import org.hibernate.metamodel.source.MetadataImplementor;
import org.hibernate.service.Service;

Contract for an initiator of services that target the specialized service registry SessionFactoryServiceRegistry 
Author:
Steve Ebersole/**
 * Contract for an initiator of services that target the specialized service registry
 * {@link SessionFactoryServiceRegistry}
 *
 * @author Steve Ebersole
 */
public interface SessionFactoryServiceInitiator<R extends Service> extends ServiceInitiator<R>{
	
Initiates the managed service.

Note for implementors: signature is guaranteed to change once redesign of SessionFactory building is complete
Params:
sessionFactory – The session factory.  Note the the session factory is still in flux; care needs to be taken
in regards to what you call.
configuration – The configuration.
registry – The service registry.  Can be used to locate services needed to fulfill initiation.
Returns:
The initiated service./**
	 * Initiates the managed service.
	 * <p/>
	 * Note for implementors: signature is guaranteed to change once redesign of SessionFactory building is complete
	 *
	 * @param sessionFactory The session factory.  Note the the session factory is still in flux; care needs to be taken
	 * in regards to what you call.
	 * @param configuration The configuration.
	 * @param registry The service registry.  Can be used to locate services needed to fulfill initiation.
	 *
	 * @return The initiated service.
	 */
	public R initiateService(SessionFactoryImplementor sessionFactory, Configuration configuration, ServiceRegistryImplementor registry);

	
Initiates the managed service.

Note for implementors: signature is guaranteed to change once redesign of SessionFactory building is complete
Params:
sessionFactory – The session factory.  Note the the session factory is still in flux; care needs to be taken
in regards to what you call.
metadata – The configuration.
registry – The service registry.  Can be used to locate services needed to fulfill initiation.
Returns:
The initiated service./**
	 * Initiates the managed service.
	 * <p/>
	 * Note for implementors: signature is guaranteed to change once redesign of SessionFactory building is complete
	 *
	 * @param sessionFactory The session factory.  Note the the session factory is still in flux; care needs to be taken
	 * in regards to what you call.
	 * @param metadata The configuration.
	 * @param registry The service registry.  Can be used to locate services needed to fulfill initiation.
	 *
	 * @return The initiated service.
	 */
	public R initiateService(SessionFactoryImplementor sessionFactory, MetadataImplementor metadata, ServiceRegistryImplementor registry);

}