Google Git
Sign in
apache / logging-log4j-site / d0d0de55986756593c08e5d2b8059541eacaf428 / . / log4j-2.0-alpha1-SNAPSHOT / log4j-core / apidocs / src-html / org / apache / logging / log4j / core / filter / RegexFilter.html
blob: 6018a9d6ae60077985adf57ec13ba5b19b396837 [file] [log] [blame]
<HTML>
<BODY BGCOLOR="white">
<PRE>
<FONT color="green">001</FONT> /*<a name="line.1"></a>
<FONT color="green">002</FONT> * Licensed to the Apache Software Foundation (ASF) under one or more<a name="line.2"></a>
<FONT color="green">003</FONT> * contributor license agreements. See the NOTICE file distributed with<a name="line.3"></a>
<FONT color="green">004</FONT> * this work for additional information regarding copyright ownership.<a name="line.4"></a>
<FONT color="green">005</FONT> * The ASF licenses this file to You under the Apache license, Version 2.0<a name="line.5"></a>
<FONT color="green">006</FONT> * (the "License"); you may not use this file except in compliance with<a name="line.6"></a>
<FONT color="green">007</FONT> * the License. You may obtain a copy of the License at<a name="line.7"></a>
<FONT color="green">008</FONT> *<a name="line.8"></a>
<FONT color="green">009</FONT> * http://www.apache.org/licenses/LICENSE-2.0<a name="line.9"></a>
<FONT color="green">010</FONT> *<a name="line.10"></a>
<FONT color="green">011</FONT> * Unless required by applicable law or agreed to in writing, software<a name="line.11"></a>
<FONT color="green">012</FONT> * distributed under the License is distributed on an "AS IS" BASIS,<a name="line.12"></a>
<FONT color="green">013</FONT> * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.<a name="line.13"></a>
<FONT color="green">014</FONT> * See the license for the specific language governing permissions and<a name="line.14"></a>
<FONT color="green">015</FONT> * limitations under the license.<a name="line.15"></a>
<FONT color="green">016</FONT> */<a name="line.16"></a>
<FONT color="green">017</FONT> package org.apache.logging.log4j.core.filter;<a name="line.17"></a>
<FONT color="green">018</FONT> <a name="line.18"></a>
<FONT color="green">019</FONT> import org.apache.logging.log4j.Level;<a name="line.19"></a>
<FONT color="green">020</FONT> import org.apache.logging.log4j.Marker;<a name="line.20"></a>
<FONT color="green">021</FONT> import org.apache.logging.log4j.core.LogEvent;<a name="line.21"></a>
<FONT color="green">022</FONT> import org.apache.logging.log4j.core.Logger;<a name="line.22"></a>
<FONT color="green">023</FONT> import org.apache.logging.log4j.core.config.plugins.Plugin;<a name="line.23"></a>
<FONT color="green">024</FONT> import org.apache.logging.log4j.core.config.plugins.PluginAttr;<a name="line.24"></a>
<FONT color="green">025</FONT> import org.apache.logging.log4j.core.config.plugins.PluginFactory;<a name="line.25"></a>
<FONT color="green">026</FONT> import org.apache.logging.log4j.message.Message;<a name="line.26"></a>
<FONT color="green">027</FONT> <a name="line.27"></a>
<FONT color="green">028</FONT> import java.util.regex.Matcher;<a name="line.28"></a>
<FONT color="green">029</FONT> import java.util.regex.Pattern;<a name="line.29"></a>
<FONT color="green">030</FONT> <a name="line.30"></a>
<FONT color="green">031</FONT> /**<a name="line.31"></a>
<FONT color="green">032</FONT> * This filter returns the onMatch result if the message matches the regular expression.<a name="line.32"></a>
<FONT color="green">033</FONT> *<a name="line.33"></a>
<FONT color="green">034</FONT> * The "useRawMsg" attribute can be used to indicate whether the regular expression should be<a name="line.34"></a>
<FONT color="green">035</FONT> * applied to the result of calling Message.getMessageFormat (true) or Message.getFormattedMessage()<a name="line.35"></a>
<FONT color="green">036</FONT> * (false). The default is false.<a name="line.36"></a>
<FONT color="green">037</FONT> *<a name="line.37"></a>
<FONT color="green">038</FONT> */<a name="line.38"></a>
<FONT color="green">039</FONT> @Plugin(name = "RegexFilter", type = "Core", elementType = "filter", printObject = true)<a name="line.39"></a>
<FONT color="green">040</FONT> public final class RegexFilter extends FilterBase {<a name="line.40"></a>
<FONT color="green">041</FONT> <a name="line.41"></a>
<FONT color="green">042</FONT> private final Pattern pattern;<a name="line.42"></a>
<FONT color="green">043</FONT> private final boolean useRawMessage;<a name="line.43"></a>
<FONT color="green">044</FONT> <a name="line.44"></a>
<FONT color="green">045</FONT> private RegexFilter(boolean raw, Pattern pattern, Result onMatch, Result onMismatch) {<a name="line.45"></a>
<FONT color="green">046</FONT> super(onMatch, onMismatch);<a name="line.46"></a>
<FONT color="green">047</FONT> this.pattern = pattern;<a name="line.47"></a>
<FONT color="green">048</FONT> this.useRawMessage = raw;<a name="line.48"></a>
<FONT color="green">049</FONT> }<a name="line.49"></a>
<FONT color="green">050</FONT> <a name="line.50"></a>
<FONT color="green">051</FONT> public Result filter(Logger logger, Level level, Marker marker, String msg, Object[] params) {<a name="line.51"></a>
<FONT color="green">052</FONT> return filter(msg);<a name="line.52"></a>
<FONT color="green">053</FONT> }<a name="line.53"></a>
<FONT color="green">054</FONT> <a name="line.54"></a>
<FONT color="green">055</FONT> public Result filter(Logger logger, Level level, Marker marker, Object msg, Throwable t) {<a name="line.55"></a>
<FONT color="green">056</FONT> return filter(msg.toString());<a name="line.56"></a>
<FONT color="green">057</FONT> }<a name="line.57"></a>
<FONT color="green">058</FONT> <a name="line.58"></a>
<FONT color="green">059</FONT> public Result filter(Logger logger, Level level, Marker marker, Message msg, Throwable t) {<a name="line.59"></a>
<FONT color="green">060</FONT> String text = useRawMessage ? msg.getMessageFormat() : msg.getFormattedMessage();<a name="line.60"></a>
<FONT color="green">061</FONT> return filter(text);<a name="line.61"></a>
<FONT color="green">062</FONT> }<a name="line.62"></a>
<FONT color="green">063</FONT> <a name="line.63"></a>
<FONT color="green">064</FONT> @Override<a name="line.64"></a>
<FONT color="green">065</FONT> public Result filter(LogEvent event) {<a name="line.65"></a>
<FONT color="green">066</FONT> String text = useRawMessage ? event.getMessage().getMessageFormat() : event.getMessage().getFormattedMessage();<a name="line.66"></a>
<FONT color="green">067</FONT> return filter(text);<a name="line.67"></a>
<FONT color="green">068</FONT> }<a name="line.68"></a>
<FONT color="green">069</FONT> <a name="line.69"></a>
<FONT color="green">070</FONT> private Result filter(String msg) {<a name="line.70"></a>
<FONT color="green">071</FONT> if (msg == null) {<a name="line.71"></a>
<FONT color="green">072</FONT> return onMismatch;<a name="line.72"></a>
<FONT color="green">073</FONT> }<a name="line.73"></a>
<FONT color="green">074</FONT> Matcher m = pattern.matcher(msg);<a name="line.74"></a>
<FONT color="green">075</FONT> return m.matches() ? onMatch : onMismatch;<a name="line.75"></a>
<FONT color="green">076</FONT> }<a name="line.76"></a>
<FONT color="green">077</FONT> <a name="line.77"></a>
<FONT color="green">078</FONT> @Override<a name="line.78"></a>
<FONT color="green">079</FONT> public String toString() {<a name="line.79"></a>
<FONT color="green">080</FONT> StringBuilder sb = new StringBuilder();<a name="line.80"></a>
<FONT color="green">081</FONT> sb.append("useRaw=").append(useRawMessage);<a name="line.81"></a>
<FONT color="green">082</FONT> sb.append(", pattern=").append(pattern.toString());<a name="line.82"></a>
<FONT color="green">083</FONT> return sb.toString();<a name="line.83"></a>
<FONT color="green">084</FONT> }<a name="line.84"></a>
<FONT color="green">085</FONT> <a name="line.85"></a>
<FONT color="green">086</FONT> /**<a name="line.86"></a>
<FONT color="green">087</FONT> * Create a Filter that matches a regular expression.<a name="line.87"></a>
<FONT color="green">088</FONT> * @param regex The regular expression to match.<a name="line.88"></a>
<FONT color="green">089</FONT> * @param useRawMsg If true, the raw message will be used, otherwise the formatted message will be used.<a name="line.89"></a>
<FONT color="green">090</FONT> * @param match The action to perform when a match occurs.<a name="line.90"></a>
<FONT color="green">091</FONT> * @param mismatch The action to perform when a mismatch occurs.<a name="line.91"></a>
<FONT color="green">092</FONT> * @return The RegexFilter.<a name="line.92"></a>
<FONT color="green">093</FONT> */<a name="line.93"></a>
<FONT color="green">094</FONT> @PluginFactory<a name="line.94"></a>
<FONT color="green">095</FONT> public static RegexFilter createFilter(@PluginAttr("regex") String regex,<a name="line.95"></a>
<FONT color="green">096</FONT> @PluginAttr("useRawMsg") String useRawMsg,<a name="line.96"></a>
<FONT color="green">097</FONT> @PluginAttr("onMatch") String match,<a name="line.97"></a>
<FONT color="green">098</FONT> @PluginAttr("onMismatch") String mismatch) {<a name="line.98"></a>
<FONT color="green">099</FONT> <a name="line.99"></a>
<FONT color="green">100</FONT> if (regex == null) {<a name="line.100"></a>
<FONT color="green">101</FONT> LOGGER.error("A regular expression must be provided for RegexFilter");<a name="line.101"></a>
<FONT color="green">102</FONT> return null;<a name="line.102"></a>
<FONT color="green">103</FONT> }<a name="line.103"></a>
<FONT color="green">104</FONT> boolean raw = useRawMsg == null ? false : Boolean.parseBoolean(useRawMsg);<a name="line.104"></a>
<FONT color="green">105</FONT> Pattern pattern;<a name="line.105"></a>
<FONT color="green">106</FONT> try {<a name="line.106"></a>
<FONT color="green">107</FONT> pattern = Pattern.compile(regex);<a name="line.107"></a>
<FONT color="green">108</FONT> } catch (Exception ex) {<a name="line.108"></a>
<FONT color="green">109</FONT> LOGGER.error("RegexFilter caught exception compiling pattern: " + regex + " cause: " + ex.getMessage());<a name="line.109"></a>
<FONT color="green">110</FONT> return null;<a name="line.110"></a>
<FONT color="green">111</FONT> }<a name="line.111"></a>
<FONT color="green">112</FONT> Result onMatch = match == null ? null : Result.valueOf(match.toUpperCase());<a name="line.112"></a>
<FONT color="green">113</FONT> Result onMismatch = mismatch == null ? null : Result.valueOf(mismatch.toUpperCase());<a name="line.113"></a>
<FONT color="green">114</FONT> <a name="line.114"></a>
<FONT color="green">115</FONT> return new RegexFilter(raw, pattern, onMatch, onMismatch);<a name="line.115"></a>
<FONT color="green">116</FONT> }<a name="line.116"></a>
<FONT color="green">117</FONT> <a name="line.117"></a>
<FONT color="green">118</FONT> }<a name="line.118"></a>
</PRE>
</BODY>
</HTML>