alvinalexander.com | career | drupal | java | mac | mysql | perl | scala | uml | unix  

What this is

This file is included in the DevDaily.com "Java Source Code Warehouse" project. The intent of this project is to help you "Learn Java by Example" TM.

Other links

The source code

/*
 * Copyright (C) The Apache Software Foundation. All rights reserved.
 *
 * This software is published under the terms of the Apache Software
 * License version 1.1, a copy of which has been included with this
 * distribution in the LICENSE.txt file.  */

package org.apache.log4j.spi;

import org.apache.log4j.spi.LoggingEvent;


/**
   Users should extend this class to implement customized logging
   event filtering. Note that {@link org.apache.log4j.Category} and {@link
   org.apache.log4j.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 {@link #decide decide(LoggingEvent)} method of each filter is called sequentially, in the order of their addition to the chain.

The {@link #decide decide(LoggingEvent)} method must return one of the integer constants {@link #DENY}, {@link #NEUTRAL} or {@link #ACCEPT}.

If the value {@link #DENY} is returned, then the log event is dropped immediately without consulting with the remaining filters.

If the value {@link #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 behaviour is to log all logging events.

If the value {@link #ACCEPT} is returned, then the log event is logged without consulting the remaining filters.

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

Note that filtering is only supported by the {@link org.apache.log4j.xml.DOMConfigurator DOMConfigurator}. The {@link org.apache.log4j.PropertyConfigurator PropertyConfigurator} does not support filters. @author Ceki Gülcü @since 0.9.0 */ public abstract class Filter implements OptionHandler { /** Points to the next filter in the filter chain. */ public Filter next; /** The log event must be dropped immediately without consulting with the remaining filters, if any, in the chain. */ public static final int DENY = -1; /** This filter is neutral with respect to the log event. The remaining filters, if any, should be consulted for a final decision. */ public static final int NEUTRAL = 0; /** The log event must be logged immediately without consulting with the remaining filters, if any, in the chain. */ public static final int ACCEPT = 1; /** Usually filters options become active when set. We provide a default do-nothing implementation for convenience. */ public void activateOptions() { } /**

If the decision is DENY, then the event will be dropped. If the decision is NEUTRAL, then the next filter, if any, will be invoked. If the decision is ACCEPT then the event will be logged without consulting with other filters in the chain. @param event The LoggingEvent to decide upon. @param decision The decision of the filter. */ abstract public int decide(LoggingEvent event); }

... this post is sponsored by my books ...

#1 New Release!

FP Best Seller

 

new blog posts

 

Copyright 1998-2024 Alvin Alexander, alvinalexander.com
All Rights Reserved.

A percentage of advertising revenue from
pages under the /java/jwarehouse URI on this website is
paid back to open source projects.