| <!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>XmlLayout 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/XmlLayout.html">View Javadoc</a></div><pre> |
| <a class="jxr_linenumber" name="L1" href="#L1">1</a> <em class="jxr_comment">/*</em> |
| <a class="jxr_linenumber" name="L2" href="#L2">2</a> <em class="jxr_comment"> * Licensed to the Apache Software Foundation (ASF) under one or more</em> |
| <a class="jxr_linenumber" name="L3" href="#L3">3</a> <em class="jxr_comment"> * contributor license agreements. See the NOTICE file distributed with</em> |
| <a class="jxr_linenumber" name="L4" href="#L4">4</a> <em class="jxr_comment"> * this work for additional information regarding copyright ownership.</em> |
| <a class="jxr_linenumber" name="L5" href="#L5">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="L6" href="#L6">6</a> <em class="jxr_comment"> * (the "License"); you may not use this file except in compliance with</em> |
| <a class="jxr_linenumber" name="L7" href="#L7">7</a> <em class="jxr_comment"> * the License. You may obtain a copy of the License at</em> |
| <a class="jxr_linenumber" name="L8" href="#L8">8</a> <em class="jxr_comment"> *</em> |
| <a class="jxr_linenumber" name="L9" href="#L9">9</a> <em class="jxr_comment"> * <a href="http://www.apache.org/licenses/LICENSE-2." target="alexandria_uri">http://www.apache.org/licenses/LICENSE-2.</a>0</em> |
| <a class="jxr_linenumber" name="L10" href="#L10">10</a> <em class="jxr_comment"> *</em> |
| <a class="jxr_linenumber" name="L11" href="#L11">11</a> <em class="jxr_comment"> * Unless required by applicable law or agreed to in writing, software</em> |
| <a class="jxr_linenumber" name="L12" href="#L12">12</a> <em class="jxr_comment"> * distributed under the License is distributed on an "AS IS" BASIS,</em> |
| <a class="jxr_linenumber" name="L13" href="#L13">13</a> <em class="jxr_comment"> * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.</em> |
| <a class="jxr_linenumber" name="L14" href="#L14">14</a> <em class="jxr_comment"> * See the license for the specific language governing permissions and</em> |
| <a class="jxr_linenumber" name="L15" href="#L15">15</a> <em class="jxr_comment"> * limitations under the license.</em> |
| <a class="jxr_linenumber" name="L16" href="#L16">16</a> <em class="jxr_comment"> */</em> |
| <a class="jxr_linenumber" name="L17" href="#L17">17</a> <strong class="jxr_keyword">package</strong> org.apache.logging.log4j.core.layout; |
| <a class="jxr_linenumber" name="L18" href="#L18">18</a> |
| <a class="jxr_linenumber" name="L19" href="#L19">19</a> <strong class="jxr_keyword">import</strong> java.nio.charset.Charset; |
| <a class="jxr_linenumber" name="L20" href="#L20">20</a> <strong class="jxr_keyword">import</strong> java.nio.charset.StandardCharsets; |
| <a class="jxr_linenumber" name="L21" href="#L21">21</a> <strong class="jxr_keyword">import</strong> java.util.HashMap; |
| <a class="jxr_linenumber" name="L22" href="#L22">22</a> <strong class="jxr_keyword">import</strong> java.util.Map; |
| <a class="jxr_linenumber" name="L23" href="#L23">23</a> |
| <a class="jxr_linenumber" name="L24" href="#L24">24</a> <strong class="jxr_keyword">import</strong> org.apache.logging.log4j.core.Layout; |
| <a class="jxr_linenumber" name="L25" href="#L25">25</a> <strong class="jxr_keyword">import</strong> org.apache.logging.log4j.core.config.Configuration; |
| <a class="jxr_linenumber" name="L26" href="#L26">26</a> <strong class="jxr_keyword">import</strong> org.apache.logging.log4j.core.config.Node; |
| <a class="jxr_linenumber" name="L27" href="#L27">27</a> <strong class="jxr_keyword">import</strong> org.apache.logging.log4j.core.config.plugins.Plugin; |
| <a class="jxr_linenumber" name="L28" href="#L28">28</a> <strong class="jxr_keyword">import</strong> org.apache.logging.log4j.core.config.plugins.PluginBuilderFactory; |
| <a class="jxr_linenumber" name="L29" href="#L29">29</a> <strong class="jxr_keyword">import</strong> org.apache.logging.log4j.core.jackson.XmlConstants; |
| <a class="jxr_linenumber" name="L30" href="#L30">30</a> <strong class="jxr_keyword">import</strong> org.apache.logging.log4j.core.util.KeyValuePair; |
| <a class="jxr_linenumber" name="L31" href="#L31">31</a> |
| <a class="jxr_linenumber" name="L32" href="#L32">32</a> <em class="jxr_javadoccomment">/**</em> |
| <a class="jxr_linenumber" name="L33" href="#L33">33</a> <em class="jxr_javadoccomment"> * Appends a series of {@code event} elements as defined in the <a href="log4j.dtd">log4j.dtd</a>.</em> |
| <a class="jxr_linenumber" name="L34" href="#L34">34</a> <em class="jxr_javadoccomment"> *</em> |
| <a class="jxr_linenumber" name="L35" href="#L35">35</a> <em class="jxr_javadoccomment"> * <h3>Complete well-formed XML vs. fragment XML</h3></em> |
| <a class="jxr_linenumber" name="L36" href="#L36">36</a> <em class="jxr_javadoccomment"> * <p></em> |
| <a class="jxr_linenumber" name="L37" href="#L37">37</a> <em class="jxr_javadoccomment"> * If you configure {@code complete="true"}, the appender outputs a well-formed XML document where the default namespace</em> |
| <a class="jxr_linenumber" name="L38" href="#L38">38</a> <em class="jxr_javadoccomment"> * is the log4j namespace {@value XmlConstants#XML_NAMESPACE}. By default, with {@code complete="false"}, you should</em> |
| <a class="jxr_linenumber" name="L39" href="#L39">39</a> <em class="jxr_javadoccomment"> * include the output as an <em>external entity</em> in a separate file to form a well-formed XML document.</em> |
| <a class="jxr_linenumber" name="L40" href="#L40">40</a> <em class="jxr_javadoccomment"> * </p></em> |
| <a class="jxr_linenumber" name="L41" href="#L41">41</a> <em class="jxr_javadoccomment"> * <p></em> |
| <a class="jxr_linenumber" name="L42" href="#L42">42</a> <em class="jxr_javadoccomment"> * If {@code complete="false"}, the appender does not write the XML processing instruction and the root element.</em> |
| <a class="jxr_linenumber" name="L43" href="#L43">43</a> <em class="jxr_javadoccomment"> * </p></em> |
| <a class="jxr_linenumber" name="L44" href="#L44">44</a> <em class="jxr_javadoccomment"> * <h3>Encoding</h3></em> |
| <a class="jxr_linenumber" name="L45" href="#L45">45</a> <em class="jxr_javadoccomment"> * <p></em> |
| <a class="jxr_linenumber" name="L46" href="#L46">46</a> <em class="jxr_javadoccomment"> * Appenders using this layout should have their {@code charset} set to {@code UTF-8} or {@code UTF-16}, otherwise</em> |
| <a class="jxr_linenumber" name="L47" href="#L47">47</a> <em class="jxr_javadoccomment"> * events containing non-ASCII characters could result in corrupted log files.</em> |
| <a class="jxr_linenumber" name="L48" href="#L48">48</a> <em class="jxr_javadoccomment"> * </p></em> |
| <a class="jxr_linenumber" name="L49" href="#L49">49</a> <em class="jxr_javadoccomment"> * <h3>Pretty vs. compact XML</h3></em> |
| <a class="jxr_linenumber" name="L50" href="#L50">50</a> <em class="jxr_javadoccomment"> * <p></em> |
| <a class="jxr_linenumber" name="L51" href="#L51">51</a> <em class="jxr_javadoccomment"> * By default, the XML layout is not compact (compact = not "pretty") with {@code compact="false"}, which means the</em> |
| <a class="jxr_linenumber" name="L52" href="#L52">52</a> <em class="jxr_javadoccomment"> * appender uses end-of-line characters and indents lines to format the XML. If {@code compact="true"}, then no</em> |
| <a class="jxr_linenumber" name="L53" href="#L53">53</a> <em class="jxr_javadoccomment"> * end-of-line or indentation is used. Message content may contain, of course, end-of-lines.</em> |
| <a class="jxr_linenumber" name="L54" href="#L54">54</a> <em class="jxr_javadoccomment"> * </p></em> |
| <a class="jxr_linenumber" name="L55" href="#L55">55</a> <em class="jxr_javadoccomment"> * <h3>Additional Fields</h3></em> |
| <a class="jxr_linenumber" name="L56" href="#L56">56</a> <em class="jxr_javadoccomment"> * <p></em> |
| <a class="jxr_linenumber" name="L57" href="#L57">57</a> <em class="jxr_javadoccomment"> * This property allows addition of custom fields into generated JSON.</em> |
| <a class="jxr_linenumber" name="L58" href="#L58">58</a> <em class="jxr_javadoccomment"> * {@code <XmlLayout><KeyValuePair key="foo" value="bar"/></XmlLayout>} inserts {@code <foo>bar</foo>} directly</em> |
| <a class="jxr_linenumber" name="L59" href="#L59">59</a> <em class="jxr_javadoccomment"> * into XML output. Supports Lookup expressions.</em> |
| <a class="jxr_linenumber" name="L60" href="#L60">60</a> <em class="jxr_javadoccomment"> * </p></em> |
| <a class="jxr_linenumber" name="L61" href="#L61">61</a> <em class="jxr_javadoccomment"> */</em> |
| <a class="jxr_linenumber" name="L62" href="#L62">62</a> @Plugin(name = <span class="jxr_string">"XmlLayout"</span>, category = Node.CATEGORY, elementType = Layout.ELEMENT_TYPE, printObject = <strong class="jxr_keyword">true</strong>) |
| <a class="jxr_linenumber" name="L63" href="#L63">63</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/XmlLayout.html">XmlLayout</a> <strong class="jxr_keyword">extends</strong> <a href="../../../../../../org/apache/logging/log4j/core/layout/AbstractJacksonLayout.html">AbstractJacksonLayout</a> { |
| <a class="jxr_linenumber" name="L64" href="#L64">64</a> |
| <a class="jxr_linenumber" name="L65" href="#L65">65</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">static</strong> <strong class="jxr_keyword">final</strong> String ROOT_TAG = <span class="jxr_string">"Events"</span>; |
| <a class="jxr_linenumber" name="L66" href="#L66">66</a> |
| <a class="jxr_linenumber" name="L67" href="#L67">67</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">static</strong> <strong class="jxr_keyword">class</strong> Builder<B <strong class="jxr_keyword">extends</strong> Builder<B>> <strong class="jxr_keyword">extends</strong> AbstractJacksonLayout.Builder<B> |
| <a class="jxr_linenumber" name="L68" href="#L68">68</a> <strong class="jxr_keyword">implements</strong> org.apache.logging.log4j.core.util.Builder<XmlLayout> { |
| <a class="jxr_linenumber" name="L69" href="#L69">69</a> |
| <a class="jxr_linenumber" name="L70" href="#L70">70</a> <strong class="jxr_keyword">public</strong> <a href="../../../../../../org/apache/logging/log4j/core/util/KeyValuePair.html">Builder</a>() { |
| <a class="jxr_linenumber" name="L71" href="#L71">71</a> <strong class="jxr_keyword">super</strong>(); |
| <a class="jxr_linenumber" name="L72" href="#L72">72</a> setCharset(StandardCharsets.UTF_8); |
| <a class="jxr_linenumber" name="L73" href="#L73">73</a> } |
| <a class="jxr_linenumber" name="L74" href="#L74">74</a> |
| <a class="jxr_linenumber" name="L75" href="#L75">75</a> @Override |
| <a class="jxr_linenumber" name="L76" href="#L76">76</a> <strong class="jxr_keyword">public</strong> <a href="../../../../../../org/apache/logging/log4j/core/layout/XmlLayout.html">XmlLayout</a> build() { |
| <a class="jxr_linenumber" name="L77" href="#L77">77</a> <strong class="jxr_keyword">return</strong> <strong class="jxr_keyword">new</strong> <a href="../../../../../../org/apache/logging/log4j/core/layout/XmlLayout.html">XmlLayout</a>(getConfiguration(), isLocationInfo(), isProperties(), isComplete(), |
| <a class="jxr_linenumber" name="L78" href="#L78">78</a> isCompact(), getEndOfLine(), getCharset(), isIncludeStacktrace(), isStacktraceAsString(), |
| <a class="jxr_linenumber" name="L79" href="#L79">79</a> isIncludeNullDelimiter(), getAdditionalFields()); |
| <a class="jxr_linenumber" name="L80" href="#L80">80</a> } |
| <a class="jxr_linenumber" name="L81" href="#L81">81</a> } |
| <a class="jxr_linenumber" name="L82" href="#L82">82</a> |
| <a class="jxr_linenumber" name="L83" href="#L83">83</a> <em class="jxr_javadoccomment">/**</em> |
| <a class="jxr_linenumber" name="L84" href="#L84">84</a> <em class="jxr_javadoccomment"> * @deprecated Use {@link #newBuilder()} instead</em> |
| <a class="jxr_linenumber" name="L85" href="#L85">85</a> <em class="jxr_javadoccomment"> */</em> |
| <a class="jxr_linenumber" name="L86" href="#L86">86</a> @Deprecated |
| <a class="jxr_linenumber" name="L87" href="#L87">87</a> <strong class="jxr_keyword">protected</strong> <a href="../../../../../../org/apache/logging/log4j/core/layout/XmlLayout.html">XmlLayout</a>(<strong class="jxr_keyword">final</strong> <strong class="jxr_keyword">boolean</strong> locationInfo, <strong class="jxr_keyword">final</strong> <strong class="jxr_keyword">boolean</strong> properties, <strong class="jxr_keyword">final</strong> <strong class="jxr_keyword">boolean</strong> complete, |
| <a class="jxr_linenumber" name="L88" href="#L88">88</a> <strong class="jxr_keyword">final</strong> <strong class="jxr_keyword">boolean</strong> compact, <strong class="jxr_keyword">final</strong> Charset charset, <strong class="jxr_keyword">final</strong> <strong class="jxr_keyword">boolean</strong> includeStacktrace) { |
| <a class="jxr_linenumber" name="L89" href="#L89">89</a> <strong class="jxr_keyword">this</strong>(<strong class="jxr_keyword">null</strong>, locationInfo, properties, complete, compact, <strong class="jxr_keyword">null</strong>, charset, includeStacktrace, false, false, <strong class="jxr_keyword">null</strong>); |
| <a class="jxr_linenumber" name="L90" href="#L90">90</a> } |
| <a class="jxr_linenumber" name="L91" href="#L91">91</a> |
| <a class="jxr_linenumber" name="L92" href="#L92">92</a> <strong class="jxr_keyword">private</strong> <a href="../../../../../../org/apache/logging/log4j/core/layout/XmlLayout.html">XmlLayout</a>(<strong class="jxr_keyword">final</strong> <a href="../../../../../../org/apache/logging/log4j/core/config/Configuration.html">Configuration</a> config, <strong class="jxr_keyword">final</strong> <strong class="jxr_keyword">boolean</strong> locationInfo, <strong class="jxr_keyword">final</strong> <strong class="jxr_keyword">boolean</strong> properties, |
| <a class="jxr_linenumber" name="L93" href="#L93">93</a> <strong class="jxr_keyword">final</strong> <strong class="jxr_keyword">boolean</strong> complete, <strong class="jxr_keyword">final</strong> <strong class="jxr_keyword">boolean</strong> compact, <strong class="jxr_keyword">final</strong> String endOfLine, <strong class="jxr_keyword">final</strong> Charset charset, |
| <a class="jxr_linenumber" name="L94" href="#L94">94</a> <strong class="jxr_keyword">final</strong> <strong class="jxr_keyword">boolean</strong> includeStacktrace, <strong class="jxr_keyword">final</strong> <strong class="jxr_keyword">boolean</strong> stacktraceAsString, |
| <a class="jxr_linenumber" name="L95" href="#L95">95</a> <strong class="jxr_keyword">final</strong> <strong class="jxr_keyword">boolean</strong> includeNullDelimiter, |
| <a class="jxr_linenumber" name="L96" href="#L96">96</a> <strong class="jxr_keyword">final</strong> <a href="../../../../../../org/apache/logging/log4j/core/util/KeyValuePair.html">KeyValuePair</a>[] additionalFields) { |
| <a class="jxr_linenumber" name="L97" href="#L97">97</a> <strong class="jxr_keyword">super</strong>(config, <strong class="jxr_keyword">new</strong> JacksonFactory.XML(includeStacktrace, stacktraceAsString).newWriter( |
| <a class="jxr_linenumber" name="L98" href="#L98">98</a> locationInfo, properties, compact), |
| <a class="jxr_linenumber" name="L99" href="#L99">99</a> charset, compact, complete, false, endOfLine, <strong class="jxr_keyword">null</strong>, <strong class="jxr_keyword">null</strong>, includeNullDelimiter, |
| <a class="jxr_linenumber" name="L100" href="#L100">100</a> additionalFields); |
| <a class="jxr_linenumber" name="L101" href="#L101">101</a> } |
| <a class="jxr_linenumber" name="L102" href="#L102">102</a> |
| <a class="jxr_linenumber" name="L103" href="#L103">103</a> <em class="jxr_javadoccomment">/**</em> |
| <a class="jxr_linenumber" name="L104" href="#L104">104</a> <em class="jxr_javadoccomment"> * Returns appropriate XML headers.</em> |
| <a class="jxr_linenumber" name="L105" href="#L105">105</a> <em class="jxr_javadoccomment"> * <ol></em> |
| <a class="jxr_linenumber" name="L106" href="#L106">106</a> <em class="jxr_javadoccomment"> * <li>XML processing instruction</li></em> |
| <a class="jxr_linenumber" name="L107" href="#L107">107</a> <em class="jxr_javadoccomment"> * <li>XML root element</li></em> |
| <a class="jxr_linenumber" name="L108" href="#L108">108</a> <em class="jxr_javadoccomment"> * </ol></em> |
| <a class="jxr_linenumber" name="L109" href="#L109">109</a> <em class="jxr_javadoccomment"> *</em> |
| <a class="jxr_linenumber" name="L110" href="#L110">110</a> <em class="jxr_javadoccomment"> * @return a byte array containing the header.</em> |
| <a class="jxr_linenumber" name="L111" href="#L111">111</a> <em class="jxr_javadoccomment"> */</em> |
| <a class="jxr_linenumber" name="L112" href="#L112">112</a> @Override |
| <a class="jxr_linenumber" name="L113" href="#L113">113</a> <strong class="jxr_keyword">public</strong> byte[] getHeader() { |
| <a class="jxr_linenumber" name="L114" href="#L114">114</a> <strong class="jxr_keyword">if</strong> (!complete) { |
| <a class="jxr_linenumber" name="L115" href="#L115">115</a> <strong class="jxr_keyword">return</strong> <strong class="jxr_keyword">null</strong>; |
| <a class="jxr_linenumber" name="L116" href="#L116">116</a> } |
| <a class="jxr_linenumber" name="L117" href="#L117">117</a> <strong class="jxr_keyword">final</strong> StringBuilder buf = <strong class="jxr_keyword">new</strong> StringBuilder(); |
| <a class="jxr_linenumber" name="L118" href="#L118">118</a> buf.append(<span class="jxr_string">"<?xml version=\"1.0\" encoding=\""</span>); |
| <a class="jxr_linenumber" name="L119" href="#L119">119</a> buf.append(<strong class="jxr_keyword">this</strong>.getCharset().name()); |
| <a class="jxr_linenumber" name="L120" href="#L120">120</a> buf.append(<span class="jxr_string">"\"?>"</span>); |
| <a class="jxr_linenumber" name="L121" href="#L121">121</a> buf.append(<strong class="jxr_keyword">this</strong>.eol); |
| <a class="jxr_linenumber" name="L122" href="#L122">122</a> <em class="jxr_comment">// Make the log4j namespace the default namespace, no need to use more space with a namespace prefix.</em> |
| <a class="jxr_linenumber" name="L123" href="#L123">123</a> buf.append('<'); |
| <a class="jxr_linenumber" name="L124" href="#L124">124</a> buf.append(ROOT_TAG); |
| <a class="jxr_linenumber" name="L125" href="#L125">125</a> buf.append(<span class="jxr_string">" xmlns=\""</span> + XmlConstants.XML_NAMESPACE + <span class="jxr_string">"\">"</span>); |
| <a class="jxr_linenumber" name="L126" href="#L126">126</a> buf.append(<strong class="jxr_keyword">this</strong>.eol); |
| <a class="jxr_linenumber" name="L127" href="#L127">127</a> <strong class="jxr_keyword">return</strong> buf.toString().getBytes(<strong class="jxr_keyword">this</strong>.getCharset()); |
| <a class="jxr_linenumber" name="L128" href="#L128">128</a> } |
| <a class="jxr_linenumber" name="L129" href="#L129">129</a> |
| <a class="jxr_linenumber" name="L130" href="#L130">130</a> <em class="jxr_javadoccomment">/**</em> |
| <a class="jxr_linenumber" name="L131" href="#L131">131</a> <em class="jxr_javadoccomment"> * Returns appropriate XML footer.</em> |
| <a class="jxr_linenumber" name="L132" href="#L132">132</a> <em class="jxr_javadoccomment"> *</em> |
| <a class="jxr_linenumber" name="L133" href="#L133">133</a> <em class="jxr_javadoccomment"> * @return a byte array containing the footer, closing the XML root element.</em> |
| <a class="jxr_linenumber" name="L134" href="#L134">134</a> <em class="jxr_javadoccomment"> */</em> |
| <a class="jxr_linenumber" name="L135" href="#L135">135</a> @Override |
| <a class="jxr_linenumber" name="L136" href="#L136">136</a> <strong class="jxr_keyword">public</strong> byte[] getFooter() { |
| <a class="jxr_linenumber" name="L137" href="#L137">137</a> <strong class="jxr_keyword">if</strong> (!complete) { |
| <a class="jxr_linenumber" name="L138" href="#L138">138</a> <strong class="jxr_keyword">return</strong> <strong class="jxr_keyword">null</strong>; |
| <a class="jxr_linenumber" name="L139" href="#L139">139</a> } |
| <a class="jxr_linenumber" name="L140" href="#L140">140</a> <strong class="jxr_keyword">return</strong> getBytes(<span class="jxr_string">"</"</span> + ROOT_TAG + '>' + <strong class="jxr_keyword">this</strong>.eol); |
| <a class="jxr_linenumber" name="L141" href="#L141">141</a> } |
| <a class="jxr_linenumber" name="L142" href="#L142">142</a> |
| <a class="jxr_linenumber" name="L143" href="#L143">143</a> <em class="jxr_javadoccomment">/**</em> |
| <a class="jxr_linenumber" name="L144" href="#L144">144</a> <em class="jxr_javadoccomment"> * Gets this XmlLayout's content format. Specified by:</em> |
| <a class="jxr_linenumber" name="L145" href="#L145">145</a> <em class="jxr_javadoccomment"> * <ul></em> |
| <a class="jxr_linenumber" name="L146" href="#L146">146</a> <em class="jxr_javadoccomment"> * <li>Key: "dtd" Value: "log4j-events.dtd"</li></em> |
| <a class="jxr_linenumber" name="L147" href="#L147">147</a> <em class="jxr_javadoccomment"> * <li>Key: "version" Value: "2.0"</li></em> |
| <a class="jxr_linenumber" name="L148" href="#L148">148</a> <em class="jxr_javadoccomment"> * </ul></em> |
| <a class="jxr_linenumber" name="L149" href="#L149">149</a> <em class="jxr_javadoccomment"> *</em> |
| <a class="jxr_linenumber" name="L150" href="#L150">150</a> <em class="jxr_javadoccomment"> * @return Map of content format keys supporting XmlLayout</em> |
| <a class="jxr_linenumber" name="L151" href="#L151">151</a> <em class="jxr_javadoccomment"> */</em> |
| <a class="jxr_linenumber" name="L152" href="#L152">152</a> @Override |
| <a class="jxr_linenumber" name="L153" href="#L153">153</a> <strong class="jxr_keyword">public</strong> Map<String, String> getContentFormat() { |
| <a class="jxr_linenumber" name="L154" href="#L154">154</a> <strong class="jxr_keyword">final</strong> Map<String, String> result = <strong class="jxr_keyword">new</strong> HashMap<>(); |
| <a class="jxr_linenumber" name="L155" href="#L155">155</a> <em class="jxr_comment">// result.put("dtd", "log4j-events.dtd");</em> |
| <a class="jxr_linenumber" name="L156" href="#L156">156</a> result.put(<span class="jxr_string">"xsd"</span>, <span class="jxr_string">"log4j-events.xsd"</span>); |
| <a class="jxr_linenumber" name="L157" href="#L157">157</a> result.put(<span class="jxr_string">"version"</span>, <span class="jxr_string">"2.0"</span>); |
| <a class="jxr_linenumber" name="L158" href="#L158">158</a> <strong class="jxr_keyword">return</strong> result; |
| <a class="jxr_linenumber" name="L159" href="#L159">159</a> } |
| <a class="jxr_linenumber" name="L160" href="#L160">160</a> |
| <a class="jxr_linenumber" name="L161" href="#L161">161</a> <em class="jxr_javadoccomment">/**</em> |
| <a class="jxr_linenumber" name="L162" href="#L162">162</a> <em class="jxr_javadoccomment"> * @return The content type.</em> |
| <a class="jxr_linenumber" name="L163" href="#L163">163</a> <em class="jxr_javadoccomment"> */</em> |
| <a class="jxr_linenumber" name="L164" href="#L164">164</a> @Override |
| <a class="jxr_linenumber" name="L165" href="#L165">165</a> <strong class="jxr_keyword">public</strong> String getContentType() { |
| <a class="jxr_linenumber" name="L166" href="#L166">166</a> <strong class="jxr_keyword">return</strong> <span class="jxr_string">"text/xml; charset="</span> + <strong class="jxr_keyword">this</strong>.getCharset(); |
| <a class="jxr_linenumber" name="L167" href="#L167">167</a> } |
| <a class="jxr_linenumber" name="L168" href="#L168">168</a> |
| <a class="jxr_linenumber" name="L169" href="#L169">169</a> <em class="jxr_javadoccomment">/**</em> |
| <a class="jxr_linenumber" name="L170" href="#L170">170</a> <em class="jxr_javadoccomment"> * Creates an XML Layout.</em> |
| <a class="jxr_linenumber" name="L171" href="#L171">171</a> <em class="jxr_javadoccomment"> *</em> |
| <a class="jxr_linenumber" name="L172" href="#L172">172</a> <em class="jxr_javadoccomment"> * @param locationInfo If "true", includes the location information in the generated XML.</em> |
| <a class="jxr_linenumber" name="L173" href="#L173">173</a> <em class="jxr_javadoccomment"> * @param properties If "true", includes the thread context map in the generated XML.</em> |
| <a class="jxr_linenumber" name="L174" href="#L174">174</a> <em class="jxr_javadoccomment"> * @param complete If "true", includes the XML header and footer, defaults to "false".</em> |
| <a class="jxr_linenumber" name="L175" href="#L175">175</a> <em class="jxr_javadoccomment"> * @param compact If "true", does not use end-of-lines and indentation, defaults to "false".</em> |
| <a class="jxr_linenumber" name="L176" href="#L176">176</a> <em class="jxr_javadoccomment"> * @param charset The character set to use, if {@code null}, uses "UTF-8".</em> |
| <a class="jxr_linenumber" name="L177" href="#L177">177</a> <em class="jxr_javadoccomment"> * @param includeStacktrace</em> |
| <a class="jxr_linenumber" name="L178" href="#L178">178</a> <em class="jxr_javadoccomment"> * If "true", includes the stacktrace of any Throwable in the generated XML, defaults to "true".</em> |
| <a class="jxr_linenumber" name="L179" href="#L179">179</a> <em class="jxr_javadoccomment"> * @return An XML Layout.</em> |
| <a class="jxr_linenumber" name="L180" href="#L180">180</a> <em class="jxr_javadoccomment"> *</em> |
| <a class="jxr_linenumber" name="L181" href="#L181">181</a> <em class="jxr_javadoccomment"> * @deprecated Use {@link #newBuilder()} instead</em> |
| <a class="jxr_linenumber" name="L182" href="#L182">182</a> <em class="jxr_javadoccomment"> */</em> |
| <a class="jxr_linenumber" name="L183" href="#L183">183</a> @Deprecated |
| <a class="jxr_linenumber" name="L184" href="#L184">184</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">static</strong> <a href="../../../../../../org/apache/logging/log4j/core/layout/XmlLayout.html">XmlLayout</a> createLayout( |
| <a class="jxr_linenumber" name="L185" href="#L185">185</a> <strong class="jxr_keyword">final</strong> <strong class="jxr_keyword">boolean</strong> locationInfo, |
| <a class="jxr_linenumber" name="L186" href="#L186">186</a> <strong class="jxr_keyword">final</strong> <strong class="jxr_keyword">boolean</strong> properties, |
| <a class="jxr_linenumber" name="L187" href="#L187">187</a> <strong class="jxr_keyword">final</strong> <strong class="jxr_keyword">boolean</strong> complete, |
| <a class="jxr_linenumber" name="L188" href="#L188">188</a> <strong class="jxr_keyword">final</strong> <strong class="jxr_keyword">boolean</strong> compact, |
| <a class="jxr_linenumber" name="L189" href="#L189">189</a> <strong class="jxr_keyword">final</strong> Charset charset, |
| <a class="jxr_linenumber" name="L190" href="#L190">190</a> <strong class="jxr_keyword">final</strong> <strong class="jxr_keyword">boolean</strong> includeStacktrace) { |
| <a class="jxr_linenumber" name="L191" href="#L191">191</a> <strong class="jxr_keyword">return</strong> <strong class="jxr_keyword">new</strong> <a href="../../../../../../org/apache/logging/log4j/core/layout/XmlLayout.html">XmlLayout</a>(<strong class="jxr_keyword">null</strong>, locationInfo, properties, complete, compact, <strong class="jxr_keyword">null</strong>, charset, includeStacktrace, false, |
| <a class="jxr_linenumber" name="L192" href="#L192">192</a> false, <strong class="jxr_keyword">null</strong>); |
| <a class="jxr_linenumber" name="L193" href="#L193">193</a> } |
| <a class="jxr_linenumber" name="L194" href="#L194">194</a> |
| <a class="jxr_linenumber" name="L195" href="#L195">195</a> @PluginBuilderFactory |
| <a class="jxr_linenumber" name="L196" href="#L196">196</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">static</strong> <B <strong class="jxr_keyword">extends</strong> Builder<B>> B newBuilder() { |
| <a class="jxr_linenumber" name="L197" href="#L197">197</a> <strong class="jxr_keyword">return</strong> <strong class="jxr_keyword">new</strong> Builder<B>().asBuilder(); |
| <a class="jxr_linenumber" name="L198" href="#L198">198</a> } |
| <a class="jxr_linenumber" name="L199" href="#L199">199</a> |
| <a class="jxr_linenumber" name="L200" href="#L200">200</a> <em class="jxr_javadoccomment">/**</em> |
| <a class="jxr_linenumber" name="L201" href="#L201">201</a> <em class="jxr_javadoccomment"> * Creates an XML Layout using the default settings.</em> |
| <a class="jxr_linenumber" name="L202" href="#L202">202</a> <em class="jxr_javadoccomment"> *</em> |
| <a class="jxr_linenumber" name="L203" href="#L203">203</a> <em class="jxr_javadoccomment"> * @return an XML Layout.</em> |
| <a class="jxr_linenumber" name="L204" href="#L204">204</a> <em class="jxr_javadoccomment"> */</em> |
| <a class="jxr_linenumber" name="L205" href="#L205">205</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">static</strong> <a href="../../../../../../org/apache/logging/log4j/core/layout/XmlLayout.html">XmlLayout</a> createDefaultLayout() { |
| <a class="jxr_linenumber" name="L206" href="#L206">206</a> <strong class="jxr_keyword">return</strong> <strong class="jxr_keyword">new</strong> <a href="../../../../../../org/apache/logging/log4j/core/layout/XmlLayout.html">XmlLayout</a>(<strong class="jxr_keyword">null</strong>, false, false, false, false, <strong class="jxr_keyword">null</strong>, StandardCharsets.UTF_8, <strong class="jxr_keyword">true</strong>, false, false, <strong class="jxr_keyword">null</strong>); |
| <a class="jxr_linenumber" name="L207" href="#L207">207</a> } |
| <a class="jxr_linenumber" name="L208" href="#L208">208</a> } |
| </pre> |
| <hr/> |
| <div id="footer">Copyright © 1999–2020 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</div> |
| </body> |
| </html> |
