Metacat

/**

 *  '$RCSfile$'

 *    Purpose: A Class that implements system utility methods 

 *  Copyright: 2008 Regents of the University of California and the

 *             National Center for Ecological Analysis and Synthesis

 *    Authors: Michael Daigle

 * 

 *   '$Author: daigle $'

 *     '$Date: 2009-03-23 13:56:56 -0800 (Mon, 23 Mar 2009) $'

 * '$Revision: 4854 $'

 *

 * This program is free software; you can redistribute it and/or modify

 * it under the terms of the GNU General Public License as published by

 * the Free Software Foundation; either version 2 of the License, or

 * (at your option) any later version.

 *

 * This program is distributed in the hope that it will be useful,

 * but WITHOUT ANY WARRANTY; without even the implied warranty of

 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the

 * GNU General Public License for more details.

 *

 * You should have received a copy of the GNU General Public License

 * along with this program; if not, write to the Free Software

 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA

 */

package edu.ucsb.nceas.metacat.workflow;

import java.util.Hashtable;

import org.apache.log4j.Logger;

public class WorkflowEngineClient implements WorkflowClientInterface {

	private static Logger logMetacat = Logger.getLogger(WorkflowEngineClient.class);

	public void execute(String workflowName, Hashtable<String, String> additionalParams) {

		// do execution stuff here

	}

	public String getStatus(String workflowId) {

		String statusXML = "";

		// do status stuff here

		return statusXML;

	}

 }

/**

 *  '$RCSfile$'

 *    Purpose: A Class that loads eml-access.xml file containing ACL 

 *             for a metadata document into relational DB

 *  Copyright: 2000 Regents of the University of California and the

 *             National Center for Ecological Analysis and Synthesis

 *    Authors: Jivka Bojilova

 *

 *   '$Author: daigle $'

 *     '$Date: 2009-03-25 14:04:06 -0800 (Wed, 25 Mar 2009) $'

 * '$Revision: 4863 $'

 *

 * This program is free software; you can redistribute it and/or modify

 * it under the terms of the GNU General Public License as published by

 * the Free Software Foundation; either version 2 of the License, or

 * (at your option) any later version.

 *

 * This program is distributed in the hope that it will be useful,

 * but WITHOUT ANY WARRANTY; without even the implied warranty of

 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the

 * GNU General Public License for more details.

 *

 * You should have received a copy of the GNU General Public License

 * along with this program; if not, write to the Free Software

 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA

 */

package edu.ucsb.nceas.metacat.workflow;

import java.util.Hashtable;

/**

 * This interface will handle the access control for different documents:

 * the package-orented, single eml2 document and other single file

 */

public interface WorkflowClientInterface

{

	public void execute(String workflowName, Hashtable<String, String> additionalParams);

	public String getStatus(String workflowId); 

}

/**

 *  '$RCSfile$'

 *    Purpose: A Class that implements administrative methods 

 *  Copyright: 2008 Regents of the University of California and the

 *             National Center for Ecological Analysis and Synthesis

 *    Authors: Michael Daigle

 * 

 *   '$Author: daigle $'

 *     '$Date: 2008-08-22 16:26:10 -0700 (Fri, 22 Aug 2008) $'

 * '$Revision: 4299 $'

 *

 * This program is free software; you can redistribute it and/or modify

 * it under the terms of the GNU General Public License as published by

 * the Free Software Foundation; either version 2 of the License, or

 * (at your option) any later version.

 *

 * This program is distributed in the hope that it will be useful,

 * but WITHOUT ANY WARRANTY; without even the implied warranty of

 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the

 * GNU General Public License for more details.

 *

 * You should have received a copy of the GNU General Public License

 * along with this program; if not, write to the Free Software

 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA

 */

package edu.ucsb.nceas.metacat.util;

import java.io.IOException;

import java.io.PrintWriter;

import java.util.Hashtable;

import javax.servlet.http.HttpServletResponse;

import org.apache.log4j.Logger;

public class ErrorUtil {

	private static Logger logMetacat = Logger.getLogger(RequestUtil.class);

	// 101XXX - general errors

	public static Long GENERAL_UTILITY_ERROR = new Long(101001);	

	public static Long METACAT_UTILITY_ERROR = new Long(101002);

	// 104XXX - property errors

