Open Source Repository

Home /spring/spring-context-support-3.0.5 | Repository Home



org/springframework/scheduling/quartz/SimpleThreadPoolTaskExecutor.java
/*
 * Copyright 2002-2009 the original author or authors.
 *
 * 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.springframework.scheduling.quartz;

import java.util.concurrent.Callable;
import java.util.concurrent.Future;
import java.util.concurrent.FutureTask;

import org.quartz.SchedulerConfigException;
import org.quartz.simpl.SimpleThreadPool;

import org.springframework.beans.factory.DisposableBean;
import org.springframework.beans.factory.InitializingBean;
import org.springframework.scheduling.SchedulingException;
import org.springframework.scheduling.SchedulingTaskExecutor;
import org.springframework.util.Assert;

/**
 * Subclass of Quartz's SimpleThreadPool that implements Spring's
 {@link org.springframework.core.task.TaskExecutor} interface
 * and listens to Spring lifecycle callbacks.
 *
 <p>Can be shared between a Quartz Scheduler (specified as "taskExecutor")
 * and other TaskExecutor users, or even used completely independent of
 * a Quartz Scheduler (as plain TaskExecutor backend).
 *
 @author Juergen Hoeller
 @since 2.0
 @see org.quartz.simpl.SimpleThreadPool
 @see org.springframework.core.task.TaskExecutor
 @see SchedulerFactoryBean#setTaskExecutor
 */
public class SimpleThreadPoolTaskExecutor extends SimpleThreadPool
    implements SchedulingTaskExecutor, InitializingBean, DisposableBean {

  private boolean waitForJobsToCompleteOnShutdown = false;


  /**
   * Set whether to wait for running jobs to complete on shutdown.
   * Default is "false".
   @see org.quartz.simpl.SimpleThreadPool#shutdown(boolean)
   */
  public void setWaitForJobsToCompleteOnShutdown(boolean waitForJobsToCompleteOnShutdown) {
    this.waitForJobsToCompleteOnShutdown = waitForJobsToCompleteOnShutdown;
  }

  public void afterPropertiesSet() throws SchedulerConfigException {
    initialize();
  }


  public void execute(Runnable task) {
    Assert.notNull(task, "Runnable must not be null");
    if (!runInThread(task)) {
      throw new SchedulingException("Quartz SimpleThreadPool already shut down");
    }
  }

  public void execute(Runnable task, long startTimeout) {
    execute(task);
  }

  public Future<?> submit(Runnable task) {
    FutureTask<Object> future = new FutureTask<Object>(task, null);
    execute(future);
    return future;
  }

  public <T> Future<T> submit(Callable<T> task) {
    FutureTask<T> future = new FutureTask<T>(task);
    execute(future);
    return future;
  }

  /**
   * This task executor prefers short-lived work units.
   */
  public boolean prefersShortLivedTasks() {
    return true;
  }


  public void destroy() {
    shutdown(this.waitForJobsToCompleteOnShutdown);
  }

}