NativeHibernateExtractor.java

/*
 * Copyright 2004-2009 the original author or authors.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *      http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package org.compass.gps.device.hibernate;

import org.hibernate.SessionFactory;

/**
 * A native <code>SessionFactory<code> extractor. Should be used with code/frameworks that
 * wrap the actual <code>SessionFactory</code>.
 *
 * @author kimchy
 */
public interface NativeHibernateExtractor {

    /**
     * Returns the actual <code>EntityManagerFactory</code> based on the given <code>EntityManagerFactory</code>.
     * Should return the same <code>EntityManagerFactory</code> if not wrapping has been done.
     *
     * @param sessionFactory The (possibly) wrapped <code>EntityManagerFactory</code>.
     * @return The actual <code>EntityManagerFactory</code> implementation.
     * @throws HibernateGpsDeviceException
     */
    SessionFactory extractNative(SessionFactory sessionFactory) throws HibernateGpsDeviceException;
}