From e6a52064b983a4152dbfb75b1597efed46d02e2d Mon Sep 17 00:00:00 2001 From: Stefan Bodewig Date: Wed, 27 Sep 2000 07:42:23 +0000 Subject: [PATCH] Allow the driver for to be loaded from a different CLASSPATH. Submitted by: Julian M. Savage git-svn-id: https://svn.apache.org/repos/asf/ant/core/trunk@268039 13f79535-47bb-0310-9956-ffa450edef68 --- docs/sql.html | 40 ++++++- .../org/apache/tools/ant/AntClassLoader.java | 4 + .../apache/tools/ant/taskdefs/SQLExec.java | 111 +++++++++++++----- .../apache/tools/ant/taskdefs/Taskdef.java | 7 +- 4 files changed, 128 insertions(+), 34 deletions(-) diff --git a/docs/sql.html b/docs/sql.html index 34fefc376..9f150c0ee 100644 --- a/docs/sql.html +++ b/docs/sql.html @@ -47,6 +47,26 @@ Auto commit flag for database connection (default false) No, default "false" + + print + Print result sets from the statements (default false) + No, default "false" + + + showheaders + Print headers for result sets from the statements (default true) + No, default "true" + + + output + Output file for result sets (defaults to System.out) + No (print to System.out by default) + + + classpath + Classpath used to load driver + No (use system classpath) +

Examples

@@ -80,7 +100,7 @@ truncate table some_other_table;

Note that you may want to enclose your statements in <![CDATA[ ... ]]> sections so you don't need to escape <, > & -or other special characters. For exampe:

+or other special characters. For example:

<sql
     driver="org.database.jdbcDriver"
@@ -94,6 +114,24 @@ update some_table set column1 = column1 + 1 where column2 < 42;
 ]]></sql>
+

The following connects to the database given in url as the sa user using the org.database.jdbcDriver and executes the sql statements contained within the file data.sql, with output piped to outputfile.txt, searching /some/jdbc.jar as well as the system classpath for the driver class.

