org.apache.commons.exec

Class ShutdownHookProcessDestroyer

java.lang.Object

org.apache.commons.exec.ShutdownHookProcessDestroyer

All Implemented Interfaces:

java.lang.Runnable, ProcessDestroyer

public class ShutdownHookProcessDestroyer
extends java.lang.Object
implements ProcessDestroyer, java.lang.Runnable

Destroys all registered Processes when the VM exits.

Version:

$Id: ShutdownHookProcessDestroyer.java 1636056 2014-11-01 21:12:52Z ggregory $

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
private class	ShutdownHookProcessDestroyer.ProcessDestroyerImpl

Field Summary

Fields

Modifier and Type	Field and Description
private boolean	added Whether or not this ProcessDestroyer has been registered as a shutdown hook
private ShutdownHookProcessDestroyer.ProcessDestroyerImpl	destroyProcessThread The thread registered at the JVM to execute the shutdown handler
private java.util.Vector<java.lang.Process>	processes the list of currently running processes
private boolean	running Whether or not this ProcessDestroyer is currently running as shutdown hook

Constructor Summary

Constructors

Constructor and Description
ShutdownHookProcessDestroyer() Constructs a ProcessDestroyer and obtains Runtime.addShutdownHook() and Runtime.removeShutdownHook() through reflection.

Method Summary

Modifier and Type	Method and Description
boolean	add(java.lang.Process process) Returns true if the specified Process was successfully added to the list of processes to destroy upon VM exit.
private void	addShutdownHook() Registers this ProcessDestroyer as a shutdown hook, uses reflection to ensure pre-JDK 1.3 compatibility.
boolean	isAddedAsShutdownHook() Returns whether or not the ProcessDestroyer is registered as as shutdown hook
boolean	remove(java.lang.Process process) Returns true if the specified Process was successfully removed from the list of processes to destroy upon VM exit.
private void	removeShutdownHook() Removes this ProcessDestroyer as a shutdown hook, uses reflection to ensure pre-JDK 1.3 compatibility
void	run() Invoked by the VM when it is exiting.
int	size() Returns the number of registered processes.

Methods inherited from class java.lang.Object

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

Field Detail

processes

private final java.util.Vector<java.lang.Process> processes

the list of currently running processes

destroyProcessThread

private ShutdownHookProcessDestroyer.ProcessDestroyerImpl destroyProcessThread

The thread registered at the JVM to execute the shutdown handler

added

private boolean added

Whether or not this ProcessDestroyer has been registered as a shutdown hook

running

private volatile boolean running

Whether or not this ProcessDestroyer is currently running as shutdown hook

Constructor Detail

ShutdownHookProcessDestroyer

public ShutdownHookProcessDestroyer()

Constructs a ProcessDestroyer and obtains Runtime.addShutdownHook() and Runtime.removeShutdownHook() through reflection. The ProcessDestroyer manages a list of processes to be destroyed when the VM exits. If a process is added when the list is empty, this ProcessDestroyer is registered as a shutdown hook. If removing a process results in an empty list, the ProcessDestroyer is removed as a shutdown hook.

Method Detail

addShutdownHook

private void addShutdownHook()

Registers this ProcessDestroyer as a shutdown hook, uses reflection to ensure pre-JDK 1.3 compatibility.

removeShutdownHook

private void removeShutdownHook()

Removes this ProcessDestroyer as a shutdown hook, uses reflection to ensure pre-JDK 1.3 compatibility

isAddedAsShutdownHook

public boolean isAddedAsShutdownHook()

Returns whether or not the ProcessDestroyer is registered as as shutdown hook

Returns:

true if this is currently added as shutdown hook

add

public boolean add(java.lang.Process process)

Returns true if the specified Process was successfully added to the list of processes to destroy upon VM exit.

Specified by:

add in interface ProcessDestroyer

Parameters:

process - the process to add

Returns:

true if the specified Process was successfully added

remove

public boolean remove(java.lang.Process process)

Returns true if the specified Process was successfully removed from the list of processes to destroy upon VM exit.

Specified by:

remove in interface ProcessDestroyer

Parameters:

process - the process to remove

Returns:

true if the specified Process was successfully removed

size

public int size()

Returns the number of registered processes.

Specified by:

size in interface ProcessDestroyer

Returns:

the number of register process

run

public void run()

Invoked by the VM when it is exiting.

Specified by:

run in interface java.lang.Runnable