org.rhq.core.system

Class ProcessInfo

java.lang.Object

org.rhq.core.system.ProcessInfo

Direct Known Subclasses:

AggregateProcessInfo

public class ProcessInfo
extends Object

Encapsulates information about a known process.

A few process properties (i.e. PID, command line) will never change during the lifetime of the process and can be read directly with this class accessors. Other process properties (i.e. state, cpu usage) will vary and their values are grouped in ProcessInfo.ProcessInfoSnapshot instances.

Operations on static properties of the process must be implemented in the ProcessInfo type. Operations on non static properties must be implemented in the ProcessInfo.ProcessInfoSnapshot type. The ProcessInfo.ProcessInfoSnapshot subtype has been created to remind users of the class that they are working with cached data.

For example, if you want to be sure a process is still alive, you should use this code:
processInfo.freshSnapshot().isRunning()

Rather than:
processInfo.priorSnapshot().isRunning()

Author:

John Mazzitelli, Ian Springer, Thomas Segismont

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	ProcessInfo.ProcessInfoSnapshot Exposes non static process properties and operations computed on them (like ProcessInfo.ProcessInfoSnapshot.isRunning() method).

Field Summary

Fields

Modifier and Type	Field and Description
protected String	baseName
protected String[]	commandLine
protected Map<String,String>	environmentVariables
protected boolean	initialized
protected String	name
protected ProcessInfo	parentProcess
protected long	pid
protected org.hyperic.sigar.ProcCpu	procCpu Deprecated. as of 4.6. To read this property call priorSnaphot() and then corresponding method from the returned ProcessInfo.ProcessInfoSnapshot.
protected org.hyperic.sigar.ProcCred	procCred Deprecated. as of 4.6. To read this property call priorSnaphot() and then corresponding method from the returned ProcessInfo.ProcessInfoSnapshot.
protected org.hyperic.sigar.ProcCredName	procCredName Deprecated. as of 4.6. To read this property call priorSnaphot() and then corresponding method from the returned ProcessInfo.ProcessInfoSnapshot.
protected Map<String,String>	procEnv
protected boolean	processDied
protected org.hyperic.sigar.ProcExe	procExe Deprecated. as of 4.6. To read this property call priorSnaphot() and then corresponding method from the returned ProcessInfo.ProcessInfoSnapshot.
protected org.hyperic.sigar.ProcFd	procFd Deprecated. as of 4.6. To read this property call priorSnaphot() and then corresponding method from the returned ProcessInfo.ProcessInfoSnapshot.
protected org.hyperic.sigar.ProcMem	procMem Deprecated. as of 4.6. To read this property call priorSnaphot() and then corresponding method from the returned ProcessInfo.ProcessInfoSnapshot.
protected org.hyperic.sigar.ProcState	procState Deprecated. as of 4.6. To read this property call priorSnaphot() and then corresponding method from the returned ProcessInfo.ProcessInfoSnapshot.
protected org.hyperic.sigar.ProcTime	procTime Deprecated. as of 4.6. To read this property call priorSnaphot() and then corresponding method from the returned ProcessInfo.ProcessInfoSnapshot.
protected org.hyperic.sigar.SigarProxy	sigar

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	ProcessInfo()
	ProcessInfo(long pid)
	ProcessInfo(long pid, org.hyperic.sigar.SigarProxy sigar)

Method Summary

Methods

