1 |
51
|
jones
|
/**
|
2 |
203
|
jones
|
* '$RCSfile$'
|
3 |
|
|
* Purpose: A Class that implements utility methods for a metadata catalog
|
4 |
|
|
* Copyright: 2000 Regents of the University of California and the
|
5 |
|
|
* National Center for Ecological Analysis and Synthesis
|
6 |
309
|
bojilova
|
* Authors: Matt Jones, Jivka Bojilova
|
7 |
349
|
jones
|
* Release: @release@
|
8 |
51
|
jones
|
*
|
9 |
203
|
jones
|
* '$Author$'
|
10 |
|
|
* '$Date$'
|
11 |
|
|
* '$Revision$'
|
12 |
51
|
jones
|
*/
|
13 |
|
|
|
14 |
|
|
package edu.ucsb.nceas.metacat;
|
15 |
|
|
|
16 |
185
|
jones
|
import java.io.File;
|
17 |
|
|
import java.net.URL;
|
18 |
|
|
import java.net.MalformedURLException;
|
19 |
50
|
jones
|
import java.sql.Connection;
|
20 |
|
|
import java.sql.DriverManager;
|
21 |
|
|
import java.sql.SQLException;
|
22 |
184
|
jones
|
import java.util.PropertyResourceBundle;
|
23 |
309
|
bojilova
|
import java.util.Hashtable;
|
24 |
|
|
import java.util.Enumeration;
|
25 |
50
|
jones
|
|
26 |
|
|
/**
|
27 |
|
|
* A suite of utility classes for the metadata catalog server
|
28 |
|
|
*/
|
29 |
|
|
public class MetaCatUtil {
|
30 |
|
|
|
31 |
184
|
jones
|
private PropertyResourceBundle options = null;
|
32 |
354
|
berkley
|
private String propertiesFile = "edu.ucsb.nceas.metacat.metacat";
|
33 |
309
|
bojilova
|
private Hashtable connectionPool = new Hashtable();
|
34 |
203
|
jones
|
private static boolean debug = false;
|
35 |
109
|
bojilova
|
|
36 |
184
|
jones
|
/**
|
37 |
|
|
* Construct an instance of the utility class
|
38 |
|
|
*/
|
39 |
|
|
public MetaCatUtil() {
|
40 |
|
|
options = (PropertyResourceBundle)
|
41 |
|
|
PropertyResourceBundle.getBundle(propertiesFile);
|
42 |
|
|
}
|
43 |
354
|
berkley
|
|
44 |
|
|
/**
|
45 |
|
|
* This constructor allows the usage of a different properties file
|
46 |
|
|
* @param propFile the properties file that you wish to use.
|
47 |
|
|
*/
|
48 |
|
|
public MetaCatUtil(String propFile)
|
49 |
|
|
{
|
50 |
|
|
propertiesFile = propFile;
|
51 |
|
|
}
|
52 |
184
|
jones
|
|
53 |
50
|
jones
|
/**
|
54 |
184
|
jones
|
* Utility method to establish a JDBC database connection using connection
|
55 |
|
|
* info from the properties file
|
56 |
|
|
*/
|
57 |
|
|
public Connection openDBConnection()
|
58 |
|
|
throws SQLException, ClassNotFoundException {
|
59 |
|
|
return openDBConnection(getOption("dbDriver"), getOption("defaultDB"),
|
60 |
|
|
getOption("user"), getOption("password"));
|
61 |
|
|
}
|
62 |
|
|
|
63 |
|
|
/**
|
64 |
50
|
jones
|
* Utility method to establish a JDBC database connection
|
65 |
|
|
*
|
66 |
|
|
* @param dbDriver the string representing the database driver
|
67 |
|
|
* @param connection the string representing the database connectin parameters
|
68 |
|
|
* @param user name of the user to use for database connection
|
69 |
|
|
* @param password password for the user to use for database connection
|
70 |
|
|
*/
|
71 |
|
|
public static Connection openDBConnection(String dbDriver, String connection,
|
72 |
|
|
String user, String password)
|
73 |
|
|
throws SQLException, ClassNotFoundException {
|
74 |
|
|
|
75 |
|
|
// Load the Oracle JDBC driver
|
76 |
|
|
Class.forName (dbDriver);
|
77 |
|
|
|
78 |
329
|
jones
|
debugMessage("Opening connection: " + connection);
|
79 |
50
|
jones
|
// Connect to the database
|
80 |
|
|
Connection conn = DriverManager.getConnection( connection, user, password);
|
81 |
|
|
return conn;
|
82 |
|
|
}
|
83 |
184
|
jones
|
|
84 |
|
|
/**
|
85 |
|
|
* Utility method to get an option value from the properties file
|
86 |
|
|
*
|
87 |
|
|
* @param option_name the name of the option requested
|
88 |
|
|
*/
|
89 |
|
|
public String getOption(String option_name) {
|
90 |
|
|
// Get the configuration file information
|
91 |
|
|
if (options == null) {
|
92 |
|
|
options = (PropertyResourceBundle)
|
93 |
|
|
PropertyResourceBundle.getBundle(propertiesFile);
|
94 |
|
|
}
|
95 |
|
|
String value = (String)options.handleGetObject(option_name);
|
96 |
|
|
return value;
|
97 |
|
|
}
|
98 |
185
|
jones
|
|
99 |
309
|
bojilova
|
/* Utility method to create and return a pool of Connection objects */
|
100 |
|
|
public Hashtable getConnectionPool()
|
101 |
|
|
throws SQLException, ClassNotFoundException {
|
102 |
|
|
|
103 |
|
|
int initConn = (new Integer(getOption("initialConnections"))).intValue();
|
104 |
|
|
|
105 |
|
|
for ( int i = 0; i < initConn; i++ ) {
|
106 |
|
|
connectionPool.put( openDBConnection(), Boolean.FALSE );
|
107 |
|
|
}
|
108 |
|
|
|
109 |
|
|
return connectionPool;
|
110 |
|
|
}
|
111 |
|
|
|
112 |
|
|
/* Utility method to get a unused Connection object from the pool */
|
113 |
|
|
public Connection getConnection()
|
114 |
320
|
bojilova
|
throws SQLException, ClassNotFoundException, Exception {
|
115 |
309
|
bojilova
|
|
116 |
|
|
Connection conn = null;
|
117 |
|
|
Enumeration connections = connectionPool.keys();
|
118 |
|
|
|
119 |
|
|
synchronized (connectionPool) {
|
120 |
|
|
while (connections.hasMoreElements()) {
|
121 |
320
|
bojilova
|
|
122 |
309
|
bojilova
|
conn = (Connection)connections.nextElement();
|
123 |
|
|
Boolean b = (Boolean)connectionPool.get(conn);
|
124 |
320
|
bojilova
|
|
125 |
|
|
if (conn == null) {
|
126 |
|
|
// closed connection; replace it
|
127 |
|
|
conn = openDBConnection();
|
128 |
|
|
// update the pool to show this one taken
|
129 |
|
|
connectionPool.put(conn, Boolean.TRUE);
|
130 |
|
|
|
131 |
|
|
return conn;
|
132 |
|
|
} else if (b == Boolean.FALSE) {
|
133 |
309
|
bojilova
|
// unused connection; test if it works and get it
|
134 |
|
|
try {
|
135 |
|
|
conn.setAutoCommit(true);
|
136 |
|
|
} catch (SQLException e) {
|
137 |
|
|
// problem with the connection, replace it
|
138 |
|
|
conn = openDBConnection();
|
139 |
|
|
}
|
140 |
|
|
// update the pool to show this one taken
|
141 |
|
|
connectionPool.put(conn, Boolean.TRUE);
|
142 |
320
|
bojilova
|
|
143 |
309
|
bojilova
|
return conn;
|
144 |
|
|
}
|
145 |
|
|
}
|
146 |
320
|
bojilova
|
}
|
147 |
309
|
bojilova
|
|
148 |
|
|
// If we get here, there no free connections;
|
149 |
|
|
// we need to make more
|
150 |
|
|
int incConn = (new Integer(getOption("incrementConnections"))).intValue();
|
151 |
320
|
bojilova
|
int maxConn = (new Integer(getOption("maximumConnections"))).intValue();
|
152 |
|
|
int k = connectionPool.size();
|
153 |
|
|
if ( k >= maxConn ) {
|
154 |
|
|
throw new Exception("The maximum of " + maxConn +
|
155 |
|
|
" open db connections is reached." +
|
156 |
|
|
" New db connection to MetaCat" +
|
157 |
|
|
" cannot be established.");
|
158 |
|
|
}
|
159 |
|
|
|
160 |
|
|
// decide how many new connections to open; no more than the maximum
|
161 |
|
|
if ( incConn > maxConn - k ) { incConn = maxConn - k; }
|
162 |
|
|
|
163 |
|
|
// get them
|
164 |
309
|
bojilova
|
for ( int i = 0; i < incConn; i++ ) {
|
165 |
|
|
connectionPool.put( openDBConnection(), Boolean.FALSE );
|
166 |
|
|
}
|
167 |
320
|
bojilova
|
|
168 |
309
|
bojilova
|
// Recurse to get one of the new connections
|
169 |
|
|
return getConnection();
|
170 |
|
|
}
|
171 |
|
|
|
172 |
|
|
/* Utility method to give the connection back to the pool */
|
173 |
|
|
public void returnConnection (Connection returned) {
|
174 |
|
|
|
175 |
|
|
Connection conn;
|
176 |
|
|
Enumeration connections = connectionPool.keys();
|
177 |
|
|
|
178 |
320
|
bojilova
|
if (returned != null) {
|
179 |
|
|
while (connections.hasMoreElements()) {
|
180 |
309
|
bojilova
|
conn = (Connection)connections.nextElement();
|
181 |
|
|
if ( conn == returned ) {
|
182 |
|
|
connectionPool.put( conn, Boolean.FALSE );
|
183 |
|
|
break;
|
184 |
|
|
}
|
185 |
320
|
bojilova
|
}
|
186 |
|
|
}
|
187 |
309
|
bojilova
|
}
|
188 |
320
|
bojilova
|
|
189 |
|
|
/* Utility method to close all the connection from the pool */
|
190 |
|
|
public void closeConnections() {
|
191 |
|
|
|
192 |
|
|
Connection conn;
|
193 |
|
|
Enumeration connections = connectionPool.keys();
|
194 |
|
|
|
195 |
|
|
while (connections.hasMoreElements()) {
|
196 |
|
|
conn = (Connection)connections.nextElement();
|
197 |
|
|
if ( conn != null ) {
|
198 |
|
|
try {
|
199 |
|
|
conn.close();
|
200 |
|
|
} catch (SQLException e) {}
|
201 |
|
|
}
|
202 |
|
|
}
|
203 |
|
|
}
|
204 |
309
|
bojilova
|
|
205 |
|
|
|
206 |
185
|
jones
|
/** Utility method to convert a file handle into a URL */
|
207 |
|
|
public static URL fileToURL(File file)
|
208 |
|
|
{
|
209 |
|
|
String path = file.getAbsolutePath();
|
210 |
|
|
String fSep = System.getProperty("file.separator");
|
211 |
|
|
if (fSep != null && fSep.length() == 1)
|
212 |
|
|
path = path.replace(fSep.charAt(0), '/');
|
213 |
|
|
if (path.length() > 0 && path.charAt(0) != '/')
|
214 |
|
|
path = '/' + path;
|
215 |
|
|
try {
|
216 |
|
|
return new URL("file", null, path);
|
217 |
|
|
}
|
218 |
|
|
catch (java.net.MalformedURLException e) {
|
219 |
|
|
/* According to the spec this could only happen if the file
|
220 |
|
|
protocol were not recognized. */
|
221 |
|
|
throw new Error("unexpected MalformedURLException");
|
222 |
|
|
}
|
223 |
|
|
}
|
224 |
|
|
|
225 |
|
|
/**
|
226 |
|
|
* Utility method to print debugging messages
|
227 |
|
|
*
|
228 |
|
|
* @param flag an integer indicating the message number
|
229 |
|
|
*/
|
230 |
203
|
jones
|
public static void debugMessage(int flag) {
|
231 |
|
|
if (debug) {
|
232 |
|
|
System.err.println("DEBUG FLAG: " + flag);
|
233 |
|
|
}
|
234 |
185
|
jones
|
}
|
235 |
203
|
jones
|
|
236 |
|
|
/**
|
237 |
|
|
* Utility method to print debugging messages
|
238 |
|
|
*
|
239 |
|
|
* @param flag an integer indicating the message number
|
240 |
|
|
*/
|
241 |
|
|
public static void debugMessage(String msg) {
|
242 |
|
|
if (debug) {
|
243 |
|
|
System.err.println(msg);
|
244 |
|
|
}
|
245 |
|
|
}
|
246 |
50
|
jones
|
}
|
247 |
203
|
jones
|
|
248 |
|
|
/**
|
249 |
|
|
* '$Log$
|
250 |
354
|
berkley
|
* 'Revision 1.14 2000/08/14 20:53:34 jones
|
251 |
|
|
* 'Added "release" keyword to all metacat source files so that the release
|
252 |
|
|
* 'number will be evident in software distributions.
|
253 |
|
|
* '
|
254 |
349
|
jones
|
* 'Revision 1.13 2000/08/09 00:39:47 jones
|
255 |
|
|
* '-Reorganized xmltodb module to support new install process for the new
|
256 |
|
|
* 'linux server (dev.nceas.ucsb.edu). Added "build.sh" shell script that
|
257 |
|
|
* 'calls ant withthe proper umask set for installation. Use:
|
258 |
|
|
* '
|
259 |
|
|
* ' ./build.sh install
|
260 |
|
|
* '
|
261 |
|
|
* 'to post a new copy of the servlet and its supporting files to the install
|
262 |
|
|
* 'directory defined in build.xml.
|
263 |
|
|
* '
|
264 |
|
|
* '-Updated the servlet to use a new servlet prefix that we'll use with the
|
265 |
|
|
* 'Tomcat servlet engine.
|
266 |
|
|
* '
|
267 |
|
|
* '-Update bin dir shell scripts to reflect new locations of relevant jar files.
|
268 |
|
|
* '
|
269 |
329
|
jones
|
* 'Revision 1.12 2000/08/04 23:34:10 bojilova
|
270 |
|
|
* 'more precise handling of the Connection Pool
|
271 |
|
|
* '
|
272 |
320
|
bojilova
|
* 'Revision 1.11 2000/08/01 18:26:50 bojilova
|
273 |
|
|
* 'added Pool of Connections
|
274 |
|
|
* 'DBQuery, DBReader, DBTransform, DBUtil are created on every request and use the connections from the Pool
|
275 |
|
|
* 'same with DBWriter and DBValidate
|
276 |
|
|
* '
|
277 |
309
|
bojilova
|
* 'Revision 1.10 2000/06/26 10:35:05 jones
|
278 |
|
|
* 'Merged in substantial changes to DBWriter and associated classes and to
|
279 |
|
|
* 'the MetaCatServlet in order to accomodate the new UPDATE and DELETE
|
280 |
|
|
* 'functions. The command line tools and the parameters for the
|
281 |
|
|
* 'servlet have changed substantially.
|
282 |
|
|
* '
|
283 |
203
|
jones
|
* 'Revision 1.9.2.4 2000/06/26 00:51:06 jones
|
284 |
|
|
* 'If docid passed to DBWriter.write() is not unique, classes now generate
|
285 |
|
|
* 'an AccessionNumberException containing the new docid generated as a
|
286 |
|
|
* 'replacement. The docid is then extracted from the exception and
|
287 |
|
|
* 'returned to the calling application for user feedback or client processing.
|
288 |
|
|
* '
|
289 |
|
|
* 'Revision 1.9.2.3 2000/06/25 23:38:17 jones
|
290 |
|
|
* 'Added RCSfile keyword
|
291 |
|
|
* '
|
292 |
|
|
* 'Revision 1.9.2.2 2000/06/25 23:34:18 jones
|
293 |
|
|
* 'Changed documentation formatting, added log entries at bottom of source files
|
294 |
|
|
* ''
|
295 |
|
|
*/
|