Package org.jdrupes.httpcodec.protocols.http.server

Class HttpRequestDecoder

java.lang.Object

org.jdrupes.httpcodec.protocols.http.HttpCodec<T>

org.jdrupes.httpcodec.protocols.http.HttpDecoder<HttpRequest,HttpResponse>

org.jdrupes.httpcodec.protocols.http.server.HttpRequestDecoder

All Implemented Interfaces:

Codec, Decoder<HttpRequest,HttpResponse>

public class HttpRequestDecoder
extends HttpDecoder<HttpRequest,HttpResponse>

A decoder for HTTP requests.

It accepts data from a sequence of ByteBuffers and decodes them into HttpRequests and their (optional) payload.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	HttpRequestDecoder.Result	Results from HttpRequestDecoder add no additional information to HttpDecoder.Result.

Nested classes/interfaces inherited from class org.jdrupes.httpcodec.protocols.http.HttpDecoder

HttpDecoder.BodyMode

Nested classes/interfaces inherited from interface org.jdrupes.httpcodec.Codec

Codec.ProtocolSwitchResult

Field Summary

Fields inherited from class org.jdrupes.httpcodec.protocols.http.HttpDecoder

HTTP_VERSION, peerEncoder, protocolVersion, SP

Fields inherited from class org.jdrupes.httpcodec.protocols.http.HttpCodec

messageHeader

Fields inherited from interface org.jdrupes.httpcodec.Codec

EMPTY_IN

Constructor Summary

Constructors

Constructor	Description
HttpRequestDecoder()

Method Summary

Modifier and Type	Method	Description
HttpRequestDecoder.Result	decode(ByteBuffer in, Buffer out, boolean endOfInput)	Decodes the next chunk of data.
Class<HttpRequest>	decoding()	Returns the type of the messages decoded by this decoder.
protected HttpDecoder.BodyMode	headerReceived(HttpRequest message)	Informs the derived class that the header has been received completely.
protected HttpRequest	newMessage(String startLine)	Checks whether the first line of a message is a valid request.
protected HttpRequestDecoder.Result.Factory	resultFactory()	Returns the result factory for this codec.

Methods inherited from class org.jdrupes.httpcodec.protocols.http.HttpDecoder

header, isAwaitingMessage, isClosed, maxHeaderLength, messageComplete, setMaxHeaderLength, setPeerEncoder

Methods inherited from class org.jdrupes.httpcodec.protocols.http.HttpCodec

bodyCharset

Methods inherited from class java.lang.Object

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

Constructor Details

HttpRequestDecoder

public HttpRequestDecoder()

Method Details

resultFactory

protected HttpRequestDecoder.Result.Factory resultFactory()

Description copied from class: HttpDecoder

Returns the result factory for this codec.

Specified by:

resultFactory in class HttpDecoder<HttpRequest,HttpResponse>

Returns:

the factory

decoding

public Class<HttpRequest> decoding()

Description copied from interface: Decoder

Returns the type of the messages decoded by this decoder.

Returns:

the value

decode

public HttpRequestDecoder.Result decode(ByteBuffer in,
 Buffer out,
 boolean endOfInput)

Description copied from class: HttpDecoder

Decodes the next chunk of data.

Specified by:

decode in interface Decoder<HttpRequest,HttpResponse>

Overrides:

decode in class HttpDecoder<HttpRequest,HttpResponse>

Parameters:

in - holds the data to be decoded

out - gets the body data (if any) written to it

endOfInput - true if there is no input left beyond the data currently in the in buffer (indicates end of body or no body at all)

Returns:

the result

newMessage

protected HttpRequest newMessage(String startLine)
                          throws HttpProtocolException

Checks whether the first line of a message is a valid request.

If so, create a new request message object with basic information, else throw an exception.

Called by the base class when a first line is received.

Specified by:

newMessage in class HttpDecoder<HttpRequest,HttpResponse>

Parameters:

startLine - the first line

Returns:

the new HttpMessage object that is to hold the decoded data

Throws:

HttpProtocolException - if the line is not a correct request line

headerReceived

protected HttpDecoder.BodyMode headerReceived(HttpRequest message)
                                       throws HttpProtocolException

Description copied from class: HttpDecoder

Informs the derived class that the header has been received completely.

Specified by:

headerReceived in class HttpDecoder<HttpRequest,HttpResponse>

Parameters:

message - the message

Returns:

indication how the body will be transferred

Throws:

HttpProtocolException - if the input violates the HTTP