org.mdiutil.lang

Class ProcessManager

java.lang.Object

org.mdiutil.lang.ProcessManager

public class ProcessManager
extends Object

The process manager is able to manage external processes.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	ProcessManager.ExternalProcess Represents an external process.

Constructor Summary

Constructors

Constructor and Description
ProcessManager()

Method Summary

Modifier and Type	Method and Description
void	filterSystem(boolean filterSystem) Filter system processes when trying to kill them.
long	getKillProcessTimeOut() Return a timeOut for the killing of a process.
int	getKillProcessTimeOutCount() Return the timeOut count for the killing of a process.
ProcessManager.ExternalProcess	getProcess(String processName) Return the first running proces which has a specific proces name.
SortedMap<Long,List<ProcessManager.ExternalProcess>>	getProcessByCreationDate() Return the map of running processes, sorted by their creation date.
SortedMap<Long,List<ProcessManager.ExternalProcess>>	getProcessByCreationDate(String processName) Return the map of running processes, sorted by their creation date.
List<ProcessManager.ExternalProcess>	getProcesses() Return the list of all running processes.
List<ProcessManager.ExternalProcess>	getProcesses(String processName) Return the list of running processes which have a specific proces name.
Map<String,List<ProcessManager.ExternalProcess>>	getProcessMap() Return the map of running processes, sorted by their process name.
boolean	isFilteringSystem() Return true if system processes are filtered when trying to kill them.
boolean	isHandlingPlatform() Return true if the current platform is handled.
boolean	isRunning(int pid) Return true if a process is currently running.
boolean	isRunning(String processName) Return true if a process is currently running.
boolean	kill(ProcessManager.ExternalProcess process) Kill an external process without its child processes.
boolean	kill(ProcessManager.ExternalProcess process, boolean recursive) Kill an external process.
void	setKillProcessTimeOut(long timeOut) Set a timeOut for the killing of a process.
void	setKillProcessTimeOutCount(int timeOutCount) Set a timeOut count for the killing of a process.

Methods inherited from class java.lang.Object

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

Constructor Detail

ProcessManager

public ProcessManager()

Method Detail

setKillProcessTimeOut

public void setKillProcessTimeOut(long timeOut)

Set a timeOut for the killing of a process. The manager will wait to check if the process have been killed.

Parameters:

timeOut - the timeOut

See Also:

kill(org.mdiutil.lang.ProcessManager.ExternalProcess)

getKillProcessTimeOut

public long getKillProcessTimeOut()

Return a timeOut for the killing of a process. The manager will wait until this timeOut to check if the process have been killed.

Returns:

the timeOut

See Also:

setKillProcessTimeOut(long)

setKillProcessTimeOutCount

public void setKillProcessTimeOutCount(int timeOutCount)

Set a timeOut count for the killing of a process.

Parameters:

timeOutCount - the timeOutCount

See Also:

kill(org.mdiutil.lang.ProcessManager.ExternalProcess)

getKillProcessTimeOutCount

public int getKillProcessTimeOutCount()

Return the timeOut count for the killing of a process.

Returns:

the timeOutCount

See Also:

kill(org.mdiutil.lang.ProcessManager.ExternalProcess)

filterSystem

public void filterSystem(boolean filterSystem)

Filter system processes when trying to kill them. If the argument is true, then the kill(org.mdiutil.lang.ProcessManager.ExternalProcess) ethod will not kill processes which are:

• "Services" processes on Windows
• "root" processes on Linux

Note that by default system processes are filtered

Parameters:

filterSystem - true if filtering system processes when trying to kill them

isFilteringSystem

public boolean isFilteringSystem()

Return true if system processes are filtered when trying to kill them. Note that by default system processes are filtered

Returns:

true if filtering system processes when trying to kill them

isHandlingPlatform

public boolean isHandlingPlatform()

Return true if the current platform is handled. Currently Windows, Linux, MAC OS X, and UNIX are handled.

Returns:

true if the current platform is handled

isRunning

public boolean isRunning(int pid)

Return true if a process is currently running.

Parameters:

pid - the process pid

Returns:

true if the process is currently running

isRunning

public boolean isRunning(String processName)

Return true if a process is currently running. The name is normally the name of the executable.

Parameters:

processName - the process name

Returns:

true if the process is currently running

getProcessByCreationDate

public SortedMap<Long,List<ProcessManager.ExternalProcess>> getProcessByCreationDate()

Return the map of running processes, sorted by their creation date. The time is consistent with the System.currentTimeMillis() method.

Returns:

the map of running processes

getProcessByCreationDate

public SortedMap<Long,List<ProcessManager.ExternalProcess>> getProcessByCreationDate(String processName)

Return the map of running processes, sorted by their creation date. The time is consistent with the System.currentTimeMillis() method.

Parameters:

processName - the process name

Returns:

the map of running processes of this name

getProcessMap

public Map<String,List<ProcessManager.ExternalProcess>> getProcessMap()

Return the map of running processes, sorted by their process name.

Returns:

the map of running processes

getProcesses

public List<ProcessManager.ExternalProcess> getProcesses(String processName)

Return the list of running processes which have a specific proces name. For example, if you have several Java processes currently running on Windows, calling this method with "java.exe" will return a list with all of the Java processes actually running.

Parameters:

processName - the process name

Returns:

the list of running processes (can be an empty list)

getProcesses

public List<ProcessManager.ExternalProcess> getProcesses()

Return the list of all running processes.

Returns:

the list of running processes

getProcess

public ProcessManager.ExternalProcess getProcess(String processName)

Return the first running proces which has a specific proces name.

Parameters:

processName - the process name

Returns:

the of proces (can be null if there is no running process with this name)

kill

public boolean kill(ProcessManager.ExternalProcess process,
                    boolean recursive)

Kill an external process. The manager will wait to check if the process have been killed.

Algorithm

The algorithm which will be used by the manager to kill the process is the following:

• If getKillProcessTimeOut() ≤ 0, then no wait will be performed after the execution of the KILL command
• else:
  • For i = 1 to getKillProcessTimeOutCount():
    • Wait until getKillProcessTimeOut()
    • If the process is not running anymore, then exit

Parameters:

process - the process

recursive - true if the children processes must be killed too

Returns:

true if the process could be killed

kill

public boolean kill(ProcessManager.ExternalProcess process)

Kill an external process without its child processes. The manager will wait to check if the process have been killed.

Parameters:

process - the process

Returns:

true if the process could be killed