com.tplan.robot

Class ShutdownHook

java.lang.Object

java.lang.Thread

com.tplan.robot.ShutdownHook

All Implemented Interfaces:

ActionListener, Runnable, EventListener

public class ShutdownHook
extends Thread
implements ActionListener

Custom hook assuring a clean application shut down when Java Virtual Machine (JVM) gets terminated.

An instance of this class is created and hooked into the JVM for each automated thread. It gets invoked by Java when a request to terminate the JVM is detected, e.g. through Ctrl+C in the system console. The hook takes care of clean shutdown of the executed test script (if any) and proper termination of any existing server connection.

T-Plan Robot Enterprise, (C) 2009-2025 T-Plan Limited. All rights reserved.

Nested Class Summary

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

Thread.State, Thread.UncaughtExceptionHandler

Field Summary

Fields inherited from class java.lang.Thread

MAX_PRIORITY, MIN_PRIORITY, NORM_PRIORITY

Constructor Summary

Constructors

Constructor and Description
ShutdownHook(ScriptManager scriptManager, RemoteDesktopClient client) Constructor.

Method Summary

Modifier and Type	Method and Description
void	actionPerformed(ActionEvent ae) Implementation of the ActionListener interface allowing to run the thread code in the GUI mode with the progress bar displayed using ProgressDialog.runAWTTask(java.awt.event.ActionListener, java.lang.String, java.lang.String)
void	addClient(RemoteDesktopClient client) Add a desktop client to be closed (disconnected) eventually on JVM shutdown.
static ShutdownHook	getGlobalHook() Get the default singleton hook instance registered with the runtime.
boolean	isCompleted() Indicates whether the shutdown routine has been completed successfully.
boolean	isShutdownInProgress() Indicate whether the hook has been started, i.e.
void	run() Implementation of the java.lang.Runnable interface.
void	setCompleted(boolean completed) Set a flag indicating that the shutdown routine is already completed and should not be performed again.
void	setShutdownReason(String shutdownReason) Set the shutdown reason.
void	setTimeoutMillis(int timeoutMillis) Set the custom shutdown timeout.

Methods inherited from class java.lang.Thread

activeCount, checkAccess, 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, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

ShutdownHook

public ShutdownHook(ScriptManager scriptManager,
                    RemoteDesktopClient client)

Constructor.

Parameters:

scriptManager - a script manager instance.

client - a desktop client.

Method Detail

getGlobalHook

public static ShutdownHook getGlobalHook()

Get the default singleton hook instance registered with the runtime. Use its addClient(com.tplan.robot.remoteclient.RemoteDesktopClient) and addModule(com.tplan.robot.CLIModule) (package access) methods to add objects to be closed down properly on the JVM shut down.

Returns:

the default hook instance.

Since:

4.4.3

run

public final void run()

Implementation of the java.lang.Runnable interface. This method gets executed when the encapsulating thread is started.

Specified by:

run in interface Runnable

Overrides:

run in class Thread

addClient

public final void addClient(RemoteDesktopClient client)

Add a desktop client to be closed (disconnected) eventually on JVM shutdown.

Parameters:

client - a client.

Since:

4.4.3

actionPerformed

public void actionPerformed(ActionEvent ae)

Implementation of the ActionListener interface allowing to run the thread code in the GUI mode with the progress bar displayed using ProgressDialog.runAWTTask(java.awt.event.ActionListener, java.lang.String, java.lang.String)

Specified by:

actionPerformed in interface ActionListener

Parameters:

ae - an action event.

Since:

4.4.3

isShutdownInProgress

public boolean isShutdownInProgress()

Indicate whether the hook has been started, i.e. if the JVM is shutting down.

Returns:

true if the hook has been started as part of the JVM shut down or false otherwise.

Since:

4.4.6

setTimeoutMillis

public void setTimeoutMillis(int timeoutMillis)

Set the custom shutdown timeout.

Parameters:

timeoutMillis - the timeout in milliseconds. The default value is 60,000 milliseconds (60 seconds).

Since:

7.2.6

isCompleted

public boolean isCompleted()

Indicates whether the shutdown routine has been completed successfully.

Returns:

true if completed or false if not yet done, in progress, crashed or timed out.

Since:

7.2.6

setCompleted

public void setCompleted(boolean completed)

Set a flag indicating that the shutdown routine is already completed and should not be performed again. It is used to set off the already registered JVM hook.

Parameters:

completed - true to set off (disable) the hook.

Since:

7.2.6

setShutdownReason

public void setShutdownReason(String shutdownReason)

Set the shutdown reason. It gets typically propagated to the report.

Parameters:

shutdownReason - the shut down reason (justification).

Since:

7.2.12