Overview | Package | Class | Use | Tree | Deprecated | Index | Help
PREV CLASS NEXT CLASS | FRAMES NO FRAMES
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD

## org.apache.logging.log4j.core.jmx
Class Server

    java.lang.Object
      org.apache.logging.log4j.core.jmx.Server

    public final class Server

extends Object

Creates MBeans to instrument various classes in the log4j class hierarchy.

All instrumentation for Log4j 2 classes can be disabled by setting system property `-Dlog4j2.disable.jmx=true`.

Field Summary
`static String` | `DOMAIN` The domain part, or prefix ("org.apache.logging.log4j2" ) of the `ObjectName` of all MBeans that instrument Log4J2 components.

Method Summary
`static String` | `escape(String name)` Either returns the specified name as is, or returns a quoted value containing the specified name with the special characters (comma, equals, colon, quote, asterisk, or question mark) preceded with a backslash.
`static void` | `reregisterMBeansAfterReconfigure()`
`static void` | `reregisterMBeansAfterReconfigure(MBeanServer mbs)`
`static void` | `unregisterLoggerContext(String loggerContextName)` Unregisters all MBeans associated with the specified logger context (including MBeans for `LoggerConfig`s and `Appender`s from the platform MBean server.
`static void` | `unregisterLoggerContext(String contextName, MBeanServer mbs)` Unregisters all MBeans associated with the specified logger context (including MBeans for `LoggerConfig`s and `Appender`s from the platform MBean server.
`static void` | `unregisterMBeans()` Unregister all log4j MBeans from the platform MBean server.
`static void` | `unregisterMBeans(MBeanServer mbs)` Unregister all log4j MBeans from the specified MBean server.

Methods inherited from class java.lang.Object
`clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait`

Field Detail

### DOMAIN

    public static final String DOMAIN

  The domain part, or prefix ("org.apache.logging.log4j2" ) of the `ObjectName` of all MBeans that instrument Log4J2 components.

  See Also:
    Constant Field Values

Method Detail

### escape

    public static String escape(String name)

  Either returns the specified name as is, or returns a quoted value containing the specified name with the special characters (comma, equals, colon, quote, asterisk, or question mark) preceded with a backslash.

  Parameters:
    `name` - the name to escape so it can be used as a value in an `ObjectName`.
  Returns:
    the escaped name

### reregisterMBeansAfterReconfigure

    public static void reregisterMBeansAfterReconfigure()

### reregisterMBeansAfterReconfigure

    public static void reregisterMBeansAfterReconfigure(MBeanServer mbs)

### unregisterMBeans

    public static void unregisterMBeans()

  Unregister all log4j MBeans from the platform MBean server.

### unregisterMBeans

    public static void unregisterMBeans(MBeanServer mbs)

  Unregister all log4j MBeans from the specified MBean server.

  Parameters:
    `mbs` - the MBean server to unregister from.

### unregisterLoggerContext

    public static void unregisterLoggerContext(String loggerContextName)

  Unregisters all MBeans associated with the specified logger context (including MBeans for `LoggerConfig`s and `Appender`s from the platform MBean server.

  Parameters:
    `loggerContextName` - name of the logger context to unregister

### unregisterLoggerContext

    public static void unregisterLoggerContext(String contextName,
                                               MBeanServer mbs)

  Unregisters all MBeans associated with the specified logger context (including MBeans for `LoggerConfig`s and `Appender`s from the platform MBean server.

  Parameters:
    `contextName` - name of the logger context to unregister
    `mbs` - the MBean Server to unregister the instrumented objects from

Overview | Package | Class | Use | Tree | Deprecated | Index | Help
PREV CLASS NEXT CLASS | FRAMES NO FRAMES
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD

Copyright © 1999-2015 Apache Software Foundation. All Rights Reserved.
Apache Logging, Apache Log4j, Log4j, Apache, the Apache feather logo, the Apache Logging project logo, and the Apache Log4j logo are trademarks of The Apache Software Foundation.