1 /*
   2  * Copyright (c) 1994, 2019, Oracle and/or its affiliates. All rights reserved.
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * This code is free software; you can redistribute it and/or modify it
   6  * under the terms of the GNU General Public License version 2 only, as
   7  * published by the Free Software Foundation.  Oracle designates this
   8  * particular file as subject to the "Classpath" exception as provided
   9  * by Oracle in the LICENSE file that accompanied this code.
  10  *
  11  * This code is distributed in the hope that it will be useful, but WITHOUT
  12  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
  13  * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
  14  * version 2 for more details (a copy is included in the LICENSE file that
  15  * accompanied this code).
  16  *
  17  * You should have received a copy of the GNU General Public License version
  18  * 2 along with this work; if not, write to the Free Software Foundation,
  19  * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
  20  *
  21  * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
  22  * or visit www.oracle.com if you need additional information or have any
  23  * questions.
  24  */
  25 package java.lang;
  26 
  27 import java.io.BufferedInputStream;
  28 import java.io.BufferedOutputStream;
  29 import java.io.Console;
  30 import java.io.FileDescriptor;
  31 import java.io.FileInputStream;
  32 import java.io.FileOutputStream;
  33 import java.io.IOException;
  34 import java.io.InputStream;
  35 import java.io.PrintStream;
  36 import java.io.UnsupportedEncodingException;
  37 import java.lang.annotation.Annotation;
  38 import java.lang.module.ModuleDescriptor;
  39 import java.lang.reflect.Constructor;
  40 import java.lang.reflect.Executable;
  41 import java.lang.reflect.Method;
  42 import java.lang.reflect.Modifier;
  43 import java.net.URI;
  44 import java.nio.charset.CharacterCodingException;
  45 import java.security.AccessControlContext;
  46 import java.security.ProtectionDomain;
  47 import java.security.AccessController;
  48 import java.security.PrivilegedAction;
  49 import java.nio.channels.Channel;
  50 import java.nio.channels.spi.SelectorProvider;
  51 import java.nio.charset.Charset;
  52 import java.util.Iterator;
  53 import java.util.List;
  54 import java.util.Map;
  55 import java.util.Objects;
  56 import java.util.Properties;
  57 import java.util.PropertyPermission;
  58 import java.util.ResourceBundle;
  59 import java.util.function.Supplier;
  60 import java.util.concurrent.ConcurrentHashMap;
  61 import java.util.stream.Stream;
  62 
  63 import jdk.internal.util.StaticProperty;
  64 import jdk.internal.module.ModuleBootstrap;
  65 import jdk.internal.module.ServicesCatalog;
  66 import jdk.internal.reflect.CallerSensitive;
  67 import jdk.internal.reflect.Reflection;
  68 import jdk.internal.HotSpotIntrinsicCandidate;
  69 import jdk.internal.access.JavaLangAccess;
  70 import jdk.internal.access.SharedSecrets;
  71 import jdk.internal.misc.VM;
  72 import jdk.internal.logger.LoggerFinderLoader;
  73 import jdk.internal.logger.LazyLoggers;
  74 import jdk.internal.logger.LocalizedLoggerWrapper;
  75 import jdk.internal.util.SystemProps;
  76 import jdk.internal.vm.annotation.Stable;
  77 import sun.reflect.annotation.AnnotationType;
  78 import sun.nio.ch.Interruptible;
  79 import sun.security.util.SecurityConstants;
  80 
  81 /**
  82  * The {@code System} class contains several useful class fields
  83  * and methods. It cannot be instantiated.
  84  *
  85  * Among the facilities provided by the {@code System} class
  86  * are standard input, standard output, and error output streams;
  87  * access to externally defined properties and environment
  88  * variables; a means of loading files and libraries; and a utility
  89  * method for quickly copying a portion of an array.
  90  *
  91  * @since   1.0
  92  */
  93 public final class System {
  94     /* Register the natives via the static initializer.
  95      *
  96      * VM will invoke the initializeSystemClass method to complete
  97      * the initialization for this class separated from clinit.
  98      * Note that to use properties set by the VM, see the constraints
  99      * described in the initializeSystemClass method.
 100      */
 101     private static native void registerNatives();
 102     static {
 103         registerNatives();
 104     }
 105 
 106     /** Don't let anyone instantiate this class */
 107     private System() {
 108     }
 109 
 110     /**
 111      * The "standard" input stream. This stream is already
 112      * open and ready to supply input data. Typically this stream
 113      * corresponds to keyboard input or another input source specified by
 114      * the host environment or user.
 115      */
 116     public static final InputStream in = null;
 117 
 118     /**
 119      * The "standard" output stream. This stream is already
 120      * open and ready to accept output data. Typically this stream
 121      * corresponds to display output or another output destination
 122      * specified by the host environment or user.
 123      * <p>
 124      * For simple stand-alone Java applications, a typical way to write
 125      * a line of output data is:
 126      * <blockquote><pre>
 127      *     System.out.println(data)
 128      * </pre></blockquote>
 129      * <p>
 130      * See the {@code println} methods in class {@code PrintStream}.
 131      *
 132      * @see     java.io.PrintStream#println()
 133      * @see     java.io.PrintStream#println(boolean)
 134      * @see     java.io.PrintStream#println(char)
 135      * @see     java.io.PrintStream#println(char[])
 136      * @see     java.io.PrintStream#println(double)
 137      * @see     java.io.PrintStream#println(float)
 138      * @see     java.io.PrintStream#println(int)
 139      * @see     java.io.PrintStream#println(long)
 140      * @see     java.io.PrintStream#println(java.lang.Object)
 141      * @see     java.io.PrintStream#println(java.lang.String)
 142      */
 143     public static final PrintStream out = null;
 144 
 145     /**
 146      * The "standard" error output stream. This stream is already
 147      * open and ready to accept output data.
 148      * <p>
 149      * Typically this stream corresponds to display output or another
 150      * output destination specified by the host environment or user. By
 151      * convention, this output stream is used to display error messages
 152      * or other information that should come to the immediate attention
 153      * of a user even if the principal output stream, the value of the
 154      * variable {@code out}, has been redirected to a file or other
 155      * destination that is typically not continuously monitored.
 156      */
 157     public static final PrintStream err = null;
 158 
 159     // indicates if a security manager is possible
 160     private static final int NEVER = 1;
 161     private static final int MAYBE = 2;
 162     private static @Stable int allowSecurityManager;
 163 
 164     // current security manager
 165     private static volatile SecurityManager security;   // read by VM
 166 
 167     // return true if a security manager is allowed
 168     private static boolean allowSecurityManager() {
 169         return (allowSecurityManager != NEVER);
 170     }
 171 
 172     /**
 173      * Reassigns the "standard" input stream.
 174      *
 175      * First, if there is a security manager, its {@code checkPermission}
 176      * method is called with a {@code RuntimePermission("setIO")} permission
 177      *  to see if it's ok to reassign the "standard" input stream.
 178      *
 179      * @param in the new standard input stream.
 180      *
 181      * @throws SecurityException
 182      *        if a security manager exists and its
 183      *        {@code checkPermission} method doesn't allow
 184      *        reassigning of the standard input stream.
 185      *
 186      * @see SecurityManager#checkPermission
 187      * @see java.lang.RuntimePermission
 188      *
 189      * @since   1.1
 190      */
 191     public static void setIn(InputStream in) {
 192         checkIO();
 193         setIn0(in);
 194     }
 195 
 196     /**
 197      * Reassigns the "standard" output stream.
 198      *
 199      * First, if there is a security manager, its {@code checkPermission}
 200      * method is called with a {@code RuntimePermission("setIO")} permission
 201      *  to see if it's ok to reassign the "standard" output stream.
 202      *
 203      * @param out the new standard output stream
 204      *
 205      * @throws SecurityException
 206      *        if a security manager exists and its
 207      *        {@code checkPermission} method doesn't allow
 208      *        reassigning of the standard output stream.
 209      *
 210      * @see SecurityManager#checkPermission
 211      * @see java.lang.RuntimePermission
 212      *
 213      * @since   1.1
 214      */
 215     public static void setOut(PrintStream out) {
 216         checkIO();
 217         setOut0(out);
 218     }
 219 
 220     /**
 221      * Reassigns the "standard" error output stream.
 222      *
 223      * First, if there is a security manager, its {@code checkPermission}
 224      * method is called with a {@code RuntimePermission("setIO")} permission
 225      *  to see if it's ok to reassign the "standard" error output stream.
 226      *
 227      * @param err the new standard error output stream.
 228      *
 229      * @throws SecurityException
 230      *        if a security manager exists and its
 231      *        {@code checkPermission} method doesn't allow
 232      *        reassigning of the standard error output stream.
 233      *
 234      * @see SecurityManager#checkPermission
 235      * @see java.lang.RuntimePermission
 236      *
 237      * @since   1.1
 238      */
 239     public static void setErr(PrintStream err) {
 240         checkIO();
 241         setErr0(err);
 242     }
 243 
 244     private static volatile Console cons;
 245 
 246     /**
 247      * Returns the unique {@link java.io.Console Console} object associated
 248      * with the current Java virtual machine, if any.
 249      *
 250      * @return  The system console, if any, otherwise {@code null}.
 251      *
 252      * @since   1.6
 253      */
 254      public static Console console() {
 255          Console c;
 256          if ((c = cons) == null) {
 257              synchronized (System.class) {
 258                  if ((c = cons) == null) {
 259                      cons = c = SharedSecrets.getJavaIOAccess().console();
 260                  }
 261              }
 262          }
 263          return c;
 264      }
 265 
 266     /**
 267      * Returns the channel inherited from the entity that created this
 268      * Java virtual machine.
 269      *
 270      * This method returns the channel obtained by invoking the
 271      * {@link java.nio.channels.spi.SelectorProvider#inheritedChannel
 272      * inheritedChannel} method of the system-wide default
 273      * {@link java.nio.channels.spi.SelectorProvider} object.
 274      *
 275      * <p> In addition to the network-oriented channels described in
 276      * {@link java.nio.channels.spi.SelectorProvider#inheritedChannel
 277      * inheritedChannel}, this method may return other kinds of
 278      * channels in the future.
 279      *
 280      * @return  The inherited channel, if any, otherwise {@code null}.
 281      *
 282      * @throws  IOException
 283      *          If an I/O error occurs
 284      *
 285      * @throws  SecurityException
 286      *          If a security manager is present and it does not
 287      *          permit access to the channel.
 288      *
 289      * @since 1.5
 290      */
 291     public static Channel inheritedChannel() throws IOException {
 292         return SelectorProvider.provider().inheritedChannel();
 293     }
 294 
 295     private static void checkIO() {
 296         SecurityManager sm = getSecurityManager();
 297         if (sm != null) {
 298             sm.checkPermission(new RuntimePermission("setIO"));
 299         }
 300     }
 301 
 302     private static native void setIn0(InputStream in);
 303     private static native void setOut0(PrintStream out);
 304     private static native void setErr0(PrintStream err);
 305 
 306     /**
 307      * Sets the system-wide security manager.
 308      *
 309      * If there is a security manager already installed, this method first
 310      * calls the security manager's {@code checkPermission} method
 311      * with a {@code RuntimePermission("setSecurityManager")}
 312      * permission to ensure it's ok to replace the existing
 313      * security manager.
 314      * This may result in throwing a {@code SecurityException}.
 315      *
 316      * <p> Otherwise, the argument is established as the current
 317      * security manager. If the argument is {@code null} and no
 318      * security manager has been established, then no action is taken and
 319      * the method simply returns.
 320      *
 321      * @implNote In the JDK implementation, if the Java virtual machine is
 322      * started with the system property {@code java.security.manager} set to
 323      * the special token "{@code disallow}" then the {@code setSecurityManager}
 324      * method cannot be used to set a security manager.
 325      *
 326      * @param  sm the security manager or {@code null}
 327      * @throws SecurityException
 328      *         if the security manager has already been set and its {@code
 329      *         checkPermission} method doesn't allow it to be replaced
 330      * @throws UnsupportedOperationException
 331      *         if {@code sm} is non-null and a security manager is not allowed
 332      *         to be set dynamically
 333      * @see #getSecurityManager
 334      * @see SecurityManager#checkPermission
 335      * @see java.lang.RuntimePermission
 336      */
 337     public static void setSecurityManager(SecurityManager sm) {
 338         if (allowSecurityManager()) {
 339             if (security == null) {
 340                 // ensure image reader is initialized
 341                 Object.class.getResource("java/lang/ANY");
 342             }
 343             if (sm != null) {
 344                 try {
 345                     // pre-populates the SecurityManager.packageAccess cache
 346                     // to avoid recursive permission checking issues with custom
 347                     // SecurityManager implementations
 348                     sm.checkPackageAccess("java.lang");
 349                 } catch (Exception e) {
 350                     // no-op
 351                 }
 352             }
 353             setSecurityManager0(sm);
 354         } else {
 355             // security manager not allowed
 356             if (sm != null) {
 357                 throw new UnsupportedOperationException(
 358                     "Runtime configured to disallow security manager");
 359             }
 360         }
 361     }
 362 
 363     private static synchronized
 364     void setSecurityManager0(final SecurityManager s) {
 365         SecurityManager sm = getSecurityManager();
 366         if (sm != null) {
 367             // ask the currently installed security manager if we
 368             // can replace it.
 369             sm.checkPermission(new RuntimePermission("setSecurityManager"));
 370         }
 371 
 372         if ((s != null) && (s.getClass().getClassLoader() != null)) {
 373             // New security manager class is not on bootstrap classpath.
 374             // Force policy to get initialized before we install the new
 375             // security manager, in order to prevent infinite loops when
 376             // trying to initialize the policy (which usually involves
 377             // accessing some security and/or system properties, which in turn
 378             // calls the installed security manager's checkPermission method
 379             // which will loop infinitely if there is a non-system class
 380             // (in this case: the new security manager class) on the stack).
 381             AccessController.doPrivileged(new PrivilegedAction<>() {
 382                 public Object run() {
 383                     s.getClass().getProtectionDomain().implies
 384                         (SecurityConstants.ALL_PERMISSION);
 385                     return null;
 386                 }
 387             });
 388         }
 389 
 390         security = s;
 391     }
 392 
 393     /**
 394      * Gets the system-wide security manager.
 395      *
 396      * @return  if a security manager has already been established for the
 397      *          current application, then that security manager is returned;
 398      *          otherwise, {@code null} is returned.
 399      * @see     #setSecurityManager
 400      */
 401     public static SecurityManager getSecurityManager() {
 402         if (allowSecurityManager()) {
 403             return security;
 404         } else {
 405             return null;
 406         }
 407     }
 408 
 409     /**
 410      * Returns the current time in milliseconds.  Note that
 411      * while the unit of time of the return value is a millisecond,
 412      * the granularity of the value depends on the underlying
 413      * operating system and may be larger.  For example, many
 414      * operating systems measure time in units of tens of
 415      * milliseconds.
 416      *
 417      * <p> See the description of the class {@code Date} for
 418      * a discussion of slight discrepancies that may arise between
 419      * "computer time" and coordinated universal time (UTC).
 420      *
 421      * @return  the difference, measured in milliseconds, between
 422      *          the current time and midnight, January 1, 1970 UTC.
 423      * @see     java.util.Date
 424      */
 425     @HotSpotIntrinsicCandidate
 426     public static native long currentTimeMillis();
 427 
 428     /**
 429      * Returns the current value of the running Java Virtual Machine's
 430      * high-resolution time source, in nanoseconds.
 431      *
 432      * This method can only be used to measure elapsed time and is
 433      * not related to any other notion of system or wall-clock time.
 434      * The value returned represents nanoseconds since some fixed but
 435      * arbitrary <i>origin</i> time (perhaps in the future, so values
 436      * may be negative).  The same origin is used by all invocations of
 437      * this method in an instance of a Java virtual machine; other
 438      * virtual machine instances are likely to use a different origin.
 439      *
 440      * <p>This method provides nanosecond precision, but not necessarily
 441      * nanosecond resolution (that is, how frequently the value changes)
 442      * - no guarantees are made except that the resolution is at least as
 443      * good as that of {@link #currentTimeMillis()}.
 444      *
 445      * <p>Differences in successive calls that span greater than
 446      * approximately 292 years (2<sup>63</sup> nanoseconds) will not
 447      * correctly compute elapsed time due to numerical overflow.
 448      *
 449      * <p>The values returned by this method become meaningful only when
 450      * the difference between two such values, obtained within the same
 451      * instance of a Java virtual machine, is computed.
 452      *
 453      * <p>For example, to measure how long some code takes to execute:
 454      * <pre> {@code
 455      * long startTime = System.nanoTime();
 456      * // ... the code being measured ...
 457      * long elapsedNanos = System.nanoTime() - startTime;}</pre>
 458      *
 459      * <p>To compare elapsed time against a timeout, use <pre> {@code
 460      * if (System.nanoTime() - startTime >= timeoutNanos) ...}</pre>
 461      * instead of <pre> {@code
 462      * if (System.nanoTime() >= startTime + timeoutNanos) ...}</pre>
 463      * because of the possibility of numerical overflow.
 464      *
 465      * @return the current value of the running Java Virtual Machine's
 466      *         high-resolution time source, in nanoseconds
 467      * @since 1.5
 468      */
 469     @HotSpotIntrinsicCandidate
 470     public static native long nanoTime();
 471 
 472     /**
 473      * Copies an array from the specified source array, beginning at the
 474      * specified position, to the specified position of the destination array.
 475      * A subsequence of array components are copied from the source
 476      * array referenced by {@code src} to the destination array
 477      * referenced by {@code dest}. The number of components copied is
 478      * equal to the {@code length} argument. The components at
 479      * positions {@code srcPos} through
 480      * {@code srcPos+length-1} in the source array are copied into
 481      * positions {@code destPos} through
 482      * {@code destPos+length-1}, respectively, of the destination
 483      * array.
 484      * <p>
 485      * If the {@code src} and {@code dest} arguments refer to the
 486      * same array object, then the copying is performed as if the
 487      * components at positions {@code srcPos} through
 488      * {@code srcPos+length-1} were first copied to a temporary
 489      * array with {@code length} components and then the contents of
 490      * the temporary array were copied into positions
 491      * {@code destPos} through {@code destPos+length-1} of the
 492      * destination array.
 493      * <p>
 494      * If {@code dest} is {@code null}, then a
 495      * {@code NullPointerException} is thrown.
 496      * <p>
 497      * If {@code src} is {@code null}, then a
 498      * {@code NullPointerException} is thrown and the destination
 499      * array is not modified.
 500      * <p>
 501      * Otherwise, if any of the following is true, an
 502      * {@code ArrayStoreException} is thrown and the destination is
 503      * not modified:
 504      * <ul>
 505      * <li>The {@code src} argument refers to an object that is not an
 506      *     array.
 507      * <li>The {@code dest} argument refers to an object that is not an
 508      *     array.
 509      * <li>The {@code src} argument and {@code dest} argument refer
 510      *     to arrays whose component types are different primitive types.
 511      * <li>The {@code src} argument refers to an array with a primitive
 512      *    component type and the {@code dest} argument refers to an array
 513      *     with a reference component type.
 514      * <li>The {@code src} argument refers to an array with a reference
 515      *    component type and the {@code dest} argument refers to an array
 516      *     with a primitive component type.
 517      * </ul>
 518      * <p>
 519      * Otherwise, if any of the following is true, an
 520      * {@code IndexOutOfBoundsException} is
 521      * thrown and the destination is not modified:
 522      * <ul>
 523      * <li>The {@code srcPos} argument is negative.
 524      * <li>The {@code destPos} argument is negative.
 525      * <li>The {@code length} argument is negative.
 526      * <li>{@code srcPos+length} is greater than
 527      *     {@code src.length}, the length of the source array.
 528      * <li>{@code destPos+length} is greater than
 529      *     {@code dest.length}, the length of the destination array.
 530      * </ul>
 531      * <p>
 532      * Otherwise, if any actual component of the source array from
 533      * position {@code srcPos} through
 534      * {@code srcPos+length-1} cannot be converted to the component
 535      * type of the destination array by assignment conversion, an
 536      * {@code ArrayStoreException} is thrown. In this case, let
 537      * <b><i>k</i></b> be the smallest nonnegative integer less than
 538      * length such that {@code src[srcPos+}<i>k</i>{@code ]}
 539      * cannot be converted to the component type of the destination
 540      * array; when the exception is thrown, source array components from
 541      * positions {@code srcPos} through
 542      * {@code srcPos+}<i>k</i>{@code -1}
 543      * will already have been copied to destination array positions
 544      * {@code destPos} through
 545      * {@code destPos+}<i>k</I>{@code -1} and no other
 546      * positions of the destination array will have been modified.
 547      * (Because of the restrictions already itemized, this
 548      * paragraph effectively applies only to the situation where both
 549      * arrays have component types that are reference types.)
 550      *
 551      * @param      src      the source array.
 552      * @param      srcPos   starting position in the source array.
 553      * @param      dest     the destination array.
 554      * @param      destPos  starting position in the destination data.
 555      * @param      length   the number of array elements to be copied.
 556      * @throws     IndexOutOfBoundsException  if copying would cause
 557      *             access of data outside array bounds.
 558      * @throws     ArrayStoreException  if an element in the {@code src}
 559      *             array could not be stored into the {@code dest} array
 560      *             because of a type mismatch.
 561      * @throws     NullPointerException if either {@code src} or
 562      *             {@code dest} is {@code null}.
 563      */
 564     @HotSpotIntrinsicCandidate
 565     public static native void arraycopy(Object src,  int  srcPos,
 566                                         Object dest, int destPos,
 567                                         int length);
 568 
 569     /**
 570      * Returns the same hash code for the given object as
 571      * would be returned by the default method hashCode(),
 572      * whether or not the given object's class overrides
 573      * hashCode().
 574      * The hash code for the null reference is zero.
 575      *
 576      * @param x object for which the hashCode is to be calculated
 577      * @return  the hashCode
 578      * @since   1.1
 579      * @see Object#hashCode
 580      * @see java.util.Objects#hashCode(Object)
 581      */
 582     @HotSpotIntrinsicCandidate
 583     public static native int identityHashCode(Object x);
 584 
 585     /**
 586      * System properties. The following properties are guaranteed to be defined:
 587      * <dl>
 588      * <dt>java.version         <dd>Java version number
 589      * <dt>java.version.date    <dd>Java version date
 590      * <dt>java.vendor          <dd>Java vendor specific string
 591      * <dt>java.vendor.url      <dd>Java vendor URL
 592      * <dt>java.vendor.version  <dd>Java vendor version
 593      * <dt>java.home            <dd>Java installation directory
 594      * <dt>java.class.version   <dd>Java class version number
 595      * <dt>java.class.path      <dd>Java classpath
 596      * <dt>os.name              <dd>Operating System Name
 597      * <dt>os.arch              <dd>Operating System Architecture
 598      * <dt>os.version           <dd>Operating System Version
 599      * <dt>file.separator       <dd>File separator ("/" on Unix)
 600      * <dt>path.separator       <dd>Path separator (":" on Unix)
 601      * <dt>line.separator       <dd>Line separator ("\n" on Unix)
 602      * <dt>user.name            <dd>User account name
 603      * <dt>user.home            <dd>User home directory
 604      * <dt>user.dir             <dd>User's current working directory
 605      * </dl>
 606      */
 607 
 608     private static Properties props;
 609 
 610     /**
 611      * Determines the current system properties.
 612      *
 613      * First, if there is a security manager, its
 614      * {@code checkPropertiesAccess} method is called with no
 615      * arguments. This may result in a security exception.
 616      * <p>
 617      * The current set of system properties for use by the
 618      * {@link #getProperty(String)} method is returned as a
 619      * {@code Properties} object. If there is no current set of
 620      * system properties, a set of system properties is first created and
 621      * initialized. This set of system properties includes a value
 622      * for each of the following keys unless the description of the associated
 623      * value indicates that the value is optional.
 624      * <table class="striped" style="text-align:left">
 625      * <caption style="display:none">Shows property keys and associated values</caption>
 626      * <thead>
 627      * <tr><th scope="col">Key</th>
 628      *     <th scope="col">Description of Associated Value</th></tr>
 629      * </thead>
 630      * <tbody>
 631      * <tr><th scope="row">{@systemProperty java.version}</th>
 632      *     <td>Java Runtime Environment version, which may be interpreted
 633      *     as a {@link Runtime.Version}</td></tr>
 634      * <tr><th scope="row">{@systemProperty java.version.date}</th>
 635      *     <td>Java Runtime Environment version date, in ISO-8601 YYYY-MM-DD
 636      *     format, which may be interpreted as a {@link
 637      *     java.time.LocalDate}</td></tr>
 638      * <tr><th scope="row">{@systemProperty java.vendor}</th>
 639      *     <td>Java Runtime Environment vendor</td></tr>
 640      * <tr><th scope="row">{@systemProperty java.vendor.url}</th>
 641      *     <td>Java vendor URL</td></tr>
 642      * <tr><th scope="row">{@systemProperty java.vendor.version}</th>
 643      *     <td>Java vendor version <em>(optional)</em> </td></tr>
 644      * <tr><th scope="row">{@systemProperty java.home}</th>
 645      *     <td>Java installation directory</td></tr>
 646      * <tr><th scope="row">{@systemProperty java.vm.specification.version}</th>
 647      *     <td>Java Virtual Machine specification version, whose value is the
 648      *     {@linkplain Runtime.Version#feature feature} element of the
 649      *     {@linkplain Runtime#version() runtime version}</td></tr>
 650      * <tr><th scope="row">{@systemProperty java.vm.specification.vendor}</th>
 651      *     <td>Java Virtual Machine specification vendor</td></tr>
 652      * <tr><th scope="row">{@systemProperty java.vm.specification.name}</th>
 653      *     <td>Java Virtual Machine specification name</td></tr>
 654      * <tr><th scope="row">{@systemProperty java.vm.version}</th>
 655      *     <td>Java Virtual Machine implementation version which may be
 656      *     interpreted as a {@link Runtime.Version}</td></tr>
 657      * <tr><th scope="row">{@systemProperty java.vm.vendor}</th>
 658      *     <td>Java Virtual Machine implementation vendor</td></tr>
 659      * <tr><th scope="row">{@systemProperty java.vm.name}</th>
 660      *     <td>Java Virtual Machine implementation name</td></tr>
 661      * <tr><th scope="row">{@systemProperty java.specification.version}</th>
 662      *     <td>Java Runtime Environment specification version, whose value is
 663      *     the {@linkplain Runtime.Version#feature feature} element of the
 664      *     {@linkplain Runtime#version() runtime version}</td></tr>
 665      * <tr><th scope="row">{@systemProperty java.specification.vendor}</th>
 666      *     <td>Java Runtime Environment specification  vendor</td></tr>
 667      * <tr><th scope="row">{@systemProperty java.specification.name}</th>
 668      *     <td>Java Runtime Environment specification  name</td></tr>
 669      * <tr><th scope="row">{@systemProperty java.class.version}</th>
 670      *     <td>Java class format version number</td></tr>
 671      * <tr><th scope="row">{@systemProperty java.class.path}</th>
 672      *     <td>Java class path  (refer to
 673      *        {@link ClassLoader#getSystemClassLoader()} for details)</td></tr>
 674      * <tr><th scope="row">{@systemProperty java.library.path}</th>
 675      *     <td>List of paths to search when loading libraries</td></tr>
 676      * <tr><th scope="row">{@systemProperty java.io.tmpdir}</th>
 677      *     <td>Default temp file path</td></tr>
 678      * <tr><th scope="row">{@systemProperty java.compiler}</th>
 679      *     <td>Name of JIT compiler to use</td></tr>
 680      * <tr><th scope="row">{@systemProperty os.name}</th>
 681      *     <td>Operating system name</td></tr>
 682      * <tr><th scope="row">{@systemProperty os.arch}</th>
 683      *     <td>Operating system architecture</td></tr>
 684      * <tr><th scope="row">{@systemProperty os.version}</th>
 685      *     <td>Operating system version</td></tr>
 686      * <tr><th scope="row">{@systemProperty file.separator}</th>
 687      *     <td>File separator ("/" on UNIX)</td></tr>
 688      * <tr><th scope="row">{@systemProperty path.separator}</th>
 689      *     <td>Path separator (":" on UNIX)</td></tr>
 690      * <tr><th scope="row">{@systemProperty line.separator}</th>
 691      *     <td>Line separator ("\n" on UNIX)</td></tr>
 692      * <tr><th scope="row">{@systemProperty user.name}</th>
 693      *     <td>User's account name</td></tr>
 694      * <tr><th scope="row">{@systemProperty user.home}</th>
 695      *     <td>User's home directory</td></tr>
 696      * <tr><th scope="row">{@systemProperty user.dir}</th>
 697      *     <td>User's current working directory</td></tr>
 698      * </tbody>
 699      * </table>
 700      * <p>
 701      * Multiple paths in a system property value are separated by the path
 702      * separator character of the platform.
 703      * <p>
 704      * Note that even if the security manager does not permit the
 705      * {@code getProperties} operation, it may choose to permit the
 706      * {@link #getProperty(String)} operation.
 707      *
 708      * @apiNote
 709      * <strong>Changing a standard system property may have unpredictable results
 710      * unless otherwise specified.</strong>
 711      * Property values may be cached during initialization or on first use.
 712      * Setting a standard property after initialization using {@link #getProperties()},
 713      * {@link #setProperties(Properties)}, {@link #setProperty(String, String)}, or
 714      * {@link #clearProperty(String)} may not have the desired effect.
 715      *
 716      * @implNote
 717      * In addition to the standard system properties, the system
 718      * properties may include the following keys:
 719      * <table class="striped">
 720      * <caption style="display:none">Shows property keys and associated values</caption>
 721      * <thead>
 722      * <tr><th scope="col">Key</th>
 723      *     <th scope="col">Description of Associated Value</th></tr>
 724      * </thead>
 725      * <tbody>
 726      * <tr><th scope="row">{@systemProperty jdk.module.path}</th>
 727      *     <td>The application module path</td></tr>
 728      * <tr><th scope="row">{@systemProperty jdk.module.upgrade.path}</th>
 729      *     <td>The upgrade module path</td></tr>
 730      * <tr><th scope="row">{@systemProperty jdk.module.main}</th>
 731      *     <td>The module name of the initial/main module</td></tr>
 732      * <tr><th scope="row">{@systemProperty jdk.module.main.class}</th>
 733      *     <td>The main class name of the initial module</td></tr>
 734      * </tbody>
 735      * </table>
 736      *
 737      * @return     the system properties
 738      * @throws     SecurityException  if a security manager exists and its
 739      *             {@code checkPropertiesAccess} method doesn't allow access
 740      *             to the system properties.
 741      * @see        #setProperties
 742      * @see        java.lang.SecurityException
 743      * @see        java.lang.SecurityManager#checkPropertiesAccess()
 744      * @see        java.util.Properties
 745      */
 746     public static Properties getProperties() {
 747         SecurityManager sm = getSecurityManager();
 748         if (sm != null) {
 749             sm.checkPropertiesAccess();
 750         }
 751 
 752         return props;
 753     }
 754 
 755     /**
 756      * Returns the system-dependent line separator string.  It always
 757      * returns the same value - the initial value of the {@linkplain
 758      * #getProperty(String) system property} {@code line.separator}.
 759      *
 760      * <p>On UNIX systems, it returns {@code "\n"}; on Microsoft
 761      * Windows systems it returns {@code "\r\n"}.
 762      *
 763      * @return the system-dependent line separator string
 764      * @since 1.7
 765      */
 766     public static String lineSeparator() {
 767         return lineSeparator;
 768     }
 769 
 770     private static String lineSeparator;
 771 
 772     /**
 773      * Sets the system properties to the {@code Properties} argument.
 774      *
 775      * First, if there is a security manager, its
 776      * {@code checkPropertiesAccess} method is called with no
 777      * arguments. This may result in a security exception.
 778      * <p>
 779      * The argument becomes the current set of system properties for use
 780      * by the {@link #getProperty(String)} method. If the argument is
 781      * {@code null}, then the current set of system properties is
 782      * forgotten.
 783      *
 784      * @apiNote
 785      * <strong>Changing a standard system property may have unpredictable results
 786      * unless otherwise specified</strong>.
 787      * See {@linkplain #getProperties getProperties} for details.
 788      *
 789      * @param      props   the new system properties.
 790      * @throws     SecurityException  if a security manager exists and its
 791      *             {@code checkPropertiesAccess} method doesn't allow access
 792      *             to the system properties.
 793      * @see        #getProperties
 794      * @see        java.util.Properties
 795      * @see        java.lang.SecurityException
 796      * @see        java.lang.SecurityManager#checkPropertiesAccess()
 797      */
 798     public static void setProperties(Properties props) {
 799         SecurityManager sm = getSecurityManager();
 800         if (sm != null) {
 801             sm.checkPropertiesAccess();
 802         }
 803 
 804         if (props == null) {
 805             Map<String, String> tempProps = SystemProps.initProperties();
 806             VersionProps.init(tempProps);
 807             props = createProperties(tempProps);
 808         }
 809         System.props = props;
 810     }
 811 
 812     /**
 813      * Gets the system property indicated by the specified key.
 814      *
 815      * First, if there is a security manager, its
 816      * {@code checkPropertyAccess} method is called with the key as
 817      * its argument. This may result in a SecurityException.
 818      * <p>
 819      * If there is no current set of system properties, a set of system
 820      * properties is first created and initialized in the same manner as
 821      * for the {@code getProperties} method.
 822      *
 823      * @apiNote
 824      * <strong>Changing a standard system property may have unpredictable results
 825      * unless otherwise specified</strong>.
 826      * See {@linkplain #getProperties getProperties} for details.
 827      *
 828      * @param      key   the name of the system property.
 829      * @return     the string value of the system property,
 830      *             or {@code null} if there is no property with that key.
 831      *
 832      * @throws     SecurityException  if a security manager exists and its
 833      *             {@code checkPropertyAccess} method doesn't allow
 834      *             access to the specified system property.
 835      * @throws     NullPointerException if {@code key} is {@code null}.
 836      * @throws     IllegalArgumentException if {@code key} is empty.
 837      * @see        #setProperty
 838      * @see        java.lang.SecurityException
 839      * @see        java.lang.SecurityManager#checkPropertyAccess(java.lang.String)
 840      * @see        java.lang.System#getProperties()
 841      */
 842     public static String getProperty(String key) {
 843         checkKey(key);
 844         SecurityManager sm = getSecurityManager();
 845         if (sm != null) {
 846             sm.checkPropertyAccess(key);
 847         }
 848 
 849         return props.getProperty(key);
 850     }
 851 
 852     /**
 853      * Gets the system property indicated by the specified key.
 854      *
 855      * First, if there is a security manager, its
 856      * {@code checkPropertyAccess} method is called with the
 857      * {@code key} as its argument.
 858      * <p>
 859      * If there is no current set of system properties, a set of system
 860      * properties is first created and initialized in the same manner as
 861      * for the {@code getProperties} method.
 862      *
 863      * @param      key   the name of the system property.
 864      * @param      def   a default value.
 865      * @return     the string value of the system property,
 866      *             or the default value if there is no property with that key.
 867      *
 868      * @throws     SecurityException  if a security manager exists and its
 869      *             {@code checkPropertyAccess} method doesn't allow
 870      *             access to the specified system property.
 871      * @throws     NullPointerException if {@code key} is {@code null}.
 872      * @throws     IllegalArgumentException if {@code key} is empty.
 873      * @see        #setProperty
 874      * @see        java.lang.SecurityManager#checkPropertyAccess(java.lang.String)
 875      * @see        java.lang.System#getProperties()
 876      */
 877     public static String getProperty(String key, String def) {
 878         checkKey(key);
 879         SecurityManager sm = getSecurityManager();
 880         if (sm != null) {
 881             sm.checkPropertyAccess(key);
 882         }
 883 
 884         return props.getProperty(key, def);
 885     }
 886 
 887     /**
 888      * Sets the system property indicated by the specified key.
 889      *
 890      * First, if a security manager exists, its
 891      * {@code SecurityManager.checkPermission} method
 892      * is called with a {@code PropertyPermission(key, "write")}
 893      * permission. This may result in a SecurityException being thrown.
 894      * If no exception is thrown, the specified property is set to the given
 895      * value.
 896      *
 897      * @apiNote
 898      * <strong>Changing a standard system property may have unpredictable results
 899      * unless otherwise specified</strong>.
 900      * See {@linkplain #getProperties getProperties} for details.
 901      *
 902      * @param      key   the name of the system property.
 903      * @param      value the value of the system property.
 904      * @return     the previous value of the system property,
 905      *             or {@code null} if it did not have one.
 906      *
 907      * @throws     SecurityException  if a security manager exists and its
 908      *             {@code checkPermission} method doesn't allow
 909      *             setting of the specified property.
 910      * @throws     NullPointerException if {@code key} or
 911      *             {@code value} is {@code null}.
 912      * @throws     IllegalArgumentException if {@code key} is empty.
 913      * @see        #getProperty
 914      * @see        java.lang.System#getProperty(java.lang.String)
 915      * @see        java.lang.System#getProperty(java.lang.String, java.lang.String)
 916      * @see        java.util.PropertyPermission
 917      * @see        SecurityManager#checkPermission
 918      * @since      1.2
 919      */
 920     public static String setProperty(String key, String value) {
 921         checkKey(key);
 922         SecurityManager sm = getSecurityManager();
 923         if (sm != null) {
 924             sm.checkPermission(new PropertyPermission(key,
 925                 SecurityConstants.PROPERTY_WRITE_ACTION));
 926         }
 927 
 928         return (String) props.setProperty(key, value);
 929     }
 930 
 931     /**
 932      * Removes the system property indicated by the specified key.
 933      *
 934      * First, if a security manager exists, its
 935      * {@code SecurityManager.checkPermission} method
 936      * is called with a {@code PropertyPermission(key, "write")}
 937      * permission. This may result in a SecurityException being thrown.
 938      * If no exception is thrown, the specified property is removed.
 939      *
 940      * @apiNote
 941      * <strong>Changing a standard system property may have unpredictable results
 942      * unless otherwise specified</strong>.
 943      * See {@linkplain #getProperties getProperties} method for details.
 944      *
 945      * @param      key   the name of the system property to be removed.
 946      * @return     the previous string value of the system property,
 947      *             or {@code null} if there was no property with that key.
 948      *
 949      * @throws     SecurityException  if a security manager exists and its
 950      *             {@code checkPropertyAccess} method doesn't allow
 951      *              access to the specified system property.
 952      * @throws     NullPointerException if {@code key} is {@code null}.
 953      * @throws     IllegalArgumentException if {@code key} is empty.
 954      * @see        #getProperty
 955      * @see        #setProperty
 956      * @see        java.util.Properties
 957      * @see        java.lang.SecurityException
 958      * @see        java.lang.SecurityManager#checkPropertiesAccess()
 959      * @since 1.5
 960      */
 961     public static String clearProperty(String key) {
 962         checkKey(key);
 963         SecurityManager sm = getSecurityManager();
 964         if (sm != null) {
 965             sm.checkPermission(new PropertyPermission(key, "write"));
 966         }
 967 
 968         return (String) props.remove(key);
 969     }
 970 
 971     private static void checkKey(String key) {
 972         if (key == null) {
 973             throw new NullPointerException("key can't be null");
 974         }
 975         if (key.isEmpty()) {
 976             throw new IllegalArgumentException("key can't be empty");
 977         }
 978     }
 979 
 980     /**
 981      * Gets the value of the specified environment variable. An
 982      * environment variable is a system-dependent external named
 983      * value.
 984      *
 985      * <p>If a security manager exists, its
 986      * {@link SecurityManager#checkPermission checkPermission}
 987      * method is called with a
 988      * {@link RuntimePermission RuntimePermission("getenv."+name)}
 989      * permission.  This may result in a {@link SecurityException}
 990      * being thrown.  If no exception is thrown the value of the
 991      * variable {@code name} is returned.
 992      *
 993      * <p><a id="EnvironmentVSSystemProperties"><i>System
 994      * properties</i> and <i>environment variables</i></a> are both
 995      * conceptually mappings between names and values.  Both
 996      * mechanisms can be used to pass user-defined information to a
 997      * Java process.  Environment variables have a more global effect,
 998      * because they are visible to all descendants of the process
 999      * which defines them, not just the immediate Java subprocess.
1000      * They can have subtly different semantics, such as case
1001      * insensitivity, on different operating systems.  For these
1002      * reasons, environment variables are more likely to have
1003      * unintended side effects.  It is best to use system properties
1004      * where possible.  Environment variables should be used when a
1005      * global effect is desired, or when an external system interface
1006      * requires an environment variable (such as {@code PATH}).
1007      *
1008      * <p>On UNIX systems the alphabetic case of {@code name} is
1009      * typically significant, while on Microsoft Windows systems it is
1010      * typically not.  For example, the expression
1011      * {@code System.getenv("FOO").equals(System.getenv("foo"))}
1012      * is likely to be true on Microsoft Windows.
1013      *
1014      * @param  name the name of the environment variable
1015      * @return the string value of the variable, or {@code null}
1016      *         if the variable is not defined in the system environment
1017      * @throws NullPointerException if {@code name} is {@code null}
1018      * @throws SecurityException
1019      *         if a security manager exists and its
1020      *         {@link SecurityManager#checkPermission checkPermission}
1021      *         method doesn't allow access to the environment variable
1022      *         {@code name}
1023      * @see    #getenv()
1024      * @see    ProcessBuilder#environment()
1025      */
1026     public static String getenv(String name) {
1027         SecurityManager sm = getSecurityManager();
1028         if (sm != null) {
1029             sm.checkPermission(new RuntimePermission("getenv."+name));
1030         }
1031 
1032         return ProcessEnvironment.getenv(name);
1033     }
1034 
1035 
1036     /**
1037      * Returns an unmodifiable string map view of the current system environment.
1038      * The environment is a system-dependent mapping from names to
1039      * values which is passed from parent to child processes.
1040      *
1041      * <p>If the system does not support environment variables, an
1042      * empty map is returned.
1043      *
1044      * <p>The returned map will never contain null keys or values.
1045      * Attempting to query the presence of a null key or value will
1046      * throw a {@link NullPointerException}.  Attempting to query
1047      * the presence of a key or value which is not of type
1048      * {@link String} will throw a {@link ClassCastException}.
1049      *
1050      * <p>The returned map and its collection views may not obey the
1051      * general contract of the {@link Object#equals} and
1052      * {@link Object#hashCode} methods.
1053      *
1054      * <p>The returned map is typically case-sensitive on all platforms.
1055      *
1056      * <p>If a security manager exists, its
1057      * {@link SecurityManager#checkPermission checkPermission}
1058      * method is called with a
1059      * {@link RuntimePermission RuntimePermission("getenv.*")} permission.
1060      * This may result in a {@link SecurityException} being thrown.
1061      *
1062      * <p>When passing information to a Java subprocess,
1063      * <a href=#EnvironmentVSSystemProperties>system properties</a>
1064      * are generally preferred over environment variables.
1065      *
1066      * @return the environment as a map of variable names to values
1067      * @throws SecurityException
1068      *         if a security manager exists and its
1069      *         {@link SecurityManager#checkPermission checkPermission}
1070      *         method doesn't allow access to the process environment
1071      * @see    #getenv(String)
1072      * @see    ProcessBuilder#environment()
1073      * @since  1.5
1074      */
1075     public static java.util.Map<String,String> getenv() {
1076         SecurityManager sm = getSecurityManager();
1077         if (sm != null) {
1078             sm.checkPermission(new RuntimePermission("getenv.*"));
1079         }
1080 
1081         return ProcessEnvironment.getenv();
1082     }
1083 
1084     /**
1085      * {@code System.Logger} instances log messages that will be
1086      * routed to the underlying logging framework the {@link System.LoggerFinder
1087      * LoggerFinder} uses.
1088      *
1089      * {@code System.Logger} instances are typically obtained from
1090      * the {@link java.lang.System System} class, by calling
1091      * {@link java.lang.System#getLogger(java.lang.String) System.getLogger(loggerName)}
1092      * or {@link java.lang.System#getLogger(java.lang.String, java.util.ResourceBundle)
1093      * System.getLogger(loggerName, bundle)}.
1094      *
1095      * @see java.lang.System#getLogger(java.lang.String)
1096      * @see java.lang.System#getLogger(java.lang.String, java.util.ResourceBundle)
1097      * @see java.lang.System.LoggerFinder
1098      *
1099      * @since 9
1100      */
1101     public interface Logger {
1102 
1103         /**
1104          * System {@linkplain Logger loggers} levels.
1105          *
1106          * A level has a {@linkplain #getName() name} and {@linkplain
1107          * #getSeverity() severity}.
1108          * Level values are {@link #ALL}, {@link #TRACE}, {@link #DEBUG},
1109          * {@link #INFO}, {@link #WARNING}, {@link #ERROR}, {@link #OFF},
1110          * by order of increasing severity.
1111          * <br>
1112          * {@link #ALL} and {@link #OFF}
1113          * are simple markers with severities mapped respectively to
1114          * {@link java.lang.Integer#MIN_VALUE Integer.MIN_VALUE} and
1115          * {@link java.lang.Integer#MAX_VALUE Integer.MAX_VALUE}.
1116          * <p>
1117          * <b>Severity values and Mapping to {@code java.util.logging.Level}.</b>
1118          * <p>
1119          * {@linkplain System.Logger.Level System logger levels} are mapped to
1120          * {@linkplain java.util.logging.Level  java.util.logging levels}
1121          * of corresponding severity.
1122          * <br>The mapping is as follows:
1123          * <br><br>
1124          * <table class="striped">
1125          * <caption>System.Logger Severity Level Mapping</caption>
1126          * <thead>
1127          * <tr><th scope="col">System.Logger Levels</th>
1128          *     <th scope="col">java.util.logging Levels</th>
1129          * </thead>
1130          * <tbody>
1131          * <tr><th scope="row">{@link Logger.Level#ALL ALL}</th>
1132          *     <td>{@link java.util.logging.Level#ALL ALL}</td>
1133          * <tr><th scope="row">{@link Logger.Level#TRACE TRACE}</th>
1134          *     <td>{@link java.util.logging.Level#FINER FINER}</td>
1135          * <tr><th scope="row">{@link Logger.Level#DEBUG DEBUG}</th>
1136          *     <td>{@link java.util.logging.Level#FINE FINE}</td>
1137          * <tr><th scope="row">{@link Logger.Level#INFO INFO}</th>
1138          *     <td>{@link java.util.logging.Level#INFO INFO}</td>
1139          * <tr><th scope="row">{@link Logger.Level#WARNING WARNING}</th>
1140          *     <td>{@link java.util.logging.Level#WARNING WARNING}</td>
1141          * <tr><th scope="row">{@link Logger.Level#ERROR ERROR}</th>
1142          *     <td>{@link java.util.logging.Level#SEVERE SEVERE}</td>
1143          * <tr><th scope="row">{@link Logger.Level#OFF OFF}</th>
1144          *     <td>{@link java.util.logging.Level#OFF OFF}</td>
1145          * </tbody>
1146          * </table>
1147          *
1148          * @since 9
1149          *
1150          * @see java.lang.System.LoggerFinder
1151          * @see java.lang.System.Logger
1152          */
1153         public enum Level {
1154 
1155             // for convenience, we're reusing java.util.logging.Level int values
1156             // the mapping logic in sun.util.logging.PlatformLogger depends
1157             // on this.
1158             /**
1159              * A marker to indicate that all levels are enabled.
1160              * This level {@linkplain #getSeverity() severity} is
1161              * {@link Integer#MIN_VALUE}.
1162              */
1163             ALL(Integer.MIN_VALUE),  // typically mapped to/from j.u.l.Level.ALL
1164             /**
1165              * {@code TRACE} level: usually used to log diagnostic information.
1166              * This level {@linkplain #getSeverity() severity} is
1167              * {@code 400}.
1168              */
1169             TRACE(400),   // typically mapped to/from j.u.l.Level.FINER
1170             /**
1171              * {@code DEBUG} level: usually used to log debug information traces.
1172              * This level {@linkplain #getSeverity() severity} is
1173              * {@code 500}.
1174              */
1175             DEBUG(500),   // typically mapped to/from j.u.l.Level.FINEST/FINE/CONFIG
1176             /**
1177              * {@code INFO} level: usually used to log information messages.
1178              * This level {@linkplain #getSeverity() severity} is
1179              * {@code 800}.
1180              */
1181             INFO(800),    // typically mapped to/from j.u.l.Level.INFO
1182             /**
1183              * {@code WARNING} level: usually used to log warning messages.
1184              * This level {@linkplain #getSeverity() severity} is
1185              * {@code 900}.
1186              */
1187             WARNING(900), // typically mapped to/from j.u.l.Level.WARNING
1188             /**
1189              * {@code ERROR} level: usually used to log error messages.
1190              * This level {@linkplain #getSeverity() severity} is
1191              * {@code 1000}.
1192              */
1193             ERROR(1000),  // typically mapped to/from j.u.l.Level.SEVERE
1194             /**
1195              * A marker to indicate that all levels are disabled.
1196              * This level {@linkplain #getSeverity() severity} is
1197              * {@link Integer#MAX_VALUE}.
1198              */
1199             OFF(Integer.MAX_VALUE);  // typically mapped to/from j.u.l.Level.OFF
1200 
1201             private final int severity;
1202 
1203             private Level(int severity) {
1204                 this.severity = severity;
1205             }
1206 
1207             /**
1208              * Returns the name of this level.
1209              * @return this level {@linkplain #name()}.
1210              */
1211             public final String getName() {
1212                 return name();
1213             }
1214 
1215             /**
1216              * Returns the severity of this level.
1217              * A higher severity means a more severe condition.
1218              * @return this level severity.
1219              */
1220             public final int getSeverity() {
1221                 return severity;
1222             }
1223         }
1224 
1225         /**
1226          * Returns the name of this logger.
1227          *
1228          * @return the logger name.
1229          */
1230         public String getName();
1231 
1232         /**
1233          * Checks if a message of the given level would be logged by
1234          * this logger.
1235          *
1236          * @param level the log message level.
1237          * @return {@code true} if the given log message level is currently
1238          *         being logged.
1239          *
1240          * @throws NullPointerException if {@code level} is {@code null}.
1241          */
1242         public boolean isLoggable(Level level);
1243 
1244         /**
1245          * Logs a message.
1246          *
1247          * @implSpec The default implementation for this method calls
1248          * {@code this.log(level, (ResourceBundle)null, msg, (Object[])null);}
1249          *
1250          * @param level the log message level.
1251          * @param msg the string message (or a key in the message catalog, if
1252          * this logger is a {@link
1253          * LoggerFinder#getLocalizedLogger(java.lang.String,
1254          * java.util.ResourceBundle, java.lang.Module) localized logger});
1255          * can be {@code null}.
1256          *
1257          * @throws NullPointerException if {@code level} is {@code null}.
1258          */
1259         public default void log(Level level, String msg) {
1260             log(level, (ResourceBundle) null, msg, (Object[]) null);
1261         }
1262 
1263         /**
1264          * Logs a lazily supplied message.
1265          *
1266          * If the logger is currently enabled for the given log message level
1267          * then a message is logged that is the result produced by the
1268          * given supplier function.  Otherwise, the supplier is not operated on.
1269          *
1270          * @implSpec When logging is enabled for the given level, the default
1271          * implementation for this method calls
1272          * {@code this.log(level, (ResourceBundle)null, msgSupplier.get(), (Object[])null);}
1273          *
1274          * @param level the log message level.
1275          * @param msgSupplier a supplier function that produces a message.
1276          *
1277          * @throws NullPointerException if {@code level} is {@code null},
1278          *         or {@code msgSupplier} is {@code null}.
1279          */
1280         public default void log(Level level, Supplier<String> msgSupplier) {
1281             Objects.requireNonNull(msgSupplier);
1282             if (isLoggable(Objects.requireNonNull(level))) {
1283                 log(level, (ResourceBundle) null, msgSupplier.get(), (Object[]) null);
1284             }
1285         }
1286 
1287         /**
1288          * Logs a message produced from the given object.
1289          *
1290          * If the logger is currently enabled for the given log message level then
1291          * a message is logged that, by default, is the result produced from
1292          * calling  toString on the given object.
1293          * Otherwise, the object is not operated on.
1294          *
1295          * @implSpec When logging is enabled for the given level, the default
1296          * implementation for this method calls
1297          * {@code this.log(level, (ResourceBundle)null, obj.toString(), (Object[])null);}
1298          *
1299          * @param level the log message level.
1300          * @param obj the object to log.
1301          *
1302          * @throws NullPointerException if {@code level} is {@code null}, or
1303          *         {@code obj} is {@code null}.
1304          */
1305         public default void log(Level level, Object obj) {
1306             Objects.requireNonNull(obj);
1307             if (isLoggable(Objects.requireNonNull(level))) {
1308                 this.log(level, (ResourceBundle) null, obj.toString(), (Object[]) null);
1309             }
1310         }
1311 
1312         /**
1313          * Logs a message associated with a given throwable.
1314          *
1315          * @implSpec The default implementation for this method calls
1316          * {@code this.log(level, (ResourceBundle)null, msg, thrown);}
1317          *
1318          * @param level the log message level.
1319          * @param msg the string message (or a key in the message catalog, if
1320          * this logger is a {@link
1321          * LoggerFinder#getLocalizedLogger(java.lang.String,
1322          * java.util.ResourceBundle, java.lang.Module) localized logger});
1323          * can be {@code null}.
1324          * @param thrown a {@code Throwable} associated with the log message;
1325          *        can be {@code null}.
1326          *
1327          * @throws NullPointerException if {@code level} is {@code null}.
1328          */
1329         public default void log(Level level, String msg, Throwable thrown) {
1330             this.log(level, null, msg, thrown);
1331         }
1332 
1333         /**
1334          * Logs a lazily supplied message associated with a given throwable.
1335          *
1336          * If the logger is currently enabled for the given log message level
1337          * then a message is logged that is the result produced by the
1338          * given supplier function.  Otherwise, the supplier is not operated on.
1339          *
1340          * @implSpec When logging is enabled for the given level, the default
1341          * implementation for this method calls
1342          * {@code this.log(level, (ResourceBundle)null, msgSupplier.get(), thrown);}
1343          *
1344          * @param level one of the log message level identifiers.
1345          * @param msgSupplier a supplier function that produces a message.
1346          * @param thrown a {@code Throwable} associated with log message;
1347          *               can be {@code null}.
1348          *
1349          * @throws NullPointerException if {@code level} is {@code null}, or
1350          *                               {@code msgSupplier} is {@code null}.
1351          */
1352         public default void log(Level level, Supplier<String> msgSupplier,
1353                 Throwable thrown) {
1354             Objects.requireNonNull(msgSupplier);
1355             if (isLoggable(Objects.requireNonNull(level))) {
1356                 this.log(level, null, msgSupplier.get(), thrown);
1357             }
1358         }
1359 
1360         /**
1361          * Logs a message with an optional list of parameters.
1362          *
1363          * @implSpec The default implementation for this method calls
1364          * {@code this.log(level, (ResourceBundle)null, format, params);}
1365          *
1366          * @param level one of the log message level identifiers.
1367          * @param format the string message format in {@link
1368          * java.text.MessageFormat} format, (or a key in the message
1369          * catalog, if this logger is a {@link
1370          * LoggerFinder#getLocalizedLogger(java.lang.String,
1371          * java.util.ResourceBundle, java.lang.Module) localized logger});
1372          * can be {@code null}.
1373          * @param params an optional list of parameters to the message (may be
1374          * none).
1375          *
1376          * @throws NullPointerException if {@code level} is {@code null}.
1377          */
1378         public default void log(Level level, String format, Object... params) {
1379             this.log(level, null, format, params);
1380         }
1381 
1382         /**
1383          * Logs a localized message associated with a given throwable.
1384          *
1385          * If the given resource bundle is non-{@code null},  the {@code msg}
1386          * string is localized using the given resource bundle.
1387          * Otherwise the {@code msg} string is not localized.
1388          *
1389          * @param level the log message level.
1390          * @param bundle a resource bundle to localize {@code msg}; can be
1391          * {@code null}.
1392          * @param msg the string message (or a key in the message catalog,
1393          *            if {@code bundle} is not {@code null}); can be {@code null}.
1394          * @param thrown a {@code Throwable} associated with the log message;
1395          *        can be {@code null}.
1396          *
1397          * @throws NullPointerException if {@code level} is {@code null}.
1398          */
1399         public void log(Level level, ResourceBundle bundle, String msg,
1400                 Throwable thrown);
1401 
1402         /**
1403          * Logs a message with resource bundle and an optional list of
1404          * parameters.
1405          *
1406          * If the given resource bundle is non-{@code null},  the {@code format}
1407          * string is localized using the given resource bundle.
1408          * Otherwise the {@code format} string is not localized.
1409          *
1410          * @param level the log message level.
1411          * @param bundle a resource bundle to localize {@code format}; can be
1412          * {@code null}.
1413          * @param format the string message format in {@link
1414          * java.text.MessageFormat} format, (or a key in the message
1415          * catalog if {@code bundle} is not {@code null}); can be {@code null}.
1416          * @param params an optional list of parameters to the message (may be
1417          * none).
1418          *
1419          * @throws NullPointerException if {@code level} is {@code null}.
1420          */
1421         public void log(Level level, ResourceBundle bundle, String format,
1422                 Object... params);
1423     }
1424 
1425     /**
1426      * The {@code LoggerFinder} service is responsible for creating, managing,
1427      * and configuring loggers to the underlying framework it uses.
1428      *
1429      * A logger finder is a concrete implementation of this class that has a
1430      * zero-argument constructor and implements the abstract methods defined
1431      * by this class.
1432      * The loggers returned from a logger finder are capable of routing log
1433      * messages to the logging backend this provider supports.
1434      * A given invocation of the Java Runtime maintains a single
1435      * system-wide LoggerFinder instance that is loaded as follows:
1436      * <ul>
1437      *    <li>First it finds any custom {@code LoggerFinder} provider
1438      *        using the {@link java.util.ServiceLoader} facility with the
1439      *        {@linkplain ClassLoader#getSystemClassLoader() system class
1440      *        loader}.</li>
1441      *    <li>If no {@code LoggerFinder} provider is found, the system default
1442      *        {@code LoggerFinder} implementation will be used.</li>
1443      * </ul>
1444      * <p>
1445      * An application can replace the logging backend
1446      * <i>even when the java.logging module is present</i>, by simply providing
1447      * and declaring an implementation of the {@link LoggerFinder} service.
1448      * <p>
1449      * <b>Default Implementation</b>
1450      * <p>
1451      * The system default {@code LoggerFinder} implementation uses
1452      * {@code java.util.logging} as the backend framework when the
1453      * {@code java.logging} module is present.
1454      * It returns a {@linkplain System.Logger logger} instance
1455      * that will route log messages to a {@link java.util.logging.Logger
1456      * java.util.logging.Logger}. Otherwise, if {@code java.logging} is not
1457      * present, the default implementation will return a simple logger
1458      * instance that will route log messages of {@code INFO} level and above to
1459      * the console ({@code System.err}).
1460      * <p>
1461      * <b>Logging Configuration</b>
1462      * <p>
1463      * {@linkplain Logger Logger} instances obtained from the
1464      * {@code LoggerFinder} factory methods are not directly configurable by
1465      * the application. Configuration is the responsibility of the underlying
1466      * logging backend, and usually requires using APIs specific to that backend.
1467      * <p>For the default {@code LoggerFinder} implementation
1468      * using {@code java.util.logging} as its backend, refer to
1469      * {@link java.util.logging java.util.logging} for logging configuration.
1470      * For the default {@code LoggerFinder} implementation returning simple loggers
1471      * when the {@code java.logging} module is absent, the configuration
1472      * is implementation dependent.
1473      * <p>
1474      * Usually an application that uses a logging framework will log messages
1475      * through a logger facade defined (or supported) by that framework.
1476      * Applications that wish to use an external framework should log
1477      * through the facade associated with that framework.
1478      * <p>
1479      * A system class that needs to log messages will typically obtain
1480      * a {@link System.Logger} instance to route messages to the logging
1481      * framework selected by the application.
1482      * <p>
1483      * Libraries and classes that only need loggers to produce log messages
1484      * should not attempt to configure loggers by themselves, as that
1485      * would make them dependent from a specific implementation of the
1486      * {@code LoggerFinder} service.
1487      * <p>
1488      * In addition, when a security manager is present, loggers provided to
1489      * system classes should not be directly configurable through the logging
1490      * backend without requiring permissions.
1491      * <br>
1492      * It is the responsibility of the provider of
1493      * the concrete {@code LoggerFinder} implementation to ensure that
1494      * these loggers are not configured by untrusted code without proper
1495      * permission checks, as configuration performed on such loggers usually
1496      * affects all applications in the same Java Runtime.
1497      * <p>
1498      * <b>Message Levels and Mapping to backend levels</b>
1499      * <p>
1500      * A logger finder is responsible for mapping from a {@code
1501      * System.Logger.Level} to a level supported by the logging backend it uses.
1502      * <br>The default LoggerFinder using {@code java.util.logging} as the backend
1503      * maps {@code System.Logger} levels to
1504      * {@linkplain java.util.logging.Level java.util.logging} levels
1505      * of corresponding severity - as described in {@link Logger.Level
1506      * Logger.Level}.
1507      *
1508      * @see java.lang.System
1509      * @see java.lang.System.Logger
1510      *
1511      * @since 9
1512      */
1513     public static abstract class LoggerFinder {
1514         /**
1515          * The {@code RuntimePermission("loggerFinder")} is
1516          * necessary to subclass and instantiate the {@code LoggerFinder} class,
1517          * as well as to obtain loggers from an instance of that class.
1518          */
1519         static final RuntimePermission LOGGERFINDER_PERMISSION =
1520                 new RuntimePermission("loggerFinder");
1521 
1522         /**
1523          * Creates a new instance of {@code LoggerFinder}.
1524          *
1525          * @implNote It is recommended that a {@code LoggerFinder} service
1526          *   implementation does not perform any heavy initialization in its
1527          *   constructor, in order to avoid possible risks of deadlock or class
1528          *   loading cycles during the instantiation of the service provider.
1529          *
1530          * @throws SecurityException if a security manager is present and its
1531          *         {@code checkPermission} method doesn't allow the
1532          *         {@code RuntimePermission("loggerFinder")}.
1533          */
1534         protected LoggerFinder() {
1535             this(checkPermission());
1536         }
1537 
1538         private LoggerFinder(Void unused) {
1539             // nothing to do.
1540         }
1541 
1542         private static Void checkPermission() {
1543             final SecurityManager sm = System.getSecurityManager();
1544             if (sm != null) {
1545                 sm.checkPermission(LOGGERFINDER_PERMISSION);
1546             }
1547             return null;
1548         }
1549 
1550         /**
1551          * Returns an instance of {@link Logger Logger}
1552          * for the given {@code module}.
1553          *
1554          * @param name the name of the logger.
1555          * @param module the module for which the logger is being requested.
1556          *
1557          * @return a {@link Logger logger} suitable for use within the given
1558          *         module.
1559          * @throws NullPointerException if {@code name} is {@code null} or
1560          *        {@code module} is {@code null}.
1561          * @throws SecurityException if a security manager is present and its
1562          *         {@code checkPermission} method doesn't allow the
1563          *         {@code RuntimePermission("loggerFinder")}.
1564          */
1565         public abstract Logger getLogger(String name, Module module);
1566 
1567         /**
1568          * Returns a localizable instance of {@link Logger Logger}
1569          * for the given {@code module}.
1570          * The returned logger will use the provided resource bundle for
1571          * message localization.
1572          *
1573          * @implSpec By default, this method calls {@link
1574          * #getLogger(java.lang.String, java.lang.Module)
1575          * this.getLogger(name, module)} to obtain a logger, then wraps that
1576          * logger in a {@link Logger} instance where all methods that do not
1577          * take a {@link ResourceBundle} as parameter are redirected to one
1578          * which does - passing the given {@code bundle} for
1579          * localization. So for instance, a call to {@link
1580          * Logger#log(Logger.Level, String) Logger.log(Level.INFO, msg)}
1581          * will end up as a call to {@link
1582          * Logger#log(Logger.Level, ResourceBundle, String, Object...)
1583          * Logger.log(Level.INFO, bundle, msg, (Object[])null)} on the wrapped
1584          * logger instance.
1585          * Note however that by default, string messages returned by {@link
1586          * java.util.function.Supplier Supplier&lt;String&gt;} will not be
1587          * localized, as it is assumed that such strings are messages which are
1588          * already constructed, rather than keys in a resource bundle.
1589          * <p>
1590          * An implementation of {@code LoggerFinder} may override this method,
1591          * for example, when the underlying logging backend provides its own
1592          * mechanism for localizing log messages, then such a
1593          * {@code LoggerFinder} would be free to return a logger
1594          * that makes direct use of the mechanism provided by the backend.
1595          *
1596          * @param name    the name of the logger.
1597          * @param bundle  a resource bundle; can be {@code null}.
1598          * @param module  the module for which the logger is being requested.
1599          * @return an instance of {@link Logger Logger}  which will use the
1600          * provided resource bundle for message localization.
1601          *
1602          * @throws NullPointerException if {@code name} is {@code null} or
1603          *         {@code module} is {@code null}.
1604          * @throws SecurityException if a security manager is present and its
1605          *         {@code checkPermission} method doesn't allow the
1606          *         {@code RuntimePermission("loggerFinder")}.
1607          */
1608         public Logger getLocalizedLogger(String name, ResourceBundle bundle,
1609                                          Module module) {
1610             return new LocalizedLoggerWrapper<>(getLogger(name, module), bundle);
1611         }
1612 
1613         /**
1614          * Returns the {@code LoggerFinder} instance. There is one
1615          * single system-wide {@code LoggerFinder} instance in
1616          * the Java Runtime.  See the class specification of how the
1617          * {@link LoggerFinder LoggerFinder} implementation is located and
1618          * loaded.
1619 
1620          * @return the {@link LoggerFinder LoggerFinder} instance.
1621          * @throws SecurityException if a security manager is present and its
1622          *         {@code checkPermission} method doesn't allow the
1623          *         {@code RuntimePermission("loggerFinder")}.
1624          */
1625         public static LoggerFinder getLoggerFinder() {
1626             final SecurityManager sm = System.getSecurityManager();
1627             if (sm != null) {
1628                 sm.checkPermission(LOGGERFINDER_PERMISSION);
1629             }
1630             return accessProvider();
1631         }
1632 
1633 
1634         private static volatile LoggerFinder service;
1635         static LoggerFinder accessProvider() {
1636             // We do not need to synchronize: LoggerFinderLoader will
1637             // always return the same instance, so if we don't have it,
1638             // just fetch it again.
1639             if (service == null) {
1640                 PrivilegedAction<LoggerFinder> pa =
1641                         () -> LoggerFinderLoader.getLoggerFinder();
1642                 service = AccessController.doPrivileged(pa, null,
1643                         LOGGERFINDER_PERMISSION);
1644             }
1645             return service;
1646         }
1647 
1648     }
1649 
1650 
1651     /**
1652      * Returns an instance of {@link Logger Logger} for the caller's
1653      * use.
1654      *
1655      * @implSpec
1656      * Instances returned by this method route messages to loggers
1657      * obtained by calling {@link LoggerFinder#getLogger(java.lang.String,
1658      * java.lang.Module) LoggerFinder.getLogger(name, module)}, where
1659      * {@code module} is the caller's module.
1660      * In cases where {@code System.getLogger} is called from a context where
1661      * there is no caller frame on the stack (e.g when called directly
1662      * from a JNI attached thread), {@code IllegalCallerException} is thrown.
1663      * To obtain a logger in such a context, use an auxiliary class that will
1664      * implicitly be identified as the caller, or use the system {@link
1665      * LoggerFinder#getLoggerFinder() LoggerFinder} to obtain a logger instead.
1666      * Note that doing the latter may eagerly initialize the underlying
1667      * logging system.
1668      *
1669      * @apiNote
1670      * This method may defer calling the {@link
1671      * LoggerFinder#getLogger(java.lang.String, java.lang.Module)
1672      * LoggerFinder.getLogger} method to create an actual logger supplied by
1673      * the logging backend, for instance, to allow loggers to be obtained during
1674      * the system initialization time.
1675      *
1676      * @param name the name of the logger.
1677      * @return an instance of {@link Logger} that can be used by the calling
1678      *         class.
1679      * @throws NullPointerException if {@code name} is {@code null}.
1680      * @throws IllegalCallerException if there is no Java caller frame on the
1681      *         stack.
1682      *
1683      * @since 9
1684      */
1685     @CallerSensitive
1686     public static Logger getLogger(String name) {
1687         Objects.requireNonNull(name);
1688         final Class<?> caller = Reflection.getCallerClass();
1689         if (caller == null) {
1690             throw new IllegalCallerException("no caller frame");
1691         }
1692         return LazyLoggers.getLogger(name, caller.getModule());
1693     }
1694 
1695     /**
1696      * Returns a localizable instance of {@link Logger
1697      * Logger} for the caller's use.
1698      * The returned logger will use the provided resource bundle for message
1699      * localization.
1700      *
1701      * @implSpec
1702      * The returned logger will perform message localization as specified
1703      * by {@link LoggerFinder#getLocalizedLogger(java.lang.String,
1704      * java.util.ResourceBundle, java.lang.Module)
1705      * LoggerFinder.getLocalizedLogger(name, bundle, module)}, where
1706      * {@code module} is the caller's module.
1707      * In cases where {@code System.getLogger} is called from a context where
1708      * there is no caller frame on the stack (e.g when called directly
1709      * from a JNI attached thread), {@code IllegalCallerException} is thrown.
1710      * To obtain a logger in such a context, use an auxiliary class that
1711      * will implicitly be identified as the caller, or use the system {@link
1712      * LoggerFinder#getLoggerFinder() LoggerFinder} to obtain a logger instead.
1713      * Note that doing the latter may eagerly initialize the underlying
1714      * logging system.
1715      *
1716      * @apiNote
1717      * This method is intended to be used after the system is fully initialized.
1718      * This method may trigger the immediate loading and initialization
1719      * of the {@link LoggerFinder} service, which may cause issues if the
1720      * Java Runtime is not ready to initialize the concrete service
1721      * implementation yet.
1722      * System classes which may be loaded early in the boot sequence and
1723      * need to log localized messages should create a logger using
1724      * {@link #getLogger(java.lang.String)} and then use the log methods that
1725      * take a resource bundle as parameter.
1726      *
1727      * @param name    the name of the logger.
1728      * @param bundle  a resource bundle.
1729      * @return an instance of {@link Logger} which will use the provided
1730      * resource bundle for message localization.
1731      * @throws NullPointerException if {@code name} is {@code null} or
1732      *         {@code bundle} is {@code null}.
1733      * @throws IllegalCallerException if there is no Java caller frame on the
1734      *         stack.
1735      *
1736      * @since 9
1737      */
1738     @CallerSensitive
1739     public static Logger getLogger(String name, ResourceBundle bundle) {
1740         final ResourceBundle rb = Objects.requireNonNull(bundle);
1741         Objects.requireNonNull(name);
1742         final Class<?> caller = Reflection.getCallerClass();
1743         if (caller == null) {
1744             throw new IllegalCallerException("no caller frame");
1745         }
1746         final SecurityManager sm = System.getSecurityManager();
1747         // We don't use LazyLoggers if a resource bundle is specified.
1748         // Bootstrap sensitive classes in the JDK do not use resource bundles
1749         // when logging. This could be revisited later, if it needs to.
1750         if (sm != null) {
1751             final PrivilegedAction<Logger> pa =
1752                     () -> LoggerFinder.accessProvider()
1753                             .getLocalizedLogger(name, rb, caller.getModule());
1754             return AccessController.doPrivileged(pa, null,
1755                                          LoggerFinder.LOGGERFINDER_PERMISSION);
1756         }
1757         return LoggerFinder.accessProvider()
1758                 .getLocalizedLogger(name, rb, caller.getModule());
1759     }
1760 
1761     /**
1762      * Terminates the currently running Java Virtual Machine. The
1763      * argument serves as a status code; by convention, a nonzero status
1764      * code indicates abnormal termination.
1765      * <p>
1766      * This method calls the {@code exit} method in class
1767      * {@code Runtime}. This method never returns normally.
1768      * <p>
1769      * The call {@code System.exit(n)} is effectively equivalent to
1770      * the call:
1771      * <blockquote><pre>
1772      * Runtime.getRuntime().exit(n)
1773      * </pre></blockquote>
1774      *
1775      * @param      status   exit status.
1776      * @throws  SecurityException
1777      *        if a security manager exists and its {@code checkExit}
1778      *        method doesn't allow exit with the specified status.
1779      * @see        java.lang.Runtime#exit(int)
1780      */
1781     public static void exit(int status) {
1782         Runtime.getRuntime().exit(status);
1783     }
1784 
1785     /**
1786      * Runs the garbage collector in the Java Virtual Machine.
1787      * <p>
1788      * Calling the {@code gc} method suggests that the Java Virtual Machine
1789      * expend effort toward recycling unused objects in order to
1790      * make the memory they currently occupy available for reuse
1791      * by the Java Virtual Machine.
1792      * When control returns from the method call, the Java Virtual Machine
1793      * has made a best effort to reclaim space from all unused objects.
1794      * There is no guarantee that this effort will recycle any particular
1795      * number of unused objects, reclaim any particular amount of space, or
1796      * complete at any particular time, if at all, before the method returns or ever.
1797      * <p>
1798      * The call {@code System.gc()} is effectively equivalent to the
1799      * call:
1800      * <blockquote><pre>
1801      * Runtime.getRuntime().gc()
1802      * </pre></blockquote>
1803      *
1804      * @see     java.lang.Runtime#gc()
1805      */
1806     public static void gc() {
1807         Runtime.getRuntime().gc();
1808     }
1809 
1810     /**
1811      * Runs the finalization methods of any objects pending finalization.
1812      *
1813      * Calling this method suggests that the Java Virtual Machine expend
1814      * effort toward running the {@code finalize} methods of objects
1815      * that have been found to be discarded but whose {@code finalize}
1816      * methods have not yet been run. When control returns from the
1817      * method call, the Java Virtual Machine has made a best effort to
1818      * complete all outstanding finalizations.
1819      * <p>
1820      * The call {@code System.runFinalization()} is effectively
1821      * equivalent to the call:
1822      * <blockquote><pre>
1823      * Runtime.getRuntime().runFinalization()
1824      * </pre></blockquote>
1825      *
1826      * @see     java.lang.Runtime#runFinalization()
1827      */
1828     public static void runFinalization() {
1829         Runtime.getRuntime().runFinalization();
1830     }
1831 
1832     /**
1833      * Loads the native library specified by the filename argument.  The filename
1834      * argument must be an absolute path name.
1835      *
1836      * If the filename argument, when stripped of any platform-specific library
1837      * prefix, path, and file extension, indicates a library whose name is,
1838      * for example, L, and a native library called L is statically linked
1839      * with the VM, then the JNI_OnLoad_L function exported by the library
1840      * is invoked rather than attempting to load a dynamic library.
1841      * A filename matching the argument does not have to exist in the
1842      * file system.
1843      * See the <a href="{@docRoot}/../specs/jni/index.html"> JNI Specification</a>
1844      * for more details.
1845      *
1846      * Otherwise, the filename argument is mapped to a native library image in
1847      * an implementation-dependent manner.
1848      *
1849      * <p>
1850      * The call {@code System.load(name)} is effectively equivalent
1851      * to the call:
1852      * <blockquote><pre>
1853      * Runtime.getRuntime().load(name)
1854      * </pre></blockquote>
1855      *
1856      * @param      filename   the file to load.
1857      * @throws     SecurityException  if a security manager exists and its
1858      *             {@code checkLink} method doesn't allow
1859      *             loading of the specified dynamic library
1860      * @throws     UnsatisfiedLinkError  if either the filename is not an
1861      *             absolute path name, the native library is not statically
1862      *             linked with the VM, or the library cannot be mapped to
1863      *             a native library image by the host system.
1864      * @throws     NullPointerException if {@code filename} is {@code null}
1865      * @see        java.lang.Runtime#load(java.lang.String)
1866      * @see        java.lang.SecurityManager#checkLink(java.lang.String)
1867      */
1868     @CallerSensitive
1869     public static void load(String filename) {
1870         Runtime.getRuntime().load0(Reflection.getCallerClass(), filename);
1871     }
1872 
1873     /**
1874      * Loads the native library specified by the {@code libname}
1875      * argument.  The {@code libname} argument must not contain any platform
1876      * specific prefix, file extension or path. If a native library
1877      * called {@code libname} is statically linked with the VM, then the
1878      * JNI_OnLoad_{@code libname} function exported by the library is invoked.
1879      * See the <a href="{@docRoot}/../specs/jni/index.html"> JNI Specification</a>
1880      * for more details.
1881      *
1882      * Otherwise, the libname argument is loaded from a system library
1883      * location and mapped to a native library image in an implementation-
1884      * dependent manner.
1885      * <p>
1886      * The call {@code System.loadLibrary(name)} is effectively
1887      * equivalent to the call
1888      * <blockquote><pre>
1889      * Runtime.getRuntime().loadLibrary(name)
1890      * </pre></blockquote>
1891      *
1892      * @param      libname   the name of the library.
1893      * @throws     SecurityException  if a security manager exists and its
1894      *             {@code checkLink} method doesn't allow
1895      *             loading of the specified dynamic library
1896      * @throws     UnsatisfiedLinkError if either the libname argument
1897      *             contains a file path, the native library is not statically
1898      *             linked with the VM,  or the library cannot be mapped to a
1899      *             native library image by the host system.
1900      * @throws     NullPointerException if {@code libname} is {@code null}
1901      * @see        java.lang.Runtime#loadLibrary(java.lang.String)
1902      * @see        java.lang.SecurityManager#checkLink(java.lang.String)
1903      */
1904     @CallerSensitive
1905     public static void loadLibrary(String libname) {
1906         Runtime.getRuntime().loadLibrary0(Reflection.getCallerClass(), libname);
1907     }
1908 
1909     /**
1910      * Maps a library name into a platform-specific string representing
1911      * a native library.
1912      *
1913      * @param      libname the name of the library.
1914      * @return     a platform-dependent native library name.
1915      * @throws     NullPointerException if {@code libname} is {@code null}
1916      * @see        java.lang.System#loadLibrary(java.lang.String)
1917      * @see        java.lang.ClassLoader#findLibrary(java.lang.String)
1918      * @since      1.2
1919      */
1920     public static native String mapLibraryName(String libname);
1921 
1922     /**
1923      * Create PrintStream for stdout/err based on encoding.
1924      */
1925     private static PrintStream newPrintStream(FileOutputStream fos, String enc) {
1926        if (enc != null) {
1927             try {
1928                 return new PrintStream(new BufferedOutputStream(fos, 128), true, enc);
1929             } catch (UnsupportedEncodingException uee) {}
1930         }
1931         return new PrintStream(new BufferedOutputStream(fos, 128), true);
1932     }
1933 
1934     /**
1935      * Logs an exception/error at initialization time to stdout or stderr.
1936      *
1937      * @param printToStderr to print to stderr rather than stdout
1938      * @param printStackTrace to print the stack trace
1939      * @param msg the message to print before the exception, can be {@code null}
1940      * @param e the exception or error
1941      */
1942     private static void logInitException(boolean printToStderr,
1943                                          boolean printStackTrace,
1944                                          String msg,
1945                                          Throwable e) {
1946         if (VM.initLevel() < 1) {
1947             throw new InternalError("system classes not initialized");
1948         }
1949         PrintStream log = (printToStderr) ? err : out;
1950         if (msg != null) {
1951             log.println(msg);
1952         }
1953         if (printStackTrace) {
1954             e.printStackTrace(log);
1955         } else {
1956             log.println(e);
1957             for (Throwable suppressed : e.getSuppressed()) {
1958                 log.println("Suppressed: " + suppressed);
1959             }
1960             Throwable cause = e.getCause();
1961             if (cause != null) {
1962                 log.println("Caused by: " + cause);
1963             }
1964         }
1965     }
1966 
1967     /**
1968      * Create the Properties object from a map - masking out system properties
1969      * that are not intended for public access.
1970      */
1971     private static Properties createProperties(Map<String, String> initialProps) {
1972         Properties properties = new Properties(initialProps.size());
1973         for (var entry : initialProps.entrySet()) {
1974             String prop = entry.getKey();
1975             switch (prop) {
1976                 // Do not add private system properties to the Properties
1977                 case "sun.nio.MaxDirectMemorySize":
1978                 case "sun.nio.PageAlignDirectMemory":
1979                     // used by java.lang.Integer.IntegerCache
1980                 case "java.lang.Integer.IntegerCache.high":
1981                     // used by sun.launcher.LauncherHelper
1982                 case "sun.java.launcher.diag":
1983                     // used by jdk.internal.loader.ClassLoaders
1984                 case "jdk.boot.class.path.append":
1985                     break;
1986                 default:
1987                     properties.put(prop, entry.getValue());
1988             }
1989         }
1990         return properties;
1991     }
1992 
1993     /**
1994      * Initialize the system class.  Called after thread initialization.
1995      */
1996     private static void initPhase1() {
1997         // VM might invoke JNU_NewStringPlatform() to set those encoding
1998         // sensitive properties (user.home, user.name, boot.class.path, etc.)
1999         // during "props" initialization.
2000         // The charset is initialized in System.c and does not depend on the Properties.
2001         Map<String, String> tempProps = SystemProps.initProperties();
2002         VersionProps.init(tempProps);
2003 
2004         // There are certain system configurations that may be controlled by
2005         // VM options such as the maximum amount of direct memory and
2006         // Integer cache size used to support the object identity semantics
2007         // of autoboxing.  Typically, the library will obtain these values
2008         // from the properties set by the VM.  If the properties are for
2009         // internal implementation use only, these properties should be
2010         // masked from the system properties.
2011         //
2012         // Save a private copy of the system properties object that
2013         // can only be accessed by the internal implementation.
2014         VM.saveProperties(tempProps);
2015         props = createProperties(tempProps);
2016 
2017         StaticProperty.javaHome();          // Load StaticProperty to cache the property values
2018 
2019         lineSeparator = props.getProperty("line.separator");
2020 
2021         FileInputStream fdIn = new FileInputStream(FileDescriptor.in);
2022         FileOutputStream fdOut = new FileOutputStream(FileDescriptor.out);
2023         FileOutputStream fdErr = new FileOutputStream(FileDescriptor.err);
2024         setIn0(new BufferedInputStream(fdIn));
2025         setOut0(newPrintStream(fdOut, props.getProperty("sun.stdout.encoding")));
2026         setErr0(newPrintStream(fdErr, props.getProperty("sun.stderr.encoding")));
2027 
2028         // Setup Java signal handlers for HUP, TERM, and INT (where available).
2029         Terminator.setup();
2030 
2031         // Initialize any miscellaneous operating system settings that need to be
2032         // set for the class libraries. Currently this is no-op everywhere except
2033         // for Windows where the process-wide error mode is set before the java.io
2034         // classes are used.
2035         VM.initializeOSEnvironment();
2036 
2037         // The main thread is not added to its thread group in the same
2038         // way as other threads; we must do it ourselves here.
2039         Thread current = Thread.currentThread();
2040         current.getThreadGroup().add(current);
2041 
2042         // register shared secrets
2043         setJavaLangAccess();
2044 
2045         // Subsystems that are invoked during initialization can invoke
2046         // VM.isBooted() in order to avoid doing things that should
2047         // wait until the VM is fully initialized. The initialization level
2048         // is incremented from 0 to 1 here to indicate the first phase of
2049         // initialization has completed.
2050         // IMPORTANT: Ensure that this remains the last initialization action!
2051         VM.initLevel(1);
2052     }
2053 
2054     // @see #initPhase2()
2055     static ModuleLayer bootLayer;
2056 
2057     /*
2058      * Invoked by VM.  Phase 2 module system initialization.
2059      * Only classes in java.base can be loaded in this phase.
2060      *
2061      * @param printToStderr print exceptions to stderr rather than stdout
2062      * @param printStackTrace print stack trace when exception occurs
2063      *
2064      * @return JNI_OK for success, JNI_ERR for failure
2065      */
2066     private static int initPhase2(boolean printToStderr, boolean printStackTrace) {
2067         try {
2068             bootLayer = ModuleBootstrap.boot();
2069         } catch (Exception | Error e) {
2070             logInitException(printToStderr, printStackTrace,
2071                              "Error occurred during initialization of boot layer", e);
2072             return -1; // JNI_ERR
2073         }
2074 
2075         // module system initialized
2076         VM.initLevel(2);
2077 
2078         return 0; // JNI_OK
2079     }
2080 
2081     /*
2082      * Invoked by VM.  Phase 3 is the final system initialization:
2083      * 1. set security manager
2084      * 2. set system class loader
2085      * 3. set TCCL
2086      *
2087      * This method must be called after the module system initialization.
2088      * The security manager and system class loader may be a custom class from
2089      * the application classpath or modulepath.
2090      */
2091     private static void initPhase3() {
2092         String smProp = System.getProperty("java.security.manager");
2093         if (smProp != null) {
2094             switch (smProp) {
2095                 case "disallow":
2096                     allowSecurityManager = NEVER;
2097                     break;
2098                 case "allow":
2099                     allowSecurityManager = MAYBE;
2100                     break;
2101                 case "":
2102                 case "default":
2103                     setSecurityManager(new SecurityManager());
2104                     allowSecurityManager = MAYBE;
2105                     break;
2106                 default:
2107                     try {
2108                         ClassLoader cl = ClassLoader.getBuiltinAppClassLoader();
2109                         Class<?> c = Class.forName(smProp, false, cl);
2110                         Constructor<?> ctor = c.getConstructor();
2111                         // Must be a public subclass of SecurityManager with
2112                         // a public no-arg constructor
2113                         if (!SecurityManager.class.isAssignableFrom(c) ||
2114                             !Modifier.isPublic(c.getModifiers()) ||
2115                             !Modifier.isPublic(ctor.getModifiers())) {
2116                             throw new Error("Could not create SecurityManager: "
2117                                              + ctor.toString());
2118                         }
2119                         // custom security manager may be in non-exported package
2120                         ctor.setAccessible(true);
2121                         SecurityManager sm = (SecurityManager) ctor.newInstance();
2122                         setSecurityManager(sm);
2123                     } catch (Exception e) {
2124                         throw new InternalError("Could not create SecurityManager", e);
2125                     }
2126                     allowSecurityManager = MAYBE;
2127             }
2128         } else {
2129             allowSecurityManager = MAYBE;
2130         }
2131 
2132         // initializing the system class loader
2133         VM.initLevel(3);
2134 
2135         // system class loader initialized
2136         ClassLoader scl = ClassLoader.initSystemClassLoader();
2137 
2138         // set TCCL
2139         Thread.currentThread().setContextClassLoader(scl);
2140 
2141         // system is fully initialized
2142         VM.initLevel(4);
2143     }
2144 
2145     private static void setJavaLangAccess() {
2146         // Allow privileged classes outside of java.lang
2147         SharedSecrets.setJavaLangAccess(new JavaLangAccess() {
2148             public List<Method> getDeclaredPublicMethods(Class<?> klass, String name, Class<?>... parameterTypes) {
2149                 return klass.getDeclaredPublicMethods(name, parameterTypes);
2150             }
2151             public jdk.internal.reflect.ConstantPool getConstantPool(Class<?> klass) {
2152                 return klass.getConstantPool();
2153             }
2154             public boolean casAnnotationType(Class<?> klass, AnnotationType oldType, AnnotationType newType) {
2155                 return klass.casAnnotationType(oldType, newType);
2156             }
2157             public AnnotationType getAnnotationType(Class<?> klass) {
2158                 return klass.getAnnotationType();
2159             }
2160             public Map<Class<? extends Annotation>, Annotation> getDeclaredAnnotationMap(Class<?> klass) {
2161                 return klass.getDeclaredAnnotationMap();
2162             }
2163             public byte[] getRawClassAnnotations(Class<?> klass) {
2164                 return klass.getRawAnnotations();
2165             }
2166             public byte[] getRawClassTypeAnnotations(Class<?> klass) {
2167                 return klass.getRawTypeAnnotations();
2168             }
2169             public byte[] getRawExecutableTypeAnnotations(Executable executable) {
2170                 return Class.getExecutableTypeAnnotationBytes(executable);
2171             }
2172             public <E extends Enum<E>>
2173             E[] getEnumConstantsShared(Class<E> klass) {
2174                 return klass.getEnumConstantsShared();
2175             }
2176             public void blockedOn(Interruptible b) {
2177                 Thread.blockedOn(b);
2178             }
2179             public void registerShutdownHook(int slot, boolean registerShutdownInProgress, Runnable hook) {
2180                 Shutdown.add(slot, registerShutdownInProgress, hook);
2181             }
2182             public Thread newThreadWithAcc(Runnable target, AccessControlContext acc) {
2183                 return new Thread(target, acc);
2184             }
2185             @SuppressWarnings("deprecation")
2186             public void invokeFinalize(Object o) throws Throwable {
2187                 o.finalize();
2188             }
2189             public ConcurrentHashMap<?, ?> createOrGetClassLoaderValueMap(ClassLoader cl) {
2190                 return cl.createOrGetClassLoaderValueMap();
2191             }
2192             public Class<?> defineClass(ClassLoader loader, String name, byte[] b, ProtectionDomain pd, String source) {
2193                 return ClassLoader.defineClass1(loader, name, b, 0, b.length, pd, source);
2194             }
2195             public Class<?> findBootstrapClassOrNull(ClassLoader cl, String name) {
2196                 return cl.findBootstrapClassOrNull(name);
2197             }
2198             public Package definePackage(ClassLoader cl, String name, Module module) {
2199                 return cl.definePackage(name, module);
2200             }
2201             public String fastUUID(long lsb, long msb) {
2202                 return Long.fastUUID(lsb, msb);
2203             }
2204             public void addNonExportedPackages(ModuleLayer layer) {
2205                 SecurityManager.addNonExportedPackages(layer);
2206             }
2207             public void invalidatePackageAccessCache() {
2208                 SecurityManager.invalidatePackageAccessCache();
2209             }
2210             public Module defineModule(ClassLoader loader,
2211                                        ModuleDescriptor descriptor,
2212                                        URI uri) {
2213                 return new Module(null, loader, descriptor, uri);
2214             }
2215             public Module defineUnnamedModule(ClassLoader loader) {
2216                 return new Module(loader);
2217             }
2218             public void addReads(Module m1, Module m2) {
2219                 m1.implAddReads(m2);
2220             }
2221             public void addReadsAllUnnamed(Module m) {
2222                 m.implAddReadsAllUnnamed();
2223             }
2224             public void addExports(Module m, String pn, Module other) {
2225                 m.implAddExports(pn, other);
2226             }
2227             public void addExportsToAllUnnamed(Module m, String pn) {
2228                 m.implAddExportsToAllUnnamed(pn);
2229             }
2230             public void addOpens(Module m, String pn, Module other) {
2231                 m.implAddOpens(pn, other);
2232             }
2233             public void addOpensToAllUnnamed(Module m, String pn) {
2234                 m.implAddOpensToAllUnnamed(pn);
2235             }
2236             public void addOpensToAllUnnamed(Module m, Iterator<String> packages) {
2237                 m.implAddOpensToAllUnnamed(packages);
2238             }
2239             public void addUses(Module m, Class<?> service) {
2240                 m.implAddUses(service);
2241             }
2242             public boolean isReflectivelyExported(Module m, String pn, Module other) {
2243                 return m.isReflectivelyExported(pn, other);
2244             }
2245             public boolean isReflectivelyOpened(Module m, String pn, Module other) {
2246                 return m.isReflectivelyOpened(pn, other);
2247             }
2248             public ServicesCatalog getServicesCatalog(ModuleLayer layer) {
2249                 return layer.getServicesCatalog();
2250             }
2251             public Stream<ModuleLayer> layers(ModuleLayer layer) {
2252                 return layer.layers();
2253             }
2254             public Stream<ModuleLayer> layers(ClassLoader loader) {
2255                 return ModuleLayer.layers(loader);
2256             }
2257 
2258             public String newStringNoRepl(byte[] bytes, Charset cs) throws CharacterCodingException  {
2259                 return StringCoding.newStringNoRepl(bytes, cs);
2260             }
2261 
2262             public byte[] getBytesNoRepl(String s, Charset cs) throws CharacterCodingException {
2263                 return StringCoding.getBytesNoRepl(s, cs);
2264             }
2265 
2266             public String newStringUTF8NoRepl(byte[] bytes, int off, int len) {
2267                 return StringCoding.newStringUTF8NoRepl(bytes, off, len);
2268             }
2269 
2270             public byte[] getBytesUTF8NoRepl(String s) {
2271                 return StringCoding.getBytesUTF8NoRepl(s);
2272             }
2273 
2274             public void setCause(Throwable t, Throwable cause) {
2275                 t.setCause(cause);
2276             }
2277 
2278             public void loadLibrary(Class<?> klass, String library) {
2279                 assert library.indexOf(java.io.File.separatorChar) < 0;
2280                 ClassLoader.loadLibrary(klass, library, false);
2281             }
2282         });
2283     }
2284 }