| <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> <a name="line.17"></a> |
| <FONT color="green">018</FONT> package org.apache.logging.log4j.core;<a name="line.18"></a> |
| <FONT color="green">019</FONT> <a name="line.19"></a> |
| <FONT color="green">020</FONT> import org.apache.logging.log4j.Level;<a name="line.20"></a> |
| <FONT color="green">021</FONT> import org.apache.logging.log4j.Marker;<a name="line.21"></a> |
| <FONT color="green">022</FONT> import org.apache.logging.log4j.message.Message;<a name="line.22"></a> |
| <FONT color="green">023</FONT> <a name="line.23"></a> |
| <FONT color="green">024</FONT> /**<a name="line.24"></a> |
| <FONT color="green">025</FONT> * Interface that must be implemented to allow custom event filtering. It is highly recommended that<a name="line.25"></a> |
| <FONT color="green">026</FONT> * applications make use of the Filters provided with this implementation before creating their own.<a name="line.26"></a> |
| <FONT color="green">027</FONT> *<a name="line.27"></a> |
| <FONT color="green">028</FONT> * This interface supports "global" filters (i.e. - all events must pass through them first), attached to<a name="line.28"></a> |
| <FONT color="green">029</FONT> * specific loggers and associated with Appenders. It is recommended that, where possible, Filter implementations<a name="line.29"></a> |
| <FONT color="green">030</FONT> * create a generic filtering method that can be called from any of the filter methods.<a name="line.30"></a> |
| <FONT color="green">031</FONT> */<a name="line.31"></a> |
| <FONT color="green">032</FONT> public interface Filter {<a name="line.32"></a> |
| <FONT color="green">033</FONT> <a name="line.33"></a> |
| <FONT color="green">034</FONT> /**<a name="line.34"></a> |
| <FONT color="green">035</FONT> * The result that can returned from a filter method call.<a name="line.35"></a> |
| <FONT color="green">036</FONT> */<a name="line.36"></a> |
| <FONT color="green">037</FONT> public enum Result {<a name="line.37"></a> |
| <FONT color="green">038</FONT> /**<a name="line.38"></a> |
| <FONT color="green">039</FONT> * The event will be processed without further filtering based on the log Level.<a name="line.39"></a> |
| <FONT color="green">040</FONT> */<a name="line.40"></a> |
| <FONT color="green">041</FONT> ACCEPT,<a name="line.41"></a> |
| <FONT color="green">042</FONT> /**<a name="line.42"></a> |
| <FONT color="green">043</FONT> * No decision could be made, further filtering should occur.<a name="line.43"></a> |
| <FONT color="green">044</FONT> */<a name="line.44"></a> |
| <FONT color="green">045</FONT> NEUTRAL,<a name="line.45"></a> |
| <FONT color="green">046</FONT> /**<a name="line.46"></a> |
| <FONT color="green">047</FONT> * The event should not be processed.<a name="line.47"></a> |
| <FONT color="green">048</FONT> */<a name="line.48"></a> |
| <FONT color="green">049</FONT> DENY<a name="line.49"></a> |
| <FONT color="green">050</FONT> }<a name="line.50"></a> |
| <FONT color="green">051</FONT> <a name="line.51"></a> |
| <FONT color="green">052</FONT> /**<a name="line.52"></a> |
| <FONT color="green">053</FONT> * Return the result that should be returned when the filter does not match the event.<a name="line.53"></a> |
| <FONT color="green">054</FONT> * @return the Result that should be returned when the filter does not match the event.<a name="line.54"></a> |
| <FONT color="green">055</FONT> */<a name="line.55"></a> |
| <FONT color="green">056</FONT> Result getOnMismatch();<a name="line.56"></a> |
| <FONT color="green">057</FONT> /**<a name="line.57"></a> |
| <FONT color="green">058</FONT> * Return the result that should be returned when the filter matches the event.<a name="line.58"></a> |
| <FONT color="green">059</FONT> * @return the Result that should be returned when the filter matches the event.<a name="line.59"></a> |
| <FONT color="green">060</FONT> */<a name="line.60"></a> |
| <FONT color="green">061</FONT> Result getOnMatch();<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> * Filter an event.<a name="line.64"></a> |
| <FONT color="green">065</FONT> * @param logger The Logger.<a name="line.65"></a> |
| <FONT color="green">066</FONT> * @param level The event logging Level.<a name="line.66"></a> |
| <FONT color="green">067</FONT> * @param marker The Marker for the event or null.<a name="line.67"></a> |
| <FONT color="green">068</FONT> * @param msg String text to filter on.<a name="line.68"></a> |
| <FONT color="green">069</FONT> * @param params An array of parameters or null.<a name="line.69"></a> |
| <FONT color="green">070</FONT> * @return the Result.<a name="line.70"></a> |
| <FONT color="green">071</FONT> */<a name="line.71"></a> |
| <FONT color="green">072</FONT> Result filter(Logger logger, Level level, Marker marker, String msg, Object... params);<a name="line.72"></a> |
| <FONT color="green">073</FONT> <a name="line.73"></a> |
| <FONT color="green">074</FONT> /**<a name="line.74"></a> |
| <FONT color="green">075</FONT> * Filter an event.<a name="line.75"></a> |
| <FONT color="green">076</FONT> * @param logger The Logger.<a name="line.76"></a> |
| <FONT color="green">077</FONT> * @param level The event logging Level.<a name="line.77"></a> |
| <FONT color="green">078</FONT> * @param marker The Marker for the event or null.<a name="line.78"></a> |
| <FONT color="green">079</FONT> * @param msg Any Object.<a name="line.79"></a> |
| <FONT color="green">080</FONT> * @param t A Throwable or null.<a name="line.80"></a> |
| <FONT color="green">081</FONT> * @return the Result.<a name="line.81"></a> |
| <FONT color="green">082</FONT> */<a name="line.82"></a> |
| <FONT color="green">083</FONT> Result filter(Logger logger, Level level, Marker marker, Object msg, Throwable t);<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> * Filter an event.<a name="line.86"></a> |
| <FONT color="green">087</FONT> * @param logger The Logger.<a name="line.87"></a> |
| <FONT color="green">088</FONT> * @param level The event logging Level.<a name="line.88"></a> |
| <FONT color="green">089</FONT> * @param marker The Marker for the event or null.<a name="line.89"></a> |
| <FONT color="green">090</FONT> * @param msg The Message<a name="line.90"></a> |
| <FONT color="green">091</FONT> * @param t A Throwable or null.<a name="line.91"></a> |
| <FONT color="green">092</FONT> * @return the Result.<a name="line.92"></a> |
| <FONT color="green">093</FONT> */<a name="line.93"></a> |
| <FONT color="green">094</FONT> Result filter(Logger logger, Level level, Marker marker, Message msg, Throwable t);<a name="line.94"></a> |
| <FONT color="green">095</FONT> <a name="line.95"></a> |
| <FONT color="green">096</FONT> /**<a name="line.96"></a> |
| <FONT color="green">097</FONT> * Filter an event.<a name="line.97"></a> |
| <FONT color="green">098</FONT> * @param event The Event to filter on.<a name="line.98"></a> |
| <FONT color="green">099</FONT> * @return the Result.<a name="line.99"></a> |
| <FONT color="green">100</FONT> */<a name="line.100"></a> |
| <FONT color="green">101</FONT> Result filter(LogEvent event);<a name="line.101"></a> |
| <FONT color="green">102</FONT> <a name="line.102"></a> |
| <FONT color="green">103</FONT> }<a name="line.103"></a> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| </PRE> |
| </BODY> |
| </HTML> |
