Package org.apache.mina.filter.codec.textline

Class TextLineDecoder

java.lang.Object

org.apache.mina.filter.codec.textline.TextLineDecoder

All Implemented Interfaces:

ProtocolDecoder

public class TextLineDecoder
extends java.lang.Object
implements ProtocolDecoder

A ProtocolDecoder which decodes a text line into a string.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
private class	TextLineDecoder.Context	A Context used during the decoding of a lin.

Field Summary

Fields

Modifier and Type	Field	Description
private int	bufferLength	The default maximum buffer length.
private java.nio.charset.Charset	charset
private static AttributeKey	CONTEXT
private IoBuffer	delimBuf	An IoBuffer containing the delimiter
private LineDelimiter	delimiter	The delimiter used to determinate when a line has been fully decoded
private int	maxLineLength	The default maximum Line length.

Constructor Summary

Constructors

Constructor	Description
TextLineDecoder()	Creates a new instance with the current default Charset and LineDelimiter.AUTO delimiter.
TextLineDecoder(java.lang.String delimiter)	Creates a new instance with the current default Charset and the specified delimiter.
TextLineDecoder(java.nio.charset.Charset charset)	Creates a new instance with the spcified charset and LineDelimiter.AUTO delimiter.
TextLineDecoder(java.nio.charset.Charset charset, java.lang.String delimiter)	Creates a new instance with the spcified charset and the specified delimiter.
TextLineDecoder(java.nio.charset.Charset charset, LineDelimiter delimiter)	Creates a new instance with the specified charset and the specified delimiter.
TextLineDecoder(LineDelimiter delimiter)	Creates a new instance with the current default Charset and the specified delimiter.

Method Summary

Modifier and Type	Method	Description
void	decode(IoSession session, IoBuffer in, ProtocolDecoderOutput out)	Decodes binary or protocol-specific content into higher-level message objects.
private void	decodeAuto(TextLineDecoder.Context ctx, IoSession session, IoBuffer in, ProtocolDecoderOutput out)	Decode a line using the default delimiter on the current system
private void	decodeNormal(TextLineDecoder.Context ctx, IoSession session, IoBuffer in, ProtocolDecoderOutput out)	Decode a line using the delimiter defined by the caller
void	dispose(IoSession session)	Releases all resources related with this decoder.
void	finishDecode(IoSession session, ProtocolDecoderOutput out)	Invoked when the specified session is closed.
int	getBufferLength()
private TextLineDecoder.Context	getContext(IoSession session)
int	getMaxLineLength()
void	setBufferLength(int bufferLength)	Sets the default buffer size.
void	setMaxLineLength(int maxLineLength)	Sets the allowed maximum size of the line to be decoded.
protected void	writeText(IoSession session, java.lang.String text, ProtocolDecoderOutput out)	By default, this method propagates the decoded line of text to ProtocolDecoderOutput#write(Object).

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

CONTEXT

private static final AttributeKey CONTEXT

charset

private final java.nio.charset.Charset charset

delimiter

private final LineDelimiter delimiter

The delimiter used to determinate when a line has been fully decoded

delimBuf

private IoBuffer delimBuf

An IoBuffer containing the delimiter

maxLineLength

private int maxLineLength

The default maximum Line length. Default to 1024.

bufferLength

private int bufferLength

The default maximum buffer length. Default to 128 chars.

Constructor Detail

TextLineDecoder

public TextLineDecoder()

Creates a new instance with the current default Charset and LineDelimiter.AUTO delimiter.

TextLineDecoder

public TextLineDecoder(java.lang.String delimiter)

Creates a new instance with the current default Charset and the specified delimiter.

Parameters:

delimiter - The line delimiter to use

TextLineDecoder

public TextLineDecoder(LineDelimiter delimiter)

Creates a new instance with the current default Charset and the specified delimiter.

Parameters:

delimiter - The line delimiter to use

TextLineDecoder

public TextLineDecoder(java.nio.charset.Charset charset)

Creates a new instance with the spcified charset and LineDelimiter.AUTO delimiter.

Parameters:

charset - The Charset to use

TextLineDecoder

public TextLineDecoder(java.nio.charset.Charset charset,
                       java.lang.String delimiter)

Creates a new instance with the spcified charset and the specified delimiter.

Parameters:

charset - The Charset to use

delimiter - The line delimiter to use

TextLineDecoder

public TextLineDecoder(java.nio.charset.Charset charset,
                       LineDelimiter delimiter)

Creates a new instance with the specified charset and the specified delimiter.

Parameters:

charset - The Charset to use

delimiter - The line delimiter to use

Method Detail

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 a BufferDataException. 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 a BufferDataException. The default value is 1024 (1KB).

Parameters:

maxLineLength - The maximum line length

setBufferLength

public void setBufferLength(int bufferLength)

Sets the default buffer size. This buffer is used in the Context to store the decoded line.

Parameters:

bufferLength - The default bufer size

getBufferLength

public int getBufferLength()

Returns:

the allowed buffer size used to store the decoded line in the Context instance.

decode

public void decode(IoSession session,
                   IoBuffer in,
                   ProtocolDecoderOutput out)
            throws java.lang.Exception

Decodes binary or protocol-specific content into higher-level message objects. MINA invokes ProtocolDecoder.decode(IoSession, IoBuffer, ProtocolDecoderOutput) method with read data, and then the decoder implementation puts decoded messages into ProtocolDecoderOutput.

Specified by:

decode in interface ProtocolDecoder

Parameters:

session - The current Session

in - the buffer to decode

out - The ProtocolDecoderOutput that will receive the decoded message

Throws:

java.lang.Exception - if the read data violated protocol specification

getContext

private TextLineDecoder.Context getContext(IoSession session)

Parameters:

session - The session for which we want the context

Returns:

the context for this session

finishDecode

public void finishDecode(IoSession session,
                         ProtocolDecoderOutput out)
                  throws java.lang.Exception

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 that ProtocolDecoder.decode(IoSession, IoBuffer, ProtocolDecoderOutput) method didn't process completely.

Specified by:

finishDecode in interface ProtocolDecoder

Parameters:

session - The current Session

out - The ProtocolDecoderOutput that contains the decoded message

Throws:

java.lang.Exception - if the read data violated protocol specification

dispose

public void dispose(IoSession session)
             throws java.lang.Exception

Releases all resources related with this decoder.

Specified by:

dispose in interface ProtocolDecoder

Parameters:

session - The current Session

Throws:

java.lang.Exception - if failed to dispose all resources

decodeAuto

private void decodeAuto(TextLineDecoder.Context ctx,
                        IoSession session,
                        IoBuffer in,
                        ProtocolDecoderOutput out)
                 throws java.nio.charset.CharacterCodingException,
                        ProtocolDecoderException

Decode a line using the default delimiter on the current system

Throws:

java.nio.charset.CharacterCodingException

ProtocolDecoderException

decodeNormal

private void decodeNormal(TextLineDecoder.Context ctx,
                          IoSession session,
                          IoBuffer in,
                          ProtocolDecoderOutput out)
                   throws java.nio.charset.CharacterCodingException,
                          ProtocolDecoderException

Decode a line using the delimiter defined by the caller

Throws:

java.nio.charset.CharacterCodingException

ProtocolDecoderException

writeText

protected void writeText(IoSession session,
                         java.lang.String text,
                         ProtocolDecoderOutput out)

By default, this method propagates the decoded line of text to ProtocolDecoderOutput#write(Object). You may override this method to modify the default behavior.

Parameters:

session - the IoSession the received data.

text - the decoded text

out - the upstream ProtocolDecoderOutput.