Stay organized with collections
Save and categorize content based on your preferences.
LoggingMXBean
public
interface
LoggingMXBean
| java.util.logging.LoggingMXBean
|
The management interface for the logging facility.
There is a single global instance of the LoggingMXBean.
The javax.management.ObjectName ObjectName that uniquely identifies
the management interface for logging within the MBeanServer is:
java.util.logging:type=Logging
Summary
Public methods
getLoggerLevel
public abstract String getLoggerLevel (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().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 |
String: The name of the Logger to be retrieved. |
| Returns |
|---|
String |
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. |
getLoggerNames
public abstract List<String> getLoggerNames ()
Returns the list of currently registered logger names. This method
calls LogManager.getLoggerNames and returns a list
of the logger names.
| Returns |
|---|
List<String> |
A list of String each of which is a
currently registered Logger name. |
getParentLoggerName
public abstract String getParentLoggerName (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 |
String: The name of a Logger. |
| Returns |
|---|
String |
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. |
setLoggerLevel
public abstract void setLoggerLevel (String loggerName,
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 |
String: The name of the Logger to be set.
Must be non-null. |
levelName |
String: The name of the level to set on the specified logger,
or null if setting 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. |
SecurityException |
if a security manager exists and if
the caller does not have LoggingPermission("control"). |
Content and code samples on this page are subject to the licenses described in the Content License. Java and OpenJDK are trademarks or registered trademarks of Oracle and/or its affiliates.
Last updated 2025-02-10 UTC.
[null,null,["Last updated 2025-02-10 UTC."],[],[],null,["# LoggingMXBean\n\nAdded in [API level 1](/guide/topics/manifest/uses-sdk-element#ApiLevels) \n\nLoggingMXBean\n=============\n\n\n`\npublic\n\n\ninterface\nLoggingMXBean\n`\n\n\n`\n\n\n`\n\n|---------------------------------|\n| java.util.logging.LoggingMXBean |\n\n\u003cbr /\u003e\n\n*** ** * ** ***\n\nThe management interface for the logging facility.\n\nThere is a single global instance of the LoggingMXBean.\n\nThe `javax.management.ObjectName ObjectName` that uniquely identifies\nthe management interface for logging within the `MBeanServer` is: \n\n /reference/java/util/logging/LogManager#LOGGING_MXBEAN_NAME\n \n\u003cbr /\u003e\n\nSummary\n-------\n\n| ### Public methods ||\n|------------------------------------------------------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| ` abstract `[String](/reference/java/lang/String) | ` `[getLoggerLevel](/reference/java/util/logging/LoggingMXBean#getLoggerLevel(java.lang.String))`(`[String](/reference/java/lang/String)` loggerName) ` Gets the name of the log level associated with the specified logger. |\n| ` abstract `[List](/reference/java/util/List)`\u003c`[String](/reference/java/lang/String)`\u003e` | ` `[getLoggerNames](/reference/java/util/logging/LoggingMXBean#getLoggerNames())`() ` Returns the list of currently registered logger names. |\n| ` abstract `[String](/reference/java/lang/String) | ` `[getParentLoggerName](/reference/java/util/logging/LoggingMXBean#getParentLoggerName(java.lang.String))`(`[String](/reference/java/lang/String)` loggerName) ` Returns the name of the parent for the specified logger. |\n| ` abstract void` | ` `[setLoggerLevel](/reference/java/util/logging/LoggingMXBean#setLoggerLevel(java.lang.String,%20java.lang.String))`(`[String](/reference/java/lang/String)` loggerName, `[String](/reference/java/lang/String)` levelName) ` Sets the specified logger to the specified new level. |\n\nPublic methods\n--------------\n\n### getLoggerLevel\n\nAdded in [API level 1](/guide/topics/manifest/uses-sdk-element#ApiLevels) \n\n```\npublic abstract String getLoggerLevel (String loggerName)\n```\n\nGets the name of the log level associated with the specified logger.\nIf the specified logger does not exist, null\nis returned.\nThis method first finds the logger of the given name and\nthen returns the name of the log level by calling:\n\u003e [Logger.getLevel()](/reference/java/util/logging/Logger#getLevel()).[getName()](/reference/java/util/logging/Level#getName());\n\n\nIf the Level of the specified logger is null,\nwhich means that this logger's effective level is inherited\nfrom its parent, an empty string will be returned.\n\n\u003cbr /\u003e\n\n| Parameters ||\n|--------------|----------------------------------------------------------|\n| `loggerName` | `String`: The name of the Logger to be retrieved. \u003cbr /\u003e |\n\n| Returns ||\n|---------------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| [String](/reference/java/lang/String) | 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. \u003cbr /\u003e |\n\n**See also:**\n\n- [Logger.getLevel()](/reference/java/util/logging/Logger#getLevel()) \n\n### getLoggerNames\n\nAdded in [API level 1](/guide/topics/manifest/uses-sdk-element#ApiLevels) \n\n```\npublic abstract List\u003cString\u003e getLoggerNames ()\n```\n\nReturns the list of currently registered logger names. This method\ncalls [LogManager.getLoggerNames](/reference/java/util/logging/LogManager#getLoggerNames()) and returns a list\nof the logger names.\n\n\u003cbr /\u003e\n\n| Returns ||\n|------------------------------------------------------------------------------|------------------------------------------------------------------------------|\n| [List](/reference/java/util/List)`\u003c`[String](/reference/java/lang/String)`\u003e` | A list of String each of which is a currently registered Logger name. \u003cbr /\u003e |\n\n### getParentLoggerName\n\nAdded in [API level 1](/guide/topics/manifest/uses-sdk-element#ApiLevels) \n\n```\npublic abstract String getParentLoggerName (String loggerName)\n```\n\nReturns the name of the parent for the specified logger.\nIf the specified logger does not exist, null is returned.\nIf the specified logger is the root Logger in the namespace,\nthe result will be an empty string.\n\n\u003cbr /\u003e\n\n| Parameters ||\n|--------------|----------------------------------------|\n| `loggerName` | `String`: The name of a Logger. \u003cbr /\u003e |\n\n| Returns ||\n|---------------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| [String](/reference/java/lang/String) | 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. \u003cbr /\u003e |\n\n### setLoggerLevel\n\nAdded in [API level 1](/guide/topics/manifest/uses-sdk-element#ApiLevels) \n\n```\npublic abstract void setLoggerLevel (String loggerName, \n String levelName)\n```\n\nSets the specified logger to the specified new level.\nIf the levelName is not null, the level\nof the specified logger is set to the parsed Level\nmatching the levelName.\nIf the levelName is null, the level\nof the specified logger is set to null and\nthe effective level of the logger is inherited from\nits nearest ancestor with a specific (non-null) level value.\n\n\u003cbr /\u003e\n\n| Parameters ||\n|--------------|-------------------------------------------------------------------------------------------------------------------------------------------|\n| `loggerName` | `String`: The name of the Logger to be set. Must be non-null. \u003cbr /\u003e |\n| `levelName` | `String`: The name of the level to set on the specified logger, or null if setting the level to inherit from its nearest ancestor. \u003cbr /\u003e |\n\n| Throws ||\n|---------------------------------------------------------------------------|--------------------------------------------------------------------------------------------|\n| [IllegalArgumentException](/reference/java/lang/IllegalArgumentException) | if the specified logger does not exist, or levelName is not a valid level name. |\n| [SecurityException](/reference/java/lang/SecurityException) | if a security manager exists and if the caller does not have LoggingPermission(\"control\"). |\n\n**See also:**\n\n- [Logger.setLevel(Level)](/reference/java/util/logging/Logger#setLevel(java.util.logging.Level))"]]
