1 /* 2 * Copyright 2002-2011 the original author or authors. 3 * 4 * Licensed under the Apache License, Version 2.0 (the "License"); 5 * you may not use this file except in compliance with the License. 6 * You may obtain a copy of the License at 7 * 8 * http://www.apache.org/licenses/LICENSE-2.0 9 * 10 * Unless required by applicable law or agreed to in writing, software 11 * distributed under the License is distributed on an "AS IS" BASIS, 12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 13 * See the License for the specific language governing permissions and 14 * limitations under the License. 15 */ 16 17 package org.springframework.orm.jpa; 18 19 import javax.persistence.EntityManager; 20 import javax.persistence.PersistenceException; 21 22 /** 23 * Callback interface for JPA code. To be used with {@link JpaTemplate}'s 24 * execution method, often as anonymous classes within a method implementation. 25 * A typical implementation will call <code>EntityManager.find/merge</code> 26 * to perform some operations on persistent objects. 27 * 28 * @author Juergen Hoeller 29 * @since 2.0 30 * @see org.springframework.orm.jpa.JpaTemplate 31 * @see org.springframework.orm.jpa.JpaTransactionManager 32 * @deprecated as of Spring 3.1, in favor of native EntityManager usage 33 * (typically obtained through <code>@PersistenceContext</code>) 34 */ 35 @Deprecated 36 public interface JpaCallback<T> { 37 38 /** 39 * Gets called by <code>JpaTemplate.execute</code> with an active 40 * JPA <code>EntityManager</code>. Does not need to care about activating 41 * or closing the <code>EntityManager</code>, or handling transactions. 42 * 43 * <p>Note that JPA callback code will not flush any modifications to the 44 * database if not executed within a transaction. Thus, you need to make 45 * sure that JpaTransactionManager has initiated a JPA transaction when 46 * the callback gets called, at least if you want to write to the database. 47 * 48 * <p>Allows for returning a result object created within the callback, 49 * i.e. a domain object or a collection of domain objects. 50 * A thrown custom RuntimeException is treated as an application exception: 51 * It gets propagated to the caller of the template. 52 * 53 * @param em active EntityManager 54 * @return a result object, or <code>null</code> if none 55 * @throws PersistenceException if thrown by the JPA API 56 * @see org.springframework.orm.jpa.JpaTemplate#execute 57 * @see org.springframework.orm.jpa.JpaTemplate#executeFind 58 */ doInJpa(EntityManager em)59 T doInJpa(EntityManager em) throws PersistenceException; 60 61 } 62