All Downloads are FREE. Search and download functionalities are using the official Maven repository.

org.compass.gps.device.jpa.NativeJpaExtractor Maven / Gradle / Ivy

There is a newer version: 2.2.0
Show newest version
/*
 * Copyright 2004-2006 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.jpa;

import javax.persistence.EntityManager;
import javax.persistence.EntityManagerFactory;

/**
 * A native EntityManagerFactory extractor. Should be used with code/frameworks that
 * wrap the actual EntityManagerFactory.
 *
 * @author kimchy
 */
public interface NativeJpaExtractor {

    /**
     * Returns the actual EntityManagerFactory based on the given EntityManagerFactory.
     * Should return the same EntityManagerFactory if not wrapping has been done.
     *
     * @param entityManagerFactory The (possibly) wrapped EntityManagerFactory.
     * @return The actual EntityManagerFactory implementation.
     * @throws JpaGpsDeviceException
     */
    EntityManagerFactory extractNative(EntityManagerFactory entityManagerFactory) throws JpaGpsDeviceException;

    /**
     * Extracts the native EntityManager based on the given EntityManager.
     * Should return the same EntityManager if no wrapper has been done.
     *
     * @param entityManager The (possibly) wrapper EntityManager.
     * @return The actual EntityManager.
     * @throws JpaGpsDeviceException
     */
    EntityManager extractNative(EntityManager entityManager) throws JpaGpsDeviceException;
}