org.safs.tools

Class GenericProcessMonitor

java.lang.Object

org.safs.tools.GenericProcessMonitor

Direct Known Subclasses:

ProcessMonitor

public class GenericProcessMonitor
extends java.lang.Object

Various utilities for monitoring or otherwise interrogating native system processes. This "Generic" version does all logging to System.out

Subclasses should override the debug(String) method to log to alternative mechanisms and should override the

This class contains no extended SAFS dependencies and can be readily packaged and distributed for non-SAFS installations.

Author:

Carl Nagle 2012.03.27 Original Release

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	GenericProcessMonitor.ProcessInfo
static class	GenericProcessMonitor.SearchCondition
static class	GenericProcessMonitor.UnixProcessSearchCondition
static class	GenericProcessMonitor.WQLSearchCondition

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	EOL The value of System property "line.separator"
static java.lang.String	FILE_SEP The value of System property "file.separator"
(package private) static java.lang.String	OS_FAMILY_MAC
(package private) static java.lang.String	OS_FAMILY_SYS_PROP
(package private) static java.lang.String	OS_FAMILY_UNIX
(package private) static java.lang.String	OS_FAMILY_WINDOWS
static java.lang.String	OS_NAME The value of System property "os.name"
static java.lang.String	osFamilyName The operating system family name, deduced from os name OS_NAME
static java.lang.String	PATH_SEP The value of System property "path.separator"
(package private) static java.lang.String	unxprockillimg
(package private) static java.lang.String	unxprockillpid
(package private) static java.lang.String	unxproclist
(package private) static java.lang.String	winimgoption
(package private) static java.lang.String	winpidoption
(package private) static java.lang.String	winprockill
(package private) static java.lang.String	winproclist
(package private) static java.lang.String	winwmic
(package private) static java.lang.String	winwmic_cmdprocess
(package private) static java.lang.String	winwmic_nodeoption

Constructor Summary

Constructors

Constructor and Description
GenericProcessMonitor()

Method Summary

Modifier and Type	Method and Description
protected static void	debug(java.lang.String message) Writes to System.out .
protected static java.lang.String	deduceOSFamily() Deduce the 'OS family name' from the 'OS name'. 'windows' for all versions of Windows System. 'unix' for all versions of Unix, Linux System. 'mac' for all versions of Mac System.
static java.util.List<GenericProcessMonitor.ProcessInfo>	getProcess(java.lang.String host, GenericProcessMonitor.SearchCondition condition, java.util.List<java.lang.String> fields) Attempt to get processes on a certain host according to a WQL search condition. On Windows we are using wmic.exe.
protected static GenericProcessCapture	getProcessCapture(java.lang.Process aproc) Subclasses may wish to override to return a different subclass of GenericProcessCapture.
static boolean	isProcessRunning(java.lang.String procid) Return true or false that a given process is running on the system.
static boolean	isWindowsOS()
static void	main(java.lang.String[] args)
static boolean	shutdownProcess(java.lang.String procid) Attempt to forcefully kill a given process by name or PID.
static java.util.List<GenericProcessMonitor.ProcessInfo>	shutdownProcess(java.lang.String host, GenericProcessMonitor.SearchCondition condition) Attempt to forcefully kill processes on a certain host according to a search condition. On Windows we are using wmic.exe.
static java.lang.String	wqlCondition(java.lang.String key, java.lang.String value, boolean partialMatch, boolean caseSensitive) To generate WQL search condition for "wmic". The condition is to search according a key's string value, we use "=" or "like" to compare. Note: 1.

Methods inherited from class java.lang.Object

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

Field Detail

winproclist

static final java.lang.String winproclist

See Also:

Constant Field Values

winprockill

static final java.lang.String winprockill

See Also:

Constant Field Values

winpidoption

static final java.lang.String winpidoption

See Also:

Constant Field Values

winimgoption

static final java.lang.String winimgoption

See Also:

Constant Field Values

winwmic

static final java.lang.String winwmic

See Also:

Constant Field Values

winwmic_nodeoption

static final java.lang.String winwmic_nodeoption

See Also:

Constant Field Values

winwmic_cmdprocess

static final java.lang.String winwmic_cmdprocess

See Also:

Constant Field Values

unxproclist

static final java.lang.String unxproclist

See Also:

Constant Field Values

unxprockillpid

static final java.lang.String unxprockillpid

See Also:

Constant Field Values

unxprockillimg

static final java.lang.String unxprockillimg

See Also:

Constant Field Values

OS_NAME

public static final java.lang.String OS_NAME

The value of System property "os.name"

PATH_SEP

public static final java.lang.String PATH_SEP

The value of System property "path.separator"

EOL

public static final java.lang.String EOL

The value of System property "line.separator"

FILE_SEP

public static final java.lang.String FILE_SEP

The value of System property "file.separator"

osFamilyName

public static java.lang.String osFamilyName

The operating system family name, deduced from os name OS_NAME

OS_FAMILY_SYS_PROP

static final java.lang.String OS_FAMILY_SYS_PROP

See Also:

Constant Field Values

OS_FAMILY_WINDOWS

static final java.lang.String OS_FAMILY_WINDOWS

See Also:

Constant Field Values

OS_FAMILY_UNIX

