hydra

Class ProcessMgr

java.lang.Object

hydra.ProcessMgr

public class ProcessMgr
extends Object

This class provides support for managing processes. It is used to execute and terminate processes, in the foreground and background, on local and remote hosts, and on UNIX and Windows platforms. It is also used to get information about the local host, the current process, or a process specified by its host and PID.

Constructor Summary

Constructors

Constructor and Description
ProcessMgr()

Method Summary

Modifier and Type	Method and Description
static int	bgexec(String command) Starts a background process on the local host and returns the PID.
static int	bgexec(String host, String command) Starts a background process on the specified host and returns the PID.
static int	bgexec(String command, String workdir, String logfile) Starts a background process on the local host and returns the PID.
static int	bgexec(String host, String command, String workdir, String logfile) Starts a background process on the specified host and returns the PID.
static void	dumpHeap(String host, int pid, String userDir, String options) Does a heap dump on a process.
static String	fgexec(String[] command, int maxWaitSec) Starts a foreground process on the local host, waits for it to complete, and returns the output.
static String	fgexec(String command, int maxWaitSec) Starts a foreground process on the local host, waits for it to complete, and returns the output.
static String	fgexec(String command, String[] envp, int maxWaitSec) Starts a foreground process on the local host, waits for it to complete, and returns the output.
static String	fgexec(String host, String command, int maxWaitSec) Starts a foreground process on the specified host, waits for it to complete, and returns the output.
static String	fgexec(String host, String command, String[] envp, int maxWaitSec) Starts a foreground process on the specified host, waits for it to complete, and returns the output.
static String	getMemoryStatus(int maxWaitSec) Returns the memory usage for the local host.
static int	getProcessId() Returns the process ID for this process.
static String	getProcessStatus(int maxWaitSec) Returns the process status for the local host (for all users).
static String	getProcessStatus(String host, int maxWaitSec) Returns the process status for the given host (for all users).
static void	killProcess(String host, int pid) Kills a process without warning.
static boolean	killProcessWait(String host, int pid, int maxWaitSec) Kills a process without warning and waits up to maxWaitSec for this to occur.
static void	logNetworkStatistics() Logs network statistics.
static void	printProcessStacks(String host, int pid) Does a thread stack dump on a process.
static String	processAndBuildInfoString() Returns a formatted String containing various information about the runtime environment of this process: host, PID, user name, user.name, user.home, user.dir, os.name, os.arch, os.version, java.version, java.vm.vendor, java.home, java.class.path, and java.library.path.
static boolean	processExists(String host, int pid) Tests whether a process exists.
static void	setReadPermission(String dir) Gives read permission on all files in the given directory to all users.
static void	shutdownProcess(String host, int pid) Tells a process to shut down.
static boolean	shutdownProcessWait(String host, int pid, int maxWaitSec) Tells a process to shut down and waits up to maxWaitSec for this to occur.
static boolean	waitForDeath(String host, int pid, int maxWaitSec) Waits up to maxWaitSec for a process to die.
static boolean	waitForLife(String host, int pid, int maxWaitSec) Waits up to maxWaitSec for a process to live.

Methods inherited from class java.lang.Object

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

Constructor Detail

ProcessMgr

public ProcessMgr()

Method Detail

getProcessId

public static int getProcessId()

Returns the process ID for this process.

Uses the RuntimeMXBean. There is no guarantee that this returns a PID, but it currently works on all platforms supported by hydra.

Throws:

HydraRuntimeException - if there is a problem getting the PID from the RuntimeMXBean

fgexec

public static String fgexec(String command,
                            int maxWaitSec)

Starts a foreground process on the local host, waits for it to complete, and returns the output.

Parameters:

host - the host on which to start the process.

command - the command to run.

maxWaitSec - the maximum amount of time to wait before timing out.

Returns:

the output of the command, both stdout and stderr.

Throws:

HydraRuntimeException - if the process cannot be created or its exit code is non-zero.

HydraTimeoutException - if the command times out.

fgexec

public static String fgexec(String command,
                            String[] envp,
                            int maxWaitSec)

