JobSchedulerService.java

/*
 * Copyright (C) 2009 eXo Platform SAS.
 *
 * This is free software; you can redistribute it and/or modify it
 * under the terms of the GNU Lesser General Public License as
 * published by the Free Software Foundation; either version 2.1 of
 * the License, or (at your option) any later version.
 *
 * This software 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
 * Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public
 * License along with this software; if not, write to the Free
 * Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA
 * 02110-1301 USA, or see the FSF site: http://www.fsf.org.
 */
package org.exoplatform.services.scheduler;

import org.exoplatform.container.component.ComponentPlugin;
import org.exoplatform.management.annotations.Managed;
import org.exoplatform.management.jmx.annotations.NameTemplate;
import org.exoplatform.management.jmx.annotations.Property;
import org.exoplatform.management.rest.annotations.RESTEndpoint;
import org.quartz.JobDataMap;
import org.quartz.JobDetail;
import org.quartz.JobExecutionContext;
import org.quartz.JobListener;
import org.quartz.Trigger;
import org.quartz.Trigger.TriggerState;
import org.quartz.TriggerListener;

import java.util.Date;
import java.util.List;

/**
 * Created by The eXo Platform SAS Author : Hoa Pham hoapham@exoplatform.com Oct
 * 5, 2005
 */
@Managed
@NameTemplate(@Property(key = "service", value = "JobSchedulerService"))
@RESTEndpoint(path = "JobSchedulerService")
public interface JobSchedulerService
{
   public void addJob(JobInfo jinfo, Date date) throws Exception;

   public void addPeriodJob(JobInfo jinfo, PeriodInfo pinfo) throws Exception;

   public void addPeriodJob(ComponentPlugin plugin) throws Exception;
   
   public void addCronJob(JobInfo jinfo, String exp) throws Exception;
   
   public void addCronJob(ComponentPlugin plugin) throws Exception;
   
   public boolean removeJob(JobInfo jinfo) throws Exception;

   public void addPeriodJob(JobInfo jinfo, PeriodInfo pinfo, JobDataMap jdatamap) throws Exception;

   public void addCronJob(JobInfo jinfo, String exp, JobDataMap jdatamap) throws Exception;

   public void executeJob(String jname, String jgroup, JobDataMap jdatamap) throws Exception;

   public void addGlobalJobListener(ComponentPlugin plugin) throws Exception;

   public List<JobListener> getAllGlobalJobListener() throws Exception;

   public JobListener getGlobalJobListener(String name) throws Exception;

   public boolean removeGlobalJobListener(String name) throws Exception;

   public void addJobListener(AddJobListenerComponentPlugin plugin) throws Exception;

   public List<JobListener> getAllJobListener() throws Exception;

   public JobListener getJobListener(String name) throws Exception;

   public boolean removeJobListener(String name) throws Exception;

   public void addGlobalTriggerListener(ComponentPlugin plugin) throws Exception;

   public List<TriggerListener> getAllGlobalTriggerListener() throws Exception;

   public TriggerListener getGlobalTriggerListener(String name) throws Exception;

   public boolean removeGlobaTriggerListener(String name) throws Exception;

   public TriggerState getTriggerState(String jobName, String groupName) throws Exception;

   public void addTriggerListener(AddTriggerListenerComponentPlugin plugin) throws Exception;

   public List<TriggerListener> getAllTriggerListener() throws Exception;

   public TriggerListener getTriggerListener(String name) throws Exception;

   public boolean removeTriggerListener(String name) throws Exception;

   public void queueTask(Task task);

   public List<JobExecutionContext> getAllExcutingJobs() throws Exception;

   public List<JobDetail> getAllJobs() throws Exception;

   public void pauseJob(String jobName, String groupName) throws Exception;

   public void resumeJob(String jobName, String groupName) throws Exception;

   public Trigger[] getTriggersOfJob(String jobName, String groupName) throws Exception;

   public Date rescheduleJob(String jobName, String groupName, Trigger newTrigger) throws Exception;

   public JobDetail getJob(JobInfo jobInfo) throws Exception;
   
   /**
    * Suspends all the registered jobs
    * @return <code>true</code> if the jobs could be suspended, <code>false</code> otherwise
    */
   public boolean suspend();
   
   /**
    * Resumes all the registered jobs
    * @return <code>true</code> if the jobs could be resumed, <code>false</code> otherwise
    */
   public boolean resume();
}