org.quartz.core.QuartzSchedulerResources Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of sundial Show documentation
Show all versions of sundial Show documentation
A Lightweight Job Scheduling Framework forked from Quartz
/**
* Copyright 2015 Knowm Inc. (http://knowm.org) and contributors.
* Copyright 2013-2015 Xeiam LLC (http://xeiam.com) and contributors.
* Copyright 2001-2011 Terracotta Inc. (http://terracotta.org).
*
* 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 java.util.ArrayList;
import java.util.List;
import org.quartz.QuartzScheduler;
import org.quartz.plugins.SchedulerPlugin;
/**
*
* Contains all of the resources (JobStore,ThreadPool, etc.) necessary to create a {@link QuartzScheduler}
* instance.
*
*
* @see QuartzScheduler
* @author James House
*/
public class QuartzSchedulerResources {
private String threadName;
private ThreadPool threadPool;
private JobStore jobStore;
private JobRunShellFactory jobRunShellFactory;
private List schedulerPlugins = new ArrayList(10);
private boolean makeSchedulerThreadDaemon = false;
private boolean threadsInheritInitializersClassLoadContext = false;
private long batchTimeWindow;
private int maxBatchSize;
private boolean interruptJobsOnShutdown = false;
private boolean interruptJobsOnShutdownWithWait = false;
/**
*
* Create an instance with no properties initialized.
*
*/
public QuartzSchedulerResources() {
// do nothing...
}
/**
*
* Get the name for the {@link QuartzSchedulerThread}.
*
*/
public String getThreadName() {
return threadName;
}
/**
*
* Set the name for the {@link QuartzSchedulerThread}.
*
*
* @exception IllegalArgumentException if name is null or empty.
*/
public void setThreadName(String threadName) {
if (threadName == null || threadName.trim().length() == 0) {
throw new IllegalArgumentException("Scheduler thread name cannot be empty.");
}
this.threadName = threadName;
}
/**
*
* Get the {@link ThreadPool} for the {@link QuartzScheduler} to use.
*
*/
public ThreadPool getThreadPool() {
return threadPool;
}
/**
*
* Set the {@link ThreadPool} for the {@link QuartzScheduler} to use.
*
*
* @exception IllegalArgumentException if threadPool is null.
*/
public void setThreadPool(ThreadPool threadPool) {
if (threadPool == null) {
throw new IllegalArgumentException("ThreadPool cannot be null.");
}
this.threadPool = threadPool;
}
/**
*
* Get the {@link JobStore} for the {@link QuartzScheduler} to use.
*
*/
public JobStore getJobStore() {
return jobStore;
}
/**
*
* Set the {@link JobStore} for the {@link QuartzScheduler} to use.
*
*
* @exception IllegalArgumentException if jobStore is null.
*/
public void setJobStore(JobStore jobStore) {
if (jobStore == null) {
throw new IllegalArgumentException("JobStore cannot be null.");
}
this.jobStore = jobStore;
}
/**
*
* Get the {@link JobRunShellFactory} for the {@link QuartzScheduler} to use.
*
*/
public JobRunShellFactory getJobRunShellFactory() {
return jobRunShellFactory;
}
/**
*
* Set the {@link JobRunShellFactory} for the {@link QuartzScheduler} to use.
*
*
* @exception IllegalArgumentException if jobRunShellFactory is null.
*/
public void setJobRunShellFactory(JobRunShellFactory jobRunShellFactory) {
if (jobRunShellFactory == null) {
throw new IllegalArgumentException("JobRunShellFactory cannot be null.");
}
this.jobRunShellFactory = jobRunShellFactory;
}
/**
*
* Add the given {@link org.quartz.plugins.SchedulerPlugin} for the {@link QuartzScheduler} to use. This method expects
* the plugin's "initialize" method to be invoked externally (either before or after this method is called).
*
*/
public void addSchedulerPlugin(SchedulerPlugin plugin) {
schedulerPlugins.add(plugin);
}
/**
*
* Get the List of all {@link org.quartz.plugins.SchedulerPlugin}s for the {@link QuartzScheduler} to use.
*
*/
public List getSchedulerPlugins() {
return schedulerPlugins;
}
/**
* Get whether to mark the Quartz scheduling thread as daemon.
*
* @see Thread#setDaemon(boolean)
*/
public boolean getMakeSchedulerThreadDaemon() {
return makeSchedulerThreadDaemon;
}
/**
* Set whether to mark the Quartz scheduling thread as daemon.
*
* @see Thread#setDaemon(boolean)
*/
public void setMakeSchedulerThreadDaemon(boolean makeSchedulerThreadDaemon) {
this.makeSchedulerThreadDaemon = makeSchedulerThreadDaemon;
}
/**
* Get whether to set the class load context of spawned threads to that of the initializing thread.
*/
public boolean isThreadsInheritInitializersClassLoadContext() {
return threadsInheritInitializersClassLoadContext;
}
/**
* Set whether to set the class load context of spawned threads to that of the initializing thread.
*/
public void setThreadsInheritInitializersClassLoadContext(boolean threadsInheritInitializersClassLoadContext) {
this.threadsInheritInitializersClassLoadContext = threadsInheritInitializersClassLoadContext;
}
public long getBatchTimeWindow() {
return batchTimeWindow;
}
public void setBatchTimeWindow(long batchTimeWindow) {
this.batchTimeWindow = batchTimeWindow;
}
public int getMaxBatchSize() {
return maxBatchSize;
}
public void setMaxBatchSize(int maxBatchSize) {
this.maxBatchSize = maxBatchSize;
}
public boolean isInterruptJobsOnShutdown() {
return interruptJobsOnShutdown;
}
public void setInterruptJobsOnShutdown(boolean interruptJobsOnShutdown) {
this.interruptJobsOnShutdown = interruptJobsOnShutdown;
}
public boolean isInterruptJobsOnShutdownWithWait() {
return interruptJobsOnShutdownWithWait;
}
public void setInterruptJobsOnShutdownWithWait(boolean interruptJobsOnShutdownWithWait) {
this.interruptJobsOnShutdownWithWait = interruptJobsOnShutdownWithWait;
}
}