	public static Long PROPERTY_NOT_FOUND = new Long(104001);	

	// 105XXX - permission errors

	public static Long NO_READ_PERMISSION = new Long(105001);

	// errorCodes is a lookup table for generic messages for each code.  It

	// is better to use the sendError() versions that accept an explicit 

	// error message;

	static Hashtable<Long, String> errorCodes = new Hashtable<Long, String>();

	static {

		errorCodes.put(GENERAL_UTILITY_ERROR, "General utility error");

		errorCodes.put(METACAT_UTILITY_ERROR, "Metacat utility error");

		errorCodes.put(PROPERTY_NOT_FOUND, "Property not found");

		errorCodes.put(NO_READ_PERMISSION, "Read permission denied for user");

	}

	/**

	 * private constructor - all methods are static so there is no

     * no need to instantiate.

	 */

	private ErrorUtil() {}

	public static void sendError(HttpServletResponse response, Long errorCode, String errorMessage) 

		throws ErrorSendingErrorException {

		PrintWriter out = null;

		try {

			out = response.getWriter();			

			response.setContentType("text/xml");

			out.println("<?xml version=\"1.0\"?>");

			out.println("<error>");

			out.println("<code>" + errorCode + "</code>");

			out.println("<message>" + errorMessage + "</message>");

			out.println("</error>");

		} catch (IOException ioe) {

			throw new ErrorSendingErrorException("I/O error when returning error: " 

					+ errorCode + " : " + errorMessage);

		} finally {

			if (out != null) {

				out.close();

			}

		}

	}

	public static void sendError(HttpServletResponse response, Long errorCode) 

		throws ErrorSendingErrorException {

		PrintWriter out = null;

		try {

			out = response.getWriter();	

			response.setContentType("text/xml");

			out.println("<?xml version=\"1.0\"?>");

			out.println("<error>");

			out.println("<code>" + errorCode + "</code>");

			out.println("<message>" + errorCodes.get(errorCode) + "</message>");

			out.println("</error>");

		} catch (IOException ioe) {

			throw new ErrorSendingErrorException("I/O error when returning error: " 

					+ errorCode);

		} finally {

			if (out != null) {

				out.close();

			}

		} out.close();

	}

	public static void sendError(HttpServletResponse response, PrintWriter out,

			Long errorCode, String errorMessage) throws ErrorSendingErrorException {

		response.setContentType("text/xml");

		out.println("<?xml version=\"1.0\"?>");

		out.println("<error>");

		out.println("<code>" + errorCode + "</code>");

		out.println("<message>" + errorMessage + "</message>");

		out.println("</error>");

	}

	public static void sendError(HttpServletResponse response, PrintWriter out,

			Long errorCode) throws ErrorSendingErrorException {

		response.setContentType("text/xml");

		out.println("<?xml version=\"1.0\"?>");

		out.println("<error>");

		out.println("<code>" + errorCode + "</code>");

		out.println("<message>" + errorCodes.get(errorCode) + "</message>");

		out.println("</error>");

	}

}

/**

 *  '$RCSfile$'

 *    Purpose: A Class that runs a single scheduled report task 

 *  Copyright: 2009 Regents of the University of California and the

 *             National Center for Ecological Analysis and Synthesis

 *    Authors: Michael Daigle

 * 

 *   '$Author: daigle $'

 *     '$Date: 2009-03-23 13:56:56 -0800 (Mon, 23 Mar 2009) $'

 * '$Revision: 4854 $'

 *

 * This program is free software; you can redistribute it and/or modify

 * it under the terms of the GNU General Public License as published by

 * the Free Software Foundation; either version 2 of the License, or

 * (at your option) any later version.

 *

 * This program is distributed in the hope that it will be useful,

 * but WITHOUT ANY WARRANTY; without even the implied warranty of

 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the

 * GNU General Public License for more details.

 *

 * You should have received a copy of the GNU General Public License

 * along with this program; if not, write to the Free Software

 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA

 */

package edu.ucsb.nceas.metacat.scheduler;

import org.quartz.InterruptableJob;

public interface ScheduledJobInterface extends InterruptableJob {

	public static String STATE_SCHEDULED = "scheduled";

	public static String STATE_EXECUTING = "executing";

	public static String STATE_UNSHCEDULED = "unscheduled";	

	public static String STATE_DELETED = "deleted";

}

