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.Connection;
021import java.sql.SQLException;
022
023/**
024 * One of the three central callback interfaces used by the JdbcTemplate class.
025 * This interface creates a CallableStatement given a connection, provided
026 * by the JdbcTemplate class. Implementations are responsible for providing
027 * SQL and any necessary parameters.
028 *
029 * <p>Implementations <i>do not</i> need to concern themselves with
030 * SQLExceptions that may be thrown from operations they attempt.
031 * The JdbcTemplate class will catch and handle SQLExceptions appropriately.
032 *
033 * <p>A PreparedStatementCreator should also implement the SqlProvider interface
034 * if it is able to provide the SQL it uses for PreparedStatement creation.
035 * This allows for better contextual information in case of exceptions.
036 *
037 * @author Rod Johnson
038 * @author Thomas Risberg
039 * @see JdbcTemplate#execute(CallableStatementCreator, CallableStatementCallback)
040 * @see JdbcTemplate#call
041 * @see SqlProvider
042 */
043public interface CallableStatementCreator {
044
045        /**
046         * Create a callable statement in this connection. Allows implementations to use
047         * CallableStatements.
048         * @param con Connection to use to create statement
049         * @return a callable statement
050         * @throws SQLException there is no need to catch SQLExceptions
051         * that may be thrown in the implementation of this method.
052         * The JdbcTemplate class will handle them.
053         */
054        CallableStatement createCallableStatement(Connection con) throws SQLException;
055
056}