org.quartz.core.StandardJobRunShellFactory 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.core;

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

/**
 * 
 * Responsible for creating the instances of a {@link JobRunShell} to be used within the {@link org.quartz.core.QuartzScheduler}  instance. It will create a standard {@link JobRunShell} unless the job class has the
 * {@link ExecuteInJTATransaction} annotation in which case it will create a {@link JTAJobRunShell}.
 * 
 * 
 * This implementation does not re-use any objects, it simply makes a new JTAJobRunShell each time borrowJobRunShell() is called.
 * 
 * 
 * @author James House
 */
public class StandardJobRunShellFactory implements JobRunShellFactory {

  /*
   * ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ Data members. ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
   */

  private Scheduler scheduler;

  /*
   * ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ Constructors. ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
   */

  public StandardJobRunShellFactory() {

  }

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

  /**
   * 
   * Initialize the factory, providing a handle to the Scheduler that should be made available within the JobRunShell and the JobExecutionContext s within it, and a handle to the SchedulingContext
   * that the shell will use in its own operations with the JobStore.
   * 
   */
  @Override
  public void initialize(Scheduler scheduler) throws SchedulerConfigException {

    this.scheduler = scheduler;
  }

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

    return new JobRunShell(scheduler, bundle);
  }

}