io.logspace.agent.shaded.quartz.SchedulerFactory Maven / Gradle / Ivy
/*
* 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 io.logspace.agent.shaded.quartz;
import java.util.Collection;
/**
* Provides a mechanism for obtaining client-usable handles to Scheduler
* instances.
*
* @see Scheduler
* @see io.logspace.agent.shaded.quartz.impl.StdSchedulerFactory
*
* @author James House
*/
public interface SchedulerFactory {
/*
* ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
*
* Interface.
*
* ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
*/
/**
*
* Returns a client-usable handle to a Scheduler.
*
*
* @throws SchedulerException
* if there is a problem with the underlying Scheduler.
*/
Scheduler getScheduler() throws SchedulerException;
/**
*
* Returns a handle to the Scheduler with the given name, if it exists.
*
*/
Scheduler getScheduler(String schedName) throws SchedulerException;
/**
*
* Returns handles to all known Schedulers (made by any SchedulerFactory
* within this jvm.).
*
*/
Collection getAllSchedulers() throws SchedulerException;
}