Google Git
Sign in
apache / logging-log4j-site / d0d0de55986756593c08e5d2b8059541eacaf428 / . / log4j-2.0-alpha1-SNAPSHOT / log4j-core / apidocs / src-html / org / apache / logging / log4j / core / appender / rewrite / RewriteAppender.html
blob: df7ccd077921013faf6f4629059c05daa3ef360a [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.appender.rewrite;<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.core.Appender;<a name="line.19"></a>
<FONT color="green">020</FONT> import org.apache.logging.log4j.core.Filter;<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.appender.AppenderBase;<a name="line.22"></a>
<FONT color="green">023</FONT> import org.apache.logging.log4j.core.config.AppenderControl;<a name="line.23"></a>
<FONT color="green">024</FONT> import org.apache.logging.log4j.core.config.AppenderRef;<a name="line.24"></a>
<FONT color="green">025</FONT> import org.apache.logging.log4j.core.config.Configuration;<a name="line.25"></a>
<FONT color="green">026</FONT> import org.apache.logging.log4j.core.config.plugins.Plugin;<a name="line.26"></a>
<FONT color="green">027</FONT> import org.apache.logging.log4j.core.config.plugins.PluginAttr;<a name="line.27"></a>
<FONT color="green">028</FONT> import org.apache.logging.log4j.core.config.plugins.PluginConfiguration;<a name="line.28"></a>
<FONT color="green">029</FONT> import org.apache.logging.log4j.core.config.plugins.PluginElement;<a name="line.29"></a>
<FONT color="green">030</FONT> import org.apache.logging.log4j.core.config.plugins.PluginFactory;<a name="line.30"></a>
<FONT color="green">031</FONT> <a name="line.31"></a>
<FONT color="green">032</FONT> import java.util.Map;<a name="line.32"></a>
<FONT color="green">033</FONT> import java.util.concurrent.ConcurrentHashMap;<a name="line.33"></a>
<FONT color="green">034</FONT> import java.util.concurrent.ConcurrentMap;<a name="line.34"></a>
<FONT color="green">035</FONT> <a name="line.35"></a>
<FONT color="green">036</FONT> /**<a name="line.36"></a>
<FONT color="green">037</FONT> * This Appender allows the logging event to be manipulated before it is processed by other Appenders.<a name="line.37"></a>
<FONT color="green">038</FONT> */<a name="line.38"></a>
<FONT color="green">039</FONT> @Plugin(name = "Rewrite", type = "Core", elementType = "appender", printObject = true)<a name="line.39"></a>
<FONT color="green">040</FONT> public final class RewriteAppender extends AppenderBase {<a name="line.40"></a>
<FONT color="green">041</FONT> private final Configuration config;<a name="line.41"></a>
<FONT color="green">042</FONT> private ConcurrentMap&lt;String, AppenderControl&gt; appenders = new ConcurrentHashMap&lt;String, AppenderControl&gt;();<a name="line.42"></a>
<FONT color="green">043</FONT> private final RewritePolicy rewritePolicy;<a name="line.43"></a>
<FONT color="green">044</FONT> private final AppenderRef[] appenderRefs;<a name="line.44"></a>
<FONT color="green">045</FONT> <a name="line.45"></a>
<FONT color="green">046</FONT> private RewriteAppender(String name, Filter filter, boolean handleException, AppenderRef[] appenderRefs,<a name="line.46"></a>
<FONT color="green">047</FONT> RewritePolicy rewritePolicy, Configuration config) {<a name="line.47"></a>
<FONT color="green">048</FONT> super(name, filter, null, handleException);<a name="line.48"></a>
<FONT color="green">049</FONT> this.config = config;<a name="line.49"></a>
<FONT color="green">050</FONT> this.rewritePolicy = rewritePolicy;<a name="line.50"></a>
<FONT color="green">051</FONT> this.appenderRefs = appenderRefs;<a name="line.51"></a>
<FONT color="green">052</FONT> }<a name="line.52"></a>
<FONT color="green">053</FONT> <a name="line.53"></a>
<FONT color="green">054</FONT> @Override<a name="line.54"></a>
<FONT color="green">055</FONT> public void start() {<a name="line.55"></a>
<FONT color="green">056</FONT> Map&lt;String, Appender&gt; map = config.getAppenders();<a name="line.56"></a>
<FONT color="green">057</FONT> for (AppenderRef ref : appenderRefs) {<a name="line.57"></a>
<FONT color="green">058</FONT> String name = ref.getRef();<a name="line.58"></a>
<FONT color="green">059</FONT> Appender appender = map.get(name);<a name="line.59"></a>
<FONT color="green">060</FONT> if (appender != null) {<a name="line.60"></a>
<FONT color="green">061</FONT> appenders.put(name, new AppenderControl(appender, ref.getLevel(), null));<a name="line.61"></a>
<FONT color="green">062</FONT> } else {<a name="line.62"></a>
<FONT color="green">063</FONT> LOGGER.error("Appender " + ref + " cannot be located. Reference ignored");<a name="line.63"></a>
<FONT color="green">064</FONT> }<a name="line.64"></a>
<FONT color="green">065</FONT> }<a name="line.65"></a>
<FONT color="green">066</FONT> super.start();<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> @Override<a name="line.69"></a>
<FONT color="green">070</FONT> public void stop() {<a name="line.70"></a>
<FONT color="green">071</FONT> super.stop();<a name="line.71"></a>
<FONT color="green">072</FONT> for (AppenderControl control : appenders.values()) {<a name="line.72"></a>
<FONT color="green">073</FONT> control.getAppender().stop();<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> /**<a name="line.77"></a>
<FONT color="green">078</FONT> * Modify the event and pass to the subordinate Appenders.<a name="line.78"></a>
<FONT color="green">079</FONT> * @param event The LogEvent.<a name="line.79"></a>
<FONT color="green">080</FONT> */<a name="line.80"></a>
<FONT color="green">081</FONT> public void append(LogEvent event) {<a name="line.81"></a>
<FONT color="green">082</FONT> if (rewritePolicy != null) {<a name="line.82"></a>
<FONT color="green">083</FONT> event = rewritePolicy.rewrite(event);<a name="line.83"></a>
<FONT color="green">084</FONT> }<a name="line.84"></a>
<FONT color="green">085</FONT> for (AppenderControl control : appenders.values()) {<a name="line.85"></a>
<FONT color="green">086</FONT> control.callAppender(event);<a name="line.86"></a>
<FONT color="green">087</FONT> }<a name="line.87"></a>
<FONT color="green">088</FONT> }<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> * Create a RewriteAppender.<a name="line.91"></a>
<FONT color="green">092</FONT> * @param name The name of the Appender.<a name="line.92"></a>
<FONT color="green">093</FONT> * @param suppress If true, exceptions will be handled in the Appender.<a name="line.93"></a>
<FONT color="green">094</FONT> * @param appenderRefs An array of Appender names to call.<a name="line.94"></a>
<FONT color="green">095</FONT> * @param config The Configuration.<a name="line.95"></a>
<FONT color="green">096</FONT> * @param rewritePolicy The policy to use to modify the event.<a name="line.96"></a>
<FONT color="green">097</FONT> * @param filter A Filter to filter events.<a name="line.97"></a>
<FONT color="green">098</FONT> * @return The created RewriteAppender.<a name="line.98"></a>
<FONT color="green">099</FONT> */<a name="line.99"></a>
<FONT color="green">100</FONT> @PluginFactory<a name="line.100"></a>
<FONT color="green">101</FONT> public static RewriteAppender createAppender(@PluginAttr("name") String name,<a name="line.101"></a>
<FONT color="green">102</FONT> @PluginAttr("suppressExceptions") String suppress,<a name="line.102"></a>
<FONT color="green">103</FONT> @PluginElement("appender-ref") AppenderRef[] appenderRefs,<a name="line.103"></a>
<FONT color="green">104</FONT> @PluginConfiguration Configuration config,<a name="line.104"></a>
<FONT color="green">105</FONT> @PluginElement("rewritePolicy") RewritePolicy rewritePolicy,<a name="line.105"></a>
<FONT color="green">106</FONT> @PluginElement("filter") Filter filter) {<a name="line.106"></a>
<FONT color="green">107</FONT> <a name="line.107"></a>
<FONT color="green">108</FONT> boolean handleExceptions = suppress == null ? true : Boolean.valueOf(suppress);<a name="line.108"></a>
<FONT color="green">109</FONT> <a name="line.109"></a>
<FONT color="green">110</FONT> if (name == null) {<a name="line.110"></a>
<FONT color="green">111</FONT> LOGGER.error("No name provided for RewriteAppender");<a name="line.111"></a>
<FONT color="green">112</FONT> return null;<a name="line.112"></a>
<FONT color="green">113</FONT> }<a name="line.113"></a>
<FONT color="green">114</FONT> if (appenderRefs == null) {<a name="line.114"></a>
<FONT color="green">115</FONT> LOGGER.error("No appender references defined for RewriteAppender");<a name="line.115"></a>
<FONT color="green">116</FONT> return null;<a name="line.116"></a>
<FONT color="green">117</FONT> }<a name="line.117"></a>
<FONT color="green">118</FONT> return new RewriteAppender(name, filter, handleExceptions, appenderRefs, rewritePolicy, config);<a name="line.118"></a>
<FONT color="green">119</FONT> }<a name="line.119"></a>
<FONT color="green">120</FONT> }<a name="line.120"></a>
</PRE>
</BODY>
</HTML>