| <!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_191) on Sat Mar 16 10:15:54 CET 2019 --> |
| <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> |
| <title>CompressionFilter (Apache MINA 1.1.2 API Documentation)</title> |
| <meta name="date" content="2019-03-16"> |
| <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="CompressionFilter (Apache MINA 1.1.2 API Documentation)"; |
| } |
| } |
| catch(err) { |
| } |
| //--> |
| var methods = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":10,"i5":10,"i6":10,"i7":10}; |
| var tabs = {65535:["t0","All 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/CompressionFilter.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/BlacklistFilter.html" title="class in org.apache.mina.filter"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../../org/apache/mina/filter/LoggingFilter.html" title="class in org.apache.mina.filter"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../index.html?org/apache/mina/filter/CompressionFilter.html" target="_top">Frames</a></li> |
| <li><a href="CompressionFilter.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>Nested | </li> |
| <li><a href="#field.summary">Field</a> | </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><a href="#field.detail">Field</a> | </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</div> |
| <h2 title="Class CompressionFilter" class="title">Class CompressionFilter</h2> |
| </div> |
| <div class="contentContainer"> |
| <ul class="inheritance"> |
| <li>java.lang.Object</li> |
| <li> |
| <ul class="inheritance"> |
| <li><a href="../../../../org/apache/mina/common/IoFilterAdapter.html" title="class in org.apache.mina.common">org.apache.mina.common.IoFilterAdapter</a></li> |
| <li> |
| <ul class="inheritance"> |
| <li>org.apache.mina.filter.CompressionFilter</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/common/IoFilter.html" title="interface in org.apache.mina.common">IoFilter</a></dd> |
| </dl> |
| <hr> |
| <br> |
| <pre>public class <span class="typeNameLabel">CompressionFilter</span> |
| extends <a href="../../../../org/apache/mina/common/IoFilterAdapter.html" title="class in org.apache.mina.common">IoFilterAdapter</a></pre> |
| <div class="block">An <a href="../../../../org/apache/mina/common/IoFilter.html" title="interface in org.apache.mina.common"><code>IoFilter</code></a> which compresses all data using |
| <a href="http://www.jcraft.com/jzlib/">JZlib</a>. |
| Support for the LZW (DLCZ) algorithm is also planned. |
| <p> |
| This filter only supports compression using the <tt>PARTIAL FLUSH</tt> method, |
| since that is the only method useful when doing stream level compression. |
| <p> |
| This filter supports compression/decompression of the input and output |
| channels selectively. It can also be enabled/disabled on the fly. |
| <p> |
| This filter does not discard the zlib objects, keeping them around for the |
| entire life of the filter. This is because the zlib dictionary needs to |
| be built up over time, which is used during compression and decompression. |
| Over time, as repetitive data is sent over the wire, the compression efficiency |
| steadily increases. |
| <p> |
| Note that the zlib header is written only once. It is not necessary that |
| the data received after processing by this filter may not be complete due |
| to packet fragmentation. |
| <p> |
| It goes without saying that the other end of this stream should also have a |
| compatible compressor/decompressor using the same algorithm.</div> |
| <dl> |
| <dt><span class="simpleTagLabel">Version:</span></dt> |
| <dd>$Rev: 560326 $, $Date: 2007-07-27 19:30:25 +0200 (Fri, 27 Jul 2007) $</dd> |
| <dt><span class="simpleTagLabel">Author:</span></dt> |
| <dd>The Apache Directory Project (mina-dev@directory.apache.org)</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> |
| <ul class="blockList"> |
| <li class="blockList"><a name="nested.classes.inherited.from.class.org.apache.mina.common.IoFilter"> |
| <!-- --> |
| </a> |
| <h3>Nested classes/interfaces inherited from interface org.apache.mina.common.<a href="../../../../org/apache/mina/common/IoFilter.html" title="interface in org.apache.mina.common">IoFilter</a></h3> |
| <code><a href="../../../../org/apache/mina/common/IoFilter.NextFilter.html" title="interface in org.apache.mina.common">IoFilter.NextFilter</a>, <a href="../../../../org/apache/mina/common/IoFilter.WriteRequest.html" title="class in org.apache.mina.common">IoFilter.WriteRequest</a></code></li> |
| </ul> |
| </li> |
| </ul> |
| <!-- =========== FIELD SUMMARY =========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="field.summary"> |
| <!-- --> |
| </a> |
| <h3>Field Summary</h3> |
| <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Field Summary table, listing fields, and an explanation"> |
| <caption><span>Fields</span><span class="tabEnd"> </span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Modifier and Type</th> |
| <th class="colLast" scope="col">Field and Description</th> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>static int</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/mina/filter/CompressionFilter.html#COMPRESSION_DEFAULT">COMPRESSION_DEFAULT</a></span></code> |
| <div class="block">The default compression level used.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>static int</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/mina/filter/CompressionFilter.html#COMPRESSION_MAX">COMPRESSION_MAX</a></span></code> |
| <div class="block">Max compression level.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>static int</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/mina/filter/CompressionFilter.html#COMPRESSION_MIN">COMPRESSION_MIN</a></span></code> |
| <div class="block">Provides the best speed at the price of a low compression ratio.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>static int</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/mina/filter/CompressionFilter.html#COMPRESSION_NONE">COMPRESSION_NONE</a></span></code> |
| <div class="block">No compression done on the data.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>static java.lang.String</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/mina/filter/CompressionFilter.html#DISABLE_COMPRESSION_ONCE">DISABLE_COMPRESSION_ONCE</a></span></code> |
| <div class="block">A flag that allows you to disable compression once.</div> |
| </td> |
| </tr> |
| </table> |
| </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/CompressionFilter.html#CompressionFilter--">CompressionFilter</a></span>()</code> |
| <div class="block">Creates a new instance which compresses outboud data and decompresses |
| inbound data with default compression level.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colOne"><code><span class="memberNameLink"><a href="../../../../org/apache/mina/filter/CompressionFilter.html#CompressionFilter-boolean-boolean-int-">CompressionFilter</a></span>(boolean compressInbound, |
| boolean compressOutbound, |
| int compressionLevel)</code> |
| <div class="block">Creates a new instance.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colOne"><code><span class="memberNameLink"><a href="../../../../org/apache/mina/filter/CompressionFilter.html#CompressionFilter-int-">CompressionFilter</a></span>(int compressionLevel)</code> |
| <div class="block">Creates a new instance which compresses outboud data and decompresses |
| inbound data with the specified <tt>compressionLevel</tt>.</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="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>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/mina/filter/CompressionFilter.html#filterWrite-org.apache.mina.common.IoFilter.NextFilter-org.apache.mina.common.IoSession-org.apache.mina.common.IoFilter.WriteRequest-">filterWrite</a></span>(<a href="../../../../org/apache/mina/common/IoFilter.NextFilter.html" title="interface in org.apache.mina.common">IoFilter.NextFilter</a> nextFilter, |
| <a href="../../../../org/apache/mina/common/IoSession.html" title="interface in org.apache.mina.common">IoSession</a> session, |
| <a href="../../../../org/apache/mina/common/IoFilter.WriteRequest.html" title="class in org.apache.mina.common">IoFilter.WriteRequest</a> writeRequest)</code> |
| <div class="block">Filters <a href="../../../../org/apache/mina/common/IoSession.html#write-java.lang.Object-"><code>IoSession.write(Object)</code></a> method invocation.</div> |
| </td> |
| </tr> |
| <tr id="i1" class="rowColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/mina/filter/CompressionFilter.html#isCompressInbound--">isCompressInbound</a></span>()</code> |
| <div class="block">Returns <tt>true</tt> if incoming data is being compressed.</div> |
| </td> |
| </tr> |
| <tr id="i2" class="altColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/mina/filter/CompressionFilter.html#isCompressOutbound--">isCompressOutbound</a></span>()</code> |
| <div class="block">Returns <tt>true</tt> if the filter is compressing data being written.</div> |
| </td> |
| </tr> |
| <tr id="i3" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/mina/filter/CompressionFilter.html#messageReceived-org.apache.mina.common.IoFilter.NextFilter-org.apache.mina.common.IoSession-java.lang.Object-">messageReceived</a></span>(<a href="../../../../org/apache/mina/common/IoFilter.NextFilter.html" title="interface in org.apache.mina.common">IoFilter.NextFilter</a> nextFilter, |
| <a href="../../../../org/apache/mina/common/IoSession.html" title="interface in org.apache.mina.common">IoSession</a> session, |
| java.lang.Object message)</code> |
| <div class="block">Filters <a href="../../../../org/apache/mina/common/IoHandler.html#messageReceived-org.apache.mina.common.IoSession-java.lang.Object-"><code>IoHandler.messageReceived(IoSession,Object)</code></a> |
| event.</div> |
| </td> |
| </tr> |
| <tr id="i4" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/mina/filter/CompressionFilter.html#onPostRemove-org.apache.mina.common.IoFilterChain-java.lang.String-org.apache.mina.common.IoFilter.NextFilter-">onPostRemove</a></span>(<a href="../../../../org/apache/mina/common/IoFilterChain.html" title="interface in org.apache.mina.common">IoFilterChain</a> parent, |
| java.lang.String name, |
| <a href="../../../../org/apache/mina/common/IoFilter.NextFilter.html" title="interface in org.apache.mina.common">IoFilter.NextFilter</a> nextFilter)</code> |
| <div class="block">Invoked after this filter is removed from the specified <tt>parent</tt>.</div> |
| </td> |
| </tr> |
| <tr id="i5" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/mina/filter/CompressionFilter.html#onPreAdd-org.apache.mina.common.IoFilterChain-java.lang.String-org.apache.mina.common.IoFilter.NextFilter-">onPreAdd</a></span>(<a href="../../../../org/apache/mina/common/IoFilterChain.html" title="interface in org.apache.mina.common">IoFilterChain</a> parent, |
| java.lang.String name, |
| <a href="../../../../org/apache/mina/common/IoFilter.NextFilter.html" title="interface in org.apache.mina.common">IoFilter.NextFilter</a> nextFilter)</code> |
| <div class="block">Invoked before this filter is added to the specified <tt>parent</tt>.</div> |
| </td> |
| </tr> |
| <tr id="i6" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/mina/filter/CompressionFilter.html#setCompressInbound-boolean-">setCompressInbound</a></span>(boolean compressInbound)</code> |
| <div class="block">Sets if incoming data has to be compressed.</div> |
| </td> |
| </tr> |
| <tr id="i7" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/mina/filter/CompressionFilter.html#setCompressOutbound-boolean-">setCompressOutbound</a></span>(boolean compressOutbound)</code> |
| <div class="block">Set if outgoing data has to be compressed.</div> |
| </td> |
| </tr> |
| </table> |
| <ul class="blockList"> |
| <li class="blockList"><a name="methods.inherited.from.class.org.apache.mina.common.IoFilterAdapter"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from class org.apache.mina.common.<a href="../../../../org/apache/mina/common/IoFilterAdapter.html" title="class in org.apache.mina.common">IoFilterAdapter</a></h3> |
| <code><a href="../../../../org/apache/mina/common/IoFilterAdapter.html#destroy--">destroy</a>, <a href="../../../../org/apache/mina/common/IoFilterAdapter.html#exceptionCaught-org.apache.mina.common.IoFilter.NextFilter-org.apache.mina.common.IoSession-java.lang.Throwable-">exceptionCaught</a>, <a href="../../../../org/apache/mina/common/IoFilterAdapter.html#filterClose-org.apache.mina.common.IoFilter.NextFilter-org.apache.mina.common.IoSession-">filterClose</a>, <a href="../../../../org/apache/mina/common/IoFilterAdapter.html#init--">init</a>, <a href="../../../../org/apache/mina/common/IoFilterAdapter.html#messageSent-org.apache.mina.common.IoFilter.NextFilter-org.apache.mina.common.IoSession-java.lang.Object-">messageSent</a>, <a href="../../../../org/apache/mina/common/IoFilterAdapter.html#onPostAdd-org.apache.mina.common.IoFilterChain-java.lang.String-org.apache.mina.common.IoFilter.NextFilter-">onPostAdd</a>, <a href="../../../../org/apache/mina/common/IoFilterAdapter.html#onPreRemove-org.apache.mina.common.IoFilterChain-java.lang.String-org.apache.mina.common.IoFilter.NextFilter-">onPreRemove</a>, <a href="../../../../org/apache/mina/common/IoFilterAdapter.html#sessionClosed-org.apache.mina.common.IoFilter.NextFilter-org.apache.mina.common.IoSession-">sessionClosed</a>, <a href="../../../../org/apache/mina/common/IoFilterAdapter.html#sessionCreated-org.apache.mina.common.IoFilter.NextFilter-org.apache.mina.common.IoSession-">sessionCreated</a>, <a href="../../../../org/apache/mina/common/IoFilterAdapter.html#sessionIdle-org.apache.mina.common.IoFilter.NextFilter-org.apache.mina.common.IoSession-org.apache.mina.common.IdleStatus-">sessionIdle</a>, <a href="../../../../org/apache/mina/common/IoFilterAdapter.html#sessionOpened-org.apache.mina.common.IoFilter.NextFilter-org.apache.mina.common.IoSession-">sessionOpened</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.Object</h3> |
| <code>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</code></li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </div> |
| <div class="details"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ============ FIELD DETAIL =========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="field.detail"> |
| <!-- --> |
| </a> |
| <h3>Field Detail</h3> |
| <a name="COMPRESSION_MAX"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>COMPRESSION_MAX</h4> |
| <pre>public static final int COMPRESSION_MAX</pre> |
| <div class="block">Max compression level. Will give the highest compression ratio, but |
| will also take more cpu time and is the slowest.</div> |
| <dl> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../../constant-values.html#org.apache.mina.filter.CompressionFilter.COMPRESSION_MAX">Constant Field Values</a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="COMPRESSION_MIN"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>COMPRESSION_MIN</h4> |
| <pre>public static final int COMPRESSION_MIN</pre> |
| <div class="block">Provides the best speed at the price of a low compression ratio.</div> |
| <dl> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../../constant-values.html#org.apache.mina.filter.CompressionFilter.COMPRESSION_MIN">Constant Field Values</a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="COMPRESSION_NONE"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>COMPRESSION_NONE</h4> |
| <pre>public static final int COMPRESSION_NONE</pre> |
| <div class="block">No compression done on the data.</div> |
| <dl> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../../constant-values.html#org.apache.mina.filter.CompressionFilter.COMPRESSION_NONE">Constant Field Values</a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="COMPRESSION_DEFAULT"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>COMPRESSION_DEFAULT</h4> |
| <pre>public static final int COMPRESSION_DEFAULT</pre> |
| <div class="block">The default compression level used. Provides the best balance |
| between speed and compression</div> |
| <dl> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../../constant-values.html#org.apache.mina.filter.CompressionFilter.COMPRESSION_DEFAULT">Constant Field Values</a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="DISABLE_COMPRESSION_ONCE"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>DISABLE_COMPRESSION_ONCE</h4> |
| <pre>public static final java.lang.String DISABLE_COMPRESSION_ONCE</pre> |
| <div class="block">A flag that allows you to disable compression once.</div> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| <!-- ========= CONSTRUCTOR DETAIL ======== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="constructor.detail"> |
| <!-- --> |
| </a> |
| <h3>Constructor Detail</h3> |
| <a name="CompressionFilter--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>CompressionFilter</h4> |
| <pre>public CompressionFilter()</pre> |
| <div class="block">Creates a new instance which compresses outboud data and decompresses |
| inbound data with default compression level.</div> |
| </li> |
| </ul> |
| <a name="CompressionFilter-int-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>CompressionFilter</h4> |
| <pre>public CompressionFilter(int compressionLevel)</pre> |
| <div class="block">Creates a new instance which compresses outboud data and decompresses |
| inbound data with the specified <tt>compressionLevel</tt>.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>compressionLevel</code> - the level of compression to be used. Must |
| be one of <a href="../../../../org/apache/mina/filter/CompressionFilter.html#COMPRESSION_DEFAULT"><code>COMPRESSION_DEFAULT</code></a>, |
| <a href="../../../../org/apache/mina/filter/CompressionFilter.html#COMPRESSION_MAX"><code>COMPRESSION_MAX</code></a>, |
| <a href="../../../../org/apache/mina/filter/CompressionFilter.html#COMPRESSION_MIN"><code>COMPRESSION_MIN</code></a>, and |
| <a href="../../../../org/apache/mina/filter/CompressionFilter.html#COMPRESSION_NONE"><code>COMPRESSION_NONE</code></a>.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="CompressionFilter-boolean-boolean-int-"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>CompressionFilter</h4> |
| <pre>public CompressionFilter(boolean compressInbound, |
| boolean compressOutbound, |
| int compressionLevel)</pre> |
| <div class="block">Creates a new instance.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>compressInbound</code> - <tt>true</tt> if data read is to be decompressed</dd> |
| <dd><code>compressOutbound</code> - <tt>true</tt> if data written is to be compressed</dd> |
| <dd><code>compressionLevel</code> - the level of compression to be used. Must |
| be one of <a href="../../../../org/apache/mina/filter/CompressionFilter.html#COMPRESSION_DEFAULT"><code>COMPRESSION_DEFAULT</code></a>, |
| <a href="../../../../org/apache/mina/filter/CompressionFilter.html#COMPRESSION_MAX"><code>COMPRESSION_MAX</code></a>, |
| <a href="../../../../org/apache/mina/filter/CompressionFilter.html#COMPRESSION_MIN"><code>COMPRESSION_MIN</code></a>, and |
| <a href="../../../../org/apache/mina/filter/CompressionFilter.html#COMPRESSION_NONE"><code>COMPRESSION_NONE</code></a>.</dd> |
| </dl> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| <!-- ============ METHOD DETAIL ========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="method.detail"> |
| <!-- --> |
| </a> |
| <h3>Method Detail</h3> |
| <a name="messageReceived-org.apache.mina.common.IoFilter.NextFilter-org.apache.mina.common.IoSession-java.lang.Object-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>messageReceived</h4> |
| <pre>public void messageReceived(<a href="../../../../org/apache/mina/common/IoFilter.NextFilter.html" title="interface in org.apache.mina.common">IoFilter.NextFilter</a> nextFilter, |
| <a href="../../../../org/apache/mina/common/IoSession.html" title="interface in org.apache.mina.common">IoSession</a> session, |
| java.lang.Object message) |
| throws java.lang.Exception</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../../org/apache/mina/common/IoFilter.html#messageReceived-org.apache.mina.common.IoFilter.NextFilter-org.apache.mina.common.IoSession-java.lang.Object-">IoFilter</a></code></span></div> |
| <div class="block">Filters <a href="../../../../org/apache/mina/common/IoHandler.html#messageReceived-org.apache.mina.common.IoSession-java.lang.Object-"><code>IoHandler.messageReceived(IoSession,Object)</code></a> |
| event.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../org/apache/mina/common/IoFilter.html#messageReceived-org.apache.mina.common.IoFilter.NextFilter-org.apache.mina.common.IoSession-java.lang.Object-">messageReceived</a></code> in interface <code><a href="../../../../org/apache/mina/common/IoFilter.html" title="interface in org.apache.mina.common">IoFilter</a></code></dd> |
| <dt><span class="overrideSpecifyLabel">Overrides:</span></dt> |
| <dd><code><a href="../../../../org/apache/mina/common/IoFilterAdapter.html#messageReceived-org.apache.mina.common.IoFilter.NextFilter-org.apache.mina.common.IoSession-java.lang.Object-">messageReceived</a></code> in class <code><a href="../../../../org/apache/mina/common/IoFilterAdapter.html" title="class in org.apache.mina.common">IoFilterAdapter</a></code></dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code>java.lang.Exception</code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="filterWrite-org.apache.mina.common.IoFilter.NextFilter-org.apache.mina.common.IoSession-org.apache.mina.common.IoFilter.WriteRequest-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>filterWrite</h4> |
| <pre>public void filterWrite(<a href="../../../../org/apache/mina/common/IoFilter.NextFilter.html" title="interface in org.apache.mina.common">IoFilter.NextFilter</a> nextFilter, |
| <a href="../../../../org/apache/mina/common/IoSession.html" title="interface in org.apache.mina.common">IoSession</a> session, |
| <a href="../../../../org/apache/mina/common/IoFilter.WriteRequest.html" title="class in org.apache.mina.common">IoFilter.WriteRequest</a> writeRequest) |
| throws java.io.IOException</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../../org/apache/mina/common/IoFilter.html#filterWrite-org.apache.mina.common.IoFilter.NextFilter-org.apache.mina.common.IoSession-org.apache.mina.common.IoFilter.WriteRequest-">IoFilter</a></code></span></div> |
| <div class="block">Filters <a href="../../../../org/apache/mina/common/IoSession.html#write-java.lang.Object-"><code>IoSession.write(Object)</code></a> method invocation.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../org/apache/mina/common/IoFilter.html#filterWrite-org.apache.mina.common.IoFilter.NextFilter-org.apache.mina.common.IoSession-org.apache.mina.common.IoFilter.WriteRequest-">filterWrite</a></code> in interface <code><a href="../../../../org/apache/mina/common/IoFilter.html" title="interface in org.apache.mina.common">IoFilter</a></code></dd> |
| <dt><span class="overrideSpecifyLabel">Overrides:</span></dt> |
| <dd><code><a href="../../../../org/apache/mina/common/IoFilterAdapter.html#filterWrite-org.apache.mina.common.IoFilter.NextFilter-org.apache.mina.common.IoSession-org.apache.mina.common.IoFilter.WriteRequest-">filterWrite</a></code> in class <code><a href="../../../../org/apache/mina/common/IoFilterAdapter.html" title="class in org.apache.mina.common">IoFilterAdapter</a></code></dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code>java.io.IOException</code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="onPreAdd-org.apache.mina.common.IoFilterChain-java.lang.String-org.apache.mina.common.IoFilter.NextFilter-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>onPreAdd</h4> |
| <pre>public void onPreAdd(<a href="../../../../org/apache/mina/common/IoFilterChain.html" title="interface in org.apache.mina.common">IoFilterChain</a> parent, |
| java.lang.String name, |
| <a href="../../../../org/apache/mina/common/IoFilter.NextFilter.html" title="interface in org.apache.mina.common">IoFilter.NextFilter</a> nextFilter) |
| throws java.lang.Exception</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../../org/apache/mina/common/IoFilter.html#onPreAdd-org.apache.mina.common.IoFilterChain-java.lang.String-org.apache.mina.common.IoFilter.NextFilter-">IoFilter</a></code></span></div> |
| <div class="block">Invoked before this filter is added to the specified <tt>parent</tt>. |
| Please note that this method can be invoked more than once if |
| this filter is added to more than one parents. This method is not |
| invoked before <a href="../../../../org/apache/mina/common/IoFilter.html#init--"><code>IoFilter.init()</code></a> is invoked.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../org/apache/mina/common/IoFilter.html#onPreAdd-org.apache.mina.common.IoFilterChain-java.lang.String-org.apache.mina.common.IoFilter.NextFilter-">onPreAdd</a></code> in interface <code><a href="../../../../org/apache/mina/common/IoFilter.html" title="interface in org.apache.mina.common">IoFilter</a></code></dd> |
| <dt><span class="overrideSpecifyLabel">Overrides:</span></dt> |
| <dd><code><a href="../../../../org/apache/mina/common/IoFilterAdapter.html#onPreAdd-org.apache.mina.common.IoFilterChain-java.lang.String-org.apache.mina.common.IoFilter.NextFilter-">onPreAdd</a></code> in class <code><a href="../../../../org/apache/mina/common/IoFilterAdapter.html" title="class in org.apache.mina.common">IoFilterAdapter</a></code></dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>parent</code> - the parent who called this method</dd> |
| <dd><code>name</code> - the name assigned to this filter</dd> |
| <dd><code>nextFilter</code> - the <a href="../../../../org/apache/mina/common/IoFilter.NextFilter.html" title="interface in org.apache.mina.common"><code>IoFilter.NextFilter</code></a> for this filter. You can reuse |
| this object until this filter is removed from the chain.</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code>java.lang.Exception</code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="isCompressInbound--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>isCompressInbound</h4> |
| <pre>public boolean isCompressInbound()</pre> |
| <div class="block">Returns <tt>true</tt> if incoming data is being compressed.</div> |
| </li> |
| </ul> |
| <a name="setCompressInbound-boolean-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setCompressInbound</h4> |
| <pre>public void setCompressInbound(boolean compressInbound)</pre> |
| <div class="block">Sets if incoming data has to be compressed.</div> |
| </li> |
| </ul> |
| <a name="isCompressOutbound--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>isCompressOutbound</h4> |
| <pre>public boolean isCompressOutbound()</pre> |
| <div class="block">Returns <tt>true</tt> if the filter is compressing data being written.</div> |
| </li> |
| </ul> |
| <a name="setCompressOutbound-boolean-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setCompressOutbound</h4> |
| <pre>public void setCompressOutbound(boolean compressOutbound)</pre> |
| <div class="block">Set if outgoing data has to be compressed.</div> |
| </li> |
| </ul> |
| <a name="onPostRemove-org.apache.mina.common.IoFilterChain-java.lang.String-org.apache.mina.common.IoFilter.NextFilter-"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>onPostRemove</h4> |
| <pre>public void onPostRemove(<a href="../../../../org/apache/mina/common/IoFilterChain.html" title="interface in org.apache.mina.common">IoFilterChain</a> parent, |
| java.lang.String name, |
| <a href="../../../../org/apache/mina/common/IoFilter.NextFilter.html" title="interface in org.apache.mina.common">IoFilter.NextFilter</a> nextFilter) |
| throws java.lang.Exception</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../../org/apache/mina/common/IoFilter.html#onPostRemove-org.apache.mina.common.IoFilterChain-java.lang.String-org.apache.mina.common.IoFilter.NextFilter-">IoFilter</a></code></span></div> |
| <div class="block">Invoked after this filter is removed from the specified <tt>parent</tt>. |
| Please note that this method can be invoked more than once if |
| this filter is removed from more than one parents. |
| This method is always invoked before <a href="../../../../org/apache/mina/common/IoFilter.html#destroy--"><code>IoFilter.destroy()</code></a> is invoked.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../org/apache/mina/common/IoFilter.html#onPostRemove-org.apache.mina.common.IoFilterChain-java.lang.String-org.apache.mina.common.IoFilter.NextFilter-">onPostRemove</a></code> in interface <code><a href="../../../../org/apache/mina/common/IoFilter.html" title="interface in org.apache.mina.common">IoFilter</a></code></dd> |
| <dt><span class="overrideSpecifyLabel">Overrides:</span></dt> |
| <dd><code><a href="../../../../org/apache/mina/common/IoFilterAdapter.html#onPostRemove-org.apache.mina.common.IoFilterChain-java.lang.String-org.apache.mina.common.IoFilter.NextFilter-">onPostRemove</a></code> in class <code><a href="../../../../org/apache/mina/common/IoFilterAdapter.html" title="class in org.apache.mina.common">IoFilterAdapter</a></code></dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>parent</code> - the parent who called this method</dd> |
| <dd><code>name</code> - the name assigned to this filter</dd> |
| <dd><code>nextFilter</code> - the <a href="../../../../org/apache/mina/common/IoFilter.NextFilter.html" title="interface in org.apache.mina.common"><code>IoFilter.NextFilter</code></a> for this filter. You can reuse |
| this object until this filter is removed from the chain.</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code>java.lang.Exception</code></dd> |
| </dl> |
| </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/CompressionFilter.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/BlacklistFilter.html" title="class in org.apache.mina.filter"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../../org/apache/mina/filter/LoggingFilter.html" title="class in org.apache.mina.filter"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../index.html?org/apache/mina/filter/CompressionFilter.html" target="_top">Frames</a></li> |
| <li><a href="CompressionFilter.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>Nested | </li> |
| <li><a href="#field.summary">Field</a> | </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><a href="#field.detail">Field</a> | </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-2019 <a href="http://mina.apace.org/">Apache MINA Project</a>. All Rights Reserved.</small></p> |
| </body> |
| </html> |
