blob: 90821c0cc78a31972674ce0a01876578b7c28c74 [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.log4j.builders.layout;<a name="line.17"></a>
<span class="sourceLineNo">018</span><a name="line.18"></a>
<span class="sourceLineNo">019</span>import org.apache.log4j.Layout;<a name="line.19"></a>
<span class="sourceLineNo">020</span>import org.apache.log4j.bridge.LayoutWrapper;<a name="line.20"></a>
<span class="sourceLineNo">021</span>import org.apache.log4j.builders.AbstractBuilder;<a name="line.21"></a>
<span class="sourceLineNo">022</span>import org.apache.log4j.builders.BooleanHolder;<a name="line.22"></a>
<span class="sourceLineNo">023</span>import org.apache.log4j.builders.Holder;<a name="line.23"></a>
<span class="sourceLineNo">024</span>import org.apache.log4j.config.Log4j1Configuration;<a name="line.24"></a>
<span class="sourceLineNo">025</span>import org.apache.log4j.config.PropertiesConfiguration;<a name="line.25"></a>
<span class="sourceLineNo">026</span>import org.apache.log4j.xml.XmlConfiguration;<a name="line.26"></a>
<span class="sourceLineNo">027</span>import org.apache.logging.log4j.Logger;<a name="line.27"></a>
<span class="sourceLineNo">028</span>import org.apache.logging.log4j.core.config.plugins.Plugin;<a name="line.28"></a>
<span class="sourceLineNo">029</span>import org.apache.logging.log4j.core.layout.PatternLayout;<a name="line.29"></a>
<span class="sourceLineNo">030</span>import org.apache.logging.log4j.status.StatusLogger;<a name="line.30"></a>
<span class="sourceLineNo">031</span>import org.w3c.dom.Element;<a name="line.31"></a>
<span class="sourceLineNo">032</span><a name="line.32"></a>
<span class="sourceLineNo">033</span>import java.util.Properties;<a name="line.33"></a>
<span class="sourceLineNo">034</span><a name="line.34"></a>
<span class="sourceLineNo">035</span>import static org.apache.log4j.builders.BuilderManager.CATEGORY;<a name="line.35"></a>
<span class="sourceLineNo">036</span>import static org.apache.log4j.xml.XmlConfiguration.*;<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> * Build a Pattern Layout<a name="line.39"></a>
<span class="sourceLineNo">040</span> */<a name="line.40"></a>
<span class="sourceLineNo">041</span>@Plugin(name = "org.apache.log4j.TTCCLayout", category = CATEGORY)<a name="line.41"></a>
<span class="sourceLineNo">042</span>public class TTCCLayoutBuilder extends AbstractBuilder implements LayoutBuilder {<a name="line.42"></a>
<span class="sourceLineNo">043</span><a name="line.43"></a>
<span class="sourceLineNo">044</span> private static final Logger LOGGER = StatusLogger.getLogger();<a name="line.44"></a>
<span class="sourceLineNo">045</span><a name="line.45"></a>
<span class="sourceLineNo">046</span> private static final String THREAD_PRINTING_PARAM = "ThreadPrinting";<a name="line.46"></a>
<span class="sourceLineNo">047</span> private static final String CATEGORY_PREFIXING_PARAM = "CategoryPrefixing";<a name="line.47"></a>
<span class="sourceLineNo">048</span> private static final String CONTEXT_PRINTING_PARAM = "ContextPrinting";<a name="line.48"></a>
<span class="sourceLineNo">049</span> private static final String DATE_FORMAT_PARAM = "DateFormat";<a name="line.49"></a>
<span class="sourceLineNo">050</span> private static final String TIMEZONE_FORMAT = "TimeZone";<a name="line.50"></a>
<span class="sourceLineNo">051</span><a name="line.51"></a>
<span class="sourceLineNo">052</span> public TTCCLayoutBuilder() {<a name="line.52"></a>
<span class="sourceLineNo">053</span> }<a name="line.53"></a>
<span class="sourceLineNo">054</span><a name="line.54"></a>
<span class="sourceLineNo">055</span> public TTCCLayoutBuilder(String prefix, Properties props) {<a name="line.55"></a>
<span class="sourceLineNo">056</span> super(prefix, props);<a name="line.56"></a>
<span class="sourceLineNo">057</span> }<a name="line.57"></a>
<span class="sourceLineNo">058</span><a name="line.58"></a>
<span class="sourceLineNo">059</span> @Override<a name="line.59"></a>
<span class="sourceLineNo">060</span> public Layout parseLayout(Element layoutElement, XmlConfiguration config) {<a name="line.60"></a>
<span class="sourceLineNo">061</span> final Holder&lt;Boolean&gt; threadPrinting = new BooleanHolder();<a name="line.61"></a>
<span class="sourceLineNo">062</span> final Holder&lt;Boolean&gt; categoryPrefixing = new BooleanHolder();<a name="line.62"></a>
<span class="sourceLineNo">063</span> final Holder&lt;Boolean&gt; contextPrinting = new BooleanHolder();<a name="line.63"></a>
<span class="sourceLineNo">064</span> final Holder&lt;String&gt; dateFormat = new Holder&lt;&gt;();<a name="line.64"></a>
<span class="sourceLineNo">065</span> final Holder&lt;String&gt; timezone = new Holder&lt;&gt;();<a name="line.65"></a>
<span class="sourceLineNo">066</span> forEachElement(layoutElement.getElementsByTagName("param"), (currentElement) -&gt; {<a name="line.66"></a>
<span class="sourceLineNo">067</span> if (currentElement.getTagName().equals(PARAM_TAG)) {<a name="line.67"></a>
<span class="sourceLineNo">068</span> switch (currentElement.getAttribute(NAME_ATTR)) {<a name="line.68"></a>
<span class="sourceLineNo">069</span> case THREAD_PRINTING_PARAM:<a name="line.69"></a>
<span class="sourceLineNo">070</span> threadPrinting.set(Boolean.parseBoolean(currentElement.getAttribute(VALUE_ATTR)));<a name="line.70"></a>
<span class="sourceLineNo">071</span> break;<a name="line.71"></a>
<span class="sourceLineNo">072</span> case CATEGORY_PREFIXING_PARAM:<a name="line.72"></a>
<span class="sourceLineNo">073</span> categoryPrefixing.set(Boolean.parseBoolean(currentElement.getAttribute(VALUE_ATTR)));<a name="line.73"></a>
<span class="sourceLineNo">074</span> break;<a name="line.74"></a>
<span class="sourceLineNo">075</span> case CONTEXT_PRINTING_PARAM:<a name="line.75"></a>
<span class="sourceLineNo">076</span> contextPrinting.set(Boolean.parseBoolean(currentElement.getAttribute(VALUE_ATTR)));<a name="line.76"></a>
<span class="sourceLineNo">077</span> break;<a name="line.77"></a>
<span class="sourceLineNo">078</span> case DATE_FORMAT_PARAM:<a name="line.78"></a>
<span class="sourceLineNo">079</span> dateFormat.set(currentElement.getAttribute(VALUE_ATTR));<a name="line.79"></a>
<span class="sourceLineNo">080</span> break;<a name="line.80"></a>
<span class="sourceLineNo">081</span> case TIMEZONE_FORMAT:<a name="line.81"></a>
<span class="sourceLineNo">082</span> timezone.set(currentElement.getAttribute(VALUE_ATTR));<a name="line.82"></a>
<span class="sourceLineNo">083</span> break;<a name="line.83"></a>
<span class="sourceLineNo">084</span> }<a name="line.84"></a>
<span class="sourceLineNo">085</span> }<a name="line.85"></a>
<span class="sourceLineNo">086</span> });<a name="line.86"></a>
<span class="sourceLineNo">087</span> return createLayout(threadPrinting.get(), categoryPrefixing.get(), contextPrinting.get(),<a name="line.87"></a>
<span class="sourceLineNo">088</span> dateFormat.get(), timezone.get(), config);<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> @Override<a name="line.91"></a>
<span class="sourceLineNo">092</span> public Layout parseLayout(PropertiesConfiguration config) {<a name="line.92"></a>
<span class="sourceLineNo">093</span> boolean threadPrinting = getBooleanProperty(THREAD_PRINTING_PARAM);<a name="line.93"></a>
<span class="sourceLineNo">094</span> boolean categoryPrefixing = getBooleanProperty(CATEGORY_PREFIXING_PARAM);<a name="line.94"></a>
<span class="sourceLineNo">095</span> boolean contextPrinting = getBooleanProperty(CONTEXT_PRINTING_PARAM);<a name="line.95"></a>
<span class="sourceLineNo">096</span> String dateFormat = getProperty(DATE_FORMAT_PARAM);<a name="line.96"></a>
<span class="sourceLineNo">097</span> String timezone = getProperty(TIMEZONE_FORMAT);<a name="line.97"></a>
<span class="sourceLineNo">098</span><a name="line.98"></a>
<span class="sourceLineNo">099</span> return createLayout(threadPrinting, categoryPrefixing, contextPrinting,<a name="line.99"></a>
<span class="sourceLineNo">100</span> dateFormat, timezone, config);<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> private Layout createLayout(boolean threadPrinting, boolean categoryPrefixing, boolean contextPrinting,<a name="line.103"></a>
<span class="sourceLineNo">104</span> String dateFormat, String timezone, Log4j1Configuration config) {<a name="line.104"></a>
<span class="sourceLineNo">105</span> StringBuilder sb = new StringBuilder();<a name="line.105"></a>
<span class="sourceLineNo">106</span> if (dateFormat != null) {<a name="line.106"></a>
<span class="sourceLineNo">107</span> if (RELATIVE.equalsIgnoreCase(dateFormat)) {<a name="line.107"></a>
<span class="sourceLineNo">108</span> sb.append("%r ");<a name="line.108"></a>
<span class="sourceLineNo">109</span> } else {<a name="line.109"></a>
<span class="sourceLineNo">110</span> sb.append("%d{").append(dateFormat).append("}");<a name="line.110"></a>
<span class="sourceLineNo">111</span> if (timezone != null) {<a name="line.111"></a>
<span class="sourceLineNo">112</span> sb.append("{").append(timezone).append("}");<a name="line.112"></a>
<span class="sourceLineNo">113</span> }<a name="line.113"></a>
<span class="sourceLineNo">114</span> sb.append(" ");<a name="line.114"></a>
<span class="sourceLineNo">115</span> }<a name="line.115"></a>
<span class="sourceLineNo">116</span> }<a name="line.116"></a>
<span class="sourceLineNo">117</span> if (threadPrinting) {<a name="line.117"></a>
<span class="sourceLineNo">118</span> sb.append("[%t] ");<a name="line.118"></a>
<span class="sourceLineNo">119</span> }<a name="line.119"></a>
<span class="sourceLineNo">120</span> sb.append("%p ");<a name="line.120"></a>
<span class="sourceLineNo">121</span> if (categoryPrefixing) {<a name="line.121"></a>
<span class="sourceLineNo">122</span> sb.append("%c ");<a name="line.122"></a>
<span class="sourceLineNo">123</span> }<a name="line.123"></a>
<span class="sourceLineNo">124</span> if (contextPrinting) {<a name="line.124"></a>
<span class="sourceLineNo">125</span> sb.append("%notEmpty{%ndc }");<a name="line.125"></a>
<span class="sourceLineNo">126</span> }<a name="line.126"></a>
<span class="sourceLineNo">127</span> sb.append("- %m%n");<a name="line.127"></a>
<span class="sourceLineNo">128</span> return new LayoutWrapper(PatternLayout.newBuilder()<a name="line.128"></a>
<span class="sourceLineNo">129</span> .withPattern(sb.toString())<a name="line.129"></a>
<span class="sourceLineNo">130</span> .withConfiguration(config)<a name="line.130"></a>
<span class="sourceLineNo">131</span> .build());<a name="line.131"></a>
<span class="sourceLineNo">132</span> }<a name="line.132"></a>
<span class="sourceLineNo">133</span>}<a name="line.133"></a>
</pre>
</div>
</body>
</html>