alma.acs.shutdown

Class ShutdownHookBase

java.lang.Object

java.lang.Thread

alma.acs.shutdown.ShutdownHookBase

All Implemented Interfaces:

java.lang.Runnable

Direct Known Subclasses:

ShutdownHook, ShutdownHook

public abstract class ShutdownHookBase
extends java.lang.Thread

A subclass can be registered to the JVM Runtime as a shutdown thread to be run at shutdown, both for regular termination and for interruption like Ctrl-C (SIGINT). Make sure to call setRegularShutdownExpected() before regularly exiting the JVM, as otherwise interruptDetected() would be called erroneously.

Recommended reading: http://www-106.ibm.com/developerworks/ibm/library/i-signalhandling/ (also talks about signals for tougher mishaps than Ctrl-c). See also Runtime.addShutdownHook(Thread)

Abstracted from the java container's shutdown hook, to simplify registering such hooks also in jlog etc.

Author:

hsommer

Nested Class Summary

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

java.lang.Thread.State, java.lang.Thread.UncaughtExceptionHandler

Field Summary

Fields

Modifier and Type	Field and Description
protected java.util.logging.Logger	logger
protected boolean	m_regularShutdownExpected
protected java.lang.String	processName

Fields inherited from class java.lang.Thread

MAX_PRIORITY, MIN_PRIORITY, NORM_PRIORITY

Constructor Summary

Constructors

Constructor and Description
ShutdownHookBase(java.util.logging.Logger logger, java.lang.String processName)

Method Summary

Modifier and Type	Method and Description
protected abstract void	interruptDetected() Is called when the JVM is about to terminate due to an interrupt signal.
protected void	regularTermination() Subclasses can override this method to log nothing or something else.
void	run()
void	setRegularShutdownExpected() Must be called right before the program ends.

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

m_regularShutdownExpected

protected volatile boolean m_regularShutdownExpected

logger

protected final java.util.logging.Logger logger

processName

protected final java.lang.String processName

Constructor Detail

ShutdownHookBase

public ShutdownHookBase(java.util.logging.Logger logger,
                        java.lang.String processName)

Parameters:

logger - The logger to be used by this object.

processName - Used as the thread name, with "ShutdownHook" appended.

Method Detail

run

public void run()

Specified by:

run in interface java.lang.Runnable

Overrides:

run in class java.lang.Thread

See Also:

Runnable.run()

regularTermination

protected void regularTermination()

Subclasses can override this method to log nothing or something else. No other action is expected in the overridden method.

interruptDetected

protected abstract void interruptDetected()

Is called when the JVM is about to terminate due to an interrupt signal. Subclasses should perform emergency cleanup.

setRegularShutdownExpected

public void setRegularShutdownExpected()

Must be called right before the program ends. This helps the ShutdownHook to decide whether it's being called for a regular program termination or because of an interrupt.