OsUtils (Apache Mina SSHD :: Common support utilities 2.13.2 API)

java.lang.Object
- org.apache.sshd.common.util.OsUtils

```
public final class OsUtils
extends Object
```
Operating system dependent utility methods.

Author:

Apache MINA SSHD Project

Field Summary

Fields
Modifier and Type	Field and Description
`static List<String>`	`ANDROID_DETECTION_PROPERTIES` System properties consulted in order to detect `Android O/S`.
`static String`	`ANDROID_MODE_OVERRIDE_PROP` Property that can be used to override the reported value from `isAndroid()`.
`static Predicate<String>`	`ANDROID_PROPERTY_VALUE_MATCHER`
`static String`	`CURRENT_USER_OVERRIDE_PROP` Property that can be used to override the reported value from `getCurrentUser()`.
`static List<String>`	`DALVIK_DETECTION_PROPERTIES` System properties consulted in order to detect `Dalvik machine`.
`static String`	`DALVIK_MACHINE_OVERRIDE_PROP` Property that can be used to override the reported value from `isDalvikMachine()`.
`static Predicate<String>`	`DALVIK_PROPERTY_VALUE_MATCHER`
`static String`	`JAVA_VERSION_OVERRIDE_PROP` Property that can be used to override the reported value from `getJavaVersion()`.
`static List<String>`	`LINUX_COMMAND`
`static String`	`LINUX_SHELL_COMMAND_NAME`
`static String`	`OS_TYPE_OVERRIDE_PROP` Property that can be used to override the reported value from `isWin32()`.
`static String`	`ROOT_USER`
`static List<String>`	`WINDOWS_COMMAND`
`static String`	`WINDOWS_SHELL_COMMAND_NAME`

Method Summary

All Methods Static Methods Concrete Methods
Modifier and Type	Method and Description
`static String`	`getCanonicalUser(String user)` Remove `Windows` domain and/or group prefix as well as "(User);" suffix
`static String`	`getComparablePath(String path)`
`static String`	`getCurrentUser()` Get current user name
`static Path`	`getCurrentWorkingDirectory()`
`static VersionInfo`	`getJavaVersion()` Resolves the reported Java version by consulting `JAVA_VERSION_OVERRIDE_PROP`.
`static boolean`	`isAndroid()`
`static boolean`	`isDalvikMachine()`
`static boolean`	`isOSX()`
`static boolean`	`isUNIX()`
`static boolean`	`isWin32()`
`static String`	`resolveCanonicalGroup(String group, String user)` Attempts to resolve canonical group name for `Windows`
`static List<String>`	`resolveDefaultInteractiveCommandElements()`
`static List<String>`	`resolveDefaultInteractiveCommandElements(boolean winOS)`
`static String`	`resolveDefaultInteractiveShellCommand()`
`static String`	`resolveDefaultInteractiveShellCommand(boolean winOS)`
`static void`	`setAndroid(Boolean value)` Override the value returned by `isAndroid()` programmatically
`static void`	`setCurrentUser(String username)` Can be used to programmatically set the username reported by `getCurrentUser()`
`static void`	`setCurrentWorkingDirectoryResolver(Supplier<? extends Path> cwdProvider)` Allows the user to "plug-in" a resolver for the `getCurrentWorkingDirectory()` method
`static void`	`setDalvikMachine(Boolean value)` Override the value returned by `isDalvikMachine()` programmatically
`static void`	`setJavaVersion(VersionInfo version)` Set programmatically the reported Java version
`static void`	`setOS(String os)` Can be used to enforce Win32 or Linux report from `isWin32()`, `isOSX()` or `isUNIX()`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - CURRENT_USER_OVERRIDE_PROP
```
public static final String CURRENT_USER_OVERRIDE_PROP
```
    Property that can be used to override the reported value from getCurrentUser(). If not set then "user.name" system property is used
    
    See Also:
    
    Constant Field Values
  - JAVA_VERSION_OVERRIDE_PROP
```
public static final String JAVA_VERSION_OVERRIDE_PROP
```
    Property that can be used to override the reported value from getJavaVersion(). If not set then "java.version" system property is used
    
    See Also:
    
    Constant Field Values
  - OS_TYPE_OVERRIDE_PROP
```
public static final String OS_TYPE_OVERRIDE_PROP
```
    Property that can be used to override the reported value from isWin32(). If not set then "os.name" system property is used
    
    See Also:
    
    Constant Field Values
  - ANDROID_MODE_OVERRIDE_PROP
