001/*
002 * Copyright 2002-2012 the original author or authors.
003 *
004 * Licensed under the Apache License, Version 2.0 (the "License");
005 * you may not use this file except in compliance with the License.
006 * You may obtain a copy of the License at
007 *
008 *      https://www.apache.org/licenses/LICENSE-2.0
009 *
010 * Unless required by applicable law or agreed to in writing, software
011 * distributed under the License is distributed on an "AS IS" BASIS,
012 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
013 * See the License for the specific language governing permissions and
014 * limitations under the License.
015 */
016
017package org.springframework.orm.jpa;
018
019import javax.persistence.EntityManager;
020
021/**
022 * Subinterface of {@link javax.persistence.EntityManager} to be implemented by
023 * EntityManager proxies. Allows access to the underlying target EntityManager.
024 *
025 * <p>This interface is mainly intended for framework usage. Application code
026 * should prefer the use of the {@link javax.persistence.EntityManager#getDelegate()}
027 * method to access native functionality of the underlying resource.
028 *
029 * @author Juergen Hoeller
030 * @since 2.5
031 */
032public interface EntityManagerProxy extends EntityManager {
033
034        /**
035         * Return the underlying EntityManager that this proxy will delegate to.
036         * <p>In case of an extended EntityManager, this will be the associated
037         * raw EntityManager.
038         * <p>In case of a shared ("transactional") EntityManager, this will be
039         * the raw EntityManager that is currently associated with the transaction.
040         * Outside of a transaction, an IllegalStateException will be thrown.
041         * @return the underlying raw EntityManager (never {@code null})
042         * @throws IllegalStateException if no underlying EntityManager is available
043         */
044        EntityManager getTargetEntityManager() throws IllegalStateException;
045
046}