Modifier and Type	Method and Description
void	destroy()
boolean	equals(Object obj) Two ProcessInfo objects are equal if their pids are the same.
ProcessInfo.ProcessInfoSnapshot	freshSnapshot() Takes a fresh snapshot of the non static process properties.
AggregateProcessInfo	getAggregateProcessTree() Returns an object that provides aggregate information on this process and all its children.
String	getBaseName() Similar to getName(), this is a convenience method that returns the first command line argument, which is the name of the program that the process is executing.
String[]	getCommandLine()
org.hyperic.sigar.ProcCpu	getCpu() Deprecated. as of 4.6. For similar purpose, call priorSnaphot() and then corresponding method from the returned ProcessInfo.ProcessInfoSnapshot.
org.hyperic.sigar.ProcCred	getCredentials() Deprecated. as of 4.6. For similar purpose, call priorSnaphot() and then corresponding method from the returned ProcessInfo.ProcessInfoSnapshot.
org.hyperic.sigar.ProcCredName	getCredentialsName() Deprecated. as of 4.6. For similar purpose, call priorSnaphot() and then corresponding method from the returned ProcessInfo.ProcessInfoSnapshot.
String	getCurrentWorkingDirectory() Deprecated. as of 4.6. For similar purpose, call priorSnaphot() and then corresponding method from the returned ProcessInfo.ProcessInfoSnapshot.
String	getEnvironmentVariable(String name) Retrieves a specific environment property if it exists, null otherwise.
Map<String,String>	getEnvironmentVariables()
org.hyperic.sigar.ProcExe	getExecutable() Deprecated. as of 4.6. For similar purpose, call priorSnaphot() and then corresponding method from the returned ProcessInfo.ProcessInfoSnapshot.
org.hyperic.sigar.ProcFd	getFileDescriptor() Deprecated. as of 4.6. For similar purpose, call priorSnaphot() and then corresponding method from the returned ProcessInfo.ProcessInfoSnapshot.
org.hyperic.sigar.ProcMem	getMemory() Deprecated. as of 4.6. For similar purpose, call priorSnaphot() and then corresponding method from the returned ProcessInfo.ProcessInfoSnapshot.
String	getName() Convenience method that returns the first command line argument, which is the name of the program that the process is executing.
long	getParentPid() Deprecated. as of 4.6. For similar purpose, call priorSnaphot() and then corresponding method from the returned ProcessInfo.ProcessInfoSnapshot.
ProcessInfo	getParentProcess() Returns a ProcessInfo instance for the parent of this process.
long	getPid()
org.hyperic.sigar.ProcState	getState() Deprecated. as of 4.6. For similar purpose, call priorSnaphot() and then corresponding method from the returned ProcessInfo.ProcessInfoSnapshot.
org.hyperic.sigar.ProcTime	getTime() Deprecated. as of 4.6. For similar purpose, call priorSnaphot() and then corresponding method from the returned ProcessInfo.ProcessInfoSnapshot.
int	hashCode() A process' pid makes it unique - this returns the getPid() itself.
boolean	isRunning() Deprecated. as of 4.6. For similar purpose, call priorSnaphot() and then corresponding method from the returned ProcessInfo.ProcessInfoSnapshot.
void	kill(String signalName) Send the signal with the specified name to this process.
ProcessInfo.ProcessInfoSnapshot	priorSnaphot() Returns the last snasphot of the non static process properties.
void	refresh() Takes a fresh snapshot of non static properties of the underlying process.
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

initialized

protected boolean initialized

sigar

protected org.hyperic.sigar.SigarProxy sigar

pid

protected long pid

name

protected String name

commandLine

protected String[] commandLine

procEnv

protected Map<String,String> procEnv

environmentVariables

protected Map<String,String> environmentVariables

baseName

protected String baseName

parentProcess

protected ProcessInfo parentProcess

procState

@Deprecated
protected org.hyperic.sigar.ProcState procState

Deprecated. as of 4.6. To read this property call priorSnaphot() and then corresponding method from the returned ProcessInfo.ProcessInfoSnapshot.

procExe

@Deprecated
protected org.hyperic.sigar.ProcExe procExe

Deprecated. as of 4.6. To read this property call priorSnaphot() and then corresponding method from the returned ProcessInfo.ProcessInfoSnapshot.

procTime

@Deprecated
protected org.hyperic.sigar.ProcTime procTime

Deprecated. as of 4.6. To read this property call priorSnaphot() and then corresponding method from the returned ProcessInfo.ProcessInfoSnapshot.

procMem

@Deprecated
protected org.hyperic.sigar.ProcMem procMem

