/*

 * Copyright (c) 2003, 2011, Oracle and/or its affiliates. All rights reserved.

 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.

 *

 * This code is free software; you can redistribute it and/or modify it

 * under the terms of the GNU General Public License version 2 only, as

 * published by the Free Software Foundation.  Oracle designates this

 * particular file as subject to the "Classpath" exception as provided

 * by Oracle in the LICENSE file that accompanied this code.

 *

 * This code is distributed in the hope that it will be useful, but WITHOUT

 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or

 * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License

 * version 2 for more details (a copy is included in the LICENSE file that

 * accompanied this code).

 *

 * You should have received a copy of the GNU General Public License version

 * 2 along with this work; if not, write to the Free Software Foundation,

 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.

 *

 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA

 * or visit www.oracle.com if you need additional information or have any

 * questions.

 */

package java.util.logging;

/**

 * The management interface for the logging facility. It is recommended

 * to use the {@link java.lang.management.PlatformLoggingMXBean} management

 * interface that implements all attributes defined in this

 * {@code LoggingMXBean}.  The

 * {@link java.lang.management.ManagementFactory#getPlatformMXBean(Class)

 * ManagementFactory.getPlatformMXBean} method can be used to obtain

 * the {@code PlatformLoggingMXBean} object representing the management

 * interface for logging.

 *

 * <p>There is a single global instance of the <tt>LoggingMXBean</tt>.

 * This instance is an {@link javax.management.MXBean MXBean} that

 * can be obtained by calling the {@link LogManager#getLoggingMXBean}

 * method or from the

 * {@linkplain java.lang.management.ManagementFactory#getPlatformMBeanServer

 * platform <tt>MBeanServer</tt>}.

 * <p>

 * The {@link javax.management.ObjectName ObjectName} that uniquely identifies

 * the management interface for logging within the {@code MBeanServer} is:

 * <pre>

 *    {@link LogManager#LOGGING_MXBEAN_NAME java.util.logging:type=Logging}

 * </pre>

 * <p>

 * The instance registered in the platform {@code MBeanServer}

 * is also a {@link java.lang.management.PlatformLoggingMXBean}.

 *

 * @author  Ron Mann

 * @author  Mandy Chung

 * @since   1.5

 *

 * @see java.lang.management.PlatformLoggingMXBean

 */

public interface LoggingMXBean {

    /**

     * Returns the list of currently registered logger names. This method

     * calls {@link LogManager#getLoggerNames} and returns a list

     * of the logger names.

     *

     * @return A list of <tt>String</tt> each of which is a

     *         currently registered <tt>Logger</tt> name.

     */

    public java.util.List<String> getLoggerNames();

    /**

     * Gets the name of the log level associated with the specified logger.

     * If the specified logger does not exist, <tt>null</tt>

     * is returned.

     * This method first finds the logger of the given name and

     * then returns the name of the log level by calling:

     * <blockquote>

     *   {@link Logger#getLevel Logger.getLevel()}.{@link Level#getName getName()};

     * </blockquote>

     *

     * <p>

     * If the <tt>Level</tt> of the specified logger is <tt>null</tt>,

     * which means that this logger's effective level is inherited

     * from its parent, an empty string will be returned.

     *

     * @param loggerName The name of the <tt>Logger</tt> to be retrieved.

     *

     * @return The name of the log level of the specified logger; or

     *         an empty string if the log level of the specified logger

     *         is <tt>null</tt>.  If the specified logger does not

     *         exist, <tt>null</tt> is returned.

     *

     * @see Logger#getLevel

     */

    public String getLoggerLevel(String loggerName);

    /**

     * Sets the specified logger to the specified new level.

     * If the <tt>levelName</tt> is not <tt>null</tt>, the level

     * of the specified logger is set to the parsed <tt>Level</tt>

     * matching the <tt>levelName</tt>.

     * If the <tt>levelName</tt> is <tt>null</tt>, the level

     * of the specified logger is set to <tt>null</tt> and

     * the effective level of the logger is inherited from

     * its nearest ancestor with a specific (non-null) level value.

     *

     * @param loggerName The name of the <tt>Logger</tt> to be set.

     *                   Must be non-null.

     * @param levelName The name of the level to set on the specified logger,

     *                 or <tt>null</tt> if setting the level to inherit

     *                 from its nearest ancestor.

     *

     * @throws IllegalArgumentException if the specified logger

     * does not exist, or <tt>levelName</tt> is not a valid level name.

     *

     * @throws SecurityException if a security manager exists and if

     * the caller does not have LoggingPermission("control").

     *

     * @see Logger#setLevel

     */

    public void setLoggerLevel(String loggerName, String levelName);

    /**

     * Returns the name of the parent for the specified logger.

     * If the specified logger does not exist, <tt>null</tt> is returned.

     * If the specified logger is the root <tt>Logger</tt> in the namespace,

     * the result will be an empty string.

     *

     * @param loggerName The name of a <tt>Logger</tt>.

     *

     * @return the name of the nearest existing parent logger;

     *         an empty string if the specified logger is the root logger.

     *         If the specified logger does not exist, <tt>null</tt>

     *         is returned.

     */

    public String getParentLoggerName(String loggerName);

}