1 /*
2 * The Apache Software License, Version 1.1
3 *
4 * Copyright (c) 1999 The Apache Software Foundation. All rights
5 * reserved.
6 *
7 * Redistribution and use in source and binary forms, with or without
8 * modification, are permitted provided that the following conditions
9 * are met:
10 *
11 * 1. Redistributions of source code must retain the above copyright
12 * notice, this list of conditions and the following disclaimer.
13 *
14 * 2. Redistributions in binary form must reproduce the above copyright
15 * notice, this list of conditions and the following disclaimer in
16 * the documentation and/or other materials provided with the
17 * distribution.
18 *
19 * 3. The end-user documentation included with the redistribution, if
20 * any, must include the following acknowlegement:
21 * "This product includes software developed by the
22 * Apache Software Foundation (http://www.apache.org/)."
23 * Alternately, this acknowlegement may appear in the software itself,
24 * if and wherever such third-party acknowlegements normally appear.
25 *
26 * 4. The names "The Jakarta Project", "Tomcat", and "Apache Software
27 * Foundation" must not be used to endorse or promote products derived
28 * from this software without prior written permission. For written
29 * permission, please contact apache@apache.org.
30 *
31 * 5. Products derived from this software may not be called "Apache"
32 * nor may "Apache" appear in their names without prior written
33 * permission of the Apache Group.
34 *
35 * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
36 * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
37 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
38 * DISCLAIMED. IN NO EVENT SHALL THE APACHE SOFTWARE FOUNDATION OR
39 * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
40 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
41 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
42 * USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
43 * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
44 * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
45 * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
46 * SUCH DAMAGE.
47 * ====================================================================
48 *
49 * This software consists of voluntary contributions made by many
50 * individuals on behalf of the Apache Software Foundation. For more
51 * information on the Apache Software Foundation, please see
52 * <http://www.apache.org/>.
53 *
54 */
55
56 package org.apache.commons.jelly.tags.sql;
57
58 import java.sql.*;
59 import java.util.*;
60 import javax.sql.DataSource;
61 import javax.naming.InitialContext;
62 import javax.naming.Context;
63 import javax.naming.NamingException;
64 import javax.servlet.jsp.jstl.sql.SQLExecutionTag;
65
66 import org.apache.commons.jelly.JellyContext;
67 import org.apache.commons.jelly.JellyException;
68 import org.apache.commons.jelly.TagSupport;
69 import org.apache.commons.jelly.XMLOutput;
70 import org.apache.commons.jelly.tags.Resources;
71
72 /***
73 * <p>Abstract base class for any SQL related tag in JSTL.
74 *
75 * @author Hans Bergsten
76 * @author Justyna Horwat
77 * @author <a href="mailto:jstrachan@apache.org">James Strachan</a>
78 */
79
80 public abstract class SqlTagSupport extends TagSupport implements SQLExecutionTag {
81
82 protected String var;
83 protected String scope = "page";
84
85 /*
86 * The following properties take expression values, so the
87 * setter methods are implemented by the expression type
88 * specific subclasses.
89 */
90 protected Object rawDataSource;
91 protected boolean dataSourceSpecified;
92 protected String sql;
93
94 /*
95 * Instance variables that are not for attributes
96 */
97 private List parameters;
98 protected boolean isPartOfTransaction;
99
100 //**********************************************************************
101 // Constructor and initialization
102
103 public SqlTagSupport() {
104 }
105
106 //*********************************************************************
107 // Accessor methods
108
109 /**
110 * Sets the name of the variable to hold the
111 * result.
112 */
113 public void setVar(String var) {
114 this.var = var;
115 }
116
117 /***
118 * Sets the scope of the variable to hold the
119 * result.
120 */
121 public void setScope(String scopeName) {
122 this.scope = scopeName;
123 }
124
125 /***
126 * Sets the SQL DataSource. DataSource can be
127 * a String or a DataSource object.
128 */
129 public void setDataSource(Object dataSource) {
130 this.rawDataSource = dataSource;
131 this.dataSourceSpecified = true;
132 }
133
134 /***
135 * Sets the SQL statement to use for the
136 * query. The statement may contain parameter markers
137 * (question marks, ?). If so, the parameter values must
138 * be set using nested value elements.
139 */
140 public void setSql(String sql) {
141 this.sql = sql;
142 }
143
144
145 //**********************************************************************
146 // Public utility methods
147
148 /**
149 * Called by nested parameter elements to add PreparedStatement
150 * parameter values.
151 */
152 public void addSQLParameter(Object o) {
153 if (parameters == null) {
154 parameters = new ArrayList();
155 }
156 parameters.add(o);
157 }
158
159 //**********************************************************************
160 // Protected utility methods
161
162 /**
163 * @return true if there are SQL parameters
164 */
165 protected boolean hasParameters() {
166 return parameters != null && parameters.size() > 0;
167 }
168
169 protected void clearParameters() {
170 parameters = null;
171 }
172
173 protected Connection getConnection() throws JellyException, SQLException {
174 // Fix: Add all other mechanisms
175 Connection conn = null;
176 isPartOfTransaction = false;
177
178 TransactionTag parent =
179 (TransactionTag) findAncestorWithClass(TransactionTag.class);
180 if (parent != null) {
181 if (dataSourceSpecified) {
182 throw new JellyException(Resources.getMessage("ERROR_NESTED_DATASOURCE"));
183 }
184 conn = parent.getSharedConnection();
185 isPartOfTransaction = true;
186 }
187 else {
188 if ((rawDataSource == null) && dataSourceSpecified) {
189 throw new JellyException(Resources.getMessage("SQL_DATASOURCE_NULL"));
190 }
191 DataSource dataSource = DataSourceUtil.getDataSource(rawDataSource, context);
192 try {
193 conn = dataSource.getConnection();
194 }
195 catch (Exception ex) {
196 throw new JellyException(
197 Resources.getMessage("DATASOURCE_INVALID", ex.getMessage()));
198 }
199 }
200
201 return conn;
202 }
203
204 protected void setParameters(PreparedStatement ps)
205 throws SQLException {
206 if (parameters != null) {
207 for (int i = 0; i < parameters.size(); i++) {
208 // The first parameter has index 1
209 ps.setObject(i + 1, parameters.get(i));
210 }
211 }
212 }
213 }
This page was automatically generated by Maven