Source for java.util.logging.LoggingMXBean

   1: /* LoggingMxBean.java -- Management interface for logging
   2:    Copyright (C) 2006 Free Software Foundation, Inc.
   3: 
   4: This file is part of GNU Classpath.
   5: 
   6: GNU Classpath is free software; you can redistribute it and/or modify
   7: it under the terms of the GNU General Public License as published by
   8: the Free Software Foundation; either version 2, or (at your option)
   9: any later version.
  10: 
  11: GNU Classpath is distributed in the hope that it will be useful, but
  12: WITHOUT ANY WARRANTY; without even the implied warranty of
  13: MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  14: General Public License for more details.
  15: 
  16: You should have received a copy of the GNU General Public License
  17: along with GNU Classpath; see the file COPYING.  If not, write to the
  18: Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
  19: 02110-1301 USA.
  20: 
  21: Linking this library statically or dynamically with other modules is
  22: making a combined work based on this library.  Thus, the terms and
  23: conditions of the GNU General Public License cover the whole
  24: combination.
  25: 
  26: As a special exception, the copyright holders of this library give you
  27: permission to link this library with independent modules to produce an
  28: executable, regardless of the license terms of these independent
  29: modules, and to copy and distribute the resulting executable under
  30: terms of your choice, provided that you also meet, for each linked
  31: independent module, the terms and conditions of the license of that
  32: module.  An independent module is a module which is not derived from
  33: or based on this library.  If you modify this library, you may extend
  34: this exception to your version of the library, but you are not
  35: obligated to do so.  If you do not wish to do so, delete this
  36: exception statement from your version. */
  37: 
  38: 
  39: package java.util.logging;
  40: 
  41: import java.util.List;
  42: 
  43: /**
  44:  * This interface represents the management interface for logging.
  45:  * There is a single logging bean per VM instance, which can be
  46:  * retrieved via {@link LogManager#getLoggingMXBean()}.
  47:  * 
  48:  * @since 1.5
  49:  */
  50: public interface LoggingMXBean
  51: {
  52:   /**
  53:    * Return the name of the logging level given the name of
  54:    * a logger.  Returns null if no such logger exists.
  55:    * @param logger the logger's name
  56:    * @return the logging level's name, or null
  57:    */
  58:   String getLoggerLevel(String logger);
  59: 
  60:   /**
  61:    * Return a list of all logger names.
  62:    */
  63:   List<String> getLoggerNames();
  64: 
  65:   /**
  66:    * Return the name of the parent of the indicated logger.
  67:    * If no such logger exists, returns null.  If the logger
  68:    * is the root logger, returns the empty string.
  69:    * @param logger the logger's name
  70:    * @return the name of the logger's parent, or null
  71:    */
  72:   String getParentLoggerName(String logger);
  73: 
  74:   /**
  75:    * Sets the logging level for a particular logger.
  76:    * 
  77:    * @param logger the name of the logger
  78:    * @param level the name of the new logging level, or null
  79:    * @throws IllegalArgumentException if the level is not
  80:    * recognized, or if the logger does not exist
  81:    * @throws SecurityException if access is denied;
  82:    * see {@link Logger#setLevel(Level)}
  83:    */
  84:   void setLoggerLevel(String logger, String level);
  85: }