/src/edu/ucsb/nceas/metacat/workflow/WorkflowScheduler.java - Diff - Metacat - Ecoinformatics Redmine

« Previous | Next »

Revision 4971

Added by daigle almost 15 years ago

Beef up comments

     /**
      *  '$RCSfile$'
      *    Purpose: A Class that handles scheduling tasks
      *    Purpose: A Class that handles scheduling workflow jobs
      *  Copyright: 2009 Regents of the University of California and the
      *             National Center for Ecological Analysis and Synthesis
      *    Authors: Michael Daigle
-...
     import java.text.ParseException;
     import java.util.Calendar;
     import java.util.Date;
     import java.util.Enumeration;
     import java.util.Hashtable;
     import java.util.HashMap;
-...
     import edu.ucsb.nceas.metacat.util.RequestUtil;
     import edu.ucsb.nceas.shared.AccessException;
     /**
      * @author daigle
+     *
      */
     /**
      * @author daigle
+     *
      */
     public class WorkflowScheduler extends BaseScheduler {
     	private static WorkflowScheduler workflowScheduler = null;
-...
     		return workflowScheduler;
+    	}
     	/**
     	 * Scheduling a workflow
+    	 *
     	 * @param request
     	 *            the servlet request object
     	 * @param response
     	 *            the servlet response object
     	 * @param params
     	 *            the request parameters
     	 * @param username
     	 *            the user
     	 * @param groups
     	 *            the user's group
     	 */
     	public void scheduleJob(HttpServletRequest request, HttpServletResponse response,
     			Hashtable<String, String[]> params, String username,
     			String[] groups) throws MetacatSchedulerException {
-...
     		try {
     			SchedulerService schedulerService = SchedulerService.getInstance();
     			if (delays != null && delays.length > 0) {
     				startCal = schedulerService.getStartDateFromDelay(delays[0]);
     			} else if (startTimes != null && startTimes.length > 0) {
     			// get start time or delay.  Start time takes precidence if both exist.
     			if (startTimes != null && startTimes.length > 0) {
     				SimpleDateFormat dateFormat = new SimpleDateFormat("MM/dd/yyyy HH:mm:ss z");
     				Date startDate = dateFormat.parse(startTimes[0]);
     				startCal = Calendar.getInstance();
     				startCal.setTime(startDate);
     			} else if (delays != null && delays.length > 0) {
     				startCal = schedulerService.getStartDateFromDelay(delays[0]);
     			} else {
     				// if delay and starttime were not provided, set date to now.
     				startCal = Calendar.getInstance();
+    			}
     			// interval value must exist
     			String intervalValues[] = params.get("intervalvalue");
     			if (intervalValues == null || intervalValues.length == 0) {
     				throw new MetacatSchedulerException("WorkflowScheduler.scheduleJob - intervalvalue field must be populated "
-...
     			String intervalStrValue = intervalValues[0];
     			int intervalValue = Integer.parseInt(intervalStrValue);
     			// interval unit must exist
     			String intervalUnits[] = params.get("intervalunit");
     			if (intervalUnits == null || intervalUnits.length == 0) {
     				throw new MetacatSchedulerException("WorkflowScheduler.scheduleJob - intervalunit field must be populated "
-...
+    			}
     			String intervalUnit = intervalUnits[0];
     			Enumeration<String> paramNames = params.keys();
     			while (paramNames.hasMoreElements()) {
     				String paramName = paramNames.nextElement();
     				if (paramName.startsWith("jobparam_")) {
     					jobParams.put(paramName.substring(9), params.get(paramName)[0]);
+    				}
     			// workflow id unit must exist.  Add to job params
     			String workflowids[] = params.get("workflowid");
     			if (workflowids == null || workflowids.length == 0) {
     				throw new MetacatSchedulerException("WorkflowScheduler.scheduleJob - workflowid field must be populated "
     								+ "in scheduler parameters when scheduling job.");
+    			}
     			jobParams.put("workflowid", workflowids[0]);
     			// kar id must exist.  Add to job params
     			String karids[] = params.get("karid");
     			if (karids == null || karids.length == 0) {
     				throw new MetacatSchedulerException("WorkflowScheduler.scheduleJob - karid field must be populated "
     								+ "in scheduler parameters when scheduling job.");
+    			}
     			jobParams.put("karid", karids[0]);
     			// workflow name unit must exist.  Add to job params
     			String workflownames[] = params.get("workflowname");
     			if (workflownames == null || workflownames.length == 0) {
     				throw new MetacatSchedulerException("WorkflowScheduler.scheduleJob - workflowname field must be populated "
     								+ "in scheduler parameters when scheduling job.");
+    			}
     			jobParams.put("workflowname", workflownames[0]);
     			String jobName = WORKFLOW_JOB_GROUP
     					+ Calendar.getInstance().getTimeInMillis();
     			// Schedule the job
     			String xmlResult = schedulerService.scheduleJob(jobName, startCal, intervalValue, intervalUnit,
     					WORKFLOW_JOB_CLASS, WORKFLOW_JOB_GROUP, jobParams, username, groups);
     			// if there is a forwardto param on the request, then send the user to the page
     			// referenced in that param, otherwise, just send the xml back.
     			String forwardtos[] = params.get("forwardto");
     			String forwardto = null;
     			if (forwardtos != null && forwardtos.length > 0) {
-...
+    		}
+    	}
     	/**
     	 * Unschedule a job
+    	 *
     	 * @param request
     	 *            the servlet request object
     	 * @param response
     	 *            the servlet response object
     	 * @param params
     	 *            the request parameters
     	 * @param username
     	 *            the user
     	 * @param groups
     	 *            the user's group
     	 */
     	public void unScheduleJob(HttpServletRequest request, HttpServletResponse response,
     			Hashtable<String, String[]> params, String username, String[] groups)
     			throws MetacatSchedulerException {
     		try {
     			// workflow job id must exist
     			String jobNames[] = params.get("workflowjobid");
     			if (jobNames == null || jobNames.length == 0) {
     				throw new MetacatSchedulerException("SchedulerService.unScheduleJob - workflowjobid "
-...
+    			}
     			String jobName = jobNames[0];
     			// unschedule the job
     			SchedulerService schedulerService = SchedulerService.getInstance();
     			String xmlResult = schedulerService.unScheduleJob(jobName, username, groups);
     			String forwardtos[] = params.get("forwardto");
     			String forwardto = null;
     			if (forwardtos != null && forwardtos.length > 0) {
     				forwardto = forwardtos[0];
+    			}
     			// if there is a forwardto param on the request, then send the user to the page
     			// referenced in that param, otherwise, just send the xml back.
     			if (forwardto != null) {
     				String qformats[] = params.get("qformat");
     				String qformat = null;
-...
     				ScheduledJobAccess jobAccess = new ScheduledJobAccess();
     				ScheduledJobDAO jobDAO = jobAccess.getJobByName(jobName);
     				// we need to include the workflow id in the forward url
     				String workflowId = null;
     				ScheduledJobParamDAO jobParamDAO = jobDAO.getJobParam("workflowid");
     				if (jobParamDAO != null) {
-...
+    		}
+    	}
     	/**
     	 * reschedule job
+    	 *
     	 * @param request
     	 *            the servlet request object
     	 * @param response
     	 *            the servlet response object
     	 * @param params
     	 *            the request parameters
     	 * @param username
     	 *            the user
     	 * @param groups
     	 *            the user's group
     	 */
     	public void reScheduleJob(HttpServletRequest request, HttpServletResponse response,
     			Hashtable<String, String[]> params, String username,
     			String[] groups) throws MetacatSchedulerException {
     		try {
     			String jobNames[] = params.get("workflowjobid");
     			// workflow job id must exist
     			String jobNames[] = params.get("workflowjobid");
     			if (jobNames == null || jobNames.length == 0) {
     				throw new MetacatSchedulerException("WorkflowScheduler.reScheduleJob - workflowjobid field must be populated "
     						+ "in scheduler parameters when rescheduling job.");
+    			}
+    			}
     			String jobName = jobNames[0];
     			ScheduledJobAccess jobAccess = new ScheduledJobAccess();
     			ScheduledJobDAO jobDAO = jobAccess.getJobByName(jobName);
     			// reschedule the job
     			SchedulerService schedulerService = SchedulerService.getInstance();
     			String result = schedulerService.rescheduleJob(jobDAO, username, groups);
     			// if there is a forwardto param on the request, then send the user to the page
     			// referenced in that param, otherwise, just send the xml back.
     			String forwardtos[] = params.get("forwardto");
     			String forwardto = null;
     			if (forwardtos != null && forwardtos.length > 0) {
-...
     					qformat = qformats[0];
+    				}
     				// we need to include the workflow id in the forward url
     				String workflowId = null;
     				ScheduledJobParamDAO jobParamDAO = jobDAO.getAllJobParams().get("workflowid");
     				if (jobParamDAO != null) {
-...
+    		}
+    	}
     	/**
     	 * delete job - to be implemented
     	 */
     	public void deleteJob(HttpServletRequest request, HttpServletResponse response,
     			Hashtable<String, String[]> params, String username, String[] groups) throws MetacatSchedulerException {
+    	}
     	/**
     	 * get job information for a given workflow in xml format
+    	 *
     	 * @param request
     	 *            the servlet request object
     	 * @param response
     	 *            the servlet response object
     	 * @param params
     	 *            the request parameters
     	 * @param username
     	 *            the user
     	 * @param groups
     	 *            the user's group
     	 */
     	public void getJobs(HttpServletRequest request, HttpServletResponse response,
     			Hashtable<String, String[]> params, String username, String[] groups) throws MetacatSchedulerException {
-...
+            }
     		try {
     			// get the job info in xml format
     			String xmlResult = SchedulerService.getInstance().getJobsInfoXML(WORKFLOW_JOB_GROUP, "workflowid", workFlowId);
     			logMetacat.debug("WorkflowScheduler.getJobs - xmlResult: " + xmlResult);

Also available in: Unified diff

Project

General

Profile

Metacat

Revision 4971

Added by daigle almost 15 years ago