Class TextLineDecoder
java.lang.Object
org.apache.mina.filter.codec.textline.TextLineDecoder
- All Implemented Interfaces:
ProtocolDecoder
A
ProtocolDecoder
which decodes a text line into a string.-
Constructor Summary
ConstructorsConstructorDescriptionCreates a new instance with the current defaultCharset
andLineDelimiter.AUTO
delimiter.TextLineDecoder
(Charset charset) Creates a new instance with the spcified charset andLineDelimiter.AUTO
delimiter.TextLineDecoder
(Charset charset, LineDelimiter delimiter) Creates a new instance with the specified charset and the specified delimiter. -
Method Summary
Modifier and TypeMethodDescriptionvoid
decode
(IoSession session, ByteBuffer in, ProtocolDecoderOutput out) Decodes binary or protocol-specific content into higher-level message objects.void
Releases all resources related with this decoder.void
finishDecode
(IoSession session, ProtocolDecoderOutput out) Invoked when the specified session is closed.int
Returns the allowed maximum size of the line to be decoded.void
setMaxLineLength
(int maxLineLength) Sets the allowed maximum size of the line to be decoded.
-
Constructor Details
-
TextLineDecoder
public TextLineDecoder()Creates a new instance with the current defaultCharset
andLineDelimiter.AUTO
delimiter. -
TextLineDecoder
Creates a new instance with the spcified charset andLineDelimiter.AUTO
delimiter. -
TextLineDecoder
Creates a new instance with the specified charset and the specified delimiter.
-
-
Method Details
-
getMaxLineLength
public int getMaxLineLength()Returns the allowed maximum size of the line to be decoded. If the size of the line to be decoded exceeds this value, the decoder will throw aBufferDataException
. The default value is 1024 (1KB). -
setMaxLineLength
public void setMaxLineLength(int maxLineLength) Sets the allowed maximum size of the line to be decoded. If the size of the line to be decoded exceeds this value, the decoder will throw aBufferDataException
. The default value is 1024 (1KB). -
decode
Description copied from interface:ProtocolDecoder
Decodes binary or protocol-specific content into higher-level message objects. MINA invokesProtocolDecoder.decode(IoSession, ByteBuffer, ProtocolDecoderOutput)
method with read data, and then the decoder implementation puts decoded messages intoProtocolDecoderOutput
.- Specified by:
decode
in interfaceProtocolDecoder
- Throws:
Exception
- if the read data violated protocol specification
-
finishDecode
Description copied from interface:ProtocolDecoder
Invoked when the specified session is closed. This method is useful when you deal with the protocol which doesn't specify the length of a message such as HTTP response without content-length header. Implement this method to process the remaining data thatProtocolDecoder.decode(IoSession, ByteBuffer, ProtocolDecoderOutput)
method didn't process completely.- Specified by:
finishDecode
in interfaceProtocolDecoder
- Throws:
Exception
- if the read data violated protocol specification
-
dispose
Description copied from interface:ProtocolDecoder
Releases all resources related with this decoder.- Specified by:
dispose
in interfaceProtocolDecoder
- Throws:
Exception
- if failed to dispose all resources
-