javax.servlet.jsp.jstl.sql.SQLExecutionTag Maven / Gradle / Ivy
Show all versions of jakarta.servlet.jsp.jstl-api Show documentation
/*
* Copyright (c) 1997, 2018 Oracle and/or its affiliates. All rights reserved.
* Copyright 2004 The Apache Software Foundation
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package javax.servlet.jsp.jstl.sql;
/**
* This interface allows tag handlers implementing it to receive
* values for parameter markers in their SQL statements.
*
* This interface is implemented by both <sql:query> and
* <sql:update>. Its addSQLParameter() method
* is called by nested parameter actions (such as <sql:param>)
* to substitute PreparedStatement parameter values for
* "?" parameter markers in the SQL statement of the enclosing
* SQLExecutionTag action.
*
* The given parameter values are converted to their corresponding
* SQL type (following the rules in the JDBC specification) before
* they are sent to the database.
*
* Keeping track of the index of the parameter values being added
* is the responsibility of the tag handler implementing this
* interface
*
* The SQLExcecutionTag interface is exposed in order
* to support custom parameter actions which may retrieve their
* parameters from any source and process them before substituting
* them for a parameter marker in the SQL statement of the
* enclosing SQLExecutionTag action
*
* @author Justyna Horwat
*/
public interface SQLExecutionTag {
/**
* Adds a PreparedStatement parameter value.
* Must behave as if it calls PreparedStatement.setObject(int, Object).
* For each tag invocation, the integral index passed logically to setObject()
* must begin with 1 and must be incremented by 1 for each subsequent invocation
* of addSQLParameter(). The Object logically passed to setObject() must be the
* unmodified object received in the value argument.
*
* @param value the PreparedStatement parameter value
*/
public void addSQLParameter(Object value);
}