hydra

Class Platform

java.lang.Object

hydra.Platform

Direct Known Subclasses:

UnixPlatform, WindowsPlatform

public abstract class Platform
extends Object

This abstract class defines the methods required for platform-specific operations.

Field Summary

Fields

Modifier and Type	Field and Description
protected static String	SSH

Constructor Summary

Constructors

Constructor and Description
Platform()

Method Summary

Modifier and Type	Method and Description
protected int	bgexec(String[] cmdarray, File workdir, File logfile) Starts execution of the specified command and arguments in a separate detached process in the specified working directory writing output to the specified log file.
protected int	bgexec(String command, File workdir, File logfile) Starts execution of the specified string command in a separate detached process in the specified working directory writing output to the specified log file.
protected abstract int	bgexecInternal(String[] cmdarray, String workdir, String logfile) Starts a background command writing its stdout and stderr to the specified log file.
protected void	checkPid(int pid) Checks to make sure that we are operating on a valid process id.
protected abstract void	dumpHeap(int pid, String userDir, String options) Tells a process to dump heap
protected abstract boolean	exists(int pid) Find out if a process exists.
protected String	fgexec(String[] command, int maxWaitSec)
protected int	fgexec(String[] cmdArray, String[] output, File workdir) Starts a foreground process, waits for it to complete, and returns the exit status.
protected String	fgexec(String command, int maxWaitSec)
protected String	fgexec(String command, String[] envp, int maxWaitSec)
protected abstract String	getCommentPrefix() Returns the comment prefix for shell scripts.
protected abstract String[]	getDumpHeapCommand(int pid, String userDir, String options)
protected abstract String	getDumpLocksCommand(int pid)
protected abstract String	getFileExtension() Returns the file extension for shell scripts.
protected static Platform	getInstance()
protected abstract String	getKillCommand(int pid)
protected abstract String	getMemoryStatus(int maxWaitSec) Returns the memory status.
protected abstract String	getNetcontrolCommand(String target, int op)
protected abstract String	getNetworkStatistics(int maxWaitSec) Returns network statistics.
protected abstract String	getPrintStacksCommand(int pid)
protected abstract String	getProcessStatus(int maxWaitSec) Returns the process status.
protected abstract String	getScriptHeader() Returns the header for shell scripts.
protected abstract String	getShutdownCommand(int pid)
protected String	getStackTrace(Throwable t)
protected static String	getString(String[] s)
protected abstract void	kill(int pid) Kills a process.
protected abstract void	printStacks(int pid) Tells a process to print its stacks to its standard output
protected abstract void	restartNTP() Uses NTP to synchronize the local clock with the network time server.
protected abstract void	setExecutePermission(String fn) Gives user execute permission to the file.
protected abstract void	setReadPermission(String dir) Gives universal read permission to all files in the directory.
protected abstract void	shutdown(int pid)

Methods inherited from class java.lang.Object

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

Field Detail

SSH

protected static final String SSH

See Also:

Constant Field Values

Constructor Detail

Platform

public Platform()

Method Detail

getInstance

protected static Platform getInstance()

fgexec

protected String fgexec(String command,
                        int maxWaitSec)

fgexec

protected String fgexec(String command,
                        String[] envp,
                        int maxWaitSec)

fgexec

protected String fgexec(String[] command,
                        int maxWaitSec)

getString

protected static String getString(String[] s)

fgexec

protected int fgexec(String[] cmdArray,
                     String[] output,
                     File workdir)
              throws IOException

Starts a foreground process, waits for it to complete, and returns the exit status.

Parameters:

cmdArray - the command to run.

Returns:

the exit status of the command

Throws:

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

IOException

bgexec

protected int bgexec(String command,
                     File workdir,
                     File logfile)
              throws IOException

Starts execution of the specified string command in a separate detached process in the specified working directory writing output to the specified log file.

Parameters:

command - a specified system command.

workdir - the current directory of the created process; null causes working directory to default to the current directory.

