blob: 2c47b205394e3e5f703d64b330762411a053e07f [file] [log] [blame]
<!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>RFC5424Layout xref</title>
<link type="text/css" rel="stylesheet" href="../../../../../../stylesheet.css" />
</head>
<body>
<div id="overview"><a href="../../../../../../../apidocs/org/apache/logging/log4j/core/layout/RFC5424Layout.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.layout;
<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.LoggingException;
<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.Configuration;
<a class="jxr_linenumber" name="22" href="#22">22</a> <strong class="jxr_keyword">import</strong> org.apache.logging.log4j.core.config.plugins.Plugin;
<a class="jxr_linenumber" name="23" href="#23">23</a> <strong class="jxr_keyword">import</strong> org.apache.logging.log4j.core.config.plugins.PluginAttr;
<a class="jxr_linenumber" name="24" href="#24">24</a> <strong class="jxr_keyword">import</strong> org.apache.logging.log4j.core.config.plugins.PluginConfiguration;
<a class="jxr_linenumber" name="25" href="#25">25</a> <strong class="jxr_keyword">import</strong> org.apache.logging.log4j.core.config.plugins.PluginFactory;
<a class="jxr_linenumber" name="26" href="#26">26</a> <strong class="jxr_keyword">import</strong> org.apache.logging.log4j.core.net.Facility;
<a class="jxr_linenumber" name="27" href="#27">27</a> <strong class="jxr_keyword">import</strong> org.apache.logging.log4j.core.net.Priority;
<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.message.StructuredDataId;
<a class="jxr_linenumber" name="30" href="#30">30</a> <strong class="jxr_keyword">import</strong> org.apache.logging.log4j.message.StructuredDataMessage;
<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.net.InetAddress;
<a class="jxr_linenumber" name="33" href="#33">33</a> <strong class="jxr_keyword">import</strong> java.net.UnknownHostException;
<a class="jxr_linenumber" name="34" href="#34">34</a> <strong class="jxr_keyword">import</strong> java.nio.charset.Charset;
<a class="jxr_linenumber" name="35" href="#35">35</a> <strong class="jxr_keyword">import</strong> java.util.ArrayList;
<a class="jxr_linenumber" name="36" href="#36">36</a> <strong class="jxr_keyword">import</strong> java.util.Calendar;
<a class="jxr_linenumber" name="37" href="#37">37</a> <strong class="jxr_keyword">import</strong> java.util.GregorianCalendar;
<a class="jxr_linenumber" name="38" href="#38">38</a> <strong class="jxr_keyword">import</strong> java.util.List;
<a class="jxr_linenumber" name="39" href="#39">39</a> <strong class="jxr_keyword">import</strong> java.util.Map;
<a class="jxr_linenumber" name="40" href="#40">40</a> <strong class="jxr_keyword">import</strong> java.util.SortedMap;
<a class="jxr_linenumber" name="41" href="#41">41</a> <strong class="jxr_keyword">import</strong> java.util.TreeMap;
<a class="jxr_linenumber" name="42" href="#42">42</a>
<a class="jxr_linenumber" name="43" href="#43">43</a>
<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"> * Formats a log event in accordance with RFC 5424.</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> @Plugin(name = <span class="jxr_string">"RFC5424Layout"</span>, type = <span class="jxr_string">"Core"</span>, elementType = <span class="jxr_string">"layout"</span>, printObject = <strong class="jxr_keyword">true</strong>)
<a class="jxr_linenumber" name="48" href="#48">48</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/layout/RFC5424Layout.html">RFC5424Layout</a> <strong class="jxr_keyword">extends</strong> <a href="../../../../../../org/apache/logging/log4j/core/layout/AbstractStringLayout.html">AbstractStringLayout</a> {
<a class="jxr_linenumber" name="49" href="#49">49</a>
<a class="jxr_linenumber" name="50" href="#50">50</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="51" href="#51">51</a> <em class="jxr_javadoccomment"> * Not a very good default - it is the Apache Software Foundation's enterprise number.</em>
<a class="jxr_linenumber" name="52" href="#52">52</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="53" href="#53">53</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">static</strong> <strong class="jxr_keyword">final</strong> <strong class="jxr_keyword">int</strong> DEFAULT_ENTERPRISE_NUMBER = 18060;
<a class="jxr_linenumber" name="54" href="#54">54</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="55" href="#55">55</a> <em class="jxr_javadoccomment"> * The default event id.</em>
<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> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">static</strong> <strong class="jxr_keyword">final</strong> String DEFAULT_ID = <span class="jxr_string">"Audit"</span>;
<a class="jxr_linenumber" name="58" href="#58">58</a>
<a class="jxr_linenumber" name="59" href="#59">59</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">static</strong> <strong class="jxr_keyword">final</strong> String DEFAULT_MDCID = <span class="jxr_string">"mdc"</span>;
<a class="jxr_linenumber" name="60" href="#60">60</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">static</strong> <strong class="jxr_keyword">final</strong> <strong class="jxr_keyword">int</strong> TWO_DIGITS = 10;
<a class="jxr_linenumber" name="61" href="#61">61</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">static</strong> <strong class="jxr_keyword">final</strong> <strong class="jxr_keyword">int</strong> THREE_DIGITS = 100;
<a class="jxr_linenumber" name="62" href="#62">62</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">static</strong> <strong class="jxr_keyword">final</strong> <strong class="jxr_keyword">int</strong> MILLIS_PER_MINUTE = 60000;
<a class="jxr_linenumber" name="63" href="#63">63</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">static</strong> <strong class="jxr_keyword">final</strong> <strong class="jxr_keyword">int</strong> MINUTES_PER_HOUR = 60;
<a class="jxr_linenumber" name="64" href="#64">64</a>
<a class="jxr_linenumber" name="65" href="#65">65</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">final</strong> <a href="../../../../../../org/apache/logging/log4j/core/net/Facility.html">Facility</a> facility;
<a class="jxr_linenumber" name="66" href="#66">66</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">final</strong> String defaultId;
<a class="jxr_linenumber" name="67" href="#67">67</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">final</strong> Integer enterpriseNumber;
<a class="jxr_linenumber" name="68" href="#68">68</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">final</strong> <strong class="jxr_keyword">boolean</strong> includeMDC;
<a class="jxr_linenumber" name="69" href="#69">69</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">final</strong> String mdcId;
<a class="jxr_linenumber" name="70" href="#70">70</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">final</strong> String localHostName;
<a class="jxr_linenumber" name="71" href="#71">71</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">final</strong> String appName;
<a class="jxr_linenumber" name="72" href="#72">72</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">final</strong> String messageId;
<a class="jxr_linenumber" name="73" href="#73">73</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">final</strong> String configName;
<a class="jxr_linenumber" name="74" href="#74">74</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">final</strong> List&lt;String&gt; mdcExcludes;
<a class="jxr_linenumber" name="75" href="#75">75</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">final</strong> List&lt;String&gt; mdcIncludes;
<a class="jxr_linenumber" name="76" href="#76">76</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">final</strong> List&lt;String&gt; mdcRequired;
<a class="jxr_linenumber" name="77" href="#77">77</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">final</strong> <a href="../../../../../../org/apache/logging/log4j/core/layout/RFC5424Layout.html">ListChecker</a> checker;
<a class="jxr_linenumber" name="78" href="#78">78</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">final</strong> <a href="../../../../../../org/apache/logging/log4j/core/layout/RFC5424Layout.html">ListChecker</a> noopChecker = <strong class="jxr_keyword">new</strong> <a href="../../../../../../org/apache/logging/log4j/core/layout/RFC5424Layout.html">NoopChecker</a>();
<a class="jxr_linenumber" name="79" href="#79">79</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">final</strong> <strong class="jxr_keyword">boolean</strong> includeNewLine;
<a class="jxr_linenumber" name="80" href="#80">80</a>
<a class="jxr_linenumber" name="81" href="#81">81</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">long</strong> lastTimestamp = -1;
<a class="jxr_linenumber" name="82" href="#82">82</a> <strong class="jxr_keyword">private</strong> String timestamppStr = <strong class="jxr_keyword">null</strong>;
<a class="jxr_linenumber" name="83" href="#83">83</a>
<a class="jxr_linenumber" name="84" href="#84">84</a>
<a class="jxr_linenumber" name="85" href="#85">85</a> <strong class="jxr_keyword">private</strong> <a href="../../../../../../org/apache/logging/log4j/core/layout/RFC5424Layout.html">RFC5424Layout</a>(<a href="../../../../../../org/apache/logging/log4j/core/config/Configuration.html">Configuration</a> config, <a href="../../../../../../org/apache/logging/log4j/core/net/Facility.html">Facility</a> facility, String id, <strong class="jxr_keyword">int</strong> ein, <strong class="jxr_keyword">boolean</strong> includeMDC,
<a class="jxr_linenumber" name="86" href="#86">86</a> <strong class="jxr_keyword">boolean</strong> includeNL, String mdcId, String appName, String messageId, String excludes,
<a class="jxr_linenumber" name="87" href="#87">87</a> String includes, String required, Charset charset) {
<a class="jxr_linenumber" name="88" href="#88">88</a> <strong class="jxr_keyword">super</strong>(charset);
<a class="jxr_linenumber" name="89" href="#89">89</a> <strong class="jxr_keyword">this</strong>.facility = facility;
<a class="jxr_linenumber" name="90" href="#90">90</a> <strong class="jxr_keyword">this</strong>.defaultId = id == <strong class="jxr_keyword">null</strong> ? DEFAULT_ID : id;
<a class="jxr_linenumber" name="91" href="#91">91</a> <strong class="jxr_keyword">this</strong>.enterpriseNumber = ein;
<a class="jxr_linenumber" name="92" href="#92">92</a> <strong class="jxr_keyword">this</strong>.includeMDC = includeMDC;
<a class="jxr_linenumber" name="93" href="#93">93</a> <strong class="jxr_keyword">this</strong>.includeNewLine = includeNL;
<a class="jxr_linenumber" name="94" href="#94">94</a> <strong class="jxr_keyword">this</strong>.mdcId = mdcId;
<a class="jxr_linenumber" name="95" href="#95">95</a> <strong class="jxr_keyword">this</strong>.appName = appName;
<a class="jxr_linenumber" name="96" href="#96">96</a> <strong class="jxr_keyword">this</strong>.messageId = messageId;
<a class="jxr_linenumber" name="97" href="#97">97</a> <strong class="jxr_keyword">this</strong>.localHostName = getLocalHostname();
<a class="jxr_linenumber" name="98" href="#98">98</a> <a href="../../../../../../org/apache/logging/log4j/core/layout/RFC5424Layout.html">ListChecker</a> c = <strong class="jxr_keyword">null</strong>;
<a class="jxr_linenumber" name="99" href="#99">99</a> <strong class="jxr_keyword">if</strong> (excludes != <strong class="jxr_keyword">null</strong>) {
<a class="jxr_linenumber" name="100" href="#100">100</a> String[] array = excludes.split(<span class="jxr_string">","</span>);
<a class="jxr_linenumber" name="101" href="#101">101</a> <strong class="jxr_keyword">if</strong> (array.length &gt; 0) {
<a class="jxr_linenumber" name="102" href="#102">102</a> c = <strong class="jxr_keyword">new</strong> <a href="../../../../../../org/apache/logging/log4j/core/layout/RFC5424Layout.html">ExcludeChecker</a>();
<a class="jxr_linenumber" name="103" href="#103">103</a> mdcExcludes = <strong class="jxr_keyword">new</strong> ArrayList&lt;String&gt;(array.length);
<a class="jxr_linenumber" name="104" href="#104">104</a> <strong class="jxr_keyword">for</strong> (String str : array) {
<a class="jxr_linenumber" name="105" href="#105">105</a> mdcExcludes.add(str.trim());
<a class="jxr_linenumber" name="106" href="#106">106</a> }
<a class="jxr_linenumber" name="107" href="#107">107</a> } <strong class="jxr_keyword">else</strong> {
<a class="jxr_linenumber" name="108" href="#108">108</a> mdcExcludes = <strong class="jxr_keyword">null</strong>;
<a class="jxr_linenumber" name="109" href="#109">109</a> }
<a class="jxr_linenumber" name="110" href="#110">110</a> } <strong class="jxr_keyword">else</strong> {
<a class="jxr_linenumber" name="111" href="#111">111</a> mdcExcludes = <strong class="jxr_keyword">null</strong>;
<a class="jxr_linenumber" name="112" href="#112">112</a> }
<a class="jxr_linenumber" name="113" href="#113">113</a> <strong class="jxr_keyword">if</strong> (includes != <strong class="jxr_keyword">null</strong>) {
<a class="jxr_linenumber" name="114" href="#114">114</a> String[] array = includes.split(<span class="jxr_string">","</span>);
<a class="jxr_linenumber" name="115" href="#115">115</a> <strong class="jxr_keyword">if</strong> (array.length &gt; 0) {
<a class="jxr_linenumber" name="116" href="#116">116</a> c = <strong class="jxr_keyword">new</strong> <a href="../../../../../../org/apache/logging/log4j/core/layout/RFC5424Layout.html">IncludeChecker</a>();
<a class="jxr_linenumber" name="117" href="#117">117</a> mdcIncludes = <strong class="jxr_keyword">new</strong> ArrayList&lt;String&gt;(array.length);
<a class="jxr_linenumber" name="118" href="#118">118</a> <strong class="jxr_keyword">for</strong> (String str : array) {
<a class="jxr_linenumber" name="119" href="#119">119</a> mdcIncludes.add(str.trim());
<a class="jxr_linenumber" name="120" href="#120">120</a> }
<a class="jxr_linenumber" name="121" href="#121">121</a> } <strong class="jxr_keyword">else</strong> {
<a class="jxr_linenumber" name="122" href="#122">122</a> mdcIncludes = <strong class="jxr_keyword">null</strong>;
<a class="jxr_linenumber" name="123" href="#123">123</a> }
<a class="jxr_linenumber" name="124" href="#124">124</a> } <strong class="jxr_keyword">else</strong> {
<a class="jxr_linenumber" name="125" href="#125">125</a> mdcIncludes = <strong class="jxr_keyword">null</strong>;
<a class="jxr_linenumber" name="126" href="#126">126</a> }
<a class="jxr_linenumber" name="127" href="#127">127</a> <strong class="jxr_keyword">if</strong> (required != <strong class="jxr_keyword">null</strong>) {
<a class="jxr_linenumber" name="128" href="#128">128</a> String[] array = required.split(<span class="jxr_string">","</span>);
<a class="jxr_linenumber" name="129" href="#129">129</a> <strong class="jxr_keyword">if</strong> (array.length &gt; 0) {
<a class="jxr_linenumber" name="130" href="#130">130</a> mdcRequired = <strong class="jxr_keyword">new</strong> ArrayList&lt;String&gt;(array.length);
<a class="jxr_linenumber" name="131" href="#131">131</a> <strong class="jxr_keyword">for</strong> (String str : array) {
<a class="jxr_linenumber" name="132" href="#132">132</a> mdcRequired.add(str.trim());
<a class="jxr_linenumber" name="133" href="#133">133</a> }
<a class="jxr_linenumber" name="134" href="#134">134</a> } <strong class="jxr_keyword">else</strong> {
<a class="jxr_linenumber" name="135" href="#135">135</a> mdcRequired = <strong class="jxr_keyword">null</strong>;
<a class="jxr_linenumber" name="136" href="#136">136</a> }
<a class="jxr_linenumber" name="137" href="#137">137</a>
<a class="jxr_linenumber" name="138" href="#138">138</a> } <strong class="jxr_keyword">else</strong> {
<a class="jxr_linenumber" name="139" href="#139">139</a> mdcRequired = <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> <strong class="jxr_keyword">this</strong>.checker = c != <strong class="jxr_keyword">null</strong> ? c : noopChecker;
<a class="jxr_linenumber" name="142" href="#142">142</a> String name = config == <strong class="jxr_keyword">null</strong> ? <strong class="jxr_keyword">null</strong> : config.getName();
<a class="jxr_linenumber" name="143" href="#143">143</a> configName = (name != <strong class="jxr_keyword">null</strong> &amp;&amp; name.length() &gt; 0) ? name : <strong class="jxr_keyword">null</strong>;
<a class="jxr_linenumber" name="144" href="#144">144</a> }
<a class="jxr_linenumber" name="145" href="#145">145</a>
<a class="jxr_linenumber" name="146" href="#146">146</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="147" href="#147">147</a> <em class="jxr_javadoccomment"> * Formats a {@link org.apache.logging.log4j.core.LogEvent} in conformance with the RFC 5424 Syslog specification.</em>
<a class="jxr_linenumber" name="148" href="#148">148</a> <em class="jxr_javadoccomment"> * @param event The LogEvent.</em>
<a class="jxr_linenumber" name="149" href="#149">149</a> <em class="jxr_javadoccomment"> * @return The RFC 5424 String representation of the LogEvent.</em>
<a class="jxr_linenumber" name="150" href="#150">150</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="151" href="#151">151</a> <strong class="jxr_keyword">public</strong> String formatAs(<strong class="jxr_keyword">final</strong> <a href="../../../../../../org/apache/logging/log4j/core/LogEvent.html">LogEvent</a> event) {
<a class="jxr_linenumber" name="152" href="#152">152</a> Message msg = event.getMessage();
<a class="jxr_linenumber" name="153" href="#153">153</a> <strong class="jxr_keyword">boolean</strong> isStructured = msg instanceof StructuredDataMessage;
<a class="jxr_linenumber" name="154" href="#154">154</a> StringBuilder buf = <strong class="jxr_keyword">new</strong> StringBuilder();
<a class="jxr_linenumber" name="155" href="#155">155</a>
<a class="jxr_linenumber" name="156" href="#156">156</a> buf.append(<span class="jxr_string">"&lt;"</span>);
<a class="jxr_linenumber" name="157" href="#157">157</a> buf.append(Priority.getPriority(facility, event.getLevel()));
<a class="jxr_linenumber" name="158" href="#158">158</a> buf.append(<span class="jxr_string">"&gt;1 "</span>);
<a class="jxr_linenumber" name="159" href="#159">159</a> buf.append(computeTimeStampString(event.getMillis()));
<a class="jxr_linenumber" name="160" href="#160">160</a> buf.append(' ');
<a class="jxr_linenumber" name="161" href="#161">161</a> buf.append(localHostName);
<a class="jxr_linenumber" name="162" href="#162">162</a> buf.append(' ');
<a class="jxr_linenumber" name="163" href="#163">163</a> <strong class="jxr_keyword">if</strong> (appName != <strong class="jxr_keyword">null</strong>) {
<a class="jxr_linenumber" name="164" href="#164">164</a> buf.append(appName);
<a class="jxr_linenumber" name="165" href="#165">165</a> } <strong class="jxr_keyword">else</strong> <strong class="jxr_keyword">if</strong> (configName != <strong class="jxr_keyword">null</strong>) {
<a class="jxr_linenumber" name="166" href="#166">166</a> buf.append(configName);
<a class="jxr_linenumber" name="167" href="#167">167</a> } <strong class="jxr_keyword">else</strong> {
<a class="jxr_linenumber" name="168" href="#168">168</a> buf.append(<span class="jxr_string">"-"</span>);
<a class="jxr_linenumber" name="169" href="#169">169</a> }
<a class="jxr_linenumber" name="170" href="#170">170</a> buf.append(<span class="jxr_string">" "</span>);
<a class="jxr_linenumber" name="171" href="#171">171</a> buf.append(getProcId());
<a class="jxr_linenumber" name="172" href="#172">172</a> buf.append(<span class="jxr_string">" "</span>);
<a class="jxr_linenumber" name="173" href="#173">173</a> String type = isStructured ? ((StructuredDataMessage) msg).getType() : <strong class="jxr_keyword">null</strong>;
<a class="jxr_linenumber" name="174" href="#174">174</a> <strong class="jxr_keyword">if</strong> (type != <strong class="jxr_keyword">null</strong>) {
<a class="jxr_linenumber" name="175" href="#175">175</a> buf.append(type);
<a class="jxr_linenumber" name="176" href="#176">176</a> } <strong class="jxr_keyword">else</strong> <strong class="jxr_keyword">if</strong> (messageId != <strong class="jxr_keyword">null</strong>) {
<a class="jxr_linenumber" name="177" href="#177">177</a> buf.append(messageId);
<a class="jxr_linenumber" name="178" href="#178">178</a> } <strong class="jxr_keyword">else</strong> {
<a class="jxr_linenumber" name="179" href="#179">179</a> buf.append(<span class="jxr_string">"-"</span>);
<a class="jxr_linenumber" name="180" href="#180">180</a> }
<a class="jxr_linenumber" name="181" href="#181">181</a> buf.append(<span class="jxr_string">" "</span>);
<a class="jxr_linenumber" name="182" href="#182">182</a> <strong class="jxr_keyword">if</strong> (isStructured || includeMDC) {
<a class="jxr_linenumber" name="183" href="#183">183</a> StructuredDataId id = <strong class="jxr_keyword">null</strong>;
<a class="jxr_linenumber" name="184" href="#184">184</a> String text;
<a class="jxr_linenumber" name="185" href="#185">185</a> <strong class="jxr_keyword">if</strong> (isStructured) {
<a class="jxr_linenumber" name="186" href="#186">186</a> StructuredDataMessage data = (StructuredDataMessage) msg;
<a class="jxr_linenumber" name="187" href="#187">187</a> Map map = data.getData();
<a class="jxr_linenumber" name="188" href="#188">188</a> id = data.getId();
<a class="jxr_linenumber" name="189" href="#189">189</a> formatStructuredElement(id, map, buf, noopChecker);
<a class="jxr_linenumber" name="190" href="#190">190</a> text = data.getMessageFormat();
<a class="jxr_linenumber" name="191" href="#191">191</a> } <strong class="jxr_keyword">else</strong> {
<a class="jxr_linenumber" name="192" href="#192">192</a> text = msg.getFormattedMessage();
<a class="jxr_linenumber" name="193" href="#193">193</a> }
<a class="jxr_linenumber" name="194" href="#194">194</a> <strong class="jxr_keyword">if</strong> (includeMDC) {
<a class="jxr_linenumber" name="195" href="#195">195</a> <strong class="jxr_keyword">if</strong> (mdcRequired != <strong class="jxr_keyword">null</strong>) {
<a class="jxr_linenumber" name="196" href="#196">196</a> checkRequired(event.getContextMap());
<a class="jxr_linenumber" name="197" href="#197">197</a> }
<a class="jxr_linenumber" name="198" href="#198">198</a> <strong class="jxr_keyword">int</strong> ein = id == <strong class="jxr_keyword">null</strong> || id.getEnterpriseNumber() &lt; 0 ? enterpriseNumber : id.getEnterpriseNumber();
<a class="jxr_linenumber" name="199" href="#199">199</a> StructuredDataId mdcSDID = <strong class="jxr_keyword">new</strong> StructuredDataId(mdcId, ein, <strong class="jxr_keyword">null</strong>, <strong class="jxr_keyword">null</strong>);
<a class="jxr_linenumber" name="200" href="#200">200</a> formatStructuredElement(mdcSDID, event.getContextMap(), buf, checker);
<a class="jxr_linenumber" name="201" href="#201">201</a> }
<a class="jxr_linenumber" name="202" href="#202">202</a> <strong class="jxr_keyword">if</strong> (text != <strong class="jxr_keyword">null</strong> &amp;&amp; text.length() &gt; 0) {
<a class="jxr_linenumber" name="203" href="#203">203</a> buf.append(<span class="jxr_string">" "</span>).append(text);
<a class="jxr_linenumber" name="204" href="#204">204</a> }
<a class="jxr_linenumber" name="205" href="#205">205</a> } <strong class="jxr_keyword">else</strong> {
<a class="jxr_linenumber" name="206" href="#206">206</a> buf.append(<span class="jxr_string">"- "</span>);
<a class="jxr_linenumber" name="207" href="#207">207</a> buf.append(msg.getFormattedMessage());
<a class="jxr_linenumber" name="208" href="#208">208</a> }
<a class="jxr_linenumber" name="209" href="#209">209</a> <strong class="jxr_keyword">if</strong> (includeNewLine) {
<a class="jxr_linenumber" name="210" href="#210">210</a> buf.append(<span class="jxr_string">"\n"</span>);
<a class="jxr_linenumber" name="211" href="#211">211</a> }
<a class="jxr_linenumber" name="212" href="#212">212</a> <strong class="jxr_keyword">return</strong> buf.toString();
<a class="jxr_linenumber" name="213" href="#213">213</a> }
<a class="jxr_linenumber" name="214" href="#214">214</a>
<a class="jxr_linenumber" name="215" href="#215">215</a> <strong class="jxr_keyword">protected</strong> String getProcId() {
<a class="jxr_linenumber" name="216" href="#216">216</a> <strong class="jxr_keyword">return</strong> <span class="jxr_string">"-"</span>;
<a class="jxr_linenumber" name="217" href="#217">217</a> }
<a class="jxr_linenumber" name="218" href="#218">218</a>
<a class="jxr_linenumber" name="219" href="#219">219</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="220" href="#220">220</a> <em class="jxr_javadoccomment"> * This method gets the network name of the machine we are running on.</em>
<a class="jxr_linenumber" name="221" href="#221">221</a> <em class="jxr_javadoccomment"> * Returns "UNKNOWN_LOCALHOST" in the unlikely case where the host name</em>
<a class="jxr_linenumber" name="222" href="#222">222</a> <em class="jxr_javadoccomment"> * cannot be found.</em>
<a class="jxr_linenumber" name="223" href="#223">223</a> <em class="jxr_javadoccomment"> *</em>
<a class="jxr_linenumber" name="224" href="#224">224</a> <em class="jxr_javadoccomment"> * @return String the name of the local host</em>
<a class="jxr_linenumber" name="225" href="#225">225</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="226" href="#226">226</a> <strong class="jxr_keyword">public</strong> String getLocalHostname() {
<a class="jxr_linenumber" name="227" href="#227">227</a> <strong class="jxr_keyword">try</strong> {
<a class="jxr_linenumber" name="228" href="#228">228</a> InetAddress addr = InetAddress.getLocalHost();
<a class="jxr_linenumber" name="229" href="#229">229</a> <strong class="jxr_keyword">return</strong> addr.getHostName();
<a class="jxr_linenumber" name="230" href="#230">230</a> } <strong class="jxr_keyword">catch</strong> (UnknownHostException uhe) {
<a class="jxr_linenumber" name="231" href="#231">231</a> LOGGER.error(<span class="jxr_string">"Could not determine local host name"</span>, uhe);
<a class="jxr_linenumber" name="232" href="#232">232</a> <strong class="jxr_keyword">return</strong> <span class="jxr_string">"UNKNOWN_LOCALHOST"</span>;
<a class="jxr_linenumber" name="233" href="#233">233</a> }
<a class="jxr_linenumber" name="234" href="#234">234</a> }
<a class="jxr_linenumber" name="235" href="#235">235</a>
<a class="jxr_linenumber" name="236" href="#236">236</a> <strong class="jxr_keyword">protected</strong> List&lt;String&gt; getMdcExcludes() {
<a class="jxr_linenumber" name="237" href="#237">237</a> <strong class="jxr_keyword">return</strong> mdcExcludes;
<a class="jxr_linenumber" name="238" href="#238">238</a> }
<a class="jxr_linenumber" name="239" href="#239">239</a>
<a class="jxr_linenumber" name="240" href="#240">240</a> <strong class="jxr_keyword">protected</strong> List&lt;String&gt; getMdcIncludes() {
<a class="jxr_linenumber" name="241" href="#241">241</a> <strong class="jxr_keyword">return</strong> mdcIncludes;
<a class="jxr_linenumber" name="242" href="#242">242</a> }
<a class="jxr_linenumber" name="243" href="#243">243</a>
<a class="jxr_linenumber" name="244" href="#244">244</a> <strong class="jxr_keyword">private</strong> String computeTimeStampString(<strong class="jxr_keyword">long</strong> now) {
<a class="jxr_linenumber" name="245" href="#245">245</a> <strong class="jxr_keyword">long</strong> last;
<a class="jxr_linenumber" name="246" href="#246">246</a> <strong class="jxr_keyword">synchronized</strong> (<strong class="jxr_keyword">this</strong>) {
<a class="jxr_linenumber" name="247" href="#247">247</a> last = lastTimestamp;
<a class="jxr_linenumber" name="248" href="#248">248</a> <strong class="jxr_keyword">if</strong> (now == lastTimestamp) {
<a class="jxr_linenumber" name="249" href="#249">249</a> <strong class="jxr_keyword">return</strong> timestamppStr;
<a class="jxr_linenumber" name="250" href="#250">250</a> }
<a class="jxr_linenumber" name="251" href="#251">251</a> }
<a class="jxr_linenumber" name="252" href="#252">252</a>
<a class="jxr_linenumber" name="253" href="#253">253</a> StringBuilder buf = <strong class="jxr_keyword">new</strong> StringBuilder();
<a class="jxr_linenumber" name="254" href="#254">254</a> Calendar cal = <strong class="jxr_keyword">new</strong> GregorianCalendar();
<a class="jxr_linenumber" name="255" href="#255">255</a> cal.setTimeInMillis(now);
<a class="jxr_linenumber" name="256" href="#256">256</a> buf.append(Integer.toString(cal.get(Calendar.YEAR)));
<a class="jxr_linenumber" name="257" href="#257">257</a> buf.append(<span class="jxr_string">"-"</span>);
<a class="jxr_linenumber" name="258" href="#258">258</a> pad(cal.get(Calendar.MONTH) + 1, TWO_DIGITS, buf);
<a class="jxr_linenumber" name="259" href="#259">259</a> buf.append(<span class="jxr_string">"-"</span>);
<a class="jxr_linenumber" name="260" href="#260">260</a> pad(cal.get(Calendar.DAY_OF_MONTH), TWO_DIGITS, buf);
<a class="jxr_linenumber" name="261" href="#261">261</a> buf.append(<span class="jxr_string">"T"</span>);
<a class="jxr_linenumber" name="262" href="#262">262</a> pad(cal.get(Calendar.HOUR_OF_DAY), TWO_DIGITS, buf);
<a class="jxr_linenumber" name="263" href="#263">263</a> buf.append(<span class="jxr_string">":"</span>);
<a class="jxr_linenumber" name="264" href="#264">264</a> pad(cal.get(Calendar.MINUTE), TWO_DIGITS, buf);
<a class="jxr_linenumber" name="265" href="#265">265</a> buf.append(<span class="jxr_string">":"</span>);
<a class="jxr_linenumber" name="266" href="#266">266</a> pad(cal.get(Calendar.SECOND), TWO_DIGITS, buf);
<a class="jxr_linenumber" name="267" href="#267">267</a>
<a class="jxr_linenumber" name="268" href="#268">268</a> <strong class="jxr_keyword">int</strong> millis = cal.get(Calendar.MILLISECOND);
<a class="jxr_linenumber" name="269" href="#269">269</a> <strong class="jxr_keyword">if</strong> (millis != 0) {
<a class="jxr_linenumber" name="270" href="#270">270</a> buf.append(<span class="jxr_string">"."</span>);
<a class="jxr_linenumber" name="271" href="#271">271</a> pad(millis, THREE_DIGITS, buf);
<a class="jxr_linenumber" name="272" href="#272">272</a> }
<a class="jxr_linenumber" name="273" href="#273">273</a>
<a class="jxr_linenumber" name="274" href="#274">274</a> <strong class="jxr_keyword">int</strong> tzmin = (cal.get(Calendar.ZONE_OFFSET) + cal.get(Calendar.DST_OFFSET)) / MILLIS_PER_MINUTE;
<a class="jxr_linenumber" name="275" href="#275">275</a> <strong class="jxr_keyword">if</strong> (tzmin == 0) {
<a class="jxr_linenumber" name="276" href="#276">276</a> buf.append(<span class="jxr_string">"Z"</span>);
<a class="jxr_linenumber" name="277" href="#277">277</a> } <strong class="jxr_keyword">else</strong> {
<a class="jxr_linenumber" name="278" href="#278">278</a> <strong class="jxr_keyword">if</strong> (tzmin &lt; 0) {
<a class="jxr_linenumber" name="279" href="#279">279</a> tzmin = -tzmin;
<a class="jxr_linenumber" name="280" href="#280">280</a> buf.append(<span class="jxr_string">"-"</span>);
<a class="jxr_linenumber" name="281" href="#281">281</a> } <strong class="jxr_keyword">else</strong> {
<a class="jxr_linenumber" name="282" href="#282">282</a> buf.append(<span class="jxr_string">"+"</span>);
<a class="jxr_linenumber" name="283" href="#283">283</a> }
<a class="jxr_linenumber" name="284" href="#284">284</a> <strong class="jxr_keyword">int</strong> tzhour = tzmin / MINUTES_PER_HOUR;
<a class="jxr_linenumber" name="285" href="#285">285</a> tzmin -= tzhour * MINUTES_PER_HOUR;
<a class="jxr_linenumber" name="286" href="#286">286</a> pad(tzhour, TWO_DIGITS, buf);
<a class="jxr_linenumber" name="287" href="#287">287</a> buf.append(<span class="jxr_string">":"</span>);
<a class="jxr_linenumber" name="288" href="#288">288</a> pad(tzmin, TWO_DIGITS, buf);
<a class="jxr_linenumber" name="289" href="#289">289</a> }
<a class="jxr_linenumber" name="290" href="#290">290</a> <strong class="jxr_keyword">synchronized</strong> (<strong class="jxr_keyword">this</strong>) {
<a class="jxr_linenumber" name="291" href="#291">291</a> <strong class="jxr_keyword">if</strong> (last == lastTimestamp) {
<a class="jxr_linenumber" name="292" href="#292">292</a> lastTimestamp = now;
<a class="jxr_linenumber" name="293" href="#293">293</a> timestamppStr = buf.toString();
<a class="jxr_linenumber" name="294" href="#294">294</a> }
<a class="jxr_linenumber" name="295" href="#295">295</a> }
<a class="jxr_linenumber" name="296" href="#296">296</a> <strong class="jxr_keyword">return</strong> buf.toString();
<a class="jxr_linenumber" name="297" href="#297">297</a> }
<a class="jxr_linenumber" name="298" href="#298">298</a>
<a class="jxr_linenumber" name="299" href="#299">299</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">void</strong> pad(<strong class="jxr_keyword">int</strong> val, <strong class="jxr_keyword">int</strong> max, StringBuilder buf) {
<a class="jxr_linenumber" name="300" href="#300">300</a> <strong class="jxr_keyword">while</strong> (max &gt; 1) {
<a class="jxr_linenumber" name="301" href="#301">301</a> <strong class="jxr_keyword">if</strong> (val &lt; max) {
<a class="jxr_linenumber" name="302" href="#302">302</a> buf.append(<span class="jxr_string">"0"</span>);
<a class="jxr_linenumber" name="303" href="#303">303</a> }
<a class="jxr_linenumber" name="304" href="#304">304</a> max = max / TWO_DIGITS;
<a class="jxr_linenumber" name="305" href="#305">305</a> }
<a class="jxr_linenumber" name="306" href="#306">306</a> buf.append(Integer.toString(val));
<a class="jxr_linenumber" name="307" href="#307">307</a> }
<a class="jxr_linenumber" name="308" href="#308">308</a>
<a class="jxr_linenumber" name="309" href="#309">309</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">void</strong> formatStructuredElement(StructuredDataId id, Map&lt;String, String&gt; data, StringBuilder sb,
<a class="jxr_linenumber" name="310" href="#310">310</a> <a href="../../../../../../org/apache/logging/log4j/core/layout/RFC5424Layout.html">ListChecker</a> checker) {
<a class="jxr_linenumber" name="311" href="#311">311</a> <strong class="jxr_keyword">if</strong> (id == <strong class="jxr_keyword">null</strong> &amp;&amp; defaultId == <strong class="jxr_keyword">null</strong>) {
<a class="jxr_linenumber" name="312" href="#312">312</a> <strong class="jxr_keyword">return</strong>;
<a class="jxr_linenumber" name="313" href="#313">313</a> }
<a class="jxr_linenumber" name="314" href="#314">314</a> sb.append(<span class="jxr_string">"["</span>);
<a class="jxr_linenumber" name="315" href="#315">315</a> sb.append(getId(id));
<a class="jxr_linenumber" name="316" href="#316">316</a> appendMap(data, sb, checker);
<a class="jxr_linenumber" name="317" href="#317">317</a> sb.append(<span class="jxr_string">"]"</span>);
<a class="jxr_linenumber" name="318" href="#318">318</a> }
<a class="jxr_linenumber" name="319" href="#319">319</a>
<a class="jxr_linenumber" name="320" href="#320">320</a> <strong class="jxr_keyword">private</strong> String getId(StructuredDataId id) {
<a class="jxr_linenumber" name="321" href="#321">321</a> StringBuilder sb = <strong class="jxr_keyword">new</strong> StringBuilder();
<a class="jxr_linenumber" name="322" href="#322">322</a> <strong class="jxr_keyword">if</strong> (id.getName() == <strong class="jxr_keyword">null</strong>) {
<a class="jxr_linenumber" name="323" href="#323">323</a> sb.append(defaultId);
<a class="jxr_linenumber" name="324" href="#324">324</a> } <strong class="jxr_keyword">else</strong> {
<a class="jxr_linenumber" name="325" href="#325">325</a> sb.append(id.getName());
<a class="jxr_linenumber" name="326" href="#326">326</a> }
<a class="jxr_linenumber" name="327" href="#327">327</a> <strong class="jxr_keyword">int</strong> ein = id.getEnterpriseNumber();
<a class="jxr_linenumber" name="328" href="#328">328</a> <strong class="jxr_keyword">if</strong> (ein &lt; 0) {
<a class="jxr_linenumber" name="329" href="#329">329</a> ein = enterpriseNumber;
<a class="jxr_linenumber" name="330" href="#330">330</a> }
<a class="jxr_linenumber" name="331" href="#331">331</a> <strong class="jxr_keyword">if</strong> (ein &gt;= 0) {
<a class="jxr_linenumber" name="332" href="#332">332</a> sb.append(<span class="jxr_string">"@"</span>).append(ein);
<a class="jxr_linenumber" name="333" href="#333">333</a> }
<a class="jxr_linenumber" name="334" href="#334">334</a> <strong class="jxr_keyword">return</strong> sb.toString();
<a class="jxr_linenumber" name="335" href="#335">335</a> }
<a class="jxr_linenumber" name="336" href="#336">336</a>
<a class="jxr_linenumber" name="337" href="#337">337</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">void</strong> checkRequired(Map&lt;String, String&gt; map) {
<a class="jxr_linenumber" name="338" href="#338">338</a> <strong class="jxr_keyword">for</strong> (String key : mdcRequired) {
<a class="jxr_linenumber" name="339" href="#339">339</a> String value = map.get(key);
<a class="jxr_linenumber" name="340" href="#340">340</a> <strong class="jxr_keyword">if</strong> (value == <strong class="jxr_keyword">null</strong>) {
<a class="jxr_linenumber" name="341" href="#341">341</a> <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> LoggingException(<span class="jxr_string">"Required key "</span> + key + <span class="jxr_string">" is missing from the "</span> + mdcId);
<a class="jxr_linenumber" name="342" href="#342">342</a> }
<a class="jxr_linenumber" name="343" href="#343">343</a> }
<a class="jxr_linenumber" name="344" href="#344">344</a> }
<a class="jxr_linenumber" name="345" href="#345">345</a>
<a class="jxr_linenumber" name="346" href="#346">346</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">void</strong> appendMap(Map&lt;String, String&gt; map, StringBuilder sb, <a href="../../../../../../org/apache/logging/log4j/core/layout/RFC5424Layout.html">ListChecker</a> checker)
<a class="jxr_linenumber" name="347" href="#347">347</a> {
<a class="jxr_linenumber" name="348" href="#348">348</a> SortedMap&lt;String, String&gt; sorted = <strong class="jxr_keyword">new</strong> TreeMap&lt;String, String&gt;(map);
<a class="jxr_linenumber" name="349" href="#349">349</a> <strong class="jxr_keyword">for</strong> (Map.Entry&lt;String, String&gt; entry : sorted.entrySet()) {
<a class="jxr_linenumber" name="350" href="#350">350</a> <strong class="jxr_keyword">if</strong> (checker.check(entry.getKey())) {
<a class="jxr_linenumber" name="351" href="#351">351</a> sb.append(<span class="jxr_string">" "</span>);
<a class="jxr_linenumber" name="352" href="#352">352</a> sb.append(entry.getKey()).append(<span class="jxr_string">"=\&quot;"</span>).append(entry.getValue()).append(<span class="jxr_string">"\&quot;"</span>);
<a class="jxr_linenumber" name="353" href="#353">353</a> }
<a class="jxr_linenumber" name="354" href="#354">354</a> }
<a class="jxr_linenumber" name="355" href="#355">355</a> }
<a class="jxr_linenumber" name="356" href="#356">356</a>
<a class="jxr_linenumber" name="357" href="#357">357</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="358" href="#358">358</a> <em class="jxr_javadoccomment"> * Interface used to check keys in a Map.</em>
<a class="jxr_linenumber" name="359" href="#359">359</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="360" href="#360">360</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">interface</strong> <a href="../../../../../../org/apache/logging/log4j/core/layout/RFC5424Layout.html">ListChecker</a> {
<a class="jxr_linenumber" name="361" href="#361">361</a> <strong class="jxr_keyword">boolean</strong> check(String key);
<a class="jxr_linenumber" name="362" href="#362">362</a> }
<a class="jxr_linenumber" name="363" href="#363">363</a>
<a class="jxr_linenumber" name="364" href="#364">364</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="365" href="#365">365</a> <em class="jxr_javadoccomment"> * Includes only the listed keys.</em>
<a class="jxr_linenumber" name="366" href="#366">366</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="367" href="#367">367</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">class</strong> <a href="../../../../../../org/apache/logging/log4j/core/layout/RFC5424Layout.html">IncludeChecker</a> <strong class="jxr_keyword">implements</strong> <a href="../../../../../../org/apache/logging/log4j/core/layout/RFC5424Layout.html">ListChecker</a> {
<a class="jxr_linenumber" name="368" href="#368">368</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">boolean</strong> check(String key) {
<a class="jxr_linenumber" name="369" href="#369">369</a> <strong class="jxr_keyword">return</strong> mdcIncludes.contains(key);
<a class="jxr_linenumber" name="370" href="#370">370</a> }
<a class="jxr_linenumber" name="371" href="#371">371</a> }
<a class="jxr_linenumber" name="372" href="#372">372</a>
<a class="jxr_linenumber" name="373" href="#373">373</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="374" href="#374">374</a> <em class="jxr_javadoccomment"> * Excludes the listed keys.</em>
<a class="jxr_linenumber" name="375" href="#375">375</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="376" href="#376">376</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">class</strong> <a href="../../../../../../org/apache/logging/log4j/core/layout/RFC5424Layout.html">ExcludeChecker</a> <strong class="jxr_keyword">implements</strong> <a href="../../../../../../org/apache/logging/log4j/core/layout/RFC5424Layout.html">ListChecker</a> {
<a class="jxr_linenumber" name="377" href="#377">377</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">boolean</strong> check(String key) {
<a class="jxr_linenumber" name="378" href="#378">378</a> <strong class="jxr_keyword">return</strong> !mdcExcludes.contains(key);
<a class="jxr_linenumber" name="379" href="#379">379</a> }
<a class="jxr_linenumber" name="380" href="#380">380</a> }
<a class="jxr_linenumber" name="381" href="#381">381</a>
<a class="jxr_linenumber" name="382" href="#382">382</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="383" href="#383">383</a> <em class="jxr_javadoccomment"> * Does nothing.</em>
<a class="jxr_linenumber" name="384" href="#384">384</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="385" href="#385">385</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">class</strong> <a href="../../../../../../org/apache/logging/log4j/core/layout/RFC5424Layout.html">NoopChecker</a> <strong class="jxr_keyword">implements</strong> <a href="../../../../../../org/apache/logging/log4j/core/layout/RFC5424Layout.html">ListChecker</a> {
<a class="jxr_linenumber" name="386" href="#386">386</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">boolean</strong> check(String key) {
<a class="jxr_linenumber" name="387" href="#387">387</a> <strong class="jxr_keyword">return</strong> <strong class="jxr_keyword">true</strong>;
<a class="jxr_linenumber" name="388" href="#388">388</a> }
<a class="jxr_linenumber" name="389" href="#389">389</a> }
<a class="jxr_linenumber" name="390" href="#390">390</a>
<a class="jxr_linenumber" name="391" href="#391">391</a> @Override
<a class="jxr_linenumber" name="392" href="#392">392</a> <strong class="jxr_keyword">public</strong> String toString() {
<a class="jxr_linenumber" name="393" href="#393">393</a> StringBuilder sb = <strong class="jxr_keyword">new</strong> StringBuilder();
<a class="jxr_linenumber" name="394" href="#394">394</a> sb.append(<span class="jxr_string">"facility="</span>).append(facility.name());
<a class="jxr_linenumber" name="395" href="#395">395</a> sb.append(<span class="jxr_string">" appName="</span>).append(appName);
<a class="jxr_linenumber" name="396" href="#396">396</a> sb.append(<span class="jxr_string">" defaultId="</span>).append(defaultId);
<a class="jxr_linenumber" name="397" href="#397">397</a> sb.append(<span class="jxr_string">" enterpriseNumber="</span>).append(enterpriseNumber);
<a class="jxr_linenumber" name="398" href="#398">398</a> sb.append(<span class="jxr_string">" newLine="</span>).append(includeNewLine);
<a class="jxr_linenumber" name="399" href="#399">399</a> sb.append(<span class="jxr_string">" includeMDC="</span>).append(includeMDC);
<a class="jxr_linenumber" name="400" href="#400">400</a> sb.append(<span class="jxr_string">" messageId="</span>).append(messageId);
<a class="jxr_linenumber" name="401" href="#401">401</a> <strong class="jxr_keyword">return</strong> sb.toString();
<a class="jxr_linenumber" name="402" href="#402">402</a> }
<a class="jxr_linenumber" name="403" href="#403">403</a>
<a class="jxr_linenumber" name="404" href="#404">404</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="405" href="#405">405</a> <em class="jxr_javadoccomment"> * Create the RFC 5424 Layout.</em>
<a class="jxr_linenumber" name="406" href="#406">406</a> <em class="jxr_javadoccomment"> * @param facility The Facility is used to try to classify the message.</em>
<a class="jxr_linenumber" name="407" href="#407">407</a> <em class="jxr_javadoccomment"> * @param id The default structured data id to use when formatting according to RFC 5424.</em>
<a class="jxr_linenumber" name="408" href="#408">408</a> <em class="jxr_javadoccomment"> * @param ein The IANA enterprise number.</em>
<a class="jxr_linenumber" name="409" href="#409">409</a> <em class="jxr_javadoccomment"> * @param includeMDC Indicates whether data from the ThreadContextMap will be included in the RFC 5424 Syslog</em>
<a class="jxr_linenumber" name="410" href="#410">410</a> <em class="jxr_javadoccomment"> * record. Defaults to "true:.</em>
<a class="jxr_linenumber" name="411" href="#411">411</a> <em class="jxr_javadoccomment"> * @param mdcId The id to use for the MDC Structured Data Element.</em>
<a class="jxr_linenumber" name="412" href="#412">412</a> <em class="jxr_javadoccomment"> * @param includeNL If true, a newline will be appended to the end of the syslog record. The default is false.</em>
<a class="jxr_linenumber" name="413" href="#413">413</a> <em class="jxr_javadoccomment"> * @param appName The value to use as the APP-NAME in the RFC 5424 syslog record.</em>
<a class="jxr_linenumber" name="414" href="#414">414</a> <em class="jxr_javadoccomment"> * @param msgId The default value to be used in the MSGID field of RFC 5424 syslog records.</em>
<a class="jxr_linenumber" name="415" href="#415">415</a> <em class="jxr_javadoccomment"> * @param excludes A comma separated list of mdc keys that should be excluded from the LogEvent.</em>
<a class="jxr_linenumber" name="416" href="#416">416</a> <em class="jxr_javadoccomment"> * @param includes A comma separated list of mdc keys that should be included in the FlumeEvent.</em>
<a class="jxr_linenumber" name="417" href="#417">417</a> <em class="jxr_javadoccomment"> * @param required A comma separated list of mdc keys that must be present in the MDC.</em>
<a class="jxr_linenumber" name="418" href="#418">418</a> <em class="jxr_javadoccomment"> * @param charset The character set.</em>
<a class="jxr_linenumber" name="419" href="#419">419</a> <em class="jxr_javadoccomment"> * @param config The Configuration. Some Converters require access to the Interpolator.</em>
<a class="jxr_linenumber" name="420" href="#420">420</a> <em class="jxr_javadoccomment"> * @return An RFC5424Layout.</em>
<a class="jxr_linenumber" name="421" href="#421">421</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="422" href="#422">422</a> @PluginFactory
<a class="jxr_linenumber" name="423" href="#423">423</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">static</strong> <a href="../../../../../../org/apache/logging/log4j/core/layout/RFC5424Layout.html">RFC5424Layout</a> createLayout(@PluginAttr(<span class="jxr_string">"facility"</span>) String facility,
<a class="jxr_linenumber" name="424" href="#424">424</a> @PluginAttr(<span class="jxr_string">"id"</span>) String id,
<a class="jxr_linenumber" name="425" href="#425">425</a> @PluginAttr(<span class="jxr_string">"enterpriseNumber"</span>) String ein,
<a class="jxr_linenumber" name="426" href="#426">426</a> @PluginAttr(<span class="jxr_string">"includeMDC"</span>) String includeMDC,
<a class="jxr_linenumber" name="427" href="#427">427</a> @PluginAttr(<span class="jxr_string">"mdcId"</span>) String mdcId,
<a class="jxr_linenumber" name="428" href="#428">428</a> @PluginAttr(<span class="jxr_string">"newLine"</span>) String includeNL,
<a class="jxr_linenumber" name="429" href="#429">429</a> @PluginAttr(<span class="jxr_string">"appName"</span>) String appName,
<a class="jxr_linenumber" name="430" href="#430">430</a> @PluginAttr(<span class="jxr_string">"messageId"</span>) String msgId,
<a class="jxr_linenumber" name="431" href="#431">431</a> @PluginAttr(<span class="jxr_string">"mdcExcludes"</span>) String excludes,
<a class="jxr_linenumber" name="432" href="#432">432</a> @PluginAttr(<span class="jxr_string">"mdcIncludes"</span>) String includes,
<a class="jxr_linenumber" name="433" href="#433">433</a> @PluginAttr(<span class="jxr_string">"mdcRequired"</span>) String required,
<a class="jxr_linenumber" name="434" href="#434">434</a> @PluginAttr(<span class="jxr_string">"charset"</span>) String charset,
<a class="jxr_linenumber" name="435" href="#435">435</a> @PluginConfiguration <a href="../../../../../../org/apache/logging/log4j/core/config/Configuration.html">Configuration</a> config) {
<a class="jxr_linenumber" name="436" href="#436">436</a> Charset c = Charset.isSupported(<span class="jxr_string">"UTF-8"</span>) ? Charset.forName(<span class="jxr_string">"UTF-8"</span>) : Charset.defaultCharset();
<a class="jxr_linenumber" name="437" href="#437">437</a> <strong class="jxr_keyword">if</strong> (charset != <strong class="jxr_keyword">null</strong>) {
<a class="jxr_linenumber" name="438" href="#438">438</a> <strong class="jxr_keyword">if</strong> (Charset.isSupported(charset)) {
<a class="jxr_linenumber" name="439" href="#439">439</a> c = Charset.forName(charset);
<a class="jxr_linenumber" name="440" href="#440">440</a> } <strong class="jxr_keyword">else</strong> {
<a class="jxr_linenumber" name="441" href="#441">441</a> LOGGER.error(<span class="jxr_string">"Charset "</span> + charset + <span class="jxr_string">" is not supported for layout, using "</span> + c.displayName());
<a class="jxr_linenumber" name="442" href="#442">442</a> }
<a class="jxr_linenumber" name="443" href="#443">443</a> }
<a class="jxr_linenumber" name="444" href="#444">444</a> <strong class="jxr_keyword">if</strong> (includes != <strong class="jxr_keyword">null</strong> &amp;&amp; excludes != <strong class="jxr_keyword">null</strong>) {
<a class="jxr_linenumber" name="445" href="#445">445</a> LOGGER.error(<span class="jxr_string">"mdcIncludes and mdcExcludes are mutually exclusive. Includes wil be ignored"</span>);
<a class="jxr_linenumber" name="446" href="#446">446</a> includes = <strong class="jxr_keyword">null</strong>;
<a class="jxr_linenumber" name="447" href="#447">447</a> }
<a class="jxr_linenumber" name="448" href="#448">448</a> <a href="../../../../../../org/apache/logging/log4j/core/net/Facility.html">Facility</a> f = facility != <strong class="jxr_keyword">null</strong> ? Facility.valueOf(facility.toUpperCase()) : Facility.LOCAL0;
<a class="jxr_linenumber" name="449" href="#449">449</a> <strong class="jxr_keyword">int</strong> enterpriseNumber = ein == <strong class="jxr_keyword">null</strong> ? DEFAULT_ENTERPRISE_NUMBER : Integer.parseInt(ein);
<a class="jxr_linenumber" name="450" href="#450">450</a> <strong class="jxr_keyword">boolean</strong> isMdc = includeMDC == <strong class="jxr_keyword">null</strong> ? <strong class="jxr_keyword">true</strong> : Boolean.valueOf(includeMDC);
<a class="jxr_linenumber" name="451" href="#451">451</a> <strong class="jxr_keyword">boolean</strong> includeNewLine = includeNL == <strong class="jxr_keyword">null</strong> ? false : Boolean.valueOf(includeNL);
<a class="jxr_linenumber" name="452" href="#452">452</a> <strong class="jxr_keyword">if</strong> (mdcId == <strong class="jxr_keyword">null</strong>) {
<a class="jxr_linenumber" name="453" href="#453">453</a> mdcId = DEFAULT_MDCID;
<a class="jxr_linenumber" name="454" href="#454">454</a> }
<a class="jxr_linenumber" name="455" href="#455">455</a>
<a class="jxr_linenumber" name="456" href="#456">456</a> <strong class="jxr_keyword">return</strong> <strong class="jxr_keyword">new</strong> <a href="../../../../../../org/apache/logging/log4j/core/layout/RFC5424Layout.html">RFC5424Layout</a>(config, f, id, enterpriseNumber, isMdc, includeNewLine, mdcId, appName, msgId,
<a class="jxr_linenumber" name="457" href="#457">457</a> excludes, includes, required, c);
<a class="jxr_linenumber" name="458" href="#458">458</a> }
<a class="jxr_linenumber" name="459" href="#459">459</a> }
</pre>
<hr/><div id="footer">This page was automatically generated by <a href="http://maven.apache.org/">Maven</a></div></body>
</html>