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.
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.
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).
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.
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
27 package java.util.logging;
29 import java.util.HashMap;
31 import org.apidesign.bck2brwsr.core.JavaScriptBody;
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.
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
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.
53 * Each Logger keeps track of a "parent" Logger, which is its
54 * nearest existing ancestor in the Logger namespace.
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.
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.
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.
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.
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.
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
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
109 * Formatting (including localization) is the responsibility of
110 * the output Handler, which will typically call a Formatter.
112 * Note that formatting need not occur synchronously. It may be delayed
113 * until a LogRecord is actually written to an external sink.
115 * The logging methods are grouped in five main categories:
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.
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
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.
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).
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.
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.
149 * All methods on Logger are multi-thread safe.
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.
166 public class Logger {
167 private static int offValue = Level.OFF.intValue();
168 private static final Map<String,Logger> ALL = new HashMap<>();
171 private volatile int levelValue; // current effective level value
172 private Level levelObject;
175 * GLOBAL_LOGGER_NAME is a name for the global logger.
179 public static final String GLOBAL_LOGGER_NAME = "global";
182 * Return global logger object with the name Logger.GLOBAL_LOGGER_NAME.
184 * @return global logger object
187 public static final Logger getGlobal() {
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.
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>.
213 public static final Logger global = new Logger(GLOBAL_LOGGER_NAME);
216 * Protected method to construct a logger for a named subsystem.
218 * The logger will be initially configured with a null Level
219 * and with useParentHandlers set to true.
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.
232 protected Logger(String name, String resourceBundleName) {
234 levelValue = Level.INFO.intValue();
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.
243 levelValue = Level.INFO.intValue();
246 private void checkAccess() throws SecurityException {
247 throw new SecurityException();
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.
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.
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.
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
274 * @return a suitable Logger
275 * @throws NullPointerException if the name is null.
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);
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.
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.
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.
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
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
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.
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);
330 l = new Logger(name, resourceBundleName);
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.
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.
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.
355 * @return a newly created private Logger
357 public static Logger getAnonymousLogger() {
358 return getAnonymousLogger(null);
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.
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.
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.
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.
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);
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.
398 * @return localization bundle (may be null)
400 // public ResourceBundle getResourceBundle() {
401 // return findResourceBundle(getResourceBundleName());
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.
409 * @return localization bundle name (may be null)
411 public String getResourceBundleName() {
416 * Set a filter to control output on this Logger.
418 * After passing the initial "level" check, the Logger will
419 * call this Filter to check if a log record should really
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").
426 // public void setFilter(Filter newFilter) throws SecurityException {
431 * Get the current filter for this Logger.
433 * @return a filter object (may be null)
435 // public Filter getFilter() {
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.
446 * @param record the LogRecord to be published
448 public void log(LogRecord record) {
449 if (record.getLevel().intValue() < levelValue) {
454 switch (record.getLevel().toString()) {
455 case "INFO": method = "info"; break;
456 case "SEVERE": method = "error"; break;
457 case "WARNING": method = "warn"; break;
458 default: method = "log"; break;
461 String msg = record.getMessage();
462 final Object[] params = record.getParameters();
463 if (params == null || params.length == 0) {
465 for (int i = 0; i < params.length; i++) {
466 msg = msg.replace("{" + i + "}", params[i] == null ? "null" : params[i].toString());
472 record.getLoggerName(), msg);
475 @JavaScriptBody(args = { "method", "logger", "msg" }, body =
476 "if (console) console[method]('[' + logger + ']: ' + msg);"
478 private static native void consoleLog(
479 String method, String logger, String msg
482 // private support method for logging.
483 // We fill in the logger name, resource bundle name, and
484 // resource bundle and then call "void log(LogRecord)".
485 private void doLog(LogRecord lr) {
486 doLog(lr, lr.getResourceBundleName());
488 private void doLog(LogRecord lr, String bundleName) {
489 lr.setLoggerName(name);
494 //================================================================
495 // Start of convenience methods WITHOUT className and methodName
496 //================================================================
499 * Log a message, with no arguments.
501 * If the logger is currently enabled for the given message
502 * level then the given message is forwarded to all the
503 * registered output Handler objects.
505 * @param level One of the message level identifiers, e.g., SEVERE
506 * @param msg The string message (or a key in the message catalog)
508 public void log(Level level, String msg) {
509 if (level.intValue() < levelValue || levelValue == offValue) {
512 LogRecord lr = new LogRecord(level, msg);
517 * Log a message, with one object parameter.
519 * If the logger is currently enabled for the given message
520 * level then a corresponding LogRecord is created and forwarded
521 * to all the registered output Handler objects.
523 * @param level One of the message level identifiers, e.g., SEVERE
524 * @param msg The string message (or a key in the message catalog)
525 * @param param1 parameter to the message
527 public void log(Level level, String msg, Object param1) {
528 if (level.intValue() < levelValue || levelValue == offValue) {
531 LogRecord lr = new LogRecord(level, msg);
532 Object params[] = { param1 };
533 lr.setParameters(params);
538 * Log a message, with an array of object arguments.
540 * If the logger is currently enabled for the given message
541 * level then a corresponding LogRecord is created and forwarded
542 * to all the registered output Handler objects.
544 * @param level One of the message level identifiers, e.g., SEVERE
545 * @param msg The string message (or a key in the message catalog)
546 * @param params array of parameters to the message
548 public void log(Level level, String msg, Object params[]) {
549 if (level.intValue() < levelValue || levelValue == offValue) {
552 LogRecord lr = new LogRecord(level, msg);
553 lr.setParameters(params);
558 * Log a message, with associated Throwable information.
560 * If the logger is currently enabled for the given message
561 * level then the given arguments are stored in a LogRecord
562 * which is forwarded to all registered output handlers.
564 * Note that the thrown argument is stored in the LogRecord thrown
565 * property, rather than the LogRecord parameters property. Thus is it
566 * processed specially by output Formatters and is not treated
567 * as a formatting parameter to the LogRecord message property.
569 * @param level One of the message level identifiers, e.g., SEVERE
570 * @param msg The string message (or a key in the message catalog)
571 * @param thrown Throwable associated with log message.
573 public void log(Level level, String msg, Throwable thrown) {
574 if (level.intValue() < levelValue || levelValue == offValue) {
577 LogRecord lr = new LogRecord(level, msg);
578 lr.setThrown(thrown);
582 //================================================================
583 // Start of convenience methods WITH className and methodName
584 //================================================================
587 * Log a message, specifying source class and method,
590 * If the logger is currently enabled for the given message
591 * level then the given message is forwarded to all the
592 * registered output Handler objects.
594 * @param level One of the message level identifiers, e.g., SEVERE
595 * @param sourceClass name of class that issued the logging request
596 * @param sourceMethod name of method that issued the logging request
597 * @param msg The string message (or a key in the message catalog)
599 public void logp(Level level, String sourceClass, String sourceMethod, String msg) {
600 if (level.intValue() < levelValue || levelValue == offValue) {
603 LogRecord lr = new LogRecord(level, msg);
604 lr.setSourceClassName(sourceClass);
605 lr.setSourceMethodName(sourceMethod);
610 * Log a message, specifying source class and method,
611 * with a single object parameter to the log message.
613 * If the logger is currently enabled for the given message
614 * level then a corresponding LogRecord is created and forwarded
615 * to all the registered output Handler objects.
617 * @param level One of the message level identifiers, e.g., SEVERE
618 * @param sourceClass name of class that issued the logging request
619 * @param sourceMethod name of method that issued the logging request
620 * @param msg The string message (or a key in the message catalog)
621 * @param param1 Parameter to the log message.
623 public void logp(Level level, String sourceClass, String sourceMethod,
624 String msg, Object param1) {
625 if (level.intValue() < levelValue || levelValue == offValue) {
628 LogRecord lr = new LogRecord(level, msg);
629 lr.setSourceClassName(sourceClass);
630 lr.setSourceMethodName(sourceMethod);
631 Object params[] = { param1 };
632 lr.setParameters(params);
637 * Log a message, specifying source class and method,
638 * with an array of object arguments.
640 * If the logger is currently enabled for the given message
641 * level then a corresponding LogRecord is created and forwarded
642 * to all the registered output Handler objects.
644 * @param level One of the message level identifiers, e.g., SEVERE
645 * @param sourceClass name of class that issued the logging request
646 * @param sourceMethod name of method that issued the logging request
647 * @param msg The string message (or a key in the message catalog)
648 * @param params Array of parameters to the message
650 public void logp(Level level, String sourceClass, String sourceMethod,
651 String msg, Object params[]) {
652 if (level.intValue() < levelValue || levelValue == offValue) {
655 LogRecord lr = new LogRecord(level, msg);
656 lr.setSourceClassName(sourceClass);
657 lr.setSourceMethodName(sourceMethod);
658 lr.setParameters(params);
663 * Log a message, specifying source class and method,
664 * with associated Throwable information.
666 * If the logger is currently enabled for the given message
667 * level then the given arguments are stored in a LogRecord
668 * which is forwarded to all registered output handlers.
670 * Note that the thrown argument is stored in the LogRecord thrown
671 * property, rather than the LogRecord parameters property. Thus is it
672 * processed specially by output Formatters and is not treated
673 * as a formatting parameter to the LogRecord message property.
675 * @param level One of the message level identifiers, e.g., SEVERE
676 * @param sourceClass name of class that issued the logging request
677 * @param sourceMethod name of method that issued the logging request
678 * @param msg The string message (or a key in the message catalog)
679 * @param thrown Throwable associated with log message.
681 public void logp(Level level, String sourceClass, String sourceMethod,
682 String msg, Throwable thrown) {
683 if (level.intValue() < levelValue || levelValue == offValue) {
686 LogRecord lr = new LogRecord(level, msg);
687 lr.setSourceClassName(sourceClass);
688 lr.setSourceMethodName(sourceMethod);
689 lr.setThrown(thrown);
694 //=========================================================================
695 // Start of convenience methods WITH className, methodName and bundle name.
696 //=========================================================================
700 * Log a message, specifying source class, method, and resource bundle name
703 * If the logger is currently enabled for the given message
704 * level then the given message is forwarded to all the
705 * registered output Handler objects.
707 * The msg string is localized using the named resource bundle. If the
708 * resource bundle name is null, or an empty String or invalid
709 * then the msg string is not localized.
711 * @param level One of the message level identifiers, e.g., SEVERE
712 * @param sourceClass name of class that issued the logging request
713 * @param sourceMethod name of method that issued the logging request
714 * @param bundleName name of resource bundle to localize msg,
716 * @param msg The string message (or a key in the message catalog)
719 public void logrb(Level level, String sourceClass, String sourceMethod,
720 String bundleName, String msg) {
721 if (level.intValue() < levelValue || levelValue == offValue) {
724 LogRecord lr = new LogRecord(level, msg);
725 lr.setSourceClassName(sourceClass);
726 lr.setSourceMethodName(sourceMethod);
727 doLog(lr, bundleName);
731 * Log a message, specifying source class, method, and resource bundle name,
732 * with a single object parameter to the log message.
734 * If the logger is currently enabled for the given message
735 * level then a corresponding LogRecord is created and forwarded
736 * to all the registered output Handler objects.
738 * The msg string is localized using the named resource bundle. If the
739 * resource bundle name is null, or an empty String or invalid
740 * then the msg string is not localized.
742 * @param level One of the message level identifiers, e.g., SEVERE
743 * @param sourceClass name of class that issued the logging request
744 * @param sourceMethod name of method that issued the logging request
745 * @param bundleName name of resource bundle to localize msg,
747 * @param msg The string message (or a key in the message catalog)
748 * @param param1 Parameter to the log message.
750 public void logrb(Level level, String sourceClass, String sourceMethod,
751 String bundleName, String msg, Object param1) {
752 if (level.intValue() < levelValue || levelValue == offValue) {
755 LogRecord lr = new LogRecord(level, msg);
756 lr.setSourceClassName(sourceClass);
757 lr.setSourceMethodName(sourceMethod);
758 Object params[] = { param1 };
759 lr.setParameters(params);
760 doLog(lr, bundleName);
764 * Log a message, specifying source class, method, and resource bundle name,
765 * with an array of object arguments.
767 * If the logger is currently enabled for the given message
768 * level then a corresponding LogRecord is created and forwarded
769 * to all the registered output Handler objects.
771 * The msg string is localized using the named resource bundle. If the
772 * resource bundle name is null, or an empty String or invalid
773 * then the msg string is not localized.
775 * @param level One of the message level identifiers, e.g., SEVERE
776 * @param sourceClass name of class that issued the logging request
777 * @param sourceMethod name of method that issued the logging request
778 * @param bundleName name of resource bundle to localize msg,
780 * @param msg The string message (or a key in the message catalog)
781 * @param params Array of parameters to the message
783 public void logrb(Level level, String sourceClass, String sourceMethod,
784 String bundleName, String msg, Object params[]) {
785 if (level.intValue() < levelValue || levelValue == offValue) {
788 LogRecord lr = new LogRecord(level, msg);
789 lr.setSourceClassName(sourceClass);
790 lr.setSourceMethodName(sourceMethod);
791 lr.setParameters(params);
792 doLog(lr, bundleName);
796 * Log a message, specifying source class, method, and resource bundle name,
797 * with associated Throwable information.
799 * If the logger is currently enabled for the given message
800 * level then the given arguments are stored in a LogRecord
801 * which is forwarded to all registered output handlers.
803 * The msg string is localized using the named resource bundle. If the
804 * resource bundle name is null, or an empty String or invalid
805 * then the msg string is not localized.
807 * Note that the thrown argument is stored in the LogRecord thrown
808 * property, rather than the LogRecord parameters property. Thus is it
809 * processed specially by output Formatters and is not treated
810 * as a formatting parameter to the LogRecord message property.
812 * @param level One of the message level identifiers, e.g., SEVERE
813 * @param sourceClass name of class that issued the logging request
814 * @param sourceMethod name of method that issued the logging request
815 * @param bundleName name of resource bundle to localize msg,
817 * @param msg The string message (or a key in the message catalog)
818 * @param thrown Throwable associated with log message.
820 public void logrb(Level level, String sourceClass, String sourceMethod,
821 String bundleName, String msg, Throwable thrown) {
822 if (level.intValue() < levelValue || levelValue == offValue) {
825 LogRecord lr = new LogRecord(level, msg);
826 lr.setSourceClassName(sourceClass);
827 lr.setSourceMethodName(sourceMethod);
828 lr.setThrown(thrown);
829 doLog(lr, bundleName);
833 //======================================================================
834 // Start of convenience methods for logging method entries and returns.
835 //======================================================================
838 * Log a method entry.
840 * This is a convenience method that can be used to log entry
841 * to a method. A LogRecord with message "ENTRY", log level
842 * FINER, and the given sourceMethod and sourceClass is logged.
844 * @param sourceClass name of class that issued the logging request
845 * @param sourceMethod name of method that is being entered
847 public void entering(String sourceClass, String sourceMethod) {
848 if (Level.FINER.intValue() < levelValue) {
851 logp(Level.FINER, sourceClass, sourceMethod, "ENTRY");
855 * Log a method entry, with one parameter.
857 * This is a convenience method that can be used to log entry
858 * to a method. A LogRecord with message "ENTRY {0}", log level
859 * FINER, and the given sourceMethod, sourceClass, and parameter
862 * @param sourceClass name of class that issued the logging request
863 * @param sourceMethod name of method that is being entered
864 * @param param1 parameter to the method being entered
866 public void entering(String sourceClass, String sourceMethod, Object param1) {
867 if (Level.FINER.intValue() < levelValue) {
870 Object params[] = { param1 };
871 logp(Level.FINER, sourceClass, sourceMethod, "ENTRY {0}", params);
875 * Log a method entry, with an array of parameters.
877 * This is a convenience method that can be used to log entry
878 * to a method. A LogRecord with message "ENTRY" (followed by a
879 * format {N} indicator for each entry in the parameter array),
880 * log level FINER, and the given sourceMethod, sourceClass, and
881 * parameters is logged.
883 * @param sourceClass name of class that issued the logging request
884 * @param sourceMethod name of method that is being entered
885 * @param params array of parameters to the method being entered
887 public void entering(String sourceClass, String sourceMethod, Object params[]) {
888 if (Level.FINER.intValue() < levelValue) {
891 String msg = "ENTRY";
892 if (params == null ) {
893 logp(Level.FINER, sourceClass, sourceMethod, msg);
896 for (int i = 0; i < params.length; i++) {
897 msg = msg + " {" + i + "}";
899 logp(Level.FINER, sourceClass, sourceMethod, msg, params);
903 * Log a method return.
905 * This is a convenience method that can be used to log returning
906 * from a method. A LogRecord with message "RETURN", log level
907 * FINER, and the given sourceMethod and sourceClass is logged.
909 * @param sourceClass name of class that issued the logging request
910 * @param sourceMethod name of the method
912 public void exiting(String sourceClass, String sourceMethod) {
913 if (Level.FINER.intValue() < levelValue) {
916 logp(Level.FINER, sourceClass, sourceMethod, "RETURN");
921 * Log a method return, with result object.
923 * This is a convenience method that can be used to log returning
924 * from a method. A LogRecord with message "RETURN {0}", log level
925 * FINER, and the gives sourceMethod, sourceClass, and result
928 * @param sourceClass name of class that issued the logging request
929 * @param sourceMethod name of the method
930 * @param result Object that is being returned
932 public void exiting(String sourceClass, String sourceMethod, Object result) {
933 if (Level.FINER.intValue() < levelValue) {
936 Object params[] = { result };
937 logp(Level.FINER, sourceClass, sourceMethod, "RETURN {0}", result);
941 * Log throwing an exception.
943 * This is a convenience method to log that a method is
944 * terminating by throwing an exception. The logging is done
945 * using the FINER level.
947 * If the logger is currently enabled for the given message
948 * level then the given arguments are stored in a LogRecord
949 * which is forwarded to all registered output handlers. The
950 * LogRecord's message is set to "THROW".
952 * Note that the thrown argument is stored in the LogRecord thrown
953 * property, rather than the LogRecord parameters property. Thus is it
954 * processed specially by output Formatters and is not treated
955 * as a formatting parameter to the LogRecord message property.
957 * @param sourceClass name of class that issued the logging request
958 * @param sourceMethod name of the method.
959 * @param thrown The Throwable that is being thrown.
961 public void throwing(String sourceClass, String sourceMethod, Throwable thrown) {
962 if (Level.FINER.intValue() < levelValue || levelValue == offValue ) {
965 LogRecord lr = new LogRecord(Level.FINER, "THROW");
966 lr.setSourceClassName(sourceClass);
967 lr.setSourceMethodName(sourceMethod);
968 lr.setThrown(thrown);
972 //=======================================================================
973 // Start of simple convenience methods using level names as method names
974 //=======================================================================
977 * Log a SEVERE message.
979 * If the logger is currently enabled for the SEVERE message
980 * level then the given message is forwarded to all the
981 * registered output Handler objects.
983 * @param msg The string message (or a key in the message catalog)
985 public void severe(String msg) {
986 if (Level.SEVERE.intValue() < levelValue) {
989 log(Level.SEVERE, msg);
993 * Log a WARNING message.
995 * If the logger is currently enabled for the WARNING message
996 * level then the given message is forwarded to all the
997 * registered output Handler objects.
999 * @param msg The string message (or a key in the message catalog)
1001 public void warning(String msg) {
1002 if (Level.WARNING.intValue() < levelValue) {
1005 log(Level.WARNING, msg);
1009 * Log an INFO message.
1011 * If the logger is currently enabled for the INFO message
1012 * level then the given message is forwarded to all the
1013 * registered output Handler objects.
1015 * @param msg The string message (or a key in the message catalog)
1017 public void info(String msg) {
1018 if (Level.INFO.intValue() < levelValue) {
1021 log(Level.INFO, msg);
1025 * Log a CONFIG message.
1027 * If the logger is currently enabled for the CONFIG message
1028 * level then the given message is forwarded to all the
1029 * registered output Handler objects.
1031 * @param msg The string message (or a key in the message catalog)
1033 public void config(String msg) {
1034 if (Level.CONFIG.intValue() < levelValue) {
1037 log(Level.CONFIG, msg);
1041 * Log a FINE message.
1043 * If the logger is currently enabled for the FINE message
1044 * level then the given message is forwarded to all the
1045 * registered output Handler objects.
1047 * @param msg The string message (or a key in the message catalog)
1049 public void fine(String msg) {
1050 if (Level.FINE.intValue() < levelValue) {
1053 log(Level.FINE, msg);
1057 * Log a FINER message.
1059 * If the logger is currently enabled for the FINER message
1060 * level then the given message is forwarded to all the
1061 * registered output Handler objects.
1063 * @param msg The string message (or a key in the message catalog)
1065 public void finer(String msg) {
1066 if (Level.FINER.intValue() < levelValue) {
1069 log(Level.FINER, msg);
1073 * Log a FINEST message.
1075 * If the logger is currently enabled for the FINEST message
1076 * level then the given message is forwarded to all the
1077 * registered output Handler objects.
1079 * @param msg The string message (or a key in the message catalog)
1081 public void finest(String msg) {
1082 if (Level.FINEST.intValue() < levelValue) {
1085 log(Level.FINEST, msg);
1088 //================================================================
1089 // End of convenience methods
1090 //================================================================
1093 * Set the log level specifying which message levels will be
1094 * logged by this logger. Message levels lower than this
1095 * value will be discarded. The level value Level.OFF
1096 * can be used to turn off logging.
1098 * If the new level is null, it means that this node should
1099 * inherit its level from its nearest ancestor with a specific
1100 * (non-null) level value.
1102 * @param newLevel the new value for the log level (may be null)
1103 * @exception SecurityException if a security manager exists and if
1104 * the caller does not have LoggingPermission("control").
1106 public void setLevel(Level newLevel) throws SecurityException {
1107 levelValue = newLevel.intValue();
1108 levelObject = newLevel;
1112 * Get the log Level that has been specified for this Logger.
1113 * The result may be null, which means that this logger's
1114 * effective level will be inherited from its parent.
1116 * @return this Logger's level
1118 public Level getLevel() {
1123 * Check if a message of the given level would actually be logged
1124 * by this logger. This check is based on the Loggers effective level,
1125 * which may be inherited from its parent.
1127 * @param level a message logging level
1128 * @return true if the given message level is currently being logged.
1130 public boolean isLoggable(Level level) {
1131 if (level.intValue() < levelValue || levelValue == offValue) {
1138 * Get the name for this logger.
1139 * @return logger name. Will be null for anonymous Loggers.
1141 public String getName() {
1146 * Add a log Handler to receive logging messages.
1148 * By default, Loggers also send their output to their parent logger.
1149 * Typically the root Logger is configured with a set of Handlers
1150 * that essentially act as default handlers for all loggers.
1152 * @param handler a logging Handler
1153 * @exception SecurityException if a security manager exists and if
1154 * the caller does not have LoggingPermission("control").
1156 // public void addHandler(Handler handler) throws SecurityException {
1157 // // Check for null handler
1158 // handler.getClass();
1160 // handlers.add(handler);
1164 * Remove a log Handler.
1166 * Returns silently if the given Handler is not found or is null
1168 * @param handler a logging Handler
1169 * @exception SecurityException if a security manager exists and if
1170 * the caller does not have LoggingPermission("control").
1172 // public void removeHandler(Handler handler) throws SecurityException {
1174 // if (handler == null) {
1177 // handlers.remove(handler);
1181 * Get the Handlers associated with this logger.
1183 * @return an array of all registered Handlers
1185 // public Handler[] getHandlers() {
1186 // return handlers.toArray(emptyHandlers);
1190 * Specify whether or not this logger should send its output
1191 * to its parent Logger. This means that any LogRecords will
1192 * also be written to the parent's Handlers, and potentially
1193 * to its parent, recursively up the namespace.
1195 * @param useParentHandlers true if output is to be sent to the
1197 * @exception SecurityException if a security manager exists and if
1198 * the caller does not have LoggingPermission("control").
1200 public void setUseParentHandlers(boolean useParentHandlers) {
1205 * Discover whether or not this logger is sending its output
1206 * to its parent logger.
1208 * @return true if output is to be sent to the logger's parent
1210 public boolean getUseParentHandlers() {
1215 * Return the parent for this Logger.
1217 * This method returns the nearest extant parent in the namespace.
1218 * Thus if a Logger is called "a.b.c.d", and a Logger called "a.b"
1219 * has been created but no logger "a.b.c" exists, then a call of
1220 * getParent on the Logger "a.b.c.d" will return the Logger "a.b".
1222 * The result will be null if it is called on the root Logger
1225 * @return nearest existing parent Logger
1227 public Logger getParent() {
1228 // Note: this used to be synchronized on treeLock. However, this only
1229 // provided memory semantics, as there was no guarantee that the caller
1230 // would synchronize on treeLock (in fact, there is no way for external
1231 // callers to so synchronize). Therefore, we have made parent volatile
1233 String n = getName();
1234 int at = n.length();
1236 int last = n.lastIndexOf('.', at - 1);
1240 Logger p = ALL.get(n.substring(0, last));
1249 * Set the parent for this Logger. This method is used by
1250 * the LogManager to update a Logger when the namespace changes.
1252 * It should not be called from application code.
1254 * @param parent the new parent logger
1255 * @exception SecurityException if a security manager exists and if
1256 * the caller does not have LoggingPermission("control").
1258 public void setParent(Logger parent) {
1259 if (parent == null) {
1260 throw new NullPointerException();