Package oshi.software.os.windows

Class WindowsOperatingSystem

java.lang.Object

oshi.software.common.AbstractOperatingSystem

oshi.software.os.windows.WindowsOperatingSystem

All Implemented Interfaces:

OperatingSystem

@ThreadSafe
public class WindowsOperatingSystem
extends AbstractOperatingSystem

Microsoft Windows, commonly referred to as Windows, is a group of several proprietary graphical operating system families, all of which are developed and marketed by Microsoft.

Nested Class Summary

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

OperatingSystem.OSVersionInfo, OperatingSystem.ProcessFiltering, OperatingSystem.ProcessSorting

Field Summary

Fields inherited from class oshi.software.common.AbstractOperatingSystem

USE_WHO_COMMAND

Constructor Summary

Constructors

Constructor	Description
WindowsOperatingSystem()

Method Summary

Modifier and Type	Method	Description
OSThread	getCurrentThread()	Makes a best effort to get the current thread.
List<OSDesktopWindow>	getDesktopWindows(boolean visibleOnly)	Gets windows on the operating system's GUI desktop.
FileSystem	getFileSystem()	Instantiates a FileSystem object.
InternetProtocolStats	getInternetProtocolStats()	Instantiates a InternetProtocolStats 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 Collection of currently running processes.
int	getProcessId()	Gets the current process ID (PID).
List<OSService>	getServices()	Gets the all services on the system.
List<OSSession>	getSessions()	Gets currently logged in users.
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
int	getThreadId()	Makes a best effort to get the current thread ID (TID).
boolean	isElevated()	Determine whether the current process has elevated permissions such as sudo / Administrator
List<OSProcess>	queryAllProcesses()
protected int	queryBitness(int jvmBitness)	Backup OS-specific query to determine bitness if previous checks fail
List<OSProcess>	queryChildProcesses(int parentPid)
List<OSProcess>	queryDescendantProcesses(int parentPid)
Pair<String,OperatingSystem.OSVersionInfo>	queryFamilyVersionInfo()
String	queryManufacturer()

Methods inherited from class oshi.software.common.AbstractOperatingSystem

getBitness, getChildProcesses, getChildrenOrDescendants, getChildrenOrDescendants, getDescendantProcesses, getFamily, getManufacturer, getProcesses, getVersionInfo, toString

Methods inherited from class java.lang.Object

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

Methods inherited from interface oshi.software.os.OperatingSystem

getCurrentProcess, getProcesses

Constructor Details

WindowsOperatingSystem

public WindowsOperatingSystem()

Method Details

queryManufacturer

public String queryManufacturer()

Specified by:

queryManufacturer in class AbstractOperatingSystem

queryFamilyVersionInfo

public Pair<String,OperatingSystem.OSVersionInfo> queryFamilyVersionInfo()

Specified by:

queryFamilyVersionInfo in class AbstractOperatingSystem

queryBitness

protected int queryBitness(int jvmBitness)

Description copied from class: AbstractOperatingSystem

Backup OS-specific query to determine bitness if previous checks fail

Specified by:

queryBitness in class AbstractOperatingSystem

Parameters:

jvmBitness - The bitness of the JVM

Returns:

The operating system bitness

isElevated

public boolean isElevated()

Description copied from interface: OperatingSystem

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

Returns:

True if this process has elevated permissions

getFileSystem

public FileSystem getFileSystem()

Description copied from interface: OperatingSystem

Instantiates a FileSystem object.

Returns:

A FileSystem object.

getInternetProtocolStats

public InternetProtocolStats getInternetProtocolStats()

Description copied from interface: OperatingSystem

Instantiates a InternetProtocolStats object.

Returns:

a InternetProtocolStats object.

getSessions

public List<OSSession> getSessions()

Description copied from interface: OperatingSystem

Gets currently logged in users.

On macOS, Linux, and Unix systems, the default implementation uses native code (see man getutxent) that is not thread safe. OSHI's use of this code is synchronized and may be used in a multi-threaded environment without introducing any additional conflicts. Users should note, however, that other operating system code may access the same native code.

The Who.queryWho() method produces similar output parsing the output of the Posix-standard who command, and may internally employ reentrant code on some platforms. Users may opt to use this command-line variant by default using the oshi.os.unix.whoCommand configuration property.

Returns:

A list of OSSession objects representing logged-in users

getProcesses

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

Description copied from interface: OperatingSystem

Gets information on a Collection of currently running processes. This has potentially improved performance vs. iterating individual processes.

Parameters:

pids - A collection of process IDs

Returns:

A list of OSProcess objects for the specified process ids if it is running

queryAllProcesses

public List<OSProcess> queryAllProcesses()

Specified by:

queryAllProcesses in class AbstractOperatingSystem

queryChildProcesses

public List<OSProcess> queryChildProcesses(int parentPid)

Specified by:

queryChildProcesses in class AbstractOperatingSystem

queryDescendantProcesses

public List<OSProcess> queryDescendantProcesses(int parentPid)

Specified by:

queryDescendantProcesses in class AbstractOperatingSystem

getProcess

public OSProcess getProcess(int pid)

Description copied from interface: OperatingSystem

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

getProcessId

public int getProcessId()

Description copied from interface: OperatingSystem

Gets the current process ID (PID).

Returns:

the Process ID of the current process

getProcessCount

public int getProcessCount()

Description copied from interface: OperatingSystem

Get the number of processes currently running

Returns:

The number of processes running

getThreadId

public int getThreadId()

Description copied from interface: OperatingSystem

Makes a best effort to get the current thread ID (TID). May not be useful in a multithreaded environment. The thread ID returned may have been short lived and no longer exist.

Thread IDs on macOS are not correlated with any other Operating System output.

Returns:

the Thread ID of the current thread if known, 0 otherwise.

getCurrentThread

public OSThread getCurrentThread()

Description copied from interface: OperatingSystem

Makes a best effort to get the current thread. May not be useful in a multithreaded environment. The thread returned may have been short lived and no longer exist.

On macOS, returns the oldest thread in the calling process.

Returns:

the current thread if known; an invalid thread otherwise.

getThreadCount

public int getThreadCount()

Description copied from interface: OperatingSystem

Get the number of threads currently running

Returns:

The number of threads running

getSystemUptime

public long getSystemUptime()

Description copied from interface: OperatingSystem

Get the System up time (time since boot).

Returns:

Number of seconds since boot.

getSystemBootTime

public long getSystemBootTime()

Description copied from interface: OperatingSystem

Get Unix time of boot.

Returns:

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

getNetworkParams

public NetworkParams getNetworkParams()

Description copied from interface: OperatingSystem

Instantiates a NetworkParams object.

Returns:

A NetworkParams object.

getServices

public List<OSService> getServices()

Description copied from interface: OperatingSystem

Gets the all services on the system. The definition of what is a service is platform-dependent.

Returns:

An array of OSService objects

getDesktopWindows

public List<OSDesktopWindow> getDesktopWindows(boolean visibleOnly)

Description copied from interface: OperatingSystem

Gets windows on the operating system's GUI desktop.

On Unix-like systems, reports X11 windows only, which may be limited to the current display and will not report windows used by other window managers.

While not a guarantee, a best effort is made to return windows in foreground-to-background order. This ordering may be used along with OSDesktopWindow.getOrder() to (probably) determine the frontmost window.

Parameters:

visibleOnly - Whether to restrict the list to only windows visible to the user.

This is a best effort attempt at a reasonable definition of visibility. Visible windows may be completely transparent.

Returns:

A list of OSDesktopWindow objects representing the desktop windows.