| <!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.prefixedstring;<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.BufferDataException;<a name="line.22"></a> |
| <span class="sourceLineNo">023</span>import org.apache.mina.core.buffer.IoBuffer;<a name="line.23"></a> |
| <span class="sourceLineNo">024</span>import org.apache.mina.core.session.IoSession;<a name="line.24"></a> |
| <span class="sourceLineNo">025</span>import org.apache.mina.filter.codec.CumulativeProtocolDecoder;<a name="line.25"></a> |
| <span class="sourceLineNo">026</span>import org.apache.mina.filter.codec.ProtocolDecoder;<a name="line.26"></a> |
| <span class="sourceLineNo">027</span>import org.apache.mina.filter.codec.ProtocolDecoderOutput;<a name="line.27"></a> |
| <span class="sourceLineNo">028</span><a name="line.28"></a> |
| <span class="sourceLineNo">029</span>import java.nio.charset.Charset;<a name="line.29"></a> |
| <span class="sourceLineNo">030</span><a name="line.30"></a> |
| <span class="sourceLineNo">031</span>/**<a name="line.31"></a> |
| <span class="sourceLineNo">032</span> * A {@link ProtocolDecoder} which decodes a String using a fixed-length length prefix.<a name="line.32"></a> |
| <span class="sourceLineNo">033</span> *<a name="line.33"></a> |
| <span class="sourceLineNo">034</span> * @author <a href="http://mina.apache.org">Apache MINA Project</a><a name="line.34"></a> |
| <span class="sourceLineNo">035</span> */<a name="line.35"></a> |
| <span class="sourceLineNo">036</span>public class PrefixedStringDecoder extends CumulativeProtocolDecoder {<a name="line.36"></a> |
| <span class="sourceLineNo">037</span><a name="line.37"></a> |
| <span class="sourceLineNo">038</span> public final static int DEFAULT_PREFIX_LENGTH = 4;<a name="line.38"></a> |
| <span class="sourceLineNo">039</span><a name="line.39"></a> |
| <span class="sourceLineNo">040</span> public final static int DEFAULT_MAX_DATA_LENGTH = 2048;<a name="line.40"></a> |
| <span class="sourceLineNo">041</span><a name="line.41"></a> |
| <span class="sourceLineNo">042</span> private final Charset charset;<a name="line.42"></a> |
| <span class="sourceLineNo">043</span><a name="line.43"></a> |
| <span class="sourceLineNo">044</span> private int prefixLength = DEFAULT_PREFIX_LENGTH;<a name="line.44"></a> |
| <span class="sourceLineNo">045</span><a name="line.45"></a> |
| <span class="sourceLineNo">046</span> private int maxDataLength = DEFAULT_MAX_DATA_LENGTH;<a name="line.46"></a> |
| <span class="sourceLineNo">047</span><a name="line.47"></a> |
| <span class="sourceLineNo">048</span> /**<a name="line.48"></a> |
| <span class="sourceLineNo">049</span> * @param charset the charset to use for encoding<a name="line.49"></a> |
| <span class="sourceLineNo">050</span> * @param prefixLength the length of the prefix<a name="line.50"></a> |
| <span class="sourceLineNo">051</span> * @param maxDataLength maximum number of bytes allowed for a single String<a name="line.51"></a> |
| <span class="sourceLineNo">052</span> */<a name="line.52"></a> |
| <span class="sourceLineNo">053</span> public PrefixedStringDecoder(Charset charset, int prefixLength, int maxDataLength) {<a name="line.53"></a> |
| <span class="sourceLineNo">054</span> this.charset = charset;<a name="line.54"></a> |
| <span class="sourceLineNo">055</span> this.prefixLength = prefixLength;<a name="line.55"></a> |
| <span class="sourceLineNo">056</span> this.maxDataLength = maxDataLength;<a name="line.56"></a> |
| <span class="sourceLineNo">057</span> }<a name="line.57"></a> |
| <span class="sourceLineNo">058</span><a name="line.58"></a> |
| <span class="sourceLineNo">059</span> public PrefixedStringDecoder(Charset charset, int prefixLength) {<a name="line.59"></a> |
| <span class="sourceLineNo">060</span> this(charset, prefixLength, DEFAULT_MAX_DATA_LENGTH);<a name="line.60"></a> |
| <span class="sourceLineNo">061</span> }<a name="line.61"></a> |
| <span class="sourceLineNo">062</span><a name="line.62"></a> |
| <span class="sourceLineNo">063</span> public PrefixedStringDecoder(Charset charset) {<a name="line.63"></a> |
| <span class="sourceLineNo">064</span> this(charset, DEFAULT_PREFIX_LENGTH);<a name="line.64"></a> |
| <span class="sourceLineNo">065</span> }<a name="line.65"></a> |
| <span class="sourceLineNo">066</span><a name="line.66"></a> |
| <span class="sourceLineNo">067</span> /**<a name="line.67"></a> |
| <span class="sourceLineNo">068</span> * Sets the number of bytes used by the length prefix<a name="line.68"></a> |
| <span class="sourceLineNo">069</span> *<a name="line.69"></a> |
| <span class="sourceLineNo">070</span> * @param prefixLength the length of the length prefix (1, 2, or 4)<a name="line.70"></a> |
| <span class="sourceLineNo">071</span> */<a name="line.71"></a> |
| <span class="sourceLineNo">072</span> public void setPrefixLength(int prefixLength) {<a name="line.72"></a> |
| <span class="sourceLineNo">073</span> this.prefixLength = prefixLength;<a name="line.73"></a> |
| <span class="sourceLineNo">074</span> }<a name="line.74"></a> |
| <span class="sourceLineNo">075</span><a name="line.75"></a> |
| <span class="sourceLineNo">076</span> /**<a name="line.76"></a> |
| <span class="sourceLineNo">077</span> * Gets the length of the length prefix (1, 2, or 4)<a name="line.77"></a> |
| <span class="sourceLineNo">078</span> *<a name="line.78"></a> |
| <span class="sourceLineNo">079</span> * @return length of the length prefix<a name="line.79"></a> |
| <span class="sourceLineNo">080</span> */<a name="line.80"></a> |
| <span class="sourceLineNo">081</span> public int getPrefixLength() {<a name="line.81"></a> |
| <span class="sourceLineNo">082</span> return prefixLength;<a name="line.82"></a> |
| <span class="sourceLineNo">083</span> }<a name="line.83"></a> |
| <span class="sourceLineNo">084</span><a name="line.84"></a> |
| <span class="sourceLineNo">085</span> /**<a name="line.85"></a> |
| <span class="sourceLineNo">086</span> * Sets the maximum allowed value specified as data length in the incoming data<a name="line.86"></a> |
| <span class="sourceLineNo">087</span> * <p><a name="line.87"></a> |
| <span class="sourceLineNo">088</span> * Useful for preventing an OutOfMemory attack by the peer.<a name="line.88"></a> |
| <span class="sourceLineNo">089</span> * The decoder will throw a {@link BufferDataException} when data length<a name="line.89"></a> |
| <span class="sourceLineNo">090</span> * specified in the incoming data is greater than maxDataLength<a name="line.90"></a> |
| <span class="sourceLineNo">091</span> * The default value is {@link PrefixedStringDecoder#DEFAULT_MAX_DATA_LENGTH}.<a name="line.91"></a> |
| <span class="sourceLineNo">092</span> * </p><a name="line.92"></a> |
| <span class="sourceLineNo">093</span> *<a name="line.93"></a> |
| <span class="sourceLineNo">094</span> * @param maxDataLength maximum allowed value specified as data length in the incoming data<a name="line.94"></a> |
| <span class="sourceLineNo">095</span> */<a name="line.95"></a> |
| <span class="sourceLineNo">096</span> public void setMaxDataLength(int maxDataLength) {<a name="line.96"></a> |
| <span class="sourceLineNo">097</span> this.maxDataLength = maxDataLength;<a name="line.97"></a> |
| <span class="sourceLineNo">098</span> }<a name="line.98"></a> |
| <span class="sourceLineNo">099</span><a name="line.99"></a> |
| <span class="sourceLineNo">100</span> /**<a name="line.100"></a> |
| <span class="sourceLineNo">101</span> * Gets the maximum number of bytes allowed for a single String<a name="line.101"></a> |
| <span class="sourceLineNo">102</span> *<a name="line.102"></a> |
| <span class="sourceLineNo">103</span> * @return maximum number of bytes allowed for a single String<a name="line.103"></a> |
| <span class="sourceLineNo">104</span> */<a name="line.104"></a> |
| <span class="sourceLineNo">105</span> public int getMaxDataLength() {<a name="line.105"></a> |
| <span class="sourceLineNo">106</span> return maxDataLength;<a name="line.106"></a> |
| <span class="sourceLineNo">107</span> }<a name="line.107"></a> |
| <span class="sourceLineNo">108</span><a name="line.108"></a> |
| <span class="sourceLineNo">109</span> protected boolean doDecode(IoSession session, IoBuffer in, ProtocolDecoderOutput out) throws Exception {<a name="line.109"></a> |
| <span class="sourceLineNo">110</span> if (in.prefixedDataAvailable(prefixLength, maxDataLength)) {<a name="line.110"></a> |
| <span class="sourceLineNo">111</span> String msg = in.getPrefixedString(prefixLength, charset.newDecoder());<a name="line.111"></a> |
| <span class="sourceLineNo">112</span> out.write(msg);<a name="line.112"></a> |
| <span class="sourceLineNo">113</span> return true;<a name="line.113"></a> |
| <span class="sourceLineNo">114</span> }<a name="line.114"></a> |
| <span class="sourceLineNo">115</span><a name="line.115"></a> |
| <span class="sourceLineNo">116</span> return false;<a name="line.116"></a> |
| <span class="sourceLineNo">117</span> }<a name="line.117"></a> |
| <span class="sourceLineNo">118</span>}<a name="line.118"></a> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| </pre> |
| </div> |
| </body> |
| </html> |
