oshi.software.common

Class AbstractOperatingSystem

java.lang.Object

oshi.software.common.AbstractOperatingSystem

All Implemented Interfaces:

OperatingSystem

Direct Known Subclasses:

FreeBsdOperatingSystem, LinuxOperatingSystem, MacOperatingSystem, SolarisOperatingSystem, WindowsOperatingSystem

public abstract class AbstractOperatingSystem
extends Object
implements OperatingSystem

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected static class	AbstractOperatingSystem.FamilyVersionInfo

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

OperatingSystem.OSVersionInfo, OperatingSystem.ProcessSort

Field Summary

Fields

Modifier and Type	Field and Description
protected OperatingSystemVersion	version

Constructor Summary

Constructors

Constructor and Description
AbstractOperatingSystem()

Method Summary

Modifier and Type	Method and Description
int	getBitness() Gets the bitness (32 or 64) of the operating system.
String	getFamily() Operating system family.
String	getManufacturer() Manufacturer.
OSProcess	getProcess(int pid) Gets information on a currently running process
OSProcess[]	getProcesses() Gets currently running processes.
List<OSProcess>	getProcesses(Collection<Integer> pids) Gets information on a currently running processes.
List<OSProcess>	getProcesses(Collection<Integer> pids, boolean slowFields) Gets information on a currently running processes.
OSProcess[]	getProcesses(int limit, OperatingSystem.ProcessSort sort) Gets currently running processes, optionally limited to the top "N" for a particular sorting order.
OSService[]	getServices() Gets the all services on the system.
OperatingSystemVersion	getVersion() Operating system version.
OperatingSystem.OSVersionInfo	getVersionInfo() Operating system version information.
boolean	isElevated() Determine whether the current process has elevated permissions such as sudo / Administrator
protected List<OSProcess>	processSort(List<OSProcess> processes, int limit, OperatingSystem.ProcessSort sort) Sorts an array of processes using the specified sorting, returning an array with the top limit results if positive.
protected abstract int	queryBitness(int jvmBitness) Backup OS-specific query to determine bitness if previous checks fail
protected abstract boolean	queryElevated()
protected abstract AbstractOperatingSystem.FamilyVersionInfo	queryFamilyVersionInfo()
protected abstract String	queryManufacturer()
String	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

getChildProcesses, getFileSystem, getNetworkParams, getProcess, getProcessAffinityMask, getProcessCount, getProcesses, getProcessId, getSystemBootTime, getSystemUptime, getThreadCount

Field Detail

version

protected OperatingSystemVersion version

Constructor Detail

AbstractOperatingSystem

public AbstractOperatingSystem()

Method Detail

getManufacturer

public String getManufacturer()

Description copied from interface: OperatingSystem

Manufacturer.

Specified by:

getManufacturer in interface OperatingSystem

Returns:

String.

queryManufacturer

protected abstract String queryManufacturer()

getFamily

public String getFamily()

Description copied from interface: OperatingSystem

Operating system family.

Specified by:

getFamily in interface OperatingSystem

Returns:

String.

getVersionInfo

public OperatingSystem.OSVersionInfo getVersionInfo()

Description copied from interface: OperatingSystem

Operating system version information.

Specified by:

getVersionInfo in interface OperatingSystem

Returns:

Version information.

queryFamilyVersionInfo

protected abstract AbstractOperatingSystem.FamilyVersionInfo queryFamilyVersionInfo()

getVersion

public OperatingSystemVersion getVersion()

Description copied from interface: OperatingSystem

Operating system version.

Specified by:

getVersion in interface OperatingSystem

Returns:

Version.

getBitness

public int getBitness()

Description copied from interface: OperatingSystem

Gets the bitness (32 or 64) of the operating system.

Specified by:

getBitness in interface OperatingSystem

Returns:

The number of bits supported by the operating system.

queryBitness

protected abstract int queryBitness(int jvmBitness)

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

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

Specified by:

isElevated in interface OperatingSystem

Returns:

True if this process has elevated permissions

getServices

public OSService[] getServices()

Description copied from interface: OperatingSystem

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

Specified by:

getServices in interface OperatingSystem

Returns:

An array of OSService objects

queryElevated

protected abstract boolean queryElevated()

processSort

protected List<OSProcess> processSort(List<OSProcess> processes,
                                      int limit,
                                      OperatingSystem.ProcessSort sort)

Sorts an array of processes using the specified sorting, returning an array with the top limit results if positive.

Parameters:

processes - The array to sort

limit - The number of results to return if positive; if zero returns all results

sort - The sorting to use, or null

Returns:

An array of size limit (if positive) or of all processes, sorted as specified

getProcesses

public OSProcess[] getProcesses()

Description copied from interface: OperatingSystem

Gets currently running processes. No order is guaranteed.

Specified by:

getProcesses in interface OperatingSystem

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. Some fields that are slow to retrieve (e.g., commandlines and group information on Windows, open files on Unix and Linux) will be skipped.

getProcesses

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

Description copied from interface: OperatingSystem

Gets currently running processes, optionally limited to the top "N" for a particular sorting order. 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.

Specified by:

getProcesses in interface OperatingSystem

Parameters:

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 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. Some fields that are slow to retrieve (e.g., group information on Windows, open files on Unix and Linux) will be skipped.

getProcesses

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

Description copied from interface: OperatingSystem

Gets information on a currently running processes. This has improved performance on Windows based operating systems vs. iterating individual processes. By default, includes all process information.

Specified by:

getProcesses in interface OperatingSystem

Parameters:

pids - A collection of process IDs

Returns:

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

getProcesses

public List<OSProcess> getProcesses(Collection<Integer> pids,
                                    boolean slowFields)

Description copied from interface: OperatingSystem

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

Parameters:

pids - A collection of process IDs

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 OSProcess object for the specified process ids if it is running

getProcess

public OSProcess getProcess(int pid)

Description copied from interface: OperatingSystem

Gets information on a currently running process

Specified by:

getProcess in interface OperatingSystem

Parameters:

pid - A process ID

Returns:

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

toString

public String toString()

Overrides:

toString in class Object