static final java.lang.String OS_FAMILY_UNIX

See Also:

Constant Field Values

OS_FAMILY_MAC

static final java.lang.String OS_FAMILY_MAC

See Also:

Constant Field Values

Constructor Detail

GenericProcessMonitor

public GenericProcessMonitor()

Method Detail

deduceOSFamily

protected static java.lang.String deduceOSFamily()

Deduce the 'OS family name' from the 'OS name'.
'windows' for all versions of Windows System.
'unix' for all versions of Unix, Linux System.
'mac' for all versions of Mac System.

Returns:

"windows", "unix" or "mac"

Throws:

java.lang.IllegalStateException - if neither can be deduced.

debug

protected static void debug(java.lang.String message)

Writes to System.out . Subclasses should override to log to alternate sinks.

Parameters:

message -

getProcessCapture

protected static GenericProcessCapture getProcessCapture(java.lang.Process aproc)

Subclasses may wish to override to return a different subclass of GenericProcessCapture.

Parameters:

aproc -

Returns:

isProcessRunning

public static boolean isProcessRunning(java.lang.String procid)
                                throws java.io.IOException

Return true or false that a given process is running on the system. On Windows we are using the output for comparison. On Unix we are using output for comparison.

Parameters:

procid - CMD name, or IMAGE, or PID to seek.

Returns:

true if the procid is running/listed.

Throws:

java.io.IOException - if any error occurs in getting the processes for evaluation.

wqlCondition

public static java.lang.String wqlCondition(java.lang.String key,
                                            java.lang.String value,
                                            boolean partialMatch,
                                            boolean caseSensitive)

To generate WQL search condition for "wmic".
The condition is to search according a key's string value, we use "=" or "like" to compare.
Note:
1. It could be concatenated by operator "and", "or", "not" etc. refer to WQL Keywords
2. A group of conditions should be wrapped by parenthesis, such as ((condition1 or condition2) and condition3).
3. Finally the group of conditions should be wrapped by double-quote, such as "((condition1 or condition2) and condition3)", before feed the where clause.

Parameters:

key - String, the key to match, for example, for command 'process', the key could be CommandLine, Name, ProcessId etc.

value - String, the value to match

partialMatch - boolean, if the match is partial.

caseSensitive - boolean, if the match is case sensitive.
NOT USED YET. It seems that command 'wmic' handles condition case-insensitively.

Returns:

String, the search condition.

shutdownProcess

public static java.util.List<GenericProcessMonitor.ProcessInfo> shutdownProcess(java.lang.String host,
                                                                                GenericProcessMonitor.SearchCondition condition)
                                                                         throws SAFSException

Attempt to forcefully kill processes on a certain host according to a search condition.
On Windows we are using wmic.exe. It is only supported on Windows.
On Linux we use the 'ps', 'grep', 'awk' etc. to find matched processes, and use 'kill' to kill process.

Parameters:

host - String, the host name where to kill processes. This is only supprted on Windows.

condition - SearchCondition, the search condition to find processes

Returns:

List, a list of killed processes

Throws:

SAFSException

getProcess

public static java.util.List<GenericProcessMonitor.ProcessInfo> getProcess(java.lang.String host,
                                                                           GenericProcessMonitor.SearchCondition condition,
                                                                           java.util.List<java.lang.String> fields)
                                                                    throws SAFSException

Attempt to get processes on a certain host according to a WQL search condition.
On Windows we are using wmic.exe. It is only supported on Windows.

Parameters:

host - String, the host name where to get processes

condition - WQLSearchCondition, the WQL search condition to find processes

fields - List, a list of field to catch for a process. It can contain any of "Caption CommandLine CreationClassName CreationDate CSCreationClassName CSName Description ExecutablePath ExecutionState Handle HandleCount InstallDate KernelModeTime MaximumWorkingSetSize MinimumWorkingSetSize Name OSCreationClassName OSName OtherOperationCount OtherTransferCount PageFaults PageFileUsage ParentProcessId PeakPageFileUsage PeakVirtualSize PeakWorkingSetSize Priority PrivatePageCount ProcessId QuotaNonPagedPoolUsage QuotaPagedPoolUsage QuotaPeakNonPagedPoolUsage QuotaPeakPagedPoolUsage ReadOperationCount ReadTransferCount SessionId Status TerminationDate ThreadCount UserModeTime VirtualSize WindowsVersion WorkingSetSize WriteOperationCount WriteTransferCount".

Returns:

List, a list of processes met the condition provided in parameter.

Throws:

SAFSException

shutdownProcess

public static boolean shutdownProcess(java.lang.String procid)
                               throws java.io.IOException

Attempt to forcefully kill a given process by name or PID. On Windows we are using taskkill.exe. On Unix we are using kill -9 for PID, or killall for process names. Of course, this must be used with care!

Parameters:

procid - CMD name(nix ps-f) or IMAGE(win qprocess.exe) or PID to kill.

Returns:

true if the shutdown attempt returned with success, false otherwise.

Throws:

java.io.IOException - if no shutdown attempt was ever able to execute.

isWindowsOS

public static boolean isWindowsOS()

main

public static void main(java.lang.String[] args)
                 throws java.io.IOException

Throws:

java.io.IOException