| <!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>MapRewritePolicy 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/MapRewritePolicy.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.Logger; |
| <a class="jxr_linenumber" name="20" href="#20">20</a> <strong class="jxr_keyword">import</strong> org.apache.logging.log4j.core.LogEvent; |
| <a class="jxr_linenumber" name="21" href="#21">21</a> <strong class="jxr_keyword">import</strong> org.apache.logging.log4j.core.config.plugins.Plugin; |
| <a class="jxr_linenumber" name="22" href="#22">22</a> <strong class="jxr_keyword">import</strong> org.apache.logging.log4j.core.config.plugins.PluginAttr; |
| <a class="jxr_linenumber" name="23" href="#23">23</a> <strong class="jxr_keyword">import</strong> org.apache.logging.log4j.core.config.plugins.PluginElement; |
| <a class="jxr_linenumber" name="24" href="#24">24</a> <strong class="jxr_keyword">import</strong> org.apache.logging.log4j.core.config.plugins.PluginFactory; |
| <a class="jxr_linenumber" name="25" href="#25">25</a> <strong class="jxr_keyword">import</strong> org.apache.logging.log4j.core.helpers.KeyValuePair; |
| <a class="jxr_linenumber" name="26" href="#26">26</a> <strong class="jxr_keyword">import</strong> org.apache.logging.log4j.core.impl.Log4jLogEvent; |
| <a class="jxr_linenumber" name="27" href="#27">27</a> <strong class="jxr_keyword">import</strong> org.apache.logging.log4j.message.MapMessage; |
| <a class="jxr_linenumber" name="28" href="#28">28</a> <strong class="jxr_keyword">import</strong> org.apache.logging.log4j.message.Message; |
| <a class="jxr_linenumber" name="29" href="#29">29</a> <strong class="jxr_keyword">import</strong> org.apache.logging.log4j.status.StatusLogger; |
| <a class="jxr_linenumber" name="30" href="#30">30</a> |
| <a class="jxr_linenumber" name="31" href="#31">31</a> <strong class="jxr_keyword">import</strong> java.util.HashMap; |
| <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> |
| <a class="jxr_linenumber" name="34" href="#34">34</a> <em class="jxr_javadoccomment">/**</em> |
| <a class="jxr_linenumber" name="35" href="#35">35</a> <em class="jxr_javadoccomment"> * This policy modifies events by replacing or possibly adding keys and values to the MapMessage.</em> |
| <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> @Plugin(name = <span class="jxr_string">"MapRewritePolicy"</span>, type = <span class="jxr_string">"Core"</span>, elementType = <span class="jxr_string">"rewritePolicy"</span>, printObject = <strong class="jxr_keyword">true</strong>) |
| <a class="jxr_linenumber" name="38" href="#38">38</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/MapRewritePolicy.html">MapRewritePolicy</a> <strong class="jxr_keyword">implements</strong> <a href="../../../../../../../org/apache/logging/log4j/core/appender/rewrite/RewritePolicy.html">RewritePolicy</a> { |
| <a class="jxr_linenumber" name="39" href="#39">39</a> <em class="jxr_javadoccomment">/**</em> |
| <a class="jxr_linenumber" name="40" href="#40">40</a> <em class="jxr_javadoccomment"> * Allow subclasses access to the status logger without creating another instance.</em> |
| <a class="jxr_linenumber" name="41" href="#41">41</a> <em class="jxr_javadoccomment"> */</em> |
| <a class="jxr_linenumber" name="42" href="#42">42</a> <strong class="jxr_keyword">protected</strong> <strong class="jxr_keyword">static</strong> <strong class="jxr_keyword">final</strong> <a href="../../../../../../../org/apache/logging/log4j/core/Logger.html">Logger</a> LOGGER = StatusLogger.getLogger(); |
| <a class="jxr_linenumber" name="43" href="#43">43</a> |
| <a class="jxr_linenumber" name="44" href="#44">44</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">final</strong> Map<String, String> map; |
| <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> <strong class="jxr_keyword">final</strong> <a href="../../../../../../../org/apache/logging/log4j/core/appender/rewrite/MapRewritePolicy.html">Mode</a> mode; |
| <a class="jxr_linenumber" name="47" href="#47">47</a> |
| <a class="jxr_linenumber" name="48" href="#48">48</a> <strong class="jxr_keyword">private</strong> <a href="../../../../../../../org/apache/logging/log4j/core/appender/rewrite/MapRewritePolicy.html">MapRewritePolicy</a>(Map<String, String> map, <a href="../../../../../../../org/apache/logging/log4j/core/appender/rewrite/MapRewritePolicy.html">Mode</a> mode) { |
| <a class="jxr_linenumber" name="49" href="#49">49</a> <strong class="jxr_keyword">this</strong>.map = map; |
| <a class="jxr_linenumber" name="50" href="#50">50</a> <strong class="jxr_keyword">this</strong>.mode = mode; |
| <a class="jxr_linenumber" name="51" href="#51">51</a> } |
| <a class="jxr_linenumber" name="52" href="#52">52</a> |
| <a class="jxr_linenumber" name="53" href="#53">53</a> <em class="jxr_javadoccomment">/**</em> |
| <a class="jxr_linenumber" name="54" href="#54">54</a> <em class="jxr_javadoccomment"> * Rewrite the event.</em> |
| <a class="jxr_linenumber" name="55" href="#55">55</a> <em class="jxr_javadoccomment"> * @param source a logging event that may be returned or</em> |
| <a class="jxr_linenumber" name="56" href="#56">56</a> <em class="jxr_javadoccomment"> * used to create a new logging event.</em> |
| <a class="jxr_linenumber" name="57" href="#57">57</a> <em class="jxr_javadoccomment"> * @return The LogEvent after rewriting.</em> |
| <a class="jxr_linenumber" name="58" href="#58">58</a> <em class="jxr_javadoccomment"> */</em> |
| <a class="jxr_linenumber" name="59" href="#59">59</a> <strong class="jxr_keyword">public</strong> <a href="../../../../../../../org/apache/logging/log4j/core/LogEvent.html">LogEvent</a> rewrite(<a href="../../../../../../../org/apache/logging/log4j/core/LogEvent.html">LogEvent</a> source) { |
| <a class="jxr_linenumber" name="60" href="#60">60</a> Message msg = source.getMessage(); |
| <a class="jxr_linenumber" name="61" href="#61">61</a> <strong class="jxr_keyword">if</strong> (msg == <strong class="jxr_keyword">null</strong> || !(msg instanceof MapMessage)) { |
| <a class="jxr_linenumber" name="62" href="#62">62</a> <strong class="jxr_keyword">return</strong> source; |
| <a class="jxr_linenumber" name="63" href="#63">63</a> } |
| <a class="jxr_linenumber" name="64" href="#64">64</a> |
| <a class="jxr_linenumber" name="65" href="#65">65</a> Map<String, String> newMap = <strong class="jxr_keyword">new</strong> HashMap<String, String>(((MapMessage) msg).getData()); |
| <a class="jxr_linenumber" name="66" href="#66">66</a> <strong class="jxr_keyword">switch</strong> (mode) { |
| <a class="jxr_linenumber" name="67" href="#67">67</a> <strong class="jxr_keyword">case</strong> Add: { |
| <a class="jxr_linenumber" name="68" href="#68">68</a> newMap.putAll(map); |
| <a class="jxr_linenumber" name="69" href="#69">69</a> <strong class="jxr_keyword">break</strong>; |
| <a class="jxr_linenumber" name="70" href="#70">70</a> } |
| <a class="jxr_linenumber" name="71" href="#71">71</a> <strong class="jxr_keyword">default</strong>: { |
| <a class="jxr_linenumber" name="72" href="#72">72</a> <strong class="jxr_keyword">for</strong> (Map.Entry<String, String> entry : map.entrySet()) { |
| <a class="jxr_linenumber" name="73" href="#73">73</a> <strong class="jxr_keyword">if</strong> (newMap.containsKey(entry.getKey())) { |
| <a class="jxr_linenumber" name="74" href="#74">74</a> newMap.put(entry.getKey(), entry.getValue()); |
| <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> } |
| <a class="jxr_linenumber" name="78" href="#78">78</a> } |
| <a class="jxr_linenumber" name="79" href="#79">79</a> newMap.putAll(map); |
| <a class="jxr_linenumber" name="80" href="#80">80</a> MapMessage message = ((MapMessage) msg).newInstance(newMap); |
| <a class="jxr_linenumber" name="81" href="#81">81</a> <strong class="jxr_keyword">return</strong> <strong class="jxr_keyword">new</strong> <a href="../../../../../../../org/apache/logging/log4j/core/impl/Log4jLogEvent.html">Log4jLogEvent</a>(source.getLoggerName(), source.getMarker(), source.getFQCN(), source.getLevel(), |
| <a class="jxr_linenumber" name="82" href="#82">82</a> message, source.getThrown(), source.getContextMap(), source.getContextStack(), source.getThreadName(), |
| <a class="jxr_linenumber" name="83" href="#83">83</a> source.getSource(), source.getMillis()); |
| <a class="jxr_linenumber" name="84" href="#84">84</a> } |
| <a class="jxr_linenumber" name="85" href="#85">85</a> |
| <a class="jxr_linenumber" name="86" href="#86">86</a> <em class="jxr_javadoccomment">/**</em> |
| <a class="jxr_linenumber" name="87" href="#87">87</a> <em class="jxr_javadoccomment"> * An enumeration to identify whether keys not in the MapMessage should be added or whether only existing</em> |
| <a class="jxr_linenumber" name="88" href="#88">88</a> <em class="jxr_javadoccomment"> * keys should be updated.</em> |
| <a class="jxr_linenumber" name="89" href="#89">89</a> <em class="jxr_javadoccomment"> */</em> |
| <a class="jxr_linenumber" name="90" href="#90">90</a> <strong class="jxr_keyword">public</strong> enum <a href="../../../../../../../org/apache/logging/log4j/core/appender/rewrite/MapRewritePolicy.html">Mode</a> { |
| <a class="jxr_linenumber" name="91" href="#91">91</a> <em class="jxr_javadoccomment">/**</em> |
| <a class="jxr_linenumber" name="92" href="#92">92</a> <em class="jxr_javadoccomment"> * Keys should be added.</em> |
| <a class="jxr_linenumber" name="93" href="#93">93</a> <em class="jxr_javadoccomment"> */</em> |
| <a class="jxr_linenumber" name="94" href="#94">94</a> Add, |
| <a class="jxr_linenumber" name="95" href="#95">95</a> <em class="jxr_javadoccomment">/**</em> |
| <a class="jxr_linenumber" name="96" href="#96">96</a> <em class="jxr_javadoccomment"> * Keys should be updated.</em> |
| <a class="jxr_linenumber" name="97" href="#97">97</a> <em class="jxr_javadoccomment"> */</em> |
| <a class="jxr_linenumber" name="98" href="#98">98</a> Update |
| <a class="jxr_linenumber" name="99" href="#99">99</a> } |
| <a class="jxr_linenumber" name="100" href="#100">100</a> |
| <a class="jxr_linenumber" name="101" href="#101">101</a> @Override |
| <a class="jxr_linenumber" name="102" href="#102">102</a> <strong class="jxr_keyword">public</strong> String toString() { |
| <a class="jxr_linenumber" name="103" href="#103">103</a> StringBuilder sb = <strong class="jxr_keyword">new</strong> StringBuilder(); |
| <a class="jxr_linenumber" name="104" href="#104">104</a> sb.append(<span class="jxr_string">"mode="</span>).append(mode); |
| <a class="jxr_linenumber" name="105" href="#105">105</a> sb.append(<span class="jxr_string">" {"</span>); |
| <a class="jxr_linenumber" name="106" href="#106">106</a> <strong class="jxr_keyword">boolean</strong> first = <strong class="jxr_keyword">true</strong>; |
| <a class="jxr_linenumber" name="107" href="#107">107</a> <strong class="jxr_keyword">for</strong> (Map.Entry<String, String> entry : map.entrySet()) { |
| <a class="jxr_linenumber" name="108" href="#108">108</a> <strong class="jxr_keyword">if</strong> (!first) { |
| <a class="jxr_linenumber" name="109" href="#109">109</a> sb.append(<span class="jxr_string">", "</span>); |
| <a class="jxr_linenumber" name="110" href="#110">110</a> } |
| <a class="jxr_linenumber" name="111" href="#111">111</a> sb.append(entry.getKey()).append(<span class="jxr_string">"="</span>).append(entry.getValue()); |
| <a class="jxr_linenumber" name="112" href="#112">112</a> first = false; |
| <a class="jxr_linenumber" name="113" href="#113">113</a> } |
| <a class="jxr_linenumber" name="114" href="#114">114</a> sb.append(<span class="jxr_string">"}"</span>); |
| <a class="jxr_linenumber" name="115" href="#115">115</a> <strong class="jxr_keyword">return</strong> sb.toString(); |
| <a class="jxr_linenumber" name="116" href="#116">116</a> } |
| <a class="jxr_linenumber" name="117" href="#117">117</a> |
| <a class="jxr_linenumber" name="118" href="#118">118</a> <em class="jxr_javadoccomment">/**</em> |
| <a class="jxr_linenumber" name="119" href="#119">119</a> <em class="jxr_javadoccomment"> * The factory method to create the MapRewritePolicy.</em> |
| <a class="jxr_linenumber" name="120" href="#120">120</a> <em class="jxr_javadoccomment"> * @param mode The string representation of the Mode.</em> |
| <a class="jxr_linenumber" name="121" href="#121">121</a> <em class="jxr_javadoccomment"> * @param pairs key/value pairs for the new Map keys and values.</em> |
| <a class="jxr_linenumber" name="122" href="#122">122</a> <em class="jxr_javadoccomment"> * @return The MapRewritePolicy.</em> |
| <a class="jxr_linenumber" name="123" href="#123">123</a> <em class="jxr_javadoccomment"> */</em> |
| <a class="jxr_linenumber" name="124" href="#124">124</a> @PluginFactory |
| <a class="jxr_linenumber" name="125" href="#125">125</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">static</strong> <a href="../../../../../../../org/apache/logging/log4j/core/appender/rewrite/MapRewritePolicy.html">MapRewritePolicy</a> createPolicy(@PluginAttr(<span class="jxr_string">"mode"</span>) String mode, |
| <a class="jxr_linenumber" name="126" href="#126">126</a> @PluginElement(<span class="jxr_string">"KeyValuePair"</span>) <a href="../../../../../../../org/apache/logging/log4j/core/helpers/KeyValuePair.html">KeyValuePair</a>[] pairs) { |
| <a class="jxr_linenumber" name="127" href="#127">127</a> <a href="../../../../../../../org/apache/logging/log4j/core/appender/rewrite/MapRewritePolicy.html">Mode</a> op; |
| <a class="jxr_linenumber" name="128" href="#128">128</a> <strong class="jxr_keyword">if</strong> (mode == <strong class="jxr_keyword">null</strong>) { |
| <a class="jxr_linenumber" name="129" href="#129">129</a> op = Mode.Add; |
| <a class="jxr_linenumber" name="130" href="#130">130</a> } <strong class="jxr_keyword">else</strong> { |
| <a class="jxr_linenumber" name="131" href="#131">131</a> op = Mode.valueOf(mode); |
| <a class="jxr_linenumber" name="132" href="#132">132</a> <strong class="jxr_keyword">if</strong> (op == <strong class="jxr_keyword">null</strong>) { |
| <a class="jxr_linenumber" name="133" href="#133">133</a> LOGGER.error(<span class="jxr_string">"Undefined mode "</span> + mode); |
| <a class="jxr_linenumber" name="134" href="#134">134</a> <strong class="jxr_keyword">return</strong> <strong class="jxr_keyword">null</strong>; |
| <a class="jxr_linenumber" name="135" href="#135">135</a> } |
| <a class="jxr_linenumber" name="136" href="#136">136</a> } |
| <a class="jxr_linenumber" name="137" href="#137">137</a> <strong class="jxr_keyword">if</strong> (pairs == <strong class="jxr_keyword">null</strong> || pairs.length == 0) { |
| <a class="jxr_linenumber" name="138" href="#138">138</a> LOGGER.error(<span class="jxr_string">"keys and values must be specified for the MapRewritePolicy"</span>); |
| <a class="jxr_linenumber" name="139" href="#139">139</a> <strong class="jxr_keyword">return</strong> <strong class="jxr_keyword">null</strong>; |
| <a class="jxr_linenumber" name="140" href="#140">140</a> } |
| <a class="jxr_linenumber" name="141" href="#141">141</a> Map<String, String> map = <strong class="jxr_keyword">new</strong> HashMap<String, String>(); |
| <a class="jxr_linenumber" name="142" href="#142">142</a> <strong class="jxr_keyword">for</strong> (KeyValuePair pair : pairs) { |
| <a class="jxr_linenumber" name="143" href="#143">143</a> String key = pair.getKey(); |
| <a class="jxr_linenumber" name="144" href="#144">144</a> <strong class="jxr_keyword">if</strong> (key == <strong class="jxr_keyword">null</strong>) { |
| <a class="jxr_linenumber" name="145" href="#145">145</a> LOGGER.error(<span class="jxr_string">"A null key is not valid in MapRewritePolicy"</span>); |
| <a class="jxr_linenumber" name="146" href="#146">146</a> <strong class="jxr_keyword">continue</strong>; |
| <a class="jxr_linenumber" name="147" href="#147">147</a> } |
| <a class="jxr_linenumber" name="148" href="#148">148</a> String value = pair.getValue(); |
| <a class="jxr_linenumber" name="149" href="#149">149</a> <strong class="jxr_keyword">if</strong> (value == <strong class="jxr_keyword">null</strong>) { |
| <a class="jxr_linenumber" name="150" href="#150">150</a> LOGGER.error(<span class="jxr_string">"A null value for key "</span> + key + <span class="jxr_string">" is not allowed in MapRewritePolicy"</span>); |
| <a class="jxr_linenumber" name="151" href="#151">151</a> <strong class="jxr_keyword">continue</strong>; |
| <a class="jxr_linenumber" name="152" href="#152">152</a> } |
| <a class="jxr_linenumber" name="153" href="#153">153</a> map.put(pair.getKey(), pair.getValue()); |
| <a class="jxr_linenumber" name="154" href="#154">154</a> } |
| <a class="jxr_linenumber" name="155" href="#155">155</a> <strong class="jxr_keyword">if</strong> (map.size() == 0) { |
| <a class="jxr_linenumber" name="156" href="#156">156</a> LOGGER.error(<span class="jxr_string">"MapRewritePolicy is not configured with any valid key value pairs"</span>); |
| <a class="jxr_linenumber" name="157" href="#157">157</a> <strong class="jxr_keyword">return</strong> <strong class="jxr_keyword">null</strong>; |
| <a class="jxr_linenumber" name="158" href="#158">158</a> } |
| <a class="jxr_linenumber" name="159" href="#159">159</a> <strong class="jxr_keyword">return</strong> <strong class="jxr_keyword">new</strong> <a href="../../../../../../../org/apache/logging/log4j/core/appender/rewrite/MapRewritePolicy.html">MapRewritePolicy</a>(map, op); |
| <a class="jxr_linenumber" name="160" href="#160">160</a> } |
| <a class="jxr_linenumber" name="161" href="#161">161</a> } |
| </pre> |
| <hr/><div id="footer">This page was automatically generated by <a href="http://maven.apache.org/">Maven</a></div></body> |
| </html> |
| |
