Package org.apache.log4j
Class AppenderSkeleton
java.lang.Object
org.apache.log4j.AppenderSkeleton
- All Implemented Interfaces:
Appender,OptionHandler
- Direct Known Subclasses:
AsyncAppender,JDBCAppender,JMSAppender,NullAppender,RewriteAppender,SMTPAppender,SocketAppender,SocketHubAppender,SyslogAppender,TelnetAppender,WriterAppender
Abstract superclass of the other appenders in the package.
This class provides the code for common functionality, such as support for threshold filtering and support for general filters.
- Since:
- 0.8.1
- Author:
- Ceki Gülcü
-
Field Summary
FieldsModifier and TypeFieldDescriptionprotected booleanIs this appender closed?protected ErrorHandlerIt is assumed and enforced that errorHandler is never null.protected FilterThe first filter in the filter chain.protected LayoutThe layout variable does not need to be set if the appender implementation has its own layout.protected StringAppenders are named.protected FilterThe last filter in the filter chain.protected PriorityThere is no level threshold filtering by default. -
Constructor Summary
ConstructorsModifierConstructorDescriptionCreate new instance.protectedAppenderSkeleton(boolean isActive) Create new instance. -
Method Summary
Modifier and TypeMethodDescriptionvoidDerived appenders should override this method if option structure requires it.voidAdd a filter to end of the filter list.protected abstract voidappend(LoggingEvent event) Subclasses ofAppenderSkeletonshould implement this method to perform actual logging.voidClear the filters chain.voiddoAppend(LoggingEvent event) This method performs threshold checks and invokes filters before delegating actual logging to the subclasses specificappend(org.apache.log4j.spi.LoggingEvent)method.voidfinalize()Finalize this appender by calling the derived class'closemethod.Return the currently setErrorHandlerfor this Appender.Returns the head Filter.final FilterReturn the first filter in the filter chain for this Appender.Returns the layout of this appender.final StringgetName()Returns the name of this appender.Returns this appenders threshold level.booleanisAsSevereAsThreshold(Priority priority) Check whether the message level is below the appender's threshold.voidSet theErrorHandlerfor this Appender.voidSet the layout for this appender.voidSet the name of this Appender.voidsetThreshold(Priority threshold) Set the threshold level.Methods inherited from class java.lang.Object
clone, equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitMethods inherited from interface org.apache.log4j.Appender
close, requiresLayout
-
Field Details
-
layout
The layout variable does not need to be set if the appender implementation has its own layout. -
name
Appenders are named. -
threshold
There is no level threshold filtering by default. -
errorHandler
It is assumed and enforced that errorHandler is never null. -
headFilter
The first filter in the filter chain. Set tonullinitially. -
tailFilter
The last filter in the filter chain. -
closed
protected boolean closedIs this appender closed?
-
-
Constructor Details
-
AppenderSkeleton
public AppenderSkeleton()Create new instance. -
AppenderSkeleton
protected AppenderSkeleton(boolean isActive) Create new instance. Provided for compatibility with log4j 1.3.- Parameters:
isActive- true if appender is ready for use upon construction. Not used in log4j 1.2.x.- Since:
- 1.2.15
-
-
Method Details
-
activateOptions
public void activateOptions()Derived appenders should override this method if option structure requires it.- Specified by:
activateOptionsin interfaceOptionHandler
-
addFilter
Add a filter to end of the filter list. -
append
Subclasses ofAppenderSkeletonshould implement this method to perform actual logging. See alsoAppenderSkeleton.doAppendmethod.- Since:
- 0.9.0
-
clearFilters
public void clearFilters()Clear the filters chain.- Specified by:
clearFiltersin interfaceAppender- Since:
- 0.9.0
-
finalize
public void finalize()Finalize this appender by calling the derived class'closemethod. -
getErrorHandler
Return the currently setErrorHandlerfor this Appender.- Specified by:
getErrorHandlerin interfaceAppender- Since:
- 0.9.0
-
getFilter
Returns the head Filter. -
getFirstFilter
Return the first filter in the filter chain for this Appender. The return value may benullif no is filter is set. -
getLayout
Returns the layout of this appender. The value may be null. -
getName
Returns the name of this appender. -
getThreshold
Returns this appenders threshold level. See thesetThreshold(org.apache.log4j.Priority)method for the meaning of this option.- Since:
- 1.1
-
isAsSevereAsThreshold
Check whether the message level is below the appender's threshold. If there is no threshold set, then the return value is alwaystrue. -
doAppend
This method performs threshold checks and invokes filters before delegating actual logging to the subclasses specificappend(org.apache.log4j.spi.LoggingEvent)method. -
setErrorHandler
Set theErrorHandlerfor this Appender.- Specified by:
setErrorHandlerin interfaceAppender- Since:
- 0.9.0
-
setLayout
Set the layout for this appender. Note that some appenders have their own (fixed) layouts or do not use one. For example, theSocketAppenderignores the layout set here. -
setName
Set the name of this Appender. -
setThreshold
Set the threshold level. All log events with lower level than the threshold level are ignored by the appender.In configuration files this option is specified by setting the value of the Threshold option to a level string, such as "DEBUG", "INFO" and so on.
- Since:
- 0.8.3
-