org.apache.logging.log4j.core.jmx

Class AppenderAdmin

java.lang.Object

org.apache.logging.log4j.core.jmx.AppenderAdmin

All Implemented Interfaces:

AppenderAdminMBean

public class AppenderAdmin
extends java.lang.Object
implements AppenderAdminMBean

Implementation of the AppenderAdminMBean interface.

Field Summary

Fields

Modifier and Type	Field and Description
private Appender	appender
private java.lang.String	contextName
private javax.management.ObjectName	objectName

Fields inherited from interface org.apache.logging.log4j.core.jmx.AppenderAdminMBean

PATTERN

Constructor Summary

Constructors

Constructor and Description
AppenderAdmin(java.lang.String contextName, Appender appender) Constructs a new AppenderAdmin with the specified contextName and appender.

Method Summary

Modifier and Type	Method and Description
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	getFilter() Returns a string description of all filters configured for the instrumented Appender.
java.lang.String	getLayout() Returns the result of calling toString on the Layout object of the instrumented Appender.
java.lang.String	getName() Returns the name of the instrumented Appender.
javax.management.ObjectName	getObjectName() Returns the ObjectName of this mbean.
boolean	isIgnoreExceptions() Returns how exceptions thrown on the instrumented Appender are handled.

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

appender

private final Appender appender

objectName

private final javax.management.ObjectName objectName

Constructor Detail

AppenderAdmin

public AppenderAdmin(java.lang.String contextName,
                     Appender appender)

Constructs a new AppenderAdmin with the specified contextName and 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

getName

public java.lang.String getName()

Description copied from interface: AppenderAdminMBean

Returns the name of the instrumented Appender.

Specified by:

getName in interface AppenderAdminMBean

Returns:

the name of the Appender

getLayout

public java.lang.String getLayout()

Description copied from interface: AppenderAdminMBean

Returns the result of calling toString on the Layout object of the instrumented Appender.

Specified by:

getLayout in interface AppenderAdminMBean

Returns:

the Layout of the instrumented Appender as a string

isIgnoreExceptions

public boolean isIgnoreExceptions()

Description copied from interface: AppenderAdminMBean

Returns how exceptions thrown on the instrumented Appender are handled.

Specified by:

isIgnoreExceptions in interface AppenderAdminMBean

Returns:

true if any exceptions thrown by the Appender will be logged or false if such exceptions are re-thrown.

getErrorHandler

public java.lang.String getErrorHandler()

Description copied from interface: AppenderAdminMBean

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 AppenderAdminMBean

Returns:

result of calling toString on the error handler of this appender, or "null"

getFilter

public java.lang.String getFilter()

Description copied from interface: AppenderAdminMBean

Returns a string description of all filters configured for the instrumented Appender.

Specified by:

getFilter in interface AppenderAdminMBean

Returns:

a string description of all configured filters for this appender