oshi.json.hardware.impl

Class CentralProcessorImpl

java.lang.Object

oshi.json.json.AbstractOshiJsonObject

oshi.json.hardware.impl.CentralProcessorImpl

All Implemented Interfaces:

Serializable, CentralProcessor, OshiJsonObject

public class CentralProcessorImpl
extends AbstractOshiJsonObject
implements CentralProcessor

Wrapper class to implement CentralProcessor interface with platform-specific objects

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
CentralProcessorImpl(CentralProcessor processor) Creates a new platform-specific CentralProcessor object wrapping the provided argument

Method Summary

Modifier and Type	Method and Description
String	getFamily()
String	getIdentifier() Identifier, eg.
int	getLogicalProcessorCount() Get the number of logical CPUs available for processing.
String	getModel()
String	getName() Name, eg.
int	getPhysicalProcessorCount() Get the number of physical CPUs/cores available for processing.
double[]	getProcessorCpuLoadBetweenTicks() Returns the "recent cpu usage" for all logical processors by counting ticks for the processors from CentralProcessor.getProcessorCpuLoadTicks() between successive calls of this method, with a minimum interval slightly less than 1 second.
long[][]	getProcessorCpuLoadTicks() Get Processor CPU Load tick counters.
String	getProcessorID() Gets the Processor ID.
String	getStepping()
double	getSystemCpuLoad() Returns the "recent cpu usage" for the whole system from OperatingSystemMXBean.getSystemCpuLoad() if a user is running the Oracle JVM.
double	getSystemCpuLoadBetweenTicks() Returns the "recent cpu usage" for the whole system by counting ticks from CentralProcessor.getSystemCpuLoadTicks() between successive calls of this method, with a minimum interval slightly less than 1 second.
long[]	getSystemCpuLoadTicks() Get System-wide CPU Load tick counters.
double	getSystemLoadAverage() Returns the system load average for the last minute.
double[]	getSystemLoadAverage(int nelem) Returns the system load average for the number of elements specified, up to 3, representing 1, 5, and 15 minutes.
String	getSystemSerialNumber() Deprecated.
long	getSystemUptime() Get the System uptime (time since boot).
String	getVendor() Processor vendor.
long	getVendorFreq() Vendor frequency (in Hz), eg.
boolean	isCpu64bit() Is CPU 64bit?
void	setCpu64(boolean cpu64) Set flag is cpu is 64bit.
void	setFamily(String family)
void	setIdentifier(String identifier) Set processor identifier.
void	setModel(String model)
void	setName(String name) Set processor name.
void	setProcessorID(String processorID) Set processor ID
void	setStepping(String stepping)
void	setVendor(String vendor) Set processor vendor.
void	setVendorFreq(long freq) Set processor vendor frequency (in Hz).
javax.json.JsonObject	toJSON(Properties properties) Returns this object as a JsonObject.
String	toString()

Methods inherited from class oshi.json.json.AbstractOshiJsonObject

toCompactJSON, toCompactJSON, toJSON, toPrettyJSON, toPrettyJSON

Methods inherited from class java.lang.Object

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

Methods inherited from interface oshi.json.json.OshiJsonObject

toCompactJSON, toCompactJSON, toJSON, toPrettyJSON, toPrettyJSON

Constructor Detail

CentralProcessorImpl

public CentralProcessorImpl(CentralProcessor processor)

Creates a new platform-specific CentralProcessor object wrapping the provided argument

Parameters:

processor - a platform-specific CentralProcessor object

Method Detail

getVendor

public String getVendor()

Processor vendor.

Specified by:

getVendor in interface CentralProcessor

Returns:

vendor string.

setVendor

public void setVendor(String vendor)

Set processor vendor.

Specified by:

setVendor in interface CentralProcessor

Parameters:

vendor - Vendor.

getName

public String getName()

Name, eg. Intel(R) Core(TM)2 Duo CPU T7300 @ 2.00GHz

Specified by:

getName in interface CentralProcessor

Returns:

Processor name.

setName

public void setName(String name)

Set processor name.

Specified by:

setName in interface CentralProcessor

Parameters:

name - Name.

getProcessorID

public String getProcessorID()

Gets the Processor ID. This is a hexidecimal string representing an 8-byte value, normally obtained using the CPUID opcode with the EAX register set to 1. The first four bytes are the resulting contents of the EAX register, which is the Processor signature, represented in human-readable form by CentralProcessor.getIdentifier() . The remaining four bytes are the contents of the EDX register, containing feature flags. NOTE: The order of returned bytes is platform dependent. Windows and macOS return the values in Big-Endian order, while Linux and Unix results are in Little-Endian order.

Specified by:

getProcessorID in interface CentralProcessor

Returns:

A string representing the Processor ID

setProcessorID

public void setProcessorID(String processorID)

Set processor ID

Specified by:

