com.buabook.common.shutdown

Class ShutdownThread

java.lang.Object

java.lang.Thread

com.buabook.common.shutdown.ShutdownThread

All Implemented Interfaces:

Runnable

public class ShutdownThread
extends Thread

Shutdown Hook Thread

Provides a standard way of notifying when an application is shutting down.

Functions can be specified as ShutdownFunctions to be run serially as the application shuts down

(c) 2015 - 2017 Sport Trades Ltd

Since:

12 Jun 2015

Version:

1.1.0

Author:

Jas Rajasansir

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Thread

Thread.State, Thread.UncaughtExceptionHandler

Field Summary

Fields

Modifier and Type	Field and Description
private String	applicationName
private static org.slf4j.Logger	log
private List<ShutdownFunction>	shutdownFunctions

Fields inherited from class java.lang.Thread

MAX_PRIORITY, MIN_PRIORITY, NORM_PRIORITY

Constructor Summary

Constructors

Constructor and Description
ShutdownThread(String applicationName)
ShutdownThread(String applicationName, List<ShutdownFunction> shutdownFunctions)

Method Summary

Modifier and Type	Method and Description
ShutdownThread	addShutdownFunction(ShutdownFunction function)
static void	addShutdownListener(ShutdownThread thread) Adds the specified shutdown listener to be executed when the JVM signals its going to halt
void	run()

Methods inherited from class java.lang.Thread

activeCount, checkAccess, clone, countStackFrames, currentThread, destroy, dumpStack, enumerate, getAllStackTraces, getContextClassLoader, getDefaultUncaughtExceptionHandler, getId, getName, getPriority, getStackTrace, getState, getThreadGroup, getUncaughtExceptionHandler, holdsLock, interrupt, interrupted, isAlive, isDaemon, isInterrupted, join, join, join, resume, setContextClassLoader, setDaemon, setDefaultUncaughtExceptionHandler, setName, setPriority, setUncaughtExceptionHandler, sleep, sleep, start, stop, stop, suspend, toString, yield

Methods inherited from class java.lang.Object

equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

log

private static final org.slf4j.Logger log

applicationName

private final String applicationName

shutdownFunctions

private final List<ShutdownFunction> shutdownFunctions

Constructor Detail

ShutdownThread

public ShutdownThread(String applicationName)

ShutdownThread

public ShutdownThread(String applicationName,
                      List<ShutdownFunction> shutdownFunctions)
               throws IllegalArgumentException

Parameters:

applicationName - The name of the application for logging

shutdownFunctions - The list of functions that should be executed when the JVM signals it is exiting. This cannot be null.

Throws:

IllegalArgumentException - If either parameter is null

Method Detail

addShutdownFunction

public ShutdownThread addShutdownFunction(ShutdownFunction function)
                                   throws IllegalArgumentException,
                                          IllegalStateException

Throws:

IllegalArgumentException - If the function to add is null

IllegalStateException - If the thread is running when the add takes place

run

public void run()

Specified by:

run in interface Runnable

Overrides:

run in class Thread

addShutdownListener

public static void addShutdownListener(ShutdownThread thread)

Adds the specified shutdown listener to be executed when the JVM signals its going to halt