io.logspace.agent.shaded.quartz.plugins.management.ShutdownHookPlugin Maven / Gradle / Ivy
/*
* 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 io.logspace.agent.shaded.quartz.plugins.management;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import io.logspace.agent.shaded.quartz.Scheduler;
import io.logspace.agent.shaded.quartz.SchedulerException;
import io.logspace.agent.shaded.quartz.spi.ClassLoadHelper;
import io.logspace.agent.shaded.quartz.spi.SchedulerPlugin;
/**
* This plugin catches the event of the JVM terminating (such as upon a CRTL-C)
* and tells the scheuler to shutdown.
*
* @see io.logspace.agent.shaded.quartz.Scheduler#shutdown(boolean)
*
* @author James House
*/
public class ShutdownHookPlugin implements SchedulerPlugin {
/*
* ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
*
* Data members.
*
* ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
*/
private boolean cleanShutdown = true;
private final Logger log = LoggerFactory.getLogger(getClass());
/*
* ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
*
* Constructors.
*
* ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
*/
public ShutdownHookPlugin() {
}
/*
* ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
*
* Interface.
*
* ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
*/
/**
* Determine whether or not the plug-in is configured to cause a clean
* shutdown of the scheduler.
*
*
* The default value is true.
*
*
* @see io.logspace.agent.shaded.quartz.Scheduler#shutdown(boolean)
*/
public boolean isCleanShutdown() {
return cleanShutdown;
}
/**
* Set whether or not the plug-in is configured to cause a clean shutdown
* of the scheduler.
*
*
* The default value is true.
*
*
* @see io.logspace.agent.shaded.quartz.Scheduler#shutdown(boolean)
*/
public void setCleanShutdown(boolean b) {
cleanShutdown = b;
}
protected Logger getLog() {
return log;
}
/*
* ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
*
* SchedulerPlugin Interface.
*
* ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
*/
/**
*
* Called during creation of the Scheduler in order to give
* the SchedulerPlugin a chance to initialize.
*
*
* @throws SchedulerConfigException
* if there is an error initializing.
*/
public void initialize(String name, final Scheduler scheduler, ClassLoadHelper classLoadHelper)
throws SchedulerException {
getLog().info("Registering Quartz shutdown hook.");
Thread t = new Thread("Quartz Shutdown-Hook "
+ scheduler.getSchedulerName()) {
@Override
public void run() {
getLog().info("Shutting down Quartz...");
try {
scheduler.shutdown(isCleanShutdown());
} catch (SchedulerException e) {
getLog().info(
"Error shutting down Quartz: " + e.getMessage(), e);
}
}
};
Runtime.getRuntime().addShutdownHook(t);
}
public void start() {
// do nothing.
}
/**
*
* Called in order to inform the SchedulerPlugin that it
* should free up all of it's resources because the scheduler is shutting
* down.
*
*/
public void shutdown() {
// nothing to do in this case (since the scheduler is already shutting
// down)
}
}
// EOF