setProcessorID in interface CentralProcessor

Parameters:

processorID - The processor ID

getVendorFreq

public long getVendorFreq()

Vendor frequency (in Hz), eg. for processor named Intel(R) Core(TM)2 Duo CPU T7300 @ 2.00GHz the vendor frequency is 2000000000.

Specified by:

getVendorFreq in interface CentralProcessor

Returns:

Processor frequency or -1 if unknown.

setVendorFreq

public void setVendorFreq(long freq)

Set processor vendor frequency (in Hz).

Specified by:

setVendorFreq in interface CentralProcessor

Parameters:

freq - Frequency.

getIdentifier

public String getIdentifier()

Identifier, eg. x86 Family 6 Model 15 Stepping 10.

Specified by:

getIdentifier in interface CentralProcessor

Returns:

Processor identifier.

setIdentifier

public void setIdentifier(String identifier)

Set processor identifier.

Specified by:

setIdentifier in interface CentralProcessor

Parameters:

identifier - Identifier.

isCpu64bit

public boolean isCpu64bit()

Is CPU 64bit?

Specified by:

isCpu64bit in interface CentralProcessor

Returns:

True if cpu is 64bit.

setCpu64

public void setCpu64(boolean cpu64)

Set flag is cpu is 64bit.

Specified by:

setCpu64 in interface CentralProcessor

Parameters:

cpu64 - True if cpu is 64.

getStepping

public String getStepping()

Specified by:

getStepping in interface CentralProcessor

Returns:

the stepping

setStepping

public void setStepping(String stepping)

Specified by:

setStepping in interface CentralProcessor

Parameters:

stepping - the stepping to set

getModel

public String getModel()

Specified by:

getModel in interface CentralProcessor

Returns:

the model

setModel

public void setModel(String model)

Specified by:

setModel in interface CentralProcessor

Parameters:

model - the model to set

getFamily

public String getFamily()

Specified by:

getFamily in interface CentralProcessor

Returns:

the family

setFamily

public void setFamily(String family)

Specified by:

setFamily in interface CentralProcessor

Parameters:

family - the family to set

getSystemCpuLoadBetweenTicks

public double getSystemCpuLoadBetweenTicks()

Returns the "recent cpu usage" for the whole system by counting ticks from CentralProcessor.getSystemCpuLoadTicks() between successive calls of this method, with a minimum interval slightly less than 1 second. If less than one second has elapsed since the last call of this method, it will return a calculation based on the tick counts and times of the previous two calls. If at least a second has elapsed, it will return the average CPU load for the interval and update the "last called" times. This method is intended to be used for periodic polling at intervals of 1 second or longer.

Specified by:

getSystemCpuLoadBetweenTicks in interface CentralProcessor

Returns:

CPU load between 0 and 1 (100%)

getSystemCpuLoadTicks

public long[] getSystemCpuLoadTicks()

Get System-wide CPU Load tick counters. Returns an array with seven elements representing either clock ticks or milliseconds (platform dependent) spent in User (0), Nice (1), System (2), Idle (3), IOwait (4), Hardware interrupts (IRQ) (5), or Software interrupts/DPC (SoftIRQ) (6) states. Use CentralProcessor.TickType.getIndex() to retrieve the appropriate index. By measuring the difference between ticks across a time interval, CPU load over that interval may be calculated. Nice information is not available on Windows, and IOwait and IRQ information is not available on macOS, so these ticks will always be zero. To calculate overall Idle time using this method, include both Idle and IOWait ticks. Similarly, IRQ and SoftIRQ ticks should be added to the System value to get the total. System ticks also include time executing other virtual hosts (steal).

Specified by:

getSystemCpuLoadTicks in interface CentralProcessor

Returns:

An array of 7 long values representing time spent in User, Nice, System, Idle, IOwait, IRQ, and SoftIRQ states.

getSystemCpuLoad

public double getSystemCpuLoad()

Returns the "recent cpu usage" for the whole system from OperatingSystemMXBean.getSystemCpuLoad() if a user is running the Oracle JVM. This value is a double in the [0.0,1.0] interval. A value of 0.0 means that all CPUs were idle during the recent period of time observed, while a value of 1.0 means that all CPUs were actively running 100% of the time during the recent period being observed. All values between 0.0 and 1.0 are possible depending of the activities going on in the system. If the system recent cpu usage is not available, the method returns a negative value. Calling this method immediately upon instantiating the CentralProcessor may give unreliable results. If a user is not running the Oracle JVM, this method will default to the behavior and return value of CentralProcessor.getSystemCpuLoadBetweenTicks().

Specified by:

getSystemCpuLoad in interface CentralProcessor

Returns:

the "recent cpu usage" for the whole system; a negative value if not available.

getSystemLoadAverage

public double getSystemLoadAverage()

