Package hudson.util

Class ProcessTree

java.lang.Object

hudson.util.ProcessTree

All Implemented Interfaces:

ProcessTreeRemoting.IProcessTree, Serializable, Iterable<ProcessTree.OSProcess>, org.jenkinsci.remoting.SerializableOnlyOverRemoting

Direct Known Subclasses:

ProcessTree.Local, ProcessTree.Remote

public abstract class ProcessTree
extends Object
implements Iterable<ProcessTree.OSProcess>, ProcessTreeRemoting.IProcessTree, org.jenkinsci.remoting.SerializableOnlyOverRemoting

Represents a snapshot of the process tree of the current system.

A ProcessTree is really conceptually a map from process ID to a ProcessTree.OSProcess object. When Hudson runs on platforms that support process introspection, this allows you to introspect and do some useful things on processes. On other platforms, the implementation falls back to "do nothing" behavior.

ProcessTree is remotable.

Since:

1.315

Author:

Kohsuke Kawaguchi

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	ProcessTree.Local	Represents a local process tree, where this JVM and the process tree run on the same system.
class	ProcessTree.OSProcess	Represents a process.
static interface	ProcessTree.ProcessCallable<T>	Code that gets executed on the machine where the ProcessTree.OSProcess is local.
static class	ProcessTree.Remote	Represents a process tree over a channel.
class	ProcessTree.UnixProcess	A process.

Field Summary

Fields

Modifier and Type	Field	Description
protected Map<Integer,ProcessTree.OSProcess>	processes	To be filled in the constructor of the derived type.

Method Summary

Modifier and Type	Method	Description
static ProcessTree	get()	Gets the ProcessTree of the current system that JVM runs in, or in the worst case return the default one that's not capable of killing descendants at all.
ProcessTree.OSProcess	get(int pid)	Gets the process given a specific ID, or null if no such process exists.
abstract ProcessTree.OSProcess	get(Process proc)	Try to convert Process into this process object or null if it fails (for example, maybe the snapshot is taken after this process has already finished.)
Iterator<ProcessTree.OSProcess>	iterator()	Lists all the processes in the system.
void	killAll(Process proc, Map<String,String> modelEnvVars)	Convenience method that does killAll(Map) and ProcessTree.OSProcess.killRecursively().
abstract void	killAll(Map<String,String> modelEnvVars)	Kills all the processes that have matching environment variables.

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Methods inherited from interface org.jenkinsci.remoting.SerializableOnlyOverRemoting

getChannelForSerialization

Field Detail

processes

protected final Map<Integer,ProcessTree.OSProcess> processes

To be filled in the constructor of the derived type.

Method Detail

get

@CheckForNull
public final ProcessTree.OSProcess get(int pid)

Gets the process given a specific ID, or null if no such process exists.

iterator

@NonNull
public final Iterator<ProcessTree.OSProcess> iterator()

Lists all the processes in the system.

Specified by:

iterator in interface Iterable<ProcessTree.OSProcess>

get

@CheckForNull
public abstract ProcessTree.OSProcess get(@NonNull
                                          Process proc)

Try to convert Process into this process object or null if it fails (for example, maybe the snapshot is taken after this process has already finished.)

killAll

public abstract void killAll(@NonNull
                             Map<String,String> modelEnvVars)
                      throws InterruptedException

Kills all the processes that have matching environment variables.

In this method, the method is given a "model environment variables", which is a list of environment variables and their values that are characteristic to the launched process. The implementation is expected to find processes in the system that inherit these environment variables, and kill them all. This is suitable for locating daemon processes that cannot be tracked by the regular ancestor/descendant relationship.

Specified by:

killAll in interface ProcessTreeRemoting.IProcessTree

Throws:

InterruptedException

killAll

public void killAll(@CheckForNull
                    Process proc,
                    @CheckForNull
                    Map<String,String> modelEnvVars)
             throws InterruptedException

Convenience method that does killAll(Map) and ProcessTree.OSProcess.killRecursively(). This is necessary to reliably kill the process and its descendants, as some OS may not implement killAll(Map). Either of the parameter can be null.

Throws:

InterruptedException

get

public static ProcessTree get()

Gets the ProcessTree of the current system that JVM runs in, or in the worst case return the default one that's not capable of killing descendants at all.