Google Git
Sign in
apache / logging-log4j-site / 9755b12b39efbc0142688f9b1a11ec68db89f97b / . / 2.13.0 / log4j-api / apidocs / src-html / org / apache / logging / log4j / spi / ThreadContextMapFactory.html
blob: ab59f49ee5e3ccbc1413e031a4e7b199ab28c026 [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.logging.log4j.spi;<a name="line.17"></a>
<span class="sourceLineNo">018</span><a name="line.18"></a>
<span class="sourceLineNo">019</span>import org.apache.logging.log4j.LogManager;<a name="line.19"></a>
<span class="sourceLineNo">020</span>import org.apache.logging.log4j.Logger;<a name="line.20"></a>
<span class="sourceLineNo">021</span>import org.apache.logging.log4j.ThreadContext;<a name="line.21"></a>
<span class="sourceLineNo">022</span>import org.apache.logging.log4j.status.StatusLogger;<a name="line.22"></a>
<span class="sourceLineNo">023</span>import org.apache.logging.log4j.util.Constants;<a name="line.23"></a>
<span class="sourceLineNo">024</span>import org.apache.logging.log4j.util.PropertiesUtil;<a name="line.24"></a>
<span class="sourceLineNo">025</span>import org.apache.logging.log4j.util.ProviderUtil;<a name="line.25"></a>
<span class="sourceLineNo">026</span><a name="line.26"></a>
<span class="sourceLineNo">027</span>/**<a name="line.27"></a>
<span class="sourceLineNo">028</span> * Creates the ThreadContextMap instance used by the ThreadContext.<a name="line.28"></a>
<span class="sourceLineNo">029</span> * &lt;p&gt;<a name="line.29"></a>
<span class="sourceLineNo">030</span> * If {@link Constants#ENABLE_THREADLOCALS Log4j can use ThreadLocals}, a garbage-free StringMap-based context map can<a name="line.30"></a>
<span class="sourceLineNo">031</span> * be installed by setting system property {@code log4j2.garbagefree.threadContextMap} to {@code true}.<a name="line.31"></a>
<span class="sourceLineNo">032</span> * &lt;/p&gt;&lt;p&gt;<a name="line.32"></a>
<span class="sourceLineNo">033</span> * Furthermore, any custom {@code ThreadContextMap} can be installed by setting system property<a name="line.33"></a>
<span class="sourceLineNo">034</span> * {@code log4j2.threadContextMap} to the fully qualified class name of the class implementing the<a name="line.34"></a>
<span class="sourceLineNo">035</span> * {@code ThreadContextMap} interface. (Also implement the {@code ReadOnlyThreadContextMap} interface if your custom<a name="line.35"></a>
<span class="sourceLineNo">036</span> * {@code ThreadContextMap} implementation should be accessible to applications via the<a name="line.36"></a>
<span class="sourceLineNo">037</span> * {@link ThreadContext#getThreadContextMap()} method.)<a name="line.37"></a>
<span class="sourceLineNo">038</span> * &lt;/p&gt;&lt;p&gt;<a name="line.38"></a>
<span class="sourceLineNo">039</span> * Instead of system properties, the above can also be specified in a properties file named<a name="line.39"></a>
<span class="sourceLineNo">040</span> * {@code log4j2.component.properties} in the classpath.<a name="line.40"></a>
<span class="sourceLineNo">041</span> * &lt;/p&gt;<a name="line.41"></a>
<span class="sourceLineNo">042</span> *<a name="line.42"></a>
<span class="sourceLineNo">043</span> * @see ThreadContextMap<a name="line.43"></a>
<span class="sourceLineNo">044</span> * @see ReadOnlyThreadContextMap<a name="line.44"></a>
<span class="sourceLineNo">045</span> * @see org.apache.logging.log4j.ThreadContext<a name="line.45"></a>
<span class="sourceLineNo">046</span> * @since 2.7<a name="line.46"></a>
<span class="sourceLineNo">047</span> */<a name="line.47"></a>
<span class="sourceLineNo">048</span>public final class ThreadContextMapFactory {<a name="line.48"></a>
<span class="sourceLineNo">049</span> private static final Logger LOGGER = StatusLogger.getLogger();<a name="line.49"></a>
<span class="sourceLineNo">050</span> private static final String THREAD_CONTEXT_KEY = "log4j2.threadContextMap";<a name="line.50"></a>
<span class="sourceLineNo">051</span> private static final String GC_FREE_THREAD_CONTEXT_KEY = "log4j2.garbagefree.threadContextMap";<a name="line.51"></a>
<span class="sourceLineNo">052</span> <a name="line.52"></a>
<span class="sourceLineNo">053</span> private static boolean GcFreeThreadContextKey;<a name="line.53"></a>
<span class="sourceLineNo">054</span> private static String ThreadContextMapName;<a name="line.54"></a>
<span class="sourceLineNo">055</span><a name="line.55"></a>
<span class="sourceLineNo">056</span> static {<a name="line.56"></a>
<span class="sourceLineNo">057</span> initPrivate();<a name="line.57"></a>
<span class="sourceLineNo">058</span> }<a name="line.58"></a>
<span class="sourceLineNo">059</span> <a name="line.59"></a>
<span class="sourceLineNo">060</span> /**<a name="line.60"></a>
<span class="sourceLineNo">061</span> * Initializes static variables based on system properties. Normally called when this class is initialized by the VM<a name="line.61"></a>
<span class="sourceLineNo">062</span> * and when Log4j is reconfigured.<a name="line.62"></a>
<span class="sourceLineNo">063</span> */<a name="line.63"></a>
<span class="sourceLineNo">064</span> public static void init() {<a name="line.64"></a>
<span class="sourceLineNo">065</span> CopyOnWriteSortedArrayThreadContextMap.init();<a name="line.65"></a>
<span class="sourceLineNo">066</span> GarbageFreeSortedArrayThreadContextMap.init();<a name="line.66"></a>
<span class="sourceLineNo">067</span> DefaultThreadContextMap.init();<a name="line.67"></a>
<span class="sourceLineNo">068</span> initPrivate();<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> * Initializes static variables based on system properties. Normally called when this class is initialized by the VM<a name="line.72"></a>
<span class="sourceLineNo">073</span> * and when Log4j is reconfigured.<a name="line.73"></a>
<span class="sourceLineNo">074</span> */<a name="line.74"></a>
<span class="sourceLineNo">075</span> private static void initPrivate() {<a name="line.75"></a>
<span class="sourceLineNo">076</span> final PropertiesUtil properties = PropertiesUtil.getProperties();<a name="line.76"></a>
<span class="sourceLineNo">077</span> ThreadContextMapName = properties.getStringProperty(THREAD_CONTEXT_KEY);<a name="line.77"></a>
<span class="sourceLineNo">078</span> GcFreeThreadContextKey = properties.getBooleanProperty(GC_FREE_THREAD_CONTEXT_KEY);<a name="line.78"></a>
<span class="sourceLineNo">079</span> }<a name="line.79"></a>
<span class="sourceLineNo">080</span> <a name="line.80"></a>
<span class="sourceLineNo">081</span> private ThreadContextMapFactory() {<a name="line.81"></a>
<span class="sourceLineNo">082</span> }<a name="line.82"></a>
<span class="sourceLineNo">083</span><a name="line.83"></a>
<span class="sourceLineNo">084</span> public static ThreadContextMap createThreadContextMap() {<a name="line.84"></a>
<span class="sourceLineNo">085</span> final ClassLoader cl = ProviderUtil.findClassLoader();<a name="line.85"></a>
<span class="sourceLineNo">086</span> ThreadContextMap result = null;<a name="line.86"></a>
<span class="sourceLineNo">087</span> if (ThreadContextMapName != null) {<a name="line.87"></a>
<span class="sourceLineNo">088</span> try {<a name="line.88"></a>
<span class="sourceLineNo">089</span> final Class&lt;?&gt; clazz = cl.loadClass(ThreadContextMapName);<a name="line.89"></a>
<span class="sourceLineNo">090</span> if (ThreadContextMap.class.isAssignableFrom(clazz)) {<a name="line.90"></a>
<span class="sourceLineNo">091</span> result = (ThreadContextMap) clazz.newInstance();<a name="line.91"></a>
<span class="sourceLineNo">092</span> }<a name="line.92"></a>
<span class="sourceLineNo">093</span> } catch (final ClassNotFoundException cnfe) {<a name="line.93"></a>
<span class="sourceLineNo">094</span> LOGGER.error("Unable to locate configured ThreadContextMap {}", ThreadContextMapName);<a name="line.94"></a>
<span class="sourceLineNo">095</span> } catch (final Exception ex) {<a name="line.95"></a>
<span class="sourceLineNo">096</span> LOGGER.error("Unable to create configured ThreadContextMap {}", ThreadContextMapName, ex);<a name="line.96"></a>
<span class="sourceLineNo">097</span> }<a name="line.97"></a>
<span class="sourceLineNo">098</span> }<a name="line.98"></a>
<span class="sourceLineNo">099</span> if (result == null &amp;&amp; ProviderUtil.hasProviders() &amp;&amp; LogManager.getFactory() != null) { //LOG4J2-1658<a name="line.99"></a>
<span class="sourceLineNo">100</span> final String factoryClassName = LogManager.getFactory().getClass().getName();<a name="line.100"></a>
<span class="sourceLineNo">101</span> for (final Provider provider : ProviderUtil.getProviders()) {<a name="line.101"></a>
<span class="sourceLineNo">102</span> if (factoryClassName.equals(provider.getClassName())) {<a name="line.102"></a>
<span class="sourceLineNo">103</span> final Class&lt;? extends ThreadContextMap&gt; clazz = provider.loadThreadContextMap();<a name="line.103"></a>
<span class="sourceLineNo">104</span> if (clazz != null) {<a name="line.104"></a>
<span class="sourceLineNo">105</span> try {<a name="line.105"></a>
<span class="sourceLineNo">106</span> result = clazz.newInstance();<a name="line.106"></a>
<span class="sourceLineNo">107</span> break;<a name="line.107"></a>
<span class="sourceLineNo">108</span> } catch (final Exception e) {<a name="line.108"></a>
<span class="sourceLineNo">109</span> LOGGER.error("Unable to locate or load configured ThreadContextMap {}",<a name="line.109"></a>
<span class="sourceLineNo">110</span> provider.getThreadContextMap(), e);<a name="line.110"></a>
<span class="sourceLineNo">111</span> result = createDefaultThreadContextMap();<a name="line.111"></a>
<span class="sourceLineNo">112</span> }<a name="line.112"></a>
<span class="sourceLineNo">113</span> }<a name="line.113"></a>
<span class="sourceLineNo">114</span> }<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 (result == null) {<a name="line.117"></a>
<span class="sourceLineNo">118</span> result = createDefaultThreadContextMap();<a name="line.118"></a>
<span class="sourceLineNo">119</span> }<a name="line.119"></a>
<span class="sourceLineNo">120</span> return result;<a name="line.120"></a>
<span class="sourceLineNo">121</span> }<a name="line.121"></a>
<span class="sourceLineNo">122</span><a name="line.122"></a>
<span class="sourceLineNo">123</span> private static ThreadContextMap createDefaultThreadContextMap() {<a name="line.123"></a>
<span class="sourceLineNo">124</span> if (Constants.ENABLE_THREADLOCALS) {<a name="line.124"></a>
<span class="sourceLineNo">125</span> if (GcFreeThreadContextKey) {<a name="line.125"></a>
<span class="sourceLineNo">126</span> return new GarbageFreeSortedArrayThreadContextMap();<a name="line.126"></a>
<span class="sourceLineNo">127</span> }<a name="line.127"></a>
<span class="sourceLineNo">128</span> return new CopyOnWriteSortedArrayThreadContextMap();<a name="line.128"></a>
<span class="sourceLineNo">129</span> }<a name="line.129"></a>
<span class="sourceLineNo">130</span> return new DefaultThreadContextMap(true);<a name="line.130"></a>
<span class="sourceLineNo">131</span> }<a name="line.131"></a>
<span class="sourceLineNo">132</span>}<a name="line.132"></a>
</pre>
</div>
</body>
</html>