Returns the system load average for the last minute. This is equivalent to calling CentralProcessor.getSystemLoadAverage(int) with an argument of 1 and returning the first value, and is retained for compatibility.

Specified by:

getSystemLoadAverage in interface CentralProcessor

Returns:

the system load average; or a negative value if not available.

getSystemLoadAverage

public double[] getSystemLoadAverage(int nelem)

Returns the system load average for the number of elements specified, up to 3, representing 1, 5, and 15 minutes. The system load average is the sum of the number of runnable entities queued to the available processors and the number of runnable entities running on the available processors averaged over a period of time. The way in which the load average is calculated is operating system specific but is typically a damped time-dependent average. If the load average is not available, a negative value is returned. This method is designed to provide a hint about the system load and may be queried frequently. The load average may be unavailable on some platforms (e.g., Windows) where it is expensive to implement this method.

Specified by:

getSystemLoadAverage in interface CentralProcessor

Parameters:

nelem - Number of elements to return.

Returns:

an array of the system load averages for 1, 5, and 15 minutes with the size of the array specified by nelem; or negative values if not available.

getProcessorCpuLoadBetweenTicks

public double[] getProcessorCpuLoadBetweenTicks()

Returns the "recent cpu usage" for all logical processors by counting ticks for the processors from CentralProcessor.getProcessorCpuLoadTicks() between successive calls of this method, with a minimum interval slightly less than 1 second. If less than one second has elapsed since the last call of this method, it will return a calculation based on the tick counts and times of the previous two calls. If at least a second has elapsed, it will return the average CPU load for the interval and update the "last called" times. This method is intended to be used for periodic polling (iterating over all processors) at intervals of 1 second or longer.

Specified by:

getProcessorCpuLoadBetweenTicks in interface CentralProcessor

Returns:

array of CPU load between 0 and 1 (100%) for each logical processor

getProcessorCpuLoadTicks

public long[][] getProcessorCpuLoadTicks()

Get Processor CPU Load tick counters. Returns a two dimensional array, with CentralProcessor.getLogicalProcessorCount() arrays, each containing seven elements representing either clock ticks or milliseconds (platform dependent) spent in User (0), Nice (1), System (2), Idle (3), IOwait (4), Hardware interrupts (IRQ) (5), or Software interrupts/DPC (SoftIRQ) (6) states. Use CentralProcessor.TickType.getIndex() to retrieve the appropriate index. By measuring the difference between ticks across a time interval, CPU load over that interval may be calculated. Nice and IOwait per processor information is not available on Windows, and IOwait and IRQ information is not available on macOS, so these ticks will always be zero. To calculate overall Idle time using this method, include both Idle and IOWait ticks. Similarly, IRQ and SoftIRQ ticks should be added to the System value to get the total. System ticks also include time executing other virtual hosts (steal). Note that the System IOwait reported by CentralProcessor.getSystemCpuLoadTicks() will be included in the per-processor Idle time rather than attributed to any logical processor's IOwait counter (i.e., the sum of per-processor Idle time will equal the System Idle + IOwait time.)

Specified by:

getProcessorCpuLoadTicks in interface CentralProcessor

Returns:

A 2D array of logicalProcessorCount x 7 long values representing time spent in User, Nice, System, Idle, IOwait, IRQ, and SoftIRQ states.

getSystemUptime

public long getSystemUptime()

Get the System uptime (time since boot).

Specified by:

getSystemUptime in interface CentralProcessor

Returns:

Number of seconds since boot.

getSystemSerialNumber

@Deprecated
public String getSystemSerialNumber()

Deprecated.

Get the System/CPU Serial Number, if available. On Linux and FreeBSD, this requires either root permissions, installation of the (deprecated) HAL library (lshal command). Linux also attempts to read the dmi/id serial number files in sysfs, which are read-only root by default but may have permissions altered by the user.

Specified by:

getSystemSerialNumber in interface CentralProcessor

Returns:

the System/CPU Serial Number, if available, otherwise returns "unknown"

getLogicalProcessorCount

public int getLogicalProcessorCount()

Get the number of logical CPUs available for processing.

Specified by:

getLogicalProcessorCount in interface CentralProcessor

Returns:

The number of logical CPUs available.

getPhysicalProcessorCount

public int getPhysicalProcessorCount()

Get the number of physical CPUs/cores available for processing.

Specified by:

getPhysicalProcessorCount in interface CentralProcessor

Returns:

The number of physical CPUs available.

toJSON

public javax.json.JsonObject toJSON(Properties properties)

Returns this object as a JsonObject. The provided properties will be set on this object to configure the type of information returned using this and future invocations of OshiJsonObject.toJSON().

Specified by:

toJSON in interface OshiJsonObject

Parameters:

properties - Properties to configure returned results

Returns:

a JsonObject for this class.

toString

public String toString()

Overrides:

toString in class AbstractOshiJsonObject