AppenderSkeleton Class Reference

Inheritance diagram for AppenderSkeleton:

Inheritance graph
[legend]
Collaboration diagram for AppenderSkeleton:

Collaboration graph
[legend]
List of all members.

Public Member Functions

void finalize ()
void activateOptions ()
void setOption (const String &name, const String &value)
void addFilter (const spi::FilterPtr &newFilter)
void clearFilters ()
const spi::ErrorHandlerPtrgetErrorHandler () const
const spi::FilterPtrgetFilter () const
const spi::FilterPtrgetFirstFilter () const
const LayoutPtrgetLayout () const
const String & getName () const
const LevelPtrgetThreshold ()
bool isAsSevereAsThreshold (const LevelPtr &level) const
void doAppend (const spi::LoggingEventPtr &event)
void setErrorHandler (const spi::ErrorHandlerPtr &eh)
void setLayout (const LayoutPtr &layout)
void setName (const String &name)
void setThreshold (const LevelPtr &threshold)

Protected Member Functions

virtual void append (const spi::LoggingEventPtr &event)=0

Protected Attributes

LayoutPtr layout
String name
LevelPtr threshold
spi::ErrorHandlerPtr errorHandler
spi::FilterPtr headFilter
spi::FilterPtr tailFilter
bool closed

Detailed Description

Implementation base class for all appenders.

This class provides the code for common functionality, such as support for threshold filtering and support for general filters.


Member Function Documentation

void activateOptions (  )  [inline, virtual]

Derived appenders should override this method if option structure requires it.

Implements OptionHandler.

Reimplemented in ConsoleAppender, DailyRollingFileAppender, FileAppender, SMTPAppender, SocketAppender, SocketHubAppender, SyslogAppender, TelnetAppender, XMLSocketAppender, and NTEventLogAppender.

void addFilter ( const spi::FilterPtr newFilter  )  [virtual]

Add a filter to end of the filter list.

Implements Appender.

virtual void append ( const spi::LoggingEventPtr event  )  [protected, pure virtual]

Subclasses of AppenderSkeleton should implement this method to perform actual logging. See also AppenderSkeleton::doAppend method.

Implemented in AsyncAppender, ODBCAppender, SMTPAppender, SocketAppender, SocketHubAppender, SyslogAppender, TelnetAppender, XMLSocketAppender, NTEventLogAppender, and WriterAppender.

void clearFilters (  )  [virtual]

Clear the filters chain.

Implements Appender.

void doAppend ( const spi::LoggingEventPtr event  )  [virtual]

This method performs threshold checks and invokes filters before delegating actual logging to the subclasses specific AppenderSkeleton::append method.

Implements Appender.

void finalize (  ) 

Finalize this appender by calling the derived class' close method.

const spi::ErrorHandlerPtr& getErrorHandler (  )  const [inline, virtual]

Return the currently set spi::ErrorHandler for this Appender.

Implements Appender.

const spi::FilterPtr& getFilter (  )  const [inline, virtual]

Returns the head Filter.

Implements Appender.

const spi::FilterPtr& getFirstFilter (  )  const [inline]

Return the first filter in the filter chain for this Appender. The return value may be 0 if no is filter is set.

const LayoutPtr& getLayout (  )  const [inline, virtual]

Returns the layout of this appender. The value may be 0.

Implements Appender.

const String& getName (  )  const [inline, virtual]

Returns the name of this Appender.

Implements Appender.

const LevelPtr& getThreshold (  )  [inline]

Returns this appenders threshold level. See the setThreshold method for the meaning of this option.

bool isAsSevereAsThreshold ( const LevelPtr level  )  const

Check whether the message level is below the appender's threshold. If there is no threshold set, then the return value is always true.

void setErrorHandler ( const spi::ErrorHandlerPtr eh  )  [virtual]

Set the ErrorHandler for this Appender.

Implements Appender.

void setLayout ( const LayoutPtr layout  )  [inline, virtual]

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.

Implements Appender.

void setName ( const String &  name  )  [inline, virtual]

Set the name of this Appender.

Implements Appender.

void setOption ( const String &  name,
const String &  value 
) [inline, virtual]

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 activateOptions is called.

Implements OptionHandler.

Reimplemented in ConsoleAppender, DailyRollingFileAppender, ODBCAppender, FileAppender, SMTPAppender, SocketAppender, SocketHubAppender, SyslogAppender, TelnetAppender, XMLSocketAppender, NTEventLogAppender, and RollingFileAppender.

void setThreshold ( const LevelPtr threshold  ) 

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.


Member Data Documentation

bool closed [protected]

Is this appender closed?

spi::ErrorHandlerPtr errorHandler [protected]

It is assumed and enforced that errorHandler is never null.

spi::FilterPtr headFilter [protected]

The first filter in the filter chain. Set to null initially.

LayoutPtr layout [protected]

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

String name [protected]

Appenders are named.

spi::FilterPtr tailFilter [protected]

The last filter in the filter chain.

LevelPtr threshold [protected]

There is no level threshold filtering by default.


The documentation for this class was generated from the following files:
Generated on Wed Aug 16 10:25:31 2006 for log4cxx by  doxygen 1.4.7