oshi.software.os.windows

Class WindowsOperatingSystem

java.lang.Object

oshi.software.common.AbstractOperatingSystem

oshi.software.os.windows.WindowsOperatingSystem

All Implemented Interfaces:

Serializable, OperatingSystem

public class WindowsOperatingSystem
extends AbstractOperatingSystem

WindowsOperatingSystem class.

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from interface oshi.software.os.OperatingSystem

OperatingSystem.ProcessSort

Field Summary

Fields inherited from class oshi.software.common.AbstractOperatingSystem

bitness, elevated, family, manufacturer, version

Constructor Summary

Constructors

Constructor and Description
WindowsOperatingSystem() Constructor for WindowsOperatingSystem.

Method Summary

Modifier and Type	Method and Description
OSProcess[]	getChildProcesses(int parentPid, int limit, OperatingSystem.ProcessSort sort) Gets currently running child processes of provided PID.
FileSystem	getFileSystem() Instantiates a FileSystem object.
NetworkParams	getNetworkParams() Instantiates a NetworkParams object.
OSProcess	getProcess(int pid) Gets information on a currently running process
int	getProcessCount() Get the number of processes currently running
List<OSProcess>	getProcesses(Collection<Integer> pids) Gets information on a currently running processes.
OSProcess[]	getProcesses(int limit, OperatingSystem.ProcessSort sort, boolean slowFields) Gets currently running processes.
int	getProcessId() Gets the current process ID
long	getSystemBootTime() Get Unix time of boot.
long	getSystemUptime() Get the System up time (time since boot).
int	getThreadCount() Get the number of threads currently running
protected void	handleWin32ExceptionOnGetProcessInfo(OSProcess proc, com.sun.jna.platform.win32.Win32Exception ex) handleWin32ExceptionOnGetProcessInfo.
boolean	isElevated() Determine whether the current process has elevated permissions such as sudo / Administrator

Methods inherited from class oshi.software.common.AbstractOperatingSystem

getBitness, getFamily, getManufacturer, getProcesses, getVersion, processSort, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

WindowsOperatingSystem

public WindowsOperatingSystem()

Constructor for WindowsOperatingSystem.

Method Detail

getFileSystem

public FileSystem getFileSystem()

Instantiates a FileSystem object.

Returns:

A FileSystem object.

getProcesses

public OSProcess[] getProcesses(int limit,
                                OperatingSystem.ProcessSort sort,
                                boolean slowFields)

Gets currently running processes. If a positive limit is specified, returns only that number of processes; zero will return all processes. The order may be specified by the sort parameter, for example, to return the top cpu or memory consuming processes; if null, no order is guaranteed.

Parameters:

limit - Max number of results to return, or 0 to return all results

sort - If not null, determines sorting of results

slowFields - If false, skip OSProcess fields that are slow to retrieve (e.g., group information on Windows, open files on Unix and Linux). If true, include all fields, regardless of how long it takes to retrieve the data.

Returns:

An array of OSProcess objects for the specified number (or all) of currently running processes, sorted as specified. The array may contain null elements if a process terminates during iteration.

getChildProcesses

public OSProcess[] getChildProcesses(int parentPid,
                                     int limit,
                                     OperatingSystem.ProcessSort sort)

Gets currently running child processes of provided PID. If a positive limit is specified, returns only that number of processes; zero will return all processes. The order may be specified by the sort parameter, for example, to return the top cpu or memory consuming processes; if null, no order is guaranteed.

Parameters:

parentPid - A process ID

limit - Max number of results to return, or 0 to return all results

sort - If not null, determines sorting of results

Returns:

An array of OSProcess objects presenting the specified number (or all) of currently running child processes of the provided PID, sorted as specified. The array may contain null elements if a process terminates during iteration.

getProcess

public OSProcess getProcess(int pid)

Gets information on a currently running process

Parameters:

pid - A process ID

Returns:

An OSProcess object for the specified process id if it is running; null otherwise

getProcesses

public List<OSProcess> getProcesses(Collection<Integer> pids)

Gets information on a currently running processes. This has improved performance on Windows based operating systems vs. iterating individual processes.

Specified by:

getProcesses in interface OperatingSystem

Overrides:

getProcesses in class AbstractOperatingSystem

Parameters:

pids - A collection of process IDs

Returns:

An OSProcess object for the specified process ids if it is running

handleWin32ExceptionOnGetProcessInfo

protected void handleWin32ExceptionOnGetProcessInfo(OSProcess proc,
                                                    com.sun.jna.platform.win32.Win32Exception ex)

handleWin32ExceptionOnGetProcessInfo.

Parameters:

proc - a OSProcess object.

ex - a Win32Exception object.

getProcessId

public int getProcessId()

Gets the current process ID

Returns:

the Process ID of the current process

getProcessCount

public int getProcessCount()

Get the number of processes currently running

Returns:

The number of processes running

getThreadCount

public int getThreadCount()

Get the number of threads currently running

Returns:

The number of threads running

getSystemUptime

public long getSystemUptime()

Get the System up time (time since boot).

Returns:

Number of seconds since boot.

getSystemBootTime

public long getSystemBootTime()

Get Unix time of boot.

Returns:

The approximate time at which the system booted, in seconds since the Unix epoch.

isElevated

public boolean isElevated()

Determine whether the current process has elevated permissions such as sudo / Administrator

Specified by:

isElevated in interface OperatingSystem

Overrides:

isElevated in class AbstractOperatingSystem

Returns:

True if this process has elevated permissions

getNetworkParams

public NetworkParams getNetworkParams()

Instantiates a NetworkParams object.

Returns:

A NetworkParams object.