001/* LoggingMxBean.java -- Management interface for logging 002 Copyright (C) 2006 Free Software Foundation, Inc. 003 004This file is part of GNU Classpath. 005 006GNU Classpath is free software; you can redistribute it and/or modify 007it under the terms of the GNU General Public License as published by 008the Free Software Foundation; either version 2, or (at your option) 009any later version. 010 011GNU Classpath is distributed in the hope that it will be useful, but 012WITHOUT ANY WARRANTY; without even the implied warranty of 013MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU 014General Public License for more details. 015 016You should have received a copy of the GNU General Public License 017along with GNU Classpath; see the file COPYING. If not, write to the 018Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 01902110-1301 USA. 020 021Linking this library statically or dynamically with other modules is 022making a combined work based on this library. Thus, the terms and 023conditions of the GNU General Public License cover the whole 024combination. 025 026As a special exception, the copyright holders of this library give you 027permission to link this library with independent modules to produce an 028executable, regardless of the license terms of these independent 029modules, and to copy and distribute the resulting executable under 030terms of your choice, provided that you also meet, for each linked 031independent module, the terms and conditions of the license of that 032module. An independent module is a module which is not derived from 033or based on this library. If you modify this library, you may extend 034this exception to your version of the library, but you are not 035obligated to do so. If you do not wish to do so, delete this 036exception statement from your version. */ 037 038 039package java.util.logging; 040 041import java.util.List; 042 043/** 044 * This interface represents the management interface for logging. 045 * There is a single logging bean per VM instance, which can be 046 * retrieved via {@link LogManager#getLoggingMXBean()}. 047 * 048 * @since 1.5 049 */ 050public interface LoggingMXBean 051{ 052 /** 053 * Return the name of the logging level given the name of 054 * a logger. Returns null if no such logger exists. 055 * @param logger the logger's name 056 * @return the logging level's name, or null 057 */ 058 String getLoggerLevel(String logger); 059 060 /** 061 * Return a list of all logger names. 062 */ 063 List<String> getLoggerNames(); 064 065 /** 066 * Return the name of the parent of the indicated logger. 067 * If no such logger exists, returns null. If the logger 068 * is the root logger, returns the empty string. 069 * @param logger the logger's name 070 * @return the name of the logger's parent, or null 071 */ 072 String getParentLoggerName(String logger); 073 074 /** 075 * Sets the logging level for a particular logger. 076 * 077 * @param logger the name of the logger 078 * @param level the name of the new logging level, or null 079 * @throws IllegalArgumentException if the level is not 080 * recognized, or if the logger does not exist 081 * @throws SecurityException if access is denied; 082 * see {@link Logger#setLevel(Level)} 083 */ 084 void setLoggerLevel(String logger, String level); 085}