```
public static final String ANDROID_MODE_OVERRIDE_PROP
```
    Property that can be used to override the reported value from isAndroid(). If not set then ANDROID_DETECTION_PROPERTIES are used to determine its value. Otherwise, it must contain the string "android" (case-insensitive)
    
    See Also:
    
    ANDROID_PROPERTY_VALUE_MATCHER, Constant Field Values
  - DALVIK_MACHINE_OVERRIDE_PROP
```
public static final String DALVIK_MACHINE_OVERRIDE_PROP
```
    Property that can be used to override the reported value from isDalvikMachine(). If not set then DALVIK_DETECTION_PROPERTIES are used to determine its value. Otherwise, it must contain the string "dalvik" (case-insensitive)
    
    See Also:
    
    Constant Field Values
  - WINDOWS_SHELL_COMMAND_NAME
```
public static final String WINDOWS_SHELL_COMMAND_NAME
```
    See Also:
    
    Constant Field Values
  - LINUX_SHELL_COMMAND_NAME
```
public static final String LINUX_SHELL_COMMAND_NAME
```
    See Also:
    
    Constant Field Values
  - ROOT_USER
```
public static final String ROOT_USER
```
    See Also:
    
    Constant Field Values
  - LINUX_COMMAND
```
public static final List<String> LINUX_COMMAND
```
  - WINDOWS_COMMAND
```
public static final List<String> WINDOWS_COMMAND
```
  - ANDROID_DETECTION_PROPERTIES
```
public static final List<String> ANDROID_DETECTION_PROPERTIES
```
    System properties consulted in order to detect Android O/S.
    
    See Also:
    
    Android Developer
  - ANDROID_PROPERTY_VALUE_MATCHER
```
public static final Predicate<String> ANDROID_PROPERTY_VALUE_MATCHER
```
  - DALVIK_DETECTION_PROPERTIES
```
public static final List<String> DALVIK_DETECTION_PROPERTIES
```
    System properties consulted in order to detect Dalvik machine.
    
    See Also:
    
    Android Developer
  - DALVIK_PROPERTY_VALUE_MATCHER
```
public static final Predicate<String> DALVIK_PROPERTY_VALUE_MATCHER
```
- Method Detail
  - isAndroid
```
public static boolean isAndroid()
```
    Returns:
    
    true if currently running on Android. Note: isUNIX() is also probably true as well, so special care must be taken in code that consults these values
    
    See Also:
    
    ANDROID_DETECTION_PROPERTIES, ANDROID_MODE_OVERRIDE_PROP, ANDROID_PROPERTY_VALUE_MATCHER
  - setAndroid
```
public static void setAndroid(Boolean value)
```
    Override the value returned by isAndroid() programmatically
    
    Parameters:
    
    value - Value to set if null then value is auto-detected
  - isDalvikMachine
```
public static boolean isDalvikMachine()
```
    Returns:
    
    true if currently running on a Dalvik machine. Note: isUNIX() and/or isAndroid() are also probably true as well, so special care must be taken in code that consults these values
    
    See Also:
    
    DALVIK_DETECTION_PROPERTIES, DALVIK_MACHINE_OVERRIDE_PROP, DALVIK_PROPERTY_VALUE_MATCHER
  - setDalvikMachine
```
public static void setDalvikMachine(Boolean value)
```
    Override the value returned by isDalvikMachine() programmatically
    
    Parameters:
    
    value - Value to set if null then value is auto-detected
  - isUNIX
```
public static boolean isUNIX()
```
    Returns:
    
    true if the host is a UNIX system (and not Windows). Note: this does not preclude isAndroid() or isDalvikMachine() from being true as well.
  - isOSX
```
public static boolean isOSX()
```
    Returns:
    
    true if the host is a OSX (and not Windows or Unix).
  - isWin32
```
public static boolean isWin32()
```
    Returns:
    
    true if the host is Windows (and not UNIX).
    
    See Also:
    
    OS_TYPE_OVERRIDE_PROP, setOS(String)
  - setOS
```
public static void setOS(String os)
```
    Can be used to enforce Win32 or Linux report from isWin32(), isOSX() or isUNIX()
    
    Parameters:
    
    os - The value to set - if null then O/S type is auto-detected
    
    See Also:
    
    isWin32(), isOSX(), isUNIX()
  - resolveDefaultInteractiveShellCommand
