blob: cd5a7297b8a61acbf7530adf256656213fb8af5f [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.config.Log4j1Configuration;<a name="line.22"></a>
<span class="sourceLineNo">023</span>import org.apache.log4j.config.PropertiesConfiguration;<a name="line.23"></a>
<span class="sourceLineNo">024</span>import org.apache.log4j.xml.XmlConfiguration;<a name="line.24"></a>
<span class="sourceLineNo">025</span>import org.apache.logging.log4j.Logger;<a name="line.25"></a>
<span class="sourceLineNo">026</span>import org.apache.logging.log4j.core.config.plugins.Plugin;<a name="line.26"></a>
<span class="sourceLineNo">027</span>import org.apache.logging.log4j.core.config.plugins.PluginAliases;<a name="line.27"></a>
<span class="sourceLineNo">028</span>import org.apache.logging.log4j.core.layout.PatternLayout;<a name="line.28"></a>
<span class="sourceLineNo">029</span>import org.apache.logging.log4j.status.StatusLogger;<a name="line.29"></a>
<span class="sourceLineNo">030</span>import org.w3c.dom.Element;<a name="line.30"></a>
<span class="sourceLineNo">031</span>import org.w3c.dom.Node;<a name="line.31"></a>
<span class="sourceLineNo">032</span>import org.w3c.dom.NodeList;<a name="line.32"></a>
<span class="sourceLineNo">033</span><a name="line.33"></a>
<span class="sourceLineNo">034</span>import java.util.Properties;<a name="line.34"></a>
<span class="sourceLineNo">035</span><a name="line.35"></a>
<span class="sourceLineNo">036</span>import static org.apache.log4j.builders.BuilderManager.CATEGORY;<a name="line.36"></a>
<span class="sourceLineNo">037</span>import static org.apache.log4j.xml.XmlConfiguration.PARAM_TAG;<a name="line.37"></a>
<span class="sourceLineNo">038</span><a name="line.38"></a>
<span class="sourceLineNo">039</span>/**<a name="line.39"></a>
<span class="sourceLineNo">040</span> * Build a Pattern Layout<a name="line.40"></a>
<span class="sourceLineNo">041</span> */<a name="line.41"></a>
<span class="sourceLineNo">042</span>@Plugin(name = "org.apache.log4j.PatternLayout", category = CATEGORY)<a name="line.42"></a>
<span class="sourceLineNo">043</span>@PluginAliases("org.apache.log4j.EnhancedPatternLayout")<a name="line.43"></a>
<span class="sourceLineNo">044</span>public class PatternLayoutBuilder extends AbstractBuilder implements LayoutBuilder {<a name="line.44"></a>
<span class="sourceLineNo">045</span><a name="line.45"></a>
<span class="sourceLineNo">046</span> private static final Logger LOGGER = StatusLogger.getLogger();<a name="line.46"></a>
<span class="sourceLineNo">047</span> private static final String PATTERN = "ConversionPattern";<a name="line.47"></a>
<span class="sourceLineNo">048</span><a name="line.48"></a>
<span class="sourceLineNo">049</span> public PatternLayoutBuilder() {<a name="line.49"></a>
<span class="sourceLineNo">050</span> }<a name="line.50"></a>
<span class="sourceLineNo">051</span><a name="line.51"></a>
<span class="sourceLineNo">052</span> public PatternLayoutBuilder(String prefix, Properties props) {<a name="line.52"></a>
<span class="sourceLineNo">053</span> super(prefix, props);<a name="line.53"></a>
<span class="sourceLineNo">054</span> }<a name="line.54"></a>
<span class="sourceLineNo">055</span><a name="line.55"></a>
<span class="sourceLineNo">056</span> @Override<a name="line.56"></a>
<span class="sourceLineNo">057</span> public Layout parseLayout(final Element layoutElement, final XmlConfiguration config) {<a name="line.57"></a>
<span class="sourceLineNo">058</span> NodeList params = layoutElement.getElementsByTagName("param");<a name="line.58"></a>
<span class="sourceLineNo">059</span> final int length = params.getLength();<a name="line.59"></a>
<span class="sourceLineNo">060</span> String pattern = null;<a name="line.60"></a>
<span class="sourceLineNo">061</span> for (int index = 0; index &lt; length; ++ index) {<a name="line.61"></a>
<span class="sourceLineNo">062</span> Node currentNode = params.item(index);<a name="line.62"></a>
<span class="sourceLineNo">063</span> if (currentNode.getNodeType() == Node.ELEMENT_NODE) {<a name="line.63"></a>
<span class="sourceLineNo">064</span> Element currentElement = (Element) currentNode;<a name="line.64"></a>
<span class="sourceLineNo">065</span> if (currentElement.getTagName().equals(PARAM_TAG)) {<a name="line.65"></a>
<span class="sourceLineNo">066</span> if (PATTERN.equalsIgnoreCase(currentElement.getAttribute("name"))) {<a name="line.66"></a>
<span class="sourceLineNo">067</span> pattern = currentElement.getAttribute("value");<a name="line.67"></a>
<span class="sourceLineNo">068</span> break;<a name="line.68"></a>
<span class="sourceLineNo">069</span> }<a name="line.69"></a>
<span class="sourceLineNo">070</span> }<a name="line.70"></a>
<span class="sourceLineNo">071</span> }<a name="line.71"></a>
<span class="sourceLineNo">072</span> }<a name="line.72"></a>
<span class="sourceLineNo">073</span> return createLayout(pattern, config);<a name="line.73"></a>
<span class="sourceLineNo">074</span> }<a name="line.74"></a>
<span class="sourceLineNo">075</span><a name="line.75"></a>
<span class="sourceLineNo">076</span> @Override<a name="line.76"></a>
<span class="sourceLineNo">077</span> public Layout parseLayout(final PropertiesConfiguration config) {<a name="line.77"></a>
<span class="sourceLineNo">078</span> String pattern = getProperty(PATTERN);<a name="line.78"></a>
<span class="sourceLineNo">079</span> return createLayout(pattern, config);<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> private Layout createLayout(String pattern, final Log4j1Configuration config) {<a name="line.82"></a>
<span class="sourceLineNo">083</span> if (pattern == null) {<a name="line.83"></a>
<span class="sourceLineNo">084</span> LOGGER.info("No pattern provided for pattern layout, using default pattern");<a name="line.84"></a>
<span class="sourceLineNo">085</span> pattern = PatternLayout.DEFAULT_CONVERSION_PATTERN;<a name="line.85"></a>
<span class="sourceLineNo">086</span> }<a name="line.86"></a>
<span class="sourceLineNo">087</span> return new LayoutWrapper(PatternLayout.newBuilder()<a name="line.87"></a>
<span class="sourceLineNo">088</span> .withPattern(pattern<a name="line.88"></a>
<span class="sourceLineNo">089</span> // Log4j 2's %x (NDC) is not compatible with Log4j 1's<a name="line.89"></a>
<span class="sourceLineNo">090</span> // %x<a name="line.90"></a>
<span class="sourceLineNo">091</span> // Log4j 1: "foo bar baz"<a name="line.91"></a>
<span class="sourceLineNo">092</span> // Log4j 2: "[foo, bar, baz]"<a name="line.92"></a>
<span class="sourceLineNo">093</span> // Use %ndc to get the Log4j 1 format<a name="line.93"></a>
<span class="sourceLineNo">094</span> .replace("%x", "%ndc")<a name="line.94"></a>
<span class="sourceLineNo">095</span><a name="line.95"></a>
<span class="sourceLineNo">096</span> // Log4j 2's %X (MDC) is not compatible with Log4j 1's<a name="line.96"></a>
<span class="sourceLineNo">097</span> // %X<a name="line.97"></a>
<span class="sourceLineNo">098</span> // Log4j 1: "{{foo,bar}{hoo,boo}}"<a name="line.98"></a>
<span class="sourceLineNo">099</span> // Log4j 2: "{foo=bar,hoo=boo}"<a name="line.99"></a>
<span class="sourceLineNo">100</span> // Use %properties to get the Log4j 1 format<a name="line.100"></a>
<span class="sourceLineNo">101</span> .replace("%X", "%properties"))<a name="line.101"></a>
<span class="sourceLineNo">102</span> .withConfiguration(config)<a name="line.102"></a>
<span class="sourceLineNo">103</span> .build());<a name="line.103"></a>
<span class="sourceLineNo">104</span> }<a name="line.104"></a>
<span class="sourceLineNo">105</span>}<a name="line.105"></a>
</pre>
</div>
</body>
</html>