1 | /*
|
---|
2 | * Licensed to the Apache Software Foundation (ASF) under one or more
|
---|
3 | * contributor license agreements. See the NOTICE file distributed with
|
---|
4 | * this work for additional information regarding copyright ownership.
|
---|
5 | * The ASF licenses this file to You under the Apache License, Version 2.0
|
---|
6 | * (the "License"); you may not use this file except in compliance with
|
---|
7 | * the License. You may obtain a copy of the License at
|
---|
8 | *
|
---|
9 | * http://www.apache.org/licenses/LICENSE-2.0
|
---|
10 | *
|
---|
11 | * Unless required by applicable law or agreed to in writing, software
|
---|
12 | * distributed under the License is distributed on an "AS IS" BASIS,
|
---|
13 | * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
---|
14 | * See the License for the specific language governing permissions and
|
---|
15 | * limitations under the License.
|
---|
16 | */
|
---|
17 |
|
---|
18 | #ifndef _LOG4CXX_FILTER_EXPRESSIONFILTER_H
|
---|
19 | #define _LOG4CXX_FILTER_EXPRESSIONFILTER_H
|
---|
20 |
|
---|
21 | #if defined(_MSC_VER)
|
---|
22 | #pragma warning ( push )
|
---|
23 | #pragma warning ( disable: 4231 4251 4275 4786 )
|
---|
24 | #endif
|
---|
25 |
|
---|
26 |
|
---|
27 | #include <log4cxx/spi/filter.h>
|
---|
28 |
|
---|
29 | namespace log4cxx
|
---|
30 | {
|
---|
31 | namespace rule
|
---|
32 | {
|
---|
33 | class Rule;
|
---|
34 | typedef helpers::ObjectPtrT < Rule > RulePtr;
|
---|
35 | }
|
---|
36 |
|
---|
37 |
|
---|
38 | namespace filter
|
---|
39 | {
|
---|
40 |
|
---|
41 |
|
---|
42 | /**
|
---|
43 | *A filter supporting complex expressions - supports both infix and postfix
|
---|
44 | * expressions (infix expressions must first be converted to postfix prior
|
---|
45 | * to processing).
|
---|
46 | *
|
---|
47 | * <p>See <code>org.apache.log4j.chainsaw.LoggingEventFieldResolver.java</code>
|
---|
48 | * for the correct names for logging event fields used when building expressions.
|
---|
49 | *
|
---|
50 | * <p>See <code>org.apache.log4j.chainsaw.rule</code> package for a list of available
|
---|
51 | * rules which can be applied using the expression syntax.
|
---|
52 | *
|
---|
53 | * <p>See <code>org.apache.log4j.chainsaw.RuleFactory</code> for the symbols
|
---|
54 | * used to activate the corresponding rules.
|
---|
55 | *
|
---|
56 | *NOTE: Grouping using parentheses is supported - all tokens must be separated by spaces, and
|
---|
57 | *operands which contain spaces are not yet supported.
|
---|
58 | *
|
---|
59 | *Example:
|
---|
60 | *
|
---|
61 | *In order to build a filter that displays all messages with infomsg-45 or infomsg-44 in the message,
|
---|
62 | *as well as all messages with a level of WARN or higher, build an expression using
|
---|
63 | *the LikeRule (supports ORO-based regular expressions) and the InequalityRule.
|
---|
64 | * <b> ( MSG LIKE infomsg-4[4,5] ) && ( LEVEL >= WARN ) </b>
|
---|
65 | *
|
---|
66 | *Three options are required:
|
---|
67 | * <b>Expression</b> - the expression to match
|
---|
68 | * <b>ConvertInFixToPostFix</b> - convert from infix to posfix (default true)
|
---|
69 | * <b>AcceptOnMatch</b> - true or false (default true)
|
---|
70 | *
|
---|
71 | * Meaning of <b>AcceptToMatch</b>:
|
---|
72 | * If there is a match between the value of the
|
---|
73 | * Expression option and the {@link log4cxx::spi::LoggingEvent} and AcceptOnMatch is true,
|
---|
74 | * the {@link #decide} method returns {@link log4cxx::spi::Filter#ACCEPT}.
|
---|
75 | *
|
---|
76 | * If there is a match between the value of the
|
---|
77 | * Expression option and the {@link log4cxx::spi::LoggingEvent} and AcceptOnMatch is false,
|
---|
78 | * {@link log4cxx::spi::Filter#DENY} is returned.
|
---|
79 | *
|
---|
80 | * If there is no match, {@link log4cxx::spi::Filter#NEUTRAL} is returned.
|
---|
81 | *
|
---|
82 | *
|
---|
83 | */
|
---|
84 | class LOG4CXX_EXPORT ExpressionFilter:public log4cxx::spi::Filter
|
---|
85 | {
|
---|
86 | private:
|
---|
87 | bool acceptOnMatch;
|
---|
88 | bool convertInFixToPostFix;
|
---|
89 | LogString expression;
|
---|
90 | log4cxx::rule::RulePtr expressionRule;
|
---|
91 | ExpressionFilter(const ExpressionFilter &);
|
---|
92 | ExpressionFilter & operator=(const ExpressionFilter &);
|
---|
93 |
|
---|
94 | public:
|
---|
95 | DECLARE_LOG4CXX_OBJECT(ExpressionFilter)
|
---|
96 | BEGIN_LOG4CXX_CAST_MAP()
|
---|
97 | LOG4CXX_CAST_ENTRY(log4cxx::spi::Filter)
|
---|
98 | END_LOG4CXX_CAST_MAP()
|
---|
99 |
|
---|
100 |
|
---|
101 | ExpressionFilter();
|
---|
102 |
|
---|
103 | void activateOptions(log4cxx::helpers::Pool & p);
|
---|
104 |
|
---|
105 | void setExpression(const LogString & expression);
|
---|
106 |
|
---|
107 | LogString getExpression() const;
|
---|
108 |
|
---|
109 | void setConvertInFixToPostFix(bool convertInFixToPostFix);
|
---|
110 |
|
---|
111 | bool getConvertInFixToPostFix() const;
|
---|
112 |
|
---|
113 | void setAcceptOnMatch(bool acceptOnMatch);
|
---|
114 |
|
---|
115 | bool getAcceptOnMatch() const;
|
---|
116 |
|
---|
117 | /**
|
---|
118 | Returns {@link log4cxx::spi::Filter#NEUTRAL} is there is no string match.
|
---|
119 | */
|
---|
120 | FilterDecision decide(const spi::LoggingEventPtr & event) const;
|
---|
121 | };
|
---|
122 | }
|
---|
123 | }
|
---|
124 |
|
---|
125 | #if defined(_MSC_VER)
|
---|
126 | #pragma warning ( pop )
|
---|
127 | #endif
|
---|
128 |
|
---|
129 |
|
---|
130 | #endif
|
---|