/**

 *  '$RCSfile$'

 *    Purpose: A Class that manages database access of scheduled task 

 *             information.

 *  Copyright: 2009 Regents of the University of California and the

 *             National Center for Ecological Analysis and Synthesis

 *    Authors: Michael Daigle

 * 

 *   '$Author: daigle $'

 *     '$Date: 2009-03-23 13:56:56 -0800 (Mon, 23 Mar 2009) $'

 * '$Revision: 4854 $'

 *

 * This program is free software; you can redistribute it and/or modify

 * it under the terms of the GNU General Public License as published by

 * the Free Software Foundation; either version 2 of the License, or

 * (at your option) any later version.

 *

 * This program is distributed in the hope that it will be useful,

 * but WITHOUT ANY WARRANTY; without even the implied warranty of

 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the

 * GNU General Public License for more details.

 *

 * You should have received a copy of the GNU General Public License

 * along with this program; if not, write to the Free Software

 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA

 */

package edu.ucsb.nceas.metacat.scheduler;

import java.sql.PreparedStatement;

import java.sql.SQLException;

import java.util.Enumeration;

import java.util.Hashtable;

import org.apache.log4j.Logger;

import edu.ucsb.nceas.shared.AccessException;

import edu.ucsb.nceas.shared.BaseAccess;

public class ScheduledJobParamsAccess extends BaseAccess {

	private Logger logMetacat = Logger.getLogger(ScheduledJobParamsAccess.class);

	public ScheduledJobParamsAccess() throws AccessException {

		super("ScheduledJobParamsAccess");

	}

	protected void createJobParams(Long jobId, Hashtable<String, String> jobParams) throws AccessException {

		Enumeration<String> paramKeys = jobParams.keys();

		while(paramKeys.hasMoreElements()) {

			String paramKey = paramKeys.nextElement();

			ScheduledJobParamsDAO jobParamsDAO = new ScheduledJobParamsDAO();

			jobParamsDAO.setStatus(ScheduledJobInterface.STATE_SCHEDULED);

			jobParamsDAO.setJobId(jobId);

			jobParamsDAO.setKey(paramKey);

			jobParamsDAO.setValue(jobParams.get(paramKey));

			try {

				String sql = 

					"INSERT INTO scheduled_job_params (date_created, date_updated, status, job_id, key, value) " 

					+ "VALUES(now(), now(), ?, ?, ?, ?)";		

				PreparedStatement pstmt = conn.prepareStatement(sql);

				pstmt.setString(1, jobParamsDAO.getStatus());

				pstmt.setLong(2, jobParamsDAO.getJobId());

				pstmt.setString(3, jobParamsDAO.getKey());

				pstmt.setString(4, jobParamsDAO.getValue());

				logMetacat.info("SQL createJobParams - " + sql);

				logMetacat.info("SQL params:  [" + jobParamsDAO.getStatus() + ","

						+ jobParamsDAO.getJobId() + ","

						+ jobParamsDAO.getKey() + ","

						+ jobParamsDAO.getValue().toString() + "]");

				pstmt.execute();

			} catch (SQLException sqle) {

				// Just throw the exception.  The ScheduledJobAccess class should handle cleanup.

				throw new AccessException("ScheduledJobParamsAccess.createJobParams - SQL error when creating scheduled job parameter : "    

					 + sqle.getMessage());

			}

		}

	}

	protected void deleteJobParams(Long jobId) throws AccessException {

		try {

			String sql = "UPDATE scheduled_job_params SET status = ? WHERE jobId = ?";		

			pstmt.setString(1, ScheduledJobInterface.STATE_DELETED);

			pstmt.setLong(1, jobId);

			logMetacat.info("SQL deleteJobParams - " + sql);

			pstmt.execute();

		} catch (SQLException sqle) {

			throw new AccessException("ScheduledJobParamsAccess.deleteJobParams - SQL error " 

					+ "when deleting scheduled job params for job" + jobId  + " : "  + sqle.getMessage());

		}	

	}	

}

