Gdy piszemy aplikację, która korzysta ze sprawdzonych bibliotek, które do logowania wykorzystują log4j’a, możemy chcieć odpuścić sobie logowanie informacji z klas znajdujących się w wybranych pakietach tychże bibliotek. Poniższy kod przedstawia klasę filtru, który pozwala włączyć lub wyłączyć logowanie informacji z wybranego pakietu i całej jego podrzędnej struktury.

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
*
*  PackageFilter.java
*
*  Copyright (C) 2009  Kamil Dybicz
*
*  This library is free software; you can redistribute it and/or
*  modify it under the terms of the GNU Lesser General Public
*  License as published by the Free Software Foundation; either
*  version 3 of the License, or (at your option) any later version.
*
*  This program is distributed in the hope that it will be useful,
*  but WITHOUT ANY WARRANTY; without even the implied warranty of
*  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
*  Lesser General Public License for more details.
*
*  You should have received a copy of the GNU Lesser General Public
*  License along with this library. If not, see <http://www.gnu.org/licenses/>.
*/
package net.javaio.log4j.spi;

import org.apache.commons.lang.StringUtils;
import org.apache.log4j.spi.Filter;
import org.apache.log4j.spi.LoggingEvent;

/**
*
* @author Kamil Dybicz
*/
public class PackageFilter extends Filter {

    private boolean acceptOnMatch = true;
    private String packageNameToMatch;

    public PackageFilter() {
        setAcceptOnMatch(true);
        setPackageNameToMatch(null);
    }

    public PackageFilter(String packageNameToMatch) {
        setAcceptOnMatch(true);
        setPackageNameToMatch(packageNameToMatch);
    }

    public PackageFilter(String packageNameToMatch, boolean acceptOnMatch) {
        setAcceptOnMatch(acceptOnMatch);
        setPackageNameToMatch(packageNameToMatch);
    }

    @Override
    public int decide(LoggingEvent e) {
        boolean acceptOnMatch;
        String packageNameToMatch;

        synchronized (this) {
            acceptOnMatch = this.acceptOnMatch;
            packageNameToMatch = this.packageNameToMatch;
        }

        String className = e.getLocationInformation().getClassName();
        if (StringUtils.isNotBlank(packageNameToMatch)) {
            if (className.startsWith(packageNameToMatch)) {
                if (acceptOnMatch) {
                    return ACCEPT;
                } else {
                    return DENY;
                }
            }
        }

        return NEUTRAL;
    }

    public synchronized void setAcceptOnMatch(boolean acceptOnMatch) {
        this.acceptOnMatch = acceptOnMatch;
    }

    public synchronized boolean isAcceptOnMatch() {
        return acceptOnMatch;
    }

    public synchronized String getPackageNameToMatch() {
        return packageNameToMatch;
    }

    public synchronized void setPackageNameToMatch(String packageNameToMatch) {
        this.packageNameToMatch = packageNameToMatch;
    }
}

Wykorzystanie powyższej klasy jest bardzo proste i może wyglądać następująco:

1
2
3
4
5
ConsoleAppender consoleAppender = new ConsoleAppender(new PatternLayout(%d{ISO8601} %p [%c{1}:%L] %m%n));
consoleAppender.addFilter(new PackageFilter(org.apache, false));
consoleAppender.setThreshold(Level.ALL);

BasicConfigurator.configure(consoleAppender);

W efekcie działania powyższego kodu, na konsoli będą wyświetlane wszelkie komunikaty, niezależnie od poziomu logowania oraz nazwy i położenia klasy z której są logowane, z wyłączeniem klas znajdujących się w pakiecie org.apache.