java.util.logging
Interface 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 LogManager.getLoggingMXBean() sample code for java.util.logging.LogManager.getLoggingMXBean() definition code for java.util.logging.LogManager.getLoggingMXBean() method or from the platform MBeanServer sample code for java.lang.management.ManagementFactory.getPlatformMBeanServer() definition code for java.lang.management.ManagementFactory.getPlatformMBeanServer() method.

The ObjectName sample code for javax.management.ObjectName definition code for javax.management.ObjectName for uniquely identifying the LoggingMXBean within an MBeanServer is:

java.util.logging:type=Logging sample code for java.util.logging.LogManager.LOGGING_MXBEAN_NAME definition code for java.util.logging.LogManager.LOGGING_MXBEAN_NAME

Since:
1.5
See Also:
ManagementFactory sample code for java.lang.management.ManagementFactory definition code for java.lang.management.ManagementFactory

Method Summary
 String sample code for java.lang.String definition code for java.lang.String getLoggerLevel sample code for java.util.logging.LoggingMXBean.getLoggerLevel(java.lang.String) definition code for java.util.logging.LoggingMXBean.getLoggerLevel(java.lang.String) (String sample code for java.lang.String definition code for java.lang.String  loggerName)
          Gets the name of the log level associated with the specified logger.
 List sample code for java.util.List definition code for java.util.List <String sample code for java.lang.String definition code for java.lang.String > getLoggerNames sample code for java.util.logging.LoggingMXBean.getLoggerNames() definition code for java.util.logging.LoggingMXBean.getLoggerNames() ()
          Returns the list of currently registered loggers.
 String sample code for java.lang.String definition code for java.lang.String getParentLoggerName sample code for java.util.logging.LoggingMXBean.getParentLoggerName(java.lang.String) definition code for java.util.logging.LoggingMXBean.getParentLoggerName(java.lang.String) (String sample code for java.lang.String definition code for java.lang.String  loggerName)
          Returns the name of the parent for the specified logger.
 void setLoggerLevel sample code for java.util.logging.LoggingMXBean.setLoggerLevel(java.lang.String, java.lang.String) definition code for java.util.logging.LoggingMXBean.setLoggerLevel(java.lang.String, java.lang.String) (String sample code for java.lang.String definition code for java.lang.String  loggerName, String sample code for java.lang.String definition code for java.lang.String  levelName)
          Sets the specified logger to the specified new level.
 

Method Detail

getLoggerNames sample code for java.util.logging.LoggingMXBean.getLoggerNames() definition code for java.util.logging.LoggingMXBean.getLoggerNames()

List sample code for java.util.List definition code for java.util.List <String sample code for java.lang.String definition code for java.lang.String > getLoggerNames()
Returns the list of currently registered loggers. This method calls LogManager.getLoggerNames() sample code for java.util.logging.LogManager.getLoggerNames() definition code for java.util.logging.LogManager.getLoggerNames() and returns a list of the logger names.

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

getLoggerLevel sample code for java.util.logging.LoggingMXBean.getLoggerLevel(java.lang.String) definition code for java.util.logging.LoggingMXBean.getLoggerLevel(java.lang.String)

String sample code for java.lang.String definition code for java.lang.String  getLoggerLevel(String sample code for java.lang.String definition code for 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:
Logger.getLevel() sample code for java.util.logging.Logger.getLevel() definition code for java.util.logging.Logger.getLevel() .getName() sample code for java.util.logging.Level.getName() definition code for java.util.logging.Level.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.

Parameters:
loggerName - The name of the Logger to be retrieved.
Returns:
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 Also:
Logger.getLevel() sample code for java.util.logging.Logger.getLevel() definition code for java.util.logging.Logger.getLevel()

setLoggerLevel sample code for java.util.logging.LoggingMXBean.setLoggerLevel(java.lang.String, java.lang.String) definition code for java.util.logging.LoggingMXBean.setLoggerLevel(java.lang.String, java.lang.String)

void setLoggerLevel(String sample code for java.lang.String definition code for java.lang.String  loggerName,
                    String sample code for java.lang.String definition code for 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.

Parameters:
loggerName - The name of the Logger to be set. Must be non-null.
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 sample code for java.lang.IllegalArgumentException definition code for java.lang.IllegalArgumentException - if the specified logger does not exist, or levelName is not a valid level name.
SecurityException sample code for java.lang.SecurityException definition code for java.lang.SecurityException - if a security manager exists and if the caller does not have LoggingPermission("control").
See Also:
Logger.setLevel(java.util.logging.Level) sample code for java.util.logging.Logger.setLevel(java.util.logging.Level) definition code for java.util.logging.Logger.setLevel(java.util.logging.Level)

getParentLoggerName sample code for java.util.logging.LoggingMXBean.getParentLoggerName(java.lang.String) definition code for java.util.logging.LoggingMXBean.getParentLoggerName(java.lang.String)

String sample code for java.lang.String definition code for java.lang.String  getParentLoggerName(String sample code for java.lang.String definition code for 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.

Parameters:
loggerName - The name of a Logger.
Returns:
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.