| <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> |
| <!-- NewPage --> |
| <html lang="en"> |
| <head> |
| <!-- Generated by javadoc (1.8.0_60) on Wed Feb 03 10:01:29 CET 2016 --> |
| <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> |
| <title>MdcInjectionFilter (Apache MINA 2.0.12 API)</title> |
| <meta name="date" content="2016-02-03"> |
| <link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style"> |
| <script type="text/javascript" src="../../../../../script.js"></script> |
| </head> |
| <body> |
| <script type="text/javascript"><!-- |
| try { |
| if (location.href.indexOf('is-external=true') == -1) { |
| parent.document.title="MdcInjectionFilter (Apache MINA 2.0.12 API)"; |
| } |
| } |
| catch(err) { |
| } |
| //--> |
| var methods = {"i0":10,"i1":10,"i2":9,"i3":9,"i4":9}; |
| var tabs = {65535:["t0","All Methods"],1:["t1","Static Methods"],2:["t2","Instance Methods"],8:["t4","Concrete Methods"]}; |
| var altColor = "altColor"; |
| var rowColor = "rowColor"; |
| var tableTab = "tableTab"; |
| var activeTableTab = "activeTableTab"; |
| </script> |
| <noscript> |
| <div>JavaScript is disabled on your browser.</div> |
| </noscript> |
| <!-- ========= START OF TOP NAVBAR ======= --> |
| <div class="topNav"><a name="navbar.top"> |
| <!-- --> |
| </a> |
| <div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div> |
| <a name="navbar.top.firstrow"> |
| <!-- --> |
| </a> |
| <ul class="navList" title="Navigation"> |
| <li><a href="../../../../../overview-summary.html">Overview</a></li> |
| <li><a href="package-summary.html">Package</a></li> |
| <li class="navBarCell1Rev">Class</li> |
| <li><a href="class-use/MdcInjectionFilter.html">Use</a></li> |
| <li><a href="package-tree.html">Tree</a></li> |
| <li><a href="../../../../../deprecated-list.html">Deprecated</a></li> |
| <li><a href="../../../../../index-all.html">Index</a></li> |
| <li><a href="../../../../../help-doc.html">Help</a></li> |
| </ul> |
| </div> |
| <div class="subNav"> |
| <ul class="navList"> |
| <li><a href="../../../../../org/apache/mina/filter/logging/LogLevel.html" title="enum in org.apache.mina.filter.logging"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../../../org/apache/mina/filter/logging/MdcInjectionFilter.MdcKey.html" title="enum in org.apache.mina.filter.logging"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../../index.html?org/apache/mina/filter/logging/MdcInjectionFilter.html" target="_top">Frames</a></li> |
| <li><a href="MdcInjectionFilter.html" target="_top">No Frames</a></li> |
| </ul> |
| <ul class="navList" id="allclasses_navbar_top"> |
| <li><a href="../../../../../allclasses-noframe.html">All Classes</a></li> |
| </ul> |
| <div> |
| <script type="text/javascript"><!-- |
| allClassesLink = document.getElementById("allclasses_navbar_top"); |
| if(window==top) { |
| allClassesLink.style.display = "block"; |
| } |
| else { |
| allClassesLink.style.display = "none"; |
| } |
| //--> |
| </script> |
| </div> |
| <div> |
| <ul class="subNavList"> |
| <li>Summary: </li> |
| <li><a href="#nested.class.summary">Nested</a> | </li> |
| <li>Field | </li> |
| <li><a href="#constructor.summary">Constr</a> | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li><a href="#constructor.detail">Constr</a> | </li> |
| <li><a href="#method.detail">Method</a></li> |
| </ul> |
| </div> |
| <a name="skip.navbar.top"> |
| <!-- --> |
| </a></div> |
| <!-- ========= END OF TOP NAVBAR ========= --> |
| <!-- ======== START OF CLASS DATA ======== --> |
| <div class="header"> |
| <div class="subTitle">org.apache.mina.filter.logging</div> |
| <h2 title="Class MdcInjectionFilter" class="title">Class MdcInjectionFilter</h2> |
| </div> |
| <div class="contentContainer"> |
| <ul class="inheritance"> |
| <li><a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">java.lang.Object</a></li> |
| <li> |
| <ul class="inheritance"> |
| <li><a href="../../../../../org/apache/mina/core/filterchain/IoFilterAdapter.html" title="class in org.apache.mina.core.filterchain">org.apache.mina.core.filterchain.IoFilterAdapter</a></li> |
| <li> |
| <ul class="inheritance"> |
| <li><a href="../../../../../org/apache/mina/filter/util/CommonEventFilter.html" title="class in org.apache.mina.filter.util">org.apache.mina.filter.util.CommonEventFilter</a></li> |
| <li> |
| <ul class="inheritance"> |
| <li>org.apache.mina.filter.logging.MdcInjectionFilter</li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| <div class="description"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <dl> |
| <dt>All Implemented Interfaces:</dt> |
| <dd><a href="../../../../../org/apache/mina/core/filterchain/IoFilter.html" title="interface in org.apache.mina.core.filterchain">IoFilter</a></dd> |
| </dl> |
| <hr> |
| <br> |
| <pre>public class <a href="../../../../../src-html/org/apache/mina/filter/logging/MdcInjectionFilter.html#line.73">MdcInjectionFilter</a> |
| extends <a href="../../../../../org/apache/mina/filter/util/CommonEventFilter.html" title="class in org.apache.mina.filter.util">CommonEventFilter</a></pre> |
| <div class="block">This filter will inject some key IoSession properties into the Mapped Diagnostic Context (MDC) |
| <p> |
| These properties will be set in the MDC for all logging events that are generated |
| down the call stack, even in code that is not aware of MINA. |
| |
| By default, the following properties will be set for all transports: |
| <ul> |
| <li>"handlerClass"</li> |
| <li>"remoteAddress"</li> |
| <li>"localAddress"</li> |
| </ul> |
| |
| When <code>session.getTransportMetadata().getAddressType() == InetSocketAddress.class</code> |
| the following properties will also be set: |
| <ul> |
| <li>"remoteIp"</li> |
| <li>"remotePort"</li> |
| <li>"localIp"</li> |
| <li>"localPort"</li> |
| </ul> |
| |
| User code can also add custom properties to the context, via <a href="../../../../../org/apache/mina/filter/logging/MdcInjectionFilter.html#setProperty-org.apache.mina.core.session.IoSession-java.lang.String-java.lang.String-"><code>setProperty(IoSession, String, String)</code></a> |
| |
| If you only want the MDC to be set for the IoHandler code, it's enough to add |
| one MdcInjectionFilter at the end of the filter chain. |
| |
| If you want the MDC to be set for ALL code, you should |
| add an MdcInjectionFilter to the start of the chain |
| and add that same MdcInjectionFilter instance after EVERY ExecutorFilter in the chain |
| |
| Thus it's ok to have one instance of the MdcInjectionFilter and add it multiple times to the chain |
| but you should avoid adding multiple instances to the chain.</div> |
| <dl> |
| <dt><span class="simpleTagLabel">Author:</span></dt> |
| <dd><a href="http://mina.apache.org">Apache MINA Project</a></dd> |
| </dl> |
| </li> |
| </ul> |
| </div> |
| <div class="summary"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ======== NESTED CLASS SUMMARY ======== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="nested.class.summary"> |
| <!-- --> |
| </a> |
| <h3>Nested Class Summary</h3> |
| <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Nested Class Summary table, listing nested classes, and an explanation"> |
| <caption><span>Nested Classes</span><span class="tabEnd"> </span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Modifier and Type</th> |
| <th class="colLast" scope="col">Class and Description</th> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>static class </code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/mina/filter/logging/MdcInjectionFilter.MdcKey.html" title="enum in org.apache.mina.filter.logging">MdcInjectionFilter.MdcKey</a></span></code> </td> |
| </tr> |
| </table> |
| <ul class="blockList"> |
| <li class="blockList"><a name="nested.classes.inherited.from.class.org.apache.mina.core.filterchain.IoFilter"> |
| <!-- --> |
| </a> |
| <h3>Nested classes/interfaces inherited from interface org.apache.mina.core.filterchain.<a href="../../../../../org/apache/mina/core/filterchain/IoFilter.html" title="interface in org.apache.mina.core.filterchain">IoFilter</a></h3> |
| <code><a href="../../../../../org/apache/mina/core/filterchain/IoFilter.NextFilter.html" title="interface in org.apache.mina.core.filterchain">IoFilter.NextFilter</a></code></li> |
| </ul> |
| </li> |
| </ul> |
| <!-- ======== CONSTRUCTOR SUMMARY ======== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="constructor.summary"> |
| <!-- --> |
| </a> |
| <h3>Constructor Summary</h3> |
| <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation"> |
| <caption><span>Constructors</span><span class="tabEnd"> </span></caption> |
| <tr> |
| <th class="colOne" scope="col">Constructor and Description</th> |
| </tr> |
| <tr class="altColor"> |
| <td class="colOne"><code><span class="memberNameLink"><a href="../../../../../org/apache/mina/filter/logging/MdcInjectionFilter.html#MdcInjectionFilter--">MdcInjectionFilter</a></span>()</code> </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colOne"><code><span class="memberNameLink"><a href="../../../../../org/apache/mina/filter/logging/MdcInjectionFilter.html#MdcInjectionFilter-java.util.EnumSet-">MdcInjectionFilter</a></span>(<a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/util/EnumSet.html?is-external=true" title="class or interface in java.util">EnumSet</a><<a href="../../../../../org/apache/mina/filter/logging/MdcInjectionFilter.MdcKey.html" title="enum in org.apache.mina.filter.logging">MdcInjectionFilter.MdcKey</a>> keys)</code> |
| <div class="block">Use this constructor when you want to specify which keys to add to the MDC.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colOne"><code><span class="memberNameLink"><a href="../../../../../org/apache/mina/filter/logging/MdcInjectionFilter.html#MdcInjectionFilter-org.apache.mina.filter.logging.MdcInjectionFilter.MdcKey...-">MdcInjectionFilter</a></span>(<a href="../../../../../org/apache/mina/filter/logging/MdcInjectionFilter.MdcKey.html" title="enum in org.apache.mina.filter.logging">MdcInjectionFilter.MdcKey</a>... keys)</code> |
| <div class="block">Use this constructor when you want to specify which keys to add to the MDC |
| You could still add custom keys via <a href="../../../../../org/apache/mina/filter/logging/MdcInjectionFilter.html#setProperty-org.apache.mina.core.session.IoSession-java.lang.String-java.lang.String-"><code>setProperty(IoSession, String, String)</code></a></div> |
| </td> |
| </tr> |
| </table> |
| </li> |
| </ul> |
| <!-- ========== METHOD SUMMARY =========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="method.summary"> |
| <!-- --> |
| </a> |
| <h3>Method Summary</h3> |
| <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation"> |
| <caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd"> </span></span><span id="t1" class="tableTab"><span><a href="javascript:show(1);">Static Methods</a></span><span class="tabEnd"> </span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd"> </span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd"> </span></span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Modifier and Type</th> |
| <th class="colLast" scope="col">Method and Description</th> |
| </tr> |
| <tr id="i0" class="altColor"> |
| <td class="colFirst"><code>protected void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/mina/filter/logging/MdcInjectionFilter.html#fillContext-org.apache.mina.core.session.IoSession-java.util.Map-">fillContext</a></span>(<a href="../../../../../org/apache/mina/core/session/IoSession.html" title="interface in org.apache.mina.core.session">IoSession</a> session, |
| <a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</a><<a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>,<a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>> context)</code> |
| <div class="block">write key properties of the session to the Mapped Diagnostic Context |
| sub-classes could override this method to map more/other attributes</div> |
| </td> |
| </tr> |
| <tr id="i1" class="rowColor"> |
| <td class="colFirst"><code>protected void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/mina/filter/logging/MdcInjectionFilter.html#filter-org.apache.mina.core.filterchain.IoFilterEvent-">filter</a></span>(<a href="../../../../../org/apache/mina/core/filterchain/IoFilterEvent.html" title="class in org.apache.mina.core.filterchain">IoFilterEvent</a> event)</code> </td> |
| </tr> |
| <tr id="i2" class="altColor"> |
| <td class="colFirst"><code>static <a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/mina/filter/logging/MdcInjectionFilter.html#getProperty-org.apache.mina.core.session.IoSession-java.lang.String-">getProperty</a></span>(<a href="../../../../../org/apache/mina/core/session/IoSession.html" title="interface in org.apache.mina.core.session">IoSession</a> session, |
| <a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> key)</code> </td> |
| </tr> |
| <tr id="i3" class="rowColor"> |
| <td class="colFirst"><code>static void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/mina/filter/logging/MdcInjectionFilter.html#removeProperty-org.apache.mina.core.session.IoSession-java.lang.String-">removeProperty</a></span>(<a href="../../../../../org/apache/mina/core/session/IoSession.html" title="interface in org.apache.mina.core.session">IoSession</a> session, |
| <a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> key)</code> </td> |
| </tr> |
| <tr id="i4" class="altColor"> |
| <td class="colFirst"><code>static void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/mina/filter/logging/MdcInjectionFilter.html#setProperty-org.apache.mina.core.session.IoSession-java.lang.String-java.lang.String-">setProperty</a></span>(<a href="../../../../../org/apache/mina/core/session/IoSession.html" title="interface in org.apache.mina.core.session">IoSession</a> session, |
| <a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> key, |
| <a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> value)</code> |
| <div class="block">Add a property to the context for the given session |
| This property will be added to the MDC for all subsequent events</div> |
| </td> |
| </tr> |
| </table> |
| <ul class="blockList"> |
| <li class="blockList"><a name="methods.inherited.from.class.org.apache.mina.filter.util.CommonEventFilter"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from class org.apache.mina.filter.util.<a href="../../../../../org/apache/mina/filter/util/CommonEventFilter.html" title="class in org.apache.mina.filter.util">CommonEventFilter</a></h3> |
| <code><a href="../../../../../org/apache/mina/filter/util/CommonEventFilter.html#exceptionCaught-org.apache.mina.core.filterchain.IoFilter.NextFilter-org.apache.mina.core.session.IoSession-java.lang.Throwable-">exceptionCaught</a>, <a href="../../../../../org/apache/mina/filter/util/CommonEventFilter.html#filterClose-org.apache.mina.core.filterchain.IoFilter.NextFilter-org.apache.mina.core.session.IoSession-">filterClose</a>, <a href="../../../../../org/apache/mina/filter/util/CommonEventFilter.html#filterWrite-org.apache.mina.core.filterchain.IoFilter.NextFilter-org.apache.mina.core.session.IoSession-org.apache.mina.core.write.WriteRequest-">filterWrite</a>, <a href="../../../../../org/apache/mina/filter/util/CommonEventFilter.html#messageReceived-org.apache.mina.core.filterchain.IoFilter.NextFilter-org.apache.mina.core.session.IoSession-java.lang.Object-">messageReceived</a>, <a href="../../../../../org/apache/mina/filter/util/CommonEventFilter.html#messageSent-org.apache.mina.core.filterchain.IoFilter.NextFilter-org.apache.mina.core.session.IoSession-org.apache.mina.core.write.WriteRequest-">messageSent</a>, <a href="../../../../../org/apache/mina/filter/util/CommonEventFilter.html#sessionClosed-org.apache.mina.core.filterchain.IoFilter.NextFilter-org.apache.mina.core.session.IoSession-">sessionClosed</a>, <a href="../../../../../org/apache/mina/filter/util/CommonEventFilter.html#sessionCreated-org.apache.mina.core.filterchain.IoFilter.NextFilter-org.apache.mina.core.session.IoSession-">sessionCreated</a>, <a href="../../../../../org/apache/mina/filter/util/CommonEventFilter.html#sessionIdle-org.apache.mina.core.filterchain.IoFilter.NextFilter-org.apache.mina.core.session.IoSession-org.apache.mina.core.session.IdleStatus-">sessionIdle</a>, <a href="../../../../../org/apache/mina/filter/util/CommonEventFilter.html#sessionOpened-org.apache.mina.core.filterchain.IoFilter.NextFilter-org.apache.mina.core.session.IoSession-">sessionOpened</a></code></li> |
| </ul> |
| <ul class="blockList"> |
| <li class="blockList"><a name="methods.inherited.from.class.org.apache.mina.core.filterchain.IoFilterAdapter"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from class org.apache.mina.core.filterchain.<a href="../../../../../org/apache/mina/core/filterchain/IoFilterAdapter.html" title="class in org.apache.mina.core.filterchain">IoFilterAdapter</a></h3> |
| <code><a href="../../../../../org/apache/mina/core/filterchain/IoFilterAdapter.html#destroy--">destroy</a>, <a href="../../../../../org/apache/mina/core/filterchain/IoFilterAdapter.html#init--">init</a>, <a href="../../../../../org/apache/mina/core/filterchain/IoFilterAdapter.html#inputClosed-org.apache.mina.core.filterchain.IoFilter.NextFilter-org.apache.mina.core.session.IoSession-">inputClosed</a>, <a href="../../../../../org/apache/mina/core/filterchain/IoFilterAdapter.html#onPostAdd-org.apache.mina.core.filterchain.IoFilterChain-java.lang.String-org.apache.mina.core.filterchain.IoFilter.NextFilter-">onPostAdd</a>, <a href="../../../../../org/apache/mina/core/filterchain/IoFilterAdapter.html#onPostRemove-org.apache.mina.core.filterchain.IoFilterChain-java.lang.String-org.apache.mina.core.filterchain.IoFilter.NextFilter-">onPostRemove</a>, <a href="../../../../../org/apache/mina/core/filterchain/IoFilterAdapter.html#onPreAdd-org.apache.mina.core.filterchain.IoFilterChain-java.lang.String-org.apache.mina.core.filterchain.IoFilter.NextFilter-">onPreAdd</a>, <a href="../../../../../org/apache/mina/core/filterchain/IoFilterAdapter.html#onPreRemove-org.apache.mina.core.filterchain.IoFilterChain-java.lang.String-org.apache.mina.core.filterchain.IoFilter.NextFilter-">onPreRemove</a>, <a href="../../../../../org/apache/mina/core/filterchain/IoFilterAdapter.html#toString--">toString</a></code></li> |
| </ul> |
| <ul class="blockList"> |
| <li class="blockList"><a name="methods.inherited.from.class.java.lang.Object"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from class java.lang.<a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></h3> |
| <code><a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true#clone--" title="class or interface in java.lang">clone</a>, <a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true#equals-java.lang.Object-" title="class or interface in java.lang">equals</a>, <a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true#finalize--" title="class or interface in java.lang">finalize</a>, <a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true#getClass--" title="class or interface in java.lang">getClass</a>, <a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true#hashCode--" title="class or interface in java.lang">hashCode</a>, <a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true#notify--" title="class or interface in java.lang">notify</a>, <a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true#notifyAll--" title="class or interface in java.lang">notifyAll</a>, <a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true#wait--" title="class or interface in java.lang">wait</a>, <a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true#wait-long-" title="class or interface in java.lang">wait</a>, <a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true#wait-long-int-" title="class or interface in java.lang">wait</a></code></li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </div> |
| <div class="details"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ========= CONSTRUCTOR DETAIL ======== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="constructor.detail"> |
| <!-- --> |
| </a> |
| <h3>Constructor Detail</h3> |
| <a name="MdcInjectionFilter-java.util.EnumSet-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>MdcInjectionFilter</h4> |
| <pre>public <a href="../../../../../src-html/org/apache/mina/filter/logging/MdcInjectionFilter.html#line.98">MdcInjectionFilter</a>(<a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/util/EnumSet.html?is-external=true" title="class or interface in java.util">EnumSet</a><<a href="../../../../../org/apache/mina/filter/logging/MdcInjectionFilter.MdcKey.html" title="enum in org.apache.mina.filter.logging">MdcInjectionFilter.MdcKey</a>> keys)</pre> |
| <div class="block">Use this constructor when you want to specify which keys to add to the MDC. |
| You could still add custom keys via <a href="../../../../../org/apache/mina/filter/logging/MdcInjectionFilter.html#setProperty-org.apache.mina.core.session.IoSession-java.lang.String-java.lang.String-"><code>setProperty(IoSession, String, String)</code></a></div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>keys</code> - set of keys that should be added to the MDC</dd> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../../../org/apache/mina/filter/logging/MdcInjectionFilter.html#setProperty-org.apache.mina.core.session.IoSession-java.lang.String-java.lang.String-"><code>setProperty(org.apache.mina.core.session.IoSession, String, String)</code></a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="MdcInjectionFilter-org.apache.mina.filter.logging.MdcInjectionFilter.MdcKey...-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>MdcInjectionFilter</h4> |
| <pre>public <a href="../../../../../src-html/org/apache/mina/filter/logging/MdcInjectionFilter.html#line.109">MdcInjectionFilter</a>(<a href="../../../../../org/apache/mina/filter/logging/MdcInjectionFilter.MdcKey.html" title="enum in org.apache.mina.filter.logging">MdcInjectionFilter.MdcKey</a>... keys)</pre> |
| <div class="block">Use this constructor when you want to specify which keys to add to the MDC |
| You could still add custom keys via <a href="../../../../../org/apache/mina/filter/logging/MdcInjectionFilter.html#setProperty-org.apache.mina.core.session.IoSession-java.lang.String-java.lang.String-"><code>setProperty(IoSession, String, String)</code></a></div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>keys</code> - list of keys that should be added to the MDC</dd> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../../../org/apache/mina/filter/logging/MdcInjectionFilter.html#setProperty-org.apache.mina.core.session.IoSession-java.lang.String-java.lang.String-"><code>setProperty(org.apache.mina.core.session.IoSession, String, String)</code></a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="MdcInjectionFilter--"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>MdcInjectionFilter</h4> |
| <pre>public <a href="../../../../../src-html/org/apache/mina/filter/logging/MdcInjectionFilter.html#line.114">MdcInjectionFilter</a>()</pre> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| <!-- ============ METHOD DETAIL ========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="method.detail"> |
| <!-- --> |
| </a> |
| <h3>Method Detail</h3> |
| <a name="filter-org.apache.mina.core.filterchain.IoFilterEvent-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>filter</h4> |
| <pre>protected void <a href="../../../../../src-html/org/apache/mina/filter/logging/MdcInjectionFilter.html#line.119">filter</a>(<a href="../../../../../org/apache/mina/core/filterchain/IoFilterEvent.html" title="class in org.apache.mina.core.filterchain">IoFilterEvent</a> event) |
| throws <a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang">Exception</a></pre> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../../org/apache/mina/filter/util/CommonEventFilter.html#filter-org.apache.mina.core.filterchain.IoFilterEvent-">filter</a></code> in class <code><a href="../../../../../org/apache/mina/filter/util/CommonEventFilter.html" title="class in org.apache.mina.filter.util">CommonEventFilter</a></code></dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang">Exception</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="fillContext-org.apache.mina.core.session.IoSession-java.util.Map-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>fillContext</h4> |
| <pre>protected void <a href="../../../../../src-html/org/apache/mina/filter/logging/MdcInjectionFilter.html#line.173">fillContext</a>(<a href="../../../../../org/apache/mina/core/session/IoSession.html" title="interface in org.apache.mina.core.session">IoSession</a> session, |
| <a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</a><<a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>,<a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>> context)</pre> |
| <div class="block">write key properties of the session to the Mapped Diagnostic Context |
| sub-classes could override this method to map more/other attributes</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>session</code> - the session to map</dd> |
| <dd><code>context</code> - key properties will be added to this map</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getProperty-org.apache.mina.core.session.IoSession-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getProperty</h4> |
| <pre>public static <a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> <a href="../../../../../src-html/org/apache/mina/filter/logging/MdcInjectionFilter.html#line.202">getProperty</a>(<a href="../../../../../org/apache/mina/core/session/IoSession.html" title="interface in org.apache.mina.core.session">IoSession</a> session, |
| <a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> key)</pre> |
| </li> |
| </ul> |
| <a name="setProperty-org.apache.mina.core.session.IoSession-java.lang.String-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setProperty</h4> |
| <pre>public static void <a href="../../../../../src-html/org/apache/mina/filter/logging/MdcInjectionFilter.html#line.223">setProperty</a>(<a href="../../../../../org/apache/mina/core/session/IoSession.html" title="interface in org.apache.mina.core.session">IoSession</a> session, |
| <a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> key, |
| <a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> value)</pre> |
| <div class="block">Add a property to the context for the given session |
| This property will be added to the MDC for all subsequent events</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>session</code> - The session for which you want to set a property</dd> |
| <dd><code>key</code> - The name of the property (should not be null)</dd> |
| <dd><code>value</code> - The value of the property</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="removeProperty-org.apache.mina.core.session.IoSession-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>removeProperty</h4> |
| <pre>public static void <a href="../../../../../src-html/org/apache/mina/filter/logging/MdcInjectionFilter.html#line.235">removeProperty</a>(<a href="../../../../../org/apache/mina/core/session/IoSession.html" title="interface in org.apache.mina.core.session">IoSession</a> session, |
| <a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> key)</pre> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </div> |
| </div> |
| <!-- ========= END OF CLASS DATA ========= --> |
| <!-- ======= START OF BOTTOM NAVBAR ====== --> |
| <div class="bottomNav"><a name="navbar.bottom"> |
| <!-- --> |
| </a> |
| <div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div> |
| <a name="navbar.bottom.firstrow"> |
| <!-- --> |
| </a> |
| <ul class="navList" title="Navigation"> |
| <li><a href="../../../../../overview-summary.html">Overview</a></li> |
| <li><a href="package-summary.html">Package</a></li> |
| <li class="navBarCell1Rev">Class</li> |
| <li><a href="class-use/MdcInjectionFilter.html">Use</a></li> |
| <li><a href="package-tree.html">Tree</a></li> |
| <li><a href="../../../../../deprecated-list.html">Deprecated</a></li> |
| <li><a href="../../../../../index-all.html">Index</a></li> |
| <li><a href="../../../../../help-doc.html">Help</a></li> |
| </ul> |
| </div> |
| <div class="subNav"> |
| <ul class="navList"> |
| <li><a href="../../../../../org/apache/mina/filter/logging/LogLevel.html" title="enum in org.apache.mina.filter.logging"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../../../org/apache/mina/filter/logging/MdcInjectionFilter.MdcKey.html" title="enum in org.apache.mina.filter.logging"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../../index.html?org/apache/mina/filter/logging/MdcInjectionFilter.html" target="_top">Frames</a></li> |
| <li><a href="MdcInjectionFilter.html" target="_top">No Frames</a></li> |
| </ul> |
| <ul class="navList" id="allclasses_navbar_bottom"> |
| <li><a href="../../../../../allclasses-noframe.html">All Classes</a></li> |
| </ul> |
| <div> |
| <script type="text/javascript"><!-- |
| allClassesLink = document.getElementById("allclasses_navbar_bottom"); |
| if(window==top) { |
| allClassesLink.style.display = "block"; |
| } |
| else { |
| allClassesLink.style.display = "none"; |
| } |
| //--> |
| </script> |
| </div> |
| <div> |
| <ul class="subNavList"> |
| <li>Summary: </li> |
| <li><a href="#nested.class.summary">Nested</a> | </li> |
| <li>Field | </li> |
| <li><a href="#constructor.summary">Constr</a> | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li><a href="#constructor.detail">Constr</a> | </li> |
| <li><a href="#method.detail">Method</a></li> |
| </ul> |
| </div> |
| <a name="skip.navbar.bottom"> |
| <!-- --> |
| </a></div> |
| <!-- ======== END OF BOTTOM NAVBAR ======= --> |
| <p class="legalCopy"><small>Copyright © 2004–2016 <a href="http://mina.apache.org/">Apache MINA Project</a>. All rights reserved.</small></p> |
| </body> |
| </html> |
