| <HTML> |
| <BODY BGCOLOR="white"> |
| <PRE> |
| <FONT color="green">001</FONT> /*<a name="line.1"></a> |
| <FONT color="green">002</FONT> * Licensed to the Apache Software Foundation (ASF) under one or more<a name="line.2"></a> |
| <FONT color="green">003</FONT> * contributor license agreements. See the NOTICE file distributed with<a name="line.3"></a> |
| <FONT color="green">004</FONT> * this work for additional information regarding copyright ownership.<a name="line.4"></a> |
| <FONT color="green">005</FONT> * The ASF licenses this file to You under the Apache license, Version 2.0<a name="line.5"></a> |
| <FONT color="green">006</FONT> * (the "License"); you may not use this file except in compliance with<a name="line.6"></a> |
| <FONT color="green">007</FONT> * the License. You may obtain a copy of the License at<a name="line.7"></a> |
| <FONT color="green">008</FONT> *<a name="line.8"></a> |
| <FONT color="green">009</FONT> * http://www.apache.org/licenses/LICENSE-2.0<a name="line.9"></a> |
| <FONT color="green">010</FONT> *<a name="line.10"></a> |
| <FONT color="green">011</FONT> * Unless required by applicable law or agreed to in writing, software<a name="line.11"></a> |
| <FONT color="green">012</FONT> * distributed under the License is distributed on an "AS IS" BASIS,<a name="line.12"></a> |
| <FONT color="green">013</FONT> * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.<a name="line.13"></a> |
| <FONT color="green">014</FONT> * See the license for the specific language governing permissions and<a name="line.14"></a> |
| <FONT color="green">015</FONT> * limitations under the license.<a name="line.15"></a> |
| <FONT color="green">016</FONT> */<a name="line.16"></a> |
| <FONT color="green">017</FONT> package org.apache.logging.log4j.core.layout;<a name="line.17"></a> |
| <FONT color="green">018</FONT> <a name="line.18"></a> |
| <FONT color="green">019</FONT> import org.apache.logging.log4j.core.LogEvent;<a name="line.19"></a> |
| <FONT color="green">020</FONT> import org.apache.logging.log4j.core.config.Configuration;<a name="line.20"></a> |
| <FONT color="green">021</FONT> import org.apache.logging.log4j.core.config.plugins.Plugin;<a name="line.21"></a> |
| <FONT color="green">022</FONT> import org.apache.logging.log4j.core.config.plugins.PluginAttr;<a name="line.22"></a> |
| <FONT color="green">023</FONT> import org.apache.logging.log4j.core.config.plugins.PluginConfiguration;<a name="line.23"></a> |
| <FONT color="green">024</FONT> import org.apache.logging.log4j.core.config.plugins.PluginElement;<a name="line.24"></a> |
| <FONT color="green">025</FONT> import org.apache.logging.log4j.core.config.plugins.PluginFactory;<a name="line.25"></a> |
| <FONT color="green">026</FONT> import org.apache.logging.log4j.core.helpers.OptionConverter;<a name="line.26"></a> |
| <FONT color="green">027</FONT> import org.apache.logging.log4j.core.pattern.LogEventPatternConverter;<a name="line.27"></a> |
| <FONT color="green">028</FONT> import org.apache.logging.log4j.core.pattern.PatternConverter;<a name="line.28"></a> |
| <FONT color="green">029</FONT> import org.apache.logging.log4j.core.pattern.PatternParser;<a name="line.29"></a> |
| <FONT color="green">030</FONT> import org.apache.logging.log4j.core.pattern.RegexReplacement;<a name="line.30"></a> |
| <FONT color="green">031</FONT> <a name="line.31"></a> |
| <FONT color="green">032</FONT> import java.nio.charset.Charset;<a name="line.32"></a> |
| <FONT color="green">033</FONT> import java.util.List;<a name="line.33"></a> |
| <FONT color="green">034</FONT> <a name="line.34"></a> |
| <FONT color="green">035</FONT> /**<a name="line.35"></a> |
| <FONT color="green">036</FONT> * <p>A flexible layout configurable with pattern string. The goal of this class<a name="line.36"></a> |
| <FONT color="green">037</FONT> * is to {@link #format format} a {@link LogEvent} and return the results.<a name="line.37"></a> |
| <FONT color="green">038</FONT> * The format of the result depends on the <em>conversion pattern</em>.<a name="line.38"></a> |
| <FONT color="green">039</FONT> * <p><a name="line.39"></a> |
| <FONT color="green">040</FONT> * <p/><a name="line.40"></a> |
| <FONT color="green">041</FONT> * <p>The conversion pattern is closely related to the conversion<a name="line.41"></a> |
| <FONT color="green">042</FONT> * pattern of the printf function in C. A conversion pattern is<a name="line.42"></a> |
| <FONT color="green">043</FONT> * composed of literal text and format control expressions called<a name="line.43"></a> |
| <FONT color="green">044</FONT> * <em>conversion specifiers</em>.<a name="line.44"></a> |
| <FONT color="green">045</FONT> *<a name="line.45"></a> |
| <FONT color="green">046</FONT> * See the Log4j Manual for details on the supported pattern converters.<a name="line.46"></a> |
| <FONT color="green">047</FONT> */<a name="line.47"></a> |
| <FONT color="green">048</FONT> @Plugin(name = "PatternLayout", type = "Core", elementType = "layout", printObject = true)<a name="line.48"></a> |
| <FONT color="green">049</FONT> public final class PatternLayout extends AbstractStringLayout {<a name="line.49"></a> |
| <FONT color="green">050</FONT> /**<a name="line.50"></a> |
| <FONT color="green">051</FONT> * Default pattern string for log output. Currently set to the<a name="line.51"></a> |
| <FONT color="green">052</FONT> * string <b>"%m%n"</b> which just prints the application supplied<a name="line.52"></a> |
| <FONT color="green">053</FONT> * message.<a name="line.53"></a> |
| <FONT color="green">054</FONT> */<a name="line.54"></a> |
| <FONT color="green">055</FONT> public static final String DEFAULT_CONVERSION_PATTERN = "%m%n";<a name="line.55"></a> |
| <FONT color="green">056</FONT> <a name="line.56"></a> |
| <FONT color="green">057</FONT> /**<a name="line.57"></a> |
| <FONT color="green">058</FONT> * A conversion pattern equivalent to the TTCCCLayout.<a name="line.58"></a> |
| <FONT color="green">059</FONT> * Current value is <b>%r [%t] %p %c %x - %m%n</b>.<a name="line.59"></a> |
| <FONT color="green">060</FONT> */<a name="line.60"></a> |
| <FONT color="green">061</FONT> public static final String TTCC_CONVERSION_PATTERN =<a name="line.61"></a> |
| <FONT color="green">062</FONT> "%r [%t] %p %c %x - %m%n";<a name="line.62"></a> |
| <FONT color="green">063</FONT> <a name="line.63"></a> |
| <FONT color="green">064</FONT> /**<a name="line.64"></a> |
| <FONT color="green">065</FONT> * A simple pattern.<a name="line.65"></a> |
| <FONT color="green">066</FONT> * Current value is <b>%d [%t] %p %c - %m%n</b>.<a name="line.66"></a> |
| <FONT color="green">067</FONT> */<a name="line.67"></a> |
| <FONT color="green">068</FONT> public static final String SIMPLE_CONVERSION_PATTERN =<a name="line.68"></a> |
| <FONT color="green">069</FONT> "%d [%t] %p %c - %m%n";<a name="line.69"></a> |
| <FONT color="green">070</FONT> <a name="line.70"></a> |
| <FONT color="green">071</FONT> private static final String KEY = "Converter";<a name="line.71"></a> |
| <FONT color="green">072</FONT> <a name="line.72"></a> |
| <FONT color="green">073</FONT> /**<a name="line.73"></a> |
| <FONT color="green">074</FONT> * Initial converter for pattern.<a name="line.74"></a> |
| <FONT color="green">075</FONT> */<a name="line.75"></a> |
| <FONT color="green">076</FONT> private List<PatternConverter> converters;<a name="line.76"></a> |
| <FONT color="green">077</FONT> <a name="line.77"></a> |
| <FONT color="green">078</FONT> /**<a name="line.78"></a> |
| <FONT color="green">079</FONT> * Conversion pattern.<a name="line.79"></a> |
| <FONT color="green">080</FONT> */<a name="line.80"></a> |
| <FONT color="green">081</FONT> private String conversionPattern;<a name="line.81"></a> |
| <FONT color="green">082</FONT> <a name="line.82"></a> |
| <FONT color="green">083</FONT> /**<a name="line.83"></a> |
| <FONT color="green">084</FONT> * True if any element in pattern formats information from exceptions.<a name="line.84"></a> |
| <FONT color="green">085</FONT> */<a name="line.85"></a> |
| <FONT color="green">086</FONT> private boolean handlesExceptions;<a name="line.86"></a> |
| <FONT color="green">087</FONT> <a name="line.87"></a> |
| <FONT color="green">088</FONT> /**<a name="line.88"></a> |
| <FONT color="green">089</FONT> * The current Configuration.<a name="line.89"></a> |
| <FONT color="green">090</FONT> */<a name="line.90"></a> |
| <FONT color="green">091</FONT> private final Configuration config;<a name="line.91"></a> |
| <FONT color="green">092</FONT> <a name="line.92"></a> |
| <FONT color="green">093</FONT> private final RegexReplacement replace;<a name="line.93"></a> |
| <FONT color="green">094</FONT> <a name="line.94"></a> |
| <FONT color="green">095</FONT> /**<a name="line.95"></a> |
| <FONT color="green">096</FONT> * Constructs a EnhancedPatternLayout using the supplied conversion pattern.<a name="line.96"></a> |
| <FONT color="green">097</FONT> *<a name="line.97"></a> |
| <FONT color="green">098</FONT> * @param config The Configuration.<a name="line.98"></a> |
| <FONT color="green">099</FONT> * @param replace The regular expression to match.<a name="line.99"></a> |
| <FONT color="green">100</FONT> * @param pattern conversion pattern.<a name="line.100"></a> |
| <FONT color="green">101</FONT> * @param charset The character set.<a name="line.101"></a> |
| <FONT color="green">102</FONT> */<a name="line.102"></a> |
| <FONT color="green">103</FONT> private PatternLayout(Configuration config, final RegexReplacement replace, final String pattern,<a name="line.103"></a> |
| <FONT color="green">104</FONT> final Charset charset) {<a name="line.104"></a> |
| <FONT color="green">105</FONT> super(charset);<a name="line.105"></a> |
| <FONT color="green">106</FONT> this.replace = replace;<a name="line.106"></a> |
| <FONT color="green">107</FONT> this.conversionPattern = pattern;<a name="line.107"></a> |
| <FONT color="green">108</FONT> this.config = config;<a name="line.108"></a> |
| <FONT color="green">109</FONT> PatternParser parser = createPatternParser(config);<a name="line.109"></a> |
| <FONT color="green">110</FONT> converters = parser.parse((pattern == null) ? DEFAULT_CONVERSION_PATTERN : pattern);<a name="line.110"></a> |
| <FONT color="green">111</FONT> handlesExceptions = parser.handlesExceptions();<a name="line.111"></a> |
| <FONT color="green">112</FONT> <a name="line.112"></a> |
| <FONT color="green">113</FONT> }<a name="line.113"></a> |
| <FONT color="green">114</FONT> <a name="line.114"></a> |
| <FONT color="green">115</FONT> /**<a name="line.115"></a> |
| <FONT color="green">116</FONT> * Set the <b>ConversionPattern</b> option. This is the string which<a name="line.116"></a> |
| <FONT color="green">117</FONT> * controls formatting and consists of a mix of literal content and<a name="line.117"></a> |
| <FONT color="green">118</FONT> * conversion specifiers.<a name="line.118"></a> |
| <FONT color="green">119</FONT> *<a name="line.119"></a> |
| <FONT color="green">120</FONT> * @param conversionPattern conversion pattern.<a name="line.120"></a> |
| <FONT color="green">121</FONT> */<a name="line.121"></a> |
| <FONT color="green">122</FONT> public void setConversionPattern(final String conversionPattern) {<a name="line.122"></a> |
| <FONT color="green">123</FONT> String pattern = OptionConverter.convertSpecialChars(conversionPattern);<a name="line.123"></a> |
| <FONT color="green">124</FONT> if (pattern == null) {<a name="line.124"></a> |
| <FONT color="green">125</FONT> return;<a name="line.125"></a> |
| <FONT color="green">126</FONT> }<a name="line.126"></a> |
| <FONT color="green">127</FONT> PatternParser parser = createPatternParser(this.config);<a name="line.127"></a> |
| <FONT color="green">128</FONT> converters = parser.parse(pattern);<a name="line.128"></a> |
| <FONT color="green">129</FONT> handlesExceptions = parser.handlesExceptions();<a name="line.129"></a> |
| <FONT color="green">130</FONT> }<a name="line.130"></a> |
| <FONT color="green">131</FONT> <a name="line.131"></a> |
| <FONT color="green">132</FONT> /**<a name="line.132"></a> |
| <FONT color="green">133</FONT> * Formats a logging event to a writer.<a name="line.133"></a> |
| <FONT color="green">134</FONT> *<a name="line.134"></a> |
| <FONT color="green">135</FONT> * @param event logging event to be formatted.<a name="line.135"></a> |
| <FONT color="green">136</FONT> * @return The event formatted as a String.<a name="line.136"></a> |
| <FONT color="green">137</FONT> */<a name="line.137"></a> |
| <FONT color="green">138</FONT> public String formatAs(final LogEvent event) {<a name="line.138"></a> |
| <FONT color="green">139</FONT> StringBuilder buf = new StringBuilder();<a name="line.139"></a> |
| <FONT color="green">140</FONT> for (PatternConverter c : converters) {<a name="line.140"></a> |
| <FONT color="green">141</FONT> c.format(event, buf);<a name="line.141"></a> |
| <FONT color="green">142</FONT> }<a name="line.142"></a> |
| <FONT color="green">143</FONT> String str = buf.toString();<a name="line.143"></a> |
| <FONT color="green">144</FONT> if (replace != null) {<a name="line.144"></a> |
| <FONT color="green">145</FONT> str = replace.format(str);<a name="line.145"></a> |
| <FONT color="green">146</FONT> }<a name="line.146"></a> |
| <FONT color="green">147</FONT> return config == null ? str : config.getSubst().replace(event, str);<a name="line.147"></a> |
| <FONT color="green">148</FONT> }<a name="line.148"></a> |
| <FONT color="green">149</FONT> <a name="line.149"></a> |
| <FONT color="green">150</FONT> /**<a name="line.150"></a> |
| <FONT color="green">151</FONT> * Create a PatternParser.<a name="line.151"></a> |
| <FONT color="green">152</FONT> * @param config The Configuration.<a name="line.152"></a> |
| <FONT color="green">153</FONT> * @return The PatternParser.<a name="line.153"></a> |
| <FONT color="green">154</FONT> */<a name="line.154"></a> |
| <FONT color="green">155</FONT> public static PatternParser createPatternParser(Configuration config) {<a name="line.155"></a> |
| <FONT color="green">156</FONT> if (config == null) {<a name="line.156"></a> |
| <FONT color="green">157</FONT> return new PatternParser(config, KEY, LogEventPatternConverter.class);<a name="line.157"></a> |
| <FONT color="green">158</FONT> }<a name="line.158"></a> |
| <FONT color="green">159</FONT> PatternParser parser = (PatternParser) config.getComponent(KEY);<a name="line.159"></a> |
| <FONT color="green">160</FONT> if (parser == null) {<a name="line.160"></a> |
| <FONT color="green">161</FONT> parser = new PatternParser(config, KEY, LogEventPatternConverter.class);<a name="line.161"></a> |
| <FONT color="green">162</FONT> config.addComponent(KEY, parser);<a name="line.162"></a> |
| <FONT color="green">163</FONT> parser = (PatternParser) config.getComponent(KEY);<a name="line.163"></a> |
| <FONT color="green">164</FONT> }<a name="line.164"></a> |
| <FONT color="green">165</FONT> return parser;<a name="line.165"></a> |
| <FONT color="green">166</FONT> }<a name="line.166"></a> |
| <FONT color="green">167</FONT> <a name="line.167"></a> |
| <FONT color="green">168</FONT> @Override<a name="line.168"></a> |
| <FONT color="green">169</FONT> public String toString() {<a name="line.169"></a> |
| <FONT color="green">170</FONT> return conversionPattern;<a name="line.170"></a> |
| <FONT color="green">171</FONT> }<a name="line.171"></a> |
| <FONT color="green">172</FONT> <a name="line.172"></a> |
| <FONT color="green">173</FONT> /**<a name="line.173"></a> |
| <FONT color="green">174</FONT> * Create a pattern layout.<a name="line.174"></a> |
| <FONT color="green">175</FONT> * @param pattern The pattern. If not specified, defaults to DEFAULT_CONVERSION_PATTERN.<a name="line.175"></a> |
| <FONT color="green">176</FONT> * @param config The Configuration. Some Converters require access to the Interpolator.<a name="line.176"></a> |
| <FONT color="green">177</FONT> * @param replace A Regex replacement String.<a name="line.177"></a> |
| <FONT color="green">178</FONT> * @param charset The character set.<a name="line.178"></a> |
| <FONT color="green">179</FONT> * @return The PatternLayout.<a name="line.179"></a> |
| <FONT color="green">180</FONT> */<a name="line.180"></a> |
| <FONT color="green">181</FONT> @PluginFactory<a name="line.181"></a> |
| <FONT color="green">182</FONT> public static PatternLayout createLayout(@PluginAttr("pattern") String pattern,<a name="line.182"></a> |
| <FONT color="green">183</FONT> @PluginConfiguration Configuration config,<a name="line.183"></a> |
| <FONT color="green">184</FONT> @PluginElement("replace") RegexReplacement replace,<a name="line.184"></a> |
| <FONT color="green">185</FONT> @PluginAttr("charset") String charset) {<a name="line.185"></a> |
| <FONT color="green">186</FONT> Charset c = Charset.isSupported("UTF-8") ? Charset.forName("UTF-8") : Charset.defaultCharset();<a name="line.186"></a> |
| <FONT color="green">187</FONT> if (charset != null) {<a name="line.187"></a> |
| <FONT color="green">188</FONT> if (Charset.isSupported(charset)) {<a name="line.188"></a> |
| <FONT color="green">189</FONT> c = Charset.forName(charset);<a name="line.189"></a> |
| <FONT color="green">190</FONT> } else {<a name="line.190"></a> |
| <FONT color="green">191</FONT> LOGGER.error("Charset " + charset + " is not supported for layout, using " + c.displayName());<a name="line.191"></a> |
| <FONT color="green">192</FONT> }<a name="line.192"></a> |
| <FONT color="green">193</FONT> }<a name="line.193"></a> |
| <FONT color="green">194</FONT> return new PatternLayout(config, replace, pattern == null ? DEFAULT_CONVERSION_PATTERN : pattern, c);<a name="line.194"></a> |
| <FONT color="green">195</FONT> }<a name="line.195"></a> |
| <FONT color="green">196</FONT> }<a name="line.196"></a> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| </PRE> |
| </BODY> |
| </HTML> |