/**

 *  '$RCSfile$'

 *    Purpose: A Class that holds the data from the scheduled_task 

 *             table in the database. 

 *  Copyright: 2009 Regents of the University of California and the

 *             National Center for Ecological Analysis and Synthesis

 *    Authors: Michael Daigle

 * 

 *   '$Author: daigle $'

 *     '$Date: 2009-03-23 13:56:56 -0800 (Mon, 23 Mar 2009) $'

 * '$Revision: 4854 $'

 *

 * This program is free software; you can redistribute it and/or modify

 * it under the terms of the GNU General Public License as published by

 * the Free Software Foundation; either version 2 of the License, or

 * (at your option) any later version.

 *

 * This program is distributed in the hope that it will be useful,

 * but WITHOUT ANY WARRANTY; without even the implied warranty of

 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the

 * GNU General Public License for more details.

 *

 * You should have received a copy of the GNU General Public License

 * along with this program; if not, write to the Free Software

 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA

 */

package edu.ucsb.nceas.metacat.scheduler;

import edu.ucsb.nceas.shared.BaseDAO;

public class ScheduledJobParamsDAO extends BaseDAO {

	private Long _jobId;

	private String _key;

	private String _value;

	public Long getJobId() {

		return _jobId;

	}

	public void setJobId(Long jobId) {

		_jobId = jobId;

	}

	public String getKey() {

		return _key;

	}

	public void setKey(String key) {

		_key = key;

	}

	public String getValue() {

		return _value;

	}

	public void setValue(String value) {

		_value = value;

	}

}

public class AccessException extends Exception {

import java.sql.PreparedStatement;

public class BaseAccess {

    protected PreparedStatement pstmt = null;

    protected ResultSet select(PreparedStatement pstmt) throws AccessException {

    	try {

    		pstmt.execute();

        	rs = pstmt.getResultSet();

    	} catch (SQLException sqle) {

    		throw new AccessException("Could not perform select: " + pstmt.toString()

    				+ sqle.getMessage());

    	}

    	return rs;

    }

import edu.ucsb.nceas.metacat.util.ErrorUtil;

            		ErrorUtil.sendError(response, ErrorUtil.NO_READ_PERMISSION, errorString);

        	ErrorUtil.sendError(response, ErrorUtil.GENERAL_UTILITY_ERROR, errorString);

        	ErrorUtil.sendError(response, ErrorUtil.PROPERTY_NOT_FOUND, errorString);

        	ErrorUtil.sendError(response, ErrorUtil.METACAT_UTILITY_ERROR, errorString);

				} else if (action.equals("schedule")) {

					SchedulerService.getInstance().scheduleHandler(params, request, response, 

							userName, groupNames);

					return;

					out

							.println("Error: action not registered.  Please report this error.");

		}

public class ServiceException extends Exception {

import edu.ucsb.nceas.metacat.scheduler.ScheduledJobInterface;

public class WorkflowJob implements ScheduledJobInterface {

	private int _interval;

