blob: 1290114e1cb4429e7500236afc24d2058d72415c [file] [log] [blame]
<!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=ISO-8859-1" /><title>ProtocolCodecFilter xref</title>
<link type="text/css" rel="stylesheet" href="../../../../../stylesheet.css" />
</head>
<body>
<div id="overview"><a href="../../../../../../apidocs/org/apache/mina/filter/codec/ProtocolCodecFilter.html">View Javadoc</a></div><pre>
<a name="1" href="#1">1</a> <strong>package</strong> <a href="../../../../../org/apache/mina/filter/codec/package-summary.html">org.apache.mina.filter.codec</a>;
<a name="2" href="#2">2</a>
<a name="3" href="#3">3</a> <strong>import</strong> org.apache.mina.common.ByteBuffer;
<a name="4" href="#4">4</a> <strong>import</strong> org.apache.mina.common.ByteBufferProxy;
<a name="5" href="#5">5</a> <strong>import</strong> org.apache.mina.common.IoFilterAdapter;
<a name="6" href="#6">6</a> <strong>import</strong> org.apache.mina.common.IoFilterChain;
<a name="7" href="#7">7</a> <strong>import</strong> org.apache.mina.common.IoSession;
<a name="8" href="#8">8</a> <strong>import</strong> org.apache.mina.common.WriteFuture;
<a name="9" href="#9">9</a> <strong>import</strong> org.apache.mina.filter.codec.support.SimpleProtocolDecoderOutput;
<a name="10" href="#10">10</a> <strong>import</strong> org.apache.mina.filter.codec.support.SimpleProtocolEncoderOutput;
<a name="11" href="#11">11</a> <strong>import</strong> org.apache.mina.util.Queue;
<a name="12" href="#12">12</a> <strong>import</strong> org.apache.mina.util.SessionLog;
<a name="13" href="#13">13</a>
<a name="14" href="#14">14</a> <strong>public</strong> <strong>class</strong> <a href="../../../../../org/apache/mina/filter/codec/ProtocolCodecFilter.html">ProtocolCodecFilter</a> <strong>extends</strong> <a href="../../../../../org/apache/mina/common/IoFilterAdapter.html">IoFilterAdapter</a>
<a name="15" href="#15">15</a> {
<a name="16" href="#16">16</a> <strong>public</strong> <strong>static</strong> <strong>final</strong> String ENCODER = ProtocolCodecFilter.<strong>class</strong>.getName() + <span class="string">".encoder"</span>;
<a name="17" href="#17">17</a> <strong>public</strong> <strong>static</strong> <strong>final</strong> String DECODER = ProtocolCodecFilter.<strong>class</strong>.getName() + <span class="string">".decoder"</span>;
<a name="18" href="#18">18</a> <strong>public</strong> <strong>static</strong> <strong>final</strong> String ENCODER_OUT = ProtocolCodecFilter.<strong>class</strong>.getName() + <span class="string">".encoderOutput"</span>;
<a name="19" href="#19">19</a> <strong>public</strong> <strong>static</strong> <strong>final</strong> String DECODER_OUT = ProtocolCodecFilter.<strong>class</strong>.getName() + <span class="string">".decoderOutput"</span>;
<a name="20" href="#20">20</a>
<a name="21" href="#21">21</a> <strong>private</strong> <strong>final</strong> <a href="../../../../../org/apache/mina/filter/codec/ProtocolCodecFactory.html">ProtocolCodecFactory</a> factory;
<a name="22" href="#22">22</a>
<a name="23" href="#23">23</a> <strong>public</strong> <a href="../../../../../org/apache/mina/filter/codec/ProtocolCodecFilter.html">ProtocolCodecFilter</a>( ProtocolCodecFactory factory )
<a name="24" href="#24">24</a> {
<a name="25" href="#25">25</a> <strong>if</strong>( factory == <strong>null</strong> )
<a name="26" href="#26">26</a> {
<a name="27" href="#27">27</a> <strong>throw</strong> <strong>new</strong> NullPointerException( <span class="string">"factory"</span> );
<a name="28" href="#28">28</a> }
<a name="29" href="#29">29</a> <strong>this</strong>.factory = factory;
<a name="30" href="#30">30</a> }
<a name="31" href="#31">31</a>
<a name="32" href="#32">32</a> <strong>public</strong> <strong>void</strong> onPreAdd( IoFilterChain parent, String name, NextFilter nextFilter ) throws Exception
<a name="33" href="#33">33</a> {
<a name="34" href="#34">34</a> <strong>if</strong>( parent.contains( ProtocolCodecFilter.<strong>class</strong> ) )
<a name="35" href="#35">35</a> {
<a name="36" href="#36">36</a> <strong>throw</strong> <strong>new</strong> IllegalStateException( <span class="string">"A filter chain cannot contain more than one ProtocolCodecFilter."</span> );
<a name="37" href="#37">37</a> }
<a name="38" href="#38">38</a> }
<a name="39" href="#39">39</a>
<a name="40" href="#40">40</a> <strong>public</strong> <strong>void</strong> messageReceived( NextFilter nextFilter, IoSession session, Object message ) throws Exception
<a name="41" href="#41">41</a> {
<a name="42" href="#42">42</a> <strong>if</strong>( !( message instanceof ByteBuffer ) )
<a name="43" href="#43">43</a> {
<a name="44" href="#44">44</a> nextFilter.messageReceived( session, message );
<a name="45" href="#45">45</a> <strong>return</strong>;
<a name="46" href="#46">46</a> }
<a name="47" href="#47">47</a>
<a name="48" href="#48">48</a> <a href="../../../../../org/apache/mina/common/ByteBuffer.html">ByteBuffer</a> in = ( ByteBuffer ) message;
<a name="49" href="#49">49</a> <a href="../../../../../org/apache/mina/filter/codec/ProtocolDecoder.html">ProtocolDecoder</a> decoder = getDecoder( session );
<a name="50" href="#50">50</a> <a href="../../../../../org/apache/mina/filter/codec/support/SimpleProtocolDecoderOutput.html">SimpleProtocolDecoderOutput</a> decoderOut = getDecoderOut( session );
<a name="51" href="#51">51</a>
<a name="52" href="#52">52</a> <strong>try</strong>
<a name="53" href="#53">53</a> {
<a name="54" href="#54">54</a> <strong>synchronized</strong>( decoder )
<a name="55" href="#55">55</a> {
<a name="56" href="#56">56</a> decoder.decode( session, in, decoderOut );
<a name="57" href="#57">57</a> }
<a name="58" href="#58">58</a> }
<a name="59" href="#59">59</a> <strong>catch</strong>( Throwable t )
<a name="60" href="#60">60</a> {
<a name="61" href="#61">61</a> <a href="../../../../../org/apache/mina/filter/codec/ProtocolDecoderException.html">ProtocolDecoderException</a> pde;
<a name="62" href="#62">62</a> <strong>if</strong>( t instanceof ProtocolDecoderException )
<a name="63" href="#63">63</a> {
<a name="64" href="#64">64</a> pde = ( ProtocolDecoderException ) t;
<a name="65" href="#65">65</a> }
<a name="66" href="#66">66</a> <strong>else</strong>
<a name="67" href="#67">67</a> {
<a name="68" href="#68">68</a> pde = <strong>new</strong> <a href="../../../../../org/apache/mina/filter/codec/ProtocolDecoderException.html">ProtocolDecoderException</a>( t );
<a name="69" href="#69">69</a> }
<a name="70" href="#70">70</a> pde.setHexdump( in.getHexDump() );
<a name="71" href="#71">71</a> <strong>throw</strong> pde;
<a name="72" href="#72">72</a> }
<a name="73" href="#73">73</a> <strong>finally</strong>
<a name="74" href="#74">74</a> {
<a name="75" href="#75">75</a> <em class="comment">// Dispose the decoder if this session is connectionless.</em>
<a name="76" href="#76">76</a> <strong>if</strong>( session.getTransportType().isConnectionless() )
<a name="77" href="#77">77</a> {
<a name="78" href="#78">78</a> disposeDecoder( session );
<a name="79" href="#79">79</a> }
<a name="80" href="#80">80</a>
<a name="81" href="#81">81</a> <em class="comment">// Release the read buffer.</em>
<a name="82" href="#82">82</a> in.release();
<a name="83" href="#83">83</a>
<a name="84" href="#84">84</a> <a href="../../../../../org/apache/mina/util/Queue.html">Queue</a> queue = decoderOut.getMessageQueue();
<a name="85" href="#85">85</a> <strong>synchronized</strong>( queue )
<a name="86" href="#86">86</a> {
<a name="87" href="#87">87</a> <strong>if</strong>( !queue.isEmpty() )
<a name="88" href="#88">88</a> {
<a name="89" href="#89">89</a> <strong>do</strong>
<a name="90" href="#90">90</a> {
<a name="91" href="#91">91</a> nextFilter.messageReceived( session, queue.pop() );
<a name="92" href="#92">92</a> }
<a name="93" href="#93">93</a> <strong>while</strong>( !queue.isEmpty() );
<a name="94" href="#94">94</a> }
<a name="95" href="#95">95</a> }
<a name="96" href="#96">96</a> }
<a name="97" href="#97">97</a> }
<a name="98" href="#98">98</a>
<a name="99" href="#99">99</a> <strong>public</strong> <strong>void</strong> messageSent( NextFilter nextFilter, IoSession session, Object message ) throws Exception
<a name="100" href="#100">100</a> {
<a name="101" href="#101">101</a> <strong>if</strong>( ! ( message instanceof MessageByteBuffer ) )
<a name="102" href="#102">102</a> {
<a name="103" href="#103">103</a> nextFilter.messageSent( session, message );
<a name="104" href="#104">104</a> <strong>return</strong>;
<a name="105" href="#105">105</a> }
<a name="106" href="#106">106</a>
<a name="107" href="#107">107</a> MessageByteBuffer buf = ( MessageByteBuffer ) message;
<a name="108" href="#108">108</a> <strong>try</strong>
<a name="109" href="#109">109</a> {
<a name="110" href="#110">110</a> buf.release();
<a name="111" href="#111">111</a> }
<a name="112" href="#112">112</a> <strong>finally</strong>
<a name="113" href="#113">113</a> {
<a name="114" href="#114">114</a> nextFilter.messageSent( session, buf.message );
<a name="115" href="#115">115</a> }
<a name="116" href="#116">116</a> }
<a name="117" href="#117">117</a>
<a name="118" href="#118">118</a> <strong>public</strong> <strong>void</strong> filterWrite( NextFilter nextFilter, IoSession session, WriteRequest writeRequest ) throws Exception
<a name="119" href="#119">119</a> {
<a name="120" href="#120">120</a> Object message = writeRequest.getMessage();
<a name="121" href="#121">121</a> <strong>if</strong>( message instanceof ByteBuffer )
<a name="122" href="#122">122</a> {
<a name="123" href="#123">123</a> nextFilter.filterWrite( session, writeRequest );
<a name="124" href="#124">124</a> <strong>return</strong>;
<a name="125" href="#125">125</a> }
<a name="126" href="#126">126</a>
<a name="127" href="#127">127</a> <a href="../../../../../org/apache/mina/filter/codec/ProtocolEncoder.html">ProtocolEncoder</a> encoder = getEncoder( session );
<a name="128" href="#128">128</a> ProtocolEncoderOutputImpl encoderOut = getEncoderOut( session );
<a name="129" href="#129">129</a> encoderOut.nextFilter = nextFilter;
<a name="130" href="#130">130</a>
<a name="131" href="#131">131</a> <strong>try</strong>
<a name="132" href="#132">132</a> {
<a name="133" href="#133">133</a> encoder.encode( session, message, encoderOut );
<a name="134" href="#134">134</a> }
<a name="135" href="#135">135</a> <strong>catch</strong>( Throwable t )
<a name="136" href="#136">136</a> {
<a name="137" href="#137">137</a> <a href="../../../../../org/apache/mina/filter/codec/ProtocolEncoderException.html">ProtocolEncoderException</a> pee;
<a name="138" href="#138">138</a> <strong>if</strong>( t instanceof ProtocolEncoderException )
<a name="139" href="#139">139</a> {
<a name="140" href="#140">140</a> pee = ( ProtocolEncoderException ) t;
<a name="141" href="#141">141</a> }
<a name="142" href="#142">142</a> <strong>else</strong>
<a name="143" href="#143">143</a> {
<a name="144" href="#144">144</a> pee = <strong>new</strong> <a href="../../../../../org/apache/mina/filter/codec/ProtocolEncoderException.html">ProtocolEncoderException</a>( t );
<a name="145" href="#145">145</a> }
<a name="146" href="#146">146</a> <strong>throw</strong> pee;
<a name="147" href="#147">147</a> }
<a name="148" href="#148">148</a> <strong>finally</strong>
<a name="149" href="#149">149</a> {
<a name="150" href="#150">150</a> <em class="comment">// Dispose the encoder if this session is connectionless.</em>
<a name="151" href="#151">151</a> <strong>if</strong>( session.getTransportType().isConnectionless() )
<a name="152" href="#152">152</a> {
<a name="153" href="#153">153</a> disposeEncoder( session );
<a name="154" href="#154">154</a> }
<a name="155" href="#155">155</a> }
<a name="156" href="#156">156</a>
<a name="157" href="#157">157</a> encoderOut.writeRequest = writeRequest;
<a name="158" href="#158">158</a> encoderOut.flush();
<a name="159" href="#159">159</a> }
<a name="160" href="#160">160</a>
<a name="161" href="#161">161</a> <strong>public</strong> <strong>void</strong> sessionClosed( NextFilter nextFilter, IoSession session ) throws Exception
<a name="162" href="#162">162</a> {
<a name="163" href="#163">163</a> disposeEncoder( session );
<a name="164" href="#164">164</a> disposeDecoder( session );
<a name="165" href="#165">165</a> nextFilter.sessionClosed( session );
<a name="166" href="#166">166</a> }
<a name="167" href="#167">167</a>
<a name="168" href="#168">168</a> <strong>private</strong> <a href="../../../../../org/apache/mina/filter/codec/ProtocolEncoder.html">ProtocolEncoder</a> getEncoder( IoSession session )
<a name="169" href="#169">169</a> {
<a name="170" href="#170">170</a> <a href="../../../../../org/apache/mina/filter/codec/ProtocolEncoder.html">ProtocolEncoder</a> encoder = ( ProtocolEncoder ) session.getAttribute( ENCODER );
<a name="171" href="#171">171</a> <strong>if</strong>( encoder == <strong>null</strong> )
<a name="172" href="#172">172</a> {
<a name="173" href="#173">173</a> encoder = factory.getEncoder();
<a name="174" href="#174">174</a> session.setAttribute( ENCODER, encoder );
<a name="175" href="#175">175</a> }
<a name="176" href="#176">176</a> <strong>return</strong> encoder;
<a name="177" href="#177">177</a> }
<a name="178" href="#178">178</a>
<a name="179" href="#179">179</a> <strong>private</strong> ProtocolEncoderOutputImpl getEncoderOut( IoSession session )
<a name="180" href="#180">180</a> {
<a name="181" href="#181">181</a> ProtocolEncoderOutputImpl out = ( ProtocolEncoderOutputImpl ) session.getAttribute( ENCODER_OUT );
<a name="182" href="#182">182</a> <strong>if</strong>( out == <strong>null</strong> )
<a name="183" href="#183">183</a> {
<a name="184" href="#184">184</a> out = <strong>new</strong> ProtocolEncoderOutputImpl( session );
<a name="185" href="#185">185</a> session.setAttribute( ENCODER_OUT, out );
<a name="186" href="#186">186</a> }
<a name="187" href="#187">187</a> <strong>return</strong> out;
<a name="188" href="#188">188</a> }
<a name="189" href="#189">189</a>
<a name="190" href="#190">190</a> <strong>private</strong> <a href="../../../../../org/apache/mina/filter/codec/ProtocolDecoder.html">ProtocolDecoder</a> getDecoder( IoSession session )
<a name="191" href="#191">191</a> {
<a name="192" href="#192">192</a> <a href="../../../../../org/apache/mina/filter/codec/ProtocolDecoder.html">ProtocolDecoder</a> decoder = ( ProtocolDecoder ) session.getAttribute( DECODER );
<a name="193" href="#193">193</a> <strong>if</strong>( decoder == <strong>null</strong> )
<a name="194" href="#194">194</a> {
<a name="195" href="#195">195</a> decoder = factory.getDecoder();
<a name="196" href="#196">196</a> session.setAttribute( DECODER, decoder );
<a name="197" href="#197">197</a> }
<a name="198" href="#198">198</a> <strong>return</strong> decoder;
<a name="199" href="#199">199</a> }
<a name="200" href="#200">200</a>
<a name="201" href="#201">201</a> <strong>private</strong> <a href="../../../../../org/apache/mina/filter/codec/support/SimpleProtocolDecoderOutput.html">SimpleProtocolDecoderOutput</a> getDecoderOut( IoSession session )
<a name="202" href="#202">202</a> {
<a name="203" href="#203">203</a> <a href="../../../../../org/apache/mina/filter/codec/support/SimpleProtocolDecoderOutput.html">SimpleProtocolDecoderOutput</a> out = ( SimpleProtocolDecoderOutput ) session.getAttribute( DECODER_OUT );
<a name="204" href="#204">204</a> <strong>if</strong>( out == <strong>null</strong> )
<a name="205" href="#205">205</a> {
<a name="206" href="#206">206</a> out = <strong>new</strong> <a href="../../../../../org/apache/mina/filter/codec/support/SimpleProtocolDecoderOutput.html">SimpleProtocolDecoderOutput</a>();
<a name="207" href="#207">207</a> session.setAttribute( DECODER_OUT, out );
<a name="208" href="#208">208</a> }
<a name="209" href="#209">209</a> <strong>return</strong> out;
<a name="210" href="#210">210</a> }
<a name="211" href="#211">211</a>
<a name="212" href="#212">212</a> <strong>private</strong> <strong>void</strong> disposeEncoder( IoSession session )
<a name="213" href="#213">213</a> {
<a name="214" href="#214">214</a> session.removeAttribute( ENCODER_OUT );
<a name="215" href="#215">215</a> <a href="../../../../../org/apache/mina/filter/codec/ProtocolEncoder.html">ProtocolEncoder</a> encoder = ( ProtocolEncoder ) session.removeAttribute( ENCODER );
<a name="216" href="#216">216</a> <strong>if</strong>( encoder == <strong>null</strong> )
<a name="217" href="#217">217</a> {
<a name="218" href="#218">218</a> <strong>return</strong>;
<a name="219" href="#219">219</a> }
<a name="220" href="#220">220</a>
<a name="221" href="#221">221</a> <strong>try</strong>
<a name="222" href="#222">222</a> {
<a name="223" href="#223">223</a> encoder.dispose( session );
<a name="224" href="#224">224</a> }
<a name="225" href="#225">225</a> <strong>catch</strong>( Throwable t )
<a name="226" href="#226">226</a> {
<a name="227" href="#227">227</a> SessionLog.warn(
<a name="228" href="#228">228</a> session,
<a name="229" href="#229">229</a> <span class="string">"Failed to dispose: "</span> + encoder.getClass().getName() +
<a name="230" href="#230">230</a> <span class="string">" ("</span> + encoder + ')' );
<a name="231" href="#231">231</a> }
<a name="232" href="#232">232</a> }
<a name="233" href="#233">233</a>
<a name="234" href="#234">234</a> <strong>private</strong> <strong>void</strong> disposeDecoder( IoSession session )
<a name="235" href="#235">235</a> {
<a name="236" href="#236">236</a> session.removeAttribute( DECODER_OUT );
<a name="237" href="#237">237</a> <a href="../../../../../org/apache/mina/filter/codec/ProtocolDecoder.html">ProtocolDecoder</a> decoder = ( ProtocolDecoder ) session.removeAttribute( DECODER );
<a name="238" href="#238">238</a> <strong>if</strong>( decoder == <strong>null</strong> )
<a name="239" href="#239">239</a> {
<a name="240" href="#240">240</a> <strong>return</strong>;
<a name="241" href="#241">241</a> }
<a name="242" href="#242">242</a>
<a name="243" href="#243">243</a> <strong>try</strong>
<a name="244" href="#244">244</a> {
<a name="245" href="#245">245</a> decoder.dispose( session );
<a name="246" href="#246">246</a> }
<a name="247" href="#247">247</a> <strong>catch</strong>( Throwable t )
<a name="248" href="#248">248</a> {
<a name="249" href="#249">249</a> SessionLog.warn(
<a name="250" href="#250">250</a> session,
<a name="251" href="#251">251</a> <span class="string">"Falied to dispose: "</span> + decoder.getClass().getName() +
<a name="252" href="#252">252</a> <span class="string">" ("</span> + decoder + ')' );
<a name="253" href="#253">253</a> }
<a name="254" href="#254">254</a> }
<a name="255" href="#255">255</a>
<a name="256" href="#256">256</a> <strong>private</strong> <strong>static</strong> <strong>class</strong> MessageByteBuffer <strong>extends</strong> <a href="../../../../../org/apache/mina/common/ByteBufferProxy.html">ByteBufferProxy</a>
<a name="257" href="#257">257</a> {
<a name="258" href="#258">258</a> <strong>private</strong> <strong>final</strong> Object message;
<a name="259" href="#259">259</a>
<a name="260" href="#260">260</a> <strong>private</strong> MessageByteBuffer( ByteBuffer buf, Object message )
<a name="261" href="#261">261</a> {
<a name="262" href="#262">262</a> <strong>super</strong>( buf );
<a name="263" href="#263">263</a> <strong>this</strong>.message = message;
<a name="264" href="#264">264</a> }
<a name="265" href="#265">265</a> }
<a name="266" href="#266">266</a>
<a name="267" href="#267">267</a> <strong>private</strong> <strong>static</strong> <strong>class</strong> ProtocolEncoderOutputImpl <strong>extends</strong> <a href="../../../../../org/apache/mina/filter/codec/support/SimpleProtocolEncoderOutput.html">SimpleProtocolEncoderOutput</a>
<a name="268" href="#268">268</a> {
<a name="269" href="#269">269</a> <strong>private</strong> <strong>final</strong> <a href="../../../../../org/apache/mina/common/IoSession.html">IoSession</a> session;
<a name="270" href="#270">270</a> <strong>private</strong> NextFilter nextFilter;
<a name="271" href="#271">271</a> <strong>private</strong> WriteRequest writeRequest;
<a name="272" href="#272">272</a>
<a name="273" href="#273">273</a> <strong>public</strong> ProtocolEncoderOutputImpl( IoSession session )
<a name="274" href="#274">274</a> {
<a name="275" href="#275">275</a> <strong>this</strong>.session = session;
<a name="276" href="#276">276</a> }
<a name="277" href="#277">277</a>
<a name="278" href="#278">278</a> <strong>protected</strong> <a href="../../../../../org/apache/mina/common/WriteFuture.html">WriteFuture</a> doFlush( ByteBuffer buf )
<a name="279" href="#279">279</a> {
<a name="280" href="#280">280</a> <a href="../../../../../org/apache/mina/common/WriteFuture.html">WriteFuture</a> future;
<a name="281" href="#281">281</a> <strong>if</strong>( writeRequest != <strong>null</strong> )
<a name="282" href="#282">282</a> {
<a name="283" href="#283">283</a> future = writeRequest.getFuture();
<a name="284" href="#284">284</a> nextFilter.filterWrite(
<a name="285" href="#285">285</a> session,
<a name="286" href="#286">286</a> <strong>new</strong> WriteRequest(
<a name="287" href="#287">287</a> <strong>new</strong> MessageByteBuffer(
<a name="288" href="#288">288</a> buf, writeRequest.getMessage() ), future ) );
<a name="289" href="#289">289</a> }
<a name="290" href="#290">290</a> <strong>else</strong>
<a name="291" href="#291">291</a> {
<a name="292" href="#292">292</a> future = <strong>new</strong> <a href="../../../../../org/apache/mina/common/WriteFuture.html">WriteFuture</a>();
<a name="293" href="#293">293</a> nextFilter.filterWrite( session, <strong>new</strong> WriteRequest( buf, future ) );
<a name="294" href="#294">294</a> }
<a name="295" href="#295">295</a> <strong>return</strong> future;
<a name="296" href="#296">296</a> }
<a name="297" href="#297">297</a> }
<a name="298" href="#298">298</a> }
</pre>
<hr/><div id="footer">This page was automatically generated by <a href="http://maven.apache.org/">Maven</a></div></body>
</html>