Log4j 1.1.3

org.apache.log4j
Class AppenderSkeleton

java.lang.Object
  |
  +--org.apache.log4j.AppenderSkeleton
All Implemented Interfaces:
Appender, OptionHandler
Direct Known Subclasses:
AsyncAppender, JMSAppender, NTEventLogAppender, NullAppender, SMTPAppender, SocketAppender, SyslogAppender, WriterAppender

public abstract class AppenderSkeleton
extends Object
implements Appender, OptionHandler

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
protected  boolean closed
          Is this appender closed?
protected  ErrorHandler errorHandler
          It is assumed and enforced that errorHandler is never null.
protected  Filter headFilter
          The first filter in the filter chain.
protected  Layout layout
          The layout variable does not need to be set if the appender implementation has its own layout.
protected  String name
          Appenders are named.
protected  Filter tailFilter
          The last filter in the filter chain.
protected  Priority threshold
          There is no priority threshold filtering by default.
static String THRESHOLD_OPTION
          Deprecated. Options are now handled using the JavaBeans paradigm. This constant is not longer needed and will be removed in the near term.
 
Constructor Summary
AppenderSkeleton()
           
 
Method Summary
 void activateOptions()
          Derived appenders should override this method if option structure requires it.
 void addFilter(Filter newFilter)
          Add a filter to end of the filter list.
protected abstract  void append(LoggingEvent event)
          Subclasses of AppenderSkeleton should implement this method to perform actual logging.
 void clearFilters()
          Clear the filters chain.
 void doAppend(LoggingEvent event)
          This method performs threshold checks and invokes filters before delegating actual logging to the subclasses specific append(org.apache.log4j.spi.LoggingEvent) method.
 void finalize()
          Finalize this appender by calling the imlenentation's close method.
 ErrorHandler getErrorHandler()
          Return the currently set ErrorHandler for this Appender.
 Filter getFilter()
          Returns the head Filter.
 Filter getFirstFilter()
          Return the first filter in the filter chain for this Appender.
 Layout getLayout()
          Returns the layout of this appender.
 String getName()
          Returns the name of this FileAppender.
 String[] getOptionStrings()
          Deprecated. We now use JavaBeans introspection to configure components. Options strings are no longer needed.
 Priority getThreshold()
          Returns this appenders threshold priority.
 boolean isAsSevereAsThreshold(Priority priority)
          Check whether the message priority is below the appender's threshold.
 void setErrorHandler(ErrorHandler eh)
          Set the ErrorHandler for this Appender.
 void setLayout(Layout layout)
          Set the layout for this appender.
 void setName(String name)
          Set the name of this Appender.
 void setOption(String key, String value)
          Set option to value.
 void setThreshold(Priority threshold)
          Set the threshold priority.
 
Methods inherited from class java.lang.Object
clone, equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 
Methods inherited from interface org.apache.log4j.Appender
close, requiresLayout
 

Field Detail

THRESHOLD_OPTION

public static final String THRESHOLD_OPTION
Deprecated. Options are now handled using the JavaBeans paradigm. This constant is not longer needed and will be removed in the near term.

A string constant used in naming the option for setting the threshold for the appender. See also setThreshold method. Current value of this string constant is Threshold.

layout

protected Layout layout
The layout variable does not need to be set if the appender implementation has its own layout.

name

protected String name
Appenders are named.

threshold

protected Priority threshold
There is no priority threshold filtering by default.

errorHandler

protected ErrorHandler errorHandler
It is assumed and enforced that errorHandler is never null.

headFilter

protected Filter headFilter
The first filter in the filter chain. Set to null initially.

tailFilter

protected Filter tailFilter
The last filter in the filter chain.

closed

protected boolean closed
Is this appender closed?
Constructor Detail

AppenderSkeleton

public AppenderSkeleton()
Method Detail

activateOptions

public void activateOptions()
Derived appenders should override this method if option structure requires it.
Specified by:
activateOptions in interface OptionHandler

addFilter

public void addFilter(Filter newFilter)
Add a filter to end of the filter list.
Specified by:
addFilter in interface Appender
Since:
0.9.0

append

protected abstract void append(LoggingEvent event)
Subclasses of AppenderSkeleton should implement this method to perform actual logging. See also AppenderSkeleton.doAppend method.
Since:
0.9.0

clearFilters

public void clearFilters()
Clear the filters chain.
Specified by:
clearFilters in interface Appender
Since:
0.9.0

finalize

public void finalize()
Finalize this appender by calling the imlenentation's close method.
Overrides:
finalize in class Object
Since:
0.8.4

getErrorHandler

public ErrorHandler getErrorHandler()
Return the currently set ErrorHandler for this Appender.
Specified by:
getErrorHandler in interface Appender
Since:
0.9.0

getFilter

public Filter getFilter()
Returns the head Filter.
Specified by:
getFilter in interface Appender
Since:
1.1

getFirstFilter

public final Filter getFirstFilter()
Return the first filter in the filter chain for this Appender. The return value may be null if no is filter is set.

getLayout

public Layout getLayout()
Returns the layout of this appender. The value may be null.
Specified by:
getLayout in interface Appender

getName

public final String getName()
Returns the name of this FileAppender.
Specified by:
getName in interface Appender

getOptionStrings

public String[] getOptionStrings()
Deprecated. We now use JavaBeans introspection to configure components. Options strings are no longer needed.

Returns the string array {THRESHOLD_OPTION}.

Configurable appenders must override this method to return the additional options they accept.

Specified by:
getOptionStrings in interface OptionHandler

getThreshold

public Priority getThreshold()
Returns this appenders threshold priority. See the setThreshold(org.apache.log4j.Priority) method for the meaning of this option.
Since:
1.1

isAsSevereAsThreshold

public boolean isAsSevereAsThreshold(Priority priority)
Check whether the message priority is below the appender's threshold. If there is no threshold set, then the return value is always true.

doAppend

public void doAppend(LoggingEvent event)
This method performs threshold checks and invokes filters before delegating actual logging to the subclasses specific append(org.apache.log4j.spi.LoggingEvent) method.
Specified by:
doAppend in interface Appender

setErrorHandler

public void setErrorHandler(ErrorHandler eh)
Set the ErrorHandler for this Appender.
Specified by:
setErrorHandler in interface Appender
Since:
0.9.0

setLayout

public void setLayout(Layout layout)
Set the layout for this appender. Note that some appenders have their own (fixed) layouts or do not use one. For example, the SocketAppender ignores the layout set here.
Specified by:
setLayout in interface Appender

setName

public void setName(String name)
Set the name of this Appender.
Specified by:
setName in interface Appender

setOption

public void setOption(String key,
                      String value)
Deprecated. Use the setter method for the option directly instead of the generic setOption method.

Description copied from interface: OptionHandler
Set option to value.

The handling of each option depends on the OptionHandler instance. Some options may become active immediately whereas other may be activated only when OptionHandler.activateOptions() is called.

Specified by:
setOption in interface OptionHandler

setThreshold

public void setThreshold(Priority threshold)
Set the threshold priority. All log events with lower priority than the threshold priority are ignored by the appender.

In configuration files this option is specified by setting the value of the Threshold option to a priority string, such as "DEBUG", "INFO" and so on.

Since:
0.8.3

Log4j 1.1.3

Please notify me about new log4j releases.