/*
* Copyright 2002-2007 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.springframework.orm.jpa;
import javax.persistence.EntityManager;
/**
* Subinterface of {@link javax.persistence.EntityManager} to be implemented by
* EntityManager proxies. Allows access to the underlying target EntityManager.
*
* <p>This interface is mainly intended for framework usage. Application code
* should prefer the use of the {@link javax.persistence.EntityManager#getDelegate()}
* method to access native functionality of the underlying resource.
*
* @author Juergen Hoeller
* @since 2.5
*/
public interface EntityManagerProxy extends EntityManager {
/**
* Return the underlying EntityManager that this proxy will delegate to.
* <p>In case of an extended EntityManager, this will be the associated
* raw EntityManager.
* <p>In case of a shared ("transactional") EntityManager, this will be
* the raw EntityManager that is currently associated with the transaction.
* Outside of a transaction, an IllegalStateException will be thrown.
* @return the underlying raw EntityManager (never <code>null</code>)
* @throws IllegalStateException if no underlying EntityManager is available
*/
EntityManager getTargetEntityManager() throws IllegalStateException;
}
|