org.quartz.spi.ThreadPool Maven / Gradle / Ivy
/*
* Copyright 2004-2005 OpenSymphony
*
* 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.
*
*/
/*
* Previously Copyright (c) 2001-2004 James House
*/
package org.quartz.spi;
import org.quartz.SchedulerConfigException;
/**
*
* The interface to be implemented by classes that want to provide a thread
* pool for the {@link org.quartz.core.QuartzScheduler}'s use.
*
*
* @see org.quartz.core.QuartzScheduler
*
* @author James House
*/
public interface ThreadPool {
/*
* ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
*
* Interface.
*
* ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
*/
/**
*
* Execute the given {@link java.lang.Runnable} in the next
* available Thread.
*
*
*
* The implementation of this interface should not throw exceptions unless
* there is a serious problem (i.e. a serious misconfiguration). If there
* are no available threads, rather it should either queue the Runnable, or
* block until a thread is available, depending on the desired strategy.
*
*/
public boolean runInThread(Runnable runnable);
/**
*
* Called by the QuartzScheduler before the ThreadPool is
* used, in order to give the it a chance to initialize.
*
*/
public void initialize() throws SchedulerConfigException;
/**
*
* Called by the QuartzScheduler to inform the ThreadPool
* that it should free up all of it's resources because the scheduler is
* shutting down.
*
*/
public void shutdown(boolean waitForJobsToComplete);
public int getPoolSize();
}