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