| <!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.util.Arrays;<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.List;<a name="line.22"></a> |
| <span class="sourceLineNo">023</span>import java.util.Map;<a name="line.23"></a> |
| <span class="sourceLineNo">024</span><a name="line.24"></a> |
| <span class="sourceLineNo">025</span>import org.apache.logging.log4j.core.Layout;<a name="line.25"></a> |
| <span class="sourceLineNo">026</span>import org.apache.logging.log4j.core.LogEvent;<a name="line.26"></a> |
| <span class="sourceLineNo">027</span>import org.apache.logging.log4j.core.config.Configuration;<a name="line.27"></a> |
| <span class="sourceLineNo">028</span>import org.apache.logging.log4j.core.config.DefaultConfiguration;<a name="line.28"></a> |
| <span class="sourceLineNo">029</span>import org.apache.logging.log4j.core.config.Node;<a name="line.29"></a> |
| <span class="sourceLineNo">030</span>import org.apache.logging.log4j.core.config.plugins.Plugin;<a name="line.30"></a> |
| <span class="sourceLineNo">031</span>import org.apache.logging.log4j.core.config.plugins.PluginAttribute;<a name="line.31"></a> |
| <span class="sourceLineNo">032</span>import org.apache.logging.log4j.core.config.plugins.PluginBuilderAttribute;<a name="line.32"></a> |
| <span class="sourceLineNo">033</span>import org.apache.logging.log4j.core.config.plugins.PluginBuilderFactory;<a name="line.33"></a> |
| <span class="sourceLineNo">034</span>import org.apache.logging.log4j.core.config.plugins.PluginConfiguration;<a name="line.34"></a> |
| <span class="sourceLineNo">035</span>import org.apache.logging.log4j.core.config.plugins.PluginElement;<a name="line.35"></a> |
| <span class="sourceLineNo">036</span>import org.apache.logging.log4j.core.config.plugins.PluginFactory;<a name="line.36"></a> |
| <span class="sourceLineNo">037</span>import org.apache.logging.log4j.core.impl.LocationAware;<a name="line.37"></a> |
| <span class="sourceLineNo">038</span>import org.apache.logging.log4j.core.pattern.LogEventPatternConverter;<a name="line.38"></a> |
| <span class="sourceLineNo">039</span>import org.apache.logging.log4j.core.pattern.PatternFormatter;<a name="line.39"></a> |
| <span class="sourceLineNo">040</span>import org.apache.logging.log4j.core.pattern.PatternParser;<a name="line.40"></a> |
| <span class="sourceLineNo">041</span>import org.apache.logging.log4j.core.pattern.RegexReplacement;<a name="line.41"></a> |
| <span class="sourceLineNo">042</span>import org.apache.logging.log4j.util.PropertiesUtil;<a name="line.42"></a> |
| <span class="sourceLineNo">043</span>import org.apache.logging.log4j.util.Strings;<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> * A flexible layout configurable with pattern string.<a name="line.46"></a> |
| <span class="sourceLineNo">047</span> * <p><a name="line.47"></a> |
| <span class="sourceLineNo">048</span> * The goal of this class is to {@link org.apache.logging.log4j.core.Layout#toByteArray format} a {@link LogEvent} and<a name="line.48"></a> |
| <span class="sourceLineNo">049</span> * return the results. The format of the result depends on the <em>conversion pattern</em>.<a name="line.49"></a> |
| <span class="sourceLineNo">050</span> * </p><a name="line.50"></a> |
| <span class="sourceLineNo">051</span> * <p><a name="line.51"></a> |
| <span class="sourceLineNo">052</span> * The conversion pattern is closely related to the conversion pattern of the printf function in C. A conversion pattern<a name="line.52"></a> |
| <span class="sourceLineNo">053</span> * is composed of literal text and format control expressions called <em>conversion specifiers</em>.<a name="line.53"></a> |
| <span class="sourceLineNo">054</span> * </p><a name="line.54"></a> |
| <span class="sourceLineNo">055</span> * <p><a name="line.55"></a> |
| <span class="sourceLineNo">056</span> * See the Log4j Manual for details on the supported pattern converters.<a name="line.56"></a> |
| <span class="sourceLineNo">057</span> * </p><a name="line.57"></a> |
| <span class="sourceLineNo">058</span> */<a name="line.58"></a> |
| <span class="sourceLineNo">059</span>@Plugin(name = "PatternLayout", category = Node.CATEGORY, elementType = Layout.ELEMENT_TYPE, printObject = true)<a name="line.59"></a> |
| <span class="sourceLineNo">060</span>public final class PatternLayout extends AbstractStringLayout {<a name="line.60"></a> |
| <span class="sourceLineNo">061</span><a name="line.61"></a> |
| <span class="sourceLineNo">062</span> /**<a name="line.62"></a> |
| <span class="sourceLineNo">063</span> * Default pattern string for log output. Currently set to the string <b>"%m%n"</b> which just prints the<a name="line.63"></a> |
| <span class="sourceLineNo">064</span> * application supplied message.<a name="line.64"></a> |
| <span class="sourceLineNo">065</span> */<a name="line.65"></a> |
| <span class="sourceLineNo">066</span> public static final String DEFAULT_CONVERSION_PATTERN = "%m%n";<a name="line.66"></a> |
| <span class="sourceLineNo">067</span><a name="line.67"></a> |
| <span class="sourceLineNo">068</span> /**<a name="line.68"></a> |
| <span class="sourceLineNo">069</span> * A conversion pattern equivalent to the TTCCLayout. Current value is <b>%r [%t] %p %c %notEmpty{%x }- %m%n</b>.<a name="line.69"></a> |
| <span class="sourceLineNo">070</span> */<a name="line.70"></a> |
| <span class="sourceLineNo">071</span> public static final String TTCC_CONVERSION_PATTERN = "%r [%t] %p %c %notEmpty{%x }- %m%n";<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> * A simple pattern. Current value is <b>%d [%t] %p %c - %m%n</b>.<a name="line.74"></a> |
| <span class="sourceLineNo">075</span> */<a name="line.75"></a> |
| <span class="sourceLineNo">076</span> public static final String SIMPLE_CONVERSION_PATTERN = "%d [%t] %p %c - %m%n";<a name="line.76"></a> |
| <span class="sourceLineNo">077</span><a name="line.77"></a> |
| <span class="sourceLineNo">078</span> /** Key to identify pattern converters. */<a name="line.78"></a> |
| <span class="sourceLineNo">079</span> public static final String KEY = "Converter";<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> * Conversion pattern.<a name="line.82"></a> |
| <span class="sourceLineNo">083</span> */<a name="line.83"></a> |
| <span class="sourceLineNo">084</span> private final String conversionPattern;<a name="line.84"></a> |
| <span class="sourceLineNo">085</span> private final PatternSelector patternSelector;<a name="line.85"></a> |
| <span class="sourceLineNo">086</span> private final Serializer eventSerializer;<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> * Constructs a PatternLayout using the supplied conversion pattern.<a name="line.89"></a> |
| <span class="sourceLineNo">090</span> *<a name="line.90"></a> |
| <span class="sourceLineNo">091</span> * @param config The Configuration.<a name="line.91"></a> |
| <span class="sourceLineNo">092</span> * @param replace The regular expression to match.<a name="line.92"></a> |
| <span class="sourceLineNo">093</span> * @param eventPattern conversion pattern.<a name="line.93"></a> |
| <span class="sourceLineNo">094</span> * @param patternSelector The PatternSelector.<a name="line.94"></a> |
| <span class="sourceLineNo">095</span> * @param charset The character set.<a name="line.95"></a> |
| <span class="sourceLineNo">096</span> * @param alwaysWriteExceptions Whether or not exceptions should always be handled in this pattern (if {@code true},<a name="line.96"></a> |
| <span class="sourceLineNo">097</span> * exceptions will be written even if the pattern does not specify so).<a name="line.97"></a> |
| <span class="sourceLineNo">098</span> * @param disableAnsi<a name="line.98"></a> |
| <span class="sourceLineNo">099</span> * If {@code "true"}, do not output ANSI escape codes<a name="line.99"></a> |
| <span class="sourceLineNo">100</span> * @param noConsoleNoAnsi<a name="line.100"></a> |
| <span class="sourceLineNo">101</span> * If {@code "true"} (default) and {@link System#console()} is null, do not output ANSI escape codes<a name="line.101"></a> |
| <span class="sourceLineNo">102</span> * @param headerPattern header conversion pattern.<a name="line.102"></a> |
| <span class="sourceLineNo">103</span> * @param footerPattern footer conversion pattern.<a name="line.103"></a> |
| <span class="sourceLineNo">104</span> */<a name="line.104"></a> |
| <span class="sourceLineNo">105</span> private PatternLayout(final Configuration config, final RegexReplacement replace, final String eventPattern,<a name="line.105"></a> |
| <span class="sourceLineNo">106</span> final PatternSelector patternSelector, final Charset charset, final boolean alwaysWriteExceptions,<a name="line.106"></a> |
| <span class="sourceLineNo">107</span> final boolean disableAnsi, final boolean noConsoleNoAnsi, final String headerPattern,<a name="line.107"></a> |
| <span class="sourceLineNo">108</span> final String footerPattern) {<a name="line.108"></a> |
| <span class="sourceLineNo">109</span> super(config, charset,<a name="line.109"></a> |
| <span class="sourceLineNo">110</span> newSerializerBuilder()<a name="line.110"></a> |
| <span class="sourceLineNo">111</span> .setConfiguration(config)<a name="line.111"></a> |
| <span class="sourceLineNo">112</span> .setReplace(replace)<a name="line.112"></a> |
| <span class="sourceLineNo">113</span> .setPatternSelector(patternSelector)<a name="line.113"></a> |
| <span class="sourceLineNo">114</span> .setAlwaysWriteExceptions(alwaysWriteExceptions)<a name="line.114"></a> |
| <span class="sourceLineNo">115</span> .setDisableAnsi(disableAnsi)<a name="line.115"></a> |
| <span class="sourceLineNo">116</span> .setNoConsoleNoAnsi(noConsoleNoAnsi)<a name="line.116"></a> |
| <span class="sourceLineNo">117</span> .setPattern(headerPattern)<a name="line.117"></a> |
| <span class="sourceLineNo">118</span> .build(),<a name="line.118"></a> |
| <span class="sourceLineNo">119</span> newSerializerBuilder()<a name="line.119"></a> |
| <span class="sourceLineNo">120</span> .setConfiguration(config)<a name="line.120"></a> |
| <span class="sourceLineNo">121</span> .setReplace(replace)<a name="line.121"></a> |
| <span class="sourceLineNo">122</span> .setPatternSelector(patternSelector)<a name="line.122"></a> |
| <span class="sourceLineNo">123</span> .setAlwaysWriteExceptions(alwaysWriteExceptions)<a name="line.123"></a> |
| <span class="sourceLineNo">124</span> .setDisableAnsi(disableAnsi)<a name="line.124"></a> |
| <span class="sourceLineNo">125</span> .setNoConsoleNoAnsi(noConsoleNoAnsi)<a name="line.125"></a> |
| <span class="sourceLineNo">126</span> .setPattern(footerPattern)<a name="line.126"></a> |
| <span class="sourceLineNo">127</span> .build());<a name="line.127"></a> |
| <span class="sourceLineNo">128</span> this.conversionPattern = eventPattern;<a name="line.128"></a> |
| <span class="sourceLineNo">129</span> this.patternSelector = patternSelector;<a name="line.129"></a> |
| <span class="sourceLineNo">130</span> this.eventSerializer = newSerializerBuilder()<a name="line.130"></a> |
| <span class="sourceLineNo">131</span> .setConfiguration(config)<a name="line.131"></a> |
| <span class="sourceLineNo">132</span> .setReplace(replace)<a name="line.132"></a> |
| <span class="sourceLineNo">133</span> .setPatternSelector(patternSelector)<a name="line.133"></a> |
| <span class="sourceLineNo">134</span> .setAlwaysWriteExceptions(alwaysWriteExceptions)<a name="line.134"></a> |
| <span class="sourceLineNo">135</span> .setDisableAnsi(disableAnsi)<a name="line.135"></a> |
| <span class="sourceLineNo">136</span> .setNoConsoleNoAnsi(noConsoleNoAnsi)<a name="line.136"></a> |
| <span class="sourceLineNo">137</span> .setPattern(eventPattern)<a name="line.137"></a> |
| <span class="sourceLineNo">138</span> .setDefaultPattern(DEFAULT_CONVERSION_PATTERN)<a name="line.138"></a> |
| <span class="sourceLineNo">139</span> .build();<a name="line.139"></a> |
| <span class="sourceLineNo">140</span> }<a name="line.140"></a> |
| <span class="sourceLineNo">141</span><a name="line.141"></a> |
| <span class="sourceLineNo">142</span> public static SerializerBuilder newSerializerBuilder() {<a name="line.142"></a> |
| <span class="sourceLineNo">143</span> return new SerializerBuilder();<a name="line.143"></a> |
| <span class="sourceLineNo">144</span> }<a name="line.144"></a> |
| <span class="sourceLineNo">145</span><a name="line.145"></a> |
| <span class="sourceLineNo">146</span> @Override<a name="line.146"></a> |
| <span class="sourceLineNo">147</span> public boolean requiresLocation() {<a name="line.147"></a> |
| <span class="sourceLineNo">148</span> return eventSerializer instanceof LocationAware && ((LocationAware) eventSerializer).requiresLocation();<a name="line.148"></a> |
| <span class="sourceLineNo">149</span> }<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> /**<a name="line.152"></a> |
| <span class="sourceLineNo">153</span> * Deprecated, use {@link #newSerializerBuilder()} instead.<a name="line.153"></a> |
| <span class="sourceLineNo">154</span> *<a name="line.154"></a> |
| <span class="sourceLineNo">155</span> * @param configuration<a name="line.155"></a> |
| <span class="sourceLineNo">156</span> * @param replace<a name="line.156"></a> |
| <span class="sourceLineNo">157</span> * @param pattern<a name="line.157"></a> |
| <span class="sourceLineNo">158</span> * @param defaultPattern<a name="line.158"></a> |
| <span class="sourceLineNo">159</span> * @param patternSelector<a name="line.159"></a> |
| <span class="sourceLineNo">160</span> * @param alwaysWriteExceptions<a name="line.160"></a> |
| <span class="sourceLineNo">161</span> * @param noConsoleNoAnsi<a name="line.161"></a> |
| <span class="sourceLineNo">162</span> * @return a new Serializer.<a name="line.162"></a> |
| <span class="sourceLineNo">163</span> * @deprecated Use {@link #newSerializerBuilder()} instead.<a name="line.163"></a> |
| <span class="sourceLineNo">164</span> */<a name="line.164"></a> |
| <span class="sourceLineNo">165</span> @Deprecated<a name="line.165"></a> |
| <span class="sourceLineNo">166</span> public static Serializer createSerializer(final Configuration configuration, final RegexReplacement replace,<a name="line.166"></a> |
| <span class="sourceLineNo">167</span> final String pattern, final String defaultPattern, final PatternSelector patternSelector,<a name="line.167"></a> |
| <span class="sourceLineNo">168</span> final boolean alwaysWriteExceptions, final boolean noConsoleNoAnsi) {<a name="line.168"></a> |
| <span class="sourceLineNo">169</span> final SerializerBuilder builder = newSerializerBuilder();<a name="line.169"></a> |
| <span class="sourceLineNo">170</span> builder.setAlwaysWriteExceptions(alwaysWriteExceptions);<a name="line.170"></a> |
| <span class="sourceLineNo">171</span> builder.setConfiguration(configuration);<a name="line.171"></a> |
| <span class="sourceLineNo">172</span> builder.setDefaultPattern(defaultPattern);<a name="line.172"></a> |
| <span class="sourceLineNo">173</span> builder.setNoConsoleNoAnsi(noConsoleNoAnsi);<a name="line.173"></a> |
| <span class="sourceLineNo">174</span> builder.setPattern(pattern);<a name="line.174"></a> |
| <span class="sourceLineNo">175</span> builder.setPatternSelector(patternSelector);<a name="line.175"></a> |
| <span class="sourceLineNo">176</span> builder.setReplace(replace);<a name="line.176"></a> |
| <span class="sourceLineNo">177</span> return builder.build();<a name="line.177"></a> |
| <span class="sourceLineNo">178</span> }<a name="line.178"></a> |
| <span class="sourceLineNo">179</span><a name="line.179"></a> |
| <span class="sourceLineNo">180</span> /**<a name="line.180"></a> |
| <span class="sourceLineNo">181</span> * Gets the conversion pattern.<a name="line.181"></a> |
| <span class="sourceLineNo">182</span> *<a name="line.182"></a> |
| <span class="sourceLineNo">183</span> * @return the conversion pattern.<a name="line.183"></a> |
| <span class="sourceLineNo">184</span> */<a name="line.184"></a> |
| <span class="sourceLineNo">185</span> public String getConversionPattern() {<a name="line.185"></a> |
| <span class="sourceLineNo">186</span> return conversionPattern;<a name="line.186"></a> |
| <span class="sourceLineNo">187</span> }<a name="line.187"></a> |
| <span class="sourceLineNo">188</span><a name="line.188"></a> |
| <span class="sourceLineNo">189</span> /**<a name="line.189"></a> |
| <span class="sourceLineNo">190</span> * Gets this PatternLayout's content format. Specified by:<a name="line.190"></a> |
| <span class="sourceLineNo">191</span> * <ul><a name="line.191"></a> |
| <span class="sourceLineNo">192</span> * <li>Key: "structured" Value: "false"</li><a name="line.192"></a> |
| <span class="sourceLineNo">193</span> * <li>Key: "formatType" Value: "conversion" (format uses the keywords supported by OptionConverter)</li><a name="line.193"></a> |
| <span class="sourceLineNo">194</span> * <li>Key: "format" Value: provided "conversionPattern" param</li><a name="line.194"></a> |
| <span class="sourceLineNo">195</span> * </ul><a name="line.195"></a> |
| <span class="sourceLineNo">196</span> *<a name="line.196"></a> |
| <span class="sourceLineNo">197</span> * @return Map of content format keys supporting PatternLayout<a name="line.197"></a> |
| <span class="sourceLineNo">198</span> */<a name="line.198"></a> |
| <span class="sourceLineNo">199</span> @Override<a name="line.199"></a> |
| <span class="sourceLineNo">200</span> public Map<String, String> getContentFormat() {<a name="line.200"></a> |
| <span class="sourceLineNo">201</span> final Map<String, String> result = new HashMap<>();<a name="line.201"></a> |
| <span class="sourceLineNo">202</span> result.put("structured", "false");<a name="line.202"></a> |
| <span class="sourceLineNo">203</span> result.put("formatType", "conversion");<a name="line.203"></a> |
| <span class="sourceLineNo">204</span> result.put("format", conversionPattern);<a name="line.204"></a> |
| <span class="sourceLineNo">205</span> return result;<a name="line.205"></a> |
| <span class="sourceLineNo">206</span> }<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> |
| <span class="sourceLineNo">209</span> * Formats a logging event to a writer.<a name="line.209"></a> |
| <span class="sourceLineNo">210</span> *<a name="line.210"></a> |
| <span class="sourceLineNo">211</span> * @param event logging event to be formatted.<a name="line.211"></a> |
| <span class="sourceLineNo">212</span> * @return The event formatted as a String.<a name="line.212"></a> |
| <span class="sourceLineNo">213</span> */<a name="line.213"></a> |
| <span class="sourceLineNo">214</span> @Override<a name="line.214"></a> |
| <span class="sourceLineNo">215</span> public String toSerializable(final LogEvent event) {<a name="line.215"></a> |
| <span class="sourceLineNo">216</span> return eventSerializer.toSerializable(event);<a name="line.216"></a> |
| <span class="sourceLineNo">217</span> }<a name="line.217"></a> |
| <span class="sourceLineNo">218</span><a name="line.218"></a> |
| <span class="sourceLineNo">219</span> public void serialize(final LogEvent event, StringBuilder stringBuilder) {<a name="line.219"></a> |
| <span class="sourceLineNo">220</span> eventSerializer.toSerializable(event, stringBuilder);<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> @Override<a name="line.223"></a> |
| <span class="sourceLineNo">224</span> public void encode(final LogEvent event, final ByteBufferDestination destination) {<a name="line.224"></a> |
| <span class="sourceLineNo">225</span> if (!(eventSerializer instanceof Serializer2)) {<a name="line.225"></a> |
| <span class="sourceLineNo">226</span> super.encode(event, destination);<a name="line.226"></a> |
| <span class="sourceLineNo">227</span> return;<a name="line.227"></a> |
| <span class="sourceLineNo">228</span> }<a name="line.228"></a> |
| <span class="sourceLineNo">229</span> final StringBuilder text = toText((Serializer2) eventSerializer, event, getStringBuilder());<a name="line.229"></a> |
| <span class="sourceLineNo">230</span> final Encoder<StringBuilder> encoder = getStringBuilderEncoder();<a name="line.230"></a> |
| <span class="sourceLineNo">231</span> encoder.encode(text, destination);<a name="line.231"></a> |
| <span class="sourceLineNo">232</span> trimToMaxSize(text);<a name="line.232"></a> |
| <span class="sourceLineNo">233</span> }<a name="line.233"></a> |
| <span class="sourceLineNo">234</span><a name="line.234"></a> |
| <span class="sourceLineNo">235</span> /**<a name="line.235"></a> |
| <span class="sourceLineNo">236</span> * Creates a text representation of the specified log event<a name="line.236"></a> |
| <span class="sourceLineNo">237</span> * and writes it into the specified StringBuilder.<a name="line.237"></a> |
| <span class="sourceLineNo">238</span> * <p><a name="line.238"></a> |
| <span class="sourceLineNo">239</span> * Implementations are free to return a new StringBuilder if they can<a name="line.239"></a> |
| <span class="sourceLineNo">240</span> * detect in advance that the specified StringBuilder is too small.<a name="line.240"></a> |
| <span class="sourceLineNo">241</span> */<a name="line.241"></a> |
| <span class="sourceLineNo">242</span> private StringBuilder toText(final Serializer2 serializer, final LogEvent event,<a name="line.242"></a> |
| <span class="sourceLineNo">243</span> final StringBuilder destination) {<a name="line.243"></a> |
| <span class="sourceLineNo">244</span> return serializer.toSerializable(event, destination);<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> /**<a name="line.247"></a> |
| <span class="sourceLineNo">248</span> * Creates a PatternParser.<a name="line.248"></a> |
| <span class="sourceLineNo">249</span> * @param config The Configuration.<a name="line.249"></a> |
| <span class="sourceLineNo">250</span> * @return The PatternParser.<a name="line.250"></a> |
| <span class="sourceLineNo">251</span> */<a name="line.251"></a> |
| <span class="sourceLineNo">252</span> public static PatternParser createPatternParser(final Configuration config) {<a name="line.252"></a> |
| <span class="sourceLineNo">253</span> if (config == null) {<a name="line.253"></a> |
| <span class="sourceLineNo">254</span> return new PatternParser(config, KEY, LogEventPatternConverter.class);<a name="line.254"></a> |
| <span class="sourceLineNo">255</span> }<a name="line.255"></a> |
| <span class="sourceLineNo">256</span> PatternParser parser = config.getComponent(KEY);<a name="line.256"></a> |
| <span class="sourceLineNo">257</span> if (parser == null) {<a name="line.257"></a> |
| <span class="sourceLineNo">258</span> parser = new PatternParser(config, KEY, LogEventPatternConverter.class);<a name="line.258"></a> |
| <span class="sourceLineNo">259</span> config.addComponent(KEY, parser);<a name="line.259"></a> |
| <span class="sourceLineNo">260</span> parser = config.getComponent(KEY);<a name="line.260"></a> |
| <span class="sourceLineNo">261</span> }<a name="line.261"></a> |
| <span class="sourceLineNo">262</span> return parser;<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> @Override<a name="line.265"></a> |
| <span class="sourceLineNo">266</span> public String toString() {<a name="line.266"></a> |
| <span class="sourceLineNo">267</span> return patternSelector == null ? conversionPattern : patternSelector.toString();<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> /**<a name="line.270"></a> |
| <span class="sourceLineNo">271</span> * Creates a pattern layout.<a name="line.271"></a> |
| <span class="sourceLineNo">272</span> *<a name="line.272"></a> |
| <span class="sourceLineNo">273</span> * @param pattern<a name="line.273"></a> |
| <span class="sourceLineNo">274</span> * The pattern. If not specified, defaults to DEFAULT_CONVERSION_PATTERN.<a name="line.274"></a> |
| <span class="sourceLineNo">275</span> * @param patternSelector<a name="line.275"></a> |
| <span class="sourceLineNo">276</span> * Allows different patterns to be used based on some selection criteria.<a name="line.276"></a> |
| <span class="sourceLineNo">277</span> * @param config<a name="line.277"></a> |
| <span class="sourceLineNo">278</span> * The Configuration. Some Converters require access to the Interpolator.<a name="line.278"></a> |
| <span class="sourceLineNo">279</span> * @param replace<a name="line.279"></a> |
| <span class="sourceLineNo">280</span> * A Regex replacement String.<a name="line.280"></a> |
| <span class="sourceLineNo">281</span> * @param charset<a name="line.281"></a> |
| <span class="sourceLineNo">282</span> * The character set. The platform default is used if not specified.<a name="line.282"></a> |
| <span class="sourceLineNo">283</span> * @param alwaysWriteExceptions<a name="line.283"></a> |
| <span class="sourceLineNo">284</span> * If {@code "true"} (default) exceptions are always written even if the pattern contains no exception tokens.<a name="line.284"></a> |
| <span class="sourceLineNo">285</span> * @param noConsoleNoAnsi<a name="line.285"></a> |
| <span class="sourceLineNo">286</span> * If {@code "true"} (default is false) and {@link System#console()} is null, do not output ANSI escape codes<a name="line.286"></a> |
| <span class="sourceLineNo">287</span> * @param headerPattern<a name="line.287"></a> |
| <span class="sourceLineNo">288</span> * The footer to place at the top of the document, once.<a name="line.288"></a> |
| <span class="sourceLineNo">289</span> * @param footerPattern<a name="line.289"></a> |
| <span class="sourceLineNo">290</span> * The footer to place at the bottom of the document, once.<a name="line.290"></a> |
| <span class="sourceLineNo">291</span> * @return The PatternLayout.<a name="line.291"></a> |
| <span class="sourceLineNo">292</span> * @deprecated Use {@link #newBuilder()} instead. This will be private in a future version.<a name="line.292"></a> |
| <span class="sourceLineNo">293</span> */<a name="line.293"></a> |
| <span class="sourceLineNo">294</span> @PluginFactory<a name="line.294"></a> |
| <span class="sourceLineNo">295</span> @Deprecated<a name="line.295"></a> |
| <span class="sourceLineNo">296</span> public static PatternLayout createLayout(<a name="line.296"></a> |
| <span class="sourceLineNo">297</span> @PluginAttribute(value = "pattern", defaultString = DEFAULT_CONVERSION_PATTERN) final String pattern,<a name="line.297"></a> |
| <span class="sourceLineNo">298</span> @PluginElement("PatternSelector") final PatternSelector patternSelector,<a name="line.298"></a> |
| <span class="sourceLineNo">299</span> @PluginConfiguration final Configuration config,<a name="line.299"></a> |
| <span class="sourceLineNo">300</span> @PluginElement("Replace") final RegexReplacement replace,<a name="line.300"></a> |
| <span class="sourceLineNo">301</span> // LOG4J2-783 use platform default by default, so do not specify defaultString for charset<a name="line.301"></a> |
| <span class="sourceLineNo">302</span> @PluginAttribute(value = "charset") final Charset charset,<a name="line.302"></a> |
| <span class="sourceLineNo">303</span> @PluginAttribute(value = "alwaysWriteExceptions", defaultBoolean = true) final boolean alwaysWriteExceptions,<a name="line.303"></a> |
| <span class="sourceLineNo">304</span> @PluginAttribute(value = "noConsoleNoAnsi") final boolean noConsoleNoAnsi,<a name="line.304"></a> |
| <span class="sourceLineNo">305</span> @PluginAttribute("header") final String headerPattern,<a name="line.305"></a> |
| <span class="sourceLineNo">306</span> @PluginAttribute("footer") final String footerPattern) {<a name="line.306"></a> |
| <span class="sourceLineNo">307</span> return newBuilder()<a name="line.307"></a> |
| <span class="sourceLineNo">308</span> .withPattern(pattern)<a name="line.308"></a> |
| <span class="sourceLineNo">309</span> .withPatternSelector(patternSelector)<a name="line.309"></a> |
| <span class="sourceLineNo">310</span> .withConfiguration(config)<a name="line.310"></a> |
| <span class="sourceLineNo">311</span> .withRegexReplacement(replace)<a name="line.311"></a> |
| <span class="sourceLineNo">312</span> .withCharset(charset)<a name="line.312"></a> |
| <span class="sourceLineNo">313</span> .withAlwaysWriteExceptions(alwaysWriteExceptions)<a name="line.313"></a> |
| <span class="sourceLineNo">314</span> .withNoConsoleNoAnsi(noConsoleNoAnsi)<a name="line.314"></a> |
| <span class="sourceLineNo">315</span> .withHeader(headerPattern)<a name="line.315"></a> |
| <span class="sourceLineNo">316</span> .withFooter(footerPattern)<a name="line.316"></a> |
| <span class="sourceLineNo">317</span> .build();<a name="line.317"></a> |
| <span class="sourceLineNo">318</span> }<a name="line.318"></a> |
| <span class="sourceLineNo">319</span><a name="line.319"></a> |
| <span class="sourceLineNo">320</span> private static class PatternSerializer implements Serializer, Serializer2, LocationAware {<a name="line.320"></a> |
| <span class="sourceLineNo">321</span><a name="line.321"></a> |
| <span class="sourceLineNo">322</span> private final PatternFormatter[] formatters;<a name="line.322"></a> |
| <span class="sourceLineNo">323</span> private final RegexReplacement replace;<a name="line.323"></a> |
| <span class="sourceLineNo">324</span><a name="line.324"></a> |
| <span class="sourceLineNo">325</span> private PatternSerializer(final PatternFormatter[] formatters, final RegexReplacement replace) {<a name="line.325"></a> |
| <span class="sourceLineNo">326</span> super();<a name="line.326"></a> |
| <span class="sourceLineNo">327</span> this.formatters = formatters;<a name="line.327"></a> |
| <span class="sourceLineNo">328</span> this.replace = replace;<a name="line.328"></a> |
| <span class="sourceLineNo">329</span> }<a name="line.329"></a> |
| <span class="sourceLineNo">330</span><a name="line.330"></a> |
| <span class="sourceLineNo">331</span> @Override<a name="line.331"></a> |
| <span class="sourceLineNo">332</span> public String toSerializable(final LogEvent event) {<a name="line.332"></a> |
| <span class="sourceLineNo">333</span> final StringBuilder sb = getStringBuilder();<a name="line.333"></a> |
| <span class="sourceLineNo">334</span> try {<a name="line.334"></a> |
| <span class="sourceLineNo">335</span> return toSerializable(event, sb).toString();<a name="line.335"></a> |
| <span class="sourceLineNo">336</span> } finally {<a name="line.336"></a> |
| <span class="sourceLineNo">337</span> trimToMaxSize(sb);<a name="line.337"></a> |
| <span class="sourceLineNo">338</span> }<a name="line.338"></a> |
| <span class="sourceLineNo">339</span> }<a name="line.339"></a> |
| <span class="sourceLineNo">340</span><a name="line.340"></a> |
| <span class="sourceLineNo">341</span> @Override<a name="line.341"></a> |
| <span class="sourceLineNo">342</span> public StringBuilder toSerializable(final LogEvent event, final StringBuilder buffer) {<a name="line.342"></a> |
| <span class="sourceLineNo">343</span> final int len = formatters.length;<a name="line.343"></a> |
| <span class="sourceLineNo">344</span> for (int i = 0; i < len; i++) {<a name="line.344"></a> |
| <span class="sourceLineNo">345</span> formatters[i].format(event, buffer);<a name="line.345"></a> |
| <span class="sourceLineNo">346</span> }<a name="line.346"></a> |
| <span class="sourceLineNo">347</span> if (replace != null) { // creates temporary objects<a name="line.347"></a> |
| <span class="sourceLineNo">348</span> String str = buffer.toString();<a name="line.348"></a> |
| <span class="sourceLineNo">349</span> str = replace.format(str);<a name="line.349"></a> |
| <span class="sourceLineNo">350</span> buffer.setLength(0);<a name="line.350"></a> |
| <span class="sourceLineNo">351</span> buffer.append(str);<a name="line.351"></a> |
| <span class="sourceLineNo">352</span> }<a name="line.352"></a> |
| <span class="sourceLineNo">353</span> return buffer;<a name="line.353"></a> |
| <span class="sourceLineNo">354</span> }<a name="line.354"></a> |
| <span class="sourceLineNo">355</span><a name="line.355"></a> |
| <span class="sourceLineNo">356</span> @Override<a name="line.356"></a> |
| <span class="sourceLineNo">357</span> public boolean requiresLocation() {<a name="line.357"></a> |
| <span class="sourceLineNo">358</span> for (PatternFormatter formatter : formatters) {<a name="line.358"></a> |
| <span class="sourceLineNo">359</span> if (formatter.requiresLocation()) {<a name="line.359"></a> |
| <span class="sourceLineNo">360</span> return true;<a name="line.360"></a> |
| <span class="sourceLineNo">361</span> }<a name="line.361"></a> |
| <span class="sourceLineNo">362</span> }<a name="line.362"></a> |
| <span class="sourceLineNo">363</span> return false;<a name="line.363"></a> |
| <span class="sourceLineNo">364</span> }<a name="line.364"></a> |
| <span class="sourceLineNo">365</span><a name="line.365"></a> |
| <span class="sourceLineNo">366</span> @Override<a name="line.366"></a> |
| <span class="sourceLineNo">367</span> public String toString() {<a name="line.367"></a> |
| <span class="sourceLineNo">368</span> final StringBuilder builder = new StringBuilder();<a name="line.368"></a> |
| <span class="sourceLineNo">369</span> builder.append(super.toString());<a name="line.369"></a> |
| <span class="sourceLineNo">370</span> builder.append("[formatters=");<a name="line.370"></a> |
| <span class="sourceLineNo">371</span> builder.append(Arrays.toString(formatters));<a name="line.371"></a> |
| <span class="sourceLineNo">372</span> builder.append(", replace=");<a name="line.372"></a> |
| <span class="sourceLineNo">373</span> builder.append(replace);<a name="line.373"></a> |
| <span class="sourceLineNo">374</span> builder.append("]");<a name="line.374"></a> |
| <span class="sourceLineNo">375</span> return builder.toString();<a name="line.375"></a> |
| <span class="sourceLineNo">376</span> }<a name="line.376"></a> |
| <span class="sourceLineNo">377</span> }<a name="line.377"></a> |
| <span class="sourceLineNo">378</span><a name="line.378"></a> |
| <span class="sourceLineNo">379</span> public static class SerializerBuilder implements org.apache.logging.log4j.core.util.Builder<Serializer> {<a name="line.379"></a> |
| <span class="sourceLineNo">380</span><a name="line.380"></a> |
| <span class="sourceLineNo">381</span> private Configuration configuration;<a name="line.381"></a> |
| <span class="sourceLineNo">382</span> private RegexReplacement replace;<a name="line.382"></a> |
| <span class="sourceLineNo">383</span> private String pattern;<a name="line.383"></a> |
| <span class="sourceLineNo">384</span> private String defaultPattern;<a name="line.384"></a> |
| <span class="sourceLineNo">385</span> private PatternSelector patternSelector;<a name="line.385"></a> |
| <span class="sourceLineNo">386</span> private boolean alwaysWriteExceptions;<a name="line.386"></a> |
| <span class="sourceLineNo">387</span> private boolean disableAnsi;<a name="line.387"></a> |
| <span class="sourceLineNo">388</span> private boolean noConsoleNoAnsi;<a name="line.388"></a> |
| <span class="sourceLineNo">389</span><a name="line.389"></a> |
| <span class="sourceLineNo">390</span> @Override<a name="line.390"></a> |
| <span class="sourceLineNo">391</span> public Serializer build() {<a name="line.391"></a> |
| <span class="sourceLineNo">392</span> if (Strings.isEmpty(pattern) && Strings.isEmpty(defaultPattern)) {<a name="line.392"></a> |
| <span class="sourceLineNo">393</span> return null;<a name="line.393"></a> |
| <span class="sourceLineNo">394</span> }<a name="line.394"></a> |
| <span class="sourceLineNo">395</span> if (patternSelector == null) {<a name="line.395"></a> |
| <span class="sourceLineNo">396</span> try {<a name="line.396"></a> |
| <span class="sourceLineNo">397</span> final PatternParser parser = createPatternParser(configuration);<a name="line.397"></a> |
| <span class="sourceLineNo">398</span> final List<PatternFormatter> list = parser.parse(pattern == null ? defaultPattern : pattern,<a name="line.398"></a> |
| <span class="sourceLineNo">399</span> alwaysWriteExceptions, disableAnsi, noConsoleNoAnsi);<a name="line.399"></a> |
| <span class="sourceLineNo">400</span> final PatternFormatter[] formatters = list.toArray(new PatternFormatter[0]);<a name="line.400"></a> |
| <span class="sourceLineNo">401</span> return new PatternSerializer(formatters, replace);<a name="line.401"></a> |
| <span class="sourceLineNo">402</span> } catch (final RuntimeException ex) {<a name="line.402"></a> |
| <span class="sourceLineNo">403</span> throw new IllegalArgumentException("Cannot parse pattern '" + pattern + "'", ex);<a name="line.403"></a> |
| <span class="sourceLineNo">404</span> }<a name="line.404"></a> |
| <span class="sourceLineNo">405</span> }<a name="line.405"></a> |
| <span class="sourceLineNo">406</span> return new PatternSelectorSerializer(patternSelector, replace);<a name="line.406"></a> |
| <span class="sourceLineNo">407</span> }<a name="line.407"></a> |
| <span class="sourceLineNo">408</span><a name="line.408"></a> |
| <span class="sourceLineNo">409</span> public SerializerBuilder setConfiguration(final Configuration configuration) {<a name="line.409"></a> |
| <span class="sourceLineNo">410</span> this.configuration = configuration;<a name="line.410"></a> |
| <span class="sourceLineNo">411</span> return this;<a name="line.411"></a> |
| <span class="sourceLineNo">412</span> }<a name="line.412"></a> |
| <span class="sourceLineNo">413</span><a name="line.413"></a> |
| <span class="sourceLineNo">414</span> public SerializerBuilder setReplace(final RegexReplacement replace) {<a name="line.414"></a> |
| <span class="sourceLineNo">415</span> this.replace = replace;<a name="line.415"></a> |
| <span class="sourceLineNo">416</span> return this;<a name="line.416"></a> |
| <span class="sourceLineNo">417</span> }<a name="line.417"></a> |
| <span class="sourceLineNo">418</span><a name="line.418"></a> |
| <span class="sourceLineNo">419</span> public SerializerBuilder setPattern(final String pattern) {<a name="line.419"></a> |
| <span class="sourceLineNo">420</span> this.pattern = pattern;<a name="line.420"></a> |
| <span class="sourceLineNo">421</span> return this;<a name="line.421"></a> |
| <span class="sourceLineNo">422</span> }<a name="line.422"></a> |
| <span class="sourceLineNo">423</span><a name="line.423"></a> |
| <span class="sourceLineNo">424</span> public SerializerBuilder setDefaultPattern(final String defaultPattern) {<a name="line.424"></a> |
| <span class="sourceLineNo">425</span> this.defaultPattern = defaultPattern;<a name="line.425"></a> |
| <span class="sourceLineNo">426</span> return this;<a name="line.426"></a> |
| <span class="sourceLineNo">427</span> }<a name="line.427"></a> |
| <span class="sourceLineNo">428</span><a name="line.428"></a> |
| <span class="sourceLineNo">429</span> public SerializerBuilder setPatternSelector(final PatternSelector patternSelector) {<a name="line.429"></a> |
| <span class="sourceLineNo">430</span> this.patternSelector = patternSelector;<a name="line.430"></a> |
| <span class="sourceLineNo">431</span> return this;<a name="line.431"></a> |
| <span class="sourceLineNo">432</span> }<a name="line.432"></a> |
| <span class="sourceLineNo">433</span><a name="line.433"></a> |
| <span class="sourceLineNo">434</span> public SerializerBuilder setAlwaysWriteExceptions(final boolean alwaysWriteExceptions) {<a name="line.434"></a> |
| <span class="sourceLineNo">435</span> this.alwaysWriteExceptions = alwaysWriteExceptions;<a name="line.435"></a> |
| <span class="sourceLineNo">436</span> return this;<a name="line.436"></a> |
| <span class="sourceLineNo">437</span> }<a name="line.437"></a> |
| <span class="sourceLineNo">438</span><a name="line.438"></a> |
| <span class="sourceLineNo">439</span> public SerializerBuilder setDisableAnsi(final boolean disableAnsi) {<a name="line.439"></a> |
| <span class="sourceLineNo">440</span> this.disableAnsi = disableAnsi;<a name="line.440"></a> |
| <span class="sourceLineNo">441</span> return this;<a name="line.441"></a> |
| <span class="sourceLineNo">442</span> }<a name="line.442"></a> |
| <span class="sourceLineNo">443</span><a name="line.443"></a> |
| <span class="sourceLineNo">444</span> public SerializerBuilder setNoConsoleNoAnsi(final boolean noConsoleNoAnsi) {<a name="line.444"></a> |
| <span class="sourceLineNo">445</span> this.noConsoleNoAnsi = noConsoleNoAnsi;<a name="line.445"></a> |
| <span class="sourceLineNo">446</span> return this;<a name="line.446"></a> |
| <span class="sourceLineNo">447</span> }<a name="line.447"></a> |
| <span class="sourceLineNo">448</span><a name="line.448"></a> |
| <span class="sourceLineNo">449</span> }<a name="line.449"></a> |
| <span class="sourceLineNo">450</span><a name="line.450"></a> |
| <span class="sourceLineNo">451</span> private static class PatternSelectorSerializer implements Serializer, Serializer2, LocationAware {<a name="line.451"></a> |
| <span class="sourceLineNo">452</span><a name="line.452"></a> |
| <span class="sourceLineNo">453</span> private final PatternSelector patternSelector;<a name="line.453"></a> |
| <span class="sourceLineNo">454</span> private final RegexReplacement replace;<a name="line.454"></a> |
| <span class="sourceLineNo">455</span><a name="line.455"></a> |
| <span class="sourceLineNo">456</span> private PatternSelectorSerializer(final PatternSelector patternSelector, final RegexReplacement replace) {<a name="line.456"></a> |
| <span class="sourceLineNo">457</span> super();<a name="line.457"></a> |
| <span class="sourceLineNo">458</span> this.patternSelector = patternSelector;<a name="line.458"></a> |
| <span class="sourceLineNo">459</span> this.replace = replace;<a name="line.459"></a> |
| <span class="sourceLineNo">460</span> }<a name="line.460"></a> |
| <span class="sourceLineNo">461</span><a name="line.461"></a> |
| <span class="sourceLineNo">462</span> @Override<a name="line.462"></a> |
| <span class="sourceLineNo">463</span> public String toSerializable(final LogEvent event) {<a name="line.463"></a> |
| <span class="sourceLineNo">464</span> final StringBuilder sb = getStringBuilder();<a name="line.464"></a> |
| <span class="sourceLineNo">465</span> try {<a name="line.465"></a> |
| <span class="sourceLineNo">466</span> return toSerializable(event, sb).toString();<a name="line.466"></a> |
| <span class="sourceLineNo">467</span> } finally {<a name="line.467"></a> |
| <span class="sourceLineNo">468</span> trimToMaxSize(sb);<a name="line.468"></a> |
| <span class="sourceLineNo">469</span> }<a name="line.469"></a> |
| <span class="sourceLineNo">470</span> }<a name="line.470"></a> |
| <span class="sourceLineNo">471</span><a name="line.471"></a> |
| <span class="sourceLineNo">472</span> @Override<a name="line.472"></a> |
| <span class="sourceLineNo">473</span> public StringBuilder toSerializable(final LogEvent event, final StringBuilder buffer) {<a name="line.473"></a> |
| <span class="sourceLineNo">474</span> final PatternFormatter[] formatters = patternSelector.getFormatters(event);<a name="line.474"></a> |
| <span class="sourceLineNo">475</span> final int len = formatters.length;<a name="line.475"></a> |
| <span class="sourceLineNo">476</span> for (int i = 0; i < len; i++) {<a name="line.476"></a> |
| <span class="sourceLineNo">477</span> formatters[i].format(event, buffer);<a name="line.477"></a> |
| <span class="sourceLineNo">478</span> }<a name="line.478"></a> |
| <span class="sourceLineNo">479</span> if (replace != null) { // creates temporary objects<a name="line.479"></a> |
| <span class="sourceLineNo">480</span> String str = buffer.toString();<a name="line.480"></a> |
| <span class="sourceLineNo">481</span> str = replace.format(str);<a name="line.481"></a> |
| <span class="sourceLineNo">482</span> buffer.setLength(0);<a name="line.482"></a> |
| <span class="sourceLineNo">483</span> buffer.append(str);<a name="line.483"></a> |
| <span class="sourceLineNo">484</span> }<a name="line.484"></a> |
| <span class="sourceLineNo">485</span> return buffer;<a name="line.485"></a> |
| <span class="sourceLineNo">486</span> }<a name="line.486"></a> |
| <span class="sourceLineNo">487</span><a name="line.487"></a> |
| <span class="sourceLineNo">488</span> @Override<a name="line.488"></a> |
| <span class="sourceLineNo">489</span> public boolean requiresLocation() {<a name="line.489"></a> |
| <span class="sourceLineNo">490</span> return patternSelector instanceof LocationAware && ((LocationAware) patternSelector).requiresLocation();<a name="line.490"></a> |
| <span class="sourceLineNo">491</span> }<a name="line.491"></a> |
| <span class="sourceLineNo">492</span><a name="line.492"></a> |
| <span class="sourceLineNo">493</span> @Override<a name="line.493"></a> |
| <span class="sourceLineNo">494</span> public String toString() {<a name="line.494"></a> |
| <span class="sourceLineNo">495</span> final StringBuilder builder = new StringBuilder();<a name="line.495"></a> |
| <span class="sourceLineNo">496</span> builder.append(super.toString());<a name="line.496"></a> |
| <span class="sourceLineNo">497</span> builder.append("[patternSelector=");<a name="line.497"></a> |
| <span class="sourceLineNo">498</span> builder.append(patternSelector);<a name="line.498"></a> |
| <span class="sourceLineNo">499</span> builder.append(", replace=");<a name="line.499"></a> |
| <span class="sourceLineNo">500</span> builder.append(replace);<a name="line.500"></a> |
| <span class="sourceLineNo">501</span> builder.append("]");<a name="line.501"></a> |
| <span class="sourceLineNo">502</span> return builder.toString();<a name="line.502"></a> |
| <span class="sourceLineNo">503</span> }<a name="line.503"></a> |
| <span class="sourceLineNo">504</span> }<a name="line.504"></a> |
| <span class="sourceLineNo">505</span><a name="line.505"></a> |
| <span class="sourceLineNo">506</span> /**<a name="line.506"></a> |
| <span class="sourceLineNo">507</span> * Creates a PatternLayout using the default options. These options include using UTF-8, the default conversion<a name="line.507"></a> |
| <span class="sourceLineNo">508</span> * pattern, exceptions being written, and with ANSI escape codes.<a name="line.508"></a> |
| <span class="sourceLineNo">509</span> *<a name="line.509"></a> |
| <span class="sourceLineNo">510</span> * @return the PatternLayout.<a name="line.510"></a> |
| <span class="sourceLineNo">511</span> * @see #DEFAULT_CONVERSION_PATTERN Default conversion pattern<a name="line.511"></a> |
| <span class="sourceLineNo">512</span> */<a name="line.512"></a> |
| <span class="sourceLineNo">513</span> public static PatternLayout createDefaultLayout() {<a name="line.513"></a> |
| <span class="sourceLineNo">514</span> return newBuilder().build();<a name="line.514"></a> |
| <span class="sourceLineNo">515</span> }<a name="line.515"></a> |
| <span class="sourceLineNo">516</span><a name="line.516"></a> |
| <span class="sourceLineNo">517</span> /**<a name="line.517"></a> |
| <span class="sourceLineNo">518</span> * Creates a PatternLayout using the default options and the given configuration. These options include using UTF-8,<a name="line.518"></a> |
| <span class="sourceLineNo">519</span> * the default conversion pattern, exceptions being written, and with ANSI escape codes.<a name="line.519"></a> |
| <span class="sourceLineNo">520</span> *<a name="line.520"></a> |
| <span class="sourceLineNo">521</span> * @param configuration The Configuration.<a name="line.521"></a> |
| <span class="sourceLineNo">522</span> *<a name="line.522"></a> |
| <span class="sourceLineNo">523</span> * @return the PatternLayout.<a name="line.523"></a> |
| <span class="sourceLineNo">524</span> * @see #DEFAULT_CONVERSION_PATTERN Default conversion pattern<a name="line.524"></a> |
| <span class="sourceLineNo">525</span> */<a name="line.525"></a> |
| <span class="sourceLineNo">526</span> public static PatternLayout createDefaultLayout(final Configuration configuration) {<a name="line.526"></a> |
| <span class="sourceLineNo">527</span> return newBuilder().withConfiguration(configuration).build();<a name="line.527"></a> |
| <span class="sourceLineNo">528</span> }<a name="line.528"></a> |
| <span class="sourceLineNo">529</span><a name="line.529"></a> |
| <span class="sourceLineNo">530</span> /**<a name="line.530"></a> |
| <span class="sourceLineNo">531</span> * Creates a builder for a custom PatternLayout.<a name="line.531"></a> |
| <span class="sourceLineNo">532</span> *<a name="line.532"></a> |
| <span class="sourceLineNo">533</span> * @return a PatternLayout builder.<a name="line.533"></a> |
| <span class="sourceLineNo">534</span> */<a name="line.534"></a> |
| <span class="sourceLineNo">535</span> @PluginBuilderFactory<a name="line.535"></a> |
| <span class="sourceLineNo">536</span> public static Builder newBuilder() {<a name="line.536"></a> |
| <span class="sourceLineNo">537</span> return new Builder();<a name="line.537"></a> |
| <span class="sourceLineNo">538</span> }<a name="line.538"></a> |
| <span class="sourceLineNo">539</span><a name="line.539"></a> |
| <span class="sourceLineNo">540</span> /**<a name="line.540"></a> |
| <span class="sourceLineNo">541</span> * Custom PatternLayout builder. Use the {@link PatternLayout#newBuilder() builder factory method} to create this.<a name="line.541"></a> |
| <span class="sourceLineNo">542</span> */<a name="line.542"></a> |
| <span class="sourceLineNo">543</span> public static class Builder implements org.apache.logging.log4j.core.util.Builder<PatternLayout> {<a name="line.543"></a> |
| <span class="sourceLineNo">544</span><a name="line.544"></a> |
| <span class="sourceLineNo">545</span> @PluginBuilderAttribute<a name="line.545"></a> |
| <span class="sourceLineNo">546</span> private String pattern = PatternLayout.DEFAULT_CONVERSION_PATTERN;<a name="line.546"></a> |
| <span class="sourceLineNo">547</span><a name="line.547"></a> |
| <span class="sourceLineNo">548</span> @PluginElement("PatternSelector")<a name="line.548"></a> |
| <span class="sourceLineNo">549</span> private PatternSelector patternSelector;<a name="line.549"></a> |
| <span class="sourceLineNo">550</span><a name="line.550"></a> |
| <span class="sourceLineNo">551</span> @PluginConfiguration<a name="line.551"></a> |
| <span class="sourceLineNo">552</span> private Configuration configuration;<a name="line.552"></a> |
| <span class="sourceLineNo">553</span><a name="line.553"></a> |
| <span class="sourceLineNo">554</span> @PluginElement("Replace")<a name="line.554"></a> |
| <span class="sourceLineNo">555</span> private RegexReplacement regexReplacement;<a name="line.555"></a> |
| <span class="sourceLineNo">556</span><a name="line.556"></a> |
| <span class="sourceLineNo">557</span> // LOG4J2-783 use platform default by default<a name="line.557"></a> |
| <span class="sourceLineNo">558</span> @PluginBuilderAttribute<a name="line.558"></a> |
| <span class="sourceLineNo">559</span> private Charset charset = Charset.defaultCharset();<a name="line.559"></a> |
| <span class="sourceLineNo">560</span><a name="line.560"></a> |
| <span class="sourceLineNo">561</span> @PluginBuilderAttribute<a name="line.561"></a> |
| <span class="sourceLineNo">562</span> private boolean alwaysWriteExceptions = true;<a name="line.562"></a> |
| <span class="sourceLineNo">563</span><a name="line.563"></a> |
| <span class="sourceLineNo">564</span> @PluginBuilderAttribute<a name="line.564"></a> |
| <span class="sourceLineNo">565</span> private boolean disableAnsi = !useAnsiEscapeCodes();<a name="line.565"></a> |
| <span class="sourceLineNo">566</span><a name="line.566"></a> |
| <span class="sourceLineNo">567</span> @PluginBuilderAttribute<a name="line.567"></a> |
| <span class="sourceLineNo">568</span> private boolean noConsoleNoAnsi;<a name="line.568"></a> |
| <span class="sourceLineNo">569</span><a name="line.569"></a> |
| <span class="sourceLineNo">570</span> @PluginBuilderAttribute<a name="line.570"></a> |
| <span class="sourceLineNo">571</span> private String header;<a name="line.571"></a> |
| <span class="sourceLineNo">572</span><a name="line.572"></a> |
| <span class="sourceLineNo">573</span> @PluginBuilderAttribute<a name="line.573"></a> |
| <span class="sourceLineNo">574</span> private String footer;<a name="line.574"></a> |
| <span class="sourceLineNo">575</span><a name="line.575"></a> |
| <span class="sourceLineNo">576</span> private Builder() {<a name="line.576"></a> |
| <span class="sourceLineNo">577</span> }<a name="line.577"></a> |
| <span class="sourceLineNo">578</span><a name="line.578"></a> |
| <span class="sourceLineNo">579</span> private boolean useAnsiEscapeCodes() {<a name="line.579"></a> |
| <span class="sourceLineNo">580</span> final PropertiesUtil propertiesUtil = PropertiesUtil.getProperties();<a name="line.580"></a> |
| <span class="sourceLineNo">581</span> final boolean isPlatformSupportsAnsi = !propertiesUtil.isOsWindows();<a name="line.581"></a> |
| <span class="sourceLineNo">582</span> final boolean isJansiRequested = !propertiesUtil.getBooleanProperty("log4j.skipJansi", true);<a name="line.582"></a> |
| <span class="sourceLineNo">583</span> return isPlatformSupportsAnsi || isJansiRequested;<a name="line.583"></a> |
| <span class="sourceLineNo">584</span> }<a name="line.584"></a> |
| <span class="sourceLineNo">585</span><a name="line.585"></a> |
| <span class="sourceLineNo">586</span> /**<a name="line.586"></a> |
| <span class="sourceLineNo">587</span> * @param pattern<a name="line.587"></a> |
| <span class="sourceLineNo">588</span> * The pattern. If not specified, defaults to DEFAULT_CONVERSION_PATTERN.<a name="line.588"></a> |
| <span class="sourceLineNo">589</span> */<a name="line.589"></a> |
| <span class="sourceLineNo">590</span> public Builder withPattern(final String pattern) {<a name="line.590"></a> |
| <span class="sourceLineNo">591</span> this.pattern = pattern;<a name="line.591"></a> |
| <span class="sourceLineNo">592</span> return this;<a name="line.592"></a> |
| <span class="sourceLineNo">593</span> }<a name="line.593"></a> |
| <span class="sourceLineNo">594</span><a name="line.594"></a> |
| <span class="sourceLineNo">595</span> /**<a name="line.595"></a> |
| <span class="sourceLineNo">596</span> * @param patternSelector<a name="line.596"></a> |
| <span class="sourceLineNo">597</span> * Allows different patterns to be used based on some selection criteria.<a name="line.597"></a> |
| <span class="sourceLineNo">598</span> */<a name="line.598"></a> |
| <span class="sourceLineNo">599</span> public Builder withPatternSelector(final PatternSelector patternSelector) {<a name="line.599"></a> |
| <span class="sourceLineNo">600</span> this.patternSelector = patternSelector;<a name="line.600"></a> |
| <span class="sourceLineNo">601</span> return this;<a name="line.601"></a> |
| <span class="sourceLineNo">602</span> }<a name="line.602"></a> |
| <span class="sourceLineNo">603</span><a name="line.603"></a> |
| <span class="sourceLineNo">604</span> /**<a name="line.604"></a> |
| <span class="sourceLineNo">605</span> * @param configuration<a name="line.605"></a> |
| <span class="sourceLineNo">606</span> * The Configuration. Some Converters require access to the Interpolator.<a name="line.606"></a> |
| <span class="sourceLineNo">607</span> */<a name="line.607"></a> |
| <span class="sourceLineNo">608</span> public Builder withConfiguration(final Configuration configuration) {<a name="line.608"></a> |
| <span class="sourceLineNo">609</span> this.configuration = configuration;<a name="line.609"></a> |
| <span class="sourceLineNo">610</span> return this;<a name="line.610"></a> |
| <span class="sourceLineNo">611</span> }<a name="line.611"></a> |
| <span class="sourceLineNo">612</span><a name="line.612"></a> |
| <span class="sourceLineNo">613</span> /**<a name="line.613"></a> |
| <span class="sourceLineNo">614</span> * @param regexReplacement<a name="line.614"></a> |
| <span class="sourceLineNo">615</span> * A Regex replacement<a name="line.615"></a> |
| <span class="sourceLineNo">616</span> */<a name="line.616"></a> |
| <span class="sourceLineNo">617</span> public Builder withRegexReplacement(final RegexReplacement regexReplacement) {<a name="line.617"></a> |
| <span class="sourceLineNo">618</span> this.regexReplacement = regexReplacement;<a name="line.618"></a> |
| <span class="sourceLineNo">619</span> return this;<a name="line.619"></a> |
| <span class="sourceLineNo">620</span> }<a name="line.620"></a> |
| <span class="sourceLineNo">621</span><a name="line.621"></a> |
| <span class="sourceLineNo">622</span> /**<a name="line.622"></a> |
| <span class="sourceLineNo">623</span> * @param charset<a name="line.623"></a> |
| <span class="sourceLineNo">624</span> * The character set. The platform default is used if not specified.<a name="line.624"></a> |
| <span class="sourceLineNo">625</span> */<a name="line.625"></a> |
| <span class="sourceLineNo">626</span> public Builder withCharset(final Charset charset) {<a name="line.626"></a> |
| <span class="sourceLineNo">627</span> // LOG4J2-783 if null, use platform default by default<a name="line.627"></a> |
| <span class="sourceLineNo">628</span> if (charset != null) {<a name="line.628"></a> |
| <span class="sourceLineNo">629</span> this.charset = charset;<a name="line.629"></a> |
| <span class="sourceLineNo">630</span> }<a name="line.630"></a> |
| <span class="sourceLineNo">631</span> return this;<a name="line.631"></a> |
| <span class="sourceLineNo">632</span> }<a name="line.632"></a> |
| <span class="sourceLineNo">633</span><a name="line.633"></a> |
| <span class="sourceLineNo">634</span> /**<a name="line.634"></a> |
| <span class="sourceLineNo">635</span> * @param alwaysWriteExceptions<a name="line.635"></a> |
| <span class="sourceLineNo">636</span> * If {@code "true"} (default) exceptions are always written even if the pattern contains no exception tokens.<a name="line.636"></a> |
| <span class="sourceLineNo">637</span> */<a name="line.637"></a> |
| <span class="sourceLineNo">638</span> public Builder withAlwaysWriteExceptions(final boolean alwaysWriteExceptions) {<a name="line.638"></a> |
| <span class="sourceLineNo">639</span> this.alwaysWriteExceptions = alwaysWriteExceptions;<a name="line.639"></a> |
| <span class="sourceLineNo">640</span> return this;<a name="line.640"></a> |
| <span class="sourceLineNo">641</span> }<a name="line.641"></a> |
| <span class="sourceLineNo">642</span><a name="line.642"></a> |
| <span class="sourceLineNo">643</span> /**<a name="line.643"></a> |
| <span class="sourceLineNo">644</span> * @param disableAnsi<a name="line.644"></a> |
| <span class="sourceLineNo">645</span> * If {@code "true"} (default is value of system property `log4j.skipJansi`, or `true` if undefined),<a name="line.645"></a> |
| <span class="sourceLineNo">646</span> * do not output ANSI escape codes<a name="line.646"></a> |
| <span class="sourceLineNo">647</span> */<a name="line.647"></a> |
| <span class="sourceLineNo">648</span> public Builder withDisableAnsi(final boolean disableAnsi) {<a name="line.648"></a> |
| <span class="sourceLineNo">649</span> this.disableAnsi = disableAnsi;<a name="line.649"></a> |
| <span class="sourceLineNo">650</span> return this;<a name="line.650"></a> |
| <span class="sourceLineNo">651</span> }<a name="line.651"></a> |
| <span class="sourceLineNo">652</span><a name="line.652"></a> |
| <span class="sourceLineNo">653</span> /**<a name="line.653"></a> |
| <span class="sourceLineNo">654</span> * @param noConsoleNoAnsi<a name="line.654"></a> |
| <span class="sourceLineNo">655</span> * If {@code "true"} (default is false) and {@link System#console()} is null, do not output ANSI escape codes<a name="line.655"></a> |
| <span class="sourceLineNo">656</span> */<a name="line.656"></a> |
| <span class="sourceLineNo">657</span> public Builder withNoConsoleNoAnsi(final boolean noConsoleNoAnsi) {<a name="line.657"></a> |
| <span class="sourceLineNo">658</span> this.noConsoleNoAnsi = noConsoleNoAnsi;<a name="line.658"></a> |
| <span class="sourceLineNo">659</span> return this;<a name="line.659"></a> |
| <span class="sourceLineNo">660</span> }<a name="line.660"></a> |
| <span class="sourceLineNo">661</span><a name="line.661"></a> |
| <span class="sourceLineNo">662</span> /**<a name="line.662"></a> |
| <span class="sourceLineNo">663</span> * @param header<a name="line.663"></a> |
| <span class="sourceLineNo">664</span> * The footer to place at the top of the document, once.<a name="line.664"></a> |
| <span class="sourceLineNo">665</span> */<a name="line.665"></a> |
| <span class="sourceLineNo">666</span> public Builder withHeader(final String header) {<a name="line.666"></a> |
| <span class="sourceLineNo">667</span> this.header = header;<a name="line.667"></a> |
| <span class="sourceLineNo">668</span> return this;<a name="line.668"></a> |
| <span class="sourceLineNo">669</span> }<a name="line.669"></a> |
| <span class="sourceLineNo">670</span><a name="line.670"></a> |
| <span class="sourceLineNo">671</span> /**<a name="line.671"></a> |
| <span class="sourceLineNo">672</span> * @param footer<a name="line.672"></a> |
| <span class="sourceLineNo">673</span> * The footer to place at the bottom of the document, once.<a name="line.673"></a> |
| <span class="sourceLineNo">674</span> */<a name="line.674"></a> |
| <span class="sourceLineNo">675</span> public Builder withFooter(final String footer) {<a name="line.675"></a> |
| <span class="sourceLineNo">676</span> this.footer = footer;<a name="line.676"></a> |
| <span class="sourceLineNo">677</span> return this;<a name="line.677"></a> |
| <span class="sourceLineNo">678</span> }<a name="line.678"></a> |
| <span class="sourceLineNo">679</span><a name="line.679"></a> |
| <span class="sourceLineNo">680</span> @Override<a name="line.680"></a> |
| <span class="sourceLineNo">681</span> public PatternLayout build() {<a name="line.681"></a> |
| <span class="sourceLineNo">682</span> // fall back to DefaultConfiguration<a name="line.682"></a> |
| <span class="sourceLineNo">683</span> if (configuration == null) {<a name="line.683"></a> |
| <span class="sourceLineNo">684</span> configuration = new DefaultConfiguration();<a name="line.684"></a> |
| <span class="sourceLineNo">685</span> }<a name="line.685"></a> |
| <span class="sourceLineNo">686</span> return new PatternLayout(configuration, regexReplacement, pattern, patternSelector, charset,<a name="line.686"></a> |
| <span class="sourceLineNo">687</span> alwaysWriteExceptions, disableAnsi, noConsoleNoAnsi, header, footer);<a name="line.687"></a> |
| <span class="sourceLineNo">688</span> }<a name="line.688"></a> |
| <span class="sourceLineNo">689</span> }<a name="line.689"></a> |
| <span class="sourceLineNo">690</span><a name="line.690"></a> |
| <span class="sourceLineNo">691</span> public Serializer getEventSerializer() {<a name="line.691"></a> |
| <span class="sourceLineNo">692</span> return eventSerializer;<a name="line.692"></a> |
| <span class="sourceLineNo">693</span> }<a name="line.693"></a> |
| <span class="sourceLineNo">694</span>}<a name="line.694"></a> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| </pre> |
| </div> |
| </body> |
| </html> |
