| <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> |
| <html lang="en"> |
| <head> |
| <title>Source code</title> |
| <link rel="stylesheet" type="text/css" href="../../../../../../../stylesheet.css" title="Style"> |
| </head> |
| <body> |
| <div class="sourceContainer"> |
| <pre><span class="sourceLineNo">001</span>/*<a name="line.1"></a> |
| <span class="sourceLineNo">002</span> * Licensed to the Apache Software Foundation (ASF) under one or more<a name="line.2"></a> |
| <span class="sourceLineNo">003</span> * contributor license agreements. See the NOTICE file distributed with<a name="line.3"></a> |
| <span class="sourceLineNo">004</span> * this work for additional information regarding copyright ownership.<a name="line.4"></a> |
| <span class="sourceLineNo">005</span> * The ASF licenses this file to You under the Apache license, Version 2.0<a name="line.5"></a> |
| <span class="sourceLineNo">006</span> * (the "License"); you may not use this file except in compliance with<a name="line.6"></a> |
| <span class="sourceLineNo">007</span> * the License. You may obtain a copy of the License at<a name="line.7"></a> |
| <span class="sourceLineNo">008</span> *<a name="line.8"></a> |
| <span class="sourceLineNo">009</span> * http://www.apache.org/licenses/LICENSE-2.0<a name="line.9"></a> |
| <span class="sourceLineNo">010</span> *<a name="line.10"></a> |
| <span class="sourceLineNo">011</span> * Unless required by applicable law or agreed to in writing, software<a name="line.11"></a> |
| <span class="sourceLineNo">012</span> * distributed under the License is distributed on an "AS IS" BASIS,<a name="line.12"></a> |
| <span class="sourceLineNo">013</span> * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.<a name="line.13"></a> |
| <span class="sourceLineNo">014</span> * See the license for the specific language governing permissions and<a name="line.14"></a> |
| <span class="sourceLineNo">015</span> * limitations under the license.<a name="line.15"></a> |
| <span class="sourceLineNo">016</span> */<a name="line.16"></a> |
| <span class="sourceLineNo">017</span>package org.apache.logging.log4j.core.layout;<a name="line.17"></a> |
| <span class="sourceLineNo">018</span><a name="line.18"></a> |
| <span class="sourceLineNo">019</span>import java.nio.charset.Charset;<a name="line.19"></a> |
| <span class="sourceLineNo">020</span>import java.nio.charset.StandardCharsets;<a name="line.20"></a> |
| <span class="sourceLineNo">021</span>import java.util.HashMap;<a name="line.21"></a> |
| <span class="sourceLineNo">022</span>import java.util.Map;<a name="line.22"></a> |
| <span class="sourceLineNo">023</span><a name="line.23"></a> |
| <span class="sourceLineNo">024</span>import org.apache.logging.log4j.core.Layout;<a name="line.24"></a> |
| <span class="sourceLineNo">025</span>import org.apache.logging.log4j.core.config.Configuration;<a name="line.25"></a> |
| <span class="sourceLineNo">026</span>import org.apache.logging.log4j.core.config.Node;<a name="line.26"></a> |
| <span class="sourceLineNo">027</span>import org.apache.logging.log4j.core.config.plugins.Plugin;<a name="line.27"></a> |
| <span class="sourceLineNo">028</span>import org.apache.logging.log4j.core.config.plugins.PluginBuilderFactory;<a name="line.28"></a> |
| <span class="sourceLineNo">029</span>import org.apache.logging.log4j.core.jackson.XmlConstants;<a name="line.29"></a> |
| <span class="sourceLineNo">030</span>import org.apache.logging.log4j.core.util.KeyValuePair;<a name="line.30"></a> |
| <span class="sourceLineNo">031</span><a name="line.31"></a> |
| <span class="sourceLineNo">032</span>/**<a name="line.32"></a> |
| <span class="sourceLineNo">033</span> * Appends a series of {@code event} elements as defined in the <a href="log4j.dtd">log4j.dtd</a>.<a name="line.33"></a> |
| <span class="sourceLineNo">034</span> *<a name="line.34"></a> |
| <span class="sourceLineNo">035</span> * <h3>Complete well-formed XML vs. fragment XML</h3><a name="line.35"></a> |
| <span class="sourceLineNo">036</span> * <p><a name="line.36"></a> |
| <span class="sourceLineNo">037</span> * If you configure {@code complete="true"}, the appender outputs a well-formed XML document where the default namespace<a name="line.37"></a> |
| <span class="sourceLineNo">038</span> * is the log4j namespace {@value XmlConstants#XML_NAMESPACE}. By default, with {@code complete="false"}, you should<a name="line.38"></a> |
| <span class="sourceLineNo">039</span> * include the output as an <em>external entity</em> in a separate file to form a well-formed XML document.<a name="line.39"></a> |
| <span class="sourceLineNo">040</span> * </p><a name="line.40"></a> |
| <span class="sourceLineNo">041</span> * <p><a name="line.41"></a> |
| <span class="sourceLineNo">042</span> * If {@code complete="false"}, the appender does not write the XML processing instruction and the root element.<a name="line.42"></a> |
| <span class="sourceLineNo">043</span> * </p><a name="line.43"></a> |
| <span class="sourceLineNo">044</span> * <h3>Encoding</h3><a name="line.44"></a> |
| <span class="sourceLineNo">045</span> * <p><a name="line.45"></a> |
| <span class="sourceLineNo">046</span> * Appenders using this layout should have their {@code charset} set to {@code UTF-8} or {@code UTF-16}, otherwise<a name="line.46"></a> |
| <span class="sourceLineNo">047</span> * events containing non-ASCII characters could result in corrupted log files.<a name="line.47"></a> |
| <span class="sourceLineNo">048</span> * </p><a name="line.48"></a> |
| <span class="sourceLineNo">049</span> * <h3>Pretty vs. compact XML</h3><a name="line.49"></a> |
| <span class="sourceLineNo">050</span> * <p><a name="line.50"></a> |
| <span class="sourceLineNo">051</span> * By default, the XML layout is not compact (compact = not "pretty") with {@code compact="false"}, which means the<a name="line.51"></a> |
| <span class="sourceLineNo">052</span> * appender uses end-of-line characters and indents lines to format the XML. If {@code compact="true"}, then no<a name="line.52"></a> |
| <span class="sourceLineNo">053</span> * end-of-line or indentation is used. Message content may contain, of course, end-of-lines.<a name="line.53"></a> |
| <span class="sourceLineNo">054</span> * </p><a name="line.54"></a> |
| <span class="sourceLineNo">055</span> * <h3>Additional Fields</h3><a name="line.55"></a> |
| <span class="sourceLineNo">056</span> * <p><a name="line.56"></a> |
| <span class="sourceLineNo">057</span> * This property allows addition of custom fields into generated JSON.<a name="line.57"></a> |
| <span class="sourceLineNo">058</span> * {@code <XmlLayout><KeyValuePair key="foo" value="bar"/></XmlLayout>} inserts {@code <foo>bar</foo>} directly<a name="line.58"></a> |
| <span class="sourceLineNo">059</span> * into XML output. Supports Lookup expressions.<a name="line.59"></a> |
| <span class="sourceLineNo">060</span> * </p><a name="line.60"></a> |
| <span class="sourceLineNo">061</span> */<a name="line.61"></a> |
| <span class="sourceLineNo">062</span>@Plugin(name = "XmlLayout", category = Node.CATEGORY, elementType = Layout.ELEMENT_TYPE, printObject = true)<a name="line.62"></a> |
| <span class="sourceLineNo">063</span>public final class XmlLayout extends AbstractJacksonLayout {<a name="line.63"></a> |
| <span class="sourceLineNo">064</span><a name="line.64"></a> |
| <span class="sourceLineNo">065</span> private static final String ROOT_TAG = "Events";<a name="line.65"></a> |
| <span class="sourceLineNo">066</span><a name="line.66"></a> |
| <span class="sourceLineNo">067</span> public static class Builder<B extends Builder<B>> extends AbstractJacksonLayout.Builder<B><a name="line.67"></a> |
| <span class="sourceLineNo">068</span> implements org.apache.logging.log4j.core.util.Builder<XmlLayout> {<a name="line.68"></a> |
| <span class="sourceLineNo">069</span><a name="line.69"></a> |
| <span class="sourceLineNo">070</span> public Builder() {<a name="line.70"></a> |
| <span class="sourceLineNo">071</span> super();<a name="line.71"></a> |
| <span class="sourceLineNo">072</span> setCharset(StandardCharsets.UTF_8);<a name="line.72"></a> |
| <span class="sourceLineNo">073</span> }<a name="line.73"></a> |
| <span class="sourceLineNo">074</span><a name="line.74"></a> |
| <span class="sourceLineNo">075</span> @Override<a name="line.75"></a> |
| <span class="sourceLineNo">076</span> public XmlLayout build() {<a name="line.76"></a> |
| <span class="sourceLineNo">077</span> return new XmlLayout(getConfiguration(), isLocationInfo(), isProperties(), isComplete(),<a name="line.77"></a> |
| <span class="sourceLineNo">078</span> isCompact(), getEndOfLine(), getCharset(), isIncludeStacktrace(), isStacktraceAsString(),<a name="line.78"></a> |
| <span class="sourceLineNo">079</span> isIncludeNullDelimiter(), getAdditionalFields());<a name="line.79"></a> |
| <span class="sourceLineNo">080</span> }<a name="line.80"></a> |
| <span class="sourceLineNo">081</span> }<a name="line.81"></a> |
| <span class="sourceLineNo">082</span><a name="line.82"></a> |
| <span class="sourceLineNo">083</span> /**<a name="line.83"></a> |
| <span class="sourceLineNo">084</span> * @deprecated Use {@link #newBuilder()} instead<a name="line.84"></a> |
| <span class="sourceLineNo">085</span> */<a name="line.85"></a> |
| <span class="sourceLineNo">086</span> @Deprecated<a name="line.86"></a> |
| <span class="sourceLineNo">087</span> protected XmlLayout(final boolean locationInfo, final boolean properties, final boolean complete,<a name="line.87"></a> |
| <span class="sourceLineNo">088</span> final boolean compact, final Charset charset, final boolean includeStacktrace) {<a name="line.88"></a> |
| <span class="sourceLineNo">089</span> this(null, locationInfo, properties, complete, compact, null, charset, includeStacktrace, false, false, null);<a name="line.89"></a> |
| <span class="sourceLineNo">090</span> }<a name="line.90"></a> |
| <span class="sourceLineNo">091</span><a name="line.91"></a> |
| <span class="sourceLineNo">092</span> private XmlLayout(final Configuration config, final boolean locationInfo, final boolean properties,<a name="line.92"></a> |
| <span class="sourceLineNo">093</span> final boolean complete, final boolean compact, final String endOfLine, final Charset charset,<a name="line.93"></a> |
| <span class="sourceLineNo">094</span> final boolean includeStacktrace, final boolean stacktraceAsString,<a name="line.94"></a> |
| <span class="sourceLineNo">095</span> final boolean includeNullDelimiter,<a name="line.95"></a> |
| <span class="sourceLineNo">096</span> final KeyValuePair[] additionalFields) {<a name="line.96"></a> |
| <span class="sourceLineNo">097</span> super(config, new JacksonFactory.XML(includeStacktrace, stacktraceAsString).newWriter(<a name="line.97"></a> |
| <span class="sourceLineNo">098</span> locationInfo, properties, compact),<a name="line.98"></a> |
| <span class="sourceLineNo">099</span> charset, compact, complete, false, endOfLine, null, null, includeNullDelimiter,<a name="line.99"></a> |
| <span class="sourceLineNo">100</span> additionalFields);<a name="line.100"></a> |
| <span class="sourceLineNo">101</span> }<a name="line.101"></a> |
| <span class="sourceLineNo">102</span><a name="line.102"></a> |
| <span class="sourceLineNo">103</span> /**<a name="line.103"></a> |
| <span class="sourceLineNo">104</span> * Returns appropriate XML headers.<a name="line.104"></a> |
| <span class="sourceLineNo">105</span> * <ol><a name="line.105"></a> |
| <span class="sourceLineNo">106</span> * <li>XML processing instruction</li><a name="line.106"></a> |
| <span class="sourceLineNo">107</span> * <li>XML root element</li><a name="line.107"></a> |
| <span class="sourceLineNo">108</span> * </ol><a name="line.108"></a> |
| <span class="sourceLineNo">109</span> *<a name="line.109"></a> |
| <span class="sourceLineNo">110</span> * @return a byte array containing the header.<a name="line.110"></a> |
| <span class="sourceLineNo">111</span> */<a name="line.111"></a> |
| <span class="sourceLineNo">112</span> @Override<a name="line.112"></a> |
| <span class="sourceLineNo">113</span> public byte[] getHeader() {<a name="line.113"></a> |
| <span class="sourceLineNo">114</span> if (!complete) {<a name="line.114"></a> |
| <span class="sourceLineNo">115</span> return null;<a name="line.115"></a> |
| <span class="sourceLineNo">116</span> }<a name="line.116"></a> |
| <span class="sourceLineNo">117</span> final StringBuilder buf = new StringBuilder();<a name="line.117"></a> |
| <span class="sourceLineNo">118</span> buf.append("<?xml version=\"1.0\" encoding=\"");<a name="line.118"></a> |
| <span class="sourceLineNo">119</span> buf.append(this.getCharset().name());<a name="line.119"></a> |
| <span class="sourceLineNo">120</span> buf.append("\"?>");<a name="line.120"></a> |
| <span class="sourceLineNo">121</span> buf.append(this.eol);<a name="line.121"></a> |
| <span class="sourceLineNo">122</span> // Make the log4j namespace the default namespace, no need to use more space with a namespace prefix.<a name="line.122"></a> |
| <span class="sourceLineNo">123</span> buf.append('<');<a name="line.123"></a> |
| <span class="sourceLineNo">124</span> buf.append(ROOT_TAG);<a name="line.124"></a> |
| <span class="sourceLineNo">125</span> buf.append(" xmlns=\"" + XmlConstants.XML_NAMESPACE + "\">");<a name="line.125"></a> |
| <span class="sourceLineNo">126</span> buf.append(this.eol);<a name="line.126"></a> |
| <span class="sourceLineNo">127</span> return buf.toString().getBytes(this.getCharset());<a name="line.127"></a> |
| <span class="sourceLineNo">128</span> }<a name="line.128"></a> |
| <span class="sourceLineNo">129</span><a name="line.129"></a> |
| <span class="sourceLineNo">130</span> /**<a name="line.130"></a> |
| <span class="sourceLineNo">131</span> * Returns appropriate XML footer.<a name="line.131"></a> |
| <span class="sourceLineNo">132</span> *<a name="line.132"></a> |
| <span class="sourceLineNo">133</span> * @return a byte array containing the footer, closing the XML root element.<a name="line.133"></a> |
| <span class="sourceLineNo">134</span> */<a name="line.134"></a> |
| <span class="sourceLineNo">135</span> @Override<a name="line.135"></a> |
| <span class="sourceLineNo">136</span> public byte[] getFooter() {<a name="line.136"></a> |
| <span class="sourceLineNo">137</span> if (!complete) {<a name="line.137"></a> |
| <span class="sourceLineNo">138</span> return null;<a name="line.138"></a> |
| <span class="sourceLineNo">139</span> }<a name="line.139"></a> |
| <span class="sourceLineNo">140</span> return getBytes("</" + ROOT_TAG + '>' + this.eol);<a name="line.140"></a> |
| <span class="sourceLineNo">141</span> }<a name="line.141"></a> |
| <span class="sourceLineNo">142</span><a name="line.142"></a> |
| <span class="sourceLineNo">143</span> /**<a name="line.143"></a> |
| <span class="sourceLineNo">144</span> * Gets this XmlLayout's content format. Specified by:<a name="line.144"></a> |
| <span class="sourceLineNo">145</span> * <ul><a name="line.145"></a> |
| <span class="sourceLineNo">146</span> * <li>Key: "dtd" Value: "log4j-events.dtd"</li><a name="line.146"></a> |
| <span class="sourceLineNo">147</span> * <li>Key: "version" Value: "2.0"</li><a name="line.147"></a> |
| <span class="sourceLineNo">148</span> * </ul><a name="line.148"></a> |
| <span class="sourceLineNo">149</span> *<a name="line.149"></a> |
| <span class="sourceLineNo">150</span> * @return Map of content format keys supporting XmlLayout<a name="line.150"></a> |
| <span class="sourceLineNo">151</span> */<a name="line.151"></a> |
| <span class="sourceLineNo">152</span> @Override<a name="line.152"></a> |
| <span class="sourceLineNo">153</span> public Map<String, String> getContentFormat() {<a name="line.153"></a> |
| <span class="sourceLineNo">154</span> final Map<String, String> result = new HashMap<>();<a name="line.154"></a> |
| <span class="sourceLineNo">155</span> // result.put("dtd", "log4j-events.dtd");<a name="line.155"></a> |
| <span class="sourceLineNo">156</span> result.put("xsd", "log4j-events.xsd");<a name="line.156"></a> |
| <span class="sourceLineNo">157</span> result.put("version", "2.0");<a name="line.157"></a> |
| <span class="sourceLineNo">158</span> return result;<a name="line.158"></a> |
| <span class="sourceLineNo">159</span> }<a name="line.159"></a> |
| <span class="sourceLineNo">160</span><a name="line.160"></a> |
| <span class="sourceLineNo">161</span> /**<a name="line.161"></a> |
| <span class="sourceLineNo">162</span> * @return The content type.<a name="line.162"></a> |
| <span class="sourceLineNo">163</span> */<a name="line.163"></a> |
| <span class="sourceLineNo">164</span> @Override<a name="line.164"></a> |
| <span class="sourceLineNo">165</span> public String getContentType() {<a name="line.165"></a> |
| <span class="sourceLineNo">166</span> return "text/xml; charset=" + this.getCharset();<a name="line.166"></a> |
| <span class="sourceLineNo">167</span> }<a name="line.167"></a> |
| <span class="sourceLineNo">168</span><a name="line.168"></a> |
| <span class="sourceLineNo">169</span> /**<a name="line.169"></a> |
| <span class="sourceLineNo">170</span> * Creates an XML Layout.<a name="line.170"></a> |
| <span class="sourceLineNo">171</span> *<a name="line.171"></a> |
| <span class="sourceLineNo">172</span> * @param locationInfo If "true", includes the location information in the generated XML.<a name="line.172"></a> |
| <span class="sourceLineNo">173</span> * @param properties If "true", includes the thread context map in the generated XML.<a name="line.173"></a> |
| <span class="sourceLineNo">174</span> * @param complete If "true", includes the XML header and footer, defaults to "false".<a name="line.174"></a> |
| <span class="sourceLineNo">175</span> * @param compact If "true", does not use end-of-lines and indentation, defaults to "false".<a name="line.175"></a> |
| <span class="sourceLineNo">176</span> * @param charset The character set to use, if {@code null}, uses "UTF-8".<a name="line.176"></a> |
| <span class="sourceLineNo">177</span> * @param includeStacktrace<a name="line.177"></a> |
| <span class="sourceLineNo">178</span> * If "true", includes the stacktrace of any Throwable in the generated XML, defaults to "true".<a name="line.178"></a> |
| <span class="sourceLineNo">179</span> * @return An XML Layout.<a name="line.179"></a> |
| <span class="sourceLineNo">180</span> *<a name="line.180"></a> |
| <span class="sourceLineNo">181</span> * @deprecated Use {@link #newBuilder()} instead<a name="line.181"></a> |
| <span class="sourceLineNo">182</span> */<a name="line.182"></a> |
| <span class="sourceLineNo">183</span> @Deprecated<a name="line.183"></a> |
| <span class="sourceLineNo">184</span> public static XmlLayout createLayout(<a name="line.184"></a> |
| <span class="sourceLineNo">185</span> final boolean locationInfo,<a name="line.185"></a> |
| <span class="sourceLineNo">186</span> final boolean properties,<a name="line.186"></a> |
| <span class="sourceLineNo">187</span> final boolean complete,<a name="line.187"></a> |
| <span class="sourceLineNo">188</span> final boolean compact,<a name="line.188"></a> |
| <span class="sourceLineNo">189</span> final Charset charset,<a name="line.189"></a> |
| <span class="sourceLineNo">190</span> final boolean includeStacktrace) {<a name="line.190"></a> |
| <span class="sourceLineNo">191</span> return new XmlLayout(null, locationInfo, properties, complete, compact, null, charset, includeStacktrace, false,<a name="line.191"></a> |
| <span class="sourceLineNo">192</span> false, null);<a name="line.192"></a> |
| <span class="sourceLineNo">193</span> }<a name="line.193"></a> |
| <span class="sourceLineNo">194</span><a name="line.194"></a> |
| <span class="sourceLineNo">195</span> @PluginBuilderFactory<a name="line.195"></a> |
| <span class="sourceLineNo">196</span> public static <B extends Builder<B>> B newBuilder() {<a name="line.196"></a> |
| <span class="sourceLineNo">197</span> return new Builder<B>().asBuilder();<a name="line.197"></a> |
| <span class="sourceLineNo">198</span> }<a name="line.198"></a> |
| <span class="sourceLineNo">199</span><a name="line.199"></a> |
| <span class="sourceLineNo">200</span> /**<a name="line.200"></a> |
| <span class="sourceLineNo">201</span> * Creates an XML Layout using the default settings.<a name="line.201"></a> |
| <span class="sourceLineNo">202</span> *<a name="line.202"></a> |
| <span class="sourceLineNo">203</span> * @return an XML Layout.<a name="line.203"></a> |
| <span class="sourceLineNo">204</span> */<a name="line.204"></a> |
| <span class="sourceLineNo">205</span> public static XmlLayout createDefaultLayout() {<a name="line.205"></a> |
| <span class="sourceLineNo">206</span> return new XmlLayout(null, false, false, false, false, null, StandardCharsets.UTF_8, true, false, false, null);<a name="line.206"></a> |
| <span class="sourceLineNo">207</span> }<a name="line.207"></a> |
| <span class="sourceLineNo">208</span>}<a name="line.208"></a> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| </pre> |
| </div> |
| </body> |
| </html> |