Starts a foreground process on the local host, waits for it to complete, and returns the output.

Parameters:

host - the host on which to start the process.

command - the command to run.

envp - the environment for the command.

maxWaitSec - the maximum amount of time to wait before timing out.

Returns:

the output of the command, both stdout and stderr.

Throws:

HydraRuntimeException - if the process cannot be created or its exit code is non-zero.

HydraTimeoutException - if the command times out.

fgexec

public static String fgexec(String[] command,
                            int maxWaitSec)

Starts a foreground process on the local host, waits for it to complete, and returns the output.

Parameters:

host - the host on which to start the process.

command - the command to run.

maxWaitSec - the maximum amount of time to wait before timing out.

Returns:

the output of the command, both stdout and stderr.

Throws:

HydraRuntimeException - if the process cannot be created or its exit code is non-zero.

HydraTimeoutException - if the command times out.

fgexec

public static String fgexec(String host,
                            String command,
                            int maxWaitSec)

Starts a foreground process on the specified host, waits for it to complete, and returns the output.

Parameters:

host - the host on which to start the process.

command - the command to run.

maxWaitSec - the maximum amount of time to wait before timing out.

Returns:

the output of the command, both stdout and stderr.

Throws:

HydraRuntimeException - if the process cannot be created or its exit code is non-zero.

HydraTimeoutException - if the command times out.

fgexec

public static String fgexec(String host,
                            String command,
                            String[] envp,
                            int maxWaitSec)

Starts a foreground process on the specified host, waits for it to complete, and returns the output.

Parameters:

host - the host on which to start the process.

command - the command to run.

envp - the environment for the command.

maxWaitSec - the maximum amount of time to wait before timing out.

Returns:

the output of the command, both stdout and stderr.

Throws:

HydraRuntimeException - if the process cannot be created or its exit code is non-zero.

HydraTimeoutException - if the command times out.

bgexec

public static int bgexec(String command)

Starts a background process on the local host and returns the PID. The user directory for the process is the caller's current directory. Process output is written to a file in this directory with a default name of the form bgexec_.log.

Parameters:

command - the command to run.

Returns:

the PID.

Throws:

HydraRuntimeException - if the process cannot be created.

bgexec

public static int bgexec(String host,
                         String command)

Starts a background process on the specified host and returns the PID. The user directory for the process is the caller's current directory. Process output is written to a file in this directory with a default name of the form bgexec_.log.

Parameters:

host - the host on which to start the process.

command - the command to run.

Returns:

the PID.

Throws:

HydraRuntimeException - if the process cannot be created.

bgexec

public static int bgexec(String command,
                         String workdir,
                         String logfile)

Starts a background process on the local host and returns the PID. The user directory for the process is set to the specified directory. Process output is written to a file with the specified name in this directory.

Parameters:

command - the command to run.

workdir - the user directory for the process.

logfile - the name of the file containing process output.

Returns:

the PID.

Throws:

HydraRuntimeException - if the process cannot be created.

bgexec

public static int bgexec(String host,
                         String command,
                         String workdir,
                         String logfile)

Starts a background process on the specified host and returns the PID. The user directory for the process is set to the specified directory. Process output is written to a file with the specified name in this directory.

Parameters:

host - the host on which to start the process.

command - the command to run.

workdir - the user directory for the process.

logfile - the name of the file containing process output.

Returns:

the PID.

Throws:

HydraRuntimeException - if the process cannot be created.

processExists

public static boolean processExists(String host,
                                    int pid)

Tests whether a process exists.

Parameters:

host - the host the process is running on.

pid - its PID.

Returns:

true if the process exists.

shutdownProcess

public static void shutdownProcess(String host,
                                   int pid)

Tells a process to shut down. This method does not wait for the process to shut down. If the process does not exist, it has no effect.

Parameters:

host - the host the process is running on.

pid - its PID.

killProcess

public static void killProcess(String host,
                               int pid)

Kills a process without warning. This method does not wait for the process to die. If the process does not exist, it has no effect.

Parameters:

