OSHI 6.0.0 is functionally equivalent to 5.8.7, with minor API updates as noted below.
The deprecated methods getProcesses(int limit, ProcessSort sort), getChildProcesses(int parentPid, int limit, ProcessSort sort), and the enum ProcessSort were removed, replaced by methods leveraging constants in the ProcessSorting class.
The deprecated method getCurrentPlatformEnum() was removed from SystemInfo and the deprecated MACOSX value has been removed from PlatformEnum.
The value returned from MacOSProcess and LinuxOSProcess method getCommandLine() has been changed from null-delimited string to space-delimited string. Due to potential truncation on some operating systems, parsing this method should not be relied upon. The getArguments() method is the preferred alternative to obtain a list of the command line arguments.
The method getServices() now returns a List<OSService> rather than an array.
The value returned from NetworkIF method getMTU() has been changed from an int to a long. This impacts Windows users who had special treatment of local interfaces which previously matched the JDK's NetworkInterface return of a 32-bit -1 value. This value is now a long
representing the max unsigned integer value.
OSHI 5.0.0-5.1.2 releases are functionally equivalent to 4.7.0-4.8.2 releases, with three categories of changes supporting full thread safety:
- Remove setters from API.
- Change getters which return arrays of objects to return unmodifiable lists.
- Remove deprecated code.
For users of JPMS, OSHI 5.2.0 and 4.9.0 were released with an Automatic Module Name of com.github.oshi,
which may differ from the oshi.core module name previously resolved automatically.
The NetworkIF, HWDiskStore, OSFileStore, and OSProcess classes are now interfaces, with setters removed.
The HWPartition class is now immutable, with setters removed.
The HardwareAbstractionLayer methods getNetworkIFs(), getDisks(), getPowerSources(),
getDisplays(), getSoundCards(), getGraphicsCards(), getUsbDevices(),
the HWDiskstore method getPartitions(), the FileSystem method getFileStores(),
the GlobalMemory method getPhysicalMemory(), the OperatingSystem methods for getProcesses(),
the CentralProcessor method getLogicalProcessors(), and the UsbDevice method getConnectedDevices()
now return an UnmodifiableList instead of an array.
The OperatingSystem methods fetching OSProcess information using a slowFields boolean have been removed,
as the behavior they enabled is now done by default. Windows users should note the addition of a configurable
parameter optionally allowing WMI caching for improved performance of OsProcess#getCommandLine.
The OperatingSystem method getProcessAffinityMask() is now on the OSProcess object as getAffinityMask().
The OSFileStore method updateAtrributes() is now spelled correctly as updateAttributes().
The deprecated OperatingSystemVersion interface and its getter OperatingSystem.getVersion were removed.
Its getVersion(), getCodeName(), and getBuildNumber() methods are available on the object returned
from the method getVersionInfo().
The deprecated CentralProcessor methods getVendor(), getName(), getFamily(), getModel(),
getStepping(), getProcessor(), getIdentifier(), getVendorFreq(), and isCpu64bit were removed.
The equivalent methods are available on the object returned from getProcessorIdentifier().
The deprecated PowerSource methods getRemainingCapacity() and getTimeRemaining() were removed,
replaced by getRemainingCapacityPercent() and getTimeRemainingEstimated().
The deprecated OSProcess method calculateCpuPercent() was removed, replaced by getProcessCpuLoadCumulative().
OSHI 4.0 requires minimum Java 8 compatibility.
The oshi-json artifact has been completely removed. It is trivial to obtain JSON output using the
Jackson ObjectMapper.
There is a new oshi-demo artifact which will contain many "how to" classes
to demonstrate OSHI's capabilities and integration with other libraries. These classes are intended
as proof-of-concept only, and are not intended for production use.
NetworkIF#getNetworkInterface() is now queryNetworkInterface() to prevent
Jackson's ObjectMapper from attempting to serialize the returned object.
There is a new VirtualMemory class which is accessible with a getter from
GlobalMemory. Methods associated with swap file usage were moved to this
new class.
The CentralProcessor setters were removed from the API. The methods
getSystemCpuLoadBetweenTicks() and getProcessorCpuLoadBetweenTicks() now take
an argument with the previous set of ticks, rather than internally saving the
previous call. This enables users to measure over a longer period or multiple
different periods. The getSystemCpuLoad() method has been removed; users
running the Oracle JVM should use the OperatingSystemMXBean method if
they desire this value. The no-argument getSystemLoadAverage() has been
removed; users can call with an argument of 1 to obtain the same value.
The getSystemUptime() method was moved from the CentralProcessor class to
the OperatingSystem class.
The NetworkIF#updateNetworkStats() and HWDiskStore#updateDiskStats() methods
were renamed to updateAttributes() to conform to other similarly named methods
to permit update of individual elements of arrays.
The most significant change in OSHI 3.0 is the separation of JSON output to a
separate artifact, filtering output using configurable properties. Users of
oshi-core who do not require JSON will find most of the API the same except
as noted below. Those who use JSON will find improved functionality in the
oshi-json module.
The CentralProcessor's getSystemIOWaitTicks() and getSystemIrqTicks()
methods were removed. The getSystemCpuLoadTicks() now include the IOWait and
IRQ tick information previously reported by those methods, although Idle time
no longer includes IOWait, and System Time no longer includes IRQ ticks. The
getProcessorCpuLoadTicks() now includes per-processor IOWait and IRQ tick
information.
The getFileSystem() method was moved from the HardwareAbstractionLayer to
the OperatingSystem. The getFileStores() method on the
HardwareAbstractionLayer was redundant with the same method on the
FileSystem class and was removed.
The OSProcess methods (getProcesses(), getProcess(), getProcessId(),
getProcessCount(), and getThreadCount()) were moved from the
CentralProcessor to the OperatingSystem.
The (OperatingSystem's) getProcesses() method now takes two arguments, to
limit the number of results returned, and to sort the results.
The HardwareAbstractionLayer's getUsbDevices() method now takes a boolean
argument which offers both the existing tree-based or a flat list format.
The Networks interface had an updateNetworkStats() method that was not
reachable from cross-platform code. That method is now on the NetworkIF
class.
Decorator classes for the OSHI API which enable JSON functionality are now in
the oshi.json.* packages with the same API changes in the previous section.
JSON objects associated with the above method changes were updated:
systemCpuLoadTicksandprocessorCpuLoadTicksnow have 7-element arrays instead of 4, and thesystemIOWaitTicksandsystemIrqTickselements have been removed from theprocessorobject.fileSystemis now an element ofoperatingSystemrather thanprocessor.fileStoresis now an element offileSystemrather thanprocessor.processID,processCount,threadCount, andprocessesare now elements ofoperatingSystemrather thanprocessor.
While the existing toJSON() method remains and is backwards compatible, the
new API permits using a java.util.Properties object as an optional parameter
which will be persistent to future (no argument) calls to that method until
replaced. See the FAQ for more information.
Even though it's a major release, OSHI 2.0 functionality is identical to 1.5.2. For the most part, the highest level APIs demonstrated in the test classes have remained the same, except as documented below. Several lower level packages and classes have been moved and/or renamed.
New packages oshi.jna.platform.* were created and code which extends
com.sun.jna.Library was moved into its respective platform library. These
classes should be considered non-API as they may be removed if/when their
code is incorporated into the JNA project.
New packages oshi.hardware.platform.* were created and contain the
platform-specific implementations of interfaces in oshi.hardware, with
implementing classes renamed to prepend the platform name to the interface
name. Similar renaming was done for implementations of oshi.software.os
in the respective oshi.software.os.* packages.
The Memory interface was renamed GlobalMemory to avoid name conflict with
JNA's Memory class.
The Processor interface, which represented one of an array of logical
processor objects, was renamed CentralProcessor and represents the entire
System CPU which may contain multiple logical processors. Methods applicable
to an individual logical processor were modified to return arrays.
The HardwareAbstractionLayer's getProcessors() method was renamed to
getProcessor() and now returns a singular CentralProcessor object.
Specific changes to CentralProcessor methods:
- The constructor no longer takes a processor number argument and the
getProcessorNumber()method was removed - The deprecated
getLoad()method was removed. UsegetSystemCpuLoadBetweenTicks(). - The
getProcessorCpuLoadBetweenTicks()method now returns an array of load values, one value for each logical processor. - The
getProcessorCpuLoadTicks()method now returns a two dimensional array; one array per logical processor, each containing the tick values previously returned for a single processor.