+ +
<sql
+    driver="org.database.jdbcDriver"
+    url="jdbc:database-url"
+    userid="sa"
+    password="pass"
+    src="data.sql"
+    print="yes"
+    output="outputfile.txt"
+    >
+<classpath>
+	<pathelement location="/some/jdbc.jar">
+</classpath>
+</sql>
+
+ + diff --git a/src/main/org/apache/tools/ant/AntClassLoader.java b/src/main/org/apache/tools/ant/AntClassLoader.java index 99a4b0fc7..1469ecbf2 100644 --- a/src/main/org/apache/tools/ant/AntClassLoader.java +++ b/src/main/org/apache/tools/ant/AntClassLoader.java @@ -110,6 +110,10 @@ public class AntClassLoader extends ClassLoader { public AntClassLoader(Project project, Path classpath) { this.project = project; this.classpath = classpath; + if (project.getJavaVersion().startsWith("1.1")) { + // JDK > 1.1 adds these by default + addSystemPackageRoot("java"); + } } /** diff --git a/src/main/org/apache/tools/ant/taskdefs/SQLExec.java b/src/main/org/apache/tools/ant/taskdefs/SQLExec.java index 6217209a1..828a9c682 100644 --- a/src/main/org/apache/tools/ant/taskdefs/SQLExec.java +++ b/src/main/org/apache/tools/ant/taskdefs/SQLExec.java @@ -55,11 +55,13 @@ package org.apache.tools.ant.taskdefs; import org.apache.tools.ant.*; +import org.apache.tools.ant.types.*; import java.io.*; import java.util.Enumeration; import java.util.StringTokenizer; import java.util.Vector; +import java.util.Properties; import java.util.zip.*; import java.sql.*; @@ -71,6 +73,10 @@ import java.sql.*; * @author Jeff Martin */ public class SQLExec extends Task { + + private Path classpath; + + private AntClassLoader loader; /** * Database connection @@ -131,6 +137,34 @@ public class SQLExec extends Task { * Results Output file. */ private File output = null; + + /** + * Set the classpath for loading the driver. + */ + public void setClasspath(Path classpath) { + if (this.classpath == null) { + this.classpath = classpath; + } else { + this.classpath.append(classpath); + } + } + + /** + * Create the classpath for loading the driver. + */ + public Path createClasspath() { + if (this.classpath == null) { + this.classpath = new Path(project); + } + return this.classpath.createPath(); + } + + /** + * Set the classpath for loading the driver using the classpath reference. + */ + public void setClasspathRef(Reference r) { + createClasspath().setRefid(r); + } /** * Set the name of the sql file to be run. @@ -185,28 +219,27 @@ public class SQLExec extends Task { * Set the print flag. */ public void setPrint(boolean print) { - this.print = print; + this.print = print; } /** * Set the showheaders flag. */ public void setShowheaders(boolean showheaders) { - this.showheaders = showheaders; + this.showheaders = showheaders; } /** * Set the output file. */ public void setOutput(File output) { - this.output = output; + this.output = output; } - + /** * Load the sql file and then execute it */ public void execute() throws BuildException { - sqlCommand = sqlCommand.trim(); if (srcFile == null && sqlCommand.length() == 0) { @@ -227,16 +260,34 @@ public class SQLExec extends Task { if (srcFile != null && !srcFile.exists()) { throw new BuildException("Source file does not exist!", location); } - - try{ - Class.forName(driver); + Driver driverInstance = null; + // Load the driver using the + try { + Class dc; + if (classpath != null) { + log("Loading " + driver + " using AntClassLoader with classpath " + classpath, Project.MSG_VERBOSE); + loader = new AntClassLoader(project, classpath, false); + dc = loader.loadClass(driver); + } + else { + log("Loading " + driver + " using system loader.", Project.MSG_VERBOSE); + dc = Class.forName(driver); + } + driverInstance = (Driver) dc.newInstance(); }catch(ClassNotFoundException e){ - throw new BuildException("JDBC driver " + driver + " could not be loaded", location); + throw new BuildException("Class Not Found: JDBC driver " + driver + " could not be loaded", location); + }catch(IllegalAccessException e){ + throw new BuildException("Illegal Access: JDBC driver " + driver + " could not be loaded", location); + }catch(InstantiationException e) { + throw new BuildException("Instantiation Exception: JDBC driver " + driver + " could not be loaded", location); } try{ log("connecting to " + url, Project.MSG_VERBOSE ); - conn = DriverManager.getConnection(url, userId, password); + Properties info = new Properties(); + info.put("user", userId); + info.put("password", password); + conn = driverInstance.connect(url, info); conn.setAutoCommit(autocommit); @@ -288,9 +339,9 @@ public class SQLExec extends Task { String sql = ""; String line = ""; - BufferedReader in = new BufferedReader(reader); + BufferedReader in = new BufferedReader(reader); - try{ + try{ while ((line=in.readLine()) != null){ if (line.trim().startsWith("//")) continue; if (line.trim().startsWith("--")) continue; @@ -304,15 +355,16 @@ public class SQLExec extends Task { } } - // Catch any statements not followed by ; - if(!sql.equals("")){ - execSQL(sql); - } - }catch(SQLException e){ + // Catch any statements not followed by ; + if(!sql.equals("")){ + execSQL(sql); + } + }catch(SQLException e){ log("Failed to execute: " + sql, Project.MSG_ERR); - throw e; - } - } + throw e; + } + + } /** @@ -324,9 +376,9 @@ public class SQLExec extends Task { Project.MSG_VERBOSE); } - if (print) { - printResults(); - } + if (print) { + printResults(); + } SQLWarning warning = conn.getWarnings(); while(warning!=null){ @@ -344,13 +396,15 @@ public class SQLExec extends Task { PrintStream out = System.out; try { if (output != null) { - out = new PrintStream(new BufferedOutputStream(new FileOutputStream(output))); + log("Opening PrintStream to output file " + output, Project.MSG_VERBOSE); + out = new PrintStream(new BufferedOutputStream(new FileOutputStream(output))); } while ((rs = statement.getResultSet()) != null) { + log("Processing new result set.", Project.MSG_VERBOSE); ResultSetMetaData md = rs.getMetaData(); int columnCount = md.getColumnCount(); StringBuffer line = new StringBuffer(); - if (showheaders) { + if (showheaders) { for (int col = 1; col < columnCount; col++) { line.append(md.getColumnName(col)); line.append(","); @@ -358,7 +412,7 @@ public class SQLExec extends Task { line.append(md.getColumnName(columnCount)); out.println(line); line.setLength(0); - } + } while (rs.next()) { for (int col = 1; col < columnCount; col++) { line.append(rs.getString(col).trim()); @@ -374,11 +428,10 @@ public class SQLExec extends Task { catch (IOException ioe) { throw new BuildException("Error writing " + output.getAbsolutePath(), ioe, location); } - finally { - if (out != null) { + finally { + if (out != null && out != System.out) { out.close(); } } } - } diff --git a/src/main/org/apache/tools/ant/taskdefs/Taskdef.java b/src/main/org/apache/tools/ant/taskdefs/Taskdef.java index 1c0b51ce8..fcb5bb7de 100644 --- a/src/main/org/apache/tools/ant/taskdefs/Taskdef.java +++ b/src/main/org/apache/tools/ant/taskdefs/Taskdef.java @@ -97,11 +97,10 @@ public class Taskdef extends Task { if (classpath != null) { AntClassLoader al = new AntClassLoader(project, classpath, false); + // need to load Task via system classloader or the new + // task we want to define will never be a Task but always + // be wrapped into a TaskAdapter. al.addSystemPackageRoot("org.apache.tools.ant"); - if (project.getJavaVersion().startsWith("1.1")) { - // JDK > 1.1 adds these by default - al.addSystemPackageRoot("java"); - } loader = al; } else { loader = this.getClass().getClassLoader();