/* * Copyright (c) 1994, 2014, Oracle and/or its affiliates. All rights reserved. * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. * * This code is free software; you can redistribute it and/or modify it * under the terms of the GNU General Public License version 2 only, as * published by the Free Software Foundation. Oracle designates this * particular file as subject to the "Classpath" exception as provided * by Oracle in the LICENSE file that accompanied this code. * * This code is distributed in the hope that it will be useful, but WITHOUT * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License * version 2 for more details (a copy is included in the LICENSE file that * accompanied this code). * * You should have received a copy of the GNU General Public License version * 2 along with this work; if not, write to the Free Software Foundation, * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. * * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA * or visit www.oracle.com if you need additional information or have any * questions. */ package java.lang; import java.io.*; import java.lang.reflect.Executable; import java.lang.annotation.Annotation; import java.security.AccessControlContext; import java.util.Properties; import java.util.PropertyPermission; import java.util.Map; import java.security.AccessController; import java.security.PrivilegedAction; import java.nio.channels.Channel; import java.nio.channels.spi.SelectorProvider; import java.util.Objects; import java.util.ResourceBundle; import java.security.Permission; import java.util.Arrays; import java.util.ServiceConfigurationError; import java.util.ServiceLoader; import java.util.function.Supplier; import sun.util.logger.JdkLoggerProvider; import sun.nio.ch.Interruptible; import sun.reflect.CallerSensitive; import sun.reflect.Reflection; import sun.security.util.SecurityConstants; import sun.reflect.annotation.AnnotationType; import jdk.internal.HotSpotIntrinsicCandidate; import jdk.internal.misc.JavaLangAccess;; import jdk.internal.misc.SharedSecrets;; import sun.util.logger.BootstrapLogger; import sun.util.logger.LazyLoggers; import sun.util.logger.LocalizedLoggerWrapper; /** * The System class contains several useful class fields * and methods. It cannot be instantiated. * *

Among the facilities provided by the System class * are standard input, standard output, and error output streams; * access to externally defined properties and environment * variables; a means of loading files and libraries; and a utility * method for quickly copying a portion of an array. * * @author unascribed * @since 1.0 */ public final class System { /* register the natives via the static initializer. * * VM will invoke the initializeSystemClass method to complete * the initialization for this class separated from clinit. * Note that to use properties set by the VM, see the constraints * described in the initializeSystemClass method. */ private static native void registerNatives(); static { registerNatives(); } /** Don't let anyone instantiate this class */ private System() { } /** * The "standard" input stream. This stream is already * open and ready to supply input data. Typically this stream * corresponds to keyboard input or another input source specified by * the host environment or user. */ public static final InputStream in = null; /** * The "standard" output stream. This stream is already * open and ready to accept output data. Typically this stream * corresponds to display output or another output destination * specified by the host environment or user. *

* For simple stand-alone Java applications, a typical way to write * a line of output data is: *

     *     System.out.println(data)
     * 
*

* See the println methods in class PrintStream. * * @see java.io.PrintStream#println() * @see java.io.PrintStream#println(boolean) * @see java.io.PrintStream#println(char) * @see java.io.PrintStream#println(char[]) * @see java.io.PrintStream#println(double) * @see java.io.PrintStream#println(float) * @see java.io.PrintStream#println(int) * @see java.io.PrintStream#println(long) * @see java.io.PrintStream#println(java.lang.Object) * @see java.io.PrintStream#println(java.lang.String) */ public static final PrintStream out = null; /** * The "standard" error output stream. This stream is already * open and ready to accept output data. *

* Typically this stream corresponds to display output or another * output destination specified by the host environment or user. By * convention, this output stream is used to display error messages * or other information that should come to the immediate attention * of a user even if the principal output stream, the value of the * variable out, has been redirected to a file or other * destination that is typically not continuously monitored. */ public static final PrintStream err = null; /* The security manager for the system. */ private static volatile SecurityManager security = null; /** * Reassigns the "standard" input stream. * *

First, if there is a security manager, its checkPermission * method is called with a RuntimePermission("setIO") permission * to see if it's ok to reassign the "standard" input stream. * * @param in the new standard input stream. * * @throws SecurityException * if a security manager exists and its * checkPermission method doesn't allow * reassigning of the standard input stream. * * @see SecurityManager#checkPermission * @see java.lang.RuntimePermission * * @since 1.1 */ public static void setIn(InputStream in) { checkIO(); setIn0(in); } /** * Reassigns the "standard" output stream. * *

First, if there is a security manager, its checkPermission * method is called with a RuntimePermission("setIO") permission * to see if it's ok to reassign the "standard" output stream. * * @param out the new standard output stream * * @throws SecurityException * if a security manager exists and its * checkPermission method doesn't allow * reassigning of the standard output stream. * * @see SecurityManager#checkPermission * @see java.lang.RuntimePermission * * @since 1.1 */ public static void setOut(PrintStream out) { checkIO(); setOut0(out); } /** * Reassigns the "standard" error output stream. * *

First, if there is a security manager, its checkPermission * method is called with a RuntimePermission("setIO") permission * to see if it's ok to reassign the "standard" error output stream. * * @param err the new standard error output stream. * * @throws SecurityException * if a security manager exists and its * checkPermission method doesn't allow * reassigning of the standard error output stream. * * @see SecurityManager#checkPermission * @see java.lang.RuntimePermission * * @since 1.1 */ public static void setErr(PrintStream err) { checkIO(); setErr0(err); } private static volatile Console cons = null; /** * Returns the unique {@link java.io.Console Console} object associated * with the current Java virtual machine, if any. * * @return The system console, if any, otherwise {@code null}. * * @since 1.6 */ public static Console console() { if (cons == null) { synchronized (System.class) { cons = SharedSecrets.getJavaIOAccess().console(); } } return cons; } /** * Returns the channel inherited from the entity that created this * Java virtual machine. * *

This method returns the channel obtained by invoking the * {@link java.nio.channels.spi.SelectorProvider#inheritedChannel * inheritedChannel} method of the system-wide default * {@link java.nio.channels.spi.SelectorProvider} object.

* *

In addition to the network-oriented channels described in * {@link java.nio.channels.spi.SelectorProvider#inheritedChannel * inheritedChannel}, this method may return other kinds of * channels in the future. * * @return The inherited channel, if any, otherwise {@code null}. * * @throws IOException * If an I/O error occurs * * @throws SecurityException * If a security manager is present and it does not * permit access to the channel. * * @since 1.5 */ public static Channel inheritedChannel() throws IOException { return SelectorProvider.provider().inheritedChannel(); } private static void checkIO() { SecurityManager sm = getSecurityManager(); if (sm != null) { sm.checkPermission(new RuntimePermission("setIO")); } } private static native void setIn0(InputStream in); private static native void setOut0(PrintStream out); private static native void setErr0(PrintStream err); /** * Sets the System security. * *

If there is a security manager already installed, this method first * calls the security manager's checkPermission method * with a RuntimePermission("setSecurityManager") * permission to ensure it's ok to replace the existing * security manager. * This may result in throwing a SecurityException. * *

Otherwise, the argument is established as the current * security manager. If the argument is null and no * security manager has been established, then no action is taken and * the method simply returns. * * @param s the security manager. * @exception SecurityException if the security manager has already * been set and its checkPermission method * doesn't allow it to be replaced. * @see #getSecurityManager * @see SecurityManager#checkPermission * @see java.lang.RuntimePermission */ public static void setSecurityManager(final SecurityManager s) { try { s.checkPackageAccess("java.lang"); } catch (Exception e) { // no-op } setSecurityManager0(s); } private static synchronized void setSecurityManager0(final SecurityManager s) { SecurityManager sm = getSecurityManager(); if (sm != null) { // ask the currently installed security manager if we // can replace it. sm.checkPermission(new RuntimePermission ("setSecurityManager")); } if ((s != null) && (s.getClass().getClassLoader() != null)) { // New security manager class is not on bootstrap classpath. // Cause policy to get initialized before we install the new // security manager, in order to prevent infinite loops when // trying to initialize the policy (which usually involves // accessing some security and/or system properties, which in turn // calls the installed security manager's checkPermission method // which will loop infinitely if there is a non-system class // (in this case: the new security manager class) on the stack). AccessController.doPrivileged(new PrivilegedAction<>() { public Object run() { s.getClass().getProtectionDomain().implies (SecurityConstants.ALL_PERMISSION); return null; } }); } security = s; } /** * Gets the system security interface. * * @return if a security manager has already been established for the * current application, then that security manager is returned; * otherwise, null is returned. * @see #setSecurityManager */ public static SecurityManager getSecurityManager() { return security; } /** * Returns the current time in milliseconds. Note that * while the unit of time of the return value is a millisecond, * the granularity of the value depends on the underlying * operating system and may be larger. For example, many * operating systems measure time in units of tens of * milliseconds. * *

See the description of the class Date for * a discussion of slight discrepancies that may arise between * "computer time" and coordinated universal time (UTC). * * @return the difference, measured in milliseconds, between * the current time and midnight, January 1, 1970 UTC. * @see java.util.Date */ @HotSpotIntrinsicCandidate public static native long currentTimeMillis(); /** * Returns the current value of the running Java Virtual Machine's * high-resolution time source, in nanoseconds. * *

This method can only be used to measure elapsed time and is * not related to any other notion of system or wall-clock time. * The value returned represents nanoseconds since some fixed but * arbitrary origin time (perhaps in the future, so values * may be negative). The same origin is used by all invocations of * this method in an instance of a Java virtual machine; other * virtual machine instances are likely to use a different origin. * *

This method provides nanosecond precision, but not necessarily * nanosecond resolution (that is, how frequently the value changes) * - no guarantees are made except that the resolution is at least as * good as that of {@link #currentTimeMillis()}. * *

Differences in successive calls that span greater than * approximately 292 years (263 nanoseconds) will not * correctly compute elapsed time due to numerical overflow. * *

The values returned by this method become meaningful only when * the difference between two such values, obtained within the same * instance of a Java virtual machine, is computed. * *

For example, to measure how long some code takes to execute: *

 {@code
     * long startTime = System.nanoTime();
     * // ... the code being measured ...
     * long elapsedNanos = System.nanoTime() - startTime;}
* *

To compare elapsed time against a timeout, use

 {@code
     * if (System.nanoTime() - startTime >= timeoutNanos) ...}
* instead of
 {@code
     * if (System.nanoTime() >= startTime + timeoutNanos) ...}
* because of the possibility of numerical overflow. * * @return the current value of the running Java Virtual Machine's * high-resolution time source, in nanoseconds * @since 1.5 */ @HotSpotIntrinsicCandidate public static native long nanoTime(); /** * Copies an array from the specified source array, beginning at the * specified position, to the specified position of the destination array. * A subsequence of array components are copied from the source * array referenced by src to the destination array * referenced by dest. The number of components copied is * equal to the length argument. The components at * positions srcPos through * srcPos+length-1 in the source array are copied into * positions destPos through * destPos+length-1, respectively, of the destination * array. *

* If the src and dest arguments refer to the * same array object, then the copying is performed as if the * components at positions srcPos through * srcPos+length-1 were first copied to a temporary * array with length components and then the contents of * the temporary array were copied into positions * destPos through destPos+length-1 of the * destination array. *

* If dest is null, then a * NullPointerException is thrown. *

* If src is null, then a * NullPointerException is thrown and the destination * array is not modified. *

* Otherwise, if any of the following is true, an * ArrayStoreException is thrown and the destination is * not modified: *

*

* Otherwise, if any of the following is true, an * IndexOutOfBoundsException is * thrown and the destination is not modified: *

*

* Otherwise, if any actual component of the source array from * position srcPos through * srcPos+length-1 cannot be converted to the component * type of the destination array by assignment conversion, an * ArrayStoreException is thrown. In this case, let * k be the smallest nonnegative integer less than * length such that src[srcPos+k] * cannot be converted to the component type of the destination * array; when the exception is thrown, source array components from * positions srcPos through * srcPos+k-1 * will already have been copied to destination array positions * destPos through * destPos+k-1 and no other * positions of the destination array will have been modified. * (Because of the restrictions already itemized, this * paragraph effectively applies only to the situation where both * arrays have component types that are reference types.) * * @param src the source array. * @param srcPos starting position in the source array. * @param dest the destination array. * @param destPos starting position in the destination data. * @param length the number of array elements to be copied. * @exception IndexOutOfBoundsException if copying would cause * access of data outside array bounds. * @exception ArrayStoreException if an element in the src * array could not be stored into the dest array * because of a type mismatch. * @exception NullPointerException if either src or * dest is null. */ @HotSpotIntrinsicCandidate public static native void arraycopy(Object src, int srcPos, Object dest, int destPos, int length); /** * Returns the same hash code for the given object as * would be returned by the default method hashCode(), * whether or not the given object's class overrides * hashCode(). * The hash code for the null reference is zero. * * @param x object for which the hashCode is to be calculated * @return the hashCode * @since 1.1 */ @HotSpotIntrinsicCandidate public static native int identityHashCode(Object x); /** * System properties. The following properties are guaranteed to be defined: *

*
java.version
Java version number *
java.vendor
Java vendor specific string *
java.vendor.url
Java vendor URL *
java.home
Java installation directory *
java.class.version
Java class version number *
java.class.path
Java classpath *
os.name
Operating System Name *
os.arch
Operating System Architecture *
os.version
Operating System Version *
file.separator
File separator ("/" on Unix) *
path.separator
Path separator (":" on Unix) *
line.separator
Line separator ("\n" on Unix) *
user.name
User account name *
user.home
User home directory *
user.dir
User's current working directory *
*/ private static Properties props; private static native Properties initProperties(Properties props); /** * Determines the current system properties. *

* First, if there is a security manager, its * checkPropertiesAccess method is called with no * arguments. This may result in a security exception. *

* The current set of system properties for use by the * {@link #getProperty(String)} method is returned as a * Properties object. If there is no current set of * system properties, a set of system properties is first created and * initialized. This set of system properties always includes values * for the following keys: * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * *
KeyDescription of Associated Value
java.versionJava Runtime Environment version
java.vendorJava Runtime Environment vendor
java.vendor.urlJava vendor URL
java.homeJava installation directory
java.vm.specification.versionJava Virtual Machine specification version
java.vm.specification.vendorJava Virtual Machine specification vendor
java.vm.specification.nameJava Virtual Machine specification name
java.vm.versionJava Virtual Machine implementation version
java.vm.vendorJava Virtual Machine implementation vendor
java.vm.nameJava Virtual Machine implementation name
java.specification.versionJava Runtime Environment specification version
java.specification.vendorJava Runtime Environment specification vendor
java.specification.nameJava Runtime Environment specification name
java.class.versionJava class format version number
java.class.pathJava class path
java.library.pathList of paths to search when loading libraries
java.io.tmpdirDefault temp file path
java.compilerName of JIT compiler to use
os.nameOperating system name
os.archOperating system architecture
os.versionOperating system version
file.separatorFile separator ("/" on UNIX)
path.separatorPath separator (":" on UNIX)
line.separatorLine separator ("\n" on UNIX)
user.nameUser's account name
user.homeUser's home directory
user.dirUser's current working directory
*

* Multiple paths in a system property value are separated by the path * separator character of the platform. *

* Note that even if the security manager does not permit the * getProperties operation, it may choose to permit the * {@link #getProperty(String)} operation. * * @return the system properties * @exception SecurityException if a security manager exists and its * checkPropertiesAccess method doesn't allow access * to the system properties. * @see #setProperties * @see java.lang.SecurityException * @see java.lang.SecurityManager#checkPropertiesAccess() * @see java.util.Properties */ public static Properties getProperties() { SecurityManager sm = getSecurityManager(); if (sm != null) { sm.checkPropertiesAccess(); } return props; } /** * Returns the system-dependent line separator string. It always * returns the same value - the initial value of the {@linkplain * #getProperty(String) system property} {@code line.separator}. * *

On UNIX systems, it returns {@code "\n"}; on Microsoft * Windows systems it returns {@code "\r\n"}. * * @return the system-dependent line separator string * @since 1.7 */ public static String lineSeparator() { return lineSeparator; } private static String lineSeparator; /** * Sets the system properties to the Properties * argument. *

* First, if there is a security manager, its * checkPropertiesAccess method is called with no * arguments. This may result in a security exception. *

* The argument becomes the current set of system properties for use * by the {@link #getProperty(String)} method. If the argument is * null, then the current set of system properties is * forgotten. * * @param props the new system properties. * @exception SecurityException if a security manager exists and its * checkPropertiesAccess method doesn't allow access * to the system properties. * @see #getProperties * @see java.util.Properties * @see java.lang.SecurityException * @see java.lang.SecurityManager#checkPropertiesAccess() */ public static void setProperties(Properties props) { SecurityManager sm = getSecurityManager(); if (sm != null) { sm.checkPropertiesAccess(); } if (props == null) { props = new Properties(); initProperties(props); } System.props = props; } /** * Gets the system property indicated by the specified key. *

* First, if there is a security manager, its * checkPropertyAccess method is called with the key as * its argument. This may result in a SecurityException. *

* If there is no current set of system properties, a set of system * properties is first created and initialized in the same manner as * for the getProperties method. * * @param key the name of the system property. * @return the string value of the system property, * or null if there is no property with that key. * * @exception SecurityException if a security manager exists and its * checkPropertyAccess method doesn't allow * access to the specified system property. * @exception NullPointerException if key is * null. * @exception IllegalArgumentException if key is empty. * @see #setProperty * @see java.lang.SecurityException * @see java.lang.SecurityManager#checkPropertyAccess(java.lang.String) * @see java.lang.System#getProperties() */ public static String getProperty(String key) { checkKey(key); SecurityManager sm = getSecurityManager(); if (sm != null) { sm.checkPropertyAccess(key); } return props.getProperty(key); } /** * Gets the system property indicated by the specified key. *

* First, if there is a security manager, its * checkPropertyAccess method is called with the * key as its argument. *

* If there is no current set of system properties, a set of system * properties is first created and initialized in the same manner as * for the getProperties method. * * @param key the name of the system property. * @param def a default value. * @return the string value of the system property, * or the default value if there is no property with that key. * * @exception SecurityException if a security manager exists and its * checkPropertyAccess method doesn't allow * access to the specified system property. * @exception NullPointerException if key is * null. * @exception IllegalArgumentException if key is empty. * @see #setProperty * @see java.lang.SecurityManager#checkPropertyAccess(java.lang.String) * @see java.lang.System#getProperties() */ public static String getProperty(String key, String def) { checkKey(key); SecurityManager sm = getSecurityManager(); if (sm != null) { sm.checkPropertyAccess(key); } return props.getProperty(key, def); } /** * Sets the system property indicated by the specified key. *

* First, if a security manager exists, its * SecurityManager.checkPermission method * is called with a PropertyPermission(key, "write") * permission. This may result in a SecurityException being thrown. * If no exception is thrown, the specified property is set to the given * value. * * @param key the name of the system property. * @param value the value of the system property. * @return the previous value of the system property, * or null if it did not have one. * * @exception SecurityException if a security manager exists and its * checkPermission method doesn't allow * setting of the specified property. * @exception NullPointerException if key or * value is null. * @exception IllegalArgumentException if key is empty. * @see #getProperty * @see java.lang.System#getProperty(java.lang.String) * @see java.lang.System#getProperty(java.lang.String, java.lang.String) * @see java.util.PropertyPermission * @see SecurityManager#checkPermission * @since 1.2 */ public static String setProperty(String key, String value) { checkKey(key); SecurityManager sm = getSecurityManager(); if (sm != null) { sm.checkPermission(new PropertyPermission(key, SecurityConstants.PROPERTY_WRITE_ACTION)); } return (String) props.setProperty(key, value); } /** * Removes the system property indicated by the specified key. *

* First, if a security manager exists, its * SecurityManager.checkPermission method * is called with a PropertyPermission(key, "write") * permission. This may result in a SecurityException being thrown. * If no exception is thrown, the specified property is removed. * * @param key the name of the system property to be removed. * @return the previous string value of the system property, * or null if there was no property with that key. * * @exception SecurityException if a security manager exists and its * checkPropertyAccess method doesn't allow * access to the specified system property. * @exception NullPointerException if key is * null. * @exception IllegalArgumentException if key is empty. * @see #getProperty * @see #setProperty * @see java.util.Properties * @see java.lang.SecurityException * @see java.lang.SecurityManager#checkPropertiesAccess() * @since 1.5 */ public static String clearProperty(String key) { checkKey(key); SecurityManager sm = getSecurityManager(); if (sm != null) { sm.checkPermission(new PropertyPermission(key, "write")); } return (String) props.remove(key); } private static void checkKey(String key) { if (key == null) { throw new NullPointerException("key can't be null"); } if (key.equals("")) { throw new IllegalArgumentException("key can't be empty"); } } /** * Gets the value of the specified environment variable. An * environment variable is a system-dependent external named * value. * *

If a security manager exists, its * {@link SecurityManager#checkPermission checkPermission} * method is called with a * {@link RuntimePermission}("getenv."+name) * permission. This may result in a {@link SecurityException} * being thrown. If no exception is thrown the value of the * variable name is returned. * *

System * properties and environment variables are both * conceptually mappings between names and values. Both * mechanisms can be used to pass user-defined information to a * Java process. Environment variables have a more global effect, * because they are visible to all descendants of the process * which defines them, not just the immediate Java subprocess. * They can have subtly different semantics, such as case * insensitivity, on different operating systems. For these * reasons, environment variables are more likely to have * unintended side effects. It is best to use system properties * where possible. Environment variables should be used when a * global effect is desired, or when an external system interface * requires an environment variable (such as PATH). * *

On UNIX systems the alphabetic case of name is * typically significant, while on Microsoft Windows systems it is * typically not. For example, the expression * System.getenv("FOO").equals(System.getenv("foo")) * is likely to be true on Microsoft Windows. * * @param name the name of the environment variable * @return the string value of the variable, or null * if the variable is not defined in the system environment * @throws NullPointerException if name is null * @throws SecurityException * if a security manager exists and its * {@link SecurityManager#checkPermission checkPermission} * method doesn't allow access to the environment variable * name * @see #getenv() * @see ProcessBuilder#environment() */ public static String getenv(String name) { SecurityManager sm = getSecurityManager(); if (sm != null) { sm.checkPermission(new RuntimePermission("getenv."+name)); } return ProcessEnvironment.getenv(name); } /** * Returns an unmodifiable string map view of the current system environment. * The environment is a system-dependent mapping from names to * values which is passed from parent to child processes. * *

If the system does not support environment variables, an * empty map is returned. * *

The returned map will never contain null keys or values. * Attempting to query the presence of a null key or value will * throw a {@link NullPointerException}. Attempting to query * the presence of a key or value which is not of type * {@link String} will throw a {@link ClassCastException}. * *

The returned map and its collection views may not obey the * general contract of the {@link Object#equals} and * {@link Object#hashCode} methods. * *

The returned map is typically case-sensitive on all platforms. * *

If a security manager exists, its * {@link SecurityManager#checkPermission checkPermission} * method is called with a * {@link RuntimePermission}("getenv.*") * permission. This may result in a {@link SecurityException} being * thrown. * *

When passing information to a Java subprocess, * system properties * are generally preferred over environment variables. * * @return the environment as a map of variable names to values * @throws SecurityException * if a security manager exists and its * {@link SecurityManager#checkPermission checkPermission} * method doesn't allow access to the process environment * @see #getenv(String) * @see ProcessBuilder#environment() * @since 1.5 */ public static java.util.Map getenv() { SecurityManager sm = getSecurityManager(); if (sm != null) { sm.checkPermission(new RuntimePermission("getenv.*")); } return ProcessEnvironment.getenv(); } /** * The minimum set of methods that a logger returned by the * {@link LoggerFinder} service should implement. * Instances of loggers implementing this interface are obtained from * the {@link java.lang.System System} class, by calling * {@link java.lang.System#getLogger(java.lang.String) System.getLogger(loggerName)} * or {@link java.lang.System#getLogger(java.lang.String, java.util.ResourceBundle) * System.getLogger(loggerName, bundle)}. *

* Unless * * @see java.lang.System * @see java.lang.System.LoggerFinder * * @since 9 * */ public interface Logger { /** * Message levels for the {@link Logger loggers} * returned by the {@link LoggerFinder} service. *

* A level has a {@linkplain #getName() name} and {@linkplain * #getSeverity() severity}. * Standard level values are {@link #ALL}, {@link #TRACE}, {@link #DEBUG}, * {@link #INFO}, {@link #WARNING}, {@link #ERROR}, {@link #OFF}, * by order of increasing severity. *
* {@link #ALL} and {@link #OFF} * are simple markers with severities mapped respectively to * {@link java.lang.Integer#MIN_VALUE Integer.MIN_VALUE} and * {@link java.lang.Integer#MAX_VALUE Integer.MAX_VALUE}. *
* For convenience the severity values are mapped to corresponding * {@link java.util.logging.Level java.util.logging.Level} severity * values. * * @since 9 * * @see java.lang.System.LoggerFinder * @see java.lang.System.Logger */ public enum Level { // for convenience, we're reusing java.util.logging.Level int values // the mapping logic in sun.util.logging.PlatformLogger depends // on this. /** * A marker to indicate that all levels are enabled. * This level {@linkplain #getSeverity() severity} is * {@link Integer#MIN_VALUE}. */ ALL(Integer.MIN_VALUE), // usually mapped to/from j.u.l.Level.ALL /** * {@code TRACE} level: usually used to log diagnostic information. * This level {@linkplain #getSeverity() severity} is * {@code 400}. */ TRACE(400), // usually mapped to/from j.u.l.Level.FINER /** * {@code DEBUG} level: usually used to log debug information traces. * This level {@linkplain #getSeverity() severity} is * {@code 500}. */ DEBUG(500), // usually mapped to/from j.u.l.Level.FINEST/FINE/CONFIG /** * {@code INFO} level: usually used to log information messages. * This level {@linkplain #getSeverity() severity} is * {@code 800}. */ INFO(800), // usually mapped to/from j.u.l.Level.INFO /** * {@code WARNING} level: usually used to log warning messages. * This level {@linkplain #getSeverity() severity} is * {@code 900}. */ WARNING(900), // usually mapped to/from j.u.l.Level.WARNING /** * {@code ERROR} level: usually used to log error messages. * This level {@linkplain #getSeverity() severity} is * {@code 1000}. */ ERROR(1000), // usually mapped to/from j.u.l.Level.SEVERE /** * A marker to indicate that all levels are disabled. * This level {@linkplain #getSeverity() severity} is * {@link Integer#MAX_VALUE}. */ OFF(Integer.MAX_VALUE); // usually mapped to/from j.u.l.Level.OFF private final int severity; private Level(int severity) { this.severity = severity; } /** * Returns the name of this level. * @return this level {@linkplain #name()}. */ public final String getName() { return name(); } /** * Returns the severity of this level. * A higher severity means a more severe condition. * @return this level severity. */ public final int getSeverity() { return severity; } } /** * Returns the name of this logger. * * @return the logger name. */ public String getName(); /** * Checks if a message of the given level would be logged by * this logger. * * @param level the message level. * @return {@code true} if the given message level is currently being logged. * * @throws NullPointerException if {@code level} is {@code null}. */ public boolean isLoggable(Level level); /** * Logs a message. * * @implSpec The default implementation for this method calls * {@code this.log(level, (ResourceBundle)null, msg, (Object[])null);} * * @param level the message level. * @param msg the string message (or a key in the message catalog, if * this logger is a {@link * LoggerFinder#getLocalizedLogger(java.lang.String, java.util.ResourceBundle, java.lang.Class) * localized logger}). * * @throws NullPointerException if {@code level} is {@code null}. */ public default void log(Level level, String msg) { log(level, (ResourceBundle) null, msg, (Object[]) null); } /** * Logs a lazily supplied message. *

* If the logger is currently enabled for the given message level * then a message is logged that is the result produced by the * given supplier function. Otherwise, the supplier is not operated on. * * @implSpec When logging is enabled for the given level, the default * implementation for this method calls * {@code this.log(level, (ResourceBundle)null, msgSupplier.get(), (Object[])null);} * * @param level the message level. * @param msgSupplier a supplier function that produces a message. * * @throws NullPointerException if {@code level} is {@code null}, or if the level * is loggable and {@code msgSupplier} is {@code null}. */ public default void log(Level level, Supplier msgSupplier) { if (isLoggable(level)) { log(level, (ResourceBundle) null, msgSupplier.get(), (Object[]) null); } } /** * Logs a message produced from the given object. *

* If the logger is currently enabled for the given message level then * a message is logged that, by default, is the result produced from * calling toString on the given object. * Otherwise, the object is not operated on. * * @implSpec When logging is enabled for the given level, the default * implementation for this method calls * {@code this.log(level, (ResourceBundle)null, obj.toString(), (Object[])null);} * * @param level the message level. * @param obj the object to log. * * @throws NullPointerException if {@code level} is {@code null}, or if the level * is loggable and {@code obj} is {@code null}. */ public default void log(Level level, Object obj) { if (isLoggable(level)) { this.log(level, (ResourceBundle) null, obj.toString(), (Object[]) null); } } /** * Logs a message associated with a given throwable. * * @implSpec The default implementation for this method calls * {@code this.log(level, (ResourceBundle)null, msg, thrown);} * * @param level the message level. * @param msg the string message (or a key in the message catalog, if * this logger is a {@link * LoggerFinder#getLocalizedLogger(java.lang.String, java.util.ResourceBundle, java.lang.Class) * localized logger}). * @param thrown a {@code Throwable} associated with the log message. * * @throws NullPointerException if {@code level} is {@code null}. */ public default void log(Level level, String msg, Throwable thrown) { this.log(level, null, msg, thrown); } /** * Logs a lazily supplied message associated with a given throwable. *

* If the logger is currently enabled for the given message level * then a message is logged that is the result produced by the * given supplier function. Otherwise, the supplier is not operated on. * * @implSpec When logging is enabled for the given level, the default * implementation for this method calls * {@code this.log(level, (ResourceBundle)null, msgSupplier.get(), thrown);} * * @param level one of the message level identifiers. * @param msgSupplier a supplier function that produces a message. * @param thrown a {@code Throwable} associated with log message. * * @throws NullPointerException if {@code level} is {@code null}, or if the level * is loggable and {@code msgSupplier} is {@code null}. */ public default void log(Level level, Supplier msgSupplier, Throwable thrown) { if (isLoggable(level)) { this.log(level, null, msgSupplier.get(), thrown); } } /** * Logs a message with an optional list of parameters. * * @implSpec The default implementation for this method calls * {@code this.log(level, (ResourceBundle)null, format, params);} * * @param level one of the message level identifiers. * @param format the string message format (or a key in the message * catalog, if this logger is a {@link * LoggerFinder#getLocalizedLogger(java.lang.String, java.util.ResourceBundle, java.lang.Class) * localized logger}). * @param params an optional list of parameters to the message (may be * none). * * @throws NullPointerException if {@code level} is {@code null}. */ public default void log(Level level, String format, Object... params) { this.log(level, null, format, params); } /** * Logs a localized message associated with a given throwable. *

* If the given resource bundle is non-{@code null}, the {@code msg} * string is localized using the given resource bundle. * Otherwise the {@code msg} string is not localized. * * @param level the message level. * @param bundle a resource bundle to localize {@code msg}, can be * {@code null}. * @param msg the string message (or a key in the message catalog, * if {@code bundle} is not {@code null}). * @param thrown a {@code Throwable} associated with the log message. * * @throws NullPointerException if {@code level} is {@code null}. */ public void log(Level level, ResourceBundle bundle, String msg, Throwable thrown); /** * Logs a message with resource bundle and an optional list of * parameters. *

* If the given resource bundle is non-{@code null}, the {@code format} * string is localized using the given resource bundle. * Otherwise the {@code format} string is not localized. * * @param level the message level. * @param bundle a resource bundle to localize {@code format}, can be * {@code null}. * @param format the string message format (or a key in the message * catalog if {@code bundle} is not {@code null}). * @param params an optional list of parameters to the message (may be * none). * * @throws NullPointerException if {@code level} is {@code null}. */ public void log(Level level, ResourceBundle bundle, String format, Object... params); } /** * The {@code LoggerFinder} service makes it possible to provide an * alternate implementation for System.Loggers used in the JDK. *

* Working with loggers obtained from the {@code LoggerFinder} *

* The {@code LoggerFinder} class makes it possible to replace * the logging backend through which logging events originating from * platform classes will be routed. The backend of the default * {@code LoggerFinder} implementation is still * {@code java.util.logging}, but it can now be replaced by providing and * declaring an alternate implementation of the {@code LoggerFinder} * service. *

* The JDK uses the {@link java.util.ServiceLoader} * facility to locate and load a concrete implementation of the * {@code LoggerFinder} service, from the {@linkplain * java.lang.ClassLoader#getSystemClassLoader() System ClassLoader}. * If no custom implementation is found the JDK will use its own default * implementation. If more than one implementation is found, a * {@link java.util.ServiceConfigurationError} will be thrown. *

* Only one instance of the {@code LoggerFinder} implementation is created. * That instance is responsible for creating, managing, and configuring * loggers as appropriate to the underlying framework it is using. *

* In the JDK, a platform class that needs to log messages will obtain * a logger that will route messages to a {@link Logger Logger} instance * obtained from one of the factory methods provided by the * {@code LoggerFinder} implementation. *

* {@link Logger Logger} instances obtained from the {@code * LoggerFinder} factory methods are not directly configurable by * the application. Configuration is the responsibility of the underlying * logging backend, and usually requires using APIs specific to that * backend. *

* System loggers (loggers obtained on behalf of platform classes) are * usually kept in a global logger tree which is separated from the * application logger tree. It is the responsibility of the provider of * the concrete {@code LoggerFinder} implementation to ensure that * system loggers can not be configured by an application without proper * permission checks, as configuration performed on system loggers usually * affects all applications in the same Java Runtime. *

* Default Implementation *

* The JDK default implementation of the {@code LoggerFinder} service * will attempt to bind to the {@linkplain java.util.logging java.logging} * module. * When the {@linkplain java.util.logging java.logging} module is present, * the default implementation will return {@link Logger} instances wrapping * instances of {@link java.util.logging.Logger java.util.logging.Logger}. * In that case, configuration may be performed by direct access to the * {@code java.util.logging} APIs, using {@link java.util.logging.Logger * java.util.logging.Logger} and {@link java.util.logging.LogManager} to * access and configure the backend loggers. *
* If the {@link java.util.logging java.logging} module is not linked * with the application, and no service implementation for the * {@code LoggerFinder} has been found, then the default implementation * will return a simple logger that prints out all log messages of * {@link java.lang.System.Logger.Level#INFO INFO} * level and above to the console ({@code System.err}). *
* These simple loggers are not configurable. *

* Note that if an implementation of the {@code LoggerFinder} service * interface has been found by the {@link java.util.ServiceLoader}, then * the JDK default implementation of {@code LoggerFinder} is not used and * configuration can only be performed through APIs provided by the backend * framework which the custom implementation of {@code LoggerFinder} has * plugged in. *
* Libraries and classes that only need loggers to produce log messages * should therefore not attempt to configure loggers by themselves, as that * would make them dependant from a specific implementation of the * {@code LoggerFinder} service. *

* Note also that the {@linkplain java.util.logging java.logging} module * does not directly provide an implementation of the {@code LoggerFinder} * service. The JDK default concrete implementation of {@code LoggerFinder} * use instead a JDK private API to bind to {@code java.util.logging}. * This makes it possible for an application to replace the logging backend * even when the java.logging module is present, by simply providing * and declaring an implementation of the {@link LoggerFinder} service. *

* Message Levels and Mapping to {@code java.util.logging} *

* The {@link Logger.Level Logger.Level} enum defines * a set of standard levels: {@link Logger.Level#ALL ALL}, * {@link Logger.Level#TRACE TRACE}, * {@link Logger.Level#DEBUG DEBUG}, * {@link Logger.Level#INFO INFO}, * {@link Logger.Level#WARNING WARNING}, * {@link Logger.Level#ERROR ERROR}, * and {@link Logger.Level#OFF OFF}, by order of increased severity. *
* {@link Logger.Level#ALL Level.ALL} and {@link Logger.Level#OFF Level.OFF} * are simple markers with severities mapped respectively to * {@link java.lang.Integer#MIN_VALUE Integer.MIN_VALUE} and * {@link java.lang.Integer#MAX_VALUE Integer.MAX_VALUE}. *

* When the logging backend supports custom levels, how to map System.Logger * levels to backend levels is the responsibility of the backend. *

* When {@link java.util.logging} is the backend, System.Logger levels are * mapped to {@linkplain java.util.logging.Level java.util.logging levels} * as follows: *

* * * * * * * * * * * * * * * * * * * * *
System.Logger Level Mapping
System.Logger Levels{@link Logger.Level#ALL ALL}{@link Logger.Level#TRACE TRACE}{@link Logger.Level#DEBUG DEBUG}{@link Logger.Level#INFO INFO}{@link Logger.Level#WARNING WARNING}{@link Logger.Level#ERROR ERROR}{@link Logger.Level#OFF OFF}
java.util.logging Backend{@link java.util.logging.Level#ALL ALL}{@link java.util.logging.Level#FINER FINER}{@link java.util.logging.Level#FINE FINE}{@link java.util.logging.Level#INFO INFO}{@link java.util.logging.Level#WARNING WARNING}{@link java.util.logging.Level#SEVERE SEVERE}{@link java.util.logging.Level#OFF OFF}
*

* Migrating From {@code java.util.logging} *

* Usually - an application that uses a logging framework will log messages * through a logger facade defined (or supported) by that framework. * Applications that wish to use an external framework should log * through the facade associated with that framework. *

* Changing the {@code LoggerFinder} Implementation *

* An application wishing to change the implementation of the * {@code LoggerFinder} is expected to provide a concrete implementation * of the {@code LoggerFinder} abstract class accessible from the * {@linkplain java.lang.ClassLoader#getSystemClassLoader() * System ClassLoader} and registered as a service in such a way that it * can be located and loaded by the {@link java.util.ServiceLoader}. * Note that because the loaded instance of {@code LoggerFinder} is * global, it will be only looked for in the {@linkplain * java.lang.ClassLoader#getSystemClassLoader() System ClassLoader} (and its * parents). *

* * @see java.lang.System * @see java.lang.System.Logger * * @since 9 */ public static abstract class LoggerFinder { /** * The {@code RuntimePermission("loggerFinder")} is * necessary to subclass and instantiate the {@code LoggerFinder} class, * as well as to obtain loggers from an instance of that class. */ public static final RuntimePermission LOGGERFINDER_PERMISSION = new RuntimePermission("loggerFinder"); /** * Creates a new instance of {@code LoggerFinder}. * * Only one instance will be created. * * @implNote It is recommended that subclasses of {@code LoggerFinder} * do not perform any heavy initialization in their constructor, in * order to avoid possible risks of deadlock or class loading cycles * during the instantiation of the provider. * * @throws SecurityException if the calling code does not have the * {@code RuntimePermission("loggerFinder")}. */ protected LoggerFinder() { this(checkPermission()); } private LoggerFinder(Void unused) { // nothing to do. } private static Void checkPermission() { final SecurityManager sm = System.getSecurityManager(); if (sm != null) { sm.checkPermission(LOGGERFINDER_PERMISSION); } return null; } /** * Returns an instance of {@link Logger Logger} * suitable for the given caller. * * @param name the name of the logger. * @param caller the class for which the logger is being requested. * * @return a {@link Logger logger} suitable for the given caller's * use. * @throws SecurityException if the calling code does not have the * {@code RuntimePermission("loggerFinder")}. */ public abstract Logger getLogger(String name, /* Module */ Class caller); /** * Returns a localizable instance of {@link Logger Logger} * suitable for the given caller. * The returned logger will use the provided resource bundle for * message localization. * * @implSpec By default, this method calls {@link * #getLogger(java.lang.String, java.lang.Class) * this.getLogger(name, caller)} to obtain a logger, then wraps that * logger in a {@link Logger} instance where all methods that do not * take a {@link ResourceBundle} as parameter are redirected to one * which does - passing the given {@code bundle} for * localization. So for instance, a call to {@link * Logger#log(Level, String) Logger.log(Level.INFO, msg)} * will end up as a call to {@link * Logger#log(Level, ResourceBundle, String, Object...) * Logger.log(Level.INFO, bundle, msg, (Object[])null)} on the wrapped * logger object. * Note however that by default, string messages returned by {@link * java.util.function.Supplier Supplier<String>} will not be * localized, as it is assumed that such strings are messages which are * already constructed, rather than keys in a resource bundle. *

* An implementation of {@code LoggerFinder} is not * constrained to use the default implementation of this method. In * particular, if the underlying logging backend provides its own * mechanism for localizing log messages, then such a * {@code LoggerFinder} would be free to return a logger * that makes direct use of the mechanism provided by the backend. * * @param name the name of the logger. * @param bundle a resource bundle. * @param caller the class for which the logger is being requested. * @return an instance of {@link Logger Logger} which will use the * provided resource bundle for message localization. * * @throws SecurityException if the calling code does not have the * {@code RuntimePermission("loggerFinder")}. */ public Logger getLocalizedLogger(String name, ResourceBundle bundle, /* Module */ Class caller) { return new LocalizedLoggerWrapper<>(getLogger(name, caller), bundle); } /** * Returns the loaded {@link LoggerFinder LoggerFinder} instance. * @return the loaded {@link LoggerFinder LoggerFinder} instance. * @throws SecurityException if the calling code does not have the * {@code RuntimePermission("loggerFinder")}. */ public static LoggerFinder getLoggerFinder() { final SecurityManager sm = System.getSecurityManager(); if (sm != null) { sm.checkPermission(LOGGERFINDER_PERMISSION); } return LoggerFinderLoader.spi(); } /** * Helper class used to load the {@link LoggerFinder}. */ final static class LoggerFinderLoader { private static volatile LoggerFinder spi; private static final Object lock = new int[0]; static final Permission CLASSLOADER_PERMISSION = SecurityConstants.GET_CLASSLOADER_PERMISSION; static final Permission READ_PERMISSION = new FilePermission("<>", SecurityConstants.FILE_READ_ACTION); // This class is static and cannot be instantiated. private LoggerFinderLoader() { throw new InternalError("LoggerFinderLoader cannot be instantiated"); } /** * The DefaultLoggerFinder is used when no {@link * LoggerFinder} implementation can be found. *

* By default, when {@link java.util.logging} * is present, the {@code DefaultLoggerFinder} returns loggers that * wrap {@link java.util.logging.Logger} created by the internal * {@link sun.util.logging.internal.JdkLoggingProvider}. * Backend loggers are obtained by * calling {@link * java.util.logging.LogManager#demandLoggerFor(java.lang.String, java.lang.Class)}. * Backend loggers can be configured by direct * use of the {@link java.util.logging} APIs. *

* When {@link java.util.logging} * is not present, the {@code DefaultLoggerFinder} returns * {@linkplain sun.util.logger.SimpleConsoleLogger * simple console loggers}. * By default, only message of level {@code INFO} and above will be * printed on the console. * For compatibility reason system loggers can be configured by * direct use of the internal {@code PlatformLogger} API. * For application loggers however, there is no API that would allow * the application to configure these loggers. *

* Therefore an application that needs to configure loggers should * either link with {@link java.util.logging} or install its own * {@link LoggerFinder} service. */ final static class DefaultLoggerFinder extends LoggerFinder { // Default JdkLoggerProvider used when no JdkLoggerProvider is // declared as an installed service. static final class DefaultJdkLoggerProvider extends JdkLoggerProvider { } private static JdkLoggerProvider loadJdkLoggerProvider() { final SecurityManager sm = System.getSecurityManager(); if (sm != null) { sm.checkPermission(LOGGERFINDER_PERMISSION); } final ServiceLoader loader; if (sm == null) { loader = ServiceLoader.loadInstalled(JdkLoggerProvider.class); } else { // We use limited do privileged here - the minimum set of // permissions required to 'see' the META-INF/services resources // seems to be CLASSLOADER_PERMISSION and READ_PERMISSION. // Note that do privileged is required because // otherwise the SecurityManager will prevent the ServiceLoader // from seeing the installed provider. loader = AccessController.doPrivileged( (PrivilegedAction>) () -> ServiceLoader.loadInstalled(JdkLoggerProvider.class), null, CLASSLOADER_PERMISSION, READ_PERMISSION); } JdkLoggerProvider result = null; try { if (loader.iterator().hasNext()) { result = loader.iterator().next(); } } catch (Throwable x) { // should report configuration error. // use the default. } if (result == null) { result = new DefaultJdkLoggerProvider(); } return result; } final JdkLoggerProvider jdkLoggerProvider; private DefaultLoggerFinder() { this(loadJdkLoggerProvider()); } private DefaultLoggerFinder(JdkLoggerProvider jdkLoggerProvider) { this.jdkLoggerProvider = jdkLoggerProvider; } @Override public Logger getLogger(String name, Class caller) { final SecurityManager sm = System.getSecurityManager(); if (sm != null) { sm.checkPermission(LOGGERFINDER_PERMISSION); } return jdkLoggerProvider.getJdkLogger(name, caller); } } // Return the loaded LoggerFinder, or load it if not already loaded. static LoggerFinder spi() { if (spi != null) return spi; synchronized(lock) { if (spi != null) return spi; spi = AccessController.doPrivileged( (PrivilegedAction) LoggerFinderLoader::load, null, LOGGERFINDER_PERMISSION, CLASSLOADER_PERMISSION, READ_PERMISSION); } // Since the LoggerFinder is already loaded - we can stop using // temporary loggers. BootstrapLogger.redirectTemporaryLoggers(); return spi; } // Loads the LoggerFinder using ServiceLoader. If no LoggerFinder // is found returns the default (possibly JUL based) implementation private static LoggerFinder load() { LoggerFinder result; try { ServiceLoader loader = ServiceLoader.load(LoggerFinder.class, ClassLoader.getSystemClassLoader()); final java.util.Iterator iterator = loader.iterator(); if (iterator.hasNext()) { result = iterator.next(); if (iterator.hasNext()) { throw new ServiceConfigurationError( LoggerFinder.class.getName() + ": several implementations found"); } } else { result = getDefaultImplementation(); } } catch(Error | RuntimeException x) { //TODO: Use an ErrorManager to log that spi = getDefaultImplementation(); throw x; } return result; } private static LoggerFinder getDefaultImplementation() { return new DefaultLoggerFinder(); } } } private static LoggerFinder accessProvider() { return LoggerFinder.LoggerFinderLoader.spi(); } /** * Returns an instance of {@link Logger Logger} suitable for the caller's * use. * * @implSpec * Instances returned by this method route messages to loggers * obtained by calling {@link LoggerFinder#getLogger(java.lang.String, java.lang.Class) * LoggerFinder.getLogger(name, caller)}. * * @apiNote * Calling this method may delay the creation of the actual logger. * A common reason for delaying the creation of the actual logger is, * for instance, if the Java Runtime is not finished booting at the time * the logger is requested. * * @param name the name of the logger. * @return an instance of {@link Logger} that can be used by the calling * class. * @throws NullPointerException if {@code name} is {@code null}. */ @CallerSensitive public static Logger getLogger(String name) { final Class caller = Reflection.getCallerClass(); // should we use lazy loggers only for platform loggers - not for all // system loggers? In other words, should we have a version of // getSystemLogger that takes an additional 'allowLazyLogger' boolean // parameter? // This method will create LazyLogger only if the Caller is in the // Boot ClassLoader return LazyLoggers.getLogger(Objects.requireNonNull(name), caller); } /** * Returns a localizable instance of {@link Logger * Logger} suitable for the caller use. * The returned logger will use the provided resource bundle for message * localization. * * @implSpec * The returned logger will perform message localization as specified * by {@link LoggerFinder#getLocalizedLogger(java.lang.String, * java.util.ResourceBundle, java.lang.Class) * LoggerFinder.getLocalizedLogger(name, bundle, caller}. * * @apiNote * Calling this method may trigger the immediate loading and initialization * of the {@link LoggerFinder} service, which may cause issues if the * Java Runtime is not ready to initialize the concrete service * implementation yet. * Platform classes which may be loaded early in the boot sequence and * need to log localized messages may prefer to create a logger using * {@link #getLogger(java.lang.String)} and then use the log methods that * take a resource bundle as parameter. * * @param name the name of the logger. * @param bundle a resource bundle. * @return an instance of {@link Logger} which will use the provided * resource bundle for message localization. * @throws NullPointerException if {@code name} or {@code bundle} is * {@code null} */ @CallerSensitive public static Logger getLogger(String name, ResourceBundle bundle) { final Class caller = Reflection.getCallerClass(); final SecurityManager sm = System.getSecurityManager(); final ResourceBundle rb = Objects.requireNonNull(bundle); // We don't use LazyLoggers if a resource bundle is specified. // Bootstrap sensitive classes in the JDK do not use resource bundles // when logging. This could be revisited later, if it needs to. if (sm != null) { return AccessController.doPrivileged((PrivilegedAction) () -> accessProvider().getLocalizedLogger(name, rb, caller), null, LoggerFinder.LOGGERFINDER_PERMISSION); } return accessProvider().getLocalizedLogger(name, rb, caller); } /** * Terminates the currently running Java Virtual Machine. The * argument serves as a status code; by convention, a nonzero status * code indicates abnormal termination. *

* This method calls the exit method in class * Runtime. This method never returns normally. *

* The call System.exit(n) is effectively equivalent to * the call: *

     * Runtime.getRuntime().exit(n)
     * 
* * @param status exit status. * @throws SecurityException * if a security manager exists and its checkExit * method doesn't allow exit with the specified status. * @see java.lang.Runtime#exit(int) */ public static void exit(int status) { Runtime.getRuntime().exit(status); } /** * Runs the garbage collector. *

* Calling the gc method suggests that the Java Virtual * Machine expend effort toward recycling unused objects in order to * make the memory they currently occupy available for quick reuse. * When control returns from the method call, the Java Virtual * Machine has made a best effort to reclaim space from all discarded * objects. *

* The call System.gc() is effectively equivalent to the * call: *

     * Runtime.getRuntime().gc()
     * 
* * @see java.lang.Runtime#gc() */ public static void gc() { Runtime.getRuntime().gc(); } /** * Runs the finalization methods of any objects pending finalization. *

* Calling this method suggests that the Java Virtual Machine expend * effort toward running the finalize methods of objects * that have been found to be discarded but whose finalize * methods have not yet been run. When control returns from the * method call, the Java Virtual Machine has made a best effort to * complete all outstanding finalizations. *

* The call System.runFinalization() is effectively * equivalent to the call: *

     * Runtime.getRuntime().runFinalization()
     * 
* * @see java.lang.Runtime#runFinalization() */ public static void runFinalization() { Runtime.getRuntime().runFinalization(); } /** * Enable or disable finalization on exit; doing so specifies that the * finalizers of all objects that have finalizers that have not yet been * automatically invoked are to be run before the Java runtime exits. * By default, finalization on exit is disabled. * *

If there is a security manager, * its checkExit method is first called * with 0 as its argument to ensure the exit is allowed. * This could result in a SecurityException. * * @deprecated This method is inherently unsafe. It may result in * finalizers being called on live objects while other threads are * concurrently manipulating those objects, resulting in erratic * behavior or deadlock. * @param value indicating enabling or disabling of finalization * @throws SecurityException * if a security manager exists and its checkExit * method doesn't allow the exit. * * @see java.lang.Runtime#exit(int) * @see java.lang.Runtime#gc() * @see java.lang.SecurityManager#checkExit(int) * @since 1.1 */ @Deprecated public static void runFinalizersOnExit(boolean value) { Runtime.runFinalizersOnExit(value); } /** * Loads the native library specified by the filename argument. The filename * argument must be an absolute path name. * * If the filename argument, when stripped of any platform-specific library * prefix, path, and file extension, indicates a library whose name is, * for example, L, and a native library called L is statically linked * with the VM, then the JNI_OnLoad_L function exported by the library * is invoked rather than attempting to load a dynamic library. * A filename matching the argument does not have to exist in the * file system. * See the JNI Specification for more details. * * Otherwise, the filename argument is mapped to a native library image in * an implementation-dependent manner. * *

* The call System.load(name) is effectively equivalent * to the call: *

     * Runtime.getRuntime().load(name)
     * 
* * @param filename the file to load. * @exception SecurityException if a security manager exists and its * checkLink method doesn't allow * loading of the specified dynamic library * @exception UnsatisfiedLinkError if either the filename is not an * absolute path name, the native library is not statically * linked with the VM, or the library cannot be mapped to * a native library image by the host system. * @exception NullPointerException if filename is * null * @see java.lang.Runtime#load(java.lang.String) * @see java.lang.SecurityManager#checkLink(java.lang.String) */ @CallerSensitive public static void load(String filename) { Runtime.getRuntime().load0(Reflection.getCallerClass(), filename); } /** * Loads the native library specified by the libname * argument. The libname argument must not contain any platform * specific prefix, file extension or path. If a native library * called libname is statically linked with the VM, then the * JNI_OnLoad_libname function exported by the library is invoked. * See the JNI Specification for more details. * * Otherwise, the libname argument is loaded from a system library * location and mapped to a native library image in an implementation- * dependent manner. *

* The call System.loadLibrary(name) is effectively * equivalent to the call *

     * Runtime.getRuntime().loadLibrary(name)
     * 
* * @param libname the name of the library. * @exception SecurityException if a security manager exists and its * checkLink method doesn't allow * loading of the specified dynamic library * @exception UnsatisfiedLinkError if either the libname argument * contains a file path, the native library is not statically * linked with the VM, or the library cannot be mapped to a * native library image by the host system. * @exception NullPointerException if libname is * null * @see java.lang.Runtime#loadLibrary(java.lang.String) * @see java.lang.SecurityManager#checkLink(java.lang.String) */ @CallerSensitive public static void loadLibrary(String libname) { Runtime.getRuntime().loadLibrary0(Reflection.getCallerClass(), libname); } /** * Maps a library name into a platform-specific string representing * a native library. * * @param libname the name of the library. * @return a platform-dependent native library name. * @exception NullPointerException if libname is * null * @see java.lang.System#loadLibrary(java.lang.String) * @see java.lang.ClassLoader#findLibrary(java.lang.String) * @since 1.2 */ public static native String mapLibraryName(String libname); /** * Create PrintStream for stdout/err based on encoding. */ private static PrintStream newPrintStream(FileOutputStream fos, String enc) { if (enc != null) { try { return new PrintStream(new BufferedOutputStream(fos, 128), true, enc); } catch (UnsupportedEncodingException uee) {} } return new PrintStream(new BufferedOutputStream(fos, 128), true); } /** * Initialize the system class. Called after thread initialization. */ private static void initializeSystemClass() { // VM might invoke JNU_NewStringPlatform() to set those encoding // sensitive properties (user.home, user.name, boot.class.path, etc.) // during "props" initialization, in which it may need access, via // System.getProperty(), to the related system encoding property that // have been initialized (put into "props") at early stage of the // initialization. So make sure the "props" is available at the // very beginning of the initialization and all system properties to // be put into it directly. props = new Properties(); initProperties(props); // initialized by the VM // There are certain system configurations that may be controlled by // VM options such as the maximum amount of direct memory and // Integer cache size used to support the object identity semantics // of autoboxing. Typically, the library will obtain these values // from the properties set by the VM. If the properties are for // internal implementation use only, these properties should be // removed from the system properties. // // See java.lang.Integer.IntegerCache and the // sun.misc.VM.saveAndRemoveProperties method for example. // // Save a private copy of the system properties object that // can only be accessed by the internal implementation. Remove // certain system properties that are not intended for public access. sun.misc.VM.saveAndRemoveProperties(props); lineSeparator = props.getProperty("line.separator"); sun.misc.Version.init(); FileInputStream fdIn = new FileInputStream(FileDescriptor.in); FileOutputStream fdOut = new FileOutputStream(FileDescriptor.out); FileOutputStream fdErr = new FileOutputStream(FileDescriptor.err); setIn0(new BufferedInputStream(fdIn)); setOut0(newPrintStream(fdOut, props.getProperty("sun.stdout.encoding"))); setErr0(newPrintStream(fdErr, props.getProperty("sun.stderr.encoding"))); // Load the zip library now in order to keep java.util.zip.ZipFile // from trying to use itself to load this library later. loadLibrary("zip"); // Setup Java signal handlers for HUP, TERM, and INT (where available). Terminator.setup(); // Initialize any miscellaneous operating system settings that need to be // set for the class libraries. Currently this is no-op everywhere except // for Windows where the process-wide error mode is set before the java.io // classes are used. sun.misc.VM.initializeOSEnvironment(); // The main thread is not added to its thread group in the same // way as other threads; we must do it ourselves here. Thread current = Thread.currentThread(); current.getThreadGroup().add(current); // register shared secrets setJavaLangAccess(); // Subsystems that are invoked during initialization can invoke // sun.misc.VM.isBooted() in order to avoid doing things that should // wait until the application class loader has been set up. // IMPORTANT: Ensure that this remains the last initialization action! sun.misc.VM.booted(); } private static void setJavaLangAccess() { // Allow privileged classes outside of java.lang SharedSecrets.setJavaLangAccess(new JavaLangAccess(){ public sun.reflect.ConstantPool getConstantPool(Class klass) { return klass.getConstantPool(); } public boolean casAnnotationType(Class klass, AnnotationType oldType, AnnotationType newType) { return klass.casAnnotationType(oldType, newType); } public AnnotationType getAnnotationType(Class klass) { return klass.getAnnotationType(); } public Map, Annotation> getDeclaredAnnotationMap(Class klass) { return klass.getDeclaredAnnotationMap(); } public byte[] getRawClassAnnotations(Class klass) { return klass.getRawAnnotations(); } public byte[] getRawClassTypeAnnotations(Class klass) { return klass.getRawTypeAnnotations(); } public byte[] getRawExecutableTypeAnnotations(Executable executable) { return Class.getExecutableTypeAnnotationBytes(executable); } public > E[] getEnumConstantsShared(Class klass) { return klass.getEnumConstantsShared(); } public void blockedOn(Thread t, Interruptible b) { t.blockedOn(b); } public void registerShutdownHook(int slot, boolean registerShutdownInProgress, Runnable hook) { Shutdown.add(slot, registerShutdownInProgress, hook); } public int getStackTraceDepth(Throwable t) { return t.getStackTraceDepth(); } public StackTraceElement getStackTraceElement(Throwable t, int i) { return t.getStackTraceElement(i); } public String newStringUnsafe(char[] chars) { return new String(chars, true); } public Thread newThreadWithAcc(Runnable target, AccessControlContext acc) { return new Thread(target, acc); } public void invokeFinalize(Object o) throws Throwable { o.finalize(); } public void formatUnsignedLong(long val, int shift, char[] buf, int offset, int len) { Long.formatUnsignedLong(val, shift, buf, offset, len); } public void formatUnsignedInt(int val, int shift, char[] buf, int offset, int len) { Integer.formatUnsignedInt(val, shift, buf, offset, len); } }); } }