org.quartz.core.JobRunShellFactory Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of logspace-jvm-agent Show documentation
The newest version!

/* 
 * 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.core;

import org.quartz.Scheduler;
import org.quartz.SchedulerConfigException;
import org.quartz.SchedulerException;
import org.quartz.spi.TriggerFiredBundle;

/**
 * 
 * Responsible for creating the instances of {@link JobRunShell}
 * to be used within the {@link QuartzScheduler} instance.
 * 
 * 
 * @author James House
 */
public interface JobRunShellFactory {

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

    /**
     * 
     * Initialize the factory, providing a handle to the Scheduler
     * that should be made available within the JobRunShell and
     * the JobExecutionContext s within it.
     * 
     */
    void initialize(Scheduler scheduler)
        throws SchedulerConfigException;

    /**
     * 
     * Called by the {@link org.quartz.core.QuartzSchedulerThread}
     * to obtain instances of {@link JobRunShell}.
     * 
     */
    JobRunShell createJobRunShell(TriggerFiredBundle bundle) throws SchedulerException;
}