Log4j 1.3alpha-7

org.apache.log4j.rolling
Class FilterBasedTriggeringPolicy

java.lang.Object
  extended byorg.apache.log4j.rolling.FilterBasedTriggeringPolicy
All Implemented Interfaces:
OptionHandler, TriggeringPolicy

public final class FilterBasedTriggeringPolicy
extends Object
implements TriggeringPolicy

FilterBasedTriggeringPolicy determines if rolling should be triggered by evaluating the current message against a set of filters. Unless a filter rejects a message, a rolling event will be triggered.

Since:
1.3
Author:
Curt Arnold

Constructor Summary
FilterBasedTriggeringPolicy()
          Creates a new FilterBasedTriggeringPolicy.
 
Method Summary
 void activateOptions()
          Activate the options that were previously set with calls to option setters.

This allows to defer activiation of the options until all options have been set. This is required for components which have related options that remain ambigous until all are set.

For example, the FileAppender has the File and Append options both of which are ambigous until the other is also set.

 void addFilter(Filter newFilter)
          Add a filter to end of the filter list.
 void clearFilters()
          Clear the filters chain.
 Filter getFilter()
          Returns the head Filter.
 boolean isTriggeringEvent(Appender appender, LoggingEvent event, String file, long fileLength)
          Determines if a rollover may be appropriate at this time. If true is returned, RolloverPolicy.rollover will be called but it can determine that a rollover is not warranted.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

FilterBasedTriggeringPolicy

public FilterBasedTriggeringPolicy()
Creates a new FilterBasedTriggeringPolicy.

Method Detail

isTriggeringEvent

public boolean isTriggeringEvent(Appender appender,
                                 LoggingEvent event,
                                 String file,
                                 long fileLength)
Determines if a rollover may be appropriate at this time. If true is returned, RolloverPolicy.rollover will be called but it can determine that a rollover is not warranted.

Specified by:
isTriggeringEvent in interface TriggeringPolicy
Parameters:
appender - A reference to the appender.
event - A reference to the currently event.
file - The filename for the currently active log file.
fileLength - Length of the file in bytes.
Returns:
true if a rollover should occur.

addFilter

public void addFilter(Filter newFilter)
Add a filter to end of the filter list.

Parameters:
newFilter - filter to add to end of list.

clearFilters

public void clearFilters()
Clear the filters chain.


getFilter

public Filter getFilter()
Returns the head Filter.

Returns:
head of filter chain, may be null.

activateOptions

public void activateOptions()
Activate the options that were previously set with calls to option setters.

This allows to defer activiation of the options until all options have been set. This is required for components which have related options that remain ambigous until all are set.

For example, the FileAppender has the File and Append options both of which are ambigous until the other is also set.

Specified by:
activateOptions in interface OptionHandler

Log4j 1.3alpha-7

Copyright 2000-2005 Apache Software Foundation.