org.waarp.common.utility

Class WaarpShutdownHook

java.lang.Object

java.lang.Thread

org.waarp.common.utility.WaarpShutdownHook

All Implemented Interfaces:

Runnable

Direct Known Subclasses:

FtpShutdownHook, R66ShutdownHook

public abstract class WaarpShutdownHook
extends Thread

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	WaarpShutdownHook.ShutdownConfiguration Class for argument of creation of WaarpShutdownHook

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

Thread.State, Thread.UncaughtExceptionHandler

Field Summary

Fields

Modifier and Type	Field and Description
static WaarpShutdownHook	shutdownHook Thread for ShutdownHook

Fields inherited from class java.lang.Thread

MAX_PRIORITY, MIN_PRIORITY, NORM_PRIORITY

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	WaarpShutdownHook(WaarpShutdownHook.ShutdownConfiguration configuration)

Method Summary

Modifier and Type	Method and Description
static void	addShutdownHook() For Server part
protected abstract void	exitService() Real exit function
WaarpShutdownHook.ShutdownConfiguration	getShutdownConfiguration()
static boolean	isInShutdown() Says if the Process is currently in shutdown
static boolean	isRestart()
static boolean	isShutdownStarting()
void	launchFinalExit() Extra call to ensure exit after long delay
static void	registerMain(Class<?> main, String[] args) Called to setup main class and args to enable restart
static void	removeShutdownHook() For Server part
void	run()
static void	setRestart(boolean toRestart) Set the way software should shutdown: with (true) or without restart (false)
static void	shutdownWillStart() To specify that shutdown will soon start
static void	terminate(boolean immediateSet) This function is the top function to be called when the process is to be shutdown.

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

shutdownHook

public static WaarpShutdownHook shutdownHook

Thread for ShutdownHook

Constructor Detail

WaarpShutdownHook

protected WaarpShutdownHook(WaarpShutdownHook.ShutdownConfiguration configuration)

Method Detail

getShutdownConfiguration

public WaarpShutdownHook.ShutdownConfiguration getShutdownConfiguration()

Returns:

the current ShutdownConfiguration

addShutdownHook

public static void addShutdownHook()

For Server part

isInShutdown

public static boolean isInShutdown()

Says if the Process is currently in shutdown

Returns:

True if already in shutdown

isShutdownStarting

public static boolean isShutdownStarting()

Returns:

True if the Shutdown process will start soon

shutdownWillStart

public static void shutdownWillStart()

To specify that shutdown will soon start

terminate

public static void terminate(boolean immediateSet)

This function is the top function to be called when the process is to be shutdown.

Parameters:

immediateSet -

removeShutdownHook

public static void removeShutdownHook()

For Server part

exitService

protected abstract void exitService()

Real exit function

isRestart

public static boolean isRestart()

Returns:

True if the shutdown should be followed by a restart

launchFinalExit

public void launchFinalExit()

Extra call to ensure exit after long delay

setRestart

public static void setRestart(boolean toRestart)

Set the way software should shutdown: with (true) or without restart (false)

Parameters:

toRestart -

registerMain

public static void registerMain(Class<?> main,
                                String[] args)

Called to setup main class and args to enable restart

Parameters:

main -

args -

run

public void run()

Specified by:

run in interface Runnable

Overrides:

run in class Thread