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