Project

General

Profile

1 4951 daigle
/**
2
 *  '$RCSfile$'
3
 *    Purpose: A Class that manages database access of scheduled task
4
 *             information.
5
 *  Copyright: 2009 Regents of the University of California and the
6
 *             National Center for Ecological Analysis and Synthesis
7
 *    Authors: Michael Daigle
8
 *
9
 *   '$Author: daigle $'
10
 *     '$Date: 2009-03-23 13:56:56 -0800 (Mon, 23 Mar 2009) $'
11
 * '$Revision: 4854 $'
12
 *
13
 * This program is free software; you can redistribute it and/or modify
14
 * it under the terms of the GNU General Public License as published by
15
 * the Free Software Foundation; either version 2 of the License, or
16
 * (at your option) any later version.
17
 *
18
 * This program is distributed in the hope that it will be useful,
19
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
20
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
21
 * GNU General Public License for more details.
22
 *
23
 * You should have received a copy of the GNU General Public License
24
 * along with this program; if not, write to the Free Software
25
 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
26
 */
27
28
package edu.ucsb.nceas.metacat.scheduler;
29
30
import java.sql.PreparedStatement;
31
import java.sql.ResultSet;
32
import java.sql.SQLException;
33
import java.sql.Timestamp;
34
import java.util.Calendar;
35 4959 daigle
import java.util.HashMap;
36
import java.util.Vector;
37 4951 daigle
38
import org.apache.log4j.Logger;
39
import org.quartz.Job;
40
41 5015 daigle
import edu.ucsb.nceas.metacat.database.DBConnectionPool;
42
import edu.ucsb.nceas.metacat.shared.AccessException;
43
import edu.ucsb.nceas.metacat.shared.BaseAccess;
44 4959 daigle
import edu.ucsb.nceas.utilities.StatusUtil;
45 4951 daigle
46
public class ScheduledJobAccess extends BaseAccess {
47
48
	private Logger logMetacat = Logger.getLogger(ScheduledJobAccess.class);
49
50 4971 daigle
	// Constructor
51 4951 daigle
	public ScheduledJobAccess() throws AccessException {
52
		super("ScheduledJobAccess");
53
	}
54
55 4971 daigle
	/**
56
	 * Get a job based on it's id
57
	 *
58
	 * @param jobId
59
	 *            the id of the job in the database
60
	 * @return the scheduled job data object that represents the desired job
61
	 */
62 4959 daigle
	public ScheduledJobDAO getJob(Long jobId) throws AccessException {
63
		ScheduledJobDAO jobDAO = null;
64
65 4971 daigle
		// first get the job from the db and put it into a DAO
66 4959 daigle
		PreparedStatement pstmt = null;
67
		try {
68
			String sql = "SELECT * FROM scheduled_job WHERE id = ? AND status != 'deleted'";
69
			pstmt = conn.prepareStatement(sql);
70
71
			pstmt.setLong(1, jobId);
72
73
			logMetacat.info("SQL getJobByName - " + sql);
74
			logMetacat.info("SQL params: [" + jobId + "]");
75
76
			pstmt.execute();
77
78
			ResultSet resultSet = pstmt.getResultSet();
79
			if (resultSet.next()) {
80
				jobDAO = populateDAO(resultSet);
81
			}
82
83
		} catch (SQLException sqle) {
84
			throw new AccessException("ScheduledJobAccess.getJob - SQL error when getting scheduled job: "
85
					+ jobId  + " : "  + sqle.getMessage());
86
		} finally {
87
			try {
88
				if (pstmt != null) {
89
					pstmt.close();
90
				}
91
			} catch (SQLException sqle) {
92
				logMetacat.error("ScheduledJobAccess.getJobByName - An error occurred "
93
						+ "closing prepared statement: " + sqle.getMessage());
94
			}
95
		}
96
97 4971 daigle
		// Now get all the job parameters and put those into a list of job parameter
98
		// DAOs and add that list to the job DAO
99 4959 daigle
		ScheduledJobParamAccess jobParamAccess = new ScheduledJobParamAccess();
100
		Vector<ScheduledJobParamDAO> jobParamList =
101
			jobParamAccess.getJobParamsForJobId(jobDAO.getId());
102
103
		for(ScheduledJobParamDAO jobParamDAO : jobParamList) {
104
			jobDAO.addJobParam(jobParamDAO);
105
		}
106
107
		return jobDAO;
108
	}
109
110 4971 daigle
	/**
111
	 * Get a job by it's name
112
	 * @param jobName the name of the job to get
113
	 * @return the scheduled job data object that represents the desired job
114
	 */
115 4951 daigle
	public ScheduledJobDAO getJobByName(String jobName) throws AccessException {
116
		ScheduledJobDAO jobDAO = null;
117
118 4971 daigle
		// first get the job from the db and put it into a DAO
119 4959 daigle
		PreparedStatement pstmt = null;
120 4951 daigle
		try {
121 4967 daigle
			String sql = "SELECT * FROM scheduled_job WHERE name = ? AND status != 'deleted'";
122 4959 daigle
			pstmt = conn.prepareStatement(sql);
123 4951 daigle
124
			pstmt.setString(1, jobName);
125
126
			logMetacat.info("SQL getJobByName - " + sql);
127
			logMetacat.info("SQL params: [" + jobName + "]");
128
129
			pstmt.execute();
130
131
			ResultSet resultSet = pstmt.getResultSet();
132 4959 daigle
			if (resultSet.next()) {
133
				jobDAO = populateDAO(resultSet);
134 5027 daigle
			} else {
135
				throw new AccessException("ScheduledJobAccess.getJobByName - could not find scheduled job with name: "
136
						+ jobName);
137 4951 daigle
			}
138
139
		} catch (SQLException sqle) {
140
			throw new AccessException("ScheduledJobAccess.getJobByName - SQL error when getting scheduled job by name: "
141
					+ jobName  + " : "  + sqle.getMessage());
142 4959 daigle
		} finally {
143
			try {
144
				if (pstmt != null) {
145
					pstmt.close();
146
				}
147
			} catch (SQLException sqle) {
148
				logMetacat.error("ScheduledJobAccess.getJobByName - An error occurred "
149
						+ "closing prepared statement: " + sqle.getMessage());
150
			}
151 4951 daigle
		}
152
153 4971 daigle
		// Now get all the job parameters and put those into a list of job parameter
154
		// DAOs and add that list to the job DAO
155 4959 daigle
		ScheduledJobParamAccess jobParamAccess = new ScheduledJobParamAccess();
156
		Vector<ScheduledJobParamDAO> jobParamList =
157
			jobParamAccess.getJobParamsForJobId(jobDAO.getId());
158
159
		for(ScheduledJobParamDAO jobParamDAO : jobParamList) {
160
			jobDAO.addJobParam(jobParamDAO);
161
		}
162
163 4951 daigle
		return jobDAO;
164
	}
165
166 4971 daigle
	/**
167
	 * Get all jobs that have a given parameter with a given value
168
	 *
169
	 * @param groupName
170
	 *            the group to which the job belongs. This keeps us from
171
	 *            returning unrelated jobs that just happen to have a similar
172
	 *            parameter
173
	 * @param paramName
174
	 *            the name of the parameter we are looking for
175
	 * @param paramValue
176
	 *            the value of the parameter we are looking for
177
	 * @return a HashMap of job data objects with all jobs in a given group that
178
	 *         have parameters that match our parameter.
179
	 */
180 4967 daigle
	public HashMap<Long, ScheduledJobDAO> getJobsWithParameter(String groupName, String paramName, String paramValue) throws AccessException {
181
182 4971 daigle
		// first get all jobs
183 4967 daigle
		HashMap<Long, ScheduledJobDAO> allJobsMap = getAllJobs(groupName);
184
		HashMap<Long, ScheduledJobDAO> jobsWithParamMap = new HashMap<Long, ScheduledJobDAO>();
185
186 4971 daigle
		// then iterate through and grab the ones that have the desired parameter
187 4967 daigle
		for (Long jobDAOId : allJobsMap.keySet()) {
188
			ScheduledJobDAO jobDAO = allJobsMap.get(jobDAOId);
189
			if (paramValue != null && paramName != null) {
190
				ScheduledJobParamDAO jobParamDAO = jobDAO.getJobParam(paramName);
191
				if(jobParamDAO != null && jobParamDAO.getValue().equals(paramValue)) {
192
					jobsWithParamMap.put(jobDAOId, jobDAO);
193
				}
194
			}
195
		}
196
197
		return jobsWithParamMap;
198
	}
199
200 4971 daigle
	/**
201
	 * Get all jobs for a given group.  A group is typically a category that coincides with
202
	 * the job type (has it's own job implementation).
203
	 * @param groupName the name of the group we want to search
204
	 * @return a HashMap of job data objects for the desired group.
205
	 */
206 4959 daigle
	public HashMap<Long, ScheduledJobDAO> getAllJobs(String groupName) throws AccessException {
207
		ScheduledJobDAO jobDAO = null;
208
209
		HashMap<Long, ScheduledJobDAO> allJobDAOs = new HashMap<Long, ScheduledJobDAO>();
210
211 4971 daigle
		// Get all jobs where the status is not deleted
212 4959 daigle
		PreparedStatement pstmt = null;
213
		try {
214
			String sql = "SELECT * FROM scheduled_job WHERE status != 'deleted'";
215
			if (groupName != null) {
216
				sql += " AND group_name = ?" ;
217
			}
218
			pstmt = conn.prepareStatement(sql);
219
220 5012 daigle
			String sqlReport = "ScheduledJobAccess.getAllJobs - SQL: " + sql;
221 4959 daigle
			if (groupName != null) {
222
				pstmt.setString(1, groupName);
223
224 5012 daigle
				sqlReport += " [" + groupName + "]";
225 4959 daigle
			}
226 5012 daigle
227
			logMetacat.info(sqlReport);
228 4959 daigle
229
			pstmt.execute();
230
231
			ResultSet resultSet = pstmt.getResultSet();
232
			while (resultSet.next()) {
233
				jobDAO = populateDAO(resultSet);
234
235
				allJobDAOs.put(jobDAO.getId(), jobDAO);
236
			}
237
238 4971 daigle
			// Here we grab all job params and put them into the associated jobs.  THis
239
			// takes a little stress off the database by avoiding a join.
240 4959 daigle
			ScheduledJobParamAccess jobParamAccess = new ScheduledJobParamAccess();
241
			Vector<ScheduledJobParamDAO> jobParamList =
242
				jobParamAccess.getAllJobParams();
243
244 4986 daigle
			for(ScheduledJobParamDAO jobParamDAO : jobParamList) {
245 4959 daigle
				Long jobId = jobParamDAO.getJobId();
246
				if( allJobDAOs.containsKey(jobId)) {
247
					allJobDAOs.get(jobId).addJobParam(jobParamDAO);
248
				}
249
			}
250
251
			return allJobDAOs;
252
253
		} catch (SQLException sqle) {
254
			throw new AccessException("ScheduledJobAccess.getJobByName - SQL error when getting all jobs : "
255
					+ sqle.getMessage());
256
		} finally {
257
			try {
258
				if (pstmt != null) {
259
					pstmt.close();
260
				}
261
			} catch (SQLException sqle) {
262
				logMetacat.error("ScheduledJobAccess.getJobByName - An error occurred "
263
						+ "closing prepared statement: " + sqle.getMessage());
264
			} finally {
265
				DBConnectionPool.returnDBConnection(conn, serialNumber);
266
			}
267
		}
268
269
	}
270
271 4971 daigle
	/**
272
	 * Create a job in the database.
273
	 *
274
	 * @param name
275
	 *            the name of the job. This should be unique
276
	 * @param triggerName
277
	 *            the name of the trigger that is registered in the scheduler
278
	 *            service
279
	 * @param groupName
280
	 *            the group of the job
281
	 * @param jobClass
282
	 *            the class that implements the job functionality. The name of
283
	 *            this class will be extracted and put into the database.
284
	 * @param startTime
285
	 *            the time when the job should first run
286
	 * @param intervalValue
287
	 *            the amount of time between job runs.
288
	 * @param intervalUnit
289
	 *            the unit of time that the intervalValue represents. Valid
290
	 *            values are s,m,h, d and w
291
	 * @param jobParams
292
	 *            a map of parameters that are associated with this job.
293
	 */
294 4959 daigle
	public void createJob(String name, String triggerName, String groupName,
295 5012 daigle
			Class<Job> jobClass, Calendar startTime, Calendar endTime, int intervalValue,
296 4959 daigle
			String intervalUnit, HashMap<String, String> jobParams)
297
			throws AccessException {
298
299 4971 daigle
		// Create and populate a job data object
300 4951 daigle
		ScheduledJobDAO jobDAO = new ScheduledJobDAO();
301 4959 daigle
		jobDAO.setStatus(StatusUtil.SCHEDULED);
302 4951 daigle
		jobDAO.setName(name);
303 4959 daigle
		jobDAO.setTriggerName(name);
304
		jobDAO.setGroupName(groupName);
305 4951 daigle
		jobDAO.setClassName(jobClass.getName());
306
		jobDAO.setStartTime(new Timestamp(startTime.getTimeInMillis()));
307 5012 daigle
		jobDAO.setEndTime(new Timestamp(endTime.getTimeInMillis()));
308 4959 daigle
		jobDAO.setIntervalValue(intervalValue);
309
		jobDAO.setIntervalUnit(intervalUnit);
310
311 4951 daigle
		createJob(jobDAO, jobParams);
312
	}
313 4971 daigle
314
	/**
315
	 * Create a job in the database
316
	 * @param jobDAO the job data object that holds necessary information
317
	 * @param jobParams a map of parameters that are associated with this job.
318
	 */
319 4959 daigle
	public void createJob(ScheduledJobDAO jobDAO, HashMap<String, String> jobParams) throws AccessException {
320
		PreparedStatement pstmt = null;
321
322 4971 daigle
		// First insert the job
323 4951 daigle
		try {
324
			String sql =
325 5012 daigle
				"INSERT INTO scheduled_job (date_created, date_updated, status, name, trigger_name, group_name, class_name, start_time, end_time, interval_value, interval_unit) "
326
				+ "VALUES(now(), now(), ?, ?, ?, ?, ?, ?, ?, ?, ?)";
327 4959 daigle
			pstmt = conn.prepareStatement(sql);
328 4951 daigle
329
			pstmt.setString(1, jobDAO.getStatus());
330
			pstmt.setString(2, jobDAO.getName());
331 4959 daigle
			pstmt.setString(3, jobDAO.getTriggerName());
332
			pstmt.setString(4, jobDAO.getGroupName());
333
			pstmt.setString(5, jobDAO.getClassName());
334
			pstmt.setTimestamp(6, jobDAO.getStartTime());
335 5012 daigle
			pstmt.setTimestamp(7, jobDAO.getEndTime());
336
			pstmt.setInt(8, jobDAO.getIntervalValue());
337
			pstmt.setString(9, jobDAO.getIntervalUnit());
338 4951 daigle
339 5012 daigle
			String sqlReport = "ScheduledJobAccess.createJob - SQL: " + sql
340
				+ " [" + jobDAO.getStatus() + ","
341
				+ jobDAO.getName() + ","
342
				+ jobDAO.getTriggerName() + ","
343
				+ jobDAO.getGroupName() + ","
344
				+ jobDAO.getClassName() + ",(Timestamp)"
345
				+ jobDAO.getStartTime().toString() + ",";
346
			if(jobDAO.getEndTime() == null) {
347
				sqlReport += "null,";
348
			} else {
349
				sqlReport += jobDAO.getEndTime().toString() + ",";
350
			}
351
			sqlReport += jobDAO.getIntervalValue() + ","
352
				+ jobDAO.getIntervalUnit() + "]";
353
			logMetacat.info(sqlReport);
354
355 4951 daigle
			pstmt.execute();
356
357
		} catch (SQLException sqle) {
358
			throw new AccessException("ScheduledJobAccess.createJob - SQL error when creating scheduled job "
359
					+ jobDAO.getName()  + " : "  + sqle.getMessage());
360 4959 daigle
		} finally {
361
			try {
362
				if (pstmt != null) {
363
					pstmt.close();
364
				}
365
			} catch (SQLException sqle) {
366
				logMetacat.error("ScheduledJobAccess.createJob - An error occurred "
367
						+ "closing prepared statement: " + sqle.getMessage());
368
			} finally {
369
				DBConnectionPool.returnDBConnection(conn, serialNumber);
370
			}
371 4951 daigle
		}
372
373 4971 daigle
		// Then iterate through the job params and insert them into the db
374 4951 daigle
		if (jobParams.size() > 0) {
375 4959 daigle
			ScheduledJobParamAccess scheduledJobParamsAccess = null;
376 4951 daigle
			ScheduledJobDAO updatedJobDAO = null;
377
			try {
378
				updatedJobDAO = getJobByName(jobDAO.getName());
379 4959 daigle
				scheduledJobParamsAccess = new ScheduledJobParamAccess();
380 4951 daigle
				scheduledJobParamsAccess.createJobParams(updatedJobDAO.getId(), jobParams);
381
			} catch (AccessException ae) {
382
				if (updatedJobDAO != null) {
383 4967 daigle
					updatedJobDAO.setStatus(StatusUtil.DELETED);
384
					updateJobStatus(updatedJobDAO);
385 4951 daigle
					scheduledJobParamsAccess.deleteJobParams(updatedJobDAO.getId());
386
				} else {
387
					logMetacat.warn("ScheduledJobAccess.createJob - Tried to delete non-existant scheduled job: "
388
							+ jobDAO.getName());
389
				}
390
			}
391
		}
392
	}
393
394 4971 daigle
	/**
395
	 * Update the status of a job in the database
396
	 *
397
	 * @param jobDAO
398
	 *            the job data object that we want to change. The status should
399
	 *            already have been updated in this object
400
	 */
401 4951 daigle
	public void updateJobStatus(ScheduledJobDAO jobDAO) throws AccessException {
402
403
		if (jobDAO == null) {
404
			throw new AccessException("ScheduledJobAccess.updateJobStatus - job DAO cannot be null.");
405
		}
406
407 4959 daigle
		PreparedStatement pstmt = null;
408
409 4951 daigle
		try {
410
			String sql = "UPDATE scheduled_job SET status = ? WHERE id = ?";
411 4967 daigle
412
			pstmt = conn.prepareStatement(sql);
413 4951 daigle
			pstmt.setString(1, jobDAO.getStatus());
414
			pstmt.setLong(2, jobDAO.getId());
415
416 5012 daigle
			String sqlReport = "ScheduledJobAccess.deleteJob - SQL: " + sql
417
				+  " [" + jobDAO.getStatus() + "," + jobDAO.getId() + "]";
418
			logMetacat.info(sqlReport);
419 4951 daigle
420
			pstmt.execute();
421
		} catch (SQLException sqle) {
422
			throw new AccessException("ScheduledJobAccess.deleteJob - SQL error when "
423
					+ "deleting scheduled job " + jobDAO.getName()  + " : "  + sqle.getMessage());
424 4959 daigle
		} finally {
425
			try {
426
				if (pstmt != null) {
427
					pstmt.close();
428
				}
429
			} catch (SQLException sqle) {
430
				logMetacat.error("ScheduledJobAccess.updateJobStatus - An error occurred "
431
						+ "closing prepared statement: " + sqle.getMessage());
432
			} finally {
433
				DBConnectionPool.returnDBConnection(conn, serialNumber);
434
			}
435
		}
436 4951 daigle
437
	}
438
439 4971 daigle
	/**
440
	 * Populate a job data object with the current row in a resultset
441
	 *
442
	 * @param resultSet
443
	 *            the result set which is already pointing to the desired row.
444
	 * @return a scheduled job data object
445
	 */
446 4959 daigle
	protected ScheduledJobDAO populateDAO(ResultSet resultSet) throws SQLException {
447
448
		ScheduledJobDAO jobDAO = new ScheduledJobDAO();
449
		jobDAO.setId(resultSet.getLong("id"));
450
		jobDAO.setCreateTime(resultSet.getTimestamp("date_created"));
451
		jobDAO.setModTime(resultSet.getTimestamp("date_updated"));
452
		jobDAO.setStatus(resultSet.getString("status"));
453
		jobDAO.setName(resultSet.getString("name"));
454
		jobDAO.setTriggerName(resultSet.getString("trigger_name"));
455
		jobDAO.setGroupName(resultSet.getString("group_name"));
456
		jobDAO.setClassName(resultSet.getString("class_name"));
457
		jobDAO.setStartTime(resultSet.getTimestamp("start_time"));
458 5012 daigle
		jobDAO.setEndTime(resultSet.getTimestamp("end_time"));
459 4959 daigle
		jobDAO.setIntervalValue(resultSet.getInt("interval_value"));
460
		jobDAO.setIntervalUnit(resultSet.getString("interval_unit"));
461
462
		return jobDAO;
463
	}
464
465 4951 daigle
}