blob: c0f4e1bda95127e770ca5e99f8323e591afef254 [file] [log] [blame]
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html lang="en">
<head>
<title>Source code</title>
<link rel="stylesheet" type="text/css" href="../../../../../../stylesheet.css" title="Style">
</head>
<body>
<div class="sourceContainer">
<pre><span class="sourceLineNo">001</span>/*<a name="line.1"></a>
<span class="sourceLineNo">002</span> * Licensed to the Apache Software Foundation (ASF) under one<a name="line.2"></a>
<span class="sourceLineNo">003</span> * or more contributor license agreements. See the NOTICE file<a name="line.3"></a>
<span class="sourceLineNo">004</span> * distributed with this work for additional information<a name="line.4"></a>
<span class="sourceLineNo">005</span> * regarding copyright ownership. The ASF licenses this file<a name="line.5"></a>
<span class="sourceLineNo">006</span> * to you under the Apache License, Version 2.0 (the<a name="line.6"></a>
<span class="sourceLineNo">007</span> * "License"); you may not use this file except in compliance<a name="line.7"></a>
<span class="sourceLineNo">008</span> * with the License. You may obtain a copy of the License at<a name="line.8"></a>
<span class="sourceLineNo">009</span> *<a name="line.9"></a>
<span class="sourceLineNo">010</span> * http://www.apache.org/licenses/LICENSE-2.0<a name="line.10"></a>
<span class="sourceLineNo">011</span> *<a name="line.11"></a>
<span class="sourceLineNo">012</span> * Unless required by applicable law or agreed to in writing,<a name="line.12"></a>
<span class="sourceLineNo">013</span> * software distributed under the License is distributed on an<a name="line.13"></a>
<span class="sourceLineNo">014</span> * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY<a name="line.14"></a>
<span class="sourceLineNo">015</span> * KIND, either express or implied. See the License for the<a name="line.15"></a>
<span class="sourceLineNo">016</span> * specific language governing permissions and limitations<a name="line.16"></a>
<span class="sourceLineNo">017</span> * under the License.<a name="line.17"></a>
<span class="sourceLineNo">018</span> *<a name="line.18"></a>
<span class="sourceLineNo">019</span> */<a name="line.19"></a>
<span class="sourceLineNo">020</span>package org.apache.mina.filter.codec;<a name="line.20"></a>
<span class="sourceLineNo">021</span><a name="line.21"></a>
<span class="sourceLineNo">022</span>import org.apache.mina.core.buffer.IoBuffer;<a name="line.22"></a>
<span class="sourceLineNo">023</span>import org.apache.mina.core.service.TransportMetadata;<a name="line.23"></a>
<span class="sourceLineNo">024</span>import org.apache.mina.core.session.AttributeKey;<a name="line.24"></a>
<span class="sourceLineNo">025</span>import org.apache.mina.core.session.IoSession;<a name="line.25"></a>
<span class="sourceLineNo">026</span><a name="line.26"></a>
<span class="sourceLineNo">027</span>/**<a name="line.27"></a>
<span class="sourceLineNo">028</span> * A {@link ProtocolDecoder} that cumulates the content of received buffers to a<a name="line.28"></a>
<span class="sourceLineNo">029</span> * &lt;em&gt;cumulative buffer&lt;/em&gt; to help users implement decoders.<a name="line.29"></a>
<span class="sourceLineNo">030</span> * &lt;p&gt;<a name="line.30"></a>
<span class="sourceLineNo">031</span> * If the received {@link IoBuffer} is only a part of a message. decoders should<a name="line.31"></a>
<span class="sourceLineNo">032</span> * cumulate received buffers to make a message complete or to postpone decoding<a name="line.32"></a>
<span class="sourceLineNo">033</span> * until more buffers arrive.<a name="line.33"></a>
<span class="sourceLineNo">034</span> * &lt;p&gt;<a name="line.34"></a>
<span class="sourceLineNo">035</span> * Here is an example decoder that decodes CRLF terminated lines into<a name="line.35"></a>
<span class="sourceLineNo">036</span> * &lt;code&gt;Command&lt;/code&gt; objects:<a name="line.36"></a>
<span class="sourceLineNo">037</span> * <a name="line.37"></a>
<span class="sourceLineNo">038</span> * &lt;pre&gt;<a name="line.38"></a>
<span class="sourceLineNo">039</span> * public class CrLfTerminatedCommandLineDecoder extends CumulativeProtocolDecoder {<a name="line.39"></a>
<span class="sourceLineNo">040</span> * <a name="line.40"></a>
<span class="sourceLineNo">041</span> * private Command parseCommand(IoBuffer in) {<a name="line.41"></a>
<span class="sourceLineNo">042</span> * // Convert the bytes in the specified buffer to a<a name="line.42"></a>
<span class="sourceLineNo">043</span> * // Command object.<a name="line.43"></a>
<span class="sourceLineNo">044</span> * ...<a name="line.44"></a>
<span class="sourceLineNo">045</span> * }<a name="line.45"></a>
<span class="sourceLineNo">046</span> * <a name="line.46"></a>
<span class="sourceLineNo">047</span> * protected boolean doDecode(IoSession session, IoBuffer in, ProtocolDecoderOutput out) throws Exception {<a name="line.47"></a>
<span class="sourceLineNo">048</span> * <a name="line.48"></a>
<span class="sourceLineNo">049</span> * // Remember the initial position.<a name="line.49"></a>
<span class="sourceLineNo">050</span> * int start = in.position();<a name="line.50"></a>
<span class="sourceLineNo">051</span> * <a name="line.51"></a>
<span class="sourceLineNo">052</span> * // Now find the first CRLF in the buffer.<a name="line.52"></a>
<span class="sourceLineNo">053</span> * byte previous = 0;<a name="line.53"></a>
<span class="sourceLineNo">054</span> * while (in.hasRemaining()) {<a name="line.54"></a>
<span class="sourceLineNo">055</span> * byte current = in.get();<a name="line.55"></a>
<span class="sourceLineNo">056</span> * <a name="line.56"></a>
<span class="sourceLineNo">057</span> * if (previous == '\r' &amp;amp;&amp;amp; current == '\n') {<a name="line.57"></a>
<span class="sourceLineNo">058</span> * // Remember the current position and limit.<a name="line.58"></a>
<span class="sourceLineNo">059</span> * int position = in.position();<a name="line.59"></a>
<span class="sourceLineNo">060</span> * int limit = in.limit();<a name="line.60"></a>
<span class="sourceLineNo">061</span> * try {<a name="line.61"></a>
<span class="sourceLineNo">062</span> * in.position(start);<a name="line.62"></a>
<span class="sourceLineNo">063</span> * in.limit(position);<a name="line.63"></a>
<span class="sourceLineNo">064</span> * // The bytes between in.position() and in.limit()<a name="line.64"></a>
<span class="sourceLineNo">065</span> * // now contain a full CRLF terminated line.<a name="line.65"></a>
<span class="sourceLineNo">066</span> * out.write(parseCommand(in.slice()));<a name="line.66"></a>
<span class="sourceLineNo">067</span> * } finally {<a name="line.67"></a>
<span class="sourceLineNo">068</span> * // Set the position to point right after the<a name="line.68"></a>
<span class="sourceLineNo">069</span> * // detected line and set the limit to the old<a name="line.69"></a>
<span class="sourceLineNo">070</span> * // one.<a name="line.70"></a>
<span class="sourceLineNo">071</span> * in.position(position);<a name="line.71"></a>
<span class="sourceLineNo">072</span> * in.limit(limit);<a name="line.72"></a>
<span class="sourceLineNo">073</span> * }<a name="line.73"></a>
<span class="sourceLineNo">074</span> * // Decoded one line; CumulativeProtocolDecoder will<a name="line.74"></a>
<span class="sourceLineNo">075</span> * // call me again until I return false. So just<a name="line.75"></a>
<span class="sourceLineNo">076</span> * // return true until there are no more lines in the<a name="line.76"></a>
<span class="sourceLineNo">077</span> * // buffer.<a name="line.77"></a>
<span class="sourceLineNo">078</span> * return true;<a name="line.78"></a>
<span class="sourceLineNo">079</span> * }<a name="line.79"></a>
<span class="sourceLineNo">080</span> * <a name="line.80"></a>
<span class="sourceLineNo">081</span> * previous = current;<a name="line.81"></a>
<span class="sourceLineNo">082</span> * }<a name="line.82"></a>
<span class="sourceLineNo">083</span> * <a name="line.83"></a>
<span class="sourceLineNo">084</span> * // Could not find CRLF in the buffer. Reset the initial<a name="line.84"></a>
<span class="sourceLineNo">085</span> * // position to the one we recorded above.<a name="line.85"></a>
<span class="sourceLineNo">086</span> * in.position(start);<a name="line.86"></a>
<span class="sourceLineNo">087</span> * <a name="line.87"></a>
<span class="sourceLineNo">088</span> * return false;<a name="line.88"></a>
<span class="sourceLineNo">089</span> * }<a name="line.89"></a>
<span class="sourceLineNo">090</span> * }<a name="line.90"></a>
<span class="sourceLineNo">091</span> * &lt;/pre&gt;<a name="line.91"></a>
<span class="sourceLineNo">092</span> * &lt;p&gt;<a name="line.92"></a>
<span class="sourceLineNo">093</span> * Please note that this decoder simply forward the call to<a name="line.93"></a>
<span class="sourceLineNo">094</span> * {@link #doDecode(IoSession, IoBuffer, ProtocolDecoderOutput)} if the<a name="line.94"></a>
<span class="sourceLineNo">095</span> * underlying transport doesn't have a packet fragmentation. Whether the<a name="line.95"></a>
<span class="sourceLineNo">096</span> * transport has fragmentation or not is determined by querying<a name="line.96"></a>
<span class="sourceLineNo">097</span> * {@link TransportMetadata}.<a name="line.97"></a>
<span class="sourceLineNo">098</span> *<a name="line.98"></a>
<span class="sourceLineNo">099</span> * @author &lt;a href="http://mina.apache.org"&gt;Apache MINA Project&lt;/a&gt;<a name="line.99"></a>
<span class="sourceLineNo">100</span> */<a name="line.100"></a>
<span class="sourceLineNo">101</span>public abstract class CumulativeProtocolDecoder extends ProtocolDecoderAdapter {<a name="line.101"></a>
<span class="sourceLineNo">102</span><a name="line.102"></a>
<span class="sourceLineNo">103</span> private final AttributeKey BUFFER = new AttributeKey(getClass(), "buffer");<a name="line.103"></a>
<span class="sourceLineNo">104</span><a name="line.104"></a>
<span class="sourceLineNo">105</span> /**<a name="line.105"></a>
<span class="sourceLineNo">106</span> * Creates a new instance.<a name="line.106"></a>
<span class="sourceLineNo">107</span> */<a name="line.107"></a>
<span class="sourceLineNo">108</span> protected CumulativeProtocolDecoder() {<a name="line.108"></a>
<span class="sourceLineNo">109</span> // Do nothing<a name="line.109"></a>
<span class="sourceLineNo">110</span> }<a name="line.110"></a>
<span class="sourceLineNo">111</span><a name="line.111"></a>
<span class="sourceLineNo">112</span> /**<a name="line.112"></a>
<span class="sourceLineNo">113</span> * Cumulates content of &lt;tt&gt;in&lt;/tt&gt; into internal buffer and forwards<a name="line.113"></a>
<span class="sourceLineNo">114</span> * decoding request to<a name="line.114"></a>
<span class="sourceLineNo">115</span> * {@link #doDecode(IoSession, IoBuffer, ProtocolDecoderOutput)}.<a name="line.115"></a>
<span class="sourceLineNo">116</span> * &lt;tt&gt;doDecode()&lt;/tt&gt; is invoked repeatedly until it returns &lt;tt&gt;false&lt;/tt&gt;<a name="line.116"></a>
<span class="sourceLineNo">117</span> * and the cumulative buffer is compacted after decoding ends.<a name="line.117"></a>
<span class="sourceLineNo">118</span> *<a name="line.118"></a>
<span class="sourceLineNo">119</span> * @throws IllegalStateException<a name="line.119"></a>
<span class="sourceLineNo">120</span> * if your &lt;tt&gt;doDecode()&lt;/tt&gt; returned &lt;tt&gt;true&lt;/tt&gt; not<a name="line.120"></a>
<span class="sourceLineNo">121</span> * consuming the cumulative buffer.<a name="line.121"></a>
<span class="sourceLineNo">122</span> */<a name="line.122"></a>
<span class="sourceLineNo">123</span> public void decode(IoSession session, IoBuffer in, ProtocolDecoderOutput out) throws Exception {<a name="line.123"></a>
<span class="sourceLineNo">124</span> if (!session.getTransportMetadata().hasFragmentation()) {<a name="line.124"></a>
<span class="sourceLineNo">125</span> while (in.hasRemaining()) {<a name="line.125"></a>
<span class="sourceLineNo">126</span> if (!doDecode(session, in, out)) {<a name="line.126"></a>
<span class="sourceLineNo">127</span> break;<a name="line.127"></a>
<span class="sourceLineNo">128</span> }<a name="line.128"></a>
<span class="sourceLineNo">129</span> }<a name="line.129"></a>
<span class="sourceLineNo">130</span><a name="line.130"></a>
<span class="sourceLineNo">131</span> return;<a name="line.131"></a>
<span class="sourceLineNo">132</span> }<a name="line.132"></a>
<span class="sourceLineNo">133</span><a name="line.133"></a>
<span class="sourceLineNo">134</span> boolean usingSessionBuffer = true;<a name="line.134"></a>
<span class="sourceLineNo">135</span> IoBuffer buf = (IoBuffer) session.getAttribute(BUFFER);<a name="line.135"></a>
<span class="sourceLineNo">136</span> // If we have a session buffer, append data to that; otherwise<a name="line.136"></a>
<span class="sourceLineNo">137</span> // use the buffer read from the network directly.<a name="line.137"></a>
<span class="sourceLineNo">138</span> if (buf != null) {<a name="line.138"></a>
<span class="sourceLineNo">139</span> boolean appended = false;<a name="line.139"></a>
<span class="sourceLineNo">140</span> // Make sure that the buffer is auto-expanded.<a name="line.140"></a>
<span class="sourceLineNo">141</span> if (buf.isAutoExpand()) {<a name="line.141"></a>
<span class="sourceLineNo">142</span> try {<a name="line.142"></a>
<span class="sourceLineNo">143</span> buf.put(in);<a name="line.143"></a>
<span class="sourceLineNo">144</span> appended = true;<a name="line.144"></a>
<span class="sourceLineNo">145</span> } catch (IllegalStateException e) {<a name="line.145"></a>
<span class="sourceLineNo">146</span> // A user called derivation method (e.g. slice()),<a name="line.146"></a>
<span class="sourceLineNo">147</span> // which disables auto-expansion of the parent buffer.<a name="line.147"></a>
<span class="sourceLineNo">148</span> } catch (IndexOutOfBoundsException e) {<a name="line.148"></a>
<span class="sourceLineNo">149</span> // A user disabled auto-expansion.<a name="line.149"></a>
<span class="sourceLineNo">150</span> }<a name="line.150"></a>
<span class="sourceLineNo">151</span> }<a name="line.151"></a>
<span class="sourceLineNo">152</span><a name="line.152"></a>
<span class="sourceLineNo">153</span> if (appended) {<a name="line.153"></a>
<span class="sourceLineNo">154</span> buf.flip();<a name="line.154"></a>
<span class="sourceLineNo">155</span> } else {<a name="line.155"></a>
<span class="sourceLineNo">156</span> // Reallocate the buffer if append operation failed due to<a name="line.156"></a>
<span class="sourceLineNo">157</span> // derivation or disabled auto-expansion.<a name="line.157"></a>
<span class="sourceLineNo">158</span> buf.flip();<a name="line.158"></a>
<span class="sourceLineNo">159</span> IoBuffer newBuf = IoBuffer.allocate(buf.remaining() + in.remaining()).setAutoExpand(true);<a name="line.159"></a>
<span class="sourceLineNo">160</span> newBuf.order(buf.order());<a name="line.160"></a>
<span class="sourceLineNo">161</span> newBuf.put(buf);<a name="line.161"></a>
<span class="sourceLineNo">162</span> newBuf.put(in);<a name="line.162"></a>
<span class="sourceLineNo">163</span> newBuf.flip();<a name="line.163"></a>
<span class="sourceLineNo">164</span> buf = newBuf;<a name="line.164"></a>
<span class="sourceLineNo">165</span><a name="line.165"></a>
<span class="sourceLineNo">166</span> // Update the session attribute.<a name="line.166"></a>
<span class="sourceLineNo">167</span> session.setAttribute(BUFFER, buf);<a name="line.167"></a>
<span class="sourceLineNo">168</span> }<a name="line.168"></a>
<span class="sourceLineNo">169</span> } else {<a name="line.169"></a>
<span class="sourceLineNo">170</span> buf = in;<a name="line.170"></a>
<span class="sourceLineNo">171</span> usingSessionBuffer = false;<a name="line.171"></a>
<span class="sourceLineNo">172</span> }<a name="line.172"></a>
<span class="sourceLineNo">173</span><a name="line.173"></a>
<span class="sourceLineNo">174</span> for (;;) {<a name="line.174"></a>
<span class="sourceLineNo">175</span> int oldPos = buf.position();<a name="line.175"></a>
<span class="sourceLineNo">176</span> boolean decoded = doDecode(session, buf, out);<a name="line.176"></a>
<span class="sourceLineNo">177</span> if (decoded) {<a name="line.177"></a>
<span class="sourceLineNo">178</span> if (buf.position() == oldPos) {<a name="line.178"></a>
<span class="sourceLineNo">179</span> throw new IllegalStateException("doDecode() can't return true when buffer is not consumed.");<a name="line.179"></a>
<span class="sourceLineNo">180</span> }<a name="line.180"></a>
<span class="sourceLineNo">181</span><a name="line.181"></a>
<span class="sourceLineNo">182</span> if (!buf.hasRemaining()) {<a name="line.182"></a>
<span class="sourceLineNo">183</span> break;<a name="line.183"></a>
<span class="sourceLineNo">184</span> }<a name="line.184"></a>
<span class="sourceLineNo">185</span> } else {<a name="line.185"></a>
<span class="sourceLineNo">186</span> break;<a name="line.186"></a>
<span class="sourceLineNo">187</span> }<a name="line.187"></a>
<span class="sourceLineNo">188</span> }<a name="line.188"></a>
<span class="sourceLineNo">189</span><a name="line.189"></a>
<span class="sourceLineNo">190</span> // if there is any data left that cannot be decoded, we store<a name="line.190"></a>
<span class="sourceLineNo">191</span> // it in a buffer in the session and next time this decoder is<a name="line.191"></a>
<span class="sourceLineNo">192</span> // invoked the session buffer gets appended to<a name="line.192"></a>
<span class="sourceLineNo">193</span> if (buf.hasRemaining()) {<a name="line.193"></a>
<span class="sourceLineNo">194</span> if (usingSessionBuffer &amp;&amp; buf.isAutoExpand()) {<a name="line.194"></a>
<span class="sourceLineNo">195</span> buf.compact();<a name="line.195"></a>
<span class="sourceLineNo">196</span> } else {<a name="line.196"></a>
<span class="sourceLineNo">197</span> storeRemainingInSession(buf, session);<a name="line.197"></a>
<span class="sourceLineNo">198</span> }<a name="line.198"></a>
<span class="sourceLineNo">199</span> } else {<a name="line.199"></a>
<span class="sourceLineNo">200</span> if (usingSessionBuffer) {<a name="line.200"></a>
<span class="sourceLineNo">201</span> removeSessionBuffer(session);<a name="line.201"></a>
<span class="sourceLineNo">202</span> }<a name="line.202"></a>
<span class="sourceLineNo">203</span> }<a name="line.203"></a>
<span class="sourceLineNo">204</span> }<a name="line.204"></a>
<span class="sourceLineNo">205</span><a name="line.205"></a>
<span class="sourceLineNo">206</span> /**<a name="line.206"></a>
<span class="sourceLineNo">207</span> * Implement this method to consume the specified cumulative buffer and<a name="line.207"></a>
<span class="sourceLineNo">208</span> * decode its content into message(s).<a name="line.208"></a>
<span class="sourceLineNo">209</span> *<a name="line.209"></a>
<span class="sourceLineNo">210</span> * @param session The current Session<a name="line.210"></a>
<span class="sourceLineNo">211</span> * @param in the cumulative buffer<a name="line.211"></a>
<span class="sourceLineNo">212</span> * @param out The {@link ProtocolDecoderOutput} that will receive the decoded message<a name="line.212"></a>
<span class="sourceLineNo">213</span> * @return &lt;tt&gt;true&lt;/tt&gt; if and only if there's more to decode in the buffer<a name="line.213"></a>
<span class="sourceLineNo">214</span> * and you want to have &lt;tt&gt;doDecode&lt;/tt&gt; method invoked again.<a name="line.214"></a>
<span class="sourceLineNo">215</span> * Return &lt;tt&gt;false&lt;/tt&gt; if remaining data is not enough to decode,<a name="line.215"></a>
<span class="sourceLineNo">216</span> * then this method will be invoked again when more data is<a name="line.216"></a>
<span class="sourceLineNo">217</span> * cumulated.<a name="line.217"></a>
<span class="sourceLineNo">218</span> * @throws Exception if cannot decode &lt;tt&gt;in&lt;/tt&gt;.<a name="line.218"></a>
<span class="sourceLineNo">219</span> */<a name="line.219"></a>
<span class="sourceLineNo">220</span> protected abstract boolean doDecode(IoSession session, IoBuffer in, ProtocolDecoderOutput out) throws Exception;<a name="line.220"></a>
<span class="sourceLineNo">221</span><a name="line.221"></a>
<span class="sourceLineNo">222</span> /**<a name="line.222"></a>
<span class="sourceLineNo">223</span> * Releases the cumulative buffer used by the specified &lt;tt&gt;session&lt;/tt&gt;.<a name="line.223"></a>
<span class="sourceLineNo">224</span> * Please don't forget to call &lt;tt&gt;super.dispose( session )&lt;/tt&gt; when you<a name="line.224"></a>
<span class="sourceLineNo">225</span> * override this method.<a name="line.225"></a>
<span class="sourceLineNo">226</span> */<a name="line.226"></a>
<span class="sourceLineNo">227</span> @Override<a name="line.227"></a>
<span class="sourceLineNo">228</span> public void dispose(IoSession session) throws Exception {<a name="line.228"></a>
<span class="sourceLineNo">229</span> removeSessionBuffer(session);<a name="line.229"></a>
<span class="sourceLineNo">230</span> }<a name="line.230"></a>
<span class="sourceLineNo">231</span><a name="line.231"></a>
<span class="sourceLineNo">232</span> private void removeSessionBuffer(IoSession session) {<a name="line.232"></a>
<span class="sourceLineNo">233</span> session.removeAttribute(BUFFER);<a name="line.233"></a>
<span class="sourceLineNo">234</span> }<a name="line.234"></a>
<span class="sourceLineNo">235</span><a name="line.235"></a>
<span class="sourceLineNo">236</span> private void storeRemainingInSession(IoBuffer buf, IoSession session) {<a name="line.236"></a>
<span class="sourceLineNo">237</span> final IoBuffer remainingBuf = IoBuffer.allocate(buf.capacity()).setAutoExpand(true);<a name="line.237"></a>
<span class="sourceLineNo">238</span><a name="line.238"></a>
<span class="sourceLineNo">239</span> remainingBuf.order(buf.order());<a name="line.239"></a>
<span class="sourceLineNo">240</span> remainingBuf.put(buf);<a name="line.240"></a>
<span class="sourceLineNo">241</span><a name="line.241"></a>
<span class="sourceLineNo">242</span> session.setAttribute(BUFFER, remainingBuf);<a name="line.242"></a>
<span class="sourceLineNo">243</span> }<a name="line.243"></a>
<span class="sourceLineNo">244</span>}<a name="line.244"></a>
</pre>
</div>
</body>
</html>