compressionfilter.html

MINA+API 关于MINA的API

<a name="127" href="#127">127</a> <em class="jxr_javadoccomment">     *</em>
<a name="128" href="#128">128</a> <em class="jxr_javadoccomment">     * @param compressInbound &lt;tt&gt;true&lt;/tt&gt; if data read is to be decompressed</em>
<a name="129" href="#129">129</a> <em class="jxr_javadoccomment">     * @param compressOutbound &lt;tt&gt;true&lt;/tt&gt; if data written is to be compressed</em>
<a name="130" href="#130">130</a> <em class="jxr_javadoccomment">     * @param compressionLevel the level of compression to be used. Must</em>
<a name="131" href="#131">131</a> <em class="jxr_javadoccomment">     *                         be one of {@link #COMPRESSION_DEFAULT},</em>
<a name="132" href="#132">132</a> <em class="jxr_javadoccomment">     *                         {@link #COMPRESSION_MAX},</em>
<a name="133" href="#133">133</a> <em class="jxr_javadoccomment">     *                         {@link #COMPRESSION_MIN}, and</em>
<a name="134" href="#134">134</a> <em class="jxr_javadoccomment">     *                         {@link #COMPRESSION_NONE}.</em>
<a name="135" href="#135">135</a> <em class="jxr_javadoccomment">     */</em>
<a name="136" href="#136">136</a>     <strong class="jxr_keyword">public</strong> <a href="../../../../../org/apache/mina/filter/compression/CompressionFilter.html">CompressionFilter</a>(<strong class="jxr_keyword">final</strong> <strong class="jxr_keyword">boolean</strong> compressInbound,
<a name="137" href="#137">137</a>             <strong class="jxr_keyword">final</strong> <strong class="jxr_keyword">boolean</strong> compressOutbound, <strong class="jxr_keyword">final</strong> <strong class="jxr_keyword">int</strong> compressionLevel) {
<a name="138" href="#138">138</a>         <strong class="jxr_keyword">this</strong>.compressionLevel = compressionLevel;
<a name="139" href="#139">139</a>         <strong class="jxr_keyword">this</strong>.compressInbound = compressInbound;
<a name="140" href="#140">140</a>         <strong class="jxr_keyword">this</strong>.compressOutbound = compressOutbound;
<a name="141" href="#141">141</a>     }
<a name="142" href="#142">142</a> 
<a name="143" href="#143">143</a>     @Override
<a name="144" href="#144">144</a>     <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> messageReceived(<a href="../../../../../org/apache/mina/common/IoFilter.html">NextFilter</a> nextFilter, <a href="../../../../../org/apache/mina/common/IoSession.html">IoSession</a> session,
<a name="145" href="#145">145</a>             Object message) <strong class="jxr_keyword">throws</strong> Exception {
<a name="146" href="#146">146</a>         <strong class="jxr_keyword">if</strong> (!compressInbound) {
<a name="147" href="#147">147</a>             nextFilter.messageReceived(session, message);
<a name="148" href="#148">148</a>             <strong class="jxr_keyword">return</strong>;
<a name="149" href="#149">149</a>         }
<a name="150" href="#150">150</a> 
<a name="151" href="#151">151</a>         <a href="../../../../../org/apache/mina/filter/compression/Zlib.html">Zlib</a> inflater = (Zlib) session.getAttribute(INFLATER);
<a name="152" href="#152">152</a>         <strong class="jxr_keyword">if</strong> (inflater == <strong class="jxr_keyword">null</strong>) {
<a name="153" href="#153">153</a>             <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> IllegalStateException();
<a name="154" href="#154">154</a>         }
<a name="155" href="#155">155</a> 
<a name="156" href="#156">156</a>         <a href="../../../../../org/apache/mina/common/IoBuffer.html">IoBuffer</a> inBuffer = (IoBuffer) message;
<a name="157" href="#157">157</a>         <a href="../../../../../org/apache/mina/common/IoBuffer.html">IoBuffer</a> outBuffer = inflater.inflate(inBuffer);
<a name="158" href="#158">158</a>         nextFilter.messageReceived(session, outBuffer);
<a name="159" href="#159">159</a>     }
<a name="160" href="#160">160</a> 
<a name="161" href="#161">161</a>     <em class="jxr_comment">/*</em>
<a name="162" href="#162">162</a> <em class="jxr_comment">     * @see org.apache.mina.common.IoFilter#filterWrite(org.apache.mina.common.IoFilter.NextFilter, org.apache.mina.common.IoSession, org.apache.mina.common.IoFilter.WriteRequest)</em>
<a name="163" href="#163">163</a> <em class="jxr_comment">     */</em>
<a name="164" href="#164">164</a>     @Override
<a name="165" href="#165">165</a>     <strong class="jxr_keyword">protected</strong> Object doFilterWrite(
<a name="166" href="#166">166</a>             <a href="../../../../../org/apache/mina/common/IoFilter.html">NextFilter</a> nextFilter, <a href="../../../../../org/apache/mina/common/IoSession.html">IoSession</a> session,
<a name="167" href="#167">167</a>             <a href="../../../../../org/apache/mina/common/WriteRequest.html">WriteRequest</a> writeRequest) <strong class="jxr_keyword">throws</strong> IOException {
<a name="168" href="#168">168</a>         <strong class="jxr_keyword">if</strong> (!compressOutbound) {
<a name="169" href="#169">169</a>             <strong class="jxr_keyword">return</strong> <strong class="jxr_keyword">null</strong>;
<a name="170" href="#170">170</a>         }
<a name="171" href="#171">171</a> 
<a name="172" href="#172">172</a>         <strong class="jxr_keyword">if</strong> (session.containsAttribute(DISABLE_COMPRESSION_ONCE)) {
<a name="173" href="#173">173</a>             <em class="jxr_comment">// Remove the marker attribute because it is temporary.</em>
<a name="174" href="#174">174</a>             session.removeAttribute(DISABLE_COMPRESSION_ONCE);
<a name="175" href="#175">175</a>             <strong class="jxr_keyword">return</strong> <strong class="jxr_keyword">null</strong>;
<a name="176" href="#176">176</a>         }
<a name="177" href="#177">177</a> 
<a name="178" href="#178">178</a>         <a href="../../../../../org/apache/mina/filter/compression/Zlib.html">Zlib</a> deflater = (Zlib) session.getAttribute(DEFLATER);
<a name="179" href="#179">179</a>         <strong class="jxr_keyword">if</strong> (deflater == <strong class="jxr_keyword">null</strong>) {
<a name="180" href="#180">180</a>             <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> IllegalStateException();
<a name="181" href="#181">181</a>         }
<a name="182" href="#182">182</a> 
<a name="183" href="#183">183</a>         <a href="../../../../../org/apache/mina/common/IoBuffer.html">IoBuffer</a> inBuffer = (IoBuffer) writeRequest.getMessage();
<a name="184" href="#184">184</a>         <strong class="jxr_keyword">if</strong> (!inBuffer.hasRemaining()) {
<a name="185" href="#185">185</a>             <em class="jxr_comment">// Ignore empty buffers</em>
<a name="186" href="#186">186</a>             <strong class="jxr_keyword">return</strong> <strong class="jxr_keyword">null</strong>;
<a name="187" href="#187">187</a>         } <strong class="jxr_keyword">else</strong> {
<a name="188" href="#188">188</a>             <strong class="jxr_keyword">return</strong> deflater.deflate(inBuffer);
<a name="189" href="#189">189</a>         }
<a name="190" href="#190">190</a>     }
<a name="191" href="#191">191</a> 
<a name="192" href="#192">192</a>     @Override
<a name="193" href="#193">193</a>     <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> onPreAdd(<a href="../../../../../org/apache/mina/common/IoFilterChain.html">IoFilterChain</a> parent, String name,
<a name="194" href="#194">194</a>             <a href="../../../../../org/apache/mina/common/IoFilter.html">NextFilter</a> nextFilter) <strong class="jxr_keyword">throws</strong> Exception {
<a name="195" href="#195">195</a>         <strong class="jxr_keyword">if</strong> (parent.contains(CompressionFilter.<strong class="jxr_keyword">class</strong>)) {
<a name="196" href="#196">196</a>             <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> IllegalStateException(
<a name="197" href="#197">197</a>                     <span class="jxr_string">"Only one "</span> + CompressionFilter.<strong class="jxr_keyword">class</strong> + <span class="jxr_string">" is permitted."</span>);
<a name="198" href="#198">198</a>         }
<a name="199" href="#199">199</a> 
<a name="200" href="#200">200</a>         <a href="../../../../../org/apache/mina/filter/compression/Zlib.html">Zlib</a> deflater = <strong class="jxr_keyword">new</strong> <a href="../../../../../org/apache/mina/filter/compression/Zlib.html">Zlib</a>(compressionLevel, Zlib.MODE_DEFLATER);
<a name="201" href="#201">201</a>         <a href="../../../../../org/apache/mina/filter/compression/Zlib.html">Zlib</a> inflater = <strong class="jxr_keyword">new</strong> <a href="../../../../../org/apache/mina/filter/compression/Zlib.html">Zlib</a>(compressionLevel, Zlib.MODE_INFLATER);
<a name="202" href="#202">202</a> 
<a name="203" href="#203">203</a>         <a href="../../../../../org/apache/mina/common/IoSession.html">IoSession</a> session = parent.getSession();
<a name="204" href="#204">204</a> 
<a name="205" href="#205">205</a>         session.setAttribute(DEFLATER, deflater);
<a name="206" href="#206">206</a>         session.setAttribute(INFLATER, inflater);
<a name="207" href="#207">207</a>     }
<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">     * Returns &lt;tt&gt;true&lt;/tt&gt; if incoming data is being compressed.</em>
<a name="211" href="#211">211</a> <em class="jxr_javadoccomment">     */</em>
<a name="212" href="#212">212</a>     <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">boolean</strong> isCompressInbound() {
<a name="213" href="#213">213</a>         <strong class="jxr_keyword">return</strong> compressInbound;
<a name="214" href="#214">214</a>     }
<a name="215" href="#215">215</a> 
<a name="216" href="#216">216</a>     <em class="jxr_javadoccomment">/**</em>
<a name="217" href="#217">217</a> <em class="jxr_javadoccomment">     * Sets if incoming data has to be compressed.</em>
<a name="218" href="#218">218</a> <em class="jxr_javadoccomment">     */</em>
<a name="219" href="#219">219</a>     <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> setCompressInbound(<strong class="jxr_keyword">boolean</strong> compressInbound) {
<a name="220" href="#220">220</a>         <strong class="jxr_keyword">this</strong>.compressInbound = compressInbound;
<a name="221" href="#221">221</a>     }
<a name="222" href="#222">222</a> 
<a name="223" href="#223">223</a>     <em class="jxr_javadoccomment">/**</em>
<a name="224" href="#224">224</a> <em class="jxr_javadoccomment">     * Returns &lt;tt&gt;true&lt;/tt&gt; if the filter is compressing data being written.</em>
<a name="225" href="#225">225</a> <em class="jxr_javadoccomment">     */</em>
<a name="226" href="#226">226</a>     <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">boolean</strong> isCompressOutbound() {
<a name="227" href="#227">227</a>         <strong class="jxr_keyword">return</strong> compressOutbound;
<a name="228" href="#228">228</a>     }
<a name="229" href="#229">229</a> 
<a name="230" href="#230">230</a>     <em class="jxr_javadoccomment">/**</em>
<a name="231" href="#231">231</a> <em class="jxr_javadoccomment">     * Set if outgoing data has to be compressed.</em>
<a name="232" href="#232">232</a> <em class="jxr_javadoccomment">     */</em>
<a name="233" href="#233">233</a>     <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> setCompressOutbound(<strong class="jxr_keyword">boolean</strong> compressOutbound) {
<a name="234" href="#234">234</a>         <strong class="jxr_keyword">this</strong>.compressOutbound = compressOutbound;
<a name="235" href="#235">235</a>     }
<a name="236" href="#236">236</a> 
<a name="237" href="#237">237</a>     @Override
<a name="238" href="#238">238</a>     <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> onPostRemove(<a href="../../../../../org/apache/mina/common/IoFilterChain.html">IoFilterChain</a> parent, String name,
<a name="239" href="#239">239</a>             <a href="../../../../../org/apache/mina/common/IoFilter.html">NextFilter</a> nextFilter) <strong class="jxr_keyword">throws</strong> Exception {
<a name="240" href="#240">240</a>         <strong class="jxr_keyword">super</strong>.onPostRemove(parent, name, nextFilter);
<a name="241" href="#241">241</a>         <a href="../../../../../org/apache/mina/common/IoSession.html">IoSession</a> session = parent.getSession();
<a name="242" href="#242">242</a>         <strong class="jxr_keyword">if</strong> (session == <strong class="jxr_keyword">null</strong>) {
<a name="243" href="#243">243</a>             <strong class="jxr_keyword">return</strong>;
<a name="244" href="#244">244</a>         }
<a name="245" href="#245">245</a> 
<a name="246" href="#246">246</a>         <a href="../../../../../org/apache/mina/filter/compression/Zlib.html">Zlib</a> inflater = (Zlib) session.getAttribute(INFLATER);
<a name="247" href="#247">247</a>         <a href="../../../../../org/apache/mina/filter/compression/Zlib.html">Zlib</a> deflater = (Zlib) session.getAttribute(DEFLATER);
<a name="248" href="#248">248</a>         <strong class="jxr_keyword">if</strong> (deflater != <strong class="jxr_keyword">null</strong>) {
<a name="249" href="#249">249</a>             deflater.cleanUp();
<a name="250" href="#250">250</a>         }
<a name="251" href="#251">251</a> 
<a name="252" href="#252">252</a>         <strong class="jxr_keyword">if</strong> (inflater != <strong class="jxr_keyword">null</strong>) {
<a name="253" href="#253">253</a>             inflater.cleanUp();
<a name="254" href="#254">254</a>         }
<a name="255" href="#255">255</a>     }
<a name="256" href="#256">256</a> }
</pre>
<hr/><div id="footer">This page was automatically generated by <a href="http://maven.apache.org/">Maven</a></div></body>
</html>