jdk/src/java.logging/share/classes/java/util/logging/Logging.java
author dfuchs
Thu, 06 Apr 2017 14:38:15 +0100
changeset 44538 a603c475d649
parent 38370 61f46e1e7aee
permissions -rw-r--r--
8178139: Minor typo in API documentation of java.util.logging.Logger Reviewed-by: lancea
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
     1
/*
21655
55f32ae4f920 8028229: Fix more raw types lint warning in core libraries
darcy
parents: 16100
diff changeset
     2
 * Copyright (c) 2003, 2013, Oracle and/or its affiliates. All rights reserved.
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
     3
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
90ce3da70b43 Initial load
duke
parents:
diff changeset
     4
 *
90ce3da70b43 Initial load
duke
parents:
diff changeset
     5
 * This code is free software; you can redistribute it and/or modify it
90ce3da70b43 Initial load
duke
parents:
diff changeset
     6
 * under the terms of the GNU General Public License version 2 only, as
5506
202f599c92aa 6943119: Rebrand source copyright notices
ohair
parents: 4172
diff changeset
     7
 * published by the Free Software Foundation.  Oracle designates this
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
     8
 * particular file as subject to the "Classpath" exception as provided
5506
202f599c92aa 6943119: Rebrand source copyright notices
ohair
parents: 4172
diff changeset
     9
 * by Oracle in the LICENSE file that accompanied this code.
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
    10
 *
90ce3da70b43 Initial load
duke
parents:
diff changeset
    11
 * This code is distributed in the hope that it will be useful, but WITHOUT
90ce3da70b43 Initial load
duke
parents:
diff changeset
    12
 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
90ce3da70b43 Initial load
duke
parents:
diff changeset
    13
 * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
90ce3da70b43 Initial load
duke
parents:
diff changeset
    14
 * version 2 for more details (a copy is included in the LICENSE file that
90ce3da70b43 Initial load
duke
parents:
diff changeset
    15
 * accompanied this code).
90ce3da70b43 Initial load
duke
parents:
diff changeset
    16
 *
90ce3da70b43 Initial load
duke
parents:
diff changeset
    17
 * You should have received a copy of the GNU General Public License version
90ce3da70b43 Initial load
duke
parents:
diff changeset
    18
 * 2 along with this work; if not, write to the Free Software Foundation,
90ce3da70b43 Initial load
duke
parents:
diff changeset
    19
 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
90ce3da70b43 Initial load
duke
parents:
diff changeset
    20
 *
5506
202f599c92aa 6943119: Rebrand source copyright notices
ohair
parents: 4172
diff changeset
    21
 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
202f599c92aa 6943119: Rebrand source copyright notices
ohair
parents: 4172
diff changeset
    22
 * or visit www.oracle.com if you need additional information or have any
202f599c92aa 6943119: Rebrand source copyright notices
ohair
parents: 4172
diff changeset
    23
 * questions.
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
    24
 */
90ce3da70b43 Initial load
duke
parents:
diff changeset
    25
90ce3da70b43 Initial load
duke
parents:
diff changeset
    26
package java.util.logging;
90ce3da70b43 Initial load
duke
parents:
diff changeset
    27
90ce3da70b43 Initial load
duke
parents:
diff changeset
    28
import java.util.Enumeration;
90ce3da70b43 Initial load
duke
parents:
diff changeset
    29
import java.util.List;
90ce3da70b43 Initial load
duke
parents:
diff changeset
    30
import java.util.ArrayList;
90ce3da70b43 Initial load
duke
parents:
diff changeset
    31
90ce3da70b43 Initial load
duke
parents:
diff changeset
    32
/**
90ce3da70b43 Initial load
duke
parents:
diff changeset
    33
 * Logging is the implementation class of LoggingMXBean.
90ce3da70b43 Initial load
duke
parents:
diff changeset
    34
 *
32037
ab4526f4ac10 8133115: docs: replace <tt> tags (obsolete in html5) for java.util.logging, java.util.prefs, java.util.zip, java.util.jar
avstepan
parents: 25859
diff changeset
    35
 * The {@code LoggingMXBean} interface provides a standard
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
    36
 * method for management access to the individual
16098
9001e536ab4e 6664509: Add logging context
mchung
parents: 14014
diff changeset
    37
 * {@code Logger} objects available at runtime.
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
    38
 *
90ce3da70b43 Initial load
duke
parents:
diff changeset
    39
 * @author Ron Mann
90ce3da70b43 Initial load
duke
parents:
diff changeset
    40
 * @author Mandy Chung
90ce3da70b43 Initial load
duke
parents:
diff changeset
    41
 * @since 1.5
90ce3da70b43 Initial load
duke
parents:
diff changeset
    42
 *
90ce3da70b43 Initial load
duke
parents:
diff changeset
    43
 * @see javax.management
14014
da3648e13e67 8000269: Cleanup javadoc warnings
alanb
parents: 9035
diff changeset
    44
 * @see Logger
da3648e13e67 8000269: Cleanup javadoc warnings
alanb
parents: 9035
diff changeset
    45
 * @see LogManager
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
    46
 */
