| <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> |
| <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en"> |
| <head> |
| <meta http-equiv="content-type" content="text/html; charset=UTF-8" /> |
| <title>RewriteAppender xref</title> |
| <link type="text/css" rel="stylesheet" href="../../../../../../../stylesheet.css" /> |
| </head> |
| <body> |
| <div id="overview"><a href="../../../../../../../../apidocs/org/apache/logging/log4j/core/appender/rewrite/RewriteAppender.html">View Javadoc</a></div><pre> |
| |
| <a class="jxr_linenumber" name="1" href="#1">1</a> <em class="jxr_comment">/*</em> |
| <a class="jxr_linenumber" name="2" href="#2">2</a> <em class="jxr_comment"> * Licensed to the Apache Software Foundation (ASF) under one or more</em> |
| <a class="jxr_linenumber" name="3" href="#3">3</a> <em class="jxr_comment"> * contributor license agreements. See the NOTICE file distributed with</em> |
| <a class="jxr_linenumber" name="4" href="#4">4</a> <em class="jxr_comment"> * this work for additional information regarding copyright ownership.</em> |
| <a class="jxr_linenumber" name="5" href="#5">5</a> <em class="jxr_comment"> * The ASF licenses this file to You under the Apache license, Version 2.0</em> |
| <a class="jxr_linenumber" name="6" href="#6">6</a> <em class="jxr_comment"> * (the "License"); you may not use this file except in compliance with</em> |
| <a class="jxr_linenumber" name="7" href="#7">7</a> <em class="jxr_comment"> * the License. You may obtain a copy of the License at</em> |
| <a class="jxr_linenumber" name="8" href="#8">8</a> <em class="jxr_comment"> *</em> |
| <a class="jxr_linenumber" name="9" href="#9">9</a> <em class="jxr_comment"> * <a href="http://www.apache.org/licenses/LICENSE-2.0" target="alexandria_uri">http://www.apache.org/licenses/LICENSE-2.0</a></em> |
| <a class="jxr_linenumber" name="10" href="#10">10</a> <em class="jxr_comment"> *</em> |
| <a class="jxr_linenumber" name="11" href="#11">11</a> <em class="jxr_comment"> * Unless required by applicable law or agreed to in writing, software</em> |
| <a class="jxr_linenumber" name="12" href="#12">12</a> <em class="jxr_comment"> * distributed under the License is distributed on an "AS IS" BASIS,</em> |
| <a class="jxr_linenumber" name="13" href="#13">13</a> <em class="jxr_comment"> * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.</em> |
| <a class="jxr_linenumber" name="14" href="#14">14</a> <em class="jxr_comment"> * See the license for the specific language governing permissions and</em> |
| <a class="jxr_linenumber" name="15" href="#15">15</a> <em class="jxr_comment"> * limitations under the license.</em> |
| <a class="jxr_linenumber" name="16" href="#16">16</a> <em class="jxr_comment"> */</em> |
| <a class="jxr_linenumber" name="17" href="#17">17</a> <strong class="jxr_keyword">package</strong> org.apache.logging.log4j.core.appender.rewrite; |
| <a class="jxr_linenumber" name="18" href="#18">18</a> |
| <a class="jxr_linenumber" name="19" href="#19">19</a> <strong class="jxr_keyword">import</strong> org.apache.logging.log4j.core.Appender; |
| <a class="jxr_linenumber" name="20" href="#20">20</a> <strong class="jxr_keyword">import</strong> org.apache.logging.log4j.core.Filter; |
| <a class="jxr_linenumber" name="21" href="#21">21</a> <strong class="jxr_keyword">import</strong> org.apache.logging.log4j.core.LogEvent; |
| <a class="jxr_linenumber" name="22" href="#22">22</a> <strong class="jxr_keyword">import</strong> org.apache.logging.log4j.core.appender.AppenderBase; |
| <a class="jxr_linenumber" name="23" href="#23">23</a> <strong class="jxr_keyword">import</strong> org.apache.logging.log4j.core.config.AppenderControl; |
| <a class="jxr_linenumber" name="24" href="#24">24</a> <strong class="jxr_keyword">import</strong> org.apache.logging.log4j.core.config.AppenderRef; |
| <a class="jxr_linenumber" name="25" href="#25">25</a> <strong class="jxr_keyword">import</strong> org.apache.logging.log4j.core.config.Configuration; |
| <a class="jxr_linenumber" name="26" href="#26">26</a> <strong class="jxr_keyword">import</strong> org.apache.logging.log4j.core.config.plugins.Plugin; |
| <a class="jxr_linenumber" name="27" href="#27">27</a> <strong class="jxr_keyword">import</strong> org.apache.logging.log4j.core.config.plugins.PluginAttr; |
| <a class="jxr_linenumber" name="28" href="#28">28</a> <strong class="jxr_keyword">import</strong> org.apache.logging.log4j.core.config.plugins.PluginConfiguration; |
| <a class="jxr_linenumber" name="29" href="#29">29</a> <strong class="jxr_keyword">import</strong> org.apache.logging.log4j.core.config.plugins.PluginElement; |
| <a class="jxr_linenumber" name="30" href="#30">30</a> <strong class="jxr_keyword">import</strong> org.apache.logging.log4j.core.config.plugins.PluginFactory; |
| <a class="jxr_linenumber" name="31" href="#31">31</a> |
| <a class="jxr_linenumber" name="32" href="#32">32</a> <strong class="jxr_keyword">import</strong> java.util.Map; |
| <a class="jxr_linenumber" name="33" href="#33">33</a> <strong class="jxr_keyword">import</strong> java.util.concurrent.ConcurrentHashMap; |
| <a class="jxr_linenumber" name="34" href="#34">34</a> <strong class="jxr_keyword">import</strong> java.util.concurrent.ConcurrentMap; |
| <a class="jxr_linenumber" name="35" href="#35">35</a> |
| <a class="jxr_linenumber" name="36" href="#36">36</a> <em class="jxr_javadoccomment">/**</em> |
| <a class="jxr_linenumber" name="37" href="#37">37</a> <em class="jxr_javadoccomment"> * This Appender allows the logging event to be manipulated before it is processed by other Appenders.</em> |
| <a class="jxr_linenumber" name="38" href="#38">38</a> <em class="jxr_javadoccomment"> */</em> |
| <a class="jxr_linenumber" name="39" href="#39">39</a> @Plugin(name = <span class="jxr_string">"Rewrite"</span>, type = <span class="jxr_string">"Core"</span>, elementType = <span class="jxr_string">"appender"</span>, printObject = <strong class="jxr_keyword">true</strong>) |
| <a class="jxr_linenumber" name="40" href="#40">40</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">final</strong> <strong class="jxr_keyword">class</strong> <a href="../../../../../../../org/apache/logging/log4j/core/appender/rewrite/RewriteAppender.html">RewriteAppender</a> <strong class="jxr_keyword">extends</strong> <a href="../../../../../../../org/apache/logging/log4j/core/appender/AppenderBase.html">AppenderBase</a> { |
| <a class="jxr_linenumber" name="41" href="#41">41</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">final</strong> <a href="../../../../../../../org/apache/logging/log4j/core/config/Configuration.html">Configuration</a> config; |
| <a class="jxr_linenumber" name="42" href="#42">42</a> <strong class="jxr_keyword">private</strong> ConcurrentMap<String, AppenderControl> appenders = <strong class="jxr_keyword">new</strong> ConcurrentHashMap<String, AppenderControl>(); |
| <a class="jxr_linenumber" name="43" href="#43">43</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">final</strong> <a href="../../../../../../../org/apache/logging/log4j/core/appender/rewrite/RewritePolicy.html">RewritePolicy</a> rewritePolicy; |
| <a class="jxr_linenumber" name="44" href="#44">44</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">final</strong> <a href="../../../../../../../org/apache/logging/log4j/core/config/AppenderRef.html">AppenderRef</a>[] appenderRefs; |
| <a class="jxr_linenumber" name="45" href="#45">45</a> |
| <a class="jxr_linenumber" name="46" href="#46">46</a> <strong class="jxr_keyword">private</strong> <a href="../../../../../../../org/apache/logging/log4j/core/appender/rewrite/RewriteAppender.html">RewriteAppender</a>(String name, <a href="../../../../../../../org/apache/logging/log4j/core/Filter.html">Filter</a> filter, <strong class="jxr_keyword">boolean</strong> handleException, <a href="../../../../../../../org/apache/logging/log4j/core/config/AppenderRef.html">AppenderRef</a>[] appenderRefs, |
| <a class="jxr_linenumber" name="47" href="#47">47</a> <a href="../../../../../../../org/apache/logging/log4j/core/appender/rewrite/RewritePolicy.html">RewritePolicy</a> rewritePolicy, <a href="../../../../../../../org/apache/logging/log4j/core/config/Configuration.html">Configuration</a> config) { |
| <a class="jxr_linenumber" name="48" href="#48">48</a> <strong class="jxr_keyword">super</strong>(name, filter, <strong class="jxr_keyword">null</strong>, handleException); |
| <a class="jxr_linenumber" name="49" href="#49">49</a> <strong class="jxr_keyword">this</strong>.config = config; |
| <a class="jxr_linenumber" name="50" href="#50">50</a> <strong class="jxr_keyword">this</strong>.rewritePolicy = rewritePolicy; |
| <a class="jxr_linenumber" name="51" href="#51">51</a> <strong class="jxr_keyword">this</strong>.appenderRefs = appenderRefs; |
| <a class="jxr_linenumber" name="52" href="#52">52</a> } |
| <a class="jxr_linenumber" name="53" href="#53">53</a> |
| <a class="jxr_linenumber" name="54" href="#54">54</a> @Override |
| <a class="jxr_linenumber" name="55" href="#55">55</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> start() { |
| <a class="jxr_linenumber" name="56" href="#56">56</a> Map<String, Appender> map = config.getAppenders(); |
| <a class="jxr_linenumber" name="57" href="#57">57</a> <strong class="jxr_keyword">for</strong> (AppenderRef ref : appenderRefs) { |
| <a class="jxr_linenumber" name="58" href="#58">58</a> String name = ref.getRef(); |
| <a class="jxr_linenumber" name="59" href="#59">59</a> <a href="../../../../../../../org/apache/logging/log4j/core/Appender.html">Appender</a> appender = map.get(name); |
| <a class="jxr_linenumber" name="60" href="#60">60</a> <strong class="jxr_keyword">if</strong> (appender != <strong class="jxr_keyword">null</strong>) { |
| <a class="jxr_linenumber" name="61" href="#61">61</a> appenders.put(name, <strong class="jxr_keyword">new</strong> <a href="../../../../../../../org/apache/logging/log4j/core/config/AppenderControl.html">AppenderControl</a>(appender, ref.getLevel(), <strong class="jxr_keyword">null</strong>)); |
| <a class="jxr_linenumber" name="62" href="#62">62</a> } <strong class="jxr_keyword">else</strong> { |
| <a class="jxr_linenumber" name="63" href="#63">63</a> LOGGER.error(<span class="jxr_string">"Appender "</span> + ref + <span class="jxr_string">" cannot be located. Reference ignored"</span>); |
| <a class="jxr_linenumber" name="64" href="#64">64</a> } |
| <a class="jxr_linenumber" name="65" href="#65">65</a> } |
| <a class="jxr_linenumber" name="66" href="#66">66</a> <strong class="jxr_keyword">super</strong>.start(); |
| <a class="jxr_linenumber" name="67" href="#67">67</a> } |
| <a class="jxr_linenumber" name="68" href="#68">68</a> |
| <a class="jxr_linenumber" name="69" href="#69">69</a> @Override |
| <a class="jxr_linenumber" name="70" href="#70">70</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> stop() { |
| <a class="jxr_linenumber" name="71" href="#71">71</a> <strong class="jxr_keyword">super</strong>.stop(); |
| <a class="jxr_linenumber" name="72" href="#72">72</a> <strong class="jxr_keyword">for</strong> (AppenderControl control : appenders.values()) { |
| <a class="jxr_linenumber" name="73" href="#73">73</a> control.getAppender().stop(); |
| <a class="jxr_linenumber" name="74" href="#74">74</a> } |
| <a class="jxr_linenumber" name="75" href="#75">75</a> } |
| <a class="jxr_linenumber" name="76" href="#76">76</a> |
| <a class="jxr_linenumber" name="77" href="#77">77</a> <em class="jxr_javadoccomment">/**</em> |
| <a class="jxr_linenumber" name="78" href="#78">78</a> <em class="jxr_javadoccomment"> * Modify the event and pass to the subordinate Appenders.</em> |
| <a class="jxr_linenumber" name="79" href="#79">79</a> <em class="jxr_javadoccomment"> * @param event The LogEvent.</em> |
| <a class="jxr_linenumber" name="80" href="#80">80</a> <em class="jxr_javadoccomment"> */</em> |
| <a class="jxr_linenumber" name="81" href="#81">81</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> append(<a href="../../../../../../../org/apache/logging/log4j/core/LogEvent.html">LogEvent</a> event) { |
| <a class="jxr_linenumber" name="82" href="#82">82</a> <strong class="jxr_keyword">if</strong> (rewritePolicy != <strong class="jxr_keyword">null</strong>) { |
| <a class="jxr_linenumber" name="83" href="#83">83</a> event = rewritePolicy.rewrite(event); |
| <a class="jxr_linenumber" name="84" href="#84">84</a> } |
| <a class="jxr_linenumber" name="85" href="#85">85</a> <strong class="jxr_keyword">for</strong> (AppenderControl control : appenders.values()) { |
| <a class="jxr_linenumber" name="86" href="#86">86</a> control.callAppender(event); |
| <a class="jxr_linenumber" name="87" href="#87">87</a> } |
| <a class="jxr_linenumber" name="88" href="#88">88</a> } |
| <a class="jxr_linenumber" name="89" href="#89">89</a> |
| <a class="jxr_linenumber" name="90" href="#90">90</a> <em class="jxr_javadoccomment">/**</em> |
| <a class="jxr_linenumber" name="91" href="#91">91</a> <em class="jxr_javadoccomment"> * Create a RewriteAppender.</em> |
| <a class="jxr_linenumber" name="92" href="#92">92</a> <em class="jxr_javadoccomment"> * @param name The name of the Appender.</em> |
| <a class="jxr_linenumber" name="93" href="#93">93</a> <em class="jxr_javadoccomment"> * @param suppress If true, exceptions will be handled in the Appender.</em> |
| <a class="jxr_linenumber" name="94" href="#94">94</a> <em class="jxr_javadoccomment"> * @param appenderRefs An array of Appender names to call.</em> |
| <a class="jxr_linenumber" name="95" href="#95">95</a> <em class="jxr_javadoccomment"> * @param config The Configuration.</em> |
| <a class="jxr_linenumber" name="96" href="#96">96</a> <em class="jxr_javadoccomment"> * @param rewritePolicy The policy to use to modify the event.</em> |
| <a class="jxr_linenumber" name="97" href="#97">97</a> <em class="jxr_javadoccomment"> * @param filter A Filter to filter events.</em> |
| <a class="jxr_linenumber" name="98" href="#98">98</a> <em class="jxr_javadoccomment"> * @return The created RewriteAppender.</em> |
| <a class="jxr_linenumber" name="99" href="#99">99</a> <em class="jxr_javadoccomment"> */</em> |
| <a class="jxr_linenumber" name="100" href="#100">100</a> @PluginFactory |
| <a class="jxr_linenumber" name="101" href="#101">101</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">static</strong> <a href="../../../../../../../org/apache/logging/log4j/core/appender/rewrite/RewriteAppender.html">RewriteAppender</a> createAppender(@PluginAttr(<span class="jxr_string">"name"</span>) String name, |
| <a class="jxr_linenumber" name="102" href="#102">102</a> @PluginAttr(<span class="jxr_string">"suppressExceptions"</span>) String suppress, |
| <a class="jxr_linenumber" name="103" href="#103">103</a> @PluginElement(<span class="jxr_string">"appender-ref"</span>) <a href="../../../../../../../org/apache/logging/log4j/core/config/AppenderRef.html">AppenderRef</a>[] appenderRefs, |
| <a class="jxr_linenumber" name="104" href="#104">104</a> @PluginConfiguration <a href="../../../../../../../org/apache/logging/log4j/core/config/Configuration.html">Configuration</a> config, |
| <a class="jxr_linenumber" name="105" href="#105">105</a> @PluginElement(<span class="jxr_string">"rewritePolicy"</span>) <a href="../../../../../../../org/apache/logging/log4j/core/appender/rewrite/RewritePolicy.html">RewritePolicy</a> rewritePolicy, |
| <a class="jxr_linenumber" name="106" href="#106">106</a> @PluginElement(<span class="jxr_string">"filter"</span>) <a href="../../../../../../../org/apache/logging/log4j/core/Filter.html">Filter</a> filter) { |
| <a class="jxr_linenumber" name="107" href="#107">107</a> |
| <a class="jxr_linenumber" name="108" href="#108">108</a> <strong class="jxr_keyword">boolean</strong> handleExceptions = suppress == <strong class="jxr_keyword">null</strong> ? <strong class="jxr_keyword">true</strong> : Boolean.valueOf(suppress); |
| <a class="jxr_linenumber" name="109" href="#109">109</a> |
| <a class="jxr_linenumber" name="110" href="#110">110</a> <strong class="jxr_keyword">if</strong> (name == <strong class="jxr_keyword">null</strong>) { |
| <a class="jxr_linenumber" name="111" href="#111">111</a> LOGGER.error(<span class="jxr_string">"No name provided for RewriteAppender"</span>); |
| <a class="jxr_linenumber" name="112" href="#112">112</a> <strong class="jxr_keyword">return</strong> <strong class="jxr_keyword">null</strong>; |
| <a class="jxr_linenumber" name="113" href="#113">113</a> } |
| <a class="jxr_linenumber" name="114" href="#114">114</a> <strong class="jxr_keyword">if</strong> (appenderRefs == <strong class="jxr_keyword">null</strong>) { |
| <a class="jxr_linenumber" name="115" href="#115">115</a> LOGGER.error(<span class="jxr_string">"No appender references defined for RewriteAppender"</span>); |
| <a class="jxr_linenumber" name="116" href="#116">116</a> <strong class="jxr_keyword">return</strong> <strong class="jxr_keyword">null</strong>; |
| <a class="jxr_linenumber" name="117" href="#117">117</a> } |
| <a class="jxr_linenumber" name="118" href="#118">118</a> <strong class="jxr_keyword">return</strong> <strong class="jxr_keyword">new</strong> <a href="../../../../../../../org/apache/logging/log4j/core/appender/rewrite/RewriteAppender.html">RewriteAppender</a>(name, filter, handleExceptions, appenderRefs, rewritePolicy, config); |
| <a class="jxr_linenumber" name="119" href="#119">119</a> } |
| <a class="jxr_linenumber" name="120" href="#120">120</a> } |
| </pre> |
| <hr/><div id="footer">This page was automatically generated by <a href="http://maven.apache.org/">Maven</a></div></body> |
| </html> |
| |
