blob: 006f6672fbd60c396d9e9e3f54be035e0bb9991b [file] [log] [blame]
<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.pattern;<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.plugins.Plugin;<a name="line.20"></a>
<FONT color="green">021</FONT> <a name="line.21"></a>
<FONT color="green">022</FONT> import java.util.Map;<a name="line.22"></a>
<FONT color="green">023</FONT> import java.util.Set;<a name="line.23"></a>
<FONT color="green">024</FONT> import java.util.TreeSet;<a name="line.24"></a>
<FONT color="green">025</FONT> <a name="line.25"></a>
<FONT color="green">026</FONT> /**<a name="line.26"></a>
<FONT color="green">027</FONT> * Able to handle the contents of the LogEvent's MDC and either<a name="line.27"></a>
<FONT color="green">028</FONT> * output the entire contents of the properties in a similar format to the<a name="line.28"></a>
<FONT color="green">029</FONT> * java.util.Hashtable.toString(), or to output the value of a specific key<a name="line.29"></a>
<FONT color="green">030</FONT> * within the property bundle<a name="line.30"></a>
<FONT color="green">031</FONT> * when this pattern converter has the option set.<a name="line.31"></a>
<FONT color="green">032</FONT> */<a name="line.32"></a>
<FONT color="green">033</FONT> @Plugin(name = "MDCPatternConverter", type = "Converter")<a name="line.33"></a>
<FONT color="green">034</FONT> @ConverterKeys({"X", "mdc", "MDC" })<a name="line.34"></a>
<FONT color="green">035</FONT> public final class MDCPatternConverter extends LogEventPatternConverter {<a name="line.35"></a>
<FONT color="green">036</FONT> /**<a name="line.36"></a>
<FONT color="green">037</FONT> * Name of property to output.<a name="line.37"></a>
<FONT color="green">038</FONT> */<a name="line.38"></a>
<FONT color="green">039</FONT> private final String key;<a name="line.39"></a>
<FONT color="green">040</FONT> <a name="line.40"></a>
<FONT color="green">041</FONT> /**<a name="line.41"></a>
<FONT color="green">042</FONT> * Private constructor.<a name="line.42"></a>
<FONT color="green">043</FONT> *<a name="line.43"></a>
<FONT color="green">044</FONT> * @param options options, may be null.<a name="line.44"></a>
<FONT color="green">045</FONT> */<a name="line.45"></a>
<FONT color="green">046</FONT> private MDCPatternConverter(final String[] options) {<a name="line.46"></a>
<FONT color="green">047</FONT> super(((options != null) &amp;&amp; (options.length &gt; 0)) ? ("MDC{" + options[0] + "}") : "MDC", "mdc");<a name="line.47"></a>
<FONT color="green">048</FONT> key = (options != null &amp;&amp; options.length &gt; 0) ? options[0] : null;<a name="line.48"></a>
<FONT color="green">049</FONT> }<a name="line.49"></a>
<FONT color="green">050</FONT> <a name="line.50"></a>
<FONT color="green">051</FONT> /**<a name="line.51"></a>
<FONT color="green">052</FONT> * Obtains an instance of PropertiesPatternConverter.<a name="line.52"></a>
<FONT color="green">053</FONT> *<a name="line.53"></a>
<FONT color="green">054</FONT> * @param options options, may be null or first element contains name of property to format.<a name="line.54"></a>
<FONT color="green">055</FONT> * @return instance of PropertiesPatternConverter.<a name="line.55"></a>
<FONT color="green">056</FONT> */<a name="line.56"></a>
<FONT color="green">057</FONT> public static MDCPatternConverter newInstance(final String[] options) {<a name="line.57"></a>
<FONT color="green">058</FONT> return new MDCPatternConverter(options);<a name="line.58"></a>
<FONT color="green">059</FONT> }<a name="line.59"></a>
<FONT color="green">060</FONT> <a name="line.60"></a>
<FONT color="green">061</FONT> /**<a name="line.61"></a>
<FONT color="green">062</FONT> * {@inheritDoc}<a name="line.62"></a>
<FONT color="green">063</FONT> */<a name="line.63"></a>
<FONT color="green">064</FONT> public void format(final LogEvent event, final StringBuilder toAppendTo) {<a name="line.64"></a>
<FONT color="green">065</FONT> Map&lt;String, String&gt; contextMap = event.getContextMap();<a name="line.65"></a>
<FONT color="green">066</FONT> // if there is no additional options, we output every single<a name="line.66"></a>
<FONT color="green">067</FONT> // Key/Value pair for the MDC in a similar format to Hashtable.toString()<a name="line.67"></a>
<FONT color="green">068</FONT> if (key == null) {<a name="line.68"></a>
<FONT color="green">069</FONT> <a name="line.69"></a>
<FONT color="green">070</FONT> <a name="line.70"></a>
<FONT color="green">071</FONT> if (contextMap == null || contextMap.size() == 0) {<a name="line.71"></a>
<FONT color="green">072</FONT> toAppendTo.append("{}");<a name="line.72"></a>
<FONT color="green">073</FONT> return;<a name="line.73"></a>
<FONT color="green">074</FONT> }<a name="line.74"></a>
<FONT color="green">075</FONT> StringBuilder sb = new StringBuilder("{");<a name="line.75"></a>
<FONT color="green">076</FONT> Set&lt;String&gt; keys = new TreeSet&lt;String&gt;(contextMap.keySet());<a name="line.76"></a>
<FONT color="green">077</FONT> for (String key : keys) {<a name="line.77"></a>
<FONT color="green">078</FONT> if (sb.length() &gt; 1) {<a name="line.78"></a>
<FONT color="green">079</FONT> sb.append(", ");<a name="line.79"></a>
<FONT color="green">080</FONT> }<a name="line.80"></a>
<FONT color="green">081</FONT> sb.append(key).append("=").append(contextMap.get(key));<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> sb.append("}");<a name="line.84"></a>
<FONT color="green">085</FONT> toAppendTo.append(sb);<a name="line.85"></a>
<FONT color="green">086</FONT> } else if (contextMap != null) {<a name="line.86"></a>
<FONT color="green">087</FONT> // otherwise they just want a single key output<a name="line.87"></a>
<FONT color="green">088</FONT> Object val = contextMap.get(key);<a name="line.88"></a>
<FONT color="green">089</FONT> <a name="line.89"></a>
<FONT color="green">090</FONT> if (val != null) {<a name="line.90"></a>
<FONT color="green">091</FONT> toAppendTo.append(val);<a name="line.91"></a>
<FONT color="green">092</FONT> }<a name="line.92"></a>
<FONT color="green">093</FONT> }<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>
</PRE>
</BODY>
</HTML>