blob: ce381e5bf6930fe74c73a9987a38a1216d0f31fc [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<a name="line.2"></a>
<span class="sourceLineNo">003</span> * or more contributor license agreements. See the NOTICE file<a name="line.3"></a>
<span class="sourceLineNo">004</span> * distributed with this work for additional information<a name="line.4"></a>
<span class="sourceLineNo">005</span> * regarding copyright ownership. The ASF licenses this file<a name="line.5"></a>
<span class="sourceLineNo">006</span> * to you under the Apache License, Version 2.0 (the<a name="line.6"></a>
<span class="sourceLineNo">007</span> * "License"); you may not use this file except in compliance<a name="line.7"></a>
<span class="sourceLineNo">008</span> * with the License. You may obtain a copy of the License at<a name="line.8"></a>
<span class="sourceLineNo">009</span> *<a name="line.9"></a>
<span class="sourceLineNo">010</span> * http://www.apache.org/licenses/LICENSE-2.0<a name="line.10"></a>
<span class="sourceLineNo">011</span> *<a name="line.11"></a>
<span class="sourceLineNo">012</span> * Unless required by applicable law or agreed to in writing,<a name="line.12"></a>
<span class="sourceLineNo">013</span> * software distributed under the License is distributed on an<a name="line.13"></a>
<span class="sourceLineNo">014</span> * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY<a name="line.14"></a>
<span class="sourceLineNo">015</span> * KIND, either express or implied. See the License for the<a name="line.15"></a>
<span class="sourceLineNo">016</span> * specific language governing permissions and limitations<a name="line.16"></a>
<span class="sourceLineNo">017</span> * under the License.<a name="line.17"></a>
<span class="sourceLineNo">018</span> *<a name="line.18"></a>
<span class="sourceLineNo">019</span> */<a name="line.19"></a>
<span class="sourceLineNo">020</span>package org.apache.mina.filter.logging;<a name="line.20"></a>
<span class="sourceLineNo">021</span><a name="line.21"></a>
<span class="sourceLineNo">022</span>import java.net.InetSocketAddress;<a name="line.22"></a>
<span class="sourceLineNo">023</span>import java.util.EnumSet;<a name="line.23"></a>
<span class="sourceLineNo">024</span>import java.util.HashSet;<a name="line.24"></a>
<span class="sourceLineNo">025</span>import java.util.Map;<a name="line.25"></a>
<span class="sourceLineNo">026</span>import java.util.Set;<a name="line.26"></a>
<span class="sourceLineNo">027</span>import java.util.Arrays;<a name="line.27"></a>
<span class="sourceLineNo">028</span>import java.util.concurrent.ConcurrentHashMap;<a name="line.28"></a>
<span class="sourceLineNo">029</span><a name="line.29"></a>
<span class="sourceLineNo">030</span>import org.apache.mina.core.filterchain.IoFilterEvent;<a name="line.30"></a>
<span class="sourceLineNo">031</span>import org.apache.mina.core.session.AttributeKey;<a name="line.31"></a>
<span class="sourceLineNo">032</span>import org.apache.mina.core.session.IoSession;<a name="line.32"></a>
<span class="sourceLineNo">033</span>import org.apache.mina.filter.util.CommonEventFilter;<a name="line.33"></a>
<span class="sourceLineNo">034</span>import org.slf4j.MDC;<a name="line.34"></a>
<span class="sourceLineNo">035</span><a name="line.35"></a>
<span class="sourceLineNo">036</span>/**<a name="line.36"></a>
<span class="sourceLineNo">037</span> * This filter will inject some key IoSession properties into the Mapped Diagnostic Context (MDC)<a name="line.37"></a>
<span class="sourceLineNo">038</span> * &lt;p&gt;<a name="line.38"></a>
<span class="sourceLineNo">039</span> * These properties will be set in the MDC for all logging events that are generated<a name="line.39"></a>
<span class="sourceLineNo">040</span> * down the call stack, even in code that is not aware of MINA.<a name="line.40"></a>
<span class="sourceLineNo">041</span> *<a name="line.41"></a>
<span class="sourceLineNo">042</span> * By default, the following properties will be set for all transports:<a name="line.42"></a>
<span class="sourceLineNo">043</span> * &lt;ul&gt;<a name="line.43"></a>
<span class="sourceLineNo">044</span> * &lt;li&gt;"handlerClass"&lt;/li&gt;<a name="line.44"></a>
<span class="sourceLineNo">045</span> * &lt;li&gt;"remoteAddress"&lt;/li&gt;<a name="line.45"></a>
<span class="sourceLineNo">046</span> * &lt;li&gt;"localAddress"&lt;/li&gt;<a name="line.46"></a>
<span class="sourceLineNo">047</span> * &lt;/ul&gt;<a name="line.47"></a>
<span class="sourceLineNo">048</span> *<a name="line.48"></a>
<span class="sourceLineNo">049</span> * When &lt;code&gt;session.getTransportMetadata().getAddressType() == InetSocketAddress.class&lt;/code&gt;<a name="line.49"></a>
<span class="sourceLineNo">050</span> * the following properties will also be set:<a name="line.50"></a>
<span class="sourceLineNo">051</span> * &lt;ul&gt;<a name="line.51"></a>
<span class="sourceLineNo">052</span> * &lt;li&gt;"remoteIp"&lt;/li&gt;<a name="line.52"></a>
<span class="sourceLineNo">053</span> * &lt;li&gt;"remotePort"&lt;/li&gt;<a name="line.53"></a>
<span class="sourceLineNo">054</span> * &lt;li&gt;"localIp"&lt;/li&gt;<a name="line.54"></a>
<span class="sourceLineNo">055</span> * &lt;li&gt;"localPort"&lt;/li&gt;<a name="line.55"></a>
<span class="sourceLineNo">056</span> * &lt;/ul&gt;<a name="line.56"></a>
<span class="sourceLineNo">057</span> *<a name="line.57"></a>
<span class="sourceLineNo">058</span> * User code can also add custom properties to the context, via {@link #setProperty(IoSession, String, String)}<a name="line.58"></a>
<span class="sourceLineNo">059</span> *<a name="line.59"></a>
<span class="sourceLineNo">060</span> * If you only want the MDC to be set for the IoHandler code, it's enough to add<a name="line.60"></a>
<span class="sourceLineNo">061</span> * one MdcInjectionFilter at the end of the filter chain.<a name="line.61"></a>
<span class="sourceLineNo">062</span> *<a name="line.62"></a>
<span class="sourceLineNo">063</span> * If you want the MDC to be set for ALL code, you should<a name="line.63"></a>
<span class="sourceLineNo">064</span> * add an MdcInjectionFilter to the start of the chain<a name="line.64"></a>
<span class="sourceLineNo">065</span> * and add that same MdcInjectionFilter instance after EVERY ExecutorFilter in the chain<a name="line.65"></a>
<span class="sourceLineNo">066</span> *<a name="line.66"></a>
<span class="sourceLineNo">067</span> * Thus it's ok to have one instance of the MdcInjectionFilter and add it multiple times to the chain<a name="line.67"></a>
<span class="sourceLineNo">068</span> * but you should avoid adding multiple instances to the chain.<a name="line.68"></a>
<span class="sourceLineNo">069</span> *<a name="line.69"></a>
<span class="sourceLineNo">070</span> * @author &lt;a href="http://mina.apache.org"&gt;Apache MINA Project&lt;/a&gt;<a name="line.70"></a>
<span class="sourceLineNo">071</span> */<a name="line.71"></a>
<span class="sourceLineNo">072</span><a name="line.72"></a>
<span class="sourceLineNo">073</span>public class MdcInjectionFilter extends CommonEventFilter {<a name="line.73"></a>
<span class="sourceLineNo">074</span><a name="line.74"></a>
<span class="sourceLineNo">075</span> public enum MdcKey {<a name="line.75"></a>
<span class="sourceLineNo">076</span> handlerClass, remoteAddress, localAddress, remoteIp, remotePort, localIp, localPort<a name="line.76"></a>
<span class="sourceLineNo">077</span> }<a name="line.77"></a>
<span class="sourceLineNo">078</span><a name="line.78"></a>
<span class="sourceLineNo">079</span> /** key used for storing the context map in the IoSession */<a name="line.79"></a>
<span class="sourceLineNo">080</span> private static final AttributeKey CONTEXT_KEY = new AttributeKey(MdcInjectionFilter.class, "context");<a name="line.80"></a>
<span class="sourceLineNo">081</span><a name="line.81"></a>
<span class="sourceLineNo">082</span> private ThreadLocal&lt;Integer&gt; callDepth = new ThreadLocal&lt;Integer&gt;() {<a name="line.82"></a>
<span class="sourceLineNo">083</span> @Override<a name="line.83"></a>
<span class="sourceLineNo">084</span> protected Integer initialValue() {<a name="line.84"></a>
<span class="sourceLineNo">085</span> return 0;<a name="line.85"></a>
<span class="sourceLineNo">086</span> }<a name="line.86"></a>
<span class="sourceLineNo">087</span> };<a name="line.87"></a>
<span class="sourceLineNo">088</span><a name="line.88"></a>
<span class="sourceLineNo">089</span> private EnumSet&lt;MdcKey&gt; mdcKeys;<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> * Use this constructor when you want to specify which keys to add to the MDC.<a name="line.92"></a>
<span class="sourceLineNo">093</span> * You could still add custom keys via {@link #setProperty(IoSession, String, String)}<a name="line.93"></a>
<span class="sourceLineNo">094</span> * @param keys set of keys that should be added to the MDC<a name="line.94"></a>
<span class="sourceLineNo">095</span> *<a name="line.95"></a>
<span class="sourceLineNo">096</span> * @see #setProperty(org.apache.mina.core.session.IoSession, String, String)<a name="line.96"></a>
<span class="sourceLineNo">097</span> */<a name="line.97"></a>
<span class="sourceLineNo">098</span> public MdcInjectionFilter(EnumSet&lt;MdcKey&gt; keys) {<a name="line.98"></a>
<span class="sourceLineNo">099</span> this.mdcKeys = keys.clone();<a name="line.99"></a>
<span class="sourceLineNo">100</span> }<a name="line.100"></a>
<span class="sourceLineNo">101</span><a name="line.101"></a>
<span class="sourceLineNo">102</span> /**<a name="line.102"></a>
<span class="sourceLineNo">103</span> * Use this constructor when you want to specify which keys to add to the MDC<a name="line.103"></a>
<span class="sourceLineNo">104</span> * You could still add custom keys via {@link #setProperty(IoSession, String, String)}<a name="line.104"></a>
<span class="sourceLineNo">105</span> * @param keys list of keys that should be added to the MDC<a name="line.105"></a>
<span class="sourceLineNo">106</span> *<a name="line.106"></a>
<span class="sourceLineNo">107</span> * @see #setProperty(org.apache.mina.core.session.IoSession, String, String)<a name="line.107"></a>
<span class="sourceLineNo">108</span> */<a name="line.108"></a>
<span class="sourceLineNo">109</span> public MdcInjectionFilter(MdcKey... keys) {<a name="line.109"></a>
<span class="sourceLineNo">110</span> Set&lt;MdcKey&gt; keySet = new HashSet&lt;MdcKey&gt;(Arrays.asList(keys));<a name="line.110"></a>
<span class="sourceLineNo">111</span> this.mdcKeys = EnumSet.copyOf(keySet);<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> public MdcInjectionFilter() {<a name="line.114"></a>
<span class="sourceLineNo">115</span> this.mdcKeys = EnumSet.allOf(MdcKey.class);<a name="line.115"></a>
<span class="sourceLineNo">116</span> }<a name="line.116"></a>
<span class="sourceLineNo">117</span><a name="line.117"></a>
<span class="sourceLineNo">118</span> @Override<a name="line.118"></a>
<span class="sourceLineNo">119</span> protected void filter(IoFilterEvent event) throws Exception {<a name="line.119"></a>
<span class="sourceLineNo">120</span> // since this method can potentially call into itself<a name="line.120"></a>
<span class="sourceLineNo">121</span> // we need to check the call depth before clearing the MDC<a name="line.121"></a>
<span class="sourceLineNo">122</span> int currentCallDepth = callDepth.get();<a name="line.122"></a>
<span class="sourceLineNo">123</span> callDepth.set(currentCallDepth + 1);<a name="line.123"></a>
<span class="sourceLineNo">124</span> Map&lt;String, String&gt; context = getAndFillContext(event.getSession());<a name="line.124"></a>
<span class="sourceLineNo">125</span><a name="line.125"></a>
<span class="sourceLineNo">126</span> if (currentCallDepth == 0) {<a name="line.126"></a>
<span class="sourceLineNo">127</span> /* copy context to the MDC when necessary. */<a name="line.127"></a>
<span class="sourceLineNo">128</span> for (Map.Entry&lt;String, String&gt; e : context.entrySet()) {<a name="line.128"></a>
<span class="sourceLineNo">129</span> MDC.put(e.getKey(), e.getValue());<a name="line.129"></a>
<span class="sourceLineNo">130</span> }<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>
<span class="sourceLineNo">133</span> try {<a name="line.133"></a>
<span class="sourceLineNo">134</span> /* propagate event down the filter chain */<a name="line.134"></a>
<span class="sourceLineNo">135</span> event.fire();<a name="line.135"></a>
<span class="sourceLineNo">136</span> } finally {<a name="line.136"></a>
<span class="sourceLineNo">137</span> if (currentCallDepth == 0) {<a name="line.137"></a>
<span class="sourceLineNo">138</span> /* remove context from the MDC */<a name="line.138"></a>
<span class="sourceLineNo">139</span> for (String key : context.keySet()) {<a name="line.139"></a>
<span class="sourceLineNo">140</span> MDC.remove(key);<a name="line.140"></a>
<span class="sourceLineNo">141</span> }<a name="line.141"></a>
<span class="sourceLineNo">142</span> callDepth.remove();<a name="line.142"></a>
<span class="sourceLineNo">143</span> } else {<a name="line.143"></a>
<span class="sourceLineNo">144</span> callDepth.set(currentCallDepth);<a name="line.144"></a>
<span class="sourceLineNo">145</span> }<a name="line.145"></a>
<span class="sourceLineNo">146</span> }<a name="line.146"></a>
<span class="sourceLineNo">147</span> }<a name="line.147"></a>
<span class="sourceLineNo">148</span><a name="line.148"></a>
<span class="sourceLineNo">149</span> private Map&lt;String, String&gt; getAndFillContext(final IoSession session) {<a name="line.149"></a>
<span class="sourceLineNo">150</span> Map&lt;String, String&gt; context = getContext(session);<a name="line.150"></a>
<span class="sourceLineNo">151</span> if (context.isEmpty()) {<a name="line.151"></a>
<span class="sourceLineNo">152</span> fillContext(session, context);<a name="line.152"></a>
<span class="sourceLineNo">153</span> }<a name="line.153"></a>
<span class="sourceLineNo">154</span> return context;<a name="line.154"></a>
<span class="sourceLineNo">155</span> }<a name="line.155"></a>
<span class="sourceLineNo">156</span><a name="line.156"></a>
<span class="sourceLineNo">157</span> @SuppressWarnings("unchecked")<a name="line.157"></a>
<span class="sourceLineNo">158</span> private static Map&lt;String, String&gt; getContext(final IoSession session) {<a name="line.158"></a>
<span class="sourceLineNo">159</span> Map&lt;String, String&gt; context = (Map&lt;String, String&gt;) session.getAttribute(CONTEXT_KEY);<a name="line.159"></a>
<span class="sourceLineNo">160</span> if (context == null) {<a name="line.160"></a>
<span class="sourceLineNo">161</span> context = new ConcurrentHashMap&lt;String, String&gt;();<a name="line.161"></a>
<span class="sourceLineNo">162</span> session.setAttribute(CONTEXT_KEY, context);<a name="line.162"></a>
<span class="sourceLineNo">163</span> }<a name="line.163"></a>
<span class="sourceLineNo">164</span> return context;<a name="line.164"></a>
<span class="sourceLineNo">165</span> }<a name="line.165"></a>
<span class="sourceLineNo">166</span><a name="line.166"></a>
<span class="sourceLineNo">167</span> /**<a name="line.167"></a>
<span class="sourceLineNo">168</span> * write key properties of the session to the Mapped Diagnostic Context<a name="line.168"></a>
<span class="sourceLineNo">169</span> * sub-classes could override this method to map more/other attributes<a name="line.169"></a>
<span class="sourceLineNo">170</span> * @param session the session to map<a name="line.170"></a>
<span class="sourceLineNo">171</span> * @param context key properties will be added to this map<a name="line.171"></a>
<span class="sourceLineNo">172</span> */<a name="line.172"></a>
<span class="sourceLineNo">173</span> protected void fillContext(final IoSession session, final Map&lt;String, String&gt; context) {<a name="line.173"></a>
<span class="sourceLineNo">174</span> if (mdcKeys.contains(MdcKey.handlerClass)) {<a name="line.174"></a>
<span class="sourceLineNo">175</span> context.put(MdcKey.handlerClass.name(), session.getHandler().getClass().getName());<a name="line.175"></a>
<span class="sourceLineNo">176</span> }<a name="line.176"></a>
<span class="sourceLineNo">177</span> if (mdcKeys.contains(MdcKey.remoteAddress)) {<a name="line.177"></a>
<span class="sourceLineNo">178</span> context.put(MdcKey.remoteAddress.name(), session.getRemoteAddress().toString());<a name="line.178"></a>
<span class="sourceLineNo">179</span> }<a name="line.179"></a>
<span class="sourceLineNo">180</span> if (mdcKeys.contains(MdcKey.localAddress)) {<a name="line.180"></a>
<span class="sourceLineNo">181</span> context.put(MdcKey.localAddress.name(), session.getLocalAddress().toString());<a name="line.181"></a>
<span class="sourceLineNo">182</span> }<a name="line.182"></a>
<span class="sourceLineNo">183</span> if (session.getTransportMetadata().getAddressType() == InetSocketAddress.class) {<a name="line.183"></a>
<span class="sourceLineNo">184</span> InetSocketAddress remoteAddress = (InetSocketAddress) session.getRemoteAddress();<a name="line.184"></a>
<span class="sourceLineNo">185</span> InetSocketAddress localAddress = (InetSocketAddress) session.getLocalAddress();<a name="line.185"></a>
<span class="sourceLineNo">186</span><a name="line.186"></a>
<span class="sourceLineNo">187</span> if (mdcKeys.contains(MdcKey.remoteIp)) {<a name="line.187"></a>
<span class="sourceLineNo">188</span> context.put(MdcKey.remoteIp.name(), remoteAddress.getAddress().getHostAddress());<a name="line.188"></a>
<span class="sourceLineNo">189</span> }<a name="line.189"></a>
<span class="sourceLineNo">190</span> if (mdcKeys.contains(MdcKey.remotePort)) {<a name="line.190"></a>
<span class="sourceLineNo">191</span> context.put(MdcKey.remotePort.name(), String.valueOf(remoteAddress.getPort()));<a name="line.191"></a>
<span class="sourceLineNo">192</span> }<a name="line.192"></a>
<span class="sourceLineNo">193</span> if (mdcKeys.contains(MdcKey.localIp)) {<a name="line.193"></a>
<span class="sourceLineNo">194</span> context.put(MdcKey.localIp.name(), localAddress.getAddress().getHostAddress());<a name="line.194"></a>
<span class="sourceLineNo">195</span> }<a name="line.195"></a>
<span class="sourceLineNo">196</span> if (mdcKeys.contains(MdcKey.localPort)) {<a name="line.196"></a>
<span class="sourceLineNo">197</span> context.put(MdcKey.localPort.name(), String.valueOf(localAddress.getPort()));<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> }<a name="line.200"></a>
<span class="sourceLineNo">201</span><a name="line.201"></a>
<span class="sourceLineNo">202</span> public static String getProperty(IoSession session, String key) {<a name="line.202"></a>
<span class="sourceLineNo">203</span> if (key == null) {<a name="line.203"></a>
<span class="sourceLineNo">204</span> throw new IllegalArgumentException("key should not be null");<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> Map&lt;String, String&gt; context = getContext(session);<a name="line.207"></a>
<span class="sourceLineNo">208</span> String answer = context.get(key);<a name="line.208"></a>
<span class="sourceLineNo">209</span> if (answer != null) {<a name="line.209"></a>
<span class="sourceLineNo">210</span> return answer;<a name="line.210"></a>
<span class="sourceLineNo">211</span> }<a name="line.211"></a>
<span class="sourceLineNo">212</span><a name="line.212"></a>
<span class="sourceLineNo">213</span> return MDC.get(key);<a name="line.213"></a>
<span class="sourceLineNo">214</span> }<a name="line.214"></a>
<span class="sourceLineNo">215</span><a name="line.215"></a>
<span class="sourceLineNo">216</span> /**<a name="line.216"></a>
<span class="sourceLineNo">217</span> * Add a property to the context for the given session<a name="line.217"></a>
<span class="sourceLineNo">218</span> * This property will be added to the MDC for all subsequent events<a name="line.218"></a>
<span class="sourceLineNo">219</span> * @param session The session for which you want to set a property<a name="line.219"></a>
<span class="sourceLineNo">220</span> * @param key The name of the property (should not be null)<a name="line.220"></a>
<span class="sourceLineNo">221</span> * @param value The value of the property<a name="line.221"></a>
<span class="sourceLineNo">222</span> */<a name="line.222"></a>
<span class="sourceLineNo">223</span> public static void setProperty(IoSession session, String key, String value) {<a name="line.223"></a>
<span class="sourceLineNo">224</span> if (key == null) {<a name="line.224"></a>
<span class="sourceLineNo">225</span> throw new IllegalArgumentException("key should not be null");<a name="line.225"></a>
<span class="sourceLineNo">226</span> }<a name="line.226"></a>
<span class="sourceLineNo">227</span> if (value == null) {<a name="line.227"></a>
<span class="sourceLineNo">228</span> removeProperty(session, key);<a name="line.228"></a>
<span class="sourceLineNo">229</span> }<a name="line.229"></a>
<span class="sourceLineNo">230</span> Map&lt;String, String&gt; context = getContext(session);<a name="line.230"></a>
<span class="sourceLineNo">231</span> context.put(key, value);<a name="line.231"></a>
<span class="sourceLineNo">232</span> MDC.put(key, value);<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> public static void removeProperty(IoSession session, String key) {<a name="line.235"></a>
<span class="sourceLineNo">236</span> if (key == null) {<a name="line.236"></a>
<span class="sourceLineNo">237</span> throw new IllegalArgumentException("key should not be null");<a name="line.237"></a>
<span class="sourceLineNo">238</span> }<a name="line.238"></a>
<span class="sourceLineNo">239</span> Map&lt;String, String&gt; context = getContext(session);<a name="line.239"></a>
<span class="sourceLineNo">240</span> context.remove(key);<a name="line.240"></a>
<span class="sourceLineNo">241</span> MDC.remove(key);<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>
</pre>
</div>
</body>
</html>