rt/emul/compact/src/main/java/java/util/logging/Logger.java
author Jaroslav Tulach <jaroslav.tulach@apidesign.org>
Sat, 07 Sep 2013 13:56:22 +0200
changeset 1260 fe3567c7b522
parent 1259 d257b7a37635
child 1277 853245102164
permissions -rw-r--r--
Re-implementation of the JDK APIs to fit into the browser
     1 /*
     2  * Copyright (c) 2000, 2011, 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 
    26 
    27 package java.util.logging;
    28 
    29 import java.util.HashMap;
    30 import java.util.Map;
    31 import org.apidesign.bck2brwsr.core.JavaScriptBody;
    32 
    33 /**
    34  * A Logger object is used to log messages for a specific
    35  * system or application component.  Loggers are normally named,
    36  * using a hierarchical dot-separated namespace.  Logger names
    37  * can be arbitrary strings, but they should normally be based on
    38  * the package name or class name of the logged component, such
    39  * as java.net or javax.swing.  In addition it is possible to create
    40  * "anonymous" Loggers that are not stored in the Logger namespace.
    41  * <p>
    42  * Logger objects may be obtained by calls on one of the getLogger
    43  * factory methods.  These will either create a new Logger or
    44  * return a suitable existing Logger. It is important to note that
    45  * the Logger returned by one of the {@code getLogger} factory methods
    46  * may be garbage collected at any time if a strong reference to the
    47  * Logger is not kept.
    48  * <p>
    49  * Logging messages will be forwarded to registered Handler
    50  * objects, which can forward the messages to a variety of
    51  * destinations, including consoles, files, OS logs, etc.
    52  * <p>
    53  * Each Logger keeps track of a "parent" Logger, which is its
    54  * nearest existing ancestor in the Logger namespace.
    55  * <p>
    56  * Each Logger has a "Level" associated with it.  This reflects
    57  * a minimum Level that this logger cares about.  If a Logger's
    58  * level is set to <tt>null</tt>, then its effective level is inherited
    59  * from its parent, which may in turn obtain it recursively from its
    60  * parent, and so on up the tree.
    61  * <p>
    62  * The log level can be configured based on the properties from the
    63  * logging configuration file, as described in the description
    64  * of the LogManager class.  However it may also be dynamically changed
    65  * by calls on the Logger.setLevel method.  If a logger's level is
    66  * changed the change may also affect child loggers, since any child
    67  * logger that has <tt>null</tt> as its level will inherit its
    68  * effective level from its parent.
    69  * <p>
    70  * On each logging call the Logger initially performs a cheap
    71  * check of the request level (e.g., SEVERE or FINE) against the
    72  * effective log level of the logger.  If the request level is
    73  * lower than the log level, the logging call returns immediately.
    74  * <p>
    75  * After passing this initial (cheap) test, the Logger will allocate
    76  * a LogRecord to describe the logging message.  It will then call a
    77  * Filter (if present) to do a more detailed check on whether the
    78  * record should be published.  If that passes it will then publish
    79  * the LogRecord to its output Handlers.  By default, loggers also
    80  * publish to their parent's Handlers, recursively up the tree.
    81  * <p>
    82  * Each Logger may have a ResourceBundle name associated with it.
    83  * The named bundle will be used for localizing logging messages.
    84  * If a Logger does not have its own ResourceBundle name, then
    85  * it will inherit the ResourceBundle name from its parent,
    86  * recursively up the tree.
    87  * <p>
    88  * Most of the logger output methods take a "msg" argument.  This
    89  * msg argument may be either a raw value or a localization key.
    90  * During formatting, if the logger has (or inherits) a localization
    91  * ResourceBundle and if the ResourceBundle has a mapping for the msg
    92  * string, then the msg string is replaced by the localized value.
    93  * Otherwise the original msg string is used.  Typically, formatters use
    94  * java.text.MessageFormat style formatting to format parameters, so
    95  * for example a format string "{0} {1}" would format two parameters
    96  * as strings.
    97  * <p>
    98  * When mapping ResourceBundle names to ResourceBundles, the Logger
    99  * will first try to use the Thread's ContextClassLoader.  If that
   100  * is null it will try the SystemClassLoader instead.  As a temporary
   101  * transition feature in the initial implementation, if the Logger is
   102  * unable to locate a ResourceBundle from the ContextClassLoader or
   103  * SystemClassLoader the Logger will also search up the class stack
   104  * and use successive calling ClassLoaders to try to locate a ResourceBundle.
   105  * (This call stack search is to allow containers to transition to
   106  * using ContextClassLoaders and is likely to be removed in future
   107  * versions.)
   108  * <p>
   109  * Formatting (including localization) is the responsibility of
   110  * the output Handler, which will typically call a Formatter.
   111  * <p>
   112  * Note that formatting need not occur synchronously.  It may be delayed
   113  * until a LogRecord is actually written to an external sink.
   114  * <p>
   115  * The logging methods are grouped in five main categories:
   116  * <ul>
   117  * <li><p>
   118  *     There are a set of "log" methods that take a log level, a message
   119  *     string, and optionally some parameters to the message string.
   120  * <li><p>
   121  *     There are a set of "logp" methods (for "log precise") that are
   122  *     like the "log" methods, but also take an explicit source class name
   123  *     and method name.
   124  * <li><p>
   125  *     There are a set of "logrb" method (for "log with resource bundle")
   126  *     that are like the "logp" method, but also take an explicit resource
   127  *     bundle name for use in localizing the log message.
   128  * <li><p>
   129  *     There are convenience methods for tracing method entries (the
   130  *     "entering" methods), method returns (the "exiting" methods) and
   131  *     throwing exceptions (the "throwing" methods).
   132  * <li><p>
   133  *     Finally, there are a set of convenience methods for use in the
   134  *     very simplest cases, when a developer simply wants to log a
   135  *     simple string at a given log level.  These methods are named
   136  *     after the standard Level names ("severe", "warning", "info", etc.)
   137  *     and take a single argument, a message string.
   138  * </ul>
   139  * <p>
   140  * For the methods that do not take an explicit source name and
   141  * method name, the Logging framework will make a "best effort"
   142  * to determine which class and method called into the logging method.
   143  * However, it is important to realize that this automatically inferred
   144  * information may only be approximate (or may even be quite wrong!).
   145  * Virtual machines are allowed to do extensive optimizations when
   146  * JITing and may entirely remove stack frames, making it impossible
   147  * to reliably locate the calling class and method.
   148  * <P>
   149  * All methods on Logger are multi-thread safe.
   150  * <p>
   151  * <b>Subclassing Information:</b> Note that a LogManager class may
   152  * provide its own implementation of named Loggers for any point in
   153  * the namespace.  Therefore, any subclasses of Logger (unless they
   154  * are implemented in conjunction with a new LogManager class) should
   155  * take care to obtain a Logger instance from the LogManager class and
   156  * should delegate operations such as "isLoggable" and "log(LogRecord)"
   157  * to that instance.  Note that in order to intercept all logging
   158  * output, subclasses need only override the log(LogRecord) method.
   159  * All the other logging methods are implemented as calls on this
   160  * log(LogRecord) method.
   161  *
   162  * @since 1.4
   163  */
   164 
   165 
   166 public class Logger {
   167     private static int offValue = Level.OFF.intValue();
   168     private static final Map<String,Logger> ALL = new HashMap<>();
   169     private String name;
   170 
   171     private volatile int levelValue;  // current effective level value
   172     private Level levelObject;
   173     
   174     /**
   175      * GLOBAL_LOGGER_NAME is a name for the global logger.
   176      *
   177      * @since 1.6
   178      */
   179     public static final String GLOBAL_LOGGER_NAME = "global";
   180 
   181     /**
   182      * Return global logger object with the name Logger.GLOBAL_LOGGER_NAME.
   183      *
   184      * @return global logger object
   185      * @since 1.7
   186      */
   187     public static final Logger getGlobal() {
   188         return global;
   189     }
   190 
   191     /**
   192      * The "global" Logger object is provided as a convenience to developers
   193      * who are making casual use of the Logging package.  Developers
   194      * who are making serious use of the logging package (for example
   195      * in products) should create and use their own Logger objects,
   196      * with appropriate names, so that logging can be controlled on a
   197      * suitable per-Logger granularity. Developers also need to keep a
   198      * strong reference to their Logger objects to prevent them from
   199      * being garbage collected.
   200      * <p>
   201      * @deprecated Initialization of this field is prone to deadlocks.
   202      * The field must be initialized by the Logger class initialization
   203      * which may cause deadlocks with the LogManager class initialization.
   204      * In such cases two class initialization wait for each other to complete.
   205      * The preferred way to get the global logger object is via the call
   206      * <code>Logger.getGlobal()</code>.
   207      * For compatibility with old JDK versions where the
   208      * <code>Logger.getGlobal()</code> is not available use the call
   209      * <code>Logger.getLogger(Logger.GLOBAL_LOGGER_NAME)</code>
   210      * or <code>Logger.getLogger("global")</code>.
   211      */
   212     @Deprecated
   213     public static final Logger global = new Logger(GLOBAL_LOGGER_NAME);
   214 
   215     /**
   216      * Protected method to construct a logger for a named subsystem.
   217      * <p>
   218      * The logger will be initially configured with a null Level
   219      * and with useParentHandlers set to true.
   220      *
   221      * @param   name    A name for the logger.  This should
   222      *                          be a dot-separated name and should normally
   223      *                          be based on the package name or class name
   224      *                          of the subsystem, such as java.net
   225      *                          or javax.swing.  It may be null for anonymous Loggers.
   226      * @param   resourceBundleName  name of ResourceBundle to be used for localizing
   227      *                          messages for this logger.  May be null if none
   228      *                          of the messages require localization.
   229      * @throws MissingResourceException if the resourceBundleName is non-null and
   230      *             no corresponding resource can be found.
   231      */
   232     protected Logger(String name, String resourceBundleName) {
   233         this.name = name;
   234         levelValue = Level.INFO.intValue();
   235     }
   236 
   237     // This constructor is used only to create the global Logger.
   238     // It is needed to break a cyclic dependence between the LogManager
   239     // and Logger static initializers causing deadlocks.
   240     private Logger(String name) {
   241         // The manager field is not initialized here.
   242         this.name = name;
   243         levelValue = Level.INFO.intValue();
   244     }
   245 
   246     private void checkAccess() throws SecurityException {
   247         throw new SecurityException();
   248     }
   249 
   250     /**
   251      * Find or create a logger for a named subsystem.  If a logger has
   252      * already been created with the given name it is returned.  Otherwise
   253      * a new logger is created.
   254      * <p>
   255      * If a new logger is created its log level will be configured
   256      * based on the LogManager configuration and it will configured
   257      * to also send logging output to its parent's Handlers.  It will
   258      * be registered in the LogManager global namespace.
   259      * <p>
   260      * Note: The LogManager may only retain a weak reference to the newly
   261      * created Logger. It is important to understand that a previously
   262      * created Logger with the given name may be garbage collected at any
   263      * time if there is no strong reference to the Logger. In particular,
   264      * this means that two back-to-back calls like
   265      * {@code getLogger("MyLogger").log(...)} may use different Logger
   266      * objects named "MyLogger" if there is no strong reference to the
   267      * Logger named "MyLogger" elsewhere in the program.
   268      *
   269      * @param   name            A name for the logger.  This should
   270      *                          be a dot-separated name and should normally
   271      *                          be based on the package name or class name
   272      *                          of the subsystem, such as java.net
   273      *                          or javax.swing
   274      * @return a suitable Logger
   275      * @throws NullPointerException if the name is null.
   276      */
   277 
   278     // Synchronization is not required here. All synchronization for
   279     // adding a new Logger object is handled by LogManager.addLogger().
   280     public static Logger getLogger(String name) {
   281         return getLogger(name, null);
   282     }
   283 
   284     /**
   285      * Find or create a logger for a named subsystem.  If a logger has
   286      * already been created with the given name it is returned.  Otherwise
   287      * a new logger is created.
   288      * <p>
   289      * If a new logger is created its log level will be configured
   290      * based on the LogManager and it will configured to also send logging
   291      * output to its parent's Handlers.  It will be registered in
   292      * the LogManager global namespace.
   293      * <p>
   294      * Note: The LogManager may only retain a weak reference to the newly
   295      * created Logger. It is important to understand that a previously
   296      * created Logger with the given name may be garbage collected at any
   297      * time if there is no strong reference to the Logger. In particular,
   298      * this means that two back-to-back calls like
   299      * {@code getLogger("MyLogger", ...).log(...)} may use different Logger
   300      * objects named "MyLogger" if there is no strong reference to the
   301      * Logger named "MyLogger" elsewhere in the program.
   302      * <p>
   303      * If the named Logger already exists and does not yet have a
   304      * localization resource bundle then the given resource bundle
   305      * name is used.  If the named Logger already exists and has
   306      * a different resource bundle name then an IllegalArgumentException
   307      * is thrown.
   308      * <p>
   309      * @param   name    A name for the logger.  This should
   310      *                          be a dot-separated name and should normally
   311      *                          be based on the package name or class name
   312      *                          of the subsystem, such as java.net
   313      *                          or javax.swing
   314      * @param   resourceBundleName  name of ResourceBundle to be used for localizing
   315      *                          messages for this logger. May be <CODE>null</CODE> if none of
   316      *                          the messages require localization.
   317      * @return a suitable Logger
   318      * @throws MissingResourceException if the resourceBundleName is non-null and
   319      *             no corresponding resource can be found.
   320      * @throws IllegalArgumentException if the Logger already exists and uses
   321      *             a different resource bundle name.
   322      * @throws NullPointerException if the name is null.
   323      */
   324 
   325     // Synchronization is not required here. All synchronization for
   326     // adding a new Logger object is handled by LogManager.addLogger().
   327     public static Logger getLogger(String name, String resourceBundleName) {
   328         Logger l = ALL.get(name);
   329         if (l == null) {
   330             l = new Logger(name, resourceBundleName);
   331             ALL.put(name, l);
   332         }
   333         return l;
   334     }
   335 
   336 
   337     /**
   338      * Create an anonymous Logger.  The newly created Logger is not
   339      * registered in the LogManager namespace.  There will be no
   340      * access checks on updates to the logger.
   341      * <p>
   342      * This factory method is primarily intended for use from applets.
   343      * Because the resulting Logger is anonymous it can be kept private
   344      * by the creating class.  This removes the need for normal security
   345      * checks, which in turn allows untrusted applet code to update
   346      * the control state of the Logger.  For example an applet can do
   347      * a setLevel or an addHandler on an anonymous Logger.
   348      * <p>
   349      * Even although the new logger is anonymous, it is configured
   350      * to have the root logger ("") as its parent.  This means that
   351      * by default it inherits its effective level and handlers
   352      * from the root logger.
   353      * <p>
   354      *
   355      * @return a newly created private Logger
   356      */
   357     public static Logger getAnonymousLogger() {
   358         return getAnonymousLogger(null);
   359     }
   360 
   361     /**
   362      * Create an anonymous Logger.  The newly created Logger is not
   363      * registered in the LogManager namespace.  There will be no
   364      * access checks on updates to the logger.
   365      * <p>
   366      * This factory method is primarily intended for use from applets.
   367      * Because the resulting Logger is anonymous it can be kept private
   368      * by the creating class.  This removes the need for normal security
   369      * checks, which in turn allows untrusted applet code to update
   370      * the control state of the Logger.  For example an applet can do
   371      * a setLevel or an addHandler on an anonymous Logger.
   372      * <p>
   373      * Even although the new logger is anonymous, it is configured
   374      * to have the root logger ("") as its parent.  This means that
   375      * by default it inherits its effective level and handlers
   376      * from the root logger.
   377      * <p>
   378      * @param   resourceBundleName  name of ResourceBundle to be used for localizing
   379      *                          messages for this logger.
   380      *          May be null if none of the messages require localization.
   381      * @return a newly created private Logger
   382      * @throws MissingResourceException if the resourceBundleName is non-null and
   383      *             no corresponding resource can be found.
   384      */
   385 
   386     // Synchronization is not required here. All synchronization for
   387     // adding a new anonymous Logger object is handled by doSetParent().
   388     public static Logger getAnonymousLogger(String resourceBundleName) {
   389         return new Logger(null, resourceBundleName);
   390     }
   391 
   392     /**
   393      * Retrieve the localization resource bundle for this
   394      * logger for the current default locale.  Note that if
   395      * the result is null, then the Logger will use a resource
   396      * bundle inherited from its parent.
   397      *
   398      * @return localization bundle (may be null)
   399      */
   400 //    public ResourceBundle getResourceBundle() {
   401 //        return findResourceBundle(getResourceBundleName());
   402 //    }
   403 
   404     /**
   405      * Retrieve the localization resource bundle name for this
   406      * logger.  Note that if the result is null, then the Logger
   407      * will use a resource bundle name inherited from its parent.
   408      *
   409      * @return localization bundle name (may be null)
   410      */
   411     public String getResourceBundleName() {
   412         return null;
   413     }
   414 
   415     /**
   416      * Set a filter to control output on this Logger.
   417      * <P>
   418      * After passing the initial "level" check, the Logger will
   419      * call this Filter to check if a log record should really
   420      * be published.
   421      *
   422      * @param   newFilter  a filter object (may be null)
   423      * @exception  SecurityException  if a security manager exists and if
   424      *             the caller does not have LoggingPermission("control").
   425      */
   426 //    public void setFilter(Filter newFilter) throws SecurityException {
   427 //        checkAccess();
   428 //    }
   429 
   430     /**
   431      * Get the current filter for this Logger.
   432      *
   433      * @return  a filter object (may be null)
   434      */
   435 //    public Filter getFilter() {
   436 //        return filter;
   437 //    }
   438 
   439     /**
   440      * Log a LogRecord.
   441      * <p>
   442      * All the other logging methods in this class call through
   443      * this method to actually perform any logging.  Subclasses can
   444      * override this single method to capture all log activity.
   445      *
   446      * @param record the LogRecord to be published
   447      */
   448     public void log(LogRecord record) {
   449         if (record.getLevel().intValue() < levelValue) {
   450             return;
   451         }
   452 
   453         consoleLog(
   454             record.getLevel().toString(), 
   455             record.getLoggerName(),
   456             record.getMessage()
   457         );
   458     }
   459     
   460     @JavaScriptBody(args = { "method", "logger", "msg" }, body = 
   461         "window.console[method]('[' + logger + ']: ' + msg);"
   462     )
   463     private static native void consoleLog(
   464         String method, String logger, String msg
   465     );
   466 
   467     // private support method for logging.
   468     // We fill in the logger name, resource bundle name, and
   469     // resource bundle and then call "void log(LogRecord)".
   470     private void doLog(LogRecord lr) {
   471         doLog(lr, lr.getResourceBundleName());
   472     }
   473     private void doLog(LogRecord lr, String bundleName) {
   474         lr.setLoggerName(name);
   475         log(lr);
   476     }
   477 
   478 
   479     //================================================================
   480     // Start of convenience methods WITHOUT className and methodName
   481     //================================================================
   482 
   483     /**
   484      * Log a message, with no arguments.
   485      * <p>
   486      * If the logger is currently enabled for the given message
   487      * level then the given message is forwarded to all the
   488      * registered output Handler objects.
   489      * <p>
   490      * @param   level   One of the message level identifiers, e.g., SEVERE
   491      * @param   msg     The string message (or a key in the message catalog)
   492      */
   493     public void log(Level level, String msg) {
   494         if (level.intValue() < levelValue || levelValue == offValue) {
   495             return;
   496         }
   497         LogRecord lr = new LogRecord(level, msg);
   498         doLog(lr);
   499     }
   500 
   501     /**
   502      * Log a message, with one object parameter.
   503      * <p>
   504      * If the logger is currently enabled for the given message
   505      * level then a corresponding LogRecord is created and forwarded
   506      * to all the registered output Handler objects.
   507      * <p>
   508      * @param   level   One of the message level identifiers, e.g., SEVERE
   509      * @param   msg     The string message (or a key in the message catalog)
   510      * @param   param1  parameter to the message
   511      */
   512     public void log(Level level, String msg, Object param1) {
   513         if (level.intValue() < levelValue || levelValue == offValue) {
   514             return;
   515         }
   516         LogRecord lr = new LogRecord(level, msg);
   517         Object params[] = { param1 };
   518         lr.setParameters(params);
   519         doLog(lr);
   520     }
   521 
   522     /**
   523      * Log a message, with an array of object arguments.
   524      * <p>
   525      * If the logger is currently enabled for the given message
   526      * level then a corresponding LogRecord is created and forwarded
   527      * to all the registered output Handler objects.
   528      * <p>
   529      * @param   level   One of the message level identifiers, e.g., SEVERE
   530      * @param   msg     The string message (or a key in the message catalog)
   531      * @param   params  array of parameters to the message
   532      */
   533     public void log(Level level, String msg, Object params[]) {
   534         if (level.intValue() < levelValue || levelValue == offValue) {
   535             return;
   536         }
   537         LogRecord lr = new LogRecord(level, msg);
   538         lr.setParameters(params);
   539         doLog(lr);
   540     }
   541 
   542     /**
   543      * Log a message, with associated Throwable information.
   544      * <p>
   545      * If the logger is currently enabled for the given message
   546      * level then the given arguments are stored in a LogRecord
   547      * which is forwarded to all registered output handlers.
   548      * <p>
   549      * Note that the thrown argument is stored in the LogRecord thrown
   550      * property, rather than the LogRecord parameters property.  Thus is it
   551      * processed specially by output Formatters and is not treated
   552      * as a formatting parameter to the LogRecord message property.
   553      * <p>
   554      * @param   level   One of the message level identifiers, e.g., SEVERE
   555      * @param   msg     The string message (or a key in the message catalog)
   556      * @param   thrown  Throwable associated with log message.
   557      */
   558     public void log(Level level, String msg, Throwable thrown) {
   559         if (level.intValue() < levelValue || levelValue == offValue) {
   560             return;
   561         }
   562         LogRecord lr = new LogRecord(level, msg);
   563         lr.setThrown(thrown);
   564         doLog(lr);
   565     }
   566 
   567     //================================================================
   568     // Start of convenience methods WITH className and methodName
   569     //================================================================
   570 
   571     /**
   572      * Log a message, specifying source class and method,
   573      * with no arguments.
   574      * <p>
   575      * If the logger is currently enabled for the given message
   576      * level then the given message is forwarded to all the
   577      * registered output Handler objects.
   578      * <p>
   579      * @param   level   One of the message level identifiers, e.g., SEVERE
   580      * @param   sourceClass    name of class that issued the logging request
   581      * @param   sourceMethod   name of method that issued the logging request
   582      * @param   msg     The string message (or a key in the message catalog)
   583      */
   584     public void logp(Level level, String sourceClass, String sourceMethod, String msg) {
   585         if (level.intValue() < levelValue || levelValue == offValue) {
   586             return;
   587         }
   588         LogRecord lr = new LogRecord(level, msg);
   589         lr.setSourceClassName(sourceClass);
   590         lr.setSourceMethodName(sourceMethod);
   591         doLog(lr);
   592     }
   593 
   594     /**
   595      * Log a message, specifying source class and method,
   596      * with a single object parameter to the log message.
   597      * <p>
   598      * If the logger is currently enabled for the given message
   599      * level then a corresponding LogRecord is created and forwarded
   600      * to all the registered output Handler objects.
   601      * <p>
   602      * @param   level   One of the message level identifiers, e.g., SEVERE
   603      * @param   sourceClass    name of class that issued the logging request
   604      * @param   sourceMethod   name of method that issued the logging request
   605      * @param   msg      The string message (or a key in the message catalog)
   606      * @param   param1    Parameter to the log message.
   607      */
   608     public void logp(Level level, String sourceClass, String sourceMethod,
   609                                                 String msg, Object param1) {
   610         if (level.intValue() < levelValue || levelValue == offValue) {
   611             return;
   612         }
   613         LogRecord lr = new LogRecord(level, msg);
   614         lr.setSourceClassName(sourceClass);
   615         lr.setSourceMethodName(sourceMethod);
   616         Object params[] = { param1 };
   617         lr.setParameters(params);
   618         doLog(lr);
   619     }
   620 
   621     /**
   622      * Log a message, specifying source class and method,
   623      * with an array of object arguments.
   624      * <p>
   625      * If the logger is currently enabled for the given message
   626      * level then a corresponding LogRecord is created and forwarded
   627      * to all the registered output Handler objects.
   628      * <p>
   629      * @param   level   One of the message level identifiers, e.g., SEVERE
   630      * @param   sourceClass    name of class that issued the logging request
   631      * @param   sourceMethod   name of method that issued the logging request
   632      * @param   msg     The string message (or a key in the message catalog)
   633      * @param   params  Array of parameters to the message
   634      */
   635     public void logp(Level level, String sourceClass, String sourceMethod,
   636                                                 String msg, Object params[]) {
   637         if (level.intValue() < levelValue || levelValue == offValue) {
   638             return;
   639         }
   640         LogRecord lr = new LogRecord(level, msg);
   641         lr.setSourceClassName(sourceClass);
   642         lr.setSourceMethodName(sourceMethod);
   643         lr.setParameters(params);
   644         doLog(lr);
   645     }
   646 
   647     /**
   648      * Log a message, specifying source class and method,
   649      * with associated Throwable information.
   650      * <p>
   651      * If the logger is currently enabled for the given message
   652      * level then the given arguments are stored in a LogRecord
   653      * which is forwarded to all registered output handlers.
   654      * <p>
   655      * Note that the thrown argument is stored in the LogRecord thrown
   656      * property, rather than the LogRecord parameters property.  Thus is it
   657      * processed specially by output Formatters and is not treated
   658      * as a formatting parameter to the LogRecord message property.
   659      * <p>
   660      * @param   level   One of the message level identifiers, e.g., SEVERE
   661      * @param   sourceClass    name of class that issued the logging request
   662      * @param   sourceMethod   name of method that issued the logging request
   663      * @param   msg     The string message (or a key in the message catalog)
   664      * @param   thrown  Throwable associated with log message.
   665      */
   666     public void logp(Level level, String sourceClass, String sourceMethod,
   667                                                         String msg, Throwable thrown) {
   668         if (level.intValue() < levelValue || levelValue == offValue) {
   669             return;
   670         }
   671         LogRecord lr = new LogRecord(level, msg);
   672         lr.setSourceClassName(sourceClass);
   673         lr.setSourceMethodName(sourceMethod);
   674         lr.setThrown(thrown);
   675         doLog(lr);
   676     }
   677 
   678 
   679     //=========================================================================
   680     // Start of convenience methods WITH className, methodName and bundle name.
   681     //=========================================================================
   682 
   683 
   684     /**
   685      * Log a message, specifying source class, method, and resource bundle name
   686      * with no arguments.
   687      * <p>
   688      * If the logger is currently enabled for the given message
   689      * level then the given message is forwarded to all the
   690      * registered output Handler objects.
   691      * <p>
   692      * The msg string is localized using the named resource bundle.  If the
   693      * resource bundle name is null, or an empty String or invalid
   694      * then the msg string is not localized.
   695      * <p>
   696      * @param   level   One of the message level identifiers, e.g., SEVERE
   697      * @param   sourceClass    name of class that issued the logging request
   698      * @param   sourceMethod   name of method that issued the logging request
   699      * @param   bundleName     name of resource bundle to localize msg,
   700      *                         can be null
   701      * @param   msg     The string message (or a key in the message catalog)
   702      */
   703 
   704     public void logrb(Level level, String sourceClass, String sourceMethod,
   705                                 String bundleName, String msg) {
   706         if (level.intValue() < levelValue || levelValue == offValue) {
   707             return;
   708         }
   709         LogRecord lr = new LogRecord(level, msg);
   710         lr.setSourceClassName(sourceClass);
   711         lr.setSourceMethodName(sourceMethod);
   712         doLog(lr, bundleName);
   713     }
   714 
   715     /**
   716      * Log a message, specifying source class, method, and resource bundle name,
   717      * with a single object parameter to the log message.
   718      * <p>
   719      * If the logger is currently enabled for the given message
   720      * level then a corresponding LogRecord is created and forwarded
   721      * to all the registered output Handler objects.
   722      * <p>
   723      * The msg string is localized using the named resource bundle.  If the
   724      * resource bundle name is null, or an empty String or invalid
   725      * then the msg string is not localized.
   726      * <p>
   727      * @param   level   One of the message level identifiers, e.g., SEVERE
   728      * @param   sourceClass    name of class that issued the logging request
   729      * @param   sourceMethod   name of method that issued the logging request
   730      * @param   bundleName     name of resource bundle to localize msg,
   731      *                         can be null
   732      * @param   msg      The string message (or a key in the message catalog)
   733      * @param   param1    Parameter to the log message.
   734      */
   735     public void logrb(Level level, String sourceClass, String sourceMethod,
   736                                 String bundleName, String msg, Object param1) {
   737         if (level.intValue() < levelValue || levelValue == offValue) {
   738             return;
   739         }
   740         LogRecord lr = new LogRecord(level, msg);
   741         lr.setSourceClassName(sourceClass);
   742         lr.setSourceMethodName(sourceMethod);
   743         Object params[] = { param1 };
   744         lr.setParameters(params);
   745         doLog(lr, bundleName);
   746     }
   747 
   748     /**
   749      * Log a message, specifying source class, method, and resource bundle name,
   750      * with an array of object arguments.
   751      * <p>
   752      * If the logger is currently enabled for the given message
   753      * level then a corresponding LogRecord is created and forwarded
   754      * to all the registered output Handler objects.
   755      * <p>
   756      * The msg string is localized using the named resource bundle.  If the
   757      * resource bundle name is null, or an empty String or invalid
   758      * then the msg string is not localized.
   759      * <p>
   760      * @param   level   One of the message level identifiers, e.g., SEVERE
   761      * @param   sourceClass    name of class that issued the logging request
   762      * @param   sourceMethod   name of method that issued the logging request
   763      * @param   bundleName     name of resource bundle to localize msg,
   764      *                         can be null.
   765      * @param   msg     The string message (or a key in the message catalog)
   766      * @param   params  Array of parameters to the message
   767      */
   768     public void logrb(Level level, String sourceClass, String sourceMethod,
   769                                 String bundleName, String msg, Object params[]) {
   770         if (level.intValue() < levelValue || levelValue == offValue) {
   771             return;
   772         }
   773         LogRecord lr = new LogRecord(level, msg);
   774         lr.setSourceClassName(sourceClass);
   775         lr.setSourceMethodName(sourceMethod);
   776         lr.setParameters(params);
   777         doLog(lr, bundleName);
   778     }
   779 
   780     /**
   781      * Log a message, specifying source class, method, and resource bundle name,
   782      * with associated Throwable information.
   783      * <p>
   784      * If the logger is currently enabled for the given message
   785      * level then the given arguments are stored in a LogRecord
   786      * which is forwarded to all registered output handlers.
   787      * <p>
   788      * The msg string is localized using the named resource bundle.  If the
   789      * resource bundle name is null, or an empty String or invalid
   790      * then the msg string is not localized.
   791      * <p>
   792      * Note that the thrown argument is stored in the LogRecord thrown
   793      * property, rather than the LogRecord parameters property.  Thus is it
   794      * processed specially by output Formatters and is not treated
   795      * as a formatting parameter to the LogRecord message property.
   796      * <p>
   797      * @param   level   One of the message level identifiers, e.g., SEVERE
   798      * @param   sourceClass    name of class that issued the logging request
   799      * @param   sourceMethod   name of method that issued the logging request
   800      * @param   bundleName     name of resource bundle to localize msg,
   801      *                         can be null
   802      * @param   msg     The string message (or a key in the message catalog)
   803      * @param   thrown  Throwable associated with log message.
   804      */
   805     public void logrb(Level level, String sourceClass, String sourceMethod,
   806                                         String bundleName, String msg, Throwable thrown) {
   807         if (level.intValue() < levelValue || levelValue == offValue) {
   808             return;
   809         }
   810         LogRecord lr = new LogRecord(level, msg);
   811         lr.setSourceClassName(sourceClass);
   812         lr.setSourceMethodName(sourceMethod);
   813         lr.setThrown(thrown);
   814         doLog(lr, bundleName);
   815     }
   816 
   817 
   818     //======================================================================
   819     // Start of convenience methods for logging method entries and returns.
   820     //======================================================================
   821 
   822     /**
   823      * Log a method entry.
   824      * <p>
   825      * This is a convenience method that can be used to log entry
   826      * to a method.  A LogRecord with message "ENTRY", log level
   827      * FINER, and the given sourceMethod and sourceClass is logged.
   828      * <p>
   829      * @param   sourceClass    name of class that issued the logging request
   830      * @param   sourceMethod   name of method that is being entered
   831      */
   832     public void entering(String sourceClass, String sourceMethod) {
   833         if (Level.FINER.intValue() < levelValue) {
   834             return;
   835         }
   836         logp(Level.FINER, sourceClass, sourceMethod, "ENTRY");
   837     }
   838 
   839     /**
   840      * Log a method entry, with one parameter.
   841      * <p>
   842      * This is a convenience method that can be used to log entry
   843      * to a method.  A LogRecord with message "ENTRY {0}", log level
   844      * FINER, and the given sourceMethod, sourceClass, and parameter
   845      * is logged.
   846      * <p>
   847      * @param   sourceClass    name of class that issued the logging request
   848      * @param   sourceMethod   name of method that is being entered
   849      * @param   param1         parameter to the method being entered
   850      */
   851     public void entering(String sourceClass, String sourceMethod, Object param1) {
   852         if (Level.FINER.intValue() < levelValue) {
   853             return;
   854         }
   855         Object params[] = { param1 };
   856         logp(Level.FINER, sourceClass, sourceMethod, "ENTRY {0}", params);
   857     }
   858 
   859     /**
   860      * Log a method entry, with an array of parameters.
   861      * <p>
   862      * This is a convenience method that can be used to log entry
   863      * to a method.  A LogRecord with message "ENTRY" (followed by a
   864      * format {N} indicator for each entry in the parameter array),
   865      * log level FINER, and the given sourceMethod, sourceClass, and
   866      * parameters is logged.
   867      * <p>
   868      * @param   sourceClass    name of class that issued the logging request
   869      * @param   sourceMethod   name of method that is being entered
   870      * @param   params         array of parameters to the method being entered
   871      */
   872     public void entering(String sourceClass, String sourceMethod, Object params[]) {
   873         if (Level.FINER.intValue() < levelValue) {
   874             return;
   875         }
   876         String msg = "ENTRY";
   877         if (params == null ) {
   878            logp(Level.FINER, sourceClass, sourceMethod, msg);
   879            return;
   880         }
   881         for (int i = 0; i < params.length; i++) {
   882             msg = msg + " {" + i + "}";
   883         }
   884         logp(Level.FINER, sourceClass, sourceMethod, msg, params);
   885     }
   886 
   887     /**
   888      * Log a method return.
   889      * <p>
   890      * This is a convenience method that can be used to log returning
   891      * from a method.  A LogRecord with message "RETURN", log level
   892      * FINER, and the given sourceMethod and sourceClass is logged.
   893      * <p>
   894      * @param   sourceClass    name of class that issued the logging request
   895      * @param   sourceMethod   name of the method
   896      */
   897     public void exiting(String sourceClass, String sourceMethod) {
   898         if (Level.FINER.intValue() < levelValue) {
   899             return;
   900         }
   901         logp(Level.FINER, sourceClass, sourceMethod, "RETURN");
   902     }
   903 
   904 
   905     /**
   906      * Log a method return, with result object.
   907      * <p>
   908      * This is a convenience method that can be used to log returning
   909      * from a method.  A LogRecord with message "RETURN {0}", log level
   910      * FINER, and the gives sourceMethod, sourceClass, and result
   911      * object is logged.
   912      * <p>
   913      * @param   sourceClass    name of class that issued the logging request
   914      * @param   sourceMethod   name of the method
   915      * @param   result  Object that is being returned
   916      */
   917     public void exiting(String sourceClass, String sourceMethod, Object result) {
   918         if (Level.FINER.intValue() < levelValue) {
   919             return;
   920         }
   921         Object params[] = { result };
   922         logp(Level.FINER, sourceClass, sourceMethod, "RETURN {0}", result);
   923     }
   924 
   925     /**
   926      * Log throwing an exception.
   927      * <p>
   928      * This is a convenience method to log that a method is
   929      * terminating by throwing an exception.  The logging is done
   930      * using the FINER level.
   931      * <p>
   932      * If the logger is currently enabled for the given message
   933      * level then the given arguments are stored in a LogRecord
   934      * which is forwarded to all registered output handlers.  The
   935      * LogRecord's message is set to "THROW".
   936      * <p>
   937      * Note that the thrown argument is stored in the LogRecord thrown
   938      * property, rather than the LogRecord parameters property.  Thus is it
   939      * processed specially by output Formatters and is not treated
   940      * as a formatting parameter to the LogRecord message property.
   941      * <p>
   942      * @param   sourceClass    name of class that issued the logging request
   943      * @param   sourceMethod  name of the method.
   944      * @param   thrown  The Throwable that is being thrown.
   945      */
   946     public void throwing(String sourceClass, String sourceMethod, Throwable thrown) {
   947         if (Level.FINER.intValue() < levelValue || levelValue == offValue ) {
   948             return;
   949         }
   950         LogRecord lr = new LogRecord(Level.FINER, "THROW");
   951         lr.setSourceClassName(sourceClass);
   952         lr.setSourceMethodName(sourceMethod);
   953         lr.setThrown(thrown);
   954         doLog(lr);
   955     }
   956 
   957     //=======================================================================
   958     // Start of simple convenience methods using level names as method names
   959     //=======================================================================
   960 
   961     /**
   962      * Log a SEVERE message.
   963      * <p>
   964      * If the logger is currently enabled for the SEVERE message
   965      * level then the given message is forwarded to all the
   966      * registered output Handler objects.
   967      * <p>
   968      * @param   msg     The string message (or a key in the message catalog)
   969      */
   970     public void severe(String msg) {
   971         if (Level.SEVERE.intValue() < levelValue) {
   972             return;
   973         }
   974         log(Level.SEVERE, msg);
   975     }
   976 
   977     /**
   978      * Log a WARNING message.
   979      * <p>
   980      * If the logger is currently enabled for the WARNING message
   981      * level then the given message is forwarded to all the
   982      * registered output Handler objects.
   983      * <p>
   984      * @param   msg     The string message (or a key in the message catalog)
   985      */
   986     public void warning(String msg) {
   987         if (Level.WARNING.intValue() < levelValue) {
   988             return;
   989         }
   990         log(Level.WARNING, msg);
   991     }
   992 
   993     /**
   994      * Log an INFO message.
   995      * <p>
   996      * If the logger is currently enabled for the INFO message
   997      * level then the given message is forwarded to all the
   998      * registered output Handler objects.
   999      * <p>
  1000      * @param   msg     The string message (or a key in the message catalog)
  1001      */
  1002     public void info(String msg) {
  1003         if (Level.INFO.intValue() < levelValue) {
  1004             return;
  1005         }
  1006         log(Level.INFO, msg);
  1007     }
  1008 
  1009     /**
  1010      * Log a CONFIG message.
  1011      * <p>
  1012      * If the logger is currently enabled for the CONFIG message
  1013      * level then the given message is forwarded to all the
  1014      * registered output Handler objects.
  1015      * <p>
  1016      * @param   msg     The string message (or a key in the message catalog)
  1017      */
  1018     public void config(String msg) {
  1019         if (Level.CONFIG.intValue() < levelValue) {
  1020             return;
  1021         }
  1022         log(Level.CONFIG, msg);
  1023     }
  1024 
  1025     /**
  1026      * Log a FINE message.
  1027      * <p>
  1028      * If the logger is currently enabled for the FINE message
  1029      * level then the given message is forwarded to all the
  1030      * registered output Handler objects.
  1031      * <p>
  1032      * @param   msg     The string message (or a key in the message catalog)
  1033      */
  1034     public void fine(String msg) {
  1035         if (Level.FINE.intValue() < levelValue) {
  1036             return;
  1037         }
  1038         log(Level.FINE, msg);
  1039     }
  1040 
  1041     /**
  1042      * Log a FINER message.
  1043      * <p>
  1044      * If the logger is currently enabled for the FINER message
  1045      * level then the given message is forwarded to all the
  1046      * registered output Handler objects.
  1047      * <p>
  1048      * @param   msg     The string message (or a key in the message catalog)
  1049      */
  1050     public void finer(String msg) {
  1051         if (Level.FINER.intValue() < levelValue) {
  1052             return;
  1053         }
  1054         log(Level.FINER, msg);
  1055     }
  1056 
  1057     /**
  1058      * Log a FINEST message.
  1059      * <p>
  1060      * If the logger is currently enabled for the FINEST message
  1061      * level then the given message is forwarded to all the
  1062      * registered output Handler objects.
  1063      * <p>
  1064      * @param   msg     The string message (or a key in the message catalog)
  1065      */
  1066     public void finest(String msg) {
  1067         if (Level.FINEST.intValue() < levelValue) {
  1068             return;
  1069         }
  1070         log(Level.FINEST, msg);
  1071     }
  1072 
  1073     //================================================================
  1074     // End of convenience methods
  1075     //================================================================
  1076 
  1077     /**
  1078      * Set the log level specifying which message levels will be
  1079      * logged by this logger.  Message levels lower than this
  1080      * value will be discarded.  The level value Level.OFF
  1081      * can be used to turn off logging.
  1082      * <p>
  1083      * If the new level is null, it means that this node should
  1084      * inherit its level from its nearest ancestor with a specific
  1085      * (non-null) level value.
  1086      *
  1087      * @param newLevel   the new value for the log level (may be null)
  1088      * @exception  SecurityException  if a security manager exists and if
  1089      *             the caller does not have LoggingPermission("control").
  1090      */
  1091     public void setLevel(Level newLevel) throws SecurityException {
  1092         levelValue = newLevel.intValue();
  1093         levelObject = newLevel;
  1094     }
  1095 
  1096     /**
  1097      * Get the log Level that has been specified for this Logger.
  1098      * The result may be null, which means that this logger's
  1099      * effective level will be inherited from its parent.
  1100      *
  1101      * @return  this Logger's level
  1102      */
  1103     public Level getLevel() {
  1104         return levelObject;
  1105     }
  1106 
  1107     /**
  1108      * Check if a message of the given level would actually be logged
  1109      * by this logger.  This check is based on the Loggers effective level,
  1110      * which may be inherited from its parent.
  1111      *
  1112      * @param   level   a message logging level
  1113      * @return  true if the given message level is currently being logged.
  1114      */
  1115     public boolean isLoggable(Level level) {
  1116         if (level.intValue() < levelValue || levelValue == offValue) {
  1117             return false;
  1118         }
  1119         return true;
  1120     }
  1121 
  1122     /**
  1123      * Get the name for this logger.
  1124      * @return logger name.  Will be null for anonymous Loggers.
  1125      */
  1126     public String getName() {
  1127         return name;
  1128     }
  1129 
  1130     /**
  1131      * Add a log Handler to receive logging messages.
  1132      * <p>
  1133      * By default, Loggers also send their output to their parent logger.
  1134      * Typically the root Logger is configured with a set of Handlers
  1135      * that essentially act as default handlers for all loggers.
  1136      *
  1137      * @param   handler a logging Handler
  1138      * @exception  SecurityException  if a security manager exists and if
  1139      *             the caller does not have LoggingPermission("control").
  1140      */
  1141 //    public void addHandler(Handler handler) throws SecurityException {
  1142 //        // Check for null handler
  1143 //        handler.getClass();
  1144 //        checkAccess();
  1145 //        handlers.add(handler);
  1146 //    }
  1147 
  1148     /**
  1149      * Remove a log Handler.
  1150      * <P>
  1151      * Returns silently if the given Handler is not found or is null
  1152      *
  1153      * @param   handler a logging Handler
  1154      * @exception  SecurityException  if a security manager exists and if
  1155      *             the caller does not have LoggingPermission("control").
  1156      */
  1157 //    public void removeHandler(Handler handler) throws SecurityException {
  1158 //        checkAccess();
  1159 //        if (handler == null) {
  1160 //            return;
  1161 //        }
  1162 //        handlers.remove(handler);
  1163 //    }
  1164 
  1165     /**
  1166      * Get the Handlers associated with this logger.
  1167      * <p>
  1168      * @return  an array of all registered Handlers
  1169      */
  1170 //    public Handler[] getHandlers() {
  1171 //        return handlers.toArray(emptyHandlers);
  1172 //    }
  1173 
  1174     /**
  1175      * Specify whether or not this logger should send its output
  1176      * to its parent Logger.  This means that any LogRecords will
  1177      * also be written to the parent's Handlers, and potentially
  1178      * to its parent, recursively up the namespace.
  1179      *
  1180      * @param useParentHandlers   true if output is to be sent to the
  1181      *          logger's parent.
  1182      * @exception  SecurityException  if a security manager exists and if
  1183      *             the caller does not have LoggingPermission("control").
  1184      */
  1185     public void setUseParentHandlers(boolean useParentHandlers) {
  1186         checkAccess();
  1187     }
  1188 
  1189     /**
  1190      * Discover whether or not this logger is sending its output
  1191      * to its parent logger.
  1192      *
  1193      * @return  true if output is to be sent to the logger's parent
  1194      */
  1195     public boolean getUseParentHandlers() {
  1196         return true;
  1197     }
  1198 
  1199     /**
  1200      * Return the parent for this Logger.
  1201      * <p>
  1202      * This method returns the nearest extant parent in the namespace.
  1203      * Thus if a Logger is called "a.b.c.d", and a Logger called "a.b"
  1204      * has been created but no logger "a.b.c" exists, then a call of
  1205      * getParent on the Logger "a.b.c.d" will return the Logger "a.b".
  1206      * <p>
  1207      * The result will be null if it is called on the root Logger
  1208      * in the namespace.
  1209      *
  1210      * @return nearest existing parent Logger
  1211      */
  1212     public Logger getParent() {
  1213         // Note: this used to be synchronized on treeLock.  However, this only
  1214         // provided memory semantics, as there was no guarantee that the caller
  1215         // would synchronize on treeLock (in fact, there is no way for external
  1216         // callers to so synchronize).  Therefore, we have made parent volatile
  1217         // instead.
  1218         String n = getName();
  1219         int at = n.length();
  1220         for (;;) {
  1221             int last = n.lastIndexOf('.', at - 1);
  1222             if (last == -1) {
  1223                 return getGlobal();
  1224             }
  1225             Logger p = ALL.get(n.substring(0, last));
  1226             if (p != null) {
  1227                 return p;
  1228             }
  1229             at = last;
  1230         }
  1231     }
  1232 
  1233     /**
  1234      * Set the parent for this Logger.  This method is used by
  1235      * the LogManager to update a Logger when the namespace changes.
  1236      * <p>
  1237      * It should not be called from application code.
  1238      * <p>
  1239      * @param  parent   the new parent logger
  1240      * @exception  SecurityException  if a security manager exists and if
  1241      *             the caller does not have LoggingPermission("control").
  1242      */
  1243     public void setParent(Logger parent) {
  1244         if (parent == null) {
  1245             throw new NullPointerException();
  1246         }
  1247         checkAccess();
  1248     }
  1249 
  1250 }