Package org.apache.logging.log4j.core.jmx

Class AsyncAppenderAdmin

    • Constructor Summary

      Constructors 
      Constructor Description
      AsyncAppenderAdmin​(java.lang.String contextName, AsyncAppender appender)
      Constructs a new AsyncAppenderAdmin with the specified contextName and async appender.

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      java.lang.String[] getAppenderRefs()
      Returns a String array with the appender refs configured for the instrumented AsyncAppender.
      java.lang.String getErrorHandler()
      Returns the result of calling toString on the error handler of this appender, or "null" if no error handler was set.
      java.lang.String getErrorRef()
      Returns the name of the appender that any errors are logged to or null.
      java.lang.String getFilter()
      Returns a string description of all filters configured for the instrumented AsyncAppender.
      java.lang.String getLayout()
      Returns the result of calling toString on the Layout object of the instrumented AsyncAppender.
      java.lang.String getName()
      Returns the name of the instrumented AsyncAppender.
      javax.management.ObjectName getObjectName()
      Returns the ObjectName of this mbean.
      int getQueueCapacity()  
      int getQueueRemainingCapacity()  
      boolean isBlocking()
      Returns true if this AsyncAppender will block when the queue is full, or false if events are dropped when the queue is full.
      boolean isIgnoreExceptions()
      Returns how exceptions thrown on the instrumented AsyncAppender are handled.
      boolean isIncludeLocation()
      Returns true if this AsyncAppender will take a snapshot of the stack with every log event to determine the class and method where the logging call was made.

      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

    • Field Detail

      • contextName

        private final java.lang.String contextName

      • objectName

        private final javax.management.ObjectName objectName

    • Constructor Detail

      • AsyncAppenderAdmin

        public AsyncAppenderAdmin​(java.lang.String contextName,
                          AsyncAppender appender)
        Constructs a new AsyncAppenderAdmin with the specified contextName and async appender.
        Parameters:
        contextName - used in the ObjectName for this mbean
        appender - the instrumented object

    • Method Detail

      • getObjectName

        public javax.management.ObjectName getObjectName()
        Returns the ObjectName of this mbean.
        Returns:
        the ObjectName
        See Also:
        AppenderAdminMBean.PATTERN

      • getLayout

        public java.lang.String getLayout()
        Description copied from interface: AsyncAppenderAdminMBean
        Returns the result of calling toString on the Layout object of the instrumented AsyncAppender.
        Specified by:
        getLayout in interface AsyncAppenderAdminMBean
        Returns:
        the Layout of the instrumented AsyncAppender as a string

      • isIgnoreExceptions

        public boolean isIgnoreExceptions()
        Description copied from interface: AsyncAppenderAdminMBean
        Returns how exceptions thrown on the instrumented AsyncAppender are handled.
        Specified by:
        isIgnoreExceptions in interface AsyncAppenderAdminMBean
        Returns:
        true if any exceptions thrown by the AsyncAppender will be logged or false if such exceptions are re-thrown.

      • getErrorHandler

        public java.lang.String getErrorHandler()
        Description copied from interface: AsyncAppenderAdminMBean
        Returns the result of calling toString on the error handler of this appender, or "null" if no error handler was set.
        Specified by:
        getErrorHandler in interface AsyncAppenderAdminMBean
        Returns:
        result of calling toString on the error handler of this appender, or "null"

      • getFilter

        public java.lang.String getFilter()
        Description copied from interface: AsyncAppenderAdminMBean
        Returns a string description of all filters configured for the instrumented AsyncAppender.
        Specified by:
        getFilter in interface AsyncAppenderAdminMBean
        Returns:
        a string description of all configured filters for this appender

      • getAppenderRefs

        public java.lang.String[] getAppenderRefs()
        Description copied from interface: AsyncAppenderAdminMBean
        Returns a String array with the appender refs configured for the instrumented AsyncAppender.
        Specified by:
        getAppenderRefs in interface AsyncAppenderAdminMBean
        Returns:
        the appender refs for the instrumented AsyncAppender.

      • isIncludeLocation

        public boolean isIncludeLocation()
        Returns true if this AsyncAppender will take a snapshot of the stack with every log event to determine the class and method where the logging call was made.
        Specified by:
        isIncludeLocation in interface AsyncAppenderAdminMBean
        Returns:
        true if location is included with every event, false otherwise

      • isBlocking

        public boolean isBlocking()
        Returns true if this AsyncAppender will block when the queue is full, or false if events are dropped when the queue is full.
        Specified by:
        isBlocking in interface AsyncAppenderAdminMBean
        Returns:
        whether this AsyncAppender will block or drop events when the queue is full.

      • getErrorRef

        public java.lang.String getErrorRef()
        Returns the name of the appender that any errors are logged to or null.
        Specified by:
        getErrorRef in interface AsyncAppenderAdminMBean
        Returns:
        the name of the appender that any errors are logged to or null