Google Git
Sign in
apache / logging-log4j-site / 9755b12b39efbc0142688f9b1a11ec68db89f97b / . / 2.13.0 / log4j-core / apidocs / src-html / org / apache / logging / log4j / core / layout / AbstractStringLayout.Builder.html
blob: cfd387b969e78cb28a7810dc8528c5f3819c9d0f [file] [log] [blame]
<!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.io.UnsupportedEncodingException;<a name="line.19"></a>
<span class="sourceLineNo">020</span>import java.nio.charset.Charset;<a name="line.20"></a>
<span class="sourceLineNo">021</span>import java.nio.charset.StandardCharsets;<a name="line.21"></a>
<span class="sourceLineNo">022</span><a name="line.22"></a>
<span class="sourceLineNo">023</span>import org.apache.logging.log4j.core.LogEvent;<a name="line.23"></a>
<span class="sourceLineNo">024</span>import org.apache.logging.log4j.core.StringLayout;<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.LoggerConfig;<a name="line.26"></a>
<span class="sourceLineNo">027</span>import org.apache.logging.log4j.core.config.plugins.PluginBuilderAttribute;<a name="line.27"></a>
<span class="sourceLineNo">028</span>import org.apache.logging.log4j.core.config.plugins.PluginElement;<a name="line.28"></a>
<span class="sourceLineNo">029</span>import org.apache.logging.log4j.core.impl.DefaultLogEventFactory;<a name="line.29"></a>
<span class="sourceLineNo">030</span>import org.apache.logging.log4j.core.impl.LocationAware;<a name="line.30"></a>
<span class="sourceLineNo">031</span>import org.apache.logging.log4j.core.util.Constants;<a name="line.31"></a>
<span class="sourceLineNo">032</span>import org.apache.logging.log4j.core.util.StringEncoder;<a name="line.32"></a>
<span class="sourceLineNo">033</span>import org.apache.logging.log4j.spi.AbstractLogger;<a name="line.33"></a>
<span class="sourceLineNo">034</span>import org.apache.logging.log4j.util.PropertiesUtil;<a name="line.34"></a>
<span class="sourceLineNo">035</span>import org.apache.logging.log4j.util.StringBuilders;<a name="line.35"></a>
<span class="sourceLineNo">036</span>import org.apache.logging.log4j.util.Strings;<a name="line.36"></a>
<span class="sourceLineNo">037</span><a name="line.37"></a>
<span class="sourceLineNo">038</span>/**<a name="line.38"></a>
<span class="sourceLineNo">039</span> * Abstract base class for Layouts that result in a String.<a name="line.39"></a>
<span class="sourceLineNo">040</span> * &lt;p&gt;<a name="line.40"></a>
<span class="sourceLineNo">041</span> * Since 2.4.1, this class has custom logic to convert ISO-8859-1 or US-ASCII Strings to byte[] arrays to improve<a name="line.41"></a>
<span class="sourceLineNo">042</span> * performance: all characters are simply cast to bytes.<a name="line.42"></a>
<span class="sourceLineNo">043</span> * &lt;/p&gt;<a name="line.43"></a>
<span class="sourceLineNo">044</span> */<a name="line.44"></a>
<span class="sourceLineNo">045</span>/*<a name="line.45"></a>
<span class="sourceLineNo">046</span> * Implementation note: prefer String.getBytes(String) to String.getBytes(Charset) for performance reasons. See<a name="line.46"></a>
<span class="sourceLineNo">047</span> * https://issues.apache.org/jira/browse/LOG4J2-935 for details.<a name="line.47"></a>
<span class="sourceLineNo">048</span> */<a name="line.48"></a>
<span class="sourceLineNo">049</span>public abstract class AbstractStringLayout extends AbstractLayout&lt;String&gt; implements StringLayout, LocationAware {<a name="line.49"></a>
<span class="sourceLineNo">050</span><a name="line.50"></a>
<span class="sourceLineNo">051</span> public abstract static class Builder&lt;B extends Builder&lt;B&gt;&gt; extends AbstractLayout.Builder&lt;B&gt; {<a name="line.51"></a>
<span class="sourceLineNo">052</span><a name="line.52"></a>
<span class="sourceLineNo">053</span> @PluginBuilderAttribute(value = "charset")<a name="line.53"></a>
<span class="sourceLineNo">054</span> private Charset charset;<a name="line.54"></a>
<span class="sourceLineNo">055</span><a name="line.55"></a>
<span class="sourceLineNo">056</span> @PluginElement("footerSerializer")<a name="line.56"></a>
<span class="sourceLineNo">057</span> private Serializer footerSerializer;<a name="line.57"></a>
<span class="sourceLineNo">058</span><a name="line.58"></a>
<span class="sourceLineNo">059</span> @PluginElement("headerSerializer")<a name="line.59"></a>
<span class="sourceLineNo">060</span> private Serializer headerSerializer;<a name="line.60"></a>
<span class="sourceLineNo">061</span><a name="line.61"></a>
<span class="sourceLineNo">062</span> public Charset getCharset() {<a name="line.62"></a>
<span class="sourceLineNo">063</span> return charset;<a name="line.63"></a>
<span class="sourceLineNo">064</span> }<a name="line.64"></a>
<span class="sourceLineNo">065</span><a name="line.65"></a>
<span class="sourceLineNo">066</span> public Serializer getFooterSerializer() {<a name="line.66"></a>
<span class="sourceLineNo">067</span> return footerSerializer;<a name="line.67"></a>
<span class="sourceLineNo">068</span> }<a name="line.68"></a>
<span class="sourceLineNo">069</span><a name="line.69"></a>
<span class="sourceLineNo">070</span> public Serializer getHeaderSerializer() {<a name="line.70"></a>
<span class="sourceLineNo">071</span> return headerSerializer;<a name="line.71"></a>
<span class="sourceLineNo">072</span> }<a name="line.72"></a>
<span class="sourceLineNo">073</span><a name="line.73"></a>
<span class="sourceLineNo">074</span> public B setCharset(final Charset charset) {<a name="line.74"></a>
<span class="sourceLineNo">075</span> this.charset = charset;<a name="line.75"></a>
<span class="sourceLineNo">076</span> return asBuilder();<a name="line.76"></a>
<span class="sourceLineNo">077</span> }<a name="line.77"></a>
<span class="sourceLineNo">078</span><a name="line.78"></a>
<span class="sourceLineNo">079</span> public B setFooterSerializer(final Serializer footerSerializer) {<a name="line.79"></a>
<span class="sourceLineNo">080</span> this.footerSerializer = footerSerializer;<a name="line.80"></a>
<span class="sourceLineNo">081</span> return asBuilder();<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> public B setHeaderSerializer(final Serializer headerSerializer) {<a name="line.84"></a>
<span class="sourceLineNo">085</span> this.headerSerializer = headerSerializer;<a name="line.85"></a>
<span class="sourceLineNo">086</span> return asBuilder();<a name="line.86"></a>
<span class="sourceLineNo">087</span> }<a name="line.87"></a>
<span class="sourceLineNo">088</span><a name="line.88"></a>
<span class="sourceLineNo">089</span> }<a name="line.89"></a>
<span class="sourceLineNo">090</span><a name="line.90"></a>
<span class="sourceLineNo">091</span> public boolean requiresLocation() {<a name="line.91"></a>
<span class="sourceLineNo">092</span> return false;<a name="line.92"></a>
<span class="sourceLineNo">093</span> }<a name="line.93"></a>
<span class="sourceLineNo">094</span><a name="line.94"></a>
<span class="sourceLineNo">095</span> public interface Serializer {<a name="line.95"></a>
<span class="sourceLineNo">096</span> String toSerializable(final LogEvent event);<a name="line.96"></a>
<span class="sourceLineNo">097</span><a name="line.97"></a>
<span class="sourceLineNo">098</span> default StringBuilder toSerializable(final LogEvent event, final StringBuilder builder) {<a name="line.98"></a>
<span class="sourceLineNo">099</span> builder.append(toSerializable(event));<a name="line.99"></a>
<span class="sourceLineNo">100</span> return builder;<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> /**<a name="line.104"></a>
<span class="sourceLineNo">105</span> * Variation of {@link Serializer} that avoids allocating temporary objects.<a name="line.105"></a>
<span class="sourceLineNo">106</span> * As of 2.13 this interface was merged into the Serializer interface.<a name="line.106"></a>
<span class="sourceLineNo">107</span> * @since 2.6<a name="line.107"></a>
<span class="sourceLineNo">108</span> */<a name="line.108"></a>
<span class="sourceLineNo">109</span> public interface Serializer2 {<a name="line.109"></a>
<span class="sourceLineNo">110</span> StringBuilder toSerializable(final LogEvent event, final StringBuilder builder);<a name="line.110"></a>
<span class="sourceLineNo">111</span> }<a name="line.111"></a>
<span class="sourceLineNo">112</span><a name="line.112"></a>
<span class="sourceLineNo">113</span> /**<a name="line.113"></a>
<span class="sourceLineNo">114</span> * Default length for new StringBuilder instances: {@value} .<a name="line.114"></a>
<span class="sourceLineNo">115</span> */<a name="line.115"></a>
<span class="sourceLineNo">116</span> protected static final int DEFAULT_STRING_BUILDER_SIZE = 1024;<a name="line.116"></a>
<span class="sourceLineNo">117</span><a name="line.117"></a>
<span class="sourceLineNo">118</span> protected static final int MAX_STRING_BUILDER_SIZE = Math.max(DEFAULT_STRING_BUILDER_SIZE,<a name="line.118"></a>
<span class="sourceLineNo">119</span> size("log4j.layoutStringBuilder.maxSize", 2 * 1024));<a name="line.119"></a>
<span class="sourceLineNo">120</span><a name="line.120"></a>
<span class="sourceLineNo">121</span> private static final ThreadLocal&lt;StringBuilder&gt; threadLocal = new ThreadLocal&lt;&gt;();<a name="line.121"></a>
<span class="sourceLineNo">122</span><a name="line.122"></a>
<span class="sourceLineNo">123</span> /**<a name="line.123"></a>
<span class="sourceLineNo">124</span> * Returns a {@code StringBuilder} that this Layout implementation can use to write the formatted log event to.<a name="line.124"></a>
<span class="sourceLineNo">125</span> *<a name="line.125"></a>
<span class="sourceLineNo">126</span> * @return a {@code StringBuilder}<a name="line.126"></a>
<span class="sourceLineNo">127</span> */<a name="line.127"></a>
<span class="sourceLineNo">128</span> protected static StringBuilder getStringBuilder() {<a name="line.128"></a>
<span class="sourceLineNo">129</span> if (AbstractLogger.getRecursionDepth() &gt; 1) { // LOG4J2-2368<a name="line.129"></a>
<span class="sourceLineNo">130</span> // Recursive logging may clobber the cached StringBuilder.<a name="line.130"></a>
<span class="sourceLineNo">131</span> return new StringBuilder(DEFAULT_STRING_BUILDER_SIZE);<a name="line.131"></a>
<span class="sourceLineNo">132</span> }<a name="line.132"></a>
<span class="sourceLineNo">133</span> StringBuilder result = threadLocal.get();<a name="line.133"></a>
<span class="sourceLineNo">134</span> if (result == null) {<a name="line.134"></a>
<span class="sourceLineNo">135</span> result = new StringBuilder(DEFAULT_STRING_BUILDER_SIZE);<a name="line.135"></a>
<span class="sourceLineNo">136</span> threadLocal.set(result);<a name="line.136"></a>
<span class="sourceLineNo">137</span> }<a name="line.137"></a>
<span class="sourceLineNo">138</span> trimToMaxSize(result);<a name="line.138"></a>
<span class="sourceLineNo">139</span> result.setLength(0);<a name="line.139"></a>
<span class="sourceLineNo">140</span> return result;<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> // LOG4J2-1151: If the built-in JDK 8 encoders are available we should use them.<a name="line.143"></a>
<span class="sourceLineNo">144</span> private static boolean isPreJava8() {<a name="line.144"></a>
<span class="sourceLineNo">145</span> return org.apache.logging.log4j.util.Constants.JAVA_MAJOR_VERSION &lt; 8;<a name="line.145"></a>
<span class="sourceLineNo">146</span> }<a name="line.146"></a>
<span class="sourceLineNo">147</span><a name="line.147"></a>
<span class="sourceLineNo">148</span> private static int size(final String property, final int defaultValue) {<a name="line.148"></a>
<span class="sourceLineNo">149</span> return PropertiesUtil.getProperties().getIntegerProperty(property, defaultValue);<a name="line.149"></a>
<span class="sourceLineNo">150</span> }<a name="line.150"></a>
<span class="sourceLineNo">151</span><a name="line.151"></a>
<span class="sourceLineNo">152</span> protected static void trimToMaxSize(final StringBuilder stringBuilder) {<a name="line.152"></a>
<span class="sourceLineNo">153</span> StringBuilders.trimToMaxSize(stringBuilder, MAX_STRING_BUILDER_SIZE);<a name="line.153"></a>
<span class="sourceLineNo">154</span> }<a name="line.154"></a>
<span class="sourceLineNo">155</span><a name="line.155"></a>
<span class="sourceLineNo">156</span> private Encoder&lt;StringBuilder&gt; textEncoder;<a name="line.156"></a>
<span class="sourceLineNo">157</span> /**<a name="line.157"></a>
<span class="sourceLineNo">158</span> * The charset for the formatted message.<a name="line.158"></a>
<span class="sourceLineNo">159</span> */<a name="line.159"></a>
<span class="sourceLineNo">160</span> // LOG4J2-1099: Charset cannot be final due to serialization needs, so we serialize as Charset name instead<a name="line.160"></a>
<span class="sourceLineNo">161</span> private transient Charset charset;<a name="line.161"></a>
<span class="sourceLineNo">162</span><a name="line.162"></a>
<span class="sourceLineNo">163</span> private final String charsetName;<a name="line.163"></a>
<span class="sourceLineNo">164</span><a name="line.164"></a>
<span class="sourceLineNo">165</span> private final Serializer footerSerializer;<a name="line.165"></a>
<span class="sourceLineNo">166</span><a name="line.166"></a>
<span class="sourceLineNo">167</span> private final Serializer headerSerializer;<a name="line.167"></a>
<span class="sourceLineNo">168</span><a name="line.168"></a>
<span class="sourceLineNo">169</span> private final boolean useCustomEncoding;<a name="line.169"></a>
<span class="sourceLineNo">170</span><a name="line.170"></a>
<span class="sourceLineNo">171</span> protected AbstractStringLayout(final Charset charset) {<a name="line.171"></a>
<span class="sourceLineNo">172</span> this(charset, (byte[]) null, (byte[]) null);<a name="line.172"></a>
<span class="sourceLineNo">173</span> }<a name="line.173"></a>
<span class="sourceLineNo">174</span><a name="line.174"></a>
<span class="sourceLineNo">175</span> /**<a name="line.175"></a>
<span class="sourceLineNo">176</span> * Builds a new layout.<a name="line.176"></a>
<span class="sourceLineNo">177</span> * @param aCharset the charset used to encode the header bytes, footer bytes and anything else that needs to be<a name="line.177"></a>
<span class="sourceLineNo">178</span> * converted from strings to bytes.<a name="line.178"></a>
<span class="sourceLineNo">179</span> * @param header the header bytes<a name="line.179"></a>
<span class="sourceLineNo">180</span> * @param footer the footer bytes<a name="line.180"></a>
<span class="sourceLineNo">181</span> */<a name="line.181"></a>
<span class="sourceLineNo">182</span> protected AbstractStringLayout(final Charset aCharset, final byte[] header, final byte[] footer) {<a name="line.182"></a>
<span class="sourceLineNo">183</span> super(null, header, footer);<a name="line.183"></a>
<span class="sourceLineNo">184</span> this.headerSerializer = null;<a name="line.184"></a>
<span class="sourceLineNo">185</span> this.footerSerializer = null;<a name="line.185"></a>
<span class="sourceLineNo">186</span> this.charset = aCharset == null ? StandardCharsets.UTF_8 : aCharset;<a name="line.186"></a>
<span class="sourceLineNo">187</span> this.charsetName = this.charset.name();<a name="line.187"></a>
<span class="sourceLineNo">188</span> useCustomEncoding = isPreJava8()<a name="line.188"></a>
<span class="sourceLineNo">189</span> &amp;&amp; (StandardCharsets.ISO_8859_1.equals(aCharset) || StandardCharsets.US_ASCII.equals(aCharset));<a name="line.189"></a>
<span class="sourceLineNo">190</span> textEncoder = Constants.ENABLE_DIRECT_ENCODERS ? new StringBuilderEncoder(charset) : null;<a name="line.190"></a>
<span class="sourceLineNo">191</span> }<a name="line.191"></a>
<span class="sourceLineNo">192</span><a name="line.192"></a>
<span class="sourceLineNo">193</span> /**<a name="line.193"></a>
<span class="sourceLineNo">194</span> * Builds a new layout.<a name="line.194"></a>
<span class="sourceLineNo">195</span> * @param config the configuration<a name="line.195"></a>
<span class="sourceLineNo">196</span> * @param aCharset the charset used to encode the header bytes, footer bytes and anything else that needs to be<a name="line.196"></a>
<span class="sourceLineNo">197</span> * converted from strings to bytes.<a name="line.197"></a>
<span class="sourceLineNo">198</span> * @param headerSerializer the header bytes serializer<a name="line.198"></a>
<span class="sourceLineNo">199</span> * @param footerSerializer the footer bytes serializer<a name="line.199"></a>
<span class="sourceLineNo">200</span> */<a name="line.200"></a>
<span class="sourceLineNo">201</span> protected AbstractStringLayout(final Configuration config, final Charset aCharset,<a name="line.201"></a>
<span class="sourceLineNo">202</span> final Serializer headerSerializer, final Serializer footerSerializer) {<a name="line.202"></a>
<span class="sourceLineNo">203</span> super(config, null, null);<a name="line.203"></a>
<span class="sourceLineNo">204</span> this.headerSerializer = headerSerializer;<a name="line.204"></a>
<span class="sourceLineNo">205</span> this.footerSerializer = footerSerializer;<a name="line.205"></a>
<span class="sourceLineNo">206</span> this.charset = aCharset == null ? StandardCharsets.UTF_8 : aCharset;<a name="line.206"></a>
<span class="sourceLineNo">207</span> this.charsetName = this.charset.name();<a name="line.207"></a>
<span class="sourceLineNo">208</span> useCustomEncoding = isPreJava8()<a name="line.208"></a>
<span class="sourceLineNo">209</span> &amp;&amp; (StandardCharsets.ISO_8859_1.equals(aCharset) || StandardCharsets.US_ASCII.equals(aCharset));<a name="line.209"></a>
<span class="sourceLineNo">210</span> textEncoder = Constants.ENABLE_DIRECT_ENCODERS ? new StringBuilderEncoder(charset) : null;<a name="line.210"></a>
<span class="sourceLineNo">211</span> }<a name="line.211"></a>
<span class="sourceLineNo">212</span><a name="line.212"></a>
<span class="sourceLineNo">213</span> protected byte[] getBytes(final String s) {<a name="line.213"></a>
<span class="sourceLineNo">214</span> if (useCustomEncoding) { // rely on branch prediction to eliminate this check if false<a name="line.214"></a>
<span class="sourceLineNo">215</span> return StringEncoder.encodeSingleByteChars(s);<a name="line.215"></a>
<span class="sourceLineNo">216</span> }<a name="line.216"></a>
<span class="sourceLineNo">217</span> try { // LOG4J2-935: String.getBytes(String) gives better performance<a name="line.217"></a>
<span class="sourceLineNo">218</span> return s.getBytes(charsetName);<a name="line.218"></a>
<span class="sourceLineNo">219</span> } catch (final UnsupportedEncodingException e) {<a name="line.219"></a>
<span class="sourceLineNo">220</span> return s.getBytes(charset);<a name="line.220"></a>
<span class="sourceLineNo">221</span> }<a name="line.221"></a>
<span class="sourceLineNo">222</span> }<a name="line.222"></a>
<span class="sourceLineNo">223</span><a name="line.223"></a>
<span class="sourceLineNo">224</span> @Override<a name="line.224"></a>
<span class="sourceLineNo">225</span> public Charset getCharset() {<a name="line.225"></a>
<span class="sourceLineNo">226</span> return charset;<a name="line.226"></a>
<span class="sourceLineNo">227</span> }<a name="line.227"></a>
<span class="sourceLineNo">228</span><a name="line.228"></a>
<span class="sourceLineNo">229</span> /**<a name="line.229"></a>
<span class="sourceLineNo">230</span> * @return The default content type for Strings.<a name="line.230"></a>
<span class="sourceLineNo">231</span> */<a name="line.231"></a>
<span class="sourceLineNo">232</span> @Override<a name="line.232"></a>
<span class="sourceLineNo">233</span> public String getContentType() {<a name="line.233"></a>
<span class="sourceLineNo">234</span> return "text/plain";<a name="line.234"></a>
<span class="sourceLineNo">235</span> }<a name="line.235"></a>
<span class="sourceLineNo">236</span><a name="line.236"></a>
<span class="sourceLineNo">237</span> /**<a name="line.237"></a>
<span class="sourceLineNo">238</span> * Returns the footer, if one is available.<a name="line.238"></a>
<span class="sourceLineNo">239</span> *<a name="line.239"></a>
<span class="sourceLineNo">240</span> * @return A byte array containing the footer.<a name="line.240"></a>
<span class="sourceLineNo">241</span> */<a name="line.241"></a>
<span class="sourceLineNo">242</span> @Override<a name="line.242"></a>
<span class="sourceLineNo">243</span> public byte[] getFooter() {<a name="line.243"></a>
<span class="sourceLineNo">244</span> return serializeToBytes(footerSerializer, super.getFooter());<a name="line.244"></a>
<span class="sourceLineNo">245</span> }<a name="line.245"></a>
<span class="sourceLineNo">246</span><a name="line.246"></a>
<span class="sourceLineNo">247</span> public Serializer getFooterSerializer() {<a name="line.247"></a>
<span class="sourceLineNo">248</span> return footerSerializer;<a name="line.248"></a>
<span class="sourceLineNo">249</span> }<a name="line.249"></a>
<span class="sourceLineNo">250</span><a name="line.250"></a>
<span class="sourceLineNo">251</span> /**<a name="line.251"></a>
<span class="sourceLineNo">252</span> * Returns the header, if one is available.<a name="line.252"></a>
<span class="sourceLineNo">253</span> *<a name="line.253"></a>
<span class="sourceLineNo">254</span> * @return A byte array containing the header.<a name="line.254"></a>
<span class="sourceLineNo">255</span> */<a name="line.255"></a>
<span class="sourceLineNo">256</span> @Override<a name="line.256"></a>
<span class="sourceLineNo">257</span> public byte[] getHeader() {<a name="line.257"></a>
<span class="sourceLineNo">258</span> return serializeToBytes(headerSerializer, super.getHeader());<a name="line.258"></a>
<span class="sourceLineNo">259</span> }<a name="line.259"></a>
<span class="sourceLineNo">260</span><a name="line.260"></a>
<span class="sourceLineNo">261</span> public Serializer getHeaderSerializer() {<a name="line.261"></a>
<span class="sourceLineNo">262</span> return headerSerializer;<a name="line.262"></a>
<span class="sourceLineNo">263</span> }<a name="line.263"></a>
<span class="sourceLineNo">264</span><a name="line.264"></a>
<span class="sourceLineNo">265</span> private DefaultLogEventFactory getLogEventFactory() {<a name="line.265"></a>
<span class="sourceLineNo">266</span> return DefaultLogEventFactory.getInstance();<a name="line.266"></a>
<span class="sourceLineNo">267</span> }<a name="line.267"></a>
<span class="sourceLineNo">268</span><a name="line.268"></a>
<span class="sourceLineNo">269</span> /**<a name="line.269"></a>
<span class="sourceLineNo">270</span> * Returns a {@code Encoder&lt;StringBuilder&gt;} that this Layout implementation can use for encoding log events.<a name="line.270"></a>
<span class="sourceLineNo">271</span> *<a name="line.271"></a>
<span class="sourceLineNo">272</span> * @return a {@code Encoder&lt;StringBuilder&gt;}<a name="line.272"></a>
<span class="sourceLineNo">273</span> */<a name="line.273"></a>
<span class="sourceLineNo">274</span> protected Encoder&lt;StringBuilder&gt; getStringBuilderEncoder() {<a name="line.274"></a>
<span class="sourceLineNo">275</span> if (textEncoder == null) {<a name="line.275"></a>
<span class="sourceLineNo">276</span> textEncoder = new StringBuilderEncoder(getCharset());<a name="line.276"></a>
<span class="sourceLineNo">277</span> }<a name="line.277"></a>
<span class="sourceLineNo">278</span> return textEncoder;<a name="line.278"></a>
<span class="sourceLineNo">279</span> }<a name="line.279"></a>
<span class="sourceLineNo">280</span><a name="line.280"></a>
<span class="sourceLineNo">281</span> protected byte[] serializeToBytes(final Serializer serializer, final byte[] defaultValue) {<a name="line.281"></a>
<span class="sourceLineNo">282</span> final String serializable = serializeToString(serializer);<a name="line.282"></a>
<span class="sourceLineNo">283</span> if (serializer == null) {<a name="line.283"></a>
<span class="sourceLineNo">284</span> return defaultValue;<a name="line.284"></a>
<span class="sourceLineNo">285</span> }<a name="line.285"></a>
<span class="sourceLineNo">286</span> return StringEncoder.toBytes(serializable, getCharset());<a name="line.286"></a>
<span class="sourceLineNo">287</span> }<a name="line.287"></a>
<span class="sourceLineNo">288</span><a name="line.288"></a>
<span class="sourceLineNo">289</span> protected String serializeToString(final Serializer serializer) {<a name="line.289"></a>
<span class="sourceLineNo">290</span> if (serializer == null) {<a name="line.290"></a>
<span class="sourceLineNo">291</span> return null;<a name="line.291"></a>
<span class="sourceLineNo">292</span> }<a name="line.292"></a>
<span class="sourceLineNo">293</span> final LoggerConfig rootLogger = getConfiguration().getRootLogger();<a name="line.293"></a>
<span class="sourceLineNo">294</span> // Using "" for the FQCN, does it matter?<a name="line.294"></a>
<span class="sourceLineNo">295</span> final LogEvent logEvent = getLogEventFactory().createEvent(rootLogger.getName(), null, Strings.EMPTY,<a name="line.295"></a>
<span class="sourceLineNo">296</span> rootLogger.getLevel(), null, null, null);<a name="line.296"></a>
<span class="sourceLineNo">297</span> return serializer.toSerializable(logEvent);<a name="line.297"></a>
<span class="sourceLineNo">298</span> }<a name="line.298"></a>
<span class="sourceLineNo">299</span><a name="line.299"></a>
<span class="sourceLineNo">300</span> /**<a name="line.300"></a>
<span class="sourceLineNo">301</span> * Formats the Log Event as a byte array.<a name="line.301"></a>
<span class="sourceLineNo">302</span> *<a name="line.302"></a>
<span class="sourceLineNo">303</span> * @param event The Log Event.<a name="line.303"></a>
<span class="sourceLineNo">304</span> * @return The formatted event as a byte array.<a name="line.304"></a>
<span class="sourceLineNo">305</span> */<a name="line.305"></a>
<span class="sourceLineNo">306</span> @Override<a name="line.306"></a>
<span class="sourceLineNo">307</span> public byte[] toByteArray(final LogEvent event) {<a name="line.307"></a>
<span class="sourceLineNo">308</span> return getBytes(toSerializable(event));<a name="line.308"></a>
<span class="sourceLineNo">309</span> }<a name="line.309"></a>
<span class="sourceLineNo">310</span><a name="line.310"></a>
<span class="sourceLineNo">311</span>}<a name="line.311"></a>
</pre>
</div>
</body>
</html>