FilterSkeleton ClassApache log4net™ SDK Documentation
Subclass this type to implement customized logging event filtering
Inheritance Hierarchy

SystemObject
  log4net.FilterFilterSkeleton
    log4net.FilterDenyAllFilter
    log4net.FilterLevelMatchFilter
    log4net.FilterLevelRangeFilter
    log4net.FilterLoggerMatchFilter
    log4net.FilterStringMatchFilter

Namespace: log4net.Filter
Assembly: log4net (in log4net.dll) Version: 2.0.8.0-.NET 4.0
Syntax

public abstract class FilterSkeleton : IFilter, 
	IOptionHandler

The FilterSkeleton type exposes the following members.

Constructors

  NameDescription
Protected methodFilterSkeleton
Initializes a new instance of the FilterSkeleton class
Top
Properties

  NameDescription
Public propertyNext
Property to get and set the next filter
Top
Methods

  NameDescription
Public methodActivateOptions
Initialize the filter with the options set
Public methodDecide
Decide if the LoggingEvent should be logged through an appender.
Public methodEquals
Determines whether the specified Object is equal to the current Object.
(Inherited from Object.)
Protected methodFinalize
Allows an Object to attempt to free resources and perform other cleanup operations before the Object is reclaimed by garbage collection.
(Inherited from Object.)
Public methodGetHashCode
Serves as a hash function for a particular type.
(Inherited from Object.)
Public methodGetType
Gets the Type of the current instance.
(Inherited from Object.)
Protected methodMemberwiseClone
Creates a shallow copy of the current Object.
(Inherited from Object.)
Public methodToString
Returns a String that represents the current Object.
(Inherited from Object.)
Top
Remarks

Users should extend this class to implement customized logging event filtering. Note that Logger and AppenderSkeleton, the parent class of all standard appenders, have built-in filtering rules. It is suggested that you first use and understand the built-in rules before rushing to write your own custom filters.

This abstract class assumes and also imposes that filters be organized in a linear chain. The Decide(LoggingEvent) method of each filter is called sequentially, in the order of their addition to the chain.

The Decide(LoggingEvent) method must return one of the integer constants Deny, Neutral or Accept.

If the value Deny is returned, then the log event is dropped immediately without consulting with the remaining filters.

If the value Neutral is returned, then the next filter in the chain is consulted. If there are no more filters in the chain, then the log event is logged. Thus, in the presence of no filters, the default behavior is to log all logging events.

If the value Accept is returned, then the log event is logged without consulting the remaining filters.

The philosophy of log4net filters is largely inspired from the Linux ipchains.

See Also

Reference