iofilterchain.html

MINA+API 关于MINA的API

<a name="109" href="#109">109</a> <em class="jxr_javadoccomment">     * specified &lt;tt&gt;name&lt;/tt&gt;.</em>
<a name="110" href="#110">110</a> <em class="jxr_javadoccomment">     */</em>
<a name="111" href="#111">111</a>     <strong class="jxr_keyword">boolean</strong> contains(String name);
<a name="112" href="#112">112</a> 
<a name="113" href="#113">113</a>     <em class="jxr_javadoccomment">/**</em>
<a name="114" href="#114">114</a> <em class="jxr_javadoccomment">     * Returns &lt;tt&gt;true&lt;/tt&gt; if this chain contains the specified &lt;tt&gt;filter&lt;/tt&gt;.</em>
<a name="115" href="#115">115</a> <em class="jxr_javadoccomment">     */</em>
<a name="116" href="#116">116</a>     <strong class="jxr_keyword">boolean</strong> contains(<a href="../../../../org/apache/mina/common/IoFilter.html">IoFilter</a> filter);
<a name="117" href="#117">117</a> 
<a name="118" href="#118">118</a>     <em class="jxr_javadoccomment">/**</em>
<a name="119" href="#119">119</a> <em class="jxr_javadoccomment">     * Returns &lt;tt&gt;true&lt;/tt&gt; if this chain contains an {@link IoFilter} of the</em>
<a name="120" href="#120">120</a> <em class="jxr_javadoccomment">     * specified &lt;tt&gt;filterType&lt;/tt&gt;.</em>
<a name="121" href="#121">121</a> <em class="jxr_javadoccomment">     */</em>
<a name="122" href="#122">122</a>     <strong class="jxr_keyword">boolean</strong> contains(Class&lt;? <strong class="jxr_keyword">extends</strong> IoFilter&gt; filterType);
<a name="123" href="#123">123</a> 
<a name="124" href="#124">124</a>     <em class="jxr_javadoccomment">/**</em>
<a name="125" href="#125">125</a> <em class="jxr_javadoccomment">     * Adds the specified filter with the specified name at the beginning of this chain.</em>
<a name="126" href="#126">126</a> <em class="jxr_javadoccomment">     * @throws IoFilterLifeCycleException</em>
<a name="127" href="#127">127</a> <em class="jxr_javadoccomment">     *             if {@link IoFilter#onPostAdd(IoFilterChain, String, NextFilter)} or</em>
<a name="128" href="#128">128</a> <em class="jxr_javadoccomment">     *             {@link IoFilter#init()} throws an exception.</em>
<a name="129" href="#129">129</a> <em class="jxr_javadoccomment">     */</em>
<a name="130" href="#130">130</a>     <strong class="jxr_keyword">void</strong> addFirst(String name, <a href="../../../../org/apache/mina/common/IoFilter.html">IoFilter</a> filter);
<a name="131" href="#131">131</a> 
<a name="132" href="#132">132</a>     <em class="jxr_javadoccomment">/**</em>
<a name="133" href="#133">133</a> <em class="jxr_javadoccomment">     * Adds the specified filter with the specified name at the end of this chain.</em>
<a name="134" href="#134">134</a> <em class="jxr_javadoccomment">     * @throws IoFilterLifeCycleException</em>
<a name="135" href="#135">135</a> <em class="jxr_javadoccomment">     *             if {@link IoFilter#onPostAdd(IoFilterChain, String, NextFilter)} or</em>
<a name="136" href="#136">136</a> <em class="jxr_javadoccomment">     *             {@link IoFilter#init()} throws an exception.</em>
<a name="137" href="#137">137</a> <em class="jxr_javadoccomment">     */</em>
<a name="138" href="#138">138</a>     <strong class="jxr_keyword">void</strong> addLast(String name, <a href="../../../../org/apache/mina/common/IoFilter.html">IoFilter</a> filter);
<a name="139" href="#139">139</a> 
<a name="140" href="#140">140</a>     <em class="jxr_javadoccomment">/**</em>
<a name="141" href="#141">141</a> <em class="jxr_javadoccomment">     * Adds the specified filter with the specified name just before the filter whose name is</em>
<a name="142" href="#142">142</a> <em class="jxr_javadoccomment">     * &lt;code&gt;baseName&lt;/code&gt; in this chain.</em>
<a name="143" href="#143">143</a> <em class="jxr_javadoccomment">     * @throws IoFilterLifeCycleException</em>
<a name="144" href="#144">144</a> <em class="jxr_javadoccomment">     *             if {@link IoFilter#onPostAdd(IoFilterChain, String, NextFilter)} or</em>
<a name="145" href="#145">145</a> <em class="jxr_javadoccomment">     *             {@link IoFilter#init()} throws an exception.</em>
<a name="146" href="#146">146</a> <em class="jxr_javadoccomment">     */</em>
<a name="147" href="#147">147</a>     <strong class="jxr_keyword">void</strong> addBefore(String baseName, String name, <a href="../../../../org/apache/mina/common/IoFilter.html">IoFilter</a> filter);
<a name="148" href="#148">148</a> 
<a name="149" href="#149">149</a>     <em class="jxr_javadoccomment">/**</em>
<a name="150" href="#150">150</a> <em class="jxr_javadoccomment">     * Adds the specified filter with the specified name just after the filter whose name is</em>
<a name="151" href="#151">151</a> <em class="jxr_javadoccomment">     * &lt;code&gt;baseName&lt;/code&gt; in this chain.</em>
<a name="152" href="#152">152</a> <em class="jxr_javadoccomment">     * @throws IoFilterLifeCycleException</em>
<a name="153" href="#153">153</a> <em class="jxr_javadoccomment">     *             if {@link IoFilter#onPostAdd(IoFilterChain, String, NextFilter)} or</em>
<a name="154" href="#154">154</a> <em class="jxr_javadoccomment">     *             {@link IoFilter#init()} throws an exception.</em>
<a name="155" href="#155">155</a> <em class="jxr_javadoccomment">     */</em>
<a name="156" href="#156">156</a>     <strong class="jxr_keyword">void</strong> addAfter(String baseName, String name, <a href="../../../../org/apache/mina/common/IoFilter.html">IoFilter</a> filter);
<a name="157" href="#157">157</a> 
<a name="158" href="#158">158</a>     <em class="jxr_javadoccomment">/**</em>
<a name="159" href="#159">159</a> <em class="jxr_javadoccomment">     * Replace the filter with the specified name with the specified new</em>
<a name="160" href="#160">160</a> <em class="jxr_javadoccomment">     * filter.</em>
<a name="161" href="#161">161</a> <em class="jxr_javadoccomment">     *</em>
<a name="162" href="#162">162</a> <em class="jxr_javadoccomment">     * @return the old filter</em>
<a name="163" href="#163">163</a> <em class="jxr_javadoccomment">     * @throws IllegalArgumentException if there's no such filter</em>
<a name="164" href="#164">164</a> <em class="jxr_javadoccomment">     */</em>
<a name="165" href="#165">165</a>     <a href="../../../../org/apache/mina/common/IoFilter.html">IoFilter</a> replace(String name, <a href="../../../../org/apache/mina/common/IoFilter.html">IoFilter</a> newFilter);
<a name="166" href="#166">166</a> 
<a name="167" href="#167">167</a>     <em class="jxr_javadoccomment">/**</em>
<a name="168" href="#168">168</a> <em class="jxr_javadoccomment">     * Replace the filter with the specified name with the specified new</em>
<a name="169" href="#169">169</a> <em class="jxr_javadoccomment">     * filter.</em>
<a name="170" href="#170">170</a> <em class="jxr_javadoccomment">     *</em>
<a name="171" href="#171">171</a> <em class="jxr_javadoccomment">     * @throws IllegalArgumentException if there's no such filter</em>
<a name="172" href="#172">172</a> <em class="jxr_javadoccomment">     */</em>
<a name="173" href="#173">173</a>     <strong class="jxr_keyword">void</strong> replace(<a href="../../../../org/apache/mina/common/IoFilter.html">IoFilter</a> oldFilter, <a href="../../../../org/apache/mina/common/IoFilter.html">IoFilter</a> newFilter);
<a name="174" href="#174">174</a> 
<a name="175" href="#175">175</a>     <em class="jxr_javadoccomment">/**</em>
<a name="176" href="#176">176</a> <em class="jxr_javadoccomment">     * Replace the filter of the specified type with the specified new</em>
<a name="177" href="#177">177</a> <em class="jxr_javadoccomment">     * filter.  If there's more than one filter with the specified type,</em>
<a name="178" href="#178">178</a> <em class="jxr_javadoccomment">     * the first match will be replaced.</em>
<a name="179" href="#179">179</a> <em class="jxr_javadoccomment">     *</em>
<a name="180" href="#180">180</a> <em class="jxr_javadoccomment">     * @throws IllegalArgumentException if there's no such filter</em>
<a name="181" href="#181">181</a> <em class="jxr_javadoccomment">     */</em>
<a name="182" href="#182">182</a>     <a href="../../../../org/apache/mina/common/IoFilter.html">IoFilter</a> replace(Class&lt;? <strong class="jxr_keyword">extends</strong> IoFilter&gt; oldFilterType, <a href="../../../../org/apache/mina/common/IoFilter.html">IoFilter</a> newFilter);
<a name="183" href="#183">183</a> 
<a name="184" href="#184">184</a>     <em class="jxr_javadoccomment">/**</em>
<a name="185" href="#185">185</a> <em class="jxr_javadoccomment">     * Removes the filter with the specified name from this chain.</em>
<a name="186" href="#186">186</a> <em class="jxr_javadoccomment">     * @throws IoFilterLifeCycleException</em>
<a name="187" href="#187">187</a> <em class="jxr_javadoccomment">     *             if {@link IoFilter#onPostRemove(IoFilterChain, String, NextFilter)} or</em>
<a name="188" href="#188">188</a> <em class="jxr_javadoccomment">     *             {@link IoFilter#destroy()} throws an exception.</em>
<a name="189" href="#189">189</a> <em class="jxr_javadoccomment">     */</em>
<a name="190" href="#190">190</a>     <a href="../../../../org/apache/mina/common/IoFilter.html">IoFilter</a> remove(String name);
<a name="191" href="#191">191</a> 
<a name="192" href="#192">192</a>     <em class="jxr_javadoccomment">/**</em>
<a name="193" href="#193">193</a> <em class="jxr_javadoccomment">     * Replace the filter with the specified name with the specified new</em>
<a name="194" href="#194">194</a> <em class="jxr_javadoccomment">     * filter.</em>
<a name="195" href="#195">195</a> <em class="jxr_javadoccomment">     *</em>
<a name="196" href="#196">196</a> <em class="jxr_javadoccomment">     * @throws IllegalArgumentException if there's no such filter</em>
<a name="197" href="#197">197</a> <em class="jxr_javadoccomment">     */</em>
<a name="198" href="#198">198</a>     <strong class="jxr_keyword">void</strong> remove(<a href="../../../../org/apache/mina/common/IoFilter.html">IoFilter</a> filter);
<a name="199" href="#199">199</a> 
<a name="200" href="#200">200</a>     <em class="jxr_javadoccomment">/**</em>
<a name="201" href="#201">201</a> <em class="jxr_javadoccomment">     * Replace the filter of the specified type with the specified new</em>
<a name="202" href="#202">202</a> <em class="jxr_javadoccomment">     * filter.  If there's more than one filter with the specified type,</em>
<a name="203" href="#203">203</a> <em class="jxr_javadoccomment">     * the first match will be replaced.</em>
<a name="204" href="#204">204</a> <em class="jxr_javadoccomment">     *</em>
<a name="205" href="#205">205</a> <em class="jxr_javadoccomment">     * @throws IllegalArgumentException if there's no such filter</em>
<a name="206" href="#206">206</a> <em class="jxr_javadoccomment">     */</em>
<a name="207" href="#207">207</a>     <a href="../../../../org/apache/mina/common/IoFilter.html">IoFilter</a> remove(Class&lt;? <strong class="jxr_keyword">extends</strong> IoFilter&gt; filterType);
<a name="208" href="#208">208</a> 
<a name="209" href="#209">209</a>     <em class="jxr_javadoccomment">/**</em>
<a name="210" href="#210">210</a> <em class="jxr_javadoccomment">     * Removes all filters added to this chain.</em>
<a name="211" href="#211">211</a> <em class="jxr_javadoccomment">     * @throws Exception if {@link IoFilter#onPostRemove(IoFilterChain, String, NextFilter)} thrown an exception.</em>
<a name="212" href="#212">212</a> <em class="jxr_javadoccomment">     */</em>
<a name="213" href="#213">213</a>     <strong class="jxr_keyword">void</strong> clear() <strong class="jxr_keyword">throws</strong> Exception;
<a name="214" href="#214">214</a> 
<a name="215" href="#215">215</a>     <em class="jxr_javadoccomment">/**</em>
<a name="216" href="#216">216</a> <em class="jxr_javadoccomment">     * Fires a {@link IoHandler#sessionCreated(IoSession)} event.  Most users don't need to</em>
<a name="217" href="#217">217</a> <em class="jxr_javadoccomment">     * call this method at all.  Please use this method only when you implement a new transport</em>
<a name="218" href="#218">218</a> <em class="jxr_javadoccomment">     * or fire a virtual event.</em>
<a name="219" href="#219">219</a> <em class="jxr_javadoccomment">     */</em>
<a name="220" href="#220">220</a>     <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> fireSessionCreated();
<a name="221" href="#221">221</a> 
<a name="222" href="#222">222</a>     <em class="jxr_javadoccomment">/**</em>
<a name="223" href="#223">223</a> <em class="jxr_javadoccomment">     * Fires a {@link IoHandler#sessionOpened(IoSession)} event.  Most users don't need to call</em>
<a name="224" href="#224">224</a> <em class="jxr_javadoccomment">     * this method at all.  Please use this method only when you implement a new transport or</em>
<a name="225" href="#225">225</a> <em class="jxr_javadoccomment">     * fire a virtual event.</em>
<a name="226" href="#226">226</a> <em class="jxr_javadoccomment">     */</em>