📄 iofilter.html
字号:
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"><html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en"><head><meta http-equiv="content-type" content="text/html; charset=UTF-8" /><title>IoFilter xref</title><link type="text/css" rel="stylesheet" href="../../../../stylesheet.css" /></head><body><div id="overview"><a href="../../../../../apidocs/org/apache/mina/common/IoFilter.html">View Javadoc</a></div><pre><a name="1" href="#1">1</a> <em class="jxr_comment">/*</em><a name="2" href="#2">2</a> <em class="jxr_comment"> * Licensed to the Apache Software Foundation (ASF) under one</em><a name="3" href="#3">3</a> <em class="jxr_comment"> * or more contributor license agreements. See the NOTICE file</em><a name="4" href="#4">4</a> <em class="jxr_comment"> * distributed with this work for additional information</em><a name="5" href="#5">5</a> <em class="jxr_comment"> * regarding copyright ownership. The ASF licenses this file</em><a name="6" href="#6">6</a> <em class="jxr_comment"> * to you under the Apache License, Version 2.0 (the</em><a name="7" href="#7">7</a> <em class="jxr_comment"> * "License"); you may not use this file except in compliance</em><a name="8" href="#8">8</a> <em class="jxr_comment"> * with the License. You may obtain a copy of the License at</em><a name="9" href="#9">9</a> <em class="jxr_comment"> *</em><a name="10" href="#10">10</a> <em class="jxr_comment"> * <a href="http://www.apache.org/licenses/LICENSE-2.0" target="alexandria_uri">http://www.apache.org/licenses/LICENSE-2.0</a></em><a name="11" href="#11">11</a> <em class="jxr_comment"> *</em><a name="12" href="#12">12</a> <em class="jxr_comment"> * Unless required by applicable law or agreed to in writing,</em><a name="13" href="#13">13</a> <em class="jxr_comment"> * software distributed under the License is distributed on an</em><a name="14" href="#14">14</a> <em class="jxr_comment"> * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY</em><a name="15" href="#15">15</a> <em class="jxr_comment"> * KIND, either express or implied. See the License for the</em><a name="16" href="#16">16</a> <em class="jxr_comment"> * specific language governing permissions and limitations</em><a name="17" href="#17">17</a> <em class="jxr_comment"> * under the License.</em><a name="18" href="#18">18</a> <em class="jxr_comment"> *</em><a name="19" href="#19">19</a> <em class="jxr_comment"> */</em><a name="20" href="#20">20</a> <strong class="jxr_keyword">package</strong> org.apache.mina.common;<a name="21" href="#21">21</a> <a name="22" href="#22">22</a> <strong class="jxr_keyword">import</strong> org.apache.mina.filter.util.ReferenceCountingFilter;<a name="23" href="#23">23</a> <a name="24" href="#24">24</a> <em class="jxr_javadoccomment">/**</em><a name="25" href="#25">25</a> <em class="jxr_javadoccomment"> * A filter which intercepts {@link IoHandler} events like Servlet</em><a name="26" href="#26">26</a> <em class="jxr_javadoccomment"> * filters. Filters can be used for these purposes:</em><a name="27" href="#27">27</a> <em class="jxr_javadoccomment"> * <ul></em><a name="28" href="#28">28</a> <em class="jxr_javadoccomment"> * <li>Event logging,</li></em><a name="29" href="#29">29</a> <em class="jxr_javadoccomment"> * <li>Performance measurement,</li></em><a name="30" href="#30">30</a> <em class="jxr_javadoccomment"> * <li>Authorization,</li></em><a name="31" href="#31">31</a> <em class="jxr_javadoccomment"> * <li>Overload control,</li></em><a name="32" href="#32">32</a> <em class="jxr_javadoccomment"> * <li>Message transformation (e.g. encryption and decryption, ...),</li></em><a name="33" href="#33">33</a> <em class="jxr_javadoccomment"> * <li>and many more.</li></em><a name="34" href="#34">34</a> <em class="jxr_javadoccomment"> * </ul></em><a name="35" href="#35">35</a> <em class="jxr_javadoccomment"> * <p></em><a name="36" href="#36">36</a> <em class="jxr_javadoccomment"> * <strong>Please NEVER implement your filters to wrap</em><a name="37" href="#37">37</a> <em class="jxr_javadoccomment"> * {@link IoSession}s.</strong> Users can cache the reference to the</em><a name="38" href="#38">38</a> <em class="jxr_javadoccomment"> * session, which might malfunction if any filters are added or removed later.</em><a name="39" href="#39">39</a> <em class="jxr_javadoccomment"> *</em><a name="40" href="#40">40</a> <em class="jxr_javadoccomment"> * <h3>The Life Cycle</h3></em><a name="41" href="#41">41</a> <em class="jxr_javadoccomment"> * {@link IoFilter}s are activated only when they are inside {@link IoFilterChain}.</em><a name="42" href="#42">42</a> <em class="jxr_javadoccomment"> * <p></em><a name="43" href="#43">43</a> <em class="jxr_javadoccomment"> * When you add an {@link IoFilter} to an {@link IoFilterChain}:</em><a name="44" href="#44">44</a> <em class="jxr_javadoccomment"> * <ol></em><a name="45" href="#45">45</a> <em class="jxr_javadoccomment"> * <li>{@link #init()} is invoked by {@link ReferenceCountingFilter} if</em><a name="46" href="#46">46</a> <em class="jxr_javadoccomment"> * the filter is added at the first time.</li></em><a name="47" href="#47">47</a> <em class="jxr_javadoccomment"> * <li>{@link #onPreAdd(IoFilterChain, String, NextFilter)} is invoked to notify</em><a name="48" href="#48">48</a> <em class="jxr_javadoccomment"> * that the filter will be added to the chain.</li></em><a name="49" href="#49">49</a> <em class="jxr_javadoccomment"> * <li>The filter is added to the chain, and all events and I/O requests</em><a name="50" href="#50">50</a> <em class="jxr_javadoccomment"> * pass through the filter from now.</li></em><a name="51" href="#51">51</a> <em class="jxr_javadoccomment"> * <li>{@link #onPostAdd(IoFilterChain, String, NextFilter)} is invoked to notify</em><a name="52" href="#52">52</a> <em class="jxr_javadoccomment"> * that the filter is added to the chain.</li></em><a name="53" href="#53">53</a> <em class="jxr_javadoccomment"> * <li>The filter is removed from the chain if {@link #onPostAdd(IoFilterChain, String, org.apache.mina.common.IoFilter.NextFilter)}</em><a name="54" href="#54">54</a> <em class="jxr_javadoccomment"> * threw an exception. {@link #destroy()} is also invoked by</em><a name="55" href="#55">55</a> <em class="jxr_javadoccomment"> * {@link ReferenceCountingFilter} if the filter is the last filter which</em><a name="56" href="#56">56</a> <em class="jxr_javadoccomment"> * was added to {@link IoFilterChain}s.</li></em><a name="57" href="#57">57</a> <em class="jxr_javadoccomment"> * </ol></em><a name="58" href="#58">58</a> <em class="jxr_javadoccomment"> * <p></em><a name="59" href="#59">59</a> <em class="jxr_javadoccomment"> * When you remove an {@link IoFilter} from an {@link IoFilterChain}:</em><a name="60" href="#60">60</a> <em class="jxr_javadoccomment"> * <ol></em><a name="61" href="#61">61</a> <em class="jxr_javadoccomment"> * <li>{@link #onPreRemove(IoFilterChain, String, NextFilter)} is invoked to</em><a name="62" href="#62">62</a> <em class="jxr_javadoccomment"> * notify that the filter will be removed from the chain.</li></em><a name="63" href="#63">63</a> <em class="jxr_javadoccomment"> * <li>The filter is removed from the chain, and any events and I/O requests</em><a name="64" href="#64">64</a> <em class="jxr_javadoccomment"> * don't pass through the filter from now.</li></em><a name="65" href="#65">65</a> <em class="jxr_javadoccomment"> * <li>{@link #onPostRemove(IoFilterChain, String, NextFilter)} is invoked to</em><a name="66" href="#66">66</a> <em class="jxr_javadoccomment"> * notify that the filter is removed from the chain.</li></em><a name="67" href="#67">67</a> <em class="jxr_javadoccomment"> * <li>{@link #destroy()} is invoked by {@link ReferenceCountingFilter} if</em><a name="68" href="#68">68</a> <em class="jxr_javadoccomment"> * the removed filter was the last one.</li></em><a name="69" href="#69">69</a> <em class="jxr_javadoccomment"> * </ol></em><a name="70" href="#70">70</a> <em class="jxr_javadoccomment"> *</em><a name="71" href="#71">71</a> <em class="jxr_javadoccomment"> * @author The Apache MINA Project (dev@mina.apache.org)</em><a name="72" href="#72">72</a> <em class="jxr_javadoccomment"> * @version $Rev: 591770 $, $Date: 2007-11-04 05:22:44 -0700 (Sun, 04 Nov 2007) $</em><a name="73" href="#73">73</a> <em class="jxr_javadoccomment"> *</em><a name="74" href="#74">74</a> <em class="jxr_javadoccomment"> * @see IoFilterAdapter</em><a name="75" href="#75">75</a> <em class="jxr_javadoccomment"> */</em><a name="76" href="#76">76</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">interface</strong> <a href="../../../../org/apache/mina/common/IoFilter.html">IoFilter</a> {<a name="77" href="#77">77</a> <em class="jxr_javadoccomment">/**</em><a name="78" href="#78">78</a> <em class="jxr_javadoccomment"> * Invoked by {@link ReferenceCountingFilter} when this filter</em><a name="79" href="#79">79</a> <em class="jxr_javadoccomment"> * is added to a {@link IoFilterChain} at the first time, so you can</em><a name="80" href="#80">80</a> <em class="jxr_javadoccomment"> * initialize shared resources. Please note that this method is never</em><a name="81" href="#81">81</a> <em class="jxr_javadoccomment"> * called if you don't wrap a filter with {@link ReferenceCountingFilter}.</em><a name="82" href="#82">82</a> <em class="jxr_javadoccomment"> */</em><a name="83" href="#83">83</a> <strong class="jxr_keyword">void</strong> init() <strong class="jxr_keyword">throws</strong> Exception;<a name="84" href="#84">84</a> ⌨️ 快捷键说明
复制代码
Ctrl + C
搜索代码
Ctrl + F
全屏模式
F11
切换主题
Ctrl + Shift + D
显示快捷键
?
增大字号
Ctrl + =
减小字号
Ctrl + -