-
- All Superinterfaces:
PlatformManagedObject
public interface PlatformLoggingMXBean extends PlatformManagedObject
The management interface for the logging facility.There is a single global instance of the
PlatformLoggingMXBean. TheManagementFactory.getPlatformMXBeanmethod can be used to obtain thePlatformLoggingMXBeanobject as follows:PlatformLoggingMXBean logging = ManagementFactory.getPlatformMXBean(PlatformLoggingMXBean.class);ThePlatformLoggingMXBeanobject is also registered with the platform MBeanServer. TheObjectNamefor uniquely identifying thePlatformLoggingMXBeanwithin an MBeanServer is:java.util.logging:type=Logging- Since:
- 1.7
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description StringgetLoggerLevel(String loggerName)Gets the name of the log level associated with the specified logger.List<String>getLoggerNames()Returns the list of the currently registered logger names.StringgetParentLoggerName(String loggerName)Returns the name of the parent for the specified logger.voidsetLoggerLevel(String loggerName, String levelName)Sets the specified logger to the specified new level.-
Methods declared in interface java.lang.management.PlatformManagedObject
getObjectName
-
-
-
-
Method Detail
-
getLoggerNames
List<String> getLoggerNames()
Returns the list of the currently registered logger names. This method callsLogManager.getLoggerNames()and returns a list of the logger names.- Returns:
- A list of
Stringeach of which is a currently registeredLoggername.
-
getLoggerLevel
String getLoggerLevel(String loggerName)
Gets the name of the log level associated with the specified logger. If the specified logger does not exist,nullis returned. This method first finds the logger of the given name and then returns the name of the log level by calling:Logger.getLevel().getName();If the
Levelof the specified logger isnull, which means that this logger's effective level is inherited from its parent, an empty string will be returned.- Parameters:
loggerName- The name of theLoggerto 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,nullis returned. - See Also:
Logger.getLevel()
-
setLoggerLevel
void setLoggerLevel(String loggerName, String levelName)
Sets the specified logger to the specified new level. If thelevelNameis notnull, the level of the specified logger is set to the parsedLevelmatching thelevelName. If thelevelNameisnull, the level of the specified logger is set tonulland the effective level of the logger is inherited from its nearest ancestor with a specific (non-null) level value.- Parameters:
loggerName- The name of theLoggerto be set. Must be non-null.levelName- The name of the level to set on the specified logger, ornullif setting the level to inherit from its nearest ancestor.- Throws:
IllegalArgumentException- if the specified logger does not exist, orlevelNameis not a valid level name.SecurityException- if a security manager exists and if the caller does not have LoggingPermission("control").- See Also:
Logger.setLevel(java.util.logging.Level)
-
getParentLoggerName
String getParentLoggerName(String loggerName)
Returns the name of the parent for the specified logger. If the specified logger does not exist,nullis returned. If the specified logger is the rootLoggerin the namespace, the result will be an empty string.- Parameters:
loggerName- The name of aLogger.- 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,
nullis returned.
-
-