/src/edu/ucsb/nceas/metacat/scheduler/SchedulerService.java - Diff - Metacat - Ecoinformatics Redmine

« Previous | Next »

Revision 4971

Added by daigle almost 15 years ago

Beef up comments

     		return schedulerService;
+    	}
     	// this is a refreshable class
     	public boolean refreshable() {
     		return true;
+    	}
     	// do the refresh
     	protected void doRefresh() throws ServiceException {
     		stop();
     		start();
+    	}
     	// initialize the service
     	protected void start() throws ServiceException {
     		try {
     			// get the Quartz scheduler factory
     			SchedulerFactory schedFact = new org.quartz.impl.StdSchedulerFactory();
     			// get the scheduler
     			sched = schedFact.getScheduler();
     			sched.start();
     			// get all existing jobs from the database
     			ScheduledJobAccess jobAccess = new ScheduledJobAccess();
     			HashMap<Long, ScheduledJobDAO> allJobsMap = jobAccess.getAllJobs(null);
     			// reschedule each job that is in a SCHEDULED state.
     			for (Long jobId : allJobsMap.keySet()) {
     				ScheduledJobDAO jobDAO = allJobsMap.get(jobId);
     				String[] groups = {"scheduler_group"};
     				if (jobDAO.getStatus().equals(StatusUtil.SCHEDULED)) {
     					// send false as the last param so the reschedule method will not
     					// complain that the job is already in a SCHEDULED state.
     					rescheduleJob(jobDAO, "scheduler_user", groups, false);
+    				}
+    			}
     		} catch (AccessException ae) {
     			throw new ServiceException("DB Access issue when starting scheduler: ", ae);
     			throw new ServiceException("SchedulerService.start - DB Access issue when starting scheduler: ", ae);
     		} catch (SchedulerException se) {
     			throw new ServiceException("Scheduler engine issue when starting scheduler: " + se.getMessage());
     			throw new ServiceException("SchedulerService.start - Scheduler engine issue when starting scheduler: " + se.getMessage());
+    		}
+    	}
     	// Stop the scheduler
     	protected void stop() throws ServiceException {
     		try {
     			sched.shutdown(true);
     			sched = null;
     		} catch (SchedulerException se) {
     			throw new ServiceException("Could not shut down scheduler: " + se.getMessage());
     			throw new ServiceException("SchedulerService.stop - Could not shut down scheduler: " + se.getMessage());
+    		}
+    	}
     	// this will eventually return the scheduler status
     	protected Vector<String> getStatus() throws ServiceException {
     		return new Vector<String>();
+    	}
     	/**
     	 * Schedule a job
+    	 *
     	 * @param jobDAO
     	 *            the job data object to schedule
     	 * @param username
     	 *            the user that we will use to schedule
     	 * @param groups
     	 *            the user group that we will use to schedule
     	 * @return a message saying that the job was scheduled
     	 */
     	public String scheduleJob(ScheduledJobDAO jobDAO, String username, String[] groups) throws ServiceException {
     		// convert the start time to a calendar object
     		Calendar startTimeCal = Calendar.getInstance();
             startTimeCal.setTime(jobDAO.getStartTime());
             // extract the job parameters from their data objects and put into a string map
             HashMap<String, String> jobParams = new HashMap<String, String>();
             HashMap<String, ScheduledJobParamDAO> jobParamDAOs = jobDAO.getAllJobParams();
             for (String paramName : jobParamDAOs.keySet()) {
             	jobParams.put(paramName, jobParamDAOs.get(paramName).getValue());
+            }
             // schedule the job
     		return scheduleJob(jobDAO.getName(), startTimeCal, jobDAO.getIntervalValue(), jobDAO.getIntervalUnit(),
     				jobDAO.getClassName(), jobDAO.getGroupName(), jobParams, username, groups);
+    	}
     	/**
     	 * schedule a job
+    	 *
     	 * @param jobName
     	 *            the name of the job
     	 * @param startCal
     	 *            a calendar holding the start date of the job
     	 * @param intervalValue
     	 *            the run interval for the job
     	 * @param intervalUnit
     	 *            the unit of the run interval for the job
     	 * @param jobClassName
     	 *            the job class name
     	 * @param jobGroup
     	 *            the job group name
     	 * @param jobParams
     	 *            a map of additional job parameters
     	 * @param username
     	 *            the user name
     	 * @param groups
     	 *            the user's group name
     	 * @return a message saying that the job was scheduled
     	 */
     	public String scheduleJob(String jobName, Calendar startCal, int intervalValue, String intervalUnit,
     			String jobClassName, String jobGroup, HashMap<String, String> jobParams,
     			String username, String[] groups) throws ServiceException {
-...
             			+ jobClassName + " : " + cnfe.getMessage());
