| <!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><a name="line.17"></a> |
| <span class="sourceLineNo">018</span>package org.apache.logging.log4j;<a name="line.18"></a> |
| <span class="sourceLineNo">019</span><a name="line.19"></a> |
| <span class="sourceLineNo">020</span>import java.io.Serializable;<a name="line.20"></a> |
| <span class="sourceLineNo">021</span>import java.util.ArrayList;<a name="line.21"></a> |
| <span class="sourceLineNo">022</span>import java.util.Collection;<a name="line.22"></a> |
| <span class="sourceLineNo">023</span>import java.util.Collections;<a name="line.23"></a> |
| <span class="sourceLineNo">024</span>import java.util.Iterator;<a name="line.24"></a> |
| <span class="sourceLineNo">025</span>import java.util.List;<a name="line.25"></a> |
| <span class="sourceLineNo">026</span>import java.util.Map;<a name="line.26"></a> |
| <span class="sourceLineNo">027</span><a name="line.27"></a> |
| <span class="sourceLineNo">028</span>import org.apache.logging.log4j.message.ParameterizedMessage;<a name="line.28"></a> |
| <span class="sourceLineNo">029</span>import org.apache.logging.log4j.spi.DefaultThreadContextMap;<a name="line.29"></a> |
| <span class="sourceLineNo">030</span>import org.apache.logging.log4j.spi.DefaultThreadContextStack;<a name="line.30"></a> |
| <span class="sourceLineNo">031</span>import org.apache.logging.log4j.spi.LoggerContextFactory;<a name="line.31"></a> |
| <span class="sourceLineNo">032</span>import org.apache.logging.log4j.spi.MutableThreadContextStack;<a name="line.32"></a> |
| <span class="sourceLineNo">033</span>import org.apache.logging.log4j.spi.Provider;<a name="line.33"></a> |
| <span class="sourceLineNo">034</span>import org.apache.logging.log4j.spi.ThreadContextMap;<a name="line.34"></a> |
| <span class="sourceLineNo">035</span>import org.apache.logging.log4j.spi.ThreadContextStack;<a name="line.35"></a> |
| <span class="sourceLineNo">036</span>import org.apache.logging.log4j.status.StatusLogger;<a name="line.36"></a> |
| <span class="sourceLineNo">037</span>import org.apache.logging.log4j.util.PropertiesUtil;<a name="line.37"></a> |
| <span class="sourceLineNo">038</span>import org.apache.logging.log4j.util.ProviderUtil;<a name="line.38"></a> |
| <span class="sourceLineNo">039</span><a name="line.39"></a> |
| <span class="sourceLineNo">040</span>/**<a name="line.40"></a> |
| <span class="sourceLineNo">041</span> * The ThreadContext allows applications to store information either in a Map or a Stack.<a name="line.41"></a> |
| <span class="sourceLineNo">042</span> * <p><a name="line.42"></a> |
| <span class="sourceLineNo">043</span> * <b><em>The MDC is managed on a per thread basis</em></b>. A child thread automatically inherits a <em>copy</em> of<a name="line.43"></a> |
| <span class="sourceLineNo">044</span> * the mapped diagnostic context of its parent.<a name="line.44"></a> |
| <span class="sourceLineNo">045</span> * </p><a name="line.45"></a> |
| <span class="sourceLineNo">046</span> */<a name="line.46"></a> |
| <span class="sourceLineNo">047</span>public final class ThreadContext {<a name="line.47"></a> |
| <span class="sourceLineNo">048</span><a name="line.48"></a> |
| <span class="sourceLineNo">049</span> /**<a name="line.49"></a> |
| <span class="sourceLineNo">050</span> * Empty, immutable Map.<a name="line.50"></a> |
| <span class="sourceLineNo">051</span> */<a name="line.51"></a> |
| <span class="sourceLineNo">052</span> public static final Map<String, String> EMPTY_MAP = Collections.emptyMap();<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> * Empty, immutable ContextStack.<a name="line.55"></a> |
| <span class="sourceLineNo">056</span> */<a name="line.56"></a> |
| <span class="sourceLineNo">057</span> public static final ThreadContextStack EMPTY_STACK = new MutableThreadContextStack(new ArrayList<String>());<a name="line.57"></a> |
| <span class="sourceLineNo">058</span><a name="line.58"></a> |
| <span class="sourceLineNo">059</span> private static final String DISABLE_MAP = "disableThreadContextMap";<a name="line.59"></a> |
| <span class="sourceLineNo">060</span> private static final String DISABLE_STACK = "disableThreadContextStack";<a name="line.60"></a> |
| <span class="sourceLineNo">061</span> private static final String DISABLE_ALL = "disableThreadContext";<a name="line.61"></a> |
| <span class="sourceLineNo">062</span> private static final String THREAD_CONTEXT_KEY = "log4j2.threadContextMap";<a name="line.62"></a> |
| <span class="sourceLineNo">063</span><a name="line.63"></a> |
| <span class="sourceLineNo">064</span> private static boolean all;<a name="line.64"></a> |
| <span class="sourceLineNo">065</span> private static boolean useMap;<a name="line.65"></a> |
| <span class="sourceLineNo">066</span> private static boolean useStack;<a name="line.66"></a> |
| <span class="sourceLineNo">067</span> private static ThreadContextMap contextMap;<a name="line.67"></a> |
| <span class="sourceLineNo">068</span> private static ThreadContextStack contextStack;<a name="line.68"></a> |
| <span class="sourceLineNo">069</span> private static final Logger LOGGER = StatusLogger.getLogger();<a name="line.69"></a> |
| <span class="sourceLineNo">070</span><a name="line.70"></a> |
| <span class="sourceLineNo">071</span> static {<a name="line.71"></a> |
| <span class="sourceLineNo">072</span> final PropertiesUtil managerProps = PropertiesUtil.getProperties();<a name="line.72"></a> |
| <span class="sourceLineNo">073</span> all = managerProps.getBooleanProperty(DISABLE_ALL);<a name="line.73"></a> |
| <span class="sourceLineNo">074</span> useStack = !(managerProps.getBooleanProperty(DISABLE_STACK) || all);<a name="line.74"></a> |
| <span class="sourceLineNo">075</span> contextStack = new DefaultThreadContextStack(useStack);<a name="line.75"></a> |
| <span class="sourceLineNo">076</span><a name="line.76"></a> |
| <span class="sourceLineNo">077</span> useMap = !(managerProps.getBooleanProperty(DISABLE_MAP) || all);<a name="line.77"></a> |
| <span class="sourceLineNo">078</span> String threadContextMapName = managerProps.getStringProperty(THREAD_CONTEXT_KEY);<a name="line.78"></a> |
| <span class="sourceLineNo">079</span> final ClassLoader cl = ProviderUtil.findClassLoader();<a name="line.79"></a> |
| <span class="sourceLineNo">080</span> if (threadContextMapName != null) {<a name="line.80"></a> |
| <span class="sourceLineNo">081</span> try {<a name="line.81"></a> |
| <span class="sourceLineNo">082</span> final Class<?> clazz = cl.loadClass(threadContextMapName);<a name="line.82"></a> |
| <span class="sourceLineNo">083</span> if (ThreadContextMap.class.isAssignableFrom(clazz)) {<a name="line.83"></a> |
| <span class="sourceLineNo">084</span> contextMap = (ThreadContextMap) clazz.newInstance();<a name="line.84"></a> |
| <span class="sourceLineNo">085</span> }<a name="line.85"></a> |
| <span class="sourceLineNo">086</span> } catch (final ClassNotFoundException cnfe) {<a name="line.86"></a> |
| <span class="sourceLineNo">087</span> LOGGER.error("Unable to locate configured LoggerContextFactory {}", threadContextMapName);<a name="line.87"></a> |
| <span class="sourceLineNo">088</span> } catch (final Exception ex) {<a name="line.88"></a> |
| <span class="sourceLineNo">089</span> LOGGER.error("Unable to create configured LoggerContextFactory {}", threadContextMapName, ex);<a name="line.89"></a> |
| <span class="sourceLineNo">090</span> }<a name="line.90"></a> |
| <span class="sourceLineNo">091</span> }<a name="line.91"></a> |
| <span class="sourceLineNo">092</span> if (contextMap == null && ProviderUtil.hasProviders()) {<a name="line.92"></a> |
| <span class="sourceLineNo">093</span> final LoggerContextFactory factory = LogManager.getFactory();<a name="line.93"></a> |
| <span class="sourceLineNo">094</span> final Iterator<Provider> providers = ProviderUtil.getProviders();<a name="line.94"></a> |
| <span class="sourceLineNo">095</span> while (providers.hasNext()) {<a name="line.95"></a> |
| <span class="sourceLineNo">096</span> final Provider provider = providers.next();<a name="line.96"></a> |
| <span class="sourceLineNo">097</span> threadContextMapName = provider.getThreadContextMap();<a name="line.97"></a> |
| <span class="sourceLineNo">098</span> final String factoryClassName = provider.getClassName();<a name="line.98"></a> |
| <span class="sourceLineNo">099</span> if (threadContextMapName != null && factory.getClass().getName().equals(factoryClassName)) {<a name="line.99"></a> |
| <span class="sourceLineNo">100</span> try {<a name="line.100"></a> |
| <span class="sourceLineNo">101</span> final Class<?> clazz = cl.loadClass(threadContextMapName);<a name="line.101"></a> |
| <span class="sourceLineNo">102</span> if (ThreadContextMap.class.isAssignableFrom(clazz)) {<a name="line.102"></a> |
| <span class="sourceLineNo">103</span> contextMap = (ThreadContextMap) clazz.newInstance();<a name="line.103"></a> |
| <span class="sourceLineNo">104</span> break;<a name="line.104"></a> |
| <span class="sourceLineNo">105</span> }<a name="line.105"></a> |
| <span class="sourceLineNo">106</span> } catch (final ClassNotFoundException cnfe) {<a name="line.106"></a> |
| <span class="sourceLineNo">107</span> LOGGER.error("Unable to locate configured LoggerContextFactory {}", threadContextMapName);<a name="line.107"></a> |
| <span class="sourceLineNo">108</span> contextMap = new DefaultThreadContextMap(useMap);<a name="line.108"></a> |
| <span class="sourceLineNo">109</span> } catch (final Exception ex) {<a name="line.109"></a> |
| <span class="sourceLineNo">110</span> LOGGER.error("Unable to create configured LoggerContextFactory {}", threadContextMapName, ex);<a name="line.110"></a> |
| <span class="sourceLineNo">111</span> contextMap = new DefaultThreadContextMap(useMap);<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> if (contextMap == null) {<a name="line.116"></a> |
| <span class="sourceLineNo">117</span> contextMap = new DefaultThreadContextMap(useMap);<a name="line.117"></a> |
| <span class="sourceLineNo">118</span> }<a name="line.118"></a> |
| <span class="sourceLineNo">119</span> }<a name="line.119"></a> |
| <span class="sourceLineNo">120</span><a name="line.120"></a> |
| <span class="sourceLineNo">121</span> private ThreadContext() {<a name="line.121"></a> |
| <span class="sourceLineNo">122</span><a name="line.122"></a> |
| <span class="sourceLineNo">123</span> }<a name="line.123"></a> |
| <span class="sourceLineNo">124</span><a name="line.124"></a> |
| <span class="sourceLineNo">125</span> /**<a name="line.125"></a> |
| <span class="sourceLineNo">126</span> * Put a context value (the <code>value</code> parameter) as identified<a name="line.126"></a> |
| <span class="sourceLineNo">127</span> * with the <code>key</code> parameter into the current thread's<a name="line.127"></a> |
| <span class="sourceLineNo">128</span> * context map.<a name="line.128"></a> |
| <span class="sourceLineNo">129</span> * <p/><a name="line.129"></a> |
| <span class="sourceLineNo">130</span> * <p>If the current thread does not have a context map it is<a name="line.130"></a> |
| <span class="sourceLineNo">131</span> * created as a side effect.<a name="line.131"></a> |
| <span class="sourceLineNo">132</span> * @param key The key name.<a name="line.132"></a> |
| <span class="sourceLineNo">133</span> * @param value The key value.<a name="line.133"></a> |
| <span class="sourceLineNo">134</span> */<a name="line.134"></a> |
| <span class="sourceLineNo">135</span> public static void put(final String key, final String value) {<a name="line.135"></a> |
| <span class="sourceLineNo">136</span> contextMap.put(key, value);<a name="line.136"></a> |
| <span class="sourceLineNo">137</span> }<a name="line.137"></a> |
| <span class="sourceLineNo">138</span><a name="line.138"></a> |
| <span class="sourceLineNo">139</span> /**<a name="line.139"></a> |
| <span class="sourceLineNo">140</span> * Get the context value identified by the <code>key</code> parameter.<a name="line.140"></a> |
| <span class="sourceLineNo">141</span> * <p/><a name="line.141"></a> |
| <span class="sourceLineNo">142</span> * <p>This method has no side effects.<a name="line.142"></a> |
| <span class="sourceLineNo">143</span> * @param key The key to locate.<a name="line.143"></a> |
| <span class="sourceLineNo">144</span> * @return The value associated with the key or null.<a name="line.144"></a> |
| <span class="sourceLineNo">145</span> */<a name="line.145"></a> |
| <span class="sourceLineNo">146</span> public static String get(final String key) {<a name="line.146"></a> |
| <span class="sourceLineNo">147</span> return contextMap.get(key);<a name="line.147"></a> |
| <span class="sourceLineNo">148</span> }<a name="line.148"></a> |
| <span class="sourceLineNo">149</span><a name="line.149"></a> |
| <span class="sourceLineNo">150</span> /**<a name="line.150"></a> |
| <span class="sourceLineNo">151</span> * Remove the context value identified by the <code>key</code> parameter.<a name="line.151"></a> |
| <span class="sourceLineNo">152</span> * @param key The key to remove.<a name="line.152"></a> |
| <span class="sourceLineNo">153</span> */<a name="line.153"></a> |
| <span class="sourceLineNo">154</span> public static void remove(final String key) {<a name="line.154"></a> |
| <span class="sourceLineNo">155</span> contextMap.remove(key);<a name="line.155"></a> |
| <span class="sourceLineNo">156</span> }<a name="line.156"></a> |
| <span class="sourceLineNo">157</span><a name="line.157"></a> |
| <span class="sourceLineNo">158</span> /**<a name="line.158"></a> |
| <span class="sourceLineNo">159</span> * Clear the context.<a name="line.159"></a> |
| <span class="sourceLineNo">160</span> */<a name="line.160"></a> |
| <span class="sourceLineNo">161</span> public static void clear() {<a name="line.161"></a> |
| <span class="sourceLineNo">162</span> contextMap.clear();<a name="line.162"></a> |
| <span class="sourceLineNo">163</span> }<a name="line.163"></a> |
| <span class="sourceLineNo">164</span><a name="line.164"></a> |
| <span class="sourceLineNo">165</span> /**<a name="line.165"></a> |
| <span class="sourceLineNo">166</span> * Determine if the key is in the context.<a name="line.166"></a> |
| <span class="sourceLineNo">167</span> * @param key The key to locate.<a name="line.167"></a> |
| <span class="sourceLineNo">168</span> * @return True if the key is in the context, false otherwise.<a name="line.168"></a> |
| <span class="sourceLineNo">169</span> */<a name="line.169"></a> |
| <span class="sourceLineNo">170</span> public static boolean containsKey(final String key) {<a name="line.170"></a> |
| <span class="sourceLineNo">171</span> return contextMap.containsKey(key);<a name="line.171"></a> |
| <span class="sourceLineNo">172</span> }<a name="line.172"></a> |
| <span class="sourceLineNo">173</span><a name="line.173"></a> |
| <span class="sourceLineNo">174</span> /**<a name="line.174"></a> |
| <span class="sourceLineNo">175</span> * Returns a mutable copy of current thread's context Map.<a name="line.175"></a> |
| <span class="sourceLineNo">176</span> * @return a mutable copy of the context.<a name="line.176"></a> |
| <span class="sourceLineNo">177</span> */<a name="line.177"></a> |
| <span class="sourceLineNo">178</span> public static Map<String, String> getContext() {<a name="line.178"></a> |
| <span class="sourceLineNo">179</span> return contextMap.getCopy();<a name="line.179"></a> |
| <span class="sourceLineNo">180</span> }<a name="line.180"></a> |
| <span class="sourceLineNo">181</span><a name="line.181"></a> |
| <span class="sourceLineNo">182</span> /**<a name="line.182"></a> |
| <span class="sourceLineNo">183</span> * Returns an immutable view of the current thread's context Map.<a name="line.183"></a> |
| <span class="sourceLineNo">184</span> * @return An immutable view of the ThreadContext Map.<a name="line.184"></a> |
| <span class="sourceLineNo">185</span> */<a name="line.185"></a> |
| <span class="sourceLineNo">186</span> public static Map<String, String> getImmutableContext() {<a name="line.186"></a> |
| <span class="sourceLineNo">187</span> final Map<String, String> map = contextMap.getImmutableMapOrNull();<a name="line.187"></a> |
| <span class="sourceLineNo">188</span> return map == null ? EMPTY_MAP : map;<a name="line.188"></a> |
| <span class="sourceLineNo">189</span> }<a name="line.189"></a> |
| <span class="sourceLineNo">190</span><a name="line.190"></a> |
| <span class="sourceLineNo">191</span> /**<a name="line.191"></a> |
| <span class="sourceLineNo">192</span> * Returns true if the Map is empty.<a name="line.192"></a> |
| <span class="sourceLineNo">193</span> * @return true if the Map is empty, false otherwise.<a name="line.193"></a> |
| <span class="sourceLineNo">194</span> */<a name="line.194"></a> |
| <span class="sourceLineNo">195</span> public static boolean isEmpty() {<a name="line.195"></a> |
| <span class="sourceLineNo">196</span> return contextMap.isEmpty();<a name="line.196"></a> |
| <span class="sourceLineNo">197</span> }<a name="line.197"></a> |
| <span class="sourceLineNo">198</span><a name="line.198"></a> |
| <span class="sourceLineNo">199</span> /**<a name="line.199"></a> |
| <span class="sourceLineNo">200</span> * Clear the stack for this thread.<a name="line.200"></a> |
| <span class="sourceLineNo">201</span> */<a name="line.201"></a> |
| <span class="sourceLineNo">202</span> public static void clearStack() {<a name="line.202"></a> |
| <span class="sourceLineNo">203</span> contextStack.clear();<a name="line.203"></a> |
| <span class="sourceLineNo">204</span> }<a name="line.204"></a> |
| <span class="sourceLineNo">205</span><a name="line.205"></a> |
| <span class="sourceLineNo">206</span> /**<a name="line.206"></a> |
| <span class="sourceLineNo">207</span> * Returns a copy of this thread's stack.<a name="line.207"></a> |
| <span class="sourceLineNo">208</span> * @return A copy of this thread's stack.<a name="line.208"></a> |
| <span class="sourceLineNo">209</span> */<a name="line.209"></a> |
| <span class="sourceLineNo">210</span> public static ContextStack cloneStack() {<a name="line.210"></a> |
| <span class="sourceLineNo">211</span> return contextStack.copy();<a name="line.211"></a> |
| <span class="sourceLineNo">212</span> }<a name="line.212"></a> |
| <span class="sourceLineNo">213</span><a name="line.213"></a> |
| <span class="sourceLineNo">214</span> /**<a name="line.214"></a> |
| <span class="sourceLineNo">215</span> * Get an immutable copy of this current thread's context stack.<a name="line.215"></a> |
| <span class="sourceLineNo">216</span> * @return an immutable copy of the ThreadContext stack.<a name="line.216"></a> |
| <span class="sourceLineNo">217</span> */<a name="line.217"></a> |
| <span class="sourceLineNo">218</span> public static ContextStack getImmutableStack() {<a name="line.218"></a> |
| <span class="sourceLineNo">219</span> return contextStack;<a name="line.219"></a> |
| <span class="sourceLineNo">220</span> }<a name="line.220"></a> |
| <span class="sourceLineNo">221</span><a name="line.221"></a> |
| <span class="sourceLineNo">222</span> /**<a name="line.222"></a> |
| <span class="sourceLineNo">223</span> * Set this thread's stack.<a name="line.223"></a> |
| <span class="sourceLineNo">224</span> * @param stack The stack to use.<a name="line.224"></a> |
| <span class="sourceLineNo">225</span> */<a name="line.225"></a> |
| <span class="sourceLineNo">226</span> public static void setStack(final Collection<String> stack) {<a name="line.226"></a> |
| <span class="sourceLineNo">227</span> if (stack.size() == 0 || !useStack) {<a name="line.227"></a> |
| <span class="sourceLineNo">228</span> return;<a name="line.228"></a> |
| <span class="sourceLineNo">229</span> }<a name="line.229"></a> |
| <span class="sourceLineNo">230</span> contextStack.clear();<a name="line.230"></a> |
| <span class="sourceLineNo">231</span> contextStack.addAll(stack);<a name="line.231"></a> |
| <span class="sourceLineNo">232</span> }<a name="line.232"></a> |
| <span class="sourceLineNo">233</span><a name="line.233"></a> |
| <span class="sourceLineNo">234</span> /**<a name="line.234"></a> |
| <span class="sourceLineNo">235</span> * Get the current nesting depth of this thread's stack.<a name="line.235"></a> |
| <span class="sourceLineNo">236</span> * @return the number of items in the stack.<a name="line.236"></a> |
| <span class="sourceLineNo">237</span> *<a name="line.237"></a> |
| <span class="sourceLineNo">238</span> * @see #trim<a name="line.238"></a> |
| <span class="sourceLineNo">239</span> */<a name="line.239"></a> |
| <span class="sourceLineNo">240</span> public static int getDepth() {<a name="line.240"></a> |
| <span class="sourceLineNo">241</span> return contextStack.getDepth();<a name="line.241"></a> |
| <span class="sourceLineNo">242</span> }<a name="line.242"></a> |
| <span class="sourceLineNo">243</span><a name="line.243"></a> |
| <span class="sourceLineNo">244</span> /**<a name="line.244"></a> |
| <span class="sourceLineNo">245</span> * Returns the value of the last item placed on the stack.<a name="line.245"></a> |
| <span class="sourceLineNo">246</span> * <p/><a name="line.246"></a> |
| <span class="sourceLineNo">247</span> * <p>The returned value is the value that was pushed last. If no<a name="line.247"></a> |
| <span class="sourceLineNo">248</span> * context is available, then the empty string "" is returned.<a name="line.248"></a> |
| <span class="sourceLineNo">249</span> *<a name="line.249"></a> |
| <span class="sourceLineNo">250</span> * @return String The innermost diagnostic context.<a name="line.250"></a> |
| <span class="sourceLineNo">251</span> */<a name="line.251"></a> |
| <span class="sourceLineNo">252</span> public static String pop() {<a name="line.252"></a> |
| <span class="sourceLineNo">253</span> return contextStack.pop();<a name="line.253"></a> |
| <span class="sourceLineNo">254</span> }<a name="line.254"></a> |
| <span class="sourceLineNo">255</span><a name="line.255"></a> |
| <span class="sourceLineNo">256</span> /**<a name="line.256"></a> |
| <span class="sourceLineNo">257</span> * Looks at the last diagnostic context at the top of this NDC<a name="line.257"></a> |
| <span class="sourceLineNo">258</span> * without removing it.<a name="line.258"></a> |
| <span class="sourceLineNo">259</span> * <p/><a name="line.259"></a> |
| <span class="sourceLineNo">260</span> * <p>The returned value is the value that was pushed last. If no<a name="line.260"></a> |
| <span class="sourceLineNo">261</span> * context is available, then the empty string "" is returned.<a name="line.261"></a> |
| <span class="sourceLineNo">262</span> *<a name="line.262"></a> |
| <span class="sourceLineNo">263</span> * @return String The innermost diagnostic context.<a name="line.263"></a> |
| <span class="sourceLineNo">264</span> */<a name="line.264"></a> |
| <span class="sourceLineNo">265</span> public static String peek() {<a name="line.265"></a> |
| <span class="sourceLineNo">266</span> return contextStack.peek();<a name="line.266"></a> |
| <span class="sourceLineNo">267</span> }<a name="line.267"></a> |
| <span class="sourceLineNo">268</span><a name="line.268"></a> |
| <span class="sourceLineNo">269</span> /**<a name="line.269"></a> |
| <span class="sourceLineNo">270</span> * Push new diagnostic context information for the current thread.<a name="line.270"></a> |
| <span class="sourceLineNo">271</span> * <p/><a name="line.271"></a> |
| <span class="sourceLineNo">272</span> * <p>The contents of the <code>message</code> parameter is<a name="line.272"></a> |
| <span class="sourceLineNo">273</span> * determined solely by the client.<a name="line.273"></a> |
| <span class="sourceLineNo">274</span> *<a name="line.274"></a> |
| <span class="sourceLineNo">275</span> * @param message The new diagnostic context information.<a name="line.275"></a> |
| <span class="sourceLineNo">276</span> */<a name="line.276"></a> |
| <span class="sourceLineNo">277</span> public static void push(final String message) {<a name="line.277"></a> |
| <span class="sourceLineNo">278</span> contextStack.push(message);<a name="line.278"></a> |
| <span class="sourceLineNo">279</span> }<a name="line.279"></a> |
| <span class="sourceLineNo">280</span> /**<a name="line.280"></a> |
| <span class="sourceLineNo">281</span> * Push new diagnostic context information for the current thread.<a name="line.281"></a> |
| <span class="sourceLineNo">282</span> * <p/><a name="line.282"></a> |
| <span class="sourceLineNo">283</span> * <p>The contents of the <code>message</code> and args parameters are<a name="line.283"></a> |
| <span class="sourceLineNo">284</span> * determined solely by the client. The message will be treated as a format String<a name="line.284"></a> |
| <span class="sourceLineNo">285</span> * and tokens will be replaced with the String value of the arguments in accordance<a name="line.285"></a> |
| <span class="sourceLineNo">286</span> * with ParameterizedMessage.<a name="line.286"></a> |
| <span class="sourceLineNo">287</span> *<a name="line.287"></a> |
| <span class="sourceLineNo">288</span> * @param message The new diagnostic context information.<a name="line.288"></a> |
| <span class="sourceLineNo">289</span> * @param args Parameters for the message.<a name="line.289"></a> |
| <span class="sourceLineNo">290</span> */<a name="line.290"></a> |
| <span class="sourceLineNo">291</span> public static void push(final String message, final Object... args) {<a name="line.291"></a> |
| <span class="sourceLineNo">292</span> contextStack.push(ParameterizedMessage.format(message, args));<a name="line.292"></a> |
| <span class="sourceLineNo">293</span> }<a name="line.293"></a> |
| <span class="sourceLineNo">294</span><a name="line.294"></a> |
| <span class="sourceLineNo">295</span> /**<a name="line.295"></a> |
| <span class="sourceLineNo">296</span> * Remove the diagnostic context for this thread.<a name="line.296"></a> |
| <span class="sourceLineNo">297</span> * <p/><a name="line.297"></a> |
| <span class="sourceLineNo">298</span> * <p>Each thread that created a diagnostic context by calling<a name="line.298"></a> |
| <span class="sourceLineNo">299</span> * {@link #push} should call this method before exiting. Otherwise,<a name="line.299"></a> |
| <span class="sourceLineNo">300</span> * the memory used by the <b>thread</b> cannot be reclaimed by the<a name="line.300"></a> |
| <span class="sourceLineNo">301</span> * VM.<a name="line.301"></a> |
| <span class="sourceLineNo">302</span> * <p/><a name="line.302"></a> |
| <span class="sourceLineNo">303</span> * <p>As this is such an important problem in heavy duty systems and<a name="line.303"></a> |
| <span class="sourceLineNo">304</span> * because it is difficult to always guarantee that the remove<a name="line.304"></a> |
| <span class="sourceLineNo">305</span> * method is called before exiting a thread, this method has been<a name="line.305"></a> |
| <span class="sourceLineNo">306</span> * augmented to lazily remove references to dead threads. In<a name="line.306"></a> |
| <span class="sourceLineNo">307</span> * practice, this means that you can be a little sloppy and<a name="line.307"></a> |
| <span class="sourceLineNo">308</span> * occasionally forget to call {@link #remove} before exiting a<a name="line.308"></a> |
| <span class="sourceLineNo">309</span> * thread. However, you must call <code>remove</code> sometime. If<a name="line.309"></a> |
| <span class="sourceLineNo">310</span> * you never call it, then your application is sure to run out of<a name="line.310"></a> |
| <span class="sourceLineNo">311</span> * memory.<a name="line.311"></a> |
| <span class="sourceLineNo">312</span> */<a name="line.312"></a> |
| <span class="sourceLineNo">313</span> public static void removeStack() {<a name="line.313"></a> |
| <span class="sourceLineNo">314</span> contextStack.clear();<a name="line.314"></a> |
| <span class="sourceLineNo">315</span> }<a name="line.315"></a> |
| <span class="sourceLineNo">316</span><a name="line.316"></a> |
| <span class="sourceLineNo">317</span> /**<a name="line.317"></a> |
| <span class="sourceLineNo">318</span> * Trims elements from this diagnostic context. If the current<a name="line.318"></a> |
| <span class="sourceLineNo">319</span> * depth is smaller or equal to <code>maxDepth</code>, then no<a name="line.319"></a> |
| <span class="sourceLineNo">320</span> * action is taken. If the current depth is larger than newDepth<a name="line.320"></a> |
| <span class="sourceLineNo">321</span> * then all elements at maxDepth or higher are discarded.<a name="line.321"></a> |
| <span class="sourceLineNo">322</span> * <p/><a name="line.322"></a> |
| <span class="sourceLineNo">323</span> * <p>This method is a convenient alternative to multiple {@link<a name="line.323"></a> |
| <span class="sourceLineNo">324</span> * #pop} calls. Moreover, it is often the case that at the end of<a name="line.324"></a> |
| <span class="sourceLineNo">325</span> * complex call sequences, the depth of the ThreadContext is<a name="line.325"></a> |
| <span class="sourceLineNo">326</span> * unpredictable. The <code>trim</code> method circumvents<a name="line.326"></a> |
| <span class="sourceLineNo">327</span> * this problem.<a name="line.327"></a> |
| <span class="sourceLineNo">328</span> * <p/><a name="line.328"></a> |
| <span class="sourceLineNo">329</span> * <p>For example, the combination<a name="line.329"></a> |
| <span class="sourceLineNo">330</span> * <pre><a name="line.330"></a> |
| <span class="sourceLineNo">331</span> * void foo() {<a name="line.331"></a> |
| <span class="sourceLineNo">332</span> * &nbsp; int depth = ThreadContext.getDepth();<a name="line.332"></a> |
| <span class="sourceLineNo">333</span> * <p/><a name="line.333"></a> |
| <span class="sourceLineNo">334</span> * &nbsp; ... complex sequence of calls<a name="line.334"></a> |
| <span class="sourceLineNo">335</span> * <p/><a name="line.335"></a> |
| <span class="sourceLineNo">336</span> * &nbsp; ThreadContext.trim(depth);<a name="line.336"></a> |
| <span class="sourceLineNo">337</span> * }<a name="line.337"></a> |
| <span class="sourceLineNo">338</span> * </pre><a name="line.338"></a> |
| <span class="sourceLineNo">339</span> * <p/><a name="line.339"></a> |
| <span class="sourceLineNo">340</span> * ensures that between the entry and exit of foo the depth of the<a name="line.340"></a> |
| <span class="sourceLineNo">341</span> * diagnostic stack is conserved.<a name="line.341"></a> |
| <span class="sourceLineNo">342</span> *<a name="line.342"></a> |
| <span class="sourceLineNo">343</span> * @see #getDepth<a name="line.343"></a> |
| <span class="sourceLineNo">344</span> * @param depth The number of elements to keep.<a name="line.344"></a> |
| <span class="sourceLineNo">345</span> */<a name="line.345"></a> |
| <span class="sourceLineNo">346</span> public static void trim(final int depth) {<a name="line.346"></a> |
| <span class="sourceLineNo">347</span> contextStack.trim(depth);<a name="line.347"></a> |
| <span class="sourceLineNo">348</span> }<a name="line.348"></a> |
| <span class="sourceLineNo">349</span><a name="line.349"></a> |
| <span class="sourceLineNo">350</span> /**<a name="line.350"></a> |
| <span class="sourceLineNo">351</span> * The ThreadContext Stack interface.<a name="line.351"></a> |
| <span class="sourceLineNo">352</span> */<a name="line.352"></a> |
| <span class="sourceLineNo">353</span> public interface ContextStack extends Serializable {<a name="line.353"></a> |
| <span class="sourceLineNo">354</span><a name="line.354"></a> |
| <span class="sourceLineNo">355</span> /**<a name="line.355"></a> |
| <span class="sourceLineNo">356</span> * Clears all elements from the stack.<a name="line.356"></a> |
| <span class="sourceLineNo">357</span> */<a name="line.357"></a> |
| <span class="sourceLineNo">358</span> void clear();<a name="line.358"></a> |
| <span class="sourceLineNo">359</span><a name="line.359"></a> |
| <span class="sourceLineNo">360</span> /**<a name="line.360"></a> |
| <span class="sourceLineNo">361</span> * Returns the element at the top of the stack.<a name="line.361"></a> |
| <span class="sourceLineNo">362</span> * @return The element at the top of the stack.<a name="line.362"></a> |
| <span class="sourceLineNo">363</span> * @throws java.util.NoSuchElementException if the stack is empty.<a name="line.363"></a> |
| <span class="sourceLineNo">364</span> */<a name="line.364"></a> |
| <span class="sourceLineNo">365</span> String pop();<a name="line.365"></a> |
| <span class="sourceLineNo">366</span><a name="line.366"></a> |
| <span class="sourceLineNo">367</span> /**<a name="line.367"></a> |
| <span class="sourceLineNo">368</span> * Returns the element at the top of the stack without removing it or null if the stack is empty.<a name="line.368"></a> |
| <span class="sourceLineNo">369</span> * @return the element at the top of the stack or null if the stack is empty.<a name="line.369"></a> |
| <span class="sourceLineNo">370</span> */<a name="line.370"></a> |
| <span class="sourceLineNo">371</span> String peek();<a name="line.371"></a> |
| <span class="sourceLineNo">372</span><a name="line.372"></a> |
| <span class="sourceLineNo">373</span> /**<a name="line.373"></a> |
| <span class="sourceLineNo">374</span> * Add an element to the stack.<a name="line.374"></a> |
| <span class="sourceLineNo">375</span> * @param message The element to add.<a name="line.375"></a> |
| <span class="sourceLineNo">376</span> */<a name="line.376"></a> |
| <span class="sourceLineNo">377</span> void push(String message);<a name="line.377"></a> |
| <span class="sourceLineNo">378</span><a name="line.378"></a> |
| <span class="sourceLineNo">379</span> /**<a name="line.379"></a> |
| <span class="sourceLineNo">380</span> * Returns the number of elements in the stack.<a name="line.380"></a> |
| <span class="sourceLineNo">381</span> * @return the number of elements in the stack.<a name="line.381"></a> |
| <span class="sourceLineNo">382</span> */<a name="line.382"></a> |
| <span class="sourceLineNo">383</span> int getDepth();<a name="line.383"></a> |
| <span class="sourceLineNo">384</span><a name="line.384"></a> |
| <span class="sourceLineNo">385</span> /**<a name="line.385"></a> |
| <span class="sourceLineNo">386</span> * Returns all the elements in the stack in a List.<a name="line.386"></a> |
| <span class="sourceLineNo">387</span> * @return all the elements in the stack in a List.<a name="line.387"></a> |
| <span class="sourceLineNo">388</span> */<a name="line.388"></a> |
| <span class="sourceLineNo">389</span> List<String> asList();<a name="line.389"></a> |
| <span class="sourceLineNo">390</span><a name="line.390"></a> |
| <span class="sourceLineNo">391</span> /**<a name="line.391"></a> |
| <span class="sourceLineNo">392</span> * Trims elements from the end of the stack.<a name="line.392"></a> |
| <span class="sourceLineNo">393</span> * @param depth The maximum number of items in the stack to keep.<a name="line.393"></a> |
| <span class="sourceLineNo">394</span> */<a name="line.394"></a> |
| <span class="sourceLineNo">395</span> void trim(int depth);<a name="line.395"></a> |
| <span class="sourceLineNo">396</span><a name="line.396"></a> |
| <span class="sourceLineNo">397</span> /**<a name="line.397"></a> |
| <span class="sourceLineNo">398</span> * Returns a copy of the ContextStack.<a name="line.398"></a> |
| <span class="sourceLineNo">399</span> * @return a copy of the ContextStack.s<a name="line.399"></a> |
| <span class="sourceLineNo">400</span> */<a name="line.400"></a> |
| <span class="sourceLineNo">401</span> ContextStack copy();<a name="line.401"></a> |
| <span class="sourceLineNo">402</span> }<a name="line.402"></a> |
| <span class="sourceLineNo">403</span>}<a name="line.403"></a> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| </pre> |
| </div> |
| </body> |
| </html> |
