/* ==================================================================== * The Apache Software License, Version 1.1 * * Copyright (c) 2002-2003 The Apache Software Foundation. All rights * reserved. * * Redistribution and use in source and binary forms, with or without * modification, are permitted provided that the following conditions * are met: * * 1. Redistributions of source code must retain the above copyright * notice, this list of conditions and the following disclaimer. * * 2. Redistributions in binary form must reproduce the above copyright * notice, this list of conditions and the following disclaimer in * the documentation and/or other materials provided with the * distribution. * * 3. The end-user documentation included with the redistribution, if * any, must include the following acknowledgement: * "This product includes software developed by the * Apache Software Foundation (http://www.apache.org/)." * Alternately, this acknowledgement may appear in the software itself, * if and wherever such third-party acknowledgements normally appear. * * 4. The names "The Jakarta Project", "Commons", and "Apache Software * Foundation" must not be used to endorse or promote products derived * from this software without prior written permission. For written * permission, please contact apache@apache.org. * * 5. Products derived from this software may not be called "Apache" * nor may "Apache" appear in their names without prior written * permission of the Apache Software Foundation. * * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE * DISCLAIMED. IN NO EVENT SHALL THE APACHE SOFTWARE FOUNDATION OR * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF * USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF * SUCH DAMAGE. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * . */ package org.apache.commons.lang; /** *

Helpers for java.lang.System.

* *

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

* * @author Based on code from Avalon Excalibur * @author Based on code from Lucene * @author Stephen Colebourne * @author Steve Downey * @author Gary Gregory * @author Michael Becke * @author Tetsuya Kaneuchi * @since 1.0 * @version $Id: SystemUtils.java,v 1.1 2012/08/30 16:24:42 marcin Exp $ */ public class SystemUtils { // System property constants //----------------------------------------------------------------------- // These MUST be declared first. Other constants depend on this. /** *

The file.encoding System Property.

*

File encoding, such as Cp1252.

* *

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

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

The file.separator System Property. * File separator ("/" on UNIX).

* *

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

* * @since Java 1.1. */ public static final String FILE_SEPARATOR = getSystemProperty("file.separator"); /** *

The java.class.path System Property. Java class path.

* *

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

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

The java.class.version System Property. * Java class format version number.

* *

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

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

The 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 null if the runtime does not have * security access to read this property or the property does not exist.

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

The java.ext.dirs System Property. Path of extension directory * or directories.

* *

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

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

The java.home System Property. Java installation directory.

* *

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

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

The java.io.tmpdir System Property. Default temp file path.

* *

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

* * @since Java 1.2 */ public static final String JAVA_IO_TMPDIR = getSystemProperty("java.io.tmpdir"); /** *

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

* *

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

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

The java.runtime.name System Property. Java Runtime Environment * name.

* *

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

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

The java.runtime.version System Property. Java Runtime Environment * version.

* *

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

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

The java.specification.name System Property. Java Runtime Environment * specification name.

* *

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

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

The java.specification.vendor System Property. Java Runtime Environment * specification vendor.

* *

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

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

The java.specification.version System Property. Java Runtime Environment * specification version.

* *

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

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

The java.vendor System Property. Java vendor-specific string.

* *

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

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

The java.vendor.url System Property. Java vendor URL.

* *

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

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

The java.version System Property. Java version number.

* *

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

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

The java.vm.info System Property. Java Virtual Machine implementation * info.

* *

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

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

The java.vm.name System Property. Java Virtual Machine implementation * name.

* *

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

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

The java.vm.specification.name System Property. Java Virtual Machine * specification name.

* *

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

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

The java.vm.specification.vendor System Property. Java Virtual * Machine specification vendor.

* *

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

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

The java.vm.specification.version System Property. Java Virtual Machine * specification version.

* *

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

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

The java.vm.vendor System Property. Java Virtual Machine implementation * vendor.

* *

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

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

The java.vm.version System Property. Java Virtual Machine * implementation version.

* *

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

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

The line.separator System Property. Line separator * ("\n<" on UNIX).

* *

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

* * @since Java 1.1 */ public static final String LINE_SEPARATOR = getSystemProperty("line.separator"); /** *

The os.arch System Property. Operating system architecture.

* *

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

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

The os.name System Property. Operating system name.

* *

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

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

The os.version System Property. Operating system version.

* *

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

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

The path.separator System Property. Path separator * (":" on UNIX).

* *

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

* * @since Java 1.1 */ public static final String PATH_SEPARATOR = getSystemProperty("path.separator"); /** *

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

* *

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

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

The user.dir System Property. User's current working * directory.

* *

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

* * @since Java 1.1 */ public static final String USER_DIR = getSystemProperty("user.dir"); /** *

The user.home System Property. User's home directory.

* *

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

* * @since Java 1.1 */ public static final String USER_HOME = getSystemProperty("user.home"); /** *

The user.language System Property. User's language code, * such as 'en'.

* *

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

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

The user.name System Property. User's account name.

* *

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

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

Gets the Java version as a float.

* *

Example return values:

* * *

The field will return zero if {@link #JAVA_VERSION} is null.

* * @since 2.0 */ public static final float JAVA_VERSION_FLOAT = getJavaVersionAsFloat(); /** *

Gets the Java version as an int.

* *

Example return values:

* * *

The field will return zero if {@link #JAVA_VERSION} is null.

* * @since 2.0 */ public static final int JAVA_VERSION_INT = getJavaVersionAsInt(); // Java version checks //----------------------------------------------------------------------- // These MUST be declared after those above as they depend on the // values being set up /** *

Is true if this is Java version 1.1 (also 1.1.x versions).

* *

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

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

Is true if this is Java version 1.2 (also 1.2.x versions).

* *

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

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

Is true if this is Java version 1.3 (also 1.3.x versions).

* *

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

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

Is true if this is Java version 1.4 (also 1.4.x versions).

* *

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

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

Is true if this is Java version 1.5 (also 1.5.x versions).

* *

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

*/ public static final boolean IS_JAVA_1_5 = getJavaVersionMatches("1.5"); // 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 commons-dev@jakarta.apache.org // if you want another added or a mistake corrected /** *

Is true if this is AIX.

* *

The field will return false if OS_NAME is * null.

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

Is true if this is HP-UX.

* *

The field will return false if OS_NAME is * null.

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

Is true if this is Irix.

* *

The field will return false if OS_NAME is * null.

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

Is true if this is Linux.

* *

The field will return false if OS_NAME is * null.

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

Is true if this is Mac.

* *

The field will return false if OS_NAME is * null.

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

Is true if this is Mac.

* *

The field will return false if OS_NAME is * null.

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

Is true if this is OS/2.

* *

The field will return false if OS_NAME is * null.

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

Is true if this is Solaris.

* *

The field will return false if OS_NAME is * null.

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

Is true if this is SunOS.

* *

The field will return false if OS_NAME is * null.

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

Is true if this is Windows.

* *

The field will return false if OS_NAME is * null.

* * @since 2.0 */ public static final boolean IS_OS_WINDOWS = getOSMatches("Windows"); /** *

Is true if this is Windows 2000.

* *

The field will return false if OS_NAME is * null.

* * @since 2.0 */ public static final boolean IS_OS_WINDOWS_2000 = getOSMatches("Windows", "5.0"); /** *

Is true if this is Windows 95.

* *

The field will return false if OS_NAME is * null.

* * @since 2.0 */ public static final boolean IS_OS_WINDOWS_95 = getOSMatches("Windows 9", "4.0"); // JDK 1.2 running on Windows98 returns 'Windows 95', hence the above /** *

Is true if this is Windows 98.

* *

The field will return false if OS_NAME is * null.

* * @since 2.0 */ public static final boolean IS_OS_WINDOWS_98 = getOSMatches("Windows 9", "4.1"); // JDK 1.2 running on Windows98 returns 'Windows 95', hence the above /** *

Is true if this is Windows ME.

* *

The field will return false if OS_NAME is * null.

* * @since 2.0 */ public static final boolean IS_OS_WINDOWS_ME = getOSMatches("Windows", "4.9"); // JDK 1.2 running on WindowsME may return 'Windows 95', hence the above /** *

Is true if this is Windows NT.

* *

The field will return false if OS_NAME is * null.

* * @since 2.0 */ public static final boolean IS_OS_WINDOWS_NT = getOSMatches("Windows NT"); // Windows 2000 returns 'Windows 2000' but may suffer from same JDK1.2 problem /** *

Is true if this is Windows XP.

* *

The field will return false if OS_NAME is * null.

* * @since 2.0 */ public static final boolean IS_OS_WINDOWS_XP = getOSMatches("Windows", "5.1"); // Windows XP returns 'Windows 2000' just for fun... //----------------------------------------------------------------------- /** *

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

* *

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

*/ public SystemUtils() { } //----------------------------------------------------------------------- /** *

Gets the Java version number as a float.

* *

Example return values:

* * * @return the version, for example 1.31f for JDK 1.3.1 * @deprecated Use {@link #JAVA_VERSION_FLOAT} instead. * Method will be removed in Commons Lang 3.0. */ public static float getJavaVersion() { return JAVA_VERSION_FLOAT; } /** *

Gets the Java version number as a float.

* *

Example return values:

* * *

Patch releases are not reported. * Zero is returned if {@link #JAVA_VERSION} is null.

* * @return the version, for example 1.31f for JDK 1.3.1 */ private static float getJavaVersionAsFloat() { if (JAVA_VERSION == null) { return 0f; } String str = JAVA_VERSION.substring(0, 3); if (JAVA_VERSION.length() >= 5) { str = str + JAVA_VERSION.substring(4, 5); } return Float.parseFloat(str); } /** *

Gets the Java version number as an int.

* *

Example return values:

* * *

Patch releases are not reported. * Zero is returned if {@link #JAVA_VERSION} is null.

* * @return the version, for example 131 for JDK 1.3.1 */ private static int getJavaVersionAsInt() { if (JAVA_VERSION == null) { return 0; } String str = JAVA_VERSION.substring(0, 1); str = str + JAVA_VERSION.substring(2, 3); if (JAVA_VERSION.length() >= 5) { str = str + JAVA_VERSION.substring(4, 5); } else { str = str + "0"; } return Integer.parseInt(str); } /** *

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(String versionPrefix) { if (JAVA_VERSION == null) { return false; } return JAVA_VERSION.startsWith(versionPrefix); } /** *

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 getOSMatches(String osNamePrefix) { if (OS_NAME == null) { return false; } return OS_NAME.startsWith(osNamePrefix); } /** *

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(String osNamePrefix, String osVersionPrefix) { if (OS_NAME == null || OS_VERSION == null) { return false; } return OS_NAME.startsWith(osNamePrefix) && OS_VERSION.startsWith(osVersionPrefix); } //----------------------------------------------------------------------- /** *

Gets a System property, defaulting to null if the property * cannot be read.

* *

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

* * @param property the system property name * @return the system property value or null if a security problem occurs */ private static String getSystemProperty(String property) { try { return System.getProperty(property); } catch (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; } } /** *

Is the Java version at least the requested version.

* *

Example input:

* * * @param requiredVersion the required version, for example 1.31f * @return true if the actual version is equal or greater * than the required version */ public static boolean isJavaVersionAtLeast(float requiredVersion) { return (JAVA_VERSION_FLOAT >= requiredVersion); } /** *

Is the Java version at least the requested version.

* *

Example input:

* * * @param requiredVersion the required version, for example 131 * @return true if the actual version is equal or greater * than the required version * @since 2.0 */ public static boolean isJavaVersionAtLeast(int requiredVersion) { return (JAVA_VERSION_INT >= requiredVersion); } }