Class HttpClientDecoder

java.lang.Object

org.apache.mina.http.HttpClientDecoder

All Implemented Interfaces:

ProtocolDecoder

public class HttpClientDecoder
extends Object
implements ProtocolDecoder

An HTTP decoder

Field Summary

Fields

Modifier and Type	Field	Description
private static final String	BODY_CHUNKED	Key for indicating chunked data
private static final String	BODY_REMAINING_BYTES	Key for the number of bytes remaining to read for completing the body
static final Pattern	COOKIE_SEPARATOR_PATTERN	Regex to split cookie header following RFC6265 Section 5.4
private static final String	DECODER_STATE_ATT	Key for decoder current state
static final Pattern	HEADER_VALUE_PATTERN	Regex to parse header name and value
static final Pattern	HEADERS_BODY_PATTERN	Regex to parse raw headers from body
static final Pattern	KEY_VALUE_PATTERN	Regex to parse out key/value pairs
private static final org.slf4j.Logger	LOGGER
static final Pattern	PARAM_STRING_PATTERN	Regex to parse out parameters from query string
private static final String	PARTIAL_HEAD_ATT	Key for the partial HTTP requests head
static final Pattern	QUERY_STRING_PATTERN	Regex to parse out QueryString from HttpRequest
static final Pattern	RAW_VALUE_PATTERN	Regex to parse raw headers and body
static final Pattern	REQUEST_LINE_PATTERN	Regex to parse HttpRequest Request Line
static final Pattern	RESPONSE_LINE_PATTERN	Regex to parse HttpRequest Request Line

Constructor Summary

Constructors

Constructor	Description
HttpClientDecoder()

Method Summary

Modifier and Type	Method	Description
void	decode(IoSession session, IoBuffer msg, ProtocolDecoderOutput out)	Decodes binary or protocol-specific content into higher-level message objects.
void	dispose(IoSession session)	Releases all resources related with this decoder.
void	finishDecode(IoSession session, ProtocolDecoderOutput out)	Invoked when the specified session is closed.
private DefaultHttpResponse	parseHttpReponseHead(ByteBuffer buffer)

Methods inherited from class Object

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

Field Details

LOGGER

private static final org.slf4j.Logger LOGGER

DECODER_STATE_ATT

private static final String DECODER_STATE_ATT

Key for decoder current state

See Also:

• Constant Field Values

PARTIAL_HEAD_ATT

private static final String PARTIAL_HEAD_ATT

Key for the partial HTTP requests head

See Also:

• Constant Field Values

BODY_REMAINING_BYTES

private static final String BODY_REMAINING_BYTES

Key for the number of bytes remaining to read for completing the body

See Also:

• Constant Field Values

BODY_CHUNKED

private static final String BODY_CHUNKED

Key for indicating chunked data

See Also:

• Constant Field Values

REQUEST_LINE_PATTERN

public static final Pattern REQUEST_LINE_PATTERN

Regex to parse HttpRequest Request Line

RESPONSE_LINE_PATTERN

public static final Pattern RESPONSE_LINE_PATTERN

Regex to parse HttpRequest Request Line

QUERY_STRING_PATTERN

public static final Pattern QUERY_STRING_PATTERN

Regex to parse out QueryString from HttpRequest

PARAM_STRING_PATTERN

public static final Pattern PARAM_STRING_PATTERN

Regex to parse out parameters from query string

KEY_VALUE_PATTERN

public static final Pattern KEY_VALUE_PATTERN

Regex to parse out key/value pairs

RAW_VALUE_PATTERN

public static final Pattern RAW_VALUE_PATTERN

Regex to parse raw headers and body

HEADERS_BODY_PATTERN

public static final Pattern HEADERS_BODY_PATTERN

Regex to parse raw headers from body

HEADER_VALUE_PATTERN

public static final Pattern HEADER_VALUE_PATTERN

Regex to parse header name and value

COOKIE_SEPARATOR_PATTERN

public static final Pattern COOKIE_SEPARATOR_PATTERN

Regex to split cookie header following RFC6265 Section 5.4

Constructor Details

HttpClientDecoder

public HttpClientDecoder()

Method Details

decode

public void decode(IoSession session,
 IoBuffer msg,
 ProtocolDecoderOutput out)

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

msg - the buffer to decode

out - The ProtocolDecoderOutput that will receive the decoded message

finishDecode

public void finishDecode(IoSession session,
 ProtocolDecoderOutput out)
                  throws 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:

Exception - if the read data violated protocol specification

dispose

public void dispose(IoSession session)
             throws Exception

Releases all resources related with this decoder.

Specified by:

dispose in interface ProtocolDecoder

Parameters:

session - The current Session

Throws:

Exception - if failed to dispose all resources

parseHttpReponseHead

private DefaultHttpResponse parseHttpReponseHead(ByteBuffer buffer)