001/* 002 * Copyright 2002-2016 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.SQLException; 020import java.sql.Statement; 021 022import org.springframework.dao.DataAccessException; 023 024/** 025 * Generic callback interface for code that operates on a JDBC Statement. 026 * Allows to execute any number of operations on a single Statement, 027 * for example a single {@code executeUpdate} call or repeated 028 * {@code executeUpdate} calls with varying SQL. 029 * 030 * <p>Used internally by JdbcTemplate, but also useful for application code. 031 * 032 * @author Juergen Hoeller 033 * @since 16.03.2004 034 * @see JdbcTemplate#execute(StatementCallback) 035 */ 036public interface StatementCallback<T> { 037 038 /** 039 * Gets called by {@code JdbcTemplate.execute} with an active JDBC 040 * Statement. Does not need to care about closing the Statement or the 041 * Connection, or about handling transactions: this will all be handled 042 * by Spring's JdbcTemplate. 043 * <p><b>NOTE:</b> Any ResultSets opened should be closed in finally blocks 044 * within the callback implementation. Spring will close the Statement 045 * object after the callback returned, but this does not necessarily imply 046 * that the ResultSet resources will be closed: the Statement objects might 047 * get pooled by the connection pool, with {@code close} calls only 048 * returning the object to the pool but not physically closing the resources. 049 * <p>If called without a thread-bound JDBC transaction (initiated by 050 * DataSourceTransactionManager), the code will simply get executed on the 051 * JDBC connection with its transactional semantics. If JdbcTemplate is 052 * configured to use a JTA-aware DataSource, the JDBC connection and thus 053 * the callback code will be transactional if a JTA transaction is active. 054 * <p>Allows for returning a result object created within the callback, i.e. 055 * a domain object or a collection of domain objects. Note that there's 056 * special support for single step actions: see JdbcTemplate.queryForObject etc. 057 * A thrown RuntimeException is treated as application exception, it gets 058 * propagated to the caller of the template. 059 * @param stmt active JDBC Statement 060 * @return a result object, or {@code null} if none 061 * @throws SQLException if thrown by a JDBC method, to be auto-converted 062 * to a DataAccessException by a SQLExceptionTranslator 063 * @throws DataAccessException in case of custom exceptions 064 * @see JdbcTemplate#queryForObject(String, Class) 065 * @see JdbcTemplate#queryForRowSet(String) 066 */ 067 T doInStatement(Statement stmt) throws SQLException, DataAccessException; 068 069}