FileDocCategorySizeDatePackage
LoggingMXBean.javaAPI DocJava SE 5 API4366Fri Aug 26 14:57:28 BST 2005java.util.logging

LoggingMXBean

public interface LoggingMXBean
The management interface for the logging facility.

There is a single global instance of the LoggingMXBean. This instance is an MXBean can be obtained by calling the {@link LogManager#getLoggingMXBean} method or from the {@link java.lang.management.ManagementFactory#getPlatformMBeanServer platform MBeanServer} method.

The {@link javax.management.ObjectName ObjectName} for uniquely identifying the LoggingMXBean within an MBeanServer is:

{@link LogManager#LOGGING_MXBEAN_NAME java.util.logging:type=Logging}
see
java.lang.management.ManagementFactory
author
Ron Mann
author
Mandy Chung
version
1.7, 04/20/04
since
1.5

Fields Summary
Constructors Summary
Methods Summary
public java.lang.StringgetLoggerLevel(java.lang.String loggerName)
Gets the name of the log level associated with the specified logger. If the specified logger does not exist, null is returned. This method first finds the logger of the given name and then returns the name of the log level by calling:
{@link Logger#getLevel Logger.getLevel()}.{@link Level#getName getName()};

If the Level of the specified logger is null, 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 Logger 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 null. If the specified logger does not exist, null is returned.
see
Logger#getLevel

public java.util.ListgetLoggerNames()
Returns the list of currently registered loggers. This method calls {@link LogManager#getLoggerNames} and returns a list of the logger names.

return
A list of String each of which is a currently registered Logger name.

public java.lang.StringgetParentLoggerName(java.lang.String loggerName)
Returns the name of the parent for the specified logger. If the specified logger does not exist, null is returned. If the specified logger is the root Logger in the namespace, the result will be an empty string.

param
loggerName The name of a Logger.
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, null is returned.

public voidsetLoggerLevel(java.lang.String loggerName, java.lang.String levelName)
Sets the specified logger to the specified new level. If the levelName is not null, the level of the specified logger is set to the parsed Level matching the levelName. If the levelName is null, the level of the specified logger is set to null 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 Logger to be set. Must be non-null.
param
levelName The name of the level to set the specified logger to, or null if to set the level to inherit from its nearest ancestor.
throws
IllegalArgumentException if the specified logger does not exist, or levelName 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