Package oshi.software.os.mac

Class MacOperatingSystem

java.lang.Object
oshi.software.common.AbstractOperatingSystem
oshi.software.os.mac.MacOperatingSystem
All Implemented Interfaces:
OperatingSystem
@ThreadSafe
public class MacOperatingSystem
extends AbstractOperatingSystem
macOS, previously Mac OS X and later OS X) is a series of proprietary graphical operating systems developed and marketed by Apple Inc. since 2001. It is the primary operating system for Apple's Mac computers.

  • Field Details

    • MACOS_VERSIONS_PROPERTIES

      public static final java.lang.String MACOS_VERSIONS_PROPERTIES
      See Also:
      Constant Field Values

  • Constructor Details

    • MacOperatingSystem

      public MacOperatingSystem()

  • Method Details

    • queryManufacturer

      public java.lang.String queryManufacturer()
      Specified by:
      queryManufacturer in class AbstractOperatingSystem

    • queryFamilyVersionInfo

      public AbstractOperatingSystem.FamilyVersionInfo 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

    • 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 java.util.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.

      Specified by:
      getSessions in interface OperatingSystem
      Overrides:
      getSessions in class AbstractOperatingSystem
      Returns:
      A list of OSSession objects representing logged-in users

    • getProcesses

      public java.util.List<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 the sort is 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
      Returns:
      A list of OSProcess objects for the specified number (or all) of currently running processes, sorted as specified. The list may contain null elements or processes with a state of OSProcess.State.INVALID if a process terminates during iteration.

    • 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

    • getChildProcesses

      public java.util.List<OSProcess> getChildProcesses​(int parentPid, int limit, OperatingSystem.ProcessSort sort)
      Description copied from interface: OperatingSystem
      Gets currently running child processes of provided parent PID, 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 the sort is null, no order is guaranteed.
      Specified by:
      getChildProcesses in interface OperatingSystem
      Overrides:
      getChildProcesses in class AbstractOperatingSystem
      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:
      A list of OSProcess objects representing the specified number (or all) of currently running child processes of the provided PID, sorted as specified. The list may contain null elements or processes with a state of OSProcess.State.INVALID if a process terminates during iteration.

    • getProcessId

      public int getProcessId()
      Description copied from interface: OperatingSystem
      Gets the current process ID
      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

    • 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 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
      Overrides:
      getServices in class AbstractOperatingSystem
      Returns:
      An array of OSService objects

    • getDesktopWindows

      public java.util.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.

      Specified by:
      getDesktopWindows in interface OperatingSystem
      Overrides:
      getDesktopWindows in class AbstractOperatingSystem
      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.