	public int getInterval() {

		return _interval;

	public void setInterval(int interval) {

		_interval = interval;

import java.text.DateFormat;

import java.text.ParseException;

import java.util.Date;

import java.util.Enumeration;

import java.util.Hashtable;

import javax.servlet.http.HttpServletRequest;

import javax.servlet.http.HttpServletResponse;

	static Hashtable<String, String> jobClassNames = new Hashtable<String, String>();

	static {

		jobClassNames.put("workflow", "edu.ucsb.nceas.metacat.workflow.WorkflowJob");

	}

	private SchedulerService() throws ServiceException {}

	public String scheduleHandler(Hashtable<String, String[]> params,

            HttpServletRequest request, HttpServletResponse response,

            String username, String[] groups) throws ServiceException {

		String returnString = "";

        String[] categories = params.get("category");

        if (categories == null || categories.length == 0) {

        	throw new ServiceException("SchedulerService.scheduleHandler - Category field " 

        			+ "must be populated in scheduler parameters");

        }

        String category = categories[0];

        if (category.equals("schedule")) {

    		Calendar startCal = null;

            Hashtable<String, String> jobParams = new Hashtable<String, String>();

    		String jobTypes[] = params.get("type");

            if (jobTypes == null || jobTypes.length == 0) {

            	throw new ServiceException("SchedulerService.scheduleJob - Type field must be populated " 

            			+ "in scheduler parameters when scheduling job.");

            }

            String delays[] = params.get("delay");

    		String startTimes[] = params.get("starttime");       

            try {

    			if (delays != null && delays.length > 0) {

    				startCal = getStartDateFromDelay(delays[0]);

    			} else if (startTimes != null && startTimes.length > 0) {

    				Date startDate = DateFormat.getInstance().parse(startTimes[0]);

    				startCal = Calendar.getInstance();

    				startCal.setTime(startDate);

    			} else {

    				throw new ServiceException("SchedulerService.scheduleJob -  Either delay or starttime  " 

    						+ "field must be populated in scheduler parameters when scheduling job.");

    			}

    		} catch (ParseException pe) {

    			throw new ServiceException("SchedulerService.scheduleJob - Could not parse start time " 

    					+ startTimes[0] + " : " + pe.getMessage());

    		}

            String intervals[] = params.get("interval"); 

            if (intervals == null || intervals.length == 0) {

            	throw new ServiceException("SchedulerService.scheduleJob - Interval field must be populated " 

            			+ "in scheduler parameters when scheduling job.");

            } 

            String interval = intervals[0];

            Enumeration<String> paramNames = params.keys();

            while (paramNames.hasMoreElements()) {

            	String paramName = paramNames.nextElement();

            	if (paramName.startsWith("jobparam_")) {

            		jobParams.put(paramName.substring(8), params.get(paramName)[0]);

            	}

            }

            String jobType = jobTypes[0];

            String jobName = jobType + Calendar.getInstance().getTimeInMillis();

        	returnString = scheduleJob(jobName, startCal, interval, jobType, jobParams);

        } else if (category.equals("unschedule")) {

        	String jobNames[] = params.get("jobName");

        	if (jobNames == null || jobNames.length == 0) {

        		throw new ServiceException("SchedulerService.scheduleJob - Job ID field must be populated " 

            			+ "in scheduler parameters when unscheduling job.");

        	}

        	unscheduleJob(jobNames[0]);

        } else if (category.equals("delete")) {

//        	deleteJob(params);

        }

        return returnString;

	}

	public String scheduleJob(String jobName, Calendar startCal, String interval,

			String jobType, Hashtable<String, String> jobParams) throws ServiceException {

        String className = jobClassNames.get(jobType);

        if (className == null) {

        	throw new ServiceException("SchedulerService.scheduleJob - Type: " + jobType 

        			+ " is not registered as a valid job type");

        }

        logMetacat.info("Scheduling job -- name: " + jobName + ", class: " + className 

        		+ ", start time: " + startCal.toString() + ", interval: " + interval);

        	jobClass = (Class<Job>)Class.forName(jobType + "Job");     	

        			+ jobType + "Job");

        }    

		char intervalUnit = interval.trim().charAt(interval.length());

					+ "into an integer: " + intervalStrValue);

		switch (intervalUnit) {

		case 's':

		case 'S':

			scheduleSecondlyJob(jobName, jobClass, startCal, intervalValue, jobType);

			break;

		case 'm':

		case 'M':

			scheduleMinutelyJob(jobName, jobClass, startCal, intervalValue, jobType);

			break;

		case 'h':

		case 'H':

			scheduleHourlyJob(jobName, jobClass, startCal, intervalValue, jobType);

			break;

		case 'd':

		case 'D':

			scheduleDailyJob(jobName, jobClass, startCal, intervalValue, jobType);

			break;

		default:

			throw new ServiceException("SchedulerService.scheduleJob - Could not interpret interval unit: " 

					+ intervalUnit + ". Unit must be s, m, h or d");	

		}	

			jobAccess.createJob(jobName, jobClass, startCal, intervalValue, jobParams);

			} catch (ServiceException se) {

						+ "job from the scheduler.  The db and scheduler may be out of sync");

			throw new ServiceException("SchedulerService.scheduleJob - Error accessing db: " 

					+ ae.getMessage());

			jobDAO.setStatus(ScheduledJobInterface.STATE_UNSHCEDULED);

							+ "scheduled job because of db access issue: " + ae.getMessage());

			throw new ServiceException("SchedulerService.deleteJob - Could not delete job: " 

					+ jobName + " for group: " + groupName + " : " + se.getMessage());

					+ "scheduled job because of db access issue: " + ae.getMessage());

}

	private void scheduleSecondlyJob(String name, Class<Job> jobClass, Calendar startTime, int interval, String jobGroup) throws ServiceException {

		JobDetail jobDetail = new JobDetail(name, jobGroup, jobClass);