+            }
             logMetacat.info("Scheduling job -- name: " + jobName + ", class: " + jobClassName
             logMetacat.info("SchedulerService.scheduleJob - Scheduling job -- name: " + jobName + ", class: " + jobClassName
             		+ ", start time: " + startCal.toString() + ", interval value: " + intervalValue
             		+ ", interval unit: " + intervalUnit);
             // start the job in the job scheduler
     		startJob(jobName, startCal, intervalValue, intervalUnit, jobClass, jobGroup, jobParams);
     		// get a database access object and create the job in the database
     		try {
     			ScheduledJobAccess jobAccess = new ScheduledJobAccess();
     			jobAccess.createJob(jobName, jobName, jobGroup, jobClass, startCal, intervalValue, intervalUnit, jobParams);
-...
     				deleteJob(jobName, username, groups);
     			} catch (Exception e) {
     				// Not much we can do here but log this
     				logMetacat.error("An access exception was thrown when writing job: " + jobName
     				logMetacat.error("SchedulerService.scheduleJob - An access exception was thrown when writing job: " + jobName
     						+ "to the db, and another exception was thrown when trying to remove the "
     						+ "job from the scheduler.  The db and scheduler may be out of sync: " + e.getMessage());
+    			}
-...
     		return "Scheduled: " + jobName;
+    	}
     	/**
     	 * Unschedule a job. This removed it from the scheduler in memory and
     	 * changed it's status to unscheduled in the database.
+    	 *
     	 * @param jobName
     	 *            the name of the job to unschedule
     	 * @param username
     	 *            the user name
     	 * @param groups
     	 *            the user's group name
     	 * @return a message saying the job was unscheduled
     	 */
     	public String unScheduleJob(String jobName, String username,
     			String[] groups) throws ServiceException {
     		try {
-...
     						+ "not find job with name: " + jobName);
+    			}
     			// remove the job from the scheduler
     			sched.deleteJob(jobDAO.getName(), jobDAO.getGroupName());
     			// change the status of the job to unscheduled in the database.
     			jobDAO.setStatus(StatusUtil.UNSCHEDULED);
     			jobAccess.updateJobStatus(jobDAO);
     		} catch (SchedulerException se) {
-...
     		return "Unscheduled: " + jobName;
+    	}
     	/**
     	 * Reschedule a job. This call will always check to make sure the status is not SCHEDULED
     	 * @param jobDAO the job data object holding the information about the job to reschedule
     	 * @param username
     	 *            the user name
     	 * @param groups
     	 *            the user's group name
     	 * @return a message saying that the job was rescheduled
     	 */
     	public String rescheduleJob(ScheduledJobDAO jobDAO, String username, String[] groups) throws ServiceException {
     		return rescheduleJob(jobDAO, username, groups, true);
+    	}
     	/**
     	 * Reschedule a job.
+    	 *
     	 * @param jobDAO
     	 *            the job data object holding the information about the job to
     	 *            reschedule
     	 * @param username
     	 *            the user name
     	 * @param groups
     	 *            the user's group name
     	 * @param checkStatus
     	 *            if set to true, the method will check to make sure the status
     	 *            is UNSCHEDULED before restarting. Otherwise, the method will
     	 *            not check. This is so that we can restart a service at startup
     	 *            that was running when metacat was shut down.
     	 * @return a message saying that the job was rescheduled
     	 */
     	public String rescheduleJob(ScheduledJobDAO jobDAO, String username, String[] groups, boolean checkStatus) throws ServiceException {
     		try {
-...
     				throw new ServiceException("SchedulerService.reScheduleJob - Cannot reschedule nonexistant job.");
+    			}
     			// if we are checking status, make sure the job is in an UNSCHEDULED state in the db
     			if (checkStatus && !jobDAO.getStatus().equals(StatusUtil.UNSCHEDULED)) {
     				throw new ServiceException("SchedulerService.reScheduleJob - Cannot reschedule a job with status: "
     						+ jobDAO.getStatus() + ". Status must be 'unscheduled'.");
-...
     	        		+ ", start time: " + startCal.toString() + ", interval value: " + jobDAO.getIntervalValue()
     	        		+ ", interval unit: " + jobDAO.getIntervalUnit());
     	        // start the job in the scheduler
     			startJob(jobDAO.getName(), startCal, jobDAO.getIntervalValue(), jobDAO.getIntervalUnit(), jobClass, jobDAO.getGroupName(), jobParams);
     			// update the status in the database
     			jobDAO.setStatus(StatusUtil.SCHEDULED);
     			jobAccess.updateJobStatus(jobDAO);
-...
     		return "Resheduled: " + jobDAO.getName();
+    	}
     	/**
     	 * Remove the job from the scheduler and set the job status to deleted in the database
     	 * @param jobDAO
     	 *            the job data object holding the information about the job to
     	 *            delete
     	 * @param username
     	 *            the user name
     	 * @param groups
     	 *            the user's group name
     	 * @return a message saying that the job was deleted
     	 */
     	public String deleteJob(String jobName, String username,
     			String[] groups) throws ServiceException {
-...
     		return "Deleted: " + jobName;
+    	}
     	/**
     	 * Get information about the job in XML format
+    	 *
     	 * @param jobId
     	 *            the job for which we want the information
     	 * @return an XML representation of the job
     	 */
     	public String getJobInfoXML(Long jobId) throws ServiceException {
     		String jobInfoXML = "";
-...
     		return jobInfoXML;
+    	}
     	/**
     	 * Get the information for jobs in a group in an xml format. A parameter
     	 * key/value pair can be provided as well to limit the jobs returned.
+    	 *
     	 * @param groupName
     	 *            the job group that we are searching for
     	 * @param paramName
     	 *            the parameter name that we are looking for. this is ignored if
     	 *            null
     	 * @param paramValue
     	 *            the parameter value that we are looking for. this is ignored
     	 *            if null
     	 * @return an XML representation of the jobs.
     	 */
     	public String getJobsInfoXML(String groupName, String paramName, String paramValue) throws ServiceException {
     		String jobInfoXML = "";
-...
     		return jobInfoXML;
+    	}
     	/**
     	 * Convert a single job to XML
     	 * @param scheduledJobDAO the job we want to convert
     	 * @return an XML representation of the job
     	 */
     	public String jobToXML(ScheduledJobDAO scheduledJobDAO) throws ServiceException {
     		String jobXML = "";
-...
     		return jobXML;
+    	}
     	/**
     	 * Start a job in the scheduler
+    	 *
     	 * @param jobName
     	 *            the name of the job
     	 * @param startCal
     	 *            a calendar holding the start date of the job
     	 * @param intervalValue
     	 *            the run interval for the job
     	 * @param intervalUnit
     	 *            the unit of the run interval for the job
     	 * @param jobClassName
     	 *            the job class name
     	 * @param jobGroup
     	 *            the job group name
     	 * @param jobParams
     	 *            a map of additional job parameters
     	 * @param username
     	 *            the user name
     	 * @param groups
     	 *            the user's group name
     	 */
     	private void startJob(String jobName, Calendar startCal, int intervalValue, String intervalUnit,
     			Class<Job> jobClass, String jobGroup, HashMap<String, String> jobParams) throws ServiceException {
-...
     		char intervalChar = intervalUnit.charAt(0);
     		// call the appropriate scheduling method depending on the schedule interval unit
     		switch (intervalChar) {
     		case 's':
     		case 'S':
-...
+    		}
+    	}
     	/**
     	 * Schedule a job in the scheduler that has an interval based in seconds
+    	 *
     	 * @param jobName
     	 *            the name of the job
     	 * @param jobClass
     	 *            the job class object
     	 * @param startTime
     	 *            the time of the first run
     	 * @param interval
     	 *            the interval in seconds between runs
     	 * @param jobGroup
     	 *            the group of this job
     	 * @param jobDetail
     	 *            the job detail object
     	 */
     	private void scheduleSecondlyJob(String jobName, Class<Job> jobClass, Calendar startTime, int interval, String jobGroup, JobDetail jobDetail) throws ServiceException {
     		Trigger trigger = TriggerUtils.makeSecondlyTrigger(interval);
-...
+    		}
+    	}
     	/**
     	 * Schedule a job in the scheduler that has an interval based in minutes
+    	 *
     	 * @param jobName
     	 *            the name of the job
     	 * @param jobClass
     	 *            the job class object
     	 * @param startTime
     	 *            the time of the first run
     	 * @param interval
     	 *            the interval in minutes between runs
     	 * @param jobGroup
     	 *            the group of this job
     	 * @param jobDetail
     	 *            the job detail object
     	 */
     	private void scheduleMinutelyJob(String jobName, Class<Job> jobClass, Calendar startTime, int interval, String jobGroup, JobDetail jobDetail) throws ServiceException {
     		Trigger trigger = TriggerUtils.makeMinutelyTrigger(interval);
-...
+    		}
+    	}
     	/**
     	 * Schedule a job in the scheduler that has an interval based in hours
+    	 *
     	 * @param jobName
     	 *            the name of the job
     	 * @param jobClass
     	 *            the job class object
     	 * @param startTime
     	 *            the time of the first run
     	 * @param interval
     	 *            the interval in hours between runs
     	 * @param jobGroup
     	 *            the group of this job
     	 * @param jobDetail
     	 *            the job detail object
     	 */
     	private void scheduleHourlyJob(String jobName, Class<Job> jobClass, Calendar startTime, int interval, String jobGroup, JobDetail jobDetail) throws ServiceException {
     		Trigger trigger = TriggerUtils.makeHourlyTrigger(interval);
-...
+    		}
+    	}
     	/**
     	 * Schedule a job in the scheduler that has an interval based in days
+    	 *
     	 * @param jobName
     	 *            the name of the job
     	 * @param jobClass
     	 *            the job class object
     	 * @param startTime
     	 *            the time of the first run
     	 * @param interval
     	 *            the interval in days between runs
     	 * @param jobGroup
     	 *            the group of this job
     	 * @param jobDetail
     	 *            the job detail object
     	 */
     	private void scheduleDailyJob(String jobName, Class<Job> jobClass, Calendar startTime, int interval, String jobGroup, JobDetail jobDetail) throws ServiceException {
     		Trigger trigger = TriggerUtils.makeHourlyTrigger(interval * 24);
-...
+    		}
+    	}
     	/**
     	 * Extract the start date from the delay value
+    	 *
     	 * @param delay
     	 *            a string representing the start delay in <value><unit>
     	 *            notation where value is an integer and unit is one of s,m,h or
     	 *            d
     	 * @return the calendar object holding the start date
     	 */
     	public Calendar getStartDateFromDelay(String delay) throws ServiceException {
     		Calendar cal = Calendar.getInstance();
-...
+    		}
     		return cal;
+    	}
+    	}
+    }

Also available in: Unified diff

Project

General

Profile

Metacat

Revision 4971

Added by daigle almost 15 years ago