38370
61f46e1e7aee 8139982: Re-examine java.management dependency on java.util.logging.LoggingMXBean
dfuchs
parents: 32037
diff changeset
    47
@SuppressWarnings("deprecation") // implements LoggingMXBean
61f46e1e7aee 8139982: Re-examine java.management dependency on java.util.logging.LoggingMXBean
dfuchs
parents: 32037
diff changeset
    48
final class Logging implements LoggingMXBean {
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
    49
90ce3da70b43 Initial load
duke
parents:
diff changeset
    50
    private static LogManager logManager = LogManager.getLogManager();
90ce3da70b43 Initial load
duke
parents:
diff changeset
    51
90ce3da70b43 Initial load
duke
parents:
diff changeset
    52
    /** Constructor of Logging which is the implementation class
90ce3da70b43 Initial load
duke
parents:
diff changeset
    53
     *  of LoggingMXBean.
90ce3da70b43 Initial load
duke
parents:
diff changeset
    54
     */
38370
61f46e1e7aee 8139982: Re-examine java.management dependency on java.util.logging.LoggingMXBean
dfuchs
parents: 32037
diff changeset
    55
    private Logging() {
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
    56
    }
90ce3da70b43 Initial load
duke
parents:
diff changeset
    57
38370
61f46e1e7aee 8139982: Re-examine java.management dependency on java.util.logging.LoggingMXBean
dfuchs
parents: 32037
diff changeset
    58
    @Override
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
    59
    public List<String> getLoggerNames() {
21655
55f32ae4f920 8028229: Fix more raw types lint warning in core libraries
darcy
parents: 16100
diff changeset
    60
        Enumeration<String> loggers = logManager.getLoggerNames();
7803
56bc97d69d93 6880112: Project Coin: Port JDK core library code to use diamond operator
smarks
parents: 5506
diff changeset
    61
        ArrayList<String> array = new ArrayList<>();
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
    62
90ce3da70b43 Initial load
duke
parents:
diff changeset
    63
        for (; loggers.hasMoreElements();) {
21655
55f32ae4f920 8028229: Fix more raw types lint warning in core libraries
darcy
parents: 16100
diff changeset
    64
            array.add(loggers.nextElement());
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
    65
        }
90ce3da70b43 Initial load
duke
parents:
diff changeset
    66
        return array;
90ce3da70b43 Initial load
duke
parents:
diff changeset
    67
    }
90ce3da70b43 Initial load
duke
parents:
diff changeset
    68
90ce3da70b43 Initial load
duke
parents:
diff changeset
    69
    private static String EMPTY_STRING = "";
38370
61f46e1e7aee 8139982: Re-examine java.management dependency on java.util.logging.LoggingMXBean
dfuchs
parents: 32037
diff changeset
    70
    @Override
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
    71
    public String getLoggerLevel(String loggerName) {
90ce3da70b43 Initial load
duke
parents:
diff changeset
    72
        Logger l = logManager.getLogger(loggerName);
90ce3da70b43 Initial load
duke
parents:
diff changeset
    73
        if (l == null) {
90ce3da70b43 Initial load
duke
parents:
diff changeset
    74
            return null;
90ce3da70b43 Initial load
duke
parents:
diff changeset
    75
        }
90ce3da70b43 Initial load
duke
parents:
diff changeset
    76
90ce3da70b43 Initial load
duke
parents:
diff changeset
    77
        Level level = l.getLevel();
90ce3da70b43 Initial load
duke
parents:
diff changeset
    78
        if (level == null) {
90ce3da70b43 Initial load
duke
parents:
diff changeset
    79
            return EMPTY_STRING;
90ce3da70b43 Initial load
duke
parents:
diff changeset
    80
        } else {
16098
9001e536ab4e 6664509: Add logging context
mchung
parents: 14014
diff changeset
    81
            return level.getLevelName();
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
    82
        }
90ce3da70b43 Initial load
duke
parents:
diff changeset
    83
    }
90ce3da70b43 Initial load
duke
parents:
diff changeset
    84
38370
61f46e1e7aee 8139982: Re-examine java.management dependency on java.util.logging.LoggingMXBean
dfuchs
parents: 32037
diff changeset
    85
    @Override
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
    86
    public void setLoggerLevel(String loggerName, String levelName) {
90ce3da70b43 Initial load
duke
parents:
diff changeset
    87
        if (loggerName == null) {
90ce3da70b43 Initial load
duke
parents:
diff changeset
    88
            throw new NullPointerException("loggerName is null");
90ce3da70b43 Initial load
duke
parents:
diff changeset
    89
        }
90ce3da70b43 Initial load
duke
parents:
diff changeset
    90
90ce3da70b43 Initial load
duke
parents:
diff changeset
    91
        Logger logger = logManager.getLogger(loggerName);
90ce3da70b43 Initial load
duke
parents:
diff changeset
    92
        if (logger == null) {
90ce3da70b43 Initial load
duke
parents:
diff changeset
    93
            throw new IllegalArgumentException("Logger " + loggerName +
23882
7dbf42ed83ef 8009637: Some error messages are missing a space
igerasim
parents: 21655
diff changeset
    94
                " does not exist");
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
    95
        }
90ce3da70b43 Initial load
duke
parents:
diff changeset
    96
90ce3da70b43 Initial load
duke
parents:
diff changeset
    97
        Level level = null;
90ce3da70b43 Initial load
duke
parents:
diff changeset
    98
        if (levelName != null) {
90ce3da70b43 Initial load
duke
parents:
diff changeset
    99
            // parse will throw IAE if logLevel is invalid
16098
9001e536ab4e 6664509: Add logging context
mchung
parents: 14014
diff changeset
   100
            level = Level.findLevel(levelName);
9001e536ab4e 6664509: Add logging context
mchung
parents: 14014
diff changeset
   101
            if (level == null) {
9001e536ab4e 6664509: Add logging context
mchung
parents: 14014
diff changeset
   102
                throw new IllegalArgumentException("Unknown level \"" + levelName + "\"");
9001e536ab4e 6664509: Add logging context
mchung
parents: 14014
diff changeset
   103
            }
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
   104
        }
90ce3da70b43 Initial load
duke
parents:
diff changeset
   105
90ce3da70b43 Initial load
duke
parents:
diff changeset
   106
        logger.setLevel(level);
90ce3da70b43 Initial load
duke
parents:
diff changeset
   107
    }
90ce3da70b43 Initial load
duke
parents:
diff changeset
   108
38370
61f46e1e7aee 8139982: Re-examine java.management dependency on java.util.logging.LoggingMXBean
dfuchs
parents: 32037
diff changeset
   109
    @Override
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
   110
    public String getParentLoggerName( String loggerName ) {
90ce3da70b43 Initial load
duke
parents:
diff changeset
   111
        Logger l = logManager.getLogger( loggerName );
90ce3da70b43 Initial load
duke
parents:
diff changeset
   112
        if (l == null) {
90ce3da70b43 Initial load
duke
parents:
diff changeset
   113
            return null;
90ce3da70b43 Initial load
duke
parents:
diff changeset
   114
        }
90ce3da70b43 Initial load
duke
parents:
diff changeset
   115
90ce3da70b43 Initial load
duke
parents:
diff changeset
   116
        Logger p = l.getParent();
90ce3da70b43 Initial load
duke
parents:
diff changeset
   117
        if (p == null) {
90ce3da70b43 Initial load
duke
parents:
diff changeset
   118
            // root logger
90ce3da70b43 Initial load
duke
parents:
diff changeset
   119
            return EMPTY_STRING;
90ce3da70b43 Initial load
duke
parents:
diff changeset
   120
        } else {
90ce3da70b43 Initial load
duke
parents:
diff changeset
   121
            return p.getName();
90ce3da70b43 Initial load
duke
parents:
diff changeset
   122
        }
90ce3da70b43 Initial load
duke
parents:
diff changeset
   123
    }
38370
61f46e1e7aee 8139982: Re-examine java.management dependency on java.util.logging.LoggingMXBean
dfuchs
parents: 32037
diff changeset
   124
61f46e1e7aee 8139982: Re-examine java.management dependency on java.util.logging.LoggingMXBean
dfuchs
parents: 32037
diff changeset
   125
    static Logging getInstance() {
61f46e1e7aee 8139982: Re-examine java.management dependency on java.util.logging.LoggingMXBean
dfuchs
parents: 32037
diff changeset
   126
        return INSTANCE;
61f46e1e7aee 8139982: Re-examine java.management dependency on java.util.logging.LoggingMXBean
dfuchs
parents: 32037
diff changeset
   127
    }
61f46e1e7aee 8139982: Re-examine java.management dependency on java.util.logging.LoggingMXBean
dfuchs
parents: 32037
diff changeset
   128
61f46e1e7aee 8139982: Re-examine java.management dependency on java.util.logging.LoggingMXBean
dfuchs
parents: 32037
diff changeset
   129
    private static final Logging INSTANCE = new Logging();
61f46e1e7aee 8139982: Re-examine java.management dependency on java.util.logging.LoggingMXBean
dfuchs
parents: 32037
diff changeset
   130
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
   131
}