/* LoggingMxBean.java -- Management interface for logging
   Copyright (C) 2006 Free Software Foundation, Inc.

This file is part of GNU Classpath.

GNU Classpath is free software; you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation; either version 2, or (at your option)
any later version.

GNU Classpath 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 for more details.

You should have received a copy of the GNU General Public License
along with GNU Classpath; see the file COPYING.  If not, write to the
Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
02110-1301 USA.

Linking this library statically or dynamically with other modules is
making a combined work based on this library.  Thus, the terms and
conditions of the GNU General Public License cover the whole
combination.

As a special exception, the copyright holders of this library give you
permission to link this library with independent modules to produce an
executable, regardless of the license terms of these independent
modules, and to copy and distribute the resulting executable under
terms of your choice, provided that you also meet, for each linked
independent module, the terms and conditions of the license of that
module.  An independent module is a module which is not derived from
or based on this library.  If you modify this library, you may extend
this exception to your version of the library, but you are not
obligated to do so.  If you do not wish to do so, delete this
exception statement from your version. */


package java.util.logging;

import java.util.List;

/**
 * This interface represents the management interface for logging.
 * There is a single logging bean per VM instance, which can be
 * retrieved via {@link LogManager#getLoggingMXBean()}.
 * 
 * @since 1.5
 */
public interface LoggingMXBean
{
  /**
   * Return the name of the logging level given the name of
   * a logger.  Returns null if no such logger exists.
   * @param logger the logger's name
   * @return the logging level's name, or null
   */
  String getLoggerLevel(String logger);

  /**
   * Return a list of all logger names.
   */
  List<String> getLoggerNames();

  /**
   * Return the name of the parent of the indicated logger.
   * If no such logger exists, returns null.  If the logger
   * is the root logger, returns the empty string.
   * @param logger the logger's name
   * @return the name of the logger's parent, or null
   */
  String getParentLoggerName(String logger);

  /**
   * Sets the logging level for a particular logger.
   * 
   * @param logger the name of the logger
   * @param level the name of the new logging level, or null
   * @throws IllegalArgumentException if the level is not
   * recognized, or if the logger does not exist
   * @throws SecurityException if access is denied;
   * see {@link Logger#setLevel(Level)}
   */
  void setLoggerLevel(String logger, String level);
}