org.quartz.spi.TimeBroker Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of sundial Show documentation
A Lightweight Java Job Scheduling Framework
There is a newer version: 2.0.1
/* 
 * Copyright 2001-2009 Terracotta, Inc. 
 * 
 * Licensed 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.quartz.spi;

import java.util.Date;

import org.quartz.exceptions.SchedulerConfigException;
import org.quartz.exceptions.SchedulerException;

/**
 * 
 * NOTE: TimeBroker is not currently used in the Quartz code base.
 * 
 * 
 * The interface to be implemented by classes that want to provide a mechanism by which the {@link org.quartz.core.QuartzScheduler} can reliably determine the current time.
 * 
 * 
 * In general, the default implementation of this interface ({@link org.quartz.simpl.SimpleTimeBroker}- which simply uses System.getCurrentTimeMillis() )is sufficient. However situations may exist where this default scheme
 * is lacking in its robustness - especially when Quartz is used in a clustered configuration. For example, if one or more of the machines in the cluster has a system time that varies by more than a few seconds from the clocks on the other systems in
 * the cluster, scheduling confusion will result.
 * 
 * 
 * @see org.quartz.core.QuartzScheduler
 * @deprecated TimeBroker is not currently used in the Quartz code base.
 * @author James House
 */
public interface TimeBroker {

  /*
   * ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ Interface. ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
   */

  /**
   * 
   * Get the current time, as known by the TimeBroker.
   * 
   * 
   * @throws SchedulerException with the error code set to SchedulerException.ERR_TIME_BROKER_FAILURE
   */
  Date getCurrentTime() throws SchedulerException;

  /**
   * 
   * Called by the QuartzScheduler before the TimeBroker is used, in order to give the it a chance to initialize.
   * 
   */
  void initialize() throws SchedulerConfigException;

  /**
   * 
   * Called by the QuartzScheduler to inform the TimeBroker that it should free up all of it's resources because the scheduler is shutting down.
   * 
   */
  void shutdown();

}