logfile - the file the created process will write stdout and stderr to; null causes a default log file name to be used.

Returns:

the process id of the created process

Throws:

SecurityException - if the current thread cannot create a subprocess.

IOException

bgexec

protected int bgexec(String[] cmdarray,
                     File workdir,
                     File logfile)
              throws IOException

Starts execution of the specified command and arguments in a separate detached process in the specified working directory writing output to the specified log file.

If there is a security manager, its checkExec method is called with the first component of the array cmdarray as its argument. This may result in a security exception.

Given an array of strings cmdarray, representing the tokens of a command line, this method creates a new process in which to execute the specified command.

Parameters:

cmdarray - array containing the command to call and its arguments.

workdir - the current directory of the created process; null causes working directory to default to the current directory.

logfile - the file the created process will write stdout and stderr to; null causes a default log file name to be used.

Returns:

the process id of the created process

Throws:

SecurityException - if the current thread cannot create a subprocess.

IOException

See Also:

SecurityException, SecurityManager.checkExec(java.lang.String)

bgexecInternal

protected abstract int bgexecInternal(String[] cmdarray,
                                      String workdir,
                                      String logfile)
                               throws IOException

Starts a background command writing its stdout and stderr to the specified log file.

Parameters:

cmdarray - An array of strings that specify the command to run. The first element must be the executable. Each additional command line argument should have its own entry in the array.

workdir - the current directory of the created process

logfile - the file the created process will write stdout and stderr to.

Returns:

the process id of the created process; -1 on failure

Throws:

IOException - if a child process could not be created.

checkPid

protected void checkPid(int pid)

Checks to make sure that we are operating on a valid process id. Sending signals to processes with pid 0 or -1 can have unintended consequences.

Throws:

IllegalArgumentException - If pid is not positive

Since:

4.0

exists

protected abstract boolean exists(int pid)

Find out if a process exists.

Parameters:

pid - the id of the process to check for

Returns:

true if the process exists; false if it does not.

shutdown

protected abstract void shutdown(int pid)

Parameters:

pid - the id of the process to shutdown

kill

protected abstract void kill(int pid)

Kills a process.

Parameters:

pid - the id of the process to shutdown

printStacks

protected abstract void printStacks(int pid)

Tells a process to print its stacks to its standard output

Parameters:

pid - the id of the process that will print its stacks

dumpHeap

protected abstract void dumpHeap(int pid,
                                 String userDir,
                                 String options)

Tells a process to dump heap

Parameters:

pid - the id of the process that will print its stacks

getNetworkStatistics

protected abstract String getNetworkStatistics(int maxWaitSec)

Returns network statistics.

getShutdownCommand

protected abstract String getShutdownCommand(int pid)

getKillCommand

protected abstract String getKillCommand(int pid)

getDumpLocksCommand

protected abstract String getDumpLocksCommand(int pid)

getPrintStacksCommand

protected abstract String getPrintStacksCommand(int pid)

getDumpHeapCommand

protected abstract String[] getDumpHeapCommand(int pid,
                                               String userDir,
                                               String options)

getNetcontrolCommand

protected abstract String getNetcontrolCommand(String target,
                                               int op)

restartNTP

protected abstract void restartNTP()

Uses NTP to synchronize the local clock with the network time server.

getFileExtension

protected abstract String getFileExtension()

Returns the file extension for shell scripts.

getScriptHeader

protected abstract String getScriptHeader()

Returns the header for shell scripts.

getCommentPrefix

protected abstract String getCommentPrefix()

Returns the comment prefix for shell scripts.

setExecutePermission

protected abstract void setExecutePermission(String fn)

Gives user execute permission to the file.

setReadPermission

protected abstract void setReadPermission(String dir)

Gives universal read permission to all files in the directory.

getProcessStatus

protected abstract String getProcessStatus(int maxWaitSec)

Returns the process status.

getMemoryStatus

protected abstract String getMemoryStatus(int maxWaitSec)

Returns the memory status.

getStackTrace

protected String getStackTrace(Throwable t)