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 / FilterBase.html
blob: b3b5bbc3667a246a8059c2bb0706a48576f1c511 [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.Filter;<a name="line.21"></a>
<FONT color="green">022</FONT> import org.apache.logging.log4j.core.Lifecycle;<a name="line.22"></a>
<FONT color="green">023</FONT> import org.apache.logging.log4j.core.LogEvent;<a name="line.23"></a>
<FONT color="green">024</FONT> import org.apache.logging.log4j.core.Logger;<a name="line.24"></a>
<FONT color="green">025</FONT> import org.apache.logging.log4j.status.StatusLogger;<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> /**<a name="line.28"></a>
<FONT color="green">029</FONT> * Users should extend this class to implement filters. Filters can be either context wide or attached to<a name="line.29"></a>
<FONT color="green">030</FONT> * an appender. A filter may choose to support being called only from the context or only from an appender in<a name="line.30"></a>
<FONT color="green">031</FONT> * which case it will only implement the required method(s). The rest will default to return NEUTRAL.<a name="line.31"></a>
<FONT color="green">032</FONT> *<a name="line.32"></a>
<FONT color="green">033</FONT> */<a name="line.33"></a>
<FONT color="green">034</FONT> public abstract class FilterBase implements Filter, Lifecycle {<a name="line.34"></a>
<FONT color="green">035</FONT> /**<a name="line.35"></a>
<FONT color="green">036</FONT> * Allow subclasses access to the status logger without creating another instance.<a name="line.36"></a>
<FONT color="green">037</FONT> */<a name="line.37"></a>
<FONT color="green">038</FONT> protected static final org.apache.logging.log4j.Logger LOGGER = StatusLogger.getLogger();<a name="line.38"></a>
<FONT color="green">039</FONT> <a name="line.39"></a>
<FONT color="green">040</FONT> /**<a name="line.40"></a>
<FONT color="green">041</FONT> * The onMatch Result.<a name="line.41"></a>
<FONT color="green">042</FONT> */<a name="line.42"></a>
<FONT color="green">043</FONT> protected final Result onMatch;<a name="line.43"></a>
<FONT color="green">044</FONT> <a name="line.44"></a>
<FONT color="green">045</FONT> /**<a name="line.45"></a>
<FONT color="green">046</FONT> * The onMismatch Result.<a name="line.46"></a>
<FONT color="green">047</FONT> */<a name="line.47"></a>
<FONT color="green">048</FONT> protected final Result onMismatch;<a name="line.48"></a>
<FONT color="green">049</FONT> <a name="line.49"></a>
<FONT color="green">050</FONT> private boolean started;<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> * The default constructor.<a name="line.53"></a>
<FONT color="green">054</FONT> */<a name="line.54"></a>
<FONT color="green">055</FONT> protected FilterBase() {<a name="line.55"></a>
<FONT color="green">056</FONT> this(null, null);<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> /**<a name="line.59"></a>
<FONT color="green">060</FONT> * Constructor that allows the onMatch and onMismatch actions to be set.<a name="line.60"></a>
<FONT color="green">061</FONT> * @param onMatch The result to return when a match occurs.<a name="line.61"></a>
<FONT color="green">062</FONT> * @param onMismatch The result to return when a match dos not occur.<a name="line.62"></a>
<FONT color="green">063</FONT> */<a name="line.63"></a>
<FONT color="green">064</FONT> protected FilterBase(Result onMatch, Result onMismatch) {<a name="line.64"></a>
<FONT color="green">065</FONT> this.onMatch = onMatch == null ? Result.NEUTRAL : onMatch;<a name="line.65"></a>
<FONT color="green">066</FONT> this.onMismatch = onMismatch == null ? Result.DENY : onMismatch;<a name="line.66"></a>
<FONT color="green">067</FONT> }<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> * Mark the Filter as started.<a name="line.70"></a>
<FONT color="green">071</FONT> */<a name="line.71"></a>
<FONT color="green">072</FONT> public void start() {<a name="line.72"></a>
<FONT color="green">073</FONT> started = true;<a name="line.73"></a>
<FONT color="green">074</FONT> }<a name="line.74"></a>
<FONT color="green">075</FONT> <a name="line.75"></a>
<FONT color="green">076</FONT> /**<a name="line.76"></a>
<FONT color="green">077</FONT> * Determine if the the Filter has started.<a name="line.77"></a>
<FONT color="green">078</FONT> * @return true if the Filter is started, false otherwise.<a name="line.78"></a>
<FONT color="green">079</FONT> */<a name="line.79"></a>
<FONT color="green">080</FONT> public boolean isStarted() {<a name="line.80"></a>
<FONT color="green">081</FONT> return started;<a name="line.81"></a>
<FONT color="green">082</FONT> }<a name="line.82"></a>
<FONT color="green">083</FONT> <a name="line.83"></a>
<FONT color="green">084</FONT> /**<a name="line.84"></a>
<FONT color="green">085</FONT> * Mark the Filter as stopped.<a name="line.85"></a>
<FONT color="green">086</FONT> */<a name="line.86"></a>
<FONT color="green">087</FONT> public void stop() {<a name="line.87"></a>
<FONT color="green">088</FONT> started = false;<a name="line.88"></a>
<FONT color="green">089</FONT> }<a name="line.89"></a>
<FONT color="green">090</FONT> <a name="line.90"></a>
<FONT color="green">091</FONT> /**<a name="line.91"></a>
<FONT color="green">092</FONT> * Return the Result to be returned when a match does not occur.<a name="line.92"></a>
<FONT color="green">093</FONT> * @return the onMismatch Result.<a name="line.93"></a>
<FONT color="green">094</FONT> */<a name="line.94"></a>
<FONT color="green">095</FONT> public final Result getOnMismatch() {<a name="line.95"></a>
<FONT color="green">096</FONT> return onMismatch;<a name="line.96"></a>
<FONT color="green">097</FONT> }<a name="line.97"></a>
<FONT color="green">098</FONT> <a name="line.98"></a>
<FONT color="green">099</FONT> /**<a name="line.99"></a>
<FONT color="green">100</FONT> * Return the Result to be returned when a match occurs.<a name="line.100"></a>
<FONT color="green">101</FONT> * @return the onMatch Result.<a name="line.101"></a>
<FONT color="green">102</FONT> */<a name="line.102"></a>
<FONT color="green">103</FONT> public final Result getOnMatch() {<a name="line.103"></a>
<FONT color="green">104</FONT> return onMatch;<a name="line.104"></a>
<FONT color="green">105</FONT> }<a name="line.105"></a>
<FONT color="green">106</FONT> <a name="line.106"></a>
<FONT color="green">107</FONT> @Override<a name="line.107"></a>
<FONT color="green">108</FONT> public String toString() {<a name="line.108"></a>
<FONT color="green">109</FONT> return this.getClass().getSimpleName();<a name="line.109"></a>
<FONT color="green">110</FONT> }<a name="line.110"></a>
<FONT color="green">111</FONT> <a name="line.111"></a>
<FONT color="green">112</FONT> /**<a name="line.112"></a>
<FONT color="green">113</FONT> * Appender Filter method. The default returns NEUTRAL.<a name="line.113"></a>
<FONT color="green">114</FONT> * @param logger the Logger.<a name="line.114"></a>
<FONT color="green">115</FONT> * @param level The logging Level.<a name="line.115"></a>
<FONT color="green">116</FONT> * @param marker The Marker, if any.<a name="line.116"></a>
<FONT color="green">117</FONT> * @param msg The message, if present.<a name="line.117"></a>
<FONT color="green">118</FONT> * @param params An array of parameters or null.<a name="line.118"></a>
<FONT color="green">119</FONT> * @return The Result of filtering.<a name="line.119"></a>
<FONT color="green">120</FONT> */<a name="line.120"></a>
<FONT color="green">121</FONT> public Result filter(Logger logger, Level level, Marker marker, String msg, Object[] params) {<a name="line.121"></a>
<FONT color="green">122</FONT> return Result.NEUTRAL;<a name="line.122"></a>
<FONT color="green">123</FONT> }<a name="line.123"></a>
<FONT color="green">124</FONT> <a name="line.124"></a>
<FONT color="green">125</FONT> /**<a name="line.125"></a>
<FONT color="green">126</FONT> * Appender Filter method. The default returns NEUTRAL.<a name="line.126"></a>
<FONT color="green">127</FONT> * @param logger the Logger.<a name="line.127"></a>
<FONT color="green">128</FONT> * @param level The logging Level.<a name="line.128"></a>
<FONT color="green">129</FONT> * @param marker The Marker, if any.<a name="line.129"></a>
<FONT color="green">130</FONT> * @param msg The message, if present.<a name="line.130"></a>
<FONT color="green">131</FONT> * @param t A throwable or null.<a name="line.131"></a>
<FONT color="green">132</FONT> * @return The Result of filtering.<a name="line.132"></a>
<FONT color="green">133</FONT> */<a name="line.133"></a>
<FONT color="green">134</FONT> public Result filter(Logger logger, Level level, Marker marker, Object msg, Throwable t) {<a name="line.134"></a>
<FONT color="green">135</FONT> return Result.NEUTRAL;<a name="line.135"></a>
<FONT color="green">136</FONT> }<a name="line.136"></a>
<FONT color="green">137</FONT> <a name="line.137"></a>
<FONT color="green">138</FONT> /**<a name="line.138"></a>
<FONT color="green">139</FONT> * Appender Filter method. The default returns NEUTRAL.<a name="line.139"></a>
<FONT color="green">140</FONT> * @param logger the Logger.<a name="line.140"></a>
<FONT color="green">141</FONT> * @param level The logging Level.<a name="line.141"></a>
<FONT color="green">142</FONT> * @param marker The Marker, if any.<a name="line.142"></a>
<FONT color="green">143</FONT> * @param msg The message, if present.<a name="line.143"></a>
<FONT color="green">144</FONT> * @param t A throwable or null.<a name="line.144"></a>
<FONT color="green">145</FONT> * @return The Result of filtering.<a name="line.145"></a>
<FONT color="green">146</FONT> */<a name="line.146"></a>
<FONT color="green">147</FONT> public Result filter(Logger logger, Level level, Marker marker, Message msg, Throwable t) {<a name="line.147"></a>
<FONT color="green">148</FONT> return Result.NEUTRAL;<a name="line.148"></a>
<FONT color="green">149</FONT> }<a name="line.149"></a>
<FONT color="green">150</FONT> <a name="line.150"></a>
<FONT color="green">151</FONT> /**<a name="line.151"></a>
<FONT color="green">152</FONT> * Context Filter method. The default returns NEUTRAL.<a name="line.152"></a>
<FONT color="green">153</FONT> * @param event The LogEvent.<a name="line.153"></a>
<FONT color="green">154</FONT> * @return The Result of filtering.<a name="line.154"></a>
<FONT color="green">155</FONT> */<a name="line.155"></a>
<FONT color="green">156</FONT> public Result filter(LogEvent event) {<a name="line.156"></a>
<FONT color="green">157</FONT> return Result.NEUTRAL;<a name="line.157"></a>
<FONT color="green">158</FONT> }<a name="line.158"></a>
<FONT color="green">159</FONT> }<a name="line.159"></a>
</PRE>
</BODY>
</HTML>