/* * Licensed to the Apache Software Foundation (ASF) under one or more * contributor license agreements. See the NOTICE file distributed with * this work for additional information regarding copyright ownership. * The ASF licenses this file to You under the Apache License, Version 2.0 * (the "License"); you may not use this file except in compliance with * the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, software * distributed under the License is distributed on an "AS IS" BASIS, * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. * See the License for the specific language governing permissions and * limitations under the License. */ package org.apache.commons.lang3; /** *

* Helpers for {@code java.lang.System}. *

*

* If a system property cannot be read due to security restrictions, the * corresponding field in this class will be set to {@code null} and a message * will be written to {@code System.err}. *

*

* #ThreadSafe# *

* * @since 1.0 */ public class SystemUtils { /** * The prefix String for all Windows OS. */ private static final String OS_NAME_WINDOWS_PREFIX = "Windows"; // System property constants // ----------------------------------------------------------------------- // These MUST be declared first. Other constants depend on this. /** * The System property key for the user home directory. */ private static final String USER_HOME_KEY = "user.home"; /** * The System property key for the user name. */ private static final String USER_NAME_KEY = "user.name"; /** * The System property key for the user directory. */ private static final String USER_DIR_KEY = "user.dir"; /** * The System property key for the Java IO temporary directory. */ private static final String JAVA_IO_TMPDIR_KEY = "java.io.tmpdir"; /** * The System property key for the Java home directory. */ private static final String JAVA_HOME_KEY = "java.home"; /** *

* The {@code awt.toolkit} System Property. *

*

* Holds a class name, on Windows XP this is {@code sun.awt.windows.WToolkit}. *

*

* On platforms without a GUI, this value is {@code null}. *

*

* Defaults to {@code null} if the runtime does not have security access to read * this property or the property does not exist. *

*

* This value is initialized when the class is loaded. If * {@link System#setProperty(String,String)} or * {@link System#setProperties(java.util.Properties)} is called after this class * is loaded, the value will be out of sync with that System property. *

* * @since 2.1 */ public static final String AWT_TOOLKIT = getSystemProperty("awt.toolkit"); /** *

* The {@code file.encoding} System Property. *

*

* File encoding, such as {@code Cp1252}. *

*

* Defaults to {@code null} if the runtime does not have security access to read * this property or the property does not exist. *

*

* This value is initialized when the class is loaded. If * {@link System#setProperty(String,String)} or * {@link System#setProperties(java.util.Properties)} is called after this class * is loaded, the value will be out of sync with that System property. *

* * @since 2.0 * @since Java 1.2 */ public static final String FILE_ENCODING = getSystemProperty("file.encoding"); /** *

* The {@code file.separator} System Property. The file separator is: *

* * *

* Defaults to {@code null} if the runtime does not have security access to read * this property or the property does not exist. *

*

* This value is initialized when the class is loaded. If * {@link System#setProperty(String,String)} or * {@link System#setProperties(java.util.Properties)} is called after this class * is loaded, the value will be out of sync with that System property. *

* * @deprecated Use {@link File#separator}, since it is guaranteed to be a string * containing a single character and it does not require a privilege * check. * @since Java 1.1 */ @Deprecated public static final String FILE_SEPARATOR = getSystemProperty("file.separator"); /** *

* The {@code java.awt.fonts} System Property. *

*

* Defaults to {@code null} if the runtime does not have security access to read * this property or the property does not exist. *

*

* This value is initialized when the class is loaded. If * {@link System#setProperty(String,String)} or * {@link System#setProperties(java.util.Properties)} is called after this class * is loaded, the value will be out of sync with that System property. *

* * @since 2.1 */ public static final String JAVA_AWT_FONTS = getSystemProperty("java.awt.fonts"); /** *

* The {@code java.awt.graphicsenv} System Property. *

*

* Defaults to {@code null} if the runtime does not have security access to read * this property or the property does not exist. *

*

* This value is initialized when the class is loaded. If * {@link System#setProperty(String,String)} or * {@link System#setProperties(java.util.Properties)} is called after this class * is loaded, the value will be out of sync with that System property. *

* * @since 2.1 */ public static final String JAVA_AWT_GRAPHICSENV = getSystemProperty("java.awt.graphicsenv"); /** *

* The {@code java.awt.headless} System Property. The value of this property is * the String {@code "true"} or {@code "false"}. *

*

* Defaults to {@code null} if the runtime does not have security access to read * this property or the property does not exist. *

*

* This value is initialized when the class is loaded. If * {@link System#setProperty(String,String)} or * {@link System#setProperties(java.util.Properties)} is called after this class * is loaded, the value will be out of sync with that System property. *

* * @see #isJavaAwtHeadless() * @since 2.1 * @since Java 1.4 */ public static final String JAVA_AWT_HEADLESS = getSystemProperty("java.awt.headless"); /** *

* The {@code java.awt.printerjob} System Property. *

*

* Defaults to {@code null} if the runtime does not have security access to read * this property or the property does not exist. *

*

* This value is initialized when the class is loaded. If * {@link System#setProperty(String,String)} or * {@link System#setProperties(java.util.Properties)} is called after this class * is loaded, the value will be out of sync with that System property. *

* * @since 2.1 */ public static final String JAVA_AWT_PRINTERJOB = getSystemProperty("java.awt.printerjob"); /** *

* The {@code java.class.path} System Property. Java class path. *

*

* Defaults to {@code null} if the runtime does not have security access to read * this property or the property does not exist. *

*

* This value is initialized when the class is loaded. If * {@link System#setProperty(String,String)} or * {@link System#setProperties(java.util.Properties)} is called after this class * is loaded, the value will be out of sync with that System property. *

* * @since Java 1.1 */ public static final String JAVA_CLASS_PATH = getSystemProperty("java.class.path"); /** *

* The {@code java.class.version} System Property. Java class format version * number. *

*

* Defaults to {@code null} if the runtime does not have security access to read * this property or the property does not exist. *

*

* This value is initialized when the class is loaded. If * {@link System#setProperty(String,String)} or * {@link System#setProperties(java.util.Properties)} is called after this class * is loaded, the value will be out of sync with that System property. *

* * @since Java 1.1 */ public static final String JAVA_CLASS_VERSION = getSystemProperty("java.class.version"); /** *

* The {@code java.compiler} System Property. Name of JIT compiler to use. First * in JDK version 1.2. Not used in Sun JDKs after 1.2. *

*

* Defaults to {@code null} if the runtime does not have security access to read * this property or the property does not exist. *

*

* This value is initialized when the class is loaded. If * {@link System#setProperty(String,String)} or * {@link System#setProperties(java.util.Properties)} is called after this class * is loaded, the value will be out of sync with that System property. *

* * @since Java 1.2. Not used in Sun versions after 1.2. */ public static final String JAVA_COMPILER = getSystemProperty("java.compiler"); /** *

* The {@code java.endorsed.dirs} System Property. Path of endorsed directory or * directories. *

*

* Defaults to {@code null} if the runtime does not have security access to read * this property or the property does not exist. *

*

* This value is initialized when the class is loaded. If * {@link System#setProperty(String,String)} or * {@link System#setProperties(java.util.Properties)} is called after this class * is loaded, the value will be out of sync with that System property. *

* * @since Java 1.4 */ public static final String JAVA_ENDORSED_DIRS = getSystemProperty("java.endorsed.dirs"); /** *

* The {@code java.ext.dirs} System Property. Path of extension directory or * directories. *

*

* Defaults to {@code null} if the runtime does not have security access to read * this property or the property does not exist. *

*

* This value is initialized when the class is loaded. If * {@link System#setProperty(String,String)} or * {@link System#setProperties(java.util.Properties)} is called after this class * is loaded, the value will be out of sync with that System property. *

* * @since Java 1.3 */ public static final String JAVA_EXT_DIRS = getSystemProperty("java.ext.dirs"); /** *

* The {@code java.home} System Property. Java installation directory. *

*

* Defaults to {@code null} if the runtime does not have security access to read * this property or the property does not exist. *

*

* This value is initialized when the class is loaded. If * {@link System#setProperty(String,String)} or * {@link System#setProperties(java.util.Properties)} is called after this class * is loaded, the value will be out of sync with that System property. *

* * @since Java 1.1 */ public static final String JAVA_HOME = getSystemProperty(JAVA_HOME_KEY); /** *

* The {@code java.io.tmpdir} System Property. Default temp file path. *

*

* Defaults to {@code null} if the runtime does not have security access to read * this property or the property does not exist. *

*

* This value is initialized when the class is loaded. If * {@link System#setProperty(String,String)} or * {@link System#setProperties(java.util.Properties)} is called after this class * is loaded, the value will be out of sync with that System property. *

* * @since Java 1.2 */ public static final String JAVA_IO_TMPDIR = getSystemProperty(JAVA_IO_TMPDIR_KEY); /** *

* The {@code java.library.path} System Property. List of paths to search when * loading libraries. *

*

* Defaults to {@code null} if the runtime does not have security access to read * this property or the property does not exist. *

*

* This value is initialized when the class is loaded. If * {@link System#setProperty(String,String)} or * {@link System#setProperties(java.util.Properties)} is called after this class * is loaded, the value will be out of sync with that System property. *

* * @since Java 1.2 */ public static final String JAVA_LIBRARY_PATH = getSystemProperty("java.library.path"); /** *

* The {@code java.runtime.name} System Property. Java Runtime Environment name. *

*

* Defaults to {@code null} if the runtime does not have security access to read * this property or the property does not exist. *

*

* This value is initialized when the class is loaded. If * {@link System#setProperty(String,String)} or * {@link System#setProperties(java.util.Properties)} is called after this class * is loaded, the value will be out of sync with that System property. *

* * @since 2.0 * @since Java 1.3 */ public static final String JAVA_RUNTIME_NAME = getSystemProperty("java.runtime.name"); /** *

* The {@code java.runtime.version} System Property. Java Runtime Environment * version. *

*

* Defaults to {@code null} if the runtime does not have security access to read * this property or the property does not exist. *

*

* This value is initialized when the class is loaded. If * {@link System#setProperty(String,String)} or * {@link System#setProperties(java.util.Properties)} is called after this class * is loaded, the value will be out of sync with that System property. *

* * @since 2.0 * @since Java 1.3 */ public static final String JAVA_RUNTIME_VERSION = getSystemProperty("java.runtime.version"); /** *

* The {@code java.specification.name} System Property. Java Runtime Environment * specification name. *

*

* Defaults to {@code null} if the runtime does not have security access to read * this property or the property does not exist. *

*

* This value is initialized when the class is loaded. If * {@link System#setProperty(String,String)} or * {@link System#setProperties(java.util.Properties)} is called after this class * is loaded, the value will be out of sync with that System property. *

* * @since Java 1.2 */ public static final String JAVA_SPECIFICATION_NAME = getSystemProperty("java.specification.name"); /** *

* The {@code java.specification.vendor} System Property. Java Runtime * Environment specification vendor. *

*

* Defaults to {@code null} if the runtime does not have security access to read * this property or the property does not exist. *

*

* This value is initialized when the class is loaded. If * {@link System#setProperty(String,String)} or * {@link System#setProperties(java.util.Properties)} is called after this class * is loaded, the value will be out of sync with that System property. *

* * @since Java 1.2 */ public static final String JAVA_SPECIFICATION_VENDOR = getSystemProperty("java.specification.vendor"); /** *

* The {@code java.specification.version} System Property. Java Runtime * Environment specification version. *

*

* Defaults to {@code null} if the runtime does not have security access to read * this property or the property does not exist. *

*

* This value is initialized when the class is loaded. If * {@link System#setProperty(String,String)} or * {@link System#setProperties(java.util.Properties)} is called after this class * is loaded, the value will be out of sync with that System property. *

* * @since Java 1.3 */ public static final String JAVA_SPECIFICATION_VERSION = getSystemProperty("java.specification.version"); private static final JavaVersion JAVA_SPECIFICATION_VERSION_AS_ENUM = JavaVersion.get(JAVA_SPECIFICATION_VERSION); /** *

* The {@code java.util.prefs.PreferencesFactory} System Property. A class name. *

*

* Defaults to {@code null} if the runtime does not have security access to read * this property or the property does not exist. *

*

* This value is initialized when the class is loaded. If * {@link System#setProperty(String,String)} or * {@link System#setProperties(java.util.Properties)} is called after this class * is loaded, the value will be out of sync with that System property. *

* * @since 2.1 * @since Java 1.4 */ public static final String JAVA_UTIL_PREFS_PREFERENCES_FACTORY = getSystemProperty( "java.util.prefs.PreferencesFactory"); /** *

* The {@code java.vendor} System Property. Java vendor-specific string. *

*

* Defaults to {@code null} if the runtime does not have security access to read * this property or the property does not exist. *

*

* This value is initialized when the class is loaded. If * {@link System#setProperty(String,String)} or * {@link System#setProperties(java.util.Properties)} is called after this class * is loaded, the value will be out of sync with that System property. *

* * @since Java 1.1 */ public static final String JAVA_VENDOR = getSystemProperty("java.vendor"); /** *

* The {@code java.vendor.url} System Property. Java vendor URL. *

*

* Defaults to {@code null} if the runtime does not have security access to read * this property or the property does not exist. *

*

* This value is initialized when the class is loaded. If * {@link System#setProperty(String,String)} or * {@link System#setProperties(java.util.Properties)} is called after this class * is loaded, the value will be out of sync with that System property. *

* * @since Java 1.1 */ public static final String JAVA_VENDOR_URL = getSystemProperty("java.vendor.url"); /** *

* The {@code java.version} System Property. Java version number. *

*

* Defaults to {@code null} if the runtime does not have security access to read * this property or the property does not exist. *

*

* This value is initialized when the class is loaded. If * {@link System#setProperty(String,String)} or * {@link System#setProperties(java.util.Properties)} is called after this class * is loaded, the value will be out of sync with that System property. *

* * @since Java 1.1 */ public static final String JAVA_VERSION = getSystemProperty("java.version"); /** *

* The {@code java.vm.info} System Property. Java Virtual Machine implementation * info. *

*

* Defaults to {@code null} if the runtime does not have security access to read * this property or the property does not exist. *

*

* This value is initialized when the class is loaded. If * {@link System#setProperty(String,String)} or * {@link System#setProperties(java.util.Properties)} is called after this class * is loaded, the value will be out of sync with that System property. *

* * @since 2.0 * @since Java 1.2 */ public static final String JAVA_VM_INFO = getSystemProperty("java.vm.info"); /** *

* The {@code java.vm.name} System Property. Java Virtual Machine implementation * name. *

*

* Defaults to {@code null} if the runtime does not have security access to read * this property or the property does not exist. *

*

* This value is initialized when the class is loaded. If * {@link System#setProperty(String,String)} or * {@link System#setProperties(java.util.Properties)} is called after this class * is loaded, the value will be out of sync with that System property. *

* * @since Java 1.2 */ public static final String JAVA_VM_NAME = getSystemProperty("java.vm.name"); /** *

* The {@code java.vm.specification.name} System Property. Java Virtual Machine * specification name. *

*

* Defaults to {@code null} if the runtime does not have security access to read * this property or the property does not exist. *

*

* This value is initialized when the class is loaded. If * {@link System#setProperty(String,String)} or * {@link System#setProperties(java.util.Properties)} is called after this class * is loaded, the value will be out of sync with that System property. *

* * @since Java 1.2 */ public static final String JAVA_VM_SPECIFICATION_NAME = getSystemProperty("java.vm.specification.name"); /** *

* The {@code java.vm.specification.vendor} System Property. Java Virtual * Machine specification vendor. *

*

* Defaults to {@code null} if the runtime does not have security access to read * this property or the property does not exist. *

*

* This value is initialized when the class is loaded. If * {@link System#setProperty(String,String)} or * {@link System#setProperties(java.util.Properties)} is called after this class * is loaded, the value will be out of sync with that System property. *

* * @since Java 1.2 */ public static final String JAVA_VM_SPECIFICATION_VENDOR = getSystemProperty("java.vm.specification.vendor"); /** *

* The {@code java.vm.specification.version} System Property. Java Virtual * Machine specification version. *

*

* Defaults to {@code null} if the runtime does not have security access to read * this property or the property does not exist. *

*

* This value is initialized when the class is loaded. If * {@link System#setProperty(String,String)} or * {@link System#setProperties(java.util.Properties)} is called after this class * is loaded, the value will be out of sync with that System property. *

* * @since Java 1.2 */ public static final String JAVA_VM_SPECIFICATION_VERSION = getSystemProperty("java.vm.specification.version"); /** *

* The {@code java.vm.vendor} System Property. Java Virtual Machine * implementation vendor. *

*

* Defaults to {@code null} if the runtime does not have security access to read * this property or the property does not exist. *

*

* This value is initialized when the class is loaded. If * {@link System#setProperty(String,String)} or * {@link System#setProperties(java.util.Properties)} is called after this class * is loaded, the value will be out of sync with that System property. *

* * @since Java 1.2 */ public static final String JAVA_VM_VENDOR = getSystemProperty("java.vm.vendor"); /** *

* The {@code java.vm.version} System Property. Java Virtual Machine * implementation version. *

*

* Defaults to {@code null} if the runtime does not have security access to read * this property or the property does not exist. *

*

* This value is initialized when the class is loaded. If * {@link System#setProperty(String,String)} or * {@link System#setProperties(java.util.Properties)} is called after this class * is loaded, the value will be out of sync with that System property. *

* * @since Java 1.2 */ public static final String JAVA_VM_VERSION = getSystemProperty("java.vm.version"); /** *

* The {@code line.separator} System Property. Line separator * ({@code "\n"} on UNIX). *

*

* Defaults to {@code null} if the runtime does not have security access to read * this property or the property does not exist. *

*

* This value is initialized when the class is loaded. If * {@link System#setProperty(String,String)} or * {@link System#setProperties(java.util.Properties)} is called after this class * is loaded, the value will be out of sync with that System property. *

* * @deprecated Use {@link System#lineSeparator()} instead, since it does not * require a privilege check. * @since Java 1.1 */ @Deprecated public static final String LINE_SEPARATOR = getSystemProperty("line.separator"); /** *

* The {@code os.arch} System Property. Operating system architecture. *

*

* Defaults to {@code null} if the runtime does not have security access to read * this property or the property does not exist. *

*

* This value is initialized when the class is loaded. If * {@link System#setProperty(String,String)} or * {@link System#setProperties(java.util.Properties)} is called after this class * is loaded, the value will be out of sync with that System property. *

* * @since Java 1.1 */ public static final String OS_ARCH = getSystemProperty("os.arch"); /** *

* The {@code os.name} System Property. Operating system name. *

*

* Defaults to {@code null} if the runtime does not have security access to read * this property or the property does not exist. *

*

* This value is initialized when the class is loaded. If * {@link System#setProperty(String,String)} or * {@link System#setProperties(java.util.Properties)} is called after this class * is loaded, the value will be out of sync with that System property. *

* * @since Java 1.1 */ public static final String OS_NAME = getSystemProperty("os.name"); /** *

* The {@code os.version} System Property. Operating system version. *

*

* Defaults to {@code null} if the runtime does not have security access to read * this property or the property does not exist. *

*

* This value is initialized when the class is loaded. If * {@link System#setProperty(String,String)} or * {@link System#setProperties(java.util.Properties)} is called after this class * is loaded, the value will be out of sync with that System property. *

* * @since Java 1.1 */ public static final String OS_VERSION = getSystemProperty("os.version"); /** *

* The {@code path.separator} System Property. Path separator * ({@code ":"} on UNIX). *

*

* Defaults to {@code null} if the runtime does not have security access to read * this property or the property does not exist. *

*

* This value is initialized when the class is loaded. If * {@link System#setProperty(String,String)} or * {@link System#setProperties(java.util.Properties)} is called after this class * is loaded, the value will be out of sync with that System property. *

* * @deprecated Use {@link File#pathSeparator}, since it is guaranteed to be a * string containing a single character and it does not require a * privilege check. * @since Java 1.1 */ @Deprecated public static final String PATH_SEPARATOR = getSystemProperty("path.separator"); /** *

* The {@code user.country} or {@code user.region} System Property. User's * country code, such as {@code GB}. First in Java version 1.2 as * {@code user.region}. Renamed to {@code user.country} in 1.4 *

*

* Defaults to {@code null} if the runtime does not have security access to read * this property or the property does not exist. *

*

* This value is initialized when the class is loaded. If * {@link System#setProperty(String,String)} or * {@link System#setProperties(java.util.Properties)} is called after this class * is loaded, the value will be out of sync with that System property. *

* * @since 2.0 * @since Java 1.2 */ public static final String USER_COUNTRY = getSystemProperty("user.country") == null ? getSystemProperty("user.region") : getSystemProperty("user.country"); /** *

* The {@code user.dir} System Property. User's current working directory. *

*

* Defaults to {@code null} if the runtime does not have security access to read * this property or the property does not exist. *

*

* This value is initialized when the class is loaded. If * {@link System#setProperty(String,String)} or * {@link System#setProperties(java.util.Properties)} is called after this class * is loaded, the value will be out of sync with that System property. *

* * @since Java 1.1 */ public static final String USER_DIR = getSystemProperty(USER_DIR_KEY); /** *

* The {@code user.home} System Property. User's home directory. *

*

* Defaults to {@code null} if the runtime does not have security access to read * this property or the property does not exist. *

*

* This value is initialized when the class is loaded. If * {@link System#setProperty(String,String)} or * {@link System#setProperties(java.util.Properties)} is called after this class * is loaded, the value will be out of sync with that System property. *

* * @since Java 1.1 */ public static final String USER_HOME = getSystemProperty(USER_HOME_KEY); /** *

* The {@code user.language} System Property. User's language code, such as * {@code "en"}. *

*

* Defaults to {@code null} if the runtime does not have security access to read * this property or the property does not exist. *

*

* This value is initialized when the class is loaded. If * {@link System#setProperty(String,String)} or * {@link System#setProperties(java.util.Properties)} is called after this class * is loaded, the value will be out of sync with that System property. *

* * @since 2.0 * @since Java 1.2 */ public static final String USER_LANGUAGE = getSystemProperty("user.language"); /** *

* The {@code user.name} System Property. User's account name. *

*

* Defaults to {@code null} if the runtime does not have security access to read * this property or the property does not exist. *

*

* This value is initialized when the class is loaded. If * {@link System#setProperty(String,String)} or * {@link System#setProperties(java.util.Properties)} is called after this class * is loaded, the value will be out of sync with that System property. *

* * @since Java 1.1 */ public static final String USER_NAME = getSystemProperty(USER_NAME_KEY); /** *

* The {@code user.timezone} System Property. For example: * {@code "America/Los_Angeles"}. *

*

* Defaults to {@code null} if the runtime does not have security access to read * this property or the property does not exist. *

*

* This value is initialized when the class is loaded. If * {@link System#setProperty(String,String)} or * {@link System#setProperties(java.util.Properties)} is called after this class * is loaded, the value will be out of sync with that System property. *

* * @since 2.1 */ public static final String USER_TIMEZONE = getSystemProperty("user.timezone"); // Java version checks // ----------------------------------------------------------------------- // These MUST be declared after those above as they depend on the // values being set up /** *

* Is {@code true} if this is Java version 1.1 (also 1.1.x versions). *

*

* The field will return {@code false} if {@link #JAVA_VERSION} is {@code null}. *

*/ public static final boolean IS_JAVA_1_1 = getJavaVersionMatches("1.1"); /** *

* Is {@code true} if this is Java version 1.2 (also 1.2.x versions). *

*

* The field will return {@code false} if {@link #JAVA_VERSION} is {@code null}. *

*/ public static final boolean IS_JAVA_1_2 = getJavaVersionMatches("1.2"); /** *

* Is {@code true} if this is Java version 1.3 (also 1.3.x versions). *

*

* The field will return {@code false} if {@link #JAVA_VERSION} is {@code null}. *

*/ public static final boolean IS_JAVA_1_3 = getJavaVersionMatches("1.3"); /** *

* Is {@code true} if this is Java version 1.4 (also 1.4.x versions). *

*

* The field will return {@code false} if {@link #JAVA_VERSION} is {@code null}. *

*/ public static final boolean IS_JAVA_1_4 = getJavaVersionMatches("1.4"); /** *

* Is {@code true} if this is Java version 1.5 (also 1.5.x versions). *

*

* The field will return {@code false} if {@link #JAVA_VERSION} is {@code null}. *

*/ public static final boolean IS_JAVA_1_5 = getJavaVersionMatches("1.5"); /** *

* Is {@code true} if this is Java version 1.6 (also 1.6.x versions). *

*

* The field will return {@code false} if {@link #JAVA_VERSION} is {@code null}. *

*/ public static final boolean IS_JAVA_1_6 = getJavaVersionMatches("1.6"); /** *

* Is {@code true} if this is Java version 1.7 (also 1.7.x versions). *

*

* The field will return {@code false} if {@link #JAVA_VERSION} is {@code null}. *

* * @since 3.0 */ public static final boolean IS_JAVA_1_7 = getJavaVersionMatches("1.7"); /** *

* Is {@code true} if this is Java version 1.8 (also 1.8.x versions). *

*

* The field will return {@code false} if {@link #JAVA_VERSION} is {@code null}. *

* * @since 3.3.2 */ public static final boolean IS_JAVA_1_8 = getJavaVersionMatches("1.8"); /** *

* Is {@code true} if this is Java version 1.9 (also 1.9.x versions). *

*

* The field will return {@code false} if {@link #JAVA_VERSION} is {@code null}. *

* * @since 3.4 * * @deprecated As of release 3.5, replaced by {@link #IS_JAVA_9} */ @Deprecated public static final boolean IS_JAVA_1_9 = getJavaVersionMatches("9"); /** *

* Is {@code true} if this is Java version 9 (also 9.x versions). *

*

* The field will return {@code false} if {@link #JAVA_VERSION} is {@code null}. *

* * @since 3.5 */ public static final boolean IS_JAVA_9 = getJavaVersionMatches("9"); /** *

* Is {@code true} if this is Java version 10 (also 10.x versions). *

*

* The field will return {@code false} if {@link #JAVA_VERSION} is {@code null}. *

* * @since 3.7 */ public static final boolean IS_JAVA_10 = getJavaVersionMatches("10"); /** *

* Is {@code true} if this is Java version 11 (also 11.x versions). *

*

* The field will return {@code false} if {@link #JAVA_VERSION} is {@code null}. *

* * @since 3.8 */ public static final boolean IS_JAVA_11 = getJavaVersionMatches("11"); /** *

* Is {@code true} if this is Java version 12 (also 12.x versions). *

*

* The field will return {@code false} if {@link #JAVA_VERSION} is {@code null}. *

* * @since 3.9 */ public static final boolean IS_JAVA_12 = getJavaVersionMatches("12"); /** *

* Is {@code true} if this is Java version 13 (also 13.x versions). *

*

* The field will return {@code false} if {@link #JAVA_VERSION} is {@code null}. *

* * @since 3.9 */ public static final boolean IS_JAVA_13 = getJavaVersionMatches("13"); /** *

* Is {@code true} if this is Java version 14 (also 14.x versions). *

*

* The field will return {@code false} if {@link #JAVA_VERSION} is {@code null}. *

* * @since 3.10 */ public static final boolean IS_JAVA_14 = getJavaVersionMatches("14"); /** *

* Is {@code true} if this is Java version 15 (also 15.x versions). *

*

* The field will return {@code false} if {@link #JAVA_VERSION} is {@code null}. *

* * @since 3.10 */ public static final boolean IS_JAVA_15 = getJavaVersionMatches("15"); // Operating system checks // ----------------------------------------------------------------------- // These MUST be declared after those above as they depend on the // values being set up // OS names from http://www.vamphq.com/os.html // Selected ones included - please advise dev@commons.apache.org // if you want another added or a mistake corrected /** *

* Is {@code true} if this is AIX. *

*

* The field will return {@code false} if {@code OS_NAME} is {@code null}. *

* * @since 2.0 */ public static final boolean IS_OS_AIX = getOsMatchesName("AIX"); /** *

* Is {@code true} if this is HP-UX. *

*

* The field will return {@code false} if {@code OS_NAME} is {@code null}. *

* * @since 2.0 */ public static final boolean IS_OS_HP_UX = getOsMatchesName("HP-UX"); /** *

* Is {@code true} if this is IBM OS/400. *

*

* The field will return {@code false} if {@code OS_NAME} is {@code null}. *

* * @since 3.3 */ public static final boolean IS_OS_400 = getOsMatchesName("OS/400"); /** *

* Is {@code true} if this is Irix. *

*

* The field will return {@code false} if {@code OS_NAME} is {@code null}. *

* * @since 2.0 */ public static final boolean IS_OS_IRIX = getOsMatchesName("Irix"); /** *

* Is {@code true} if this is Linux. *

*

* The field will return {@code false} if {@code OS_NAME} is {@code null}. *

* * @since 2.0 */ public static final boolean IS_OS_LINUX = getOsMatchesName("Linux") || getOsMatchesName("LINUX"); /** *

* Is {@code true} if this is Mac. *

*

* The field will return {@code false} if {@code OS_NAME} is {@code null}. *

* * @since 2.0 */ public static final boolean IS_OS_MAC = getOsMatchesName("Mac"); /** *

* Is {@code true} if this is Mac. *

*

* The field will return {@code false} if {@code OS_NAME} is {@code null}. *

* * @since 2.0 */ public static final boolean IS_OS_MAC_OSX = getOsMatchesName("Mac OS X"); /** *

* Is {@code true} if this is Mac OS X Cheetah. *

*

* The field will return {@code false} if {@code OS_NAME} is {@code null}. *

* * @since 3.4 */ public static final boolean IS_OS_MAC_OSX_CHEETAH = getOsMatches("Mac OS X", "10.0"); /** *

* Is {@code true} if this is Mac OS X Puma. *

*

* The field will return {@code false} if {@code OS_NAME} is {@code null}. *

* * @since 3.4 */ public static final boolean IS_OS_MAC_OSX_PUMA = getOsMatches("Mac OS X", "10.1"); /** *

* Is {@code true} if this is Mac OS X Jaguar. *

*

* The field will return {@code false} if {@code OS_NAME} is {@code null}. *

* * @since 3.4 */ public static final boolean IS_OS_MAC_OSX_JAGUAR = getOsMatches("Mac OS X", "10.2"); /** *

* Is {@code true} if this is Mac OS X Panther. *

*

* The field will return {@code false} if {@code OS_NAME} is {@code null}. *

* * @since 3.4 */ public static final boolean IS_OS_MAC_OSX_PANTHER = getOsMatches("Mac OS X", "10.3"); /** *

* Is {@code true} if this is Mac OS X Tiger. *

*

* The field will return {@code false} if {@code OS_NAME} is {@code null}. *

* * @since 3.4 */ public static final boolean IS_OS_MAC_OSX_TIGER = getOsMatches("Mac OS X", "10.4"); /** *

* Is {@code true} if this is Mac OS X Leopard. *

*

* The field will return {@code false} if {@code OS_NAME} is {@code null}. *

* * @since 3.4 */ public static final boolean IS_OS_MAC_OSX_LEOPARD = getOsMatches("Mac OS X", "10.5"); /** *

* Is {@code true} if this is Mac OS X Snow Leopard. *

*

* The field will return {@code false} if {@code OS_NAME} is {@code null}. *

* * @since 3.4 */ public static final boolean IS_OS_MAC_OSX_SNOW_LEOPARD = getOsMatches("Mac OS X", "10.6"); /** *

* Is {@code true} if this is Mac OS X Lion. *

*

* The field will return {@code false} if {@code OS_NAME} is {@code null}. *

* * @since 3.4 */ public static final boolean IS_OS_MAC_OSX_LION = getOsMatches("Mac OS X", "10.7"); /** *

* Is {@code true} if this is Mac OS X Mountain Lion. *

*

* The field will return {@code false} if {@code OS_NAME} is {@code null}. *

* * @since 3.4 */ public static final boolean IS_OS_MAC_OSX_MOUNTAIN_LION = getOsMatches("Mac OS X", "10.8"); /** *

* Is {@code true} if this is Mac OS X Mavericks. *

*

* The field will return {@code false} if {@code OS_NAME} is {@code null}. *

* * @since 3.4 */ public static final boolean IS_OS_MAC_OSX_MAVERICKS = getOsMatches("Mac OS X", "10.9"); /** *

* Is {@code true} if this is Mac OS X Yosemite. *

*

* The field will return {@code false} if {@code OS_NAME} is {@code null}. *

* * @since 3.4 */ public static final boolean IS_OS_MAC_OSX_YOSEMITE = getOsMatches("Mac OS X", "10.10"); /** *

* Is {@code true} if this is Mac OS X El Capitan. *

*

* The field will return {@code false} if {@code OS_NAME} is {@code null}. *

* * @since 3.5 */ public static final boolean IS_OS_MAC_OSX_EL_CAPITAN = getOsMatches("Mac OS X", "10.11"); /** *

* Is {@code true} if this is Mac OS X Sierra. *

*

* The field will return {@code false} if {@code OS_NAME} is {@code null}. *

* * @since 3.12.0 */ public static final boolean IS_OS_MAC_OSX_SIERRA = getOsMatches("Mac OS X", "10.12"); /** *

* Is {@code true} if this is Mac OS X High Sierra. *

*

* The field will return {@code false} if {@code OS_NAME} is {@code null}. *

* * @since 3.12.0 */ public static final boolean IS_OS_MAC_OSX_HIGH_SIERRA = getOsMatches("Mac OS X", "10.13"); /** *

* Is {@code true} if this is Mac OS X Mojave. *

*

* The field will return {@code false} if {@code OS_NAME} is {@code null}. *

* * @since 3.12.0 */ public static final boolean IS_OS_MAC_OSX_MOJAVE = getOsMatches("Mac OS X", "10.14"); /** *

* Is {@code true} if this is Mac OS X Catalina. *

*

* The field will return {@code false} if {@code OS_NAME} is {@code null}. *

* * @since 3.12.0 */ public static final boolean IS_OS_MAC_OSX_CATALINA = getOsMatches("Mac OS X", "10.15"); /** *

* Is {@code true} if this is Mac OS X Big Sur. *

*

* The field will return {@code false} if {@code OS_NAME} is {@code null}. *

* * @since 3.12.0 */ public static final boolean IS_OS_MAC_OSX_BIG_SUR = getOsMatches("Mac OS X", "10.16"); /** *

* Is {@code true} if this is FreeBSD. *

*

* The field will return {@code false} if {@code OS_NAME} is {@code null}. *

* * @since 3.1 */ public static final boolean IS_OS_FREE_BSD = getOsMatchesName("FreeBSD"); /** *

* Is {@code true} if this is OpenBSD. *

*

* The field will return {@code false} if {@code OS_NAME} is {@code null}. *

* * @since 3.1 */ public static final boolean IS_OS_OPEN_BSD = getOsMatchesName("OpenBSD"); /** *

* Is {@code true} if this is NetBSD. *

*

* The field will return {@code false} if {@code OS_NAME} is {@code null}. *

* * @since 3.1 */ public static final boolean IS_OS_NET_BSD = getOsMatchesName("NetBSD"); /** *

* Is {@code true} if this is OS/2. *

*

* The field will return {@code false} if {@code OS_NAME} is {@code null}. *

* * @since 2.0 */ public static final boolean IS_OS_OS2 = getOsMatchesName("OS/2"); /** *

* Is {@code true} if this is Solaris. *

*

* The field will return {@code false} if {@code OS_NAME} is {@code null}. *

* * @since 2.0 */ public static final boolean IS_OS_SOLARIS = getOsMatchesName("Solaris"); /** *

* Is {@code true} if this is SunOS. *

*

* The field will return {@code false} if {@code OS_NAME} is {@code null}. *

* * @since 2.0 */ public static final boolean IS_OS_SUN_OS = getOsMatchesName("SunOS"); /** *

* Is {@code true} if this is a UNIX like system, as in any of AIX, HP-UX, Irix, * Linux, MacOSX, Solaris or SUN OS. *

*

* The field will return {@code false} if {@code OS_NAME} is {@code null}. *

* * @since 2.1 */ public static final boolean IS_OS_UNIX = IS_OS_AIX || IS_OS_HP_UX || IS_OS_IRIX || IS_OS_LINUX || IS_OS_MAC_OSX || IS_OS_SOLARIS || IS_OS_SUN_OS || IS_OS_FREE_BSD || IS_OS_OPEN_BSD || IS_OS_NET_BSD; /** *

* Is {@code true} if this is Windows. *

*

* The field will return {@code false} if {@code OS_NAME} is {@code null}. *

* * @since 2.0 */ public static final boolean IS_OS_WINDOWS = getOsMatchesName(OS_NAME_WINDOWS_PREFIX); /** *

* Is {@code true} if this is Windows 2000. *

*

* The field will return {@code false} if {@code OS_NAME} is {@code null}. *

* * @since 2.0 */ public static final boolean IS_OS_WINDOWS_2000 = getOsMatchesName(OS_NAME_WINDOWS_PREFIX + " 2000"); /** *

* Is {@code true} if this is Windows 2003. *

*

* The field will return {@code false} if {@code OS_NAME} is {@code null}. *

* * @since 3.1 */ public static final boolean IS_OS_WINDOWS_2003 = getOsMatchesName(OS_NAME_WINDOWS_PREFIX + " 2003"); /** *

* Is {@code true} if this is Windows Server 2008. *

*

* The field will return {@code false} if {@code OS_NAME} is {@code null}. *

* * @since 3.1 */ public static final boolean IS_OS_WINDOWS_2008 = getOsMatchesName(OS_NAME_WINDOWS_PREFIX + " Server 2008"); /** *

* Is {@code true} if this is Windows Server 2012. *

*

* The field will return {@code false} if {@code OS_NAME} is {@code null}. *

* * @since 3.4 */ public static final boolean IS_OS_WINDOWS_2012 = getOsMatchesName(OS_NAME_WINDOWS_PREFIX + " Server 2012"); /** *

* Is {@code true} if this is Windows 95. *

*

* The field will return {@code false} if {@code OS_NAME} is {@code null}. *

* * @since 2.0 */ public static final boolean IS_OS_WINDOWS_95 = getOsMatchesName(OS_NAME_WINDOWS_PREFIX + " 95"); /** *

* Is {@code true} if this is Windows 98. *

*

* The field will return {@code false} if {@code OS_NAME} is {@code null}. *

* * @since 2.0 */ public static final boolean IS_OS_WINDOWS_98 = getOsMatchesName(OS_NAME_WINDOWS_PREFIX + " 98"); /** *

* Is {@code true} if this is Windows ME. *

*

* The field will return {@code false} if {@code OS_NAME} is {@code null}. *

* * @since 2.0 */ public static final boolean IS_OS_WINDOWS_ME = getOsMatchesName(OS_NAME_WINDOWS_PREFIX + " Me"); /** *

* Is {@code true} if this is Windows NT. *

*

* The field will return {@code false} if {@code OS_NAME} is {@code null}. *

* * @since 2.0 */ public static final boolean IS_OS_WINDOWS_NT = getOsMatchesName(OS_NAME_WINDOWS_PREFIX + " NT"); /** *

* Is {@code true} if this is Windows XP. *

*

* The field will return {@code false} if {@code OS_NAME} is {@code null}. *

* * @since 2.0 */ public static final boolean IS_OS_WINDOWS_XP = getOsMatchesName(OS_NAME_WINDOWS_PREFIX + " XP"); // ----------------------------------------------------------------------- /** *

* Is {@code true} if this is Windows Vista. *

*

* The field will return {@code false} if {@code OS_NAME} is {@code null}. *

* * @since 2.4 */ public static final boolean IS_OS_WINDOWS_VISTA = getOsMatchesName(OS_NAME_WINDOWS_PREFIX + " Vista"); /** *

* Is {@code true} if this is Windows 7. *

*

* The field will return {@code false} if {@code OS_NAME} is {@code null}. *

* * @since 3.0 */ public static final boolean IS_OS_WINDOWS_7 = getOsMatchesName(OS_NAME_WINDOWS_PREFIX + " 7"); /** *

* Is {@code true} if this is Windows 8. *

*

* The field will return {@code false} if {@code OS_NAME} is {@code null}. *

* * @since 3.2 */ public static final boolean IS_OS_WINDOWS_8 = getOsMatchesName(OS_NAME_WINDOWS_PREFIX + " 8"); /** *

* Is {@code true} if this is Windows 10. *

*

* The field will return {@code false} if {@code OS_NAME} is {@code null}. *

* * @since 3.5 */ public static final boolean IS_OS_WINDOWS_10 = getOsMatchesName(OS_NAME_WINDOWS_PREFIX + " 10"); /** *

* Is {@code true} if this is z/OS. *

*

* The field will return {@code false} if {@code OS_NAME} is {@code null}. *

* * @since 3.5 */ // Values on a z/OS system I tested (Gary Gregory - 2016-03-12) // os.arch = s390x // os.encoding = ISO8859_1 // os.name = z/OS // os.version = 02.02.00 public static final boolean IS_OS_ZOS = getOsMatchesName("z/OS"); /** *

* Gets an environment variable, defaulting to {@code defaultValue} if the * variable cannot be read. *

*

* If a {@code SecurityException} is caught, the return value is * {@code defaultValue} and a message is written to {@code System.err}. *

* * @param name the environment variable name * @param defaultValue the default value * @return the environment variable value or {@code defaultValue} if a security * problem occurs * @since 3.8 */ public static String getEnvironmentVariable(final String name, final String defaultValue) { try { final String value = System.getenv(name); return value == null ? defaultValue : value; } catch (final SecurityException ex) { // we are not allowed to look at this property // System.err.println("Caught a SecurityException reading the environment // variable '" + name + "'."); return defaultValue; } } /** * Gets the host name from an environment variable (COMPUTERNAME on Windows, * HOSTNAME elsewhere). * *

* If you want to know what the network stack says is the host name, you should * use {@code InetAddress.getLocalHost().getHostName()}. *

* * @return the host name. Will be {@code null} if the environment variable is * not defined. * @since 3.6 */ public static String getHostName() { return IS_OS_WINDOWS ? System.getenv("COMPUTERNAME") : System.getenv("HOSTNAME"); } /** *

* Decides if the Java version matches. *

* * @param versionPrefix the prefix for the java version * @return true if matches, or false if not or can't determine */ private static boolean getJavaVersionMatches(final String versionPrefix) { return isJavaVersionMatch(JAVA_SPECIFICATION_VERSION, versionPrefix); } /** * Decides if the operating system matches. * * @param osNamePrefix the prefix for the OS name * @param osVersionPrefix the prefix for the version * @return true if matches, or false if not or can't determine */ private static boolean getOsMatches(final String osNamePrefix, final String osVersionPrefix) { return isOSMatch(OS_NAME, OS_VERSION, osNamePrefix, osVersionPrefix); } /** * Decides if the operating system matches. * * @param osNamePrefix the prefix for the OS name * @return true if matches, or false if not or can't determine */ private static boolean getOsMatchesName(final String osNamePrefix) { return isOSNameMatch(OS_NAME, osNamePrefix); } // ----------------------------------------------------------------------- /** *

* Gets a System property, defaulting to {@code null} if the property cannot be * read. *

*

* If a {@code SecurityException} is caught, the return value is {@code null} * and a message is written to {@code System.err}. *

* * @param property the system property name * @return the system property value or {@code null} if a security problem * occurs */ private static String getSystemProperty(final String property) { try { return System.getProperty(property); } catch (final SecurityException ex) { // we are not allowed to look at this property // System.err.println("Caught a SecurityException reading the system property '" // + property // + "'; the SystemUtils property value will default to null."); return null; } } /** *

* Gets the user name. *

* * @return a name * @throws SecurityException if a security manager exists and its * {@code checkPropertyAccess} method doesn't allow * access to the specified system property. * @see System#getProperty(String) * @since 3.10 */ public static String getUserName() { return System.getProperty(USER_NAME_KEY); } /** *

* Gets the user name. *

* * @param defaultValue A default value. * @return a name * @throws SecurityException if a security manager exists and its * {@code checkPropertyAccess} method doesn't allow * access to the specified system property. * @see System#getProperty(String) * @since 3.10 */ public static String getUserName(final String defaultValue) { return System.getProperty(USER_NAME_KEY, defaultValue); } /** * Returns whether the {@link #JAVA_AWT_HEADLESS} value is {@code true}. * * @return {@code true} if {@code JAVA_AWT_HEADLESS} is {@code "true"}, * {@code false} otherwise. * @see #JAVA_AWT_HEADLESS * @since 2.1 * @since Java 1.4 */ public static boolean isJavaAwtHeadless() { return Boolean.TRUE.toString().equals(JAVA_AWT_HEADLESS); } /** *

* Is the Java version at least the requested version. *

*

* * @param requiredVersion the required version, for example 1.31f * @return {@code true} if the actual version is equal or greater than the * required version */ public static boolean isJavaVersionAtLeast(final JavaVersion requiredVersion) { return JAVA_SPECIFICATION_VERSION_AS_ENUM.atLeast(requiredVersion); } /** *

* Is the Java version at most the requested version. *

*

* Example input: *

* * @param requiredVersion the required version, for example 1.31f * @return {@code true} if the actual version is equal or less than the required * version * @since 3.9 */ public static boolean isJavaVersionAtMost(final JavaVersion requiredVersion) { return JAVA_SPECIFICATION_VERSION_AS_ENUM.atMost(requiredVersion); } /** *

* Decides if the Java version matches. *

*

* This method is package private instead of private to support unit test * invocation. *

* * @param version the actual Java version * @param versionPrefix the prefix for the expected Java version * @return true if matches, or false if not or can't determine */ static boolean isJavaVersionMatch(final String version, final String versionPrefix) { if (version == null) { return false; } return version.startsWith(versionPrefix); } /** * Decides if the operating system matches. *

* This method is package private instead of private to support unit test * invocation. *

* * @param osName the actual OS name * @param osVersion the actual OS version * @param osNamePrefix the prefix for the expected OS name * @param osVersionPrefix the prefix for the expected OS version * @return true if matches, or false if not or can't determine */ static boolean isOSMatch(final String osName, final String osVersion, final String osNamePrefix, final String osVersionPrefix) { if (osName == null || osVersion == null) { return false; } return isOSNameMatch(osName, osNamePrefix) && isOSVersionMatch(osVersion, osVersionPrefix); } /** * Decides if the operating system matches. *

* This method is package private instead of private to support unit test * invocation. *

* * @param osName the actual OS name * @param osNamePrefix the prefix for the expected OS name * @return true if matches, or false if not or can't determine */ static boolean isOSNameMatch(final String osName, final String osNamePrefix) { if (osName == null) { return false; } return osName.startsWith(osNamePrefix); } /** * Decides if the operating system version matches. *

* This method is package private instead of private to support unit test * invocation. *

* * @param osVersion the actual OS version * @param osVersionPrefix the prefix for the expected OS version * @return true if matches, or false if not or can't determine */ static boolean isOSVersionMatch(final String osVersion, final String osVersionPrefix) { if (StringUtils.isEmpty(osVersion)) { return false; } // Compare parts of the version string instead of using // String.startsWith(String) because otherwise // osVersionPrefix 10.1 would also match osVersion 10.10 final String[] versionPrefixParts = osVersionPrefix.split("\\."); final String[] versionParts = osVersion.split("\\."); for (int i = 0; i < Math.min(versionPrefixParts.length, versionParts.length); i++) { if (!versionPrefixParts[i].equals(versionParts[i])) { return false; } } return true; } // ----------------------------------------------------------------------- /** *

* SystemUtils instances should NOT be constructed in standard programming. * Instead, the class should be used as {@code SystemUtils.FILE_SEPARATOR}. *

*

* This constructor is public to permit tools that require a JavaBean instance * to operate. *

*/ public SystemUtils() { } }