ambari-server/src/main/java/org/apache/ambari/server/scheduler/ExecutionScheduler.java

/*
 * Licensed to the Apache Software Foundation (ASF) under one
 * or more contributor license agreements.  See the NOTICE file
 * distributed with this work for additional information
 * regarding copyright ownership.  The ASF licenses this file
 * to you under the Apache License, Version 2.0 (the
 * "License"); you may not use this file except in compliance
 * with the License.  You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package org.apache.ambari.server.scheduler;

import java.util.List;

import org.apache.ambari.server.AmbariException;
import org.quartz.JobDetail;
import org.quartz.JobKey;
import org.quartz.SchedulerException;
import org.quartz.Trigger;

public interface ExecutionScheduler {
  /**
   * Initialize and start the scheduler to accept jobs.
   * @throws AmbariException
   */
  void startScheduler(Integer delay) throws AmbariException;

  /**
   * Shutdown the scheduler threads and do not accept any more jobs.
   * @throws AmbariException
   */
  void stopScheduler() throws AmbariException;

  /**
   * Add a trigger to the execution scheduler
   * @param trigger
   * @throws SchedulerException
   */
  void scheduleJob(Trigger trigger) throws SchedulerException;

  /**
   * Persist job data
   * @param job
   * @throws SchedulerException
   */
  void addJob(JobDetail job) throws SchedulerException;


  /**
   * Delete the identified Job from the Scheduler - and any associated Triggers.
   * @param jobKey
   * @throws SchedulerException
   */
  void deleteJob(JobKey jobKey) throws SchedulerException;

  /**
   * Get details for a job from scheduler.
   * @param jobKey
   * @return
   */
  JobDetail getJobDetail(JobKey jobKey) throws SchedulerException;

  /**
   * Get all triggers created for a job.
   * @param jobKey
   * @return
   * @throws SchedulerException
   */
  List<? extends Trigger> getTriggersForJob(JobKey jobKey)
    throws SchedulerException;

  /**
   * Check whether the scheduler is already running.
   * @return
   */
  boolean isSchedulerStarted() throws SchedulerException;
}