host - the host the process is running on.

pid - its PID.

printProcessStacks

public static void printProcessStacks(String host,
                                      int pid)

Does a thread stack dump on a process. If the process does not exist, it has no effect.

Parameters:

host - the host the process is running on.

pid - its PID.

dumpHeap

public static void dumpHeap(String host,
                            int pid,
                            String userDir,
                            String options)

Does a heap dump on a process. If the process does not exist, it has no effect.

Parameters:

host - the host the process is running on.

pid - its PID.

logNetworkStatistics

public static void logNetworkStatistics()

Logs network statistics. This method throws no exceptions. If an error occurs, the stack is logged at info level.

shutdownProcessWait

public static boolean shutdownProcessWait(String host,
                                          int pid,
                                          int maxWaitSec)

Tells a process to shut down and waits up to maxWaitSec for this to occur. Returns false if the process still exists after this time limit has expired, otherwise it returns true.

Parameters:

host - the host the process is running on.

pid - its PID.

maxWaitSec - the maximum number of seconds to wait for the process to shut down.

Returns:

true if the process no longer exists

killProcessWait

public static boolean killProcessWait(String host,
                                      int pid,
                                      int maxWaitSec)

Kills a process without warning and waits up to maxWaitSec for this to occur. Returns false if the process still exists after this time limit has expired, otherwise it returns true.

Parameters:

host - the host the process is running on.

pid - its PID.

maxWaitSec - the maximum number of seconds to wait for the process to shut down.

Returns:

true if the process no longer exists

waitForDeath

public static boolean waitForDeath(String host,
                                   int pid,
                                   int maxWaitSec)

Waits up to maxWaitSec for a process to die. Returns false if the process still exists after this time limit has expired, otherwise it returns true. The process is assumed to have been shut down or killed elsewhere.

Parameters:

host - the host the process is running on.

pid - its PID.

maxWaitSec - the maximum number of seconds to wait for the process to shut down.

Returns:

true if the process no longer exists

waitForLife

public static boolean waitForLife(String host,
                                  int pid,
                                  int maxWaitSec)

Waits up to maxWaitSec for a process to live. Returns false if the process does not exist after this time limit has expired, otherwise it returns true. The process is assumed to have been created elsewhere.

Parameters:

host - the host the process is running on.

pid - its PID.

maxWaitSec - the maximum number of seconds to wait for the process to wake up.

Returns:

true if the process is alive.

processAndBuildInfoString

public static String processAndBuildInfoString()

Returns a formatted String containing various information about the runtime environment of this process: host, PID, user name, user.name, user.home, user.dir, os.name, os.arch, os.version, java.version, java.vm.vendor, java.home, java.class.path, and java.library.path. Also includes information about the GemFire build: product version, when it was built, who built it, what directory it was built from, the platform it was built on, and the JDK it was build with. Most importantly, it gives the date of the last SVN update to use in bug reports.

Returns:

formatted String of information about this process.

getProcessStatus

public static String getProcessStatus(int maxWaitSec)

Returns the process status for the local host (for all users).

Parameters:

maxWaitSec - the maximum number of seconds to wait for status.

Throws:

HydraRuntimeException - if the status cannot be determined.

HydraTimeoutException - if the attempt to get status times out.

getProcessStatus

public static String getProcessStatus(String host,
                                      int maxWaitSec)

Returns the process status for the given host (for all users).

Parameters:

maxWaitSec - the maximum number of seconds to wait for status.

Throws:

HydraRuntimeException - if the status cannot be determined.

HydraTimeoutException - if the attempt to get status times out.

getMemoryStatus

public static String getMemoryStatus(int maxWaitSec)

Returns the memory usage for the local host.

Parameters:

maxWaitSec - the maximum number of seconds to wait for status.

Throws:

HydraRuntimeException - if the status cannot be determined.

HydraTimeoutException - if the attempt to get status times out.

setReadPermission

public static void setReadPermission(String dir)

Gives read permission on all files in the given directory to all users.

Throws:

HydraRuntimeException - if a suitable command cannot be found.