| <!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_US" lang="en_US"> |
| <head> |
| <meta http-equiv="content-type" content="text/html; charset=UTF-8" /> |
| <title>Log4jXmlFormatter xref</title> |
| <link type="text/css" rel="stylesheet" href="../../../../stylesheet.css" /> |
| </head> |
| <body> |
| <div id="overview"><a href="../../../../../apidocs/org/apache/mina/util/Log4jXmlFormatter.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</em> |
| <a class="jxr_linenumber" name="3" href="#3">3</a> <em class="jxr_comment"> * or more contributor license agreements. See the NOTICE file</em> |
| <a class="jxr_linenumber" name="4" href="#4">4</a> <em class="jxr_comment"> * distributed with this work for additional information</em> |
| <a class="jxr_linenumber" name="5" href="#5">5</a> <em class="jxr_comment"> * regarding copyright ownership. The ASF licenses this file</em> |
| <a class="jxr_linenumber" name="6" href="#6">6</a> <em class="jxr_comment"> * to you under the Apache License, Version 2.0 (the</em> |
| <a class="jxr_linenumber" name="7" href="#7">7</a> <em class="jxr_comment"> * "License"); you may not use this file except in compliance</em> |
| <a class="jxr_linenumber" name="8" href="#8">8</a> <em class="jxr_comment"> * with the License. You may obtain a copy of the License at</em> |
| <a class="jxr_linenumber" name="9" href="#9">9</a> <em class="jxr_comment"> *</em> |
| <a class="jxr_linenumber" name="10" href="#10">10</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="11" href="#11">11</a> <em class="jxr_comment"> *</em> |
| <a class="jxr_linenumber" name="12" href="#12">12</a> <em class="jxr_comment"> * Unless required by applicable law or agreed to in writing,</em> |
| <a class="jxr_linenumber" name="13" href="#13">13</a> <em class="jxr_comment"> * software distributed under the License is distributed on an</em> |
| <a class="jxr_linenumber" name="14" href="#14">14</a> <em class="jxr_comment"> * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY</em> |
| <a class="jxr_linenumber" name="15" href="#15">15</a> <em class="jxr_comment"> * KIND, either express or implied. See the License for the</em> |
| <a class="jxr_linenumber" name="16" href="#16">16</a> <em class="jxr_comment"> * specific language governing permissions and limitations</em> |
| <a class="jxr_linenumber" name="17" href="#17">17</a> <em class="jxr_comment"> * under the License.</em> |
| <a class="jxr_linenumber" name="18" href="#18">18</a> <em class="jxr_comment"> *</em> |
| <a class="jxr_linenumber" name="19" href="#19">19</a> <em class="jxr_comment"> */</em> |
| <a class="jxr_linenumber" name="20" href="#20">20</a> <strong class="jxr_keyword">package</strong> org.apache.mina.util; |
| <a class="jxr_linenumber" name="21" href="#21">21</a> |
| <a class="jxr_linenumber" name="22" href="#22">22</a> <strong class="jxr_keyword">import</strong> org.slf4j.MDC; |
| <a class="jxr_linenumber" name="23" href="#23">23</a> |
| <a class="jxr_linenumber" name="24" href="#24">24</a> <strong class="jxr_keyword">import</strong> java.util.logging.Formatter; |
| <a class="jxr_linenumber" name="25" href="#25">25</a> <strong class="jxr_keyword">import</strong> java.util.logging.LogRecord; |
| <a class="jxr_linenumber" name="26" href="#26">26</a> <strong class="jxr_keyword">import</strong> java.util.Map; |
| <a class="jxr_linenumber" name="27" href="#27">27</a> <strong class="jxr_keyword">import</strong> java.util.Set; |
| <a class="jxr_linenumber" name="28" href="#28">28</a> <strong class="jxr_keyword">import</strong> java.util.Arrays; |
| <a class="jxr_linenumber" name="29" href="#29">29</a> |
| <a class="jxr_linenumber" name="30" href="#30">30</a> <em class="jxr_javadoccomment">/**</em> |
| <a class="jxr_linenumber" name="31" href="#31">31</a> <em class="jxr_javadoccomment"> * Implementation of {@link java.util.logging.Formatter} that generates xml in the log4j format.</em> |
| <a class="jxr_linenumber" name="32" href="#32">32</a> <em class="jxr_javadoccomment"> * <p></em> |
| <a class="jxr_linenumber" name="33" href="#33">33</a> <em class="jxr_javadoccomment"> * The generated xml corresponds 100% with what is generated by</em> |
| <a class="jxr_linenumber" name="34" href="#34">34</a> <em class="jxr_javadoccomment"> * log4j's <a href=<a href="http://logging.apache.org/log4j/1.2/apidocs/org/apache/log4j/xml/XMLLayout.html" target="alexandria_uri">http://logging.apache.org/log4j/1.2/apidocs/org/apache/log4j/xml/XMLLayout.html</a>">XMLLayout</a></em> |
| <a class="jxr_linenumber" name="35" href="#35">35</a> <em class="jxr_javadoccomment"> * <p></em> |
| <a class="jxr_linenumber" name="36" href="#36">36</a> <em class="jxr_javadoccomment"> * The MDC properties will only be correct when <code>format</code> is called from the same thread</em> |
| <a class="jxr_linenumber" name="37" href="#37">37</a> <em class="jxr_javadoccomment"> * that generated the LogRecord.</em> |
| <a class="jxr_linenumber" name="38" href="#38">38</a> <em class="jxr_javadoccomment"> * <p></em> |
| <a class="jxr_linenumber" name="39" href="#39">39</a> <em class="jxr_javadoccomment"> * The file and line attributes in the locationInfo element will always be "?"</em> |
| <a class="jxr_linenumber" name="40" href="#40">40</a> <em class="jxr_javadoccomment"> * since java.util.logging.LogRecord does not provide that info.</em> |
| <a class="jxr_linenumber" name="41" href="#41">41</a> <em class="jxr_javadoccomment"> * <p></em> |
| <a class="jxr_linenumber" name="42" href="#42">42</a> <em class="jxr_javadoccomment"> * The implementation is heavily based on org.apache.log4j.xml.XMLLayout</em> |
| <a class="jxr_linenumber" name="43" href="#43">43</a> <em class="jxr_javadoccomment"> * </p></em> |
| <a class="jxr_linenumber" name="44" href="#44">44</a> <em class="jxr_javadoccomment"> * </em> |
| <a class="jxr_linenumber" name="45" href="#45">45</a> <em class="jxr_javadoccomment"> * @author <a href="<a href="http://mina.apache.org" target="alexandria_uri">http://mina.apache.org</a>">Apache MINA Project</a></em> |
| <a class="jxr_linenumber" name="46" href="#46">46</a> <em class="jxr_javadoccomment"> */</em> |
| <a class="jxr_linenumber" name="47" href="#47">47</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">class</strong> Log4jXmlFormatter <strong class="jxr_keyword">extends</strong> Formatter { |
| <a class="jxr_linenumber" name="48" href="#48">48</a> |
| <a class="jxr_linenumber" name="49" href="#49">49</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">final</strong> <strong class="jxr_keyword">int</strong> DEFAULT_SIZE = 256; |
| <a class="jxr_linenumber" name="50" href="#50">50</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">final</strong> <strong class="jxr_keyword">int</strong> UPPER_LIMIT = 2048; |
| <a class="jxr_linenumber" name="51" href="#51">51</a> |
| <a class="jxr_linenumber" name="52" href="#52">52</a> <strong class="jxr_keyword">private</strong> StringBuffer buf = <strong class="jxr_keyword">new</strong> StringBuffer(DEFAULT_SIZE); |
| <a class="jxr_linenumber" name="53" href="#53">53</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">boolean</strong> locationInfo = false; |
| <a class="jxr_linenumber" name="54" href="#54">54</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">boolean</strong> properties = false; |
| <a class="jxr_linenumber" name="55" href="#55">55</a> |
| <a class="jxr_linenumber" name="56" href="#56">56</a> <em class="jxr_javadoccomment">/**</em> |
| <a class="jxr_linenumber" name="57" href="#57">57</a> <em class="jxr_javadoccomment"> * The <b>LocationInfo</b> option takes a boolean value. By default,</em> |
| <a class="jxr_linenumber" name="58" href="#58">58</a> <em class="jxr_javadoccomment"> * it is set to false which means there will be no location</em> |
| <a class="jxr_linenumber" name="59" href="#59">59</a> <em class="jxr_javadoccomment"> * information output by this layout. If the the option is set to</em> |
| <a class="jxr_linenumber" name="60" href="#60">60</a> <em class="jxr_javadoccomment"> * true, then the file name and line number of the statement at the</em> |
| <a class="jxr_linenumber" name="61" href="#61">61</a> <em class="jxr_javadoccomment"> * origin of the log statement will be output.</em> |
| <a class="jxr_linenumber" name="62" href="#62">62</a> <em class="jxr_javadoccomment"> *</em> |
| <a class="jxr_linenumber" name="63" href="#63">63</a> <em class="jxr_javadoccomment"> * @param flag whether locationInfo should be output by this layout</em> |
| <a class="jxr_linenumber" name="64" href="#64">64</a> <em class="jxr_javadoccomment"> */</em> |
| <a class="jxr_linenumber" name="65" href="#65">65</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> setLocationInfo(<strong class="jxr_keyword">boolean</strong> flag) { |
| <a class="jxr_linenumber" name="66" href="#66">66</a> locationInfo = flag; |
| <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> <em class="jxr_javadoccomment">/**</em> |
| <a class="jxr_linenumber" name="70" href="#70">70</a> <em class="jxr_javadoccomment"> * Returns the current value of the <b>LocationInfo</b> option.</em> |
| <a class="jxr_linenumber" name="71" href="#71">71</a> <em class="jxr_javadoccomment"> *</em> |
| <a class="jxr_linenumber" name="72" href="#72">72</a> <em class="jxr_javadoccomment"> * @return whether locationInfo will be output by this layout</em> |
| <a class="jxr_linenumber" name="73" href="#73">73</a> <em class="jxr_javadoccomment"> */</em> |
| <a class="jxr_linenumber" name="74" href="#74">74</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">boolean</strong> getLocationInfo() { |
| <a class="jxr_linenumber" name="75" href="#75">75</a> <strong class="jxr_keyword">return</strong> locationInfo; |
| <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> <em class="jxr_javadoccomment">/**</em> |
| <a class="jxr_linenumber" name="79" href="#79">79</a> <em class="jxr_javadoccomment"> * Sets whether MDC key-value pairs should be output, default false.</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> <em class="jxr_javadoccomment"> * @param flag new value.</em> |
| <a class="jxr_linenumber" name="82" href="#82">82</a> <em class="jxr_javadoccomment"> */</em> |
| <a class="jxr_linenumber" name="83" href="#83">83</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> setProperties(<strong class="jxr_keyword">final</strong> <strong class="jxr_keyword">boolean</strong> flag) { |
| <a class="jxr_linenumber" name="84" href="#84">84</a> properties = flag; |
| <a class="jxr_linenumber" name="85" href="#85">85</a> } |
| <a class="jxr_linenumber" name="86" href="#86">86</a> |
| <a class="jxr_linenumber" name="87" href="#87">87</a> <em class="jxr_javadoccomment">/**</em> |
| <a class="jxr_linenumber" name="88" href="#88">88</a> <em class="jxr_javadoccomment"> * Gets whether MDC key-value pairs should be output.</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> <em class="jxr_javadoccomment"> * @return true if MDC key-value pairs are output.</em> |
| <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> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">boolean</strong> getProperties() { |
| <a class="jxr_linenumber" name="93" href="#93">93</a> <strong class="jxr_keyword">return</strong> properties; |
| <a class="jxr_linenumber" name="94" href="#94">94</a> } |
| <a class="jxr_linenumber" name="95" href="#95">95</a> |
| <a class="jxr_linenumber" name="96" href="#96">96</a> @SuppressWarnings(<span class="jxr_string">"unchecked"</span>) |
| <a class="jxr_linenumber" name="97" href="#97">97</a> <strong class="jxr_keyword">public</strong> String format(<strong class="jxr_keyword">final</strong> LogRecord record) { |
| <a class="jxr_linenumber" name="98" href="#98">98</a> <em class="jxr_comment">// Reset working buffer. If the buffer is too large, then we need a new</em> |
| <a class="jxr_linenumber" name="99" href="#99">99</a> <em class="jxr_comment">// one in order to avoid the penalty of creating a large array.</em> |
| <a class="jxr_linenumber" name="100" href="#100">100</a> <strong class="jxr_keyword">if</strong> (buf.capacity() > UPPER_LIMIT) { |
| <a class="jxr_linenumber" name="101" href="#101">101</a> buf = <strong class="jxr_keyword">new</strong> StringBuffer(DEFAULT_SIZE); |
| <a class="jxr_linenumber" name="102" href="#102">102</a> } <strong class="jxr_keyword">else</strong> { |
| <a class="jxr_linenumber" name="103" href="#103">103</a> buf.setLength(0); |
| <a class="jxr_linenumber" name="104" href="#104">104</a> } |
| <a class="jxr_linenumber" name="105" href="#105">105</a> buf.append(<span class="jxr_string">"<log4j:event logger=\""</span>); |
| <a class="jxr_linenumber" name="106" href="#106">106</a> buf.append(Transform.escapeTags(record.getLoggerName())); |
| <a class="jxr_linenumber" name="107" href="#107">107</a> buf.append(<span class="jxr_string">"\" timestamp=\""</span>); |
| <a class="jxr_linenumber" name="108" href="#108">108</a> buf.append(record.getMillis()); |
| <a class="jxr_linenumber" name="109" href="#109">109</a> buf.append(<span class="jxr_string">"\" level=\""</span>); |
| <a class="jxr_linenumber" name="110" href="#110">110</a> |
| <a class="jxr_linenumber" name="111" href="#111">111</a> buf.append(Transform.escapeTags(record.getLevel().getName())); |
| <a class="jxr_linenumber" name="112" href="#112">112</a> buf.append(<span class="jxr_string">"\" thread=\""</span>); |
| <a class="jxr_linenumber" name="113" href="#113">113</a> buf.append(String.valueOf(record.getThreadID())); |
| <a class="jxr_linenumber" name="114" href="#114">114</a> buf.append(<span class="jxr_string">"\">\r\n"</span>); |
| <a class="jxr_linenumber" name="115" href="#115">115</a> |
| <a class="jxr_linenumber" name="116" href="#116">116</a> buf.append(<span class="jxr_string">"<log4j:message><![CDATA["</span>); |
| <a class="jxr_linenumber" name="117" href="#117">117</a> <em class="jxr_comment">// Append the rendered message. Also make sure to escape any</em> |
| <a class="jxr_linenumber" name="118" href="#118">118</a> <em class="jxr_comment">// existing CDATA sections.</em> |
| <a class="jxr_linenumber" name="119" href="#119">119</a> Transform.appendEscapingCDATA(buf, record.getMessage()); |
| <a class="jxr_linenumber" name="120" href="#120">120</a> buf.append(<span class="jxr_string">"]]></log4j:message>\r\n"</span>); |
| <a class="jxr_linenumber" name="121" href="#121">121</a> |
| <a class="jxr_linenumber" name="122" href="#122">122</a> <strong class="jxr_keyword">if</strong> (record.getThrown() != <strong class="jxr_keyword">null</strong>) { |
| <a class="jxr_linenumber" name="123" href="#123">123</a> String[] s = Transform.getThrowableStrRep(record.getThrown()); |
| <a class="jxr_linenumber" name="124" href="#124">124</a> <strong class="jxr_keyword">if</strong> (s != <strong class="jxr_keyword">null</strong>) { |
| <a class="jxr_linenumber" name="125" href="#125">125</a> buf.append(<span class="jxr_string">"<log4j:throwable><![CDATA["</span>); |
| <a class="jxr_linenumber" name="126" href="#126">126</a> <strong class="jxr_keyword">for</strong> (String value : s) { |
| <a class="jxr_linenumber" name="127" href="#127">127</a> Transform.appendEscapingCDATA(buf, value); |
| <a class="jxr_linenumber" name="128" href="#128">128</a> buf.append(<span class="jxr_string">"\r\n"</span>); |
| <a class="jxr_linenumber" name="129" href="#129">129</a> } |
| <a class="jxr_linenumber" name="130" href="#130">130</a> buf.append(<span class="jxr_string">"]]></log4j:throwable>\r\n"</span>); |
| <a class="jxr_linenumber" name="131" href="#131">131</a> } |
| <a class="jxr_linenumber" name="132" href="#132">132</a> } |
| <a class="jxr_linenumber" name="133" href="#133">133</a> |
| <a class="jxr_linenumber" name="134" href="#134">134</a> <strong class="jxr_keyword">if</strong> (locationInfo) { |
| <a class="jxr_linenumber" name="135" href="#135">135</a> buf.append(<span class="jxr_string">"<log4j:locationInfo class=\""</span>); |
| <a class="jxr_linenumber" name="136" href="#136">136</a> buf.append(Transform.escapeTags(record.getSourceClassName())); |
| <a class="jxr_linenumber" name="137" href="#137">137</a> buf.append(<span class="jxr_string">"\" method=\""</span>); |
| <a class="jxr_linenumber" name="138" href="#138">138</a> buf.append(Transform.escapeTags(record.getSourceMethodName())); |
| <a class="jxr_linenumber" name="139" href="#139">139</a> buf.append(<span class="jxr_string">"\" file=\"?\" line=\"?\"/>\r\n"</span>); |
| <a class="jxr_linenumber" name="140" href="#140">140</a> } |
| <a class="jxr_linenumber" name="141" href="#141">141</a> |
| <a class="jxr_linenumber" name="142" href="#142">142</a> <strong class="jxr_keyword">if</strong> (properties) { |
| <a class="jxr_linenumber" name="143" href="#143">143</a> Map contextMap = MDC.getCopyOfContextMap(); |
| <a class="jxr_linenumber" name="144" href="#144">144</a> <strong class="jxr_keyword">if</strong> (contextMap != <strong class="jxr_keyword">null</strong>) { |
| <a class="jxr_linenumber" name="145" href="#145">145</a> Set keySet = contextMap.keySet(); |
| <a class="jxr_linenumber" name="146" href="#146">146</a> <strong class="jxr_keyword">if</strong> (keySet != <strong class="jxr_keyword">null</strong> && keySet.size() > 0) { |
| <a class="jxr_linenumber" name="147" href="#147">147</a> buf.append(<span class="jxr_string">"<log4j:properties>\r\n"</span>); |
| <a class="jxr_linenumber" name="148" href="#148">148</a> Object[] keys = keySet.toArray(); |
| <a class="jxr_linenumber" name="149" href="#149">149</a> Arrays.sort(keys); |
| <a class="jxr_linenumber" name="150" href="#150">150</a> <strong class="jxr_keyword">for</strong> (Object key1 : keys) { |
| <a class="jxr_linenumber" name="151" href="#151">151</a> String key = key1.toString(); |
| <a class="jxr_linenumber" name="152" href="#152">152</a> Object val = contextMap.get(key); |
| <a class="jxr_linenumber" name="153" href="#153">153</a> <strong class="jxr_keyword">if</strong> (val != <strong class="jxr_keyword">null</strong>) { |
| <a class="jxr_linenumber" name="154" href="#154">154</a> buf.append(<span class="jxr_string">"<log4j:data name=\""</span>); |
| <a class="jxr_linenumber" name="155" href="#155">155</a> buf.append(Transform.escapeTags(key)); |
| <a class="jxr_linenumber" name="156" href="#156">156</a> buf.append(<span class="jxr_string">"\" value=\""</span>); |
| <a class="jxr_linenumber" name="157" href="#157">157</a> buf.append(Transform.escapeTags(String.valueOf(val))); |
| <a class="jxr_linenumber" name="158" href="#158">158</a> buf.append(<span class="jxr_string">"\"/>\r\n"</span>); |
| <a class="jxr_linenumber" name="159" href="#159">159</a> } |
| <a class="jxr_linenumber" name="160" href="#160">160</a> } |
| <a class="jxr_linenumber" name="161" href="#161">161</a> buf.append(<span class="jxr_string">"</log4j:properties>\r\n"</span>); |
| <a class="jxr_linenumber" name="162" href="#162">162</a> } |
| <a class="jxr_linenumber" name="163" href="#163">163</a> } |
| <a class="jxr_linenumber" name="164" href="#164">164</a> |
| <a class="jxr_linenumber" name="165" href="#165">165</a> } |
| <a class="jxr_linenumber" name="166" href="#166">166</a> buf.append(<span class="jxr_string">"</log4j:event>\r\n\r\n"</span>); |
| <a class="jxr_linenumber" name="167" href="#167">167</a> |
| <a class="jxr_linenumber" name="168" href="#168">168</a> <strong class="jxr_keyword">return</strong> buf.toString(); |
| <a class="jxr_linenumber" name="169" href="#169">169</a> } |
| <a class="jxr_linenumber" name="170" href="#170">170</a> |
| <a class="jxr_linenumber" name="171" href="#171">171</a> } |
| </pre> |
| <hr/><div id="footer">This page was automatically generated by <a href="http://maven.apache.org/">Maven</a></div></body> |
| </html> |
| |
