| <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> |
| <html lang="en"> |
| <head> |
| <title>Source code</title> |
| <link rel="stylesheet" type="text/css" href="../../../../../../../stylesheet.css" title="Style"> |
| </head> |
| <body> |
| <div class="sourceContainer"> |
| <pre><span class="sourceLineNo">001</span>/*<a name="line.1"></a> |
| <span class="sourceLineNo">002</span> * Licensed to the Apache Software Foundation (ASF) under one or more<a name="line.2"></a> |
| <span class="sourceLineNo">003</span> * contributor license agreements. See the NOTICE file distributed with<a name="line.3"></a> |
| <span class="sourceLineNo">004</span> * this work for additional information regarding copyright ownership.<a name="line.4"></a> |
| <span class="sourceLineNo">005</span> * The ASF licenses this file to You under the Apache license, Version 2.0<a name="line.5"></a> |
| <span class="sourceLineNo">006</span> * (the "License"); you may not use this file except in compliance with<a name="line.6"></a> |
| <span class="sourceLineNo">007</span> * the License. You may obtain a copy of the License at<a name="line.7"></a> |
| <span class="sourceLineNo">008</span> *<a name="line.8"></a> |
| <span class="sourceLineNo">009</span> * http://www.apache.org/licenses/LICENSE-2.0<a name="line.9"></a> |
| <span class="sourceLineNo">010</span> *<a name="line.10"></a> |
| <span class="sourceLineNo">011</span> * Unless required by applicable law or agreed to in writing, software<a name="line.11"></a> |
| <span class="sourceLineNo">012</span> * distributed under the License is distributed on an "AS IS" BASIS,<a name="line.12"></a> |
| <span class="sourceLineNo">013</span> * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.<a name="line.13"></a> |
| <span class="sourceLineNo">014</span> * See the license for the specific language governing permissions and<a name="line.14"></a> |
| <span class="sourceLineNo">015</span> * limitations under the license.<a name="line.15"></a> |
| <span class="sourceLineNo">016</span> */<a name="line.16"></a> |
| <span class="sourceLineNo">017</span>package org.apache.logging.log4j.core.filter;<a name="line.17"></a> |
| <span class="sourceLineNo">018</span><a name="line.18"></a> |
| <span class="sourceLineNo">019</span>import java.lang.reflect.Field;<a name="line.19"></a> |
| <span class="sourceLineNo">020</span>import java.util.Arrays;<a name="line.20"></a> |
| <span class="sourceLineNo">021</span>import java.util.Comparator;<a name="line.21"></a> |
| <span class="sourceLineNo">022</span>import java.util.regex.Matcher;<a name="line.22"></a> |
| <span class="sourceLineNo">023</span>import java.util.regex.Pattern;<a name="line.23"></a> |
| <span class="sourceLineNo">024</span><a name="line.24"></a> |
| <span class="sourceLineNo">025</span>import org.apache.logging.log4j.Level;<a name="line.25"></a> |
| <span class="sourceLineNo">026</span>import org.apache.logging.log4j.Marker;<a name="line.26"></a> |
| <span class="sourceLineNo">027</span>import org.apache.logging.log4j.core.Filter;<a name="line.27"></a> |
| <span class="sourceLineNo">028</span>import org.apache.logging.log4j.core.LogEvent;<a name="line.28"></a> |
| <span class="sourceLineNo">029</span>import org.apache.logging.log4j.core.Logger;<a name="line.29"></a> |
| <span class="sourceLineNo">030</span>import org.apache.logging.log4j.core.config.Node;<a name="line.30"></a> |
| <span class="sourceLineNo">031</span>import org.apache.logging.log4j.core.config.plugins.Plugin;<a name="line.31"></a> |
| <span class="sourceLineNo">032</span>import org.apache.logging.log4j.core.config.plugins.PluginAttribute;<a name="line.32"></a> |
| <span class="sourceLineNo">033</span>import org.apache.logging.log4j.core.config.plugins.PluginElement;<a name="line.33"></a> |
| <span class="sourceLineNo">034</span>import org.apache.logging.log4j.core.config.plugins.PluginFactory;<a name="line.34"></a> |
| <span class="sourceLineNo">035</span>import org.apache.logging.log4j.message.Message;<a name="line.35"></a> |
| <span class="sourceLineNo">036</span><a name="line.36"></a> |
| <span class="sourceLineNo">037</span>/**<a name="line.37"></a> |
| <span class="sourceLineNo">038</span> * This filter returns the onMatch result if the message matches the regular expression.<a name="line.38"></a> |
| <span class="sourceLineNo">039</span> *<a name="line.39"></a> |
| <span class="sourceLineNo">040</span> * The "useRawMsg" attribute can be used to indicate whether the regular expression should be applied to the result of<a name="line.40"></a> |
| <span class="sourceLineNo">041</span> * calling Message.getMessageFormat (true) or Message.getFormattedMessage() (false). The default is false.<a name="line.41"></a> |
| <span class="sourceLineNo">042</span> *<a name="line.42"></a> |
| <span class="sourceLineNo">043</span> */<a name="line.43"></a> |
| <span class="sourceLineNo">044</span>@Plugin(name = "RegexFilter", category = Node.CATEGORY, elementType = Filter.ELEMENT_TYPE, printObject = true)<a name="line.44"></a> |
| <span class="sourceLineNo">045</span>public final class RegexFilter extends AbstractFilter {<a name="line.45"></a> |
| <span class="sourceLineNo">046</span><a name="line.46"></a> |
| <span class="sourceLineNo">047</span> private static final int DEFAULT_PATTERN_FLAGS = 0;<a name="line.47"></a> |
| <span class="sourceLineNo">048</span> private final Pattern pattern;<a name="line.48"></a> |
| <span class="sourceLineNo">049</span> private final boolean useRawMessage;<a name="line.49"></a> |
| <span class="sourceLineNo">050</span><a name="line.50"></a> |
| <span class="sourceLineNo">051</span> private RegexFilter(final boolean raw, final Pattern pattern, final Result onMatch, final Result onMismatch) {<a name="line.51"></a> |
| <span class="sourceLineNo">052</span> super(onMatch, onMismatch);<a name="line.52"></a> |
| <span class="sourceLineNo">053</span> this.pattern = pattern;<a name="line.53"></a> |
| <span class="sourceLineNo">054</span> this.useRawMessage = raw;<a name="line.54"></a> |
| <span class="sourceLineNo">055</span> }<a name="line.55"></a> |
| <span class="sourceLineNo">056</span><a name="line.56"></a> |
| <span class="sourceLineNo">057</span> @Override<a name="line.57"></a> |
| <span class="sourceLineNo">058</span> public Result filter(final Logger logger, final Level level, final Marker marker, final String msg,<a name="line.58"></a> |
| <span class="sourceLineNo">059</span> final Object... params) {<a name="line.59"></a> |
| <span class="sourceLineNo">060</span> return filter(msg);<a name="line.60"></a> |
| <span class="sourceLineNo">061</span> }<a name="line.61"></a> |
| <span class="sourceLineNo">062</span><a name="line.62"></a> |
| <span class="sourceLineNo">063</span> @Override<a name="line.63"></a> |
| <span class="sourceLineNo">064</span> public Result filter(final Logger logger, final Level level, final Marker marker, final Object msg,<a name="line.64"></a> |
| <span class="sourceLineNo">065</span> final Throwable t) {<a name="line.65"></a> |
| <span class="sourceLineNo">066</span> if (msg == null) {<a name="line.66"></a> |
| <span class="sourceLineNo">067</span> return onMismatch;<a name="line.67"></a> |
| <span class="sourceLineNo">068</span> }<a name="line.68"></a> |
| <span class="sourceLineNo">069</span> return filter(msg.toString());<a name="line.69"></a> |
| <span class="sourceLineNo">070</span> }<a name="line.70"></a> |
| <span class="sourceLineNo">071</span><a name="line.71"></a> |
| <span class="sourceLineNo">072</span> @Override<a name="line.72"></a> |
| <span class="sourceLineNo">073</span> public Result filter(final Logger logger, final Level level, final Marker marker, final Message msg,<a name="line.73"></a> |
| <span class="sourceLineNo">074</span> final Throwable t) {<a name="line.74"></a> |
| <span class="sourceLineNo">075</span> if (msg == null) {<a name="line.75"></a> |
| <span class="sourceLineNo">076</span> return onMismatch;<a name="line.76"></a> |
| <span class="sourceLineNo">077</span> }<a name="line.77"></a> |
| <span class="sourceLineNo">078</span> final String text = useRawMessage ? msg.getFormat() : msg.getFormattedMessage();<a name="line.78"></a> |
| <span class="sourceLineNo">079</span> return filter(text);<a name="line.79"></a> |
| <span class="sourceLineNo">080</span> }<a name="line.80"></a> |
| <span class="sourceLineNo">081</span><a name="line.81"></a> |
| <span class="sourceLineNo">082</span> @Override<a name="line.82"></a> |
| <span class="sourceLineNo">083</span> public Result filter(final LogEvent event) {<a name="line.83"></a> |
| <span class="sourceLineNo">084</span> final String text = useRawMessage ? event.getMessage().getFormat() : event.getMessage().getFormattedMessage();<a name="line.84"></a> |
| <span class="sourceLineNo">085</span> return filter(text);<a name="line.85"></a> |
| <span class="sourceLineNo">086</span> }<a name="line.86"></a> |
| <span class="sourceLineNo">087</span><a name="line.87"></a> |
| <span class="sourceLineNo">088</span> private Result filter(final String msg) {<a name="line.88"></a> |
| <span class="sourceLineNo">089</span> if (msg == null) {<a name="line.89"></a> |
| <span class="sourceLineNo">090</span> return onMismatch;<a name="line.90"></a> |
| <span class="sourceLineNo">091</span> }<a name="line.91"></a> |
| <span class="sourceLineNo">092</span> final Matcher m = pattern.matcher(msg);<a name="line.92"></a> |
| <span class="sourceLineNo">093</span> return m.matches() ? onMatch : onMismatch;<a name="line.93"></a> |
| <span class="sourceLineNo">094</span> }<a name="line.94"></a> |
| <span class="sourceLineNo">095</span><a name="line.95"></a> |
| <span class="sourceLineNo">096</span> @Override<a name="line.96"></a> |
| <span class="sourceLineNo">097</span> public String toString() {<a name="line.97"></a> |
| <span class="sourceLineNo">098</span> final StringBuilder sb = new StringBuilder();<a name="line.98"></a> |
| <span class="sourceLineNo">099</span> sb.append("useRaw=").append(useRawMessage);<a name="line.99"></a> |
| <span class="sourceLineNo">100</span> sb.append(", pattern=").append(pattern.toString());<a name="line.100"></a> |
| <span class="sourceLineNo">101</span> return sb.toString();<a name="line.101"></a> |
| <span class="sourceLineNo">102</span> }<a name="line.102"></a> |
| <span class="sourceLineNo">103</span><a name="line.103"></a> |
| <span class="sourceLineNo">104</span> /**<a name="line.104"></a> |
| <span class="sourceLineNo">105</span> * Creates a Filter that matches a regular expression.<a name="line.105"></a> |
| <span class="sourceLineNo">106</span> *<a name="line.106"></a> |
| <span class="sourceLineNo">107</span> * @param regex<a name="line.107"></a> |
| <span class="sourceLineNo">108</span> * The regular expression to match.<a name="line.108"></a> |
| <span class="sourceLineNo">109</span> * @param patternFlags<a name="line.109"></a> |
| <span class="sourceLineNo">110</span> * An array of Strings where each String is a {@link Pattern#compile(String, int)} compilation flag.<a name="line.110"></a> |
| <span class="sourceLineNo">111</span> * @param useRawMsg<a name="line.111"></a> |
| <span class="sourceLineNo">112</span> * If true, the raw message will be used, otherwise the formatted message will be used.<a name="line.112"></a> |
| <span class="sourceLineNo">113</span> * @param match<a name="line.113"></a> |
| <span class="sourceLineNo">114</span> * The action to perform when a match occurs.<a name="line.114"></a> |
| <span class="sourceLineNo">115</span> * @param mismatch<a name="line.115"></a> |
| <span class="sourceLineNo">116</span> * The action to perform when a mismatch occurs.<a name="line.116"></a> |
| <span class="sourceLineNo">117</span> * @return The RegexFilter.<a name="line.117"></a> |
| <span class="sourceLineNo">118</span> * @throws IllegalAccessException<a name="line.118"></a> |
| <span class="sourceLineNo">119</span> * @throws IllegalArgumentException<a name="line.119"></a> |
| <span class="sourceLineNo">120</span> */<a name="line.120"></a> |
| <span class="sourceLineNo">121</span> // TODO Consider refactoring to use AbstractFilter.AbstractFilterBuilder<a name="line.121"></a> |
| <span class="sourceLineNo">122</span> @PluginFactory<a name="line.122"></a> |
| <span class="sourceLineNo">123</span> public static RegexFilter createFilter(<a name="line.123"></a> |
| <span class="sourceLineNo">124</span> //@formatter:off<a name="line.124"></a> |
| <span class="sourceLineNo">125</span> @PluginAttribute("regex") final String regex,<a name="line.125"></a> |
| <span class="sourceLineNo">126</span> @PluginElement("PatternFlags") final String[] patternFlags,<a name="line.126"></a> |
| <span class="sourceLineNo">127</span> @PluginAttribute("useRawMsg") final Boolean useRawMsg,<a name="line.127"></a> |
| <span class="sourceLineNo">128</span> @PluginAttribute("onMatch") final Result match,<a name="line.128"></a> |
| <span class="sourceLineNo">129</span> @PluginAttribute("onMismatch") final Result mismatch)<a name="line.129"></a> |
| <span class="sourceLineNo">130</span> //@formatter:on<a name="line.130"></a> |
| <span class="sourceLineNo">131</span> throws IllegalArgumentException, IllegalAccessException {<a name="line.131"></a> |
| <span class="sourceLineNo">132</span> if (regex == null) {<a name="line.132"></a> |
| <span class="sourceLineNo">133</span> LOGGER.error("A regular expression must be provided for RegexFilter");<a name="line.133"></a> |
| <span class="sourceLineNo">134</span> return null;<a name="line.134"></a> |
| <span class="sourceLineNo">135</span> }<a name="line.135"></a> |
| <span class="sourceLineNo">136</span> return new RegexFilter(useRawMsg, Pattern.compile(regex, toPatternFlags(patternFlags)), match, mismatch);<a name="line.136"></a> |
| <span class="sourceLineNo">137</span> }<a name="line.137"></a> |
| <span class="sourceLineNo">138</span><a name="line.138"></a> |
| <span class="sourceLineNo">139</span> private static int toPatternFlags(final String[] patternFlags) throws IllegalArgumentException,<a name="line.139"></a> |
| <span class="sourceLineNo">140</span> IllegalAccessException {<a name="line.140"></a> |
| <span class="sourceLineNo">141</span> if (patternFlags == null || patternFlags.length == 0) {<a name="line.141"></a> |
| <span class="sourceLineNo">142</span> return DEFAULT_PATTERN_FLAGS;<a name="line.142"></a> |
| <span class="sourceLineNo">143</span> }<a name="line.143"></a> |
| <span class="sourceLineNo">144</span> final Field[] fields = Pattern.class.getDeclaredFields();<a name="line.144"></a> |
| <span class="sourceLineNo">145</span> final Comparator<Field> comparator = new Comparator<Field>() {<a name="line.145"></a> |
| <span class="sourceLineNo">146</span><a name="line.146"></a> |
| <span class="sourceLineNo">147</span> @Override<a name="line.147"></a> |
| <span class="sourceLineNo">148</span> public int compare(final Field f1, final Field f2) {<a name="line.148"></a> |
| <span class="sourceLineNo">149</span> return f1.getName().compareTo(f2.getName());<a name="line.149"></a> |
| <span class="sourceLineNo">150</span> }<a name="line.150"></a> |
| <span class="sourceLineNo">151</span> };<a name="line.151"></a> |
| <span class="sourceLineNo">152</span> Arrays.sort(fields, comparator);<a name="line.152"></a> |
| <span class="sourceLineNo">153</span> final String[] fieldNames = new String[fields.length];<a name="line.153"></a> |
| <span class="sourceLineNo">154</span> for (int i = 0; i < fields.length; i++) {<a name="line.154"></a> |
| <span class="sourceLineNo">155</span> fieldNames[i] = fields[i].getName();<a name="line.155"></a> |
| <span class="sourceLineNo">156</span> }<a name="line.156"></a> |
| <span class="sourceLineNo">157</span> int flags = DEFAULT_PATTERN_FLAGS;<a name="line.157"></a> |
| <span class="sourceLineNo">158</span> for (final String test : patternFlags) {<a name="line.158"></a> |
| <span class="sourceLineNo">159</span> final int index = Arrays.binarySearch(fieldNames, test);<a name="line.159"></a> |
| <span class="sourceLineNo">160</span> if (index >= 0) {<a name="line.160"></a> |
| <span class="sourceLineNo">161</span> final Field field = fields[index];<a name="line.161"></a> |
| <span class="sourceLineNo">162</span> flags |= field.getInt(Pattern.class);<a name="line.162"></a> |
| <span class="sourceLineNo">163</span> }<a name="line.163"></a> |
| <span class="sourceLineNo">164</span> }<a name="line.164"></a> |
| <span class="sourceLineNo">165</span> return flags;<a name="line.165"></a> |
| <span class="sourceLineNo">166</span> }<a name="line.166"></a> |
| <span class="sourceLineNo">167</span>}<a name="line.167"></a> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| </pre> |
| </div> |
| </body> |
| </html> |
