public class AsyncAppenderAdmin extends Object implements AsyncAppenderAdminMBean
AsyncAppenderAdminMBean interface.PATTERN| Constructor and Description |
|---|
AsyncAppenderAdmin(String contextName,
AsyncAppender appender)
Constructs a new
AsyncAppenderAdmin with the specified contextName
and async appender. |
| Modifier and Type | Method and Description |
|---|---|
String[] |
getAppenderRefs()
Returns a String array with the appender refs configured for the
instrumented
AsyncAppender. |
String |
getErrorHandler()
Returns the result of calling
toString on the error handler of
this appender, or "null" if no error handler was set. |
String |
getErrorRef()
Returns the name of the appender that any errors are logged to or
null. |
String |
getFilter()
Returns a string description of all filters configured for the
instrumented
AsyncAppender. |
String |
getLayout()
Returns the result of calling
toString on the Layout
object of the instrumented AsyncAppender. |
String |
getName()
Returns the name of the instrumented
AsyncAppender. |
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. |
public AsyncAppenderAdmin(String contextName, AsyncAppender appender)
AsyncAppenderAdmin with the specified contextName
and async appender.contextName - used in the ObjectName for this mbeanappender - the instrumented objectpublic ObjectName getObjectName()
ObjectName of this mbean.ObjectNameAppenderAdminMBean.PATTERNpublic String getName()
AsyncAppenderAdminMBeanAsyncAppender.getName in interface AsyncAppenderAdminMBeanpublic String getLayout()
AsyncAppenderAdminMBeantoString on the Layout
object of the instrumented AsyncAppender.getLayout in interface AsyncAppenderAdminMBeanLayout of the instrumented AsyncAppender as a
stringpublic boolean isIgnoreExceptions()
AsyncAppenderAdminMBeanAsyncAppender
are handled.isIgnoreExceptions in interface AsyncAppenderAdminMBeantrue if any exceptions thrown by the AsyncAppender will
be logged or false if such exceptions are re-thrown.public String getErrorHandler()
AsyncAppenderAdminMBeantoString on the error handler of
this appender, or "null" if no error handler was set.getErrorHandler in interface AsyncAppenderAdminMBeantoString on the error handler of this
appender, or "null"public String getFilter()
AsyncAppenderAdminMBeanAsyncAppender.getFilter in interface AsyncAppenderAdminMBeanpublic String[] getAppenderRefs()
AsyncAppenderAdminMBeanAsyncAppender.getAppenderRefs in interface AsyncAppenderAdminMBeanAsyncAppender.public boolean isIncludeLocation()
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.isIncludeLocation in interface AsyncAppenderAdminMBeantrue if location is included with every event, false otherwisepublic boolean isBlocking()
true if this AsyncAppender will block when the queue is full,
or false if events are dropped when the queue is full.isBlocking in interface AsyncAppenderAdminMBeanpublic String getErrorRef()
null.getErrorRef in interface AsyncAppenderAdminMBeannullpublic int getQueueCapacity()
getQueueCapacity in interface AsyncAppenderAdminMBeanpublic int getQueueRemainingCapacity()
getQueueRemainingCapacity in interface AsyncAppenderAdminMBeanCopyright © 1999-2021 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.