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.jdbc.core; 018 019import java.sql.CallableStatement; 020import java.sql.SQLException; 021 022import org.springframework.dao.DataAccessException; 023 024/** 025 * Generic callback interface for code that operates on a CallableStatement. 026 * Allows to execute any number of operations on a single CallableStatement, 027 * for example a single execute call or repeated execute calls with varying 028 * parameters. 029 * 030 * <p>Used internally by JdbcTemplate, but also useful for application code. 031 * Note that the passed-in CallableStatement can have been created by the 032 * framework or by a custom CallableStatementCreator. However, the latter is 033 * hardly ever necessary, as most custom callback actions will perform updates 034 * in which case a standard CallableStatement is fine. Custom actions will 035 * always set parameter values themselves, so that CallableStatementCreator 036 * capability is not needed either. 037 * 038 * @author Juergen Hoeller 039 * @since 16.03.2004 040 * @see JdbcTemplate#execute(String, CallableStatementCallback) 041 * @see JdbcTemplate#execute(CallableStatementCreator, CallableStatementCallback) 042 */ 043public interface CallableStatementCallback<T> { 044 045 /** 046 * Gets called by {@code JdbcTemplate.execute} with an active JDBC 047 * CallableStatement. Does not need to care about closing the Statement 048 * or the Connection, or about handling transactions: this will all be 049 * handled by Spring's JdbcTemplate. 050 * 051 * <p><b>NOTE:</b> Any ResultSets opened should be closed in finally blocks 052 * within the callback implementation. Spring will close the Statement 053 * object after the callback returned, but this does not necessarily imply 054 * that the ResultSet resources will be closed: the Statement objects might 055 * get pooled by the connection pool, with {@code close} calls only 056 * returning the object to the pool but not physically closing the resources. 057 * 058 * <p>If called without a thread-bound JDBC transaction (initiated by 059 * DataSourceTransactionManager), the code will simply get executed on the 060 * JDBC connection with its transactional semantics. If JdbcTemplate is 061 * configured to use a JTA-aware DataSource, the JDBC connection and thus 062 * the callback code will be transactional if a JTA transaction is active. 063 * 064 * <p>Allows for returning a result object created within the callback, i.e. 065 * a domain object or a collection of domain objects. A thrown RuntimeException 066 * is treated as application exception: it gets propagated to the caller of 067 * the template. 068 * 069 * @param cs active JDBC CallableStatement 070 * @return a result object, or {@code null} if none 071 * @throws SQLException if thrown by a JDBC method, to be auto-converted 072 * into a DataAccessException by a SQLExceptionTranslator 073 * @throws DataAccessException in case of custom exceptions 074 */ 075 T doInCallableStatement(CallableStatement cs) throws SQLException, DataAccessException; 076 077}