```
public static String resolveDefaultInteractiveShellCommand()
```
  - resolveDefaultInteractiveShellCommand
```
public static String resolveDefaultInteractiveShellCommand(boolean winOS)
```
  - resolveDefaultInteractiveCommandElements
```
public static List<String> resolveDefaultInteractiveCommandElements()
```
  - resolveDefaultInteractiveCommandElements
```
public static List<String> resolveDefaultInteractiveCommandElements(boolean winOS)
```
  - getCurrentWorkingDirectory
```
public static Path getCurrentWorkingDirectory()
```
    Returns:
    The (C)urrent (W)orking (D)irectory Path - null if cannot resolve it. Resolution occurs as follows:
    
    Consult any currently registered resolver.
    
    If no resolver registered, then "user.dir" system property is consulted.
    See Also:
    
    setCurrentWorkingDirectoryResolver(Supplier)
  - setCurrentWorkingDirectoryResolver
```
public static void setCurrentWorkingDirectoryResolver(Supplier<? extends Path> cwdProvider)
```
    Allows the user to "plug-in" a resolver for the getCurrentWorkingDirectory() method
    
    Parameters:
    
    cwdProvider - The Supplier of the (C)urrent (W)orking (D)irectory Path - if null then "user.dir" system property is consulted
  - getCurrentUser
```
public static String getCurrentUser()
```
    Get current user name
    
    Returns:
    
    Current user
    
    See Also:
    
    CURRENT_USER_OVERRIDE_PROP
  - getCanonicalUser
```
public static String getCanonicalUser(String user)
```
    Remove Windows domain and/or group prefix as well as "(User);" suffix
    
    Parameters:
    
    user - The original username - ignored if null/empty
    
    Returns:
    
    The canonical user - unchanged if Unix O/S
  - resolveCanonicalGroup
```
public static String resolveCanonicalGroup(String group,
                                           String user)
```
    Attempts to resolve canonical group name for Windows
    
    Parameters:
    
    group - The original group name - used if not null/empty
    
    user - The owner name - sometimes it contains a group name
    
    Returns:
    
    The canonical group name
  - setCurrentUser
```
public static void setCurrentUser(String username)
```
    Can be used to programmatically set the username reported by getCurrentUser()
    
    Parameters:
    
    username - The username to set - if null then CURRENT_USER_OVERRIDE_PROP will be consulted
  - getJavaVersion
```
public static VersionInfo getJavaVersion()
```
    Resolves the reported Java version by consulting JAVA_VERSION_OVERRIDE_PROP. If not set, then "java.version" property is used
    
    Returns:
    
    The resolved VersionInfo - never null
    
    See Also:
    
    setJavaVersion(VersionInfo)
  - setJavaVersion
```
public static void setJavaVersion(VersionInfo version)
```
    Set programmatically the reported Java version
    
    Parameters:
    
    version - The version - if null then it will be automatically resolved
  - getComparablePath
```
public static String getComparablePath(String path)
```
    Parameters:
    
    path - The original path
    
    Returns:
    
    A path that can be compared with another one where case sensitivity of the underlying O/S has been taken into account - never null

Class OsUtils

Field Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

CURRENT_USER_OVERRIDE_PROP

JAVA_VERSION_OVERRIDE_PROP

OS_TYPE_OVERRIDE_PROP

ANDROID_MODE_OVERRIDE_PROP

DALVIK_MACHINE_OVERRIDE_PROP

WINDOWS_SHELL_COMMAND_NAME

LINUX_SHELL_COMMAND_NAME

ROOT_USER

LINUX_COMMAND

WINDOWS_COMMAND

ANDROID_DETECTION_PROPERTIES

ANDROID_PROPERTY_VALUE_MATCHER

DALVIK_DETECTION_PROPERTIES

DALVIK_PROPERTY_VALUE_MATCHER

Method Detail

isAndroid

setAndroid

isDalvikMachine

setDalvikMachine

isUNIX

isOSX

isWin32

setOS

resolveDefaultInteractiveShellCommand

resolveDefaultInteractiveShellCommand

resolveDefaultInteractiveCommandElements

resolveDefaultInteractiveCommandElements

getCurrentWorkingDirectory

setCurrentWorkingDirectoryResolver

getCurrentUser

getCanonicalUser

resolveCanonicalGroup

setCurrentUser

getJavaVersion

setJavaVersion

getComparablePath