Deprecated. as of 4.6. To read this property call priorSnaphot() and then corresponding method from the returned ProcessInfo.ProcessInfoSnapshot.

procCpu

@Deprecated
protected org.hyperic.sigar.ProcCpu procCpu

Deprecated. as of 4.6. To read this property call priorSnaphot() and then corresponding method from the returned ProcessInfo.ProcessInfoSnapshot.

procFd

@Deprecated
protected org.hyperic.sigar.ProcFd procFd

Deprecated. as of 4.6. To read this property call priorSnaphot() and then corresponding method from the returned ProcessInfo.ProcessInfoSnapshot.

procCred

@Deprecated
protected org.hyperic.sigar.ProcCred procCred

Deprecated. as of 4.6. To read this property call priorSnaphot() and then corresponding method from the returned ProcessInfo.ProcessInfoSnapshot.

procCredName

@Deprecated
protected org.hyperic.sigar.ProcCredName procCredName

Deprecated. as of 4.6. To read this property call priorSnaphot() and then corresponding method from the returned ProcessInfo.ProcessInfoSnapshot.

processDied

protected boolean processDied

Constructor Detail

ProcessInfo

protected ProcessInfo()

ProcessInfo

public ProcessInfo(long pid)
            throws SystemInfoException

Throws:

SystemInfoException

ProcessInfo

public ProcessInfo(long pid,
           org.hyperic.sigar.SigarProxy sigar)
            throws SystemInfoException

Throws:

SystemInfoException

Method Detail

refresh

public void refresh()
             throws SystemInfoException

Takes a fresh snapshot of non static properties of the underlying process. This method internally serializes calls so that it maintains a consistent view of the various Sigar call results.

Throws:

SystemInfoException

priorSnaphot

public ProcessInfo.ProcessInfoSnapshot priorSnaphot()

Returns the last snasphot of the non static process properties.

Caveat the returned may hold stale data has it was taken with previous SIGAR calls. Calling freshSnapshot() instead is almost always a better idea.

Returns:

a ProcessInfo.ProcessInfoSnapshot possibly holding stale data

freshSnapshot

public ProcessInfo.ProcessInfoSnapshot freshSnapshot()

Takes a fresh snapshot of the non static process properties.

Returns:

a fresh ProcessInfo.ProcessInfoSnapshot

destroy

public void destroy()
             throws SystemInfoException

Throws:

SystemInfoException

getPid

public long getPid()

getName

public String getName()

Convenience method that returns the first command line argument, which is the name of the program that the process is executing.

Returns:

full name of program that is executing

See Also:

getBaseName(), getCommandLine()

getBaseName

public String getBaseName()

Similar to getName(), this is a convenience method that returns the first command line argument, which is the name of the program that the process is executing. However, this is only the relative filename of the program, which does not include the full path to the program (e.g. this would return "sh" if the name of the process is "/usr/bin/sh").

Returns:

filename of program that is executing

See Also:

getName(), getCommandLine()

getCommandLine

public String[] getCommandLine()

getEnvironmentVariables

public Map<String,String> getEnvironmentVariables()

getEnvironmentVariable

@Nullable
public String getEnvironmentVariable(@NotNull
                                     String name)

Retrieves a specific environment property if it exists, null otherwise.

Parameters:

name - the name of the property to find

Returns:

the environment value

getParentPid

@Deprecated
public long getParentPid()
                  throws SystemInfoException

Deprecated. as of 4.6. For similar purpose, call priorSnaphot() and then corresponding method from the returned ProcessInfo.ProcessInfoSnapshot.

Throws:

SystemInfoException

getState

@Deprecated
public org.hyperic.sigar.ProcState getState()
                                     throws SystemInfoException

Deprecated. as of 4.6. For similar purpose, call priorSnaphot() and then corresponding method from the returned ProcessInfo.ProcessInfoSnapshot.

Throws:

SystemInfoException

getExecutable

@Deprecated
public org.hyperic.sigar.ProcExe getExecutable()
                                        throws SystemInfoException

Deprecated. as of 4.6. For similar purpose, call priorSnaphot() and then corresponding method from the returned ProcessInfo.ProcessInfoSnapshot.

Throws:

SystemInfoException

getTime

@Deprecated
public org.hyperic.sigar.ProcTime getTime()
                                   throws SystemInfoException

Deprecated. as of 4.6. For similar purpose, call priorSnaphot() and then corresponding method from the returned ProcessInfo.ProcessInfoSnapshot.

Throws:

SystemInfoException

getMemory

@Deprecated
public org.hyperic.sigar.ProcMem getMemory()
                                    throws SystemInfoException

Deprecated. as of 4.6. For similar purpose, call priorSnaphot() and then corresponding method from the returned ProcessInfo.ProcessInfoSnapshot.

Throws:

SystemInfoException

getCpu

@Deprecated
public org.hyperic.sigar.ProcCpu getCpu()
                                 throws SystemInfoException

Deprecated. as of 4.6. For similar purpose, call priorSnaphot() and then corresponding method from the returned ProcessInfo.ProcessInfoSnapshot.

Throws:

SystemInfoException

getFileDescriptor

@Deprecated
public org.hyperic.sigar.ProcFd getFileDescriptor()
                                           throws SystemInfoException

Deprecated. as of 4.6. For similar purpose, call priorSnaphot() and then corresponding method from the returned ProcessInfo.ProcessInfoSnapshot.

Throws:

SystemInfoException

getCredentials

@Deprecated
public org.hyperic.sigar.ProcCred getCredentials()
                                          throws SystemInfoException

Deprecated. as of 4.6. For similar purpose, call priorSnaphot() and then corresponding method from the returned ProcessInfo.ProcessInfoSnapshot.

Throws:

SystemInfoException

getCredentialsName

@Deprecated
public org.hyperic.sigar.ProcCredName getCredentialsName()
                                                  throws SystemInfoException

Deprecated. as of 4.6. For similar purpose, call priorSnaphot() and then corresponding method from the returned ProcessInfo.ProcessInfoSnapshot.

Throws:

SystemInfoException

getCurrentWorkingDirectory

@Deprecated
public String getCurrentWorkingDirectory()
                                  throws SystemInfoException

Deprecated. as of 4.6. For similar purpose, call priorSnaphot() and then corresponding method from the returned ProcessInfo.ProcessInfoSnapshot.

Throws:

SystemInfoException

isRunning

@Deprecated
public boolean isRunning()
                  throws SystemInfoException

Deprecated. as of 4.6. For similar purpose, call priorSnaphot() and then corresponding method from the returned ProcessInfo.ProcessInfoSnapshot.

Throws:

SystemInfoException

getAggregateProcessTree

public AggregateProcessInfo getAggregateProcessTree()

Returns an object that provides aggregate information on this process and all its children.

Returns:

aggregate information on this process and its children

getParentProcess

public ProcessInfo getParentProcess()
                             throws SystemInfoException

Returns a ProcessInfo instance for the parent of this process. This method uses the parent process id which is not static (it can change if the parent process dies before its child). So in theory it should be moved to the ProcessInfo.ProcessInfoSnapshot type. In practice, it stays here because the parent ProcessInfo instance is cached after creation.

Throws:

SystemInfoException

Since:

4.4

kill

public void kill(String signalName)
          throws org.hyperic.sigar.SigarException

Send the signal with the specified name to this process.

Parameters:

signalName - the name of the signal to send

Throws:

IllegalArgumentException - if the signal name is not valid

org.hyperic.sigar.SigarException - if the native kill() call fails

Since:

4.4

hashCode

public int hashCode()

A process' pid makes it unique - this returns the getPid() itself.

Overrides:

hashCode in class Object

See Also:

Object.hashCode()

equals

public boolean equals(Object obj)

Two ProcessInfo objects are equal if their pids are the same.

Overrides:

equals in class Object

See Also:

Object.equals(java.lang.Object)

toString

public String toString()

Overrides:

toString in class Object