public abstract class HttpCodecFilter extends HttpBaseFilter implements MonitoringAware<HttpProbe>
Filter
, responsible for transforming Buffer
into
HttpPacket
and vice versa in asynchronous mode.
When the HttpCodecFilter is added to a FilterChain
, on read phase
it consumes incoming Buffer
and provides HttpContent
as
the result of transformation. On write phase the HttpCodecFilter consumes
input HttpPacket
and serializes it to a Buffer
, which
gets passed farther as the result of transformation.
So transformations, provided by this filter are following:
(read phase): Buffer
-> HttpContent
(write phase): HttpPacket
-> Buffer
.HttpServerFilter
,
HttpClientFilter
Modifier and Type | Class and Description |
---|---|
static class |
HttpCodecFilter.ContentParsingState |
static class |
HttpCodecFilter.HeaderParsingState |
Modifier and Type | Field and Description |
---|---|
protected boolean |
chunkingEnabled |
protected ArraySet<ContentEncoding> |
contentEncodings |
static int |
DEFAULT_MAX_HTTP_PACKET_HEADER_SIZE |
protected int |
maxHeadersSize |
protected long |
maxPayloadRemainderToSkip
The maximum request payload remainder (in bytes) HttpServerFilter will try
to swallow after HTTP request processing is over in order to keep the
connection alive.
|
protected DefaultMonitoringConfig<HttpProbe> |
monitoringConfig
File cache probes
|
Constructor and Description |
---|
HttpCodecFilter(boolean chunkingEnabled,
int maxHeadersSize)
Constructor, which creates HttpCodecFilter instance, with the specific
max header size parameter.
|
Modifier and Type | Method and Description |
---|---|
void |
addContentEncoding(ContentEncoding contentEncoding)
Adds the specified
ContentEncoding to the HttpCodecFilter . |
void |
addTransferEncoding(TransferEncoding transferEncoding)
Adds the specified
TransferEncoding to the HttpCodecFilter . |
protected Object |
createJmxManagementObject() |
protected boolean |
decodeHttpPacket(FilterChainContext ctx,
HttpPacketParsing httpPacket,
Buffer input) |
protected boolean |
decodeHttpPacketFromBuffer(FilterChainContext ctx,
HttpPacketParsing httpPacket,
Buffer input) |
protected boolean |
decodeHttpPacketFromBytes(FilterChainContext ctx,
HttpPacketParsing httpPacket,
Buffer inputBuffer) |
protected Buffer |
encodeHttpPacket(FilterChainContext ctx,
HttpHeader httpHeader,
HttpContent httpContent,
boolean isContentAlreadyEncoded) |
protected Buffer |
encodeHttpPacket(FilterChainContext ctx,
HttpPacket input) |
protected static Buffer |
encodeKnownHeaders(MemoryManager memoryManager,
Buffer buffer,
HttpHeader httpHeader) |
protected static Buffer |
encodeMimeHeader(MemoryManager memoryManager,
Buffer buffer,
DataChunk name,
DataChunk value,
byte[] tempBuffer,
boolean encodeLastCRLF) |
protected static Buffer |
encodeMimeHeaders(MemoryManager memoryManager,
Buffer buffer,
MimeHeaders mimeHeaders,
byte[] tempEncodingBuffer) |
ContentEncoding[] |
getContentEncodings()
Gets registered
ContentEncoding s. |
long |
getMaxPayloadRemainderToSkip() |
MonitoringConfig<HttpProbe> |
getMonitoringConfig()
Return the object associated
MonitoringConfig . |
TransferEncoding[] |
getTransferEncodings()
Gets registered
TransferEncoding s. |
NextAction |
handleRead(FilterChainContext ctx,
HttpPacketParsing httpPacket)
The method is called by the specific HttpCodecFilter implementation,
once we have received a
Buffer , which has to be transformed
into HTTP packet part. |
NextAction |
handleWrite(FilterChainContext ctx)
The method is called, once we need to serialize a
HttpPacket ,
which may represent HTTP packet header, content or content chunk. |
protected boolean |
isChunkingEnabled()
Return
true if chunked transfer-encoding may be used. |
protected static boolean |
isSecure(Connection connection)
flag, which indicates whether this HttpCodecFilter is dealing with
the secured HTTP packets.
|
protected abstract void |
onHttpContentEncoded(HttpContent content,
FilterChainContext ctx)
Invoked when a HTTP body chunk has been encoded in preparation to being
transmitted to the user-agent.
|
protected abstract void |
onHttpContentError(HttpHeader httpHeader,
FilterChainContext ctx,
Throwable t)
Callback which is invoked when parsing an HTTP message payload fails.
|
protected abstract void |
onHttpContentParsed(HttpContent content,
FilterChainContext ctx)
Invoked as request/response body content has been processed by this
Filter . |
protected abstract void |
onHttpHeaderError(HttpHeader httpHeader,
FilterChainContext ctx,
Throwable t)
Callback which is invoked when parsing an HTTP message header fails.
|
protected abstract boolean |
onHttpHeaderParsed(HttpHeader httpHeader,
Buffer buffer,
FilterChainContext ctx)
Callback invoked when the HTTP message header parsing is complete.
|
protected abstract void |
onHttpHeadersEncoded(HttpHeader httpHeader,
FilterChainContext ctx)
Invoked when HTTP headers have been encoded in preparation to being
transmitted to the user-agent.
|
protected abstract void |
onHttpHeadersParsed(HttpHeader httpHeader,
FilterChainContext ctx)
Invoked when all headers of the packet have been parsed.
|
protected abstract boolean |
onHttpPacketParsed(HttpHeader httpHeader,
FilterChainContext ctx)
Callback method, called when
HttpPacket parsing has been completed. |
protected void |
onIncomingUpgrade(FilterChainContext ctx,
HttpHeader httpHeader)
The method is called, when a peer sends an upgrade HTTP packet
(either request or response).
|
protected abstract void |
onInitialLineEncoded(HttpHeader httpHeader,
FilterChainContext ctx)
Invoked when the intial response line has been encoded in preparation
to being transmitted to the user-agent.
|
protected abstract void |
onInitialLineParsed(HttpHeader httpHeader,
FilterChainContext ctx)
Invoked when either the request line or status line has been parsed.
|
protected void |
onOutgoingUpgrade(FilterChainContext ctx,
HttpHeader httpHeader) |
protected static boolean |
parseHeaderFromBuffer(HttpHeader httpHeader,
MimeHeaders mimeHeaders,
HttpCodecFilter.HeaderParsingState parsingState,
Buffer input) |
protected static boolean |
parseHeaderFromBytes(HttpHeader httpHeader,
MimeHeaders mimeHeaders,
HttpCodecFilter.HeaderParsingState parsingState,
byte[] input,
int end) |
protected static boolean |
parseHeaderName(HttpHeader httpHeader,
MimeHeaders mimeHeaders,
HttpCodecFilter.HeaderParsingState parsingState,
Buffer input) |
protected static boolean |
parseHeaderName(HttpHeader httpHeader,
MimeHeaders mimeHeaders,
HttpCodecFilter.HeaderParsingState parsingState,
byte[] input,
int end) |
protected boolean |
parseHeadersFromBuffer(HttpHeader httpHeader,
MimeHeaders mimeHeaders,
HttpCodecFilter.HeaderParsingState parsingState,
Buffer input) |
protected boolean |
parseHeadersFromBytes(HttpHeader httpHeader,
MimeHeaders mimeHeaders,
HttpCodecFilter.HeaderParsingState parsingState,
byte[] input,
int end) |
protected static int |
parseHeaderValue(HttpHeader httpHeader,
HttpCodecFilter.HeaderParsingState parsingState,
Buffer input) |
protected static int |
parseHeaderValue(HttpHeader httpHeader,
HttpCodecFilter.HeaderParsingState parsingState,
byte[] input,
int end) |
boolean |
removeContentEncoding(ContentEncoding contentEncoding)
Removes the specified
ContentEncoding from the HttpCodecFilter . |
boolean |
removeTransferEncoding(TransferEncoding transferEncoding)
Removes the specified
TransferEncoding from the HttpCodecFilter . |
void |
setMaxPayloadRemainderToSkip(long maxPayloadRemainderToSkip)
Set the maximum request payload remainder (in bytes) HttpServerFilter
will try to swallow after HTTP request processing is over in order to
keep the connection alive.
|
bind
createContext, exceptionOccurred, handleAccept, handleClose, handleConnect, handleEvent, handleRead, onAdded, onFilterChainChanged, onRemoved
public static final int DEFAULT_MAX_HTTP_PACKET_HEADER_SIZE
protected final ArraySet<ContentEncoding> contentEncodings
protected final boolean chunkingEnabled
protected long maxPayloadRemainderToSkip
protected final DefaultMonitoringConfig<HttpProbe> monitoringConfig
protected final int maxHeadersSize
public HttpCodecFilter(boolean chunkingEnabled, int maxHeadersSize)
chunkingEnabled
- true
if the chunked transfer encoding
should be used when no explicit content length has been set.maxHeadersSize
- the maximum size of the HTTP message header.protected abstract boolean onHttpPacketParsed(HttpHeader httpHeader, FilterChainContext ctx)
HttpPacket
parsing has been completed.httpHeader
- HttpHeader
, which represents parsed HTTP packet headerctx
- processing context.true
if an error has occurred while processing
the header portion of the HTTP request, otherwise returns
false
.sprotected abstract boolean onHttpHeaderParsed(HttpHeader httpHeader, Buffer buffer, FilterChainContext ctx)
httpHeader
- HttpHeader
, which represents parsed HTTP packet headerbuffer
- Buffer
the header was parsed fromctx
- processing context.true
if an error has occurred while processing
the header portion of the HTTP request, otherwise returns
false
.protected abstract void onInitialLineParsed(HttpHeader httpHeader, FilterChainContext ctx)
Invoked when either the request line or status line has been parsed.
httpHeader
- HttpHeader
, which represents HTTP packet headerctx
- processing context.protected abstract void onInitialLineEncoded(HttpHeader httpHeader, FilterChainContext ctx)
Invoked when the intial response line has been encoded in preparation to being transmitted to the user-agent.
httpHeader
- HttpHeader
, which represents HTTP packet headerctx
- processing context.protected abstract void onHttpHeadersParsed(HttpHeader httpHeader, FilterChainContext ctx)
Invoked when all headers of the packet have been parsed. Depending on the transfer encoding being used by the current request, this method may be invoked multiple times.
httpHeader
- HttpHeader
, which represents HTTP packet headerctx
- processing context.protected abstract void onHttpHeadersEncoded(HttpHeader httpHeader, FilterChainContext ctx)
Invoked when HTTP headers have been encoded in preparation to being transmitted to the user-agent.
httpHeader
- HttpHeader
, which represents HTTP packet headerctx
- processing context.protected abstract void onHttpContentParsed(HttpContent content, FilterChainContext ctx)
Invoked as request/response body content has been processed by this
Filter
.
content
- request/response body contentctx
- processing context.protected abstract void onHttpContentEncoded(HttpContent content, FilterChainContext ctx)
Invoked when a HTTP body chunk has been encoded in preparation to being transmitted to the user-agent.
content
- HttpContent
, which represents HTTP packet headerctx
- processing context.protected abstract void onHttpHeaderError(HttpHeader httpHeader, FilterChainContext ctx, Throwable t) throws IOException
Callback which is invoked when parsing an HTTP message header fails. The processing logic has to take care about error handling and following connection closing.
httpHeader
- HttpHeader
, which represents HTTP packet headerctx
- the FilterChainContext
processing this requestt
- the cause of the errorIOException
protected abstract void onHttpContentError(HttpHeader httpHeader, FilterChainContext ctx, Throwable t) throws IOException
Callback which is invoked when parsing an HTTP message payload fails. The processing logic has to take care about error handling and following connection closing.
httpHeader
- HttpHeader
, which represents HTTP packet headerctx
- the FilterChainContext
processing this requestt
- the cause of the errorIOException
public long getMaxPayloadRemainderToSkip()
public void setMaxPayloadRemainderToSkip(long maxPayloadRemainderToSkip)
maxPayloadRemainderToSkip
- public TransferEncoding[] getTransferEncodings()
Gets registered TransferEncoding
s.
TransferEncoding
s.public void addTransferEncoding(TransferEncoding transferEncoding)
Adds the specified TransferEncoding
to the HttpCodecFilter
.
transferEncoding
- the TransferEncoding
to addpublic boolean removeTransferEncoding(TransferEncoding transferEncoding)
Removes the specified TransferEncoding
from the HttpCodecFilter
.
transferEncoding
- the TransferEncoding
to removetrue
if the TransferEncoding
was removed, otherwise
false
indicating the TransferEncoding
was not already
presentpublic ContentEncoding[] getContentEncodings()
Gets registered ContentEncoding
s.
ContentEncoding
s.public void addContentEncoding(ContentEncoding contentEncoding)
Adds the specified ContentEncoding
to the HttpCodecFilter
.
contentEncoding
- the ContentEncoding
to addpublic boolean removeContentEncoding(ContentEncoding contentEncoding)
Removes the specified ContentEncoding
from the HttpCodecFilter
.
contentEncoding
- the ContentEncoding
to removetrue
if the ContentEncoding
was removed, otherwise
false
indicating the ContentEncoding
was not already
presentprotected boolean isChunkingEnabled()
true
if chunked transfer-encoding may be used.true
if chunked transfer-encoding may be used.public final NextAction handleRead(FilterChainContext ctx, HttpPacketParsing httpPacket) throws IOException
Buffer
, which has to be transformed
into HTTP packet part.
Filter gets Buffer
, which represents a part or complete HTTP
message. As the result of "read" transformation - we will get
HttpContent
message, which will represent HTTP packet content
(might be zero length content) and reference to a HttpHeader
,
which contains HTTP message header.ctx
- Request processing contexthttpPacket
- the current HttpPacket, which is being processed.NextAction
IOException
protected boolean decodeHttpPacket(FilterChainContext ctx, HttpPacketParsing httpPacket, Buffer input)
protected boolean decodeHttpPacketFromBytes(FilterChainContext ctx, HttpPacketParsing httpPacket, Buffer inputBuffer)
protected boolean parseHeadersFromBytes(HttpHeader httpHeader, MimeHeaders mimeHeaders, HttpCodecFilter.HeaderParsingState parsingState, byte[] input, int end)
protected static boolean parseHeaderFromBytes(HttpHeader httpHeader, MimeHeaders mimeHeaders, HttpCodecFilter.HeaderParsingState parsingState, byte[] input, int end)
protected static boolean parseHeaderName(HttpHeader httpHeader, MimeHeaders mimeHeaders, HttpCodecFilter.HeaderParsingState parsingState, byte[] input, int end)
protected static int parseHeaderValue(HttpHeader httpHeader, HttpCodecFilter.HeaderParsingState parsingState, byte[] input, int end)
protected boolean decodeHttpPacketFromBuffer(FilterChainContext ctx, HttpPacketParsing httpPacket, Buffer input)
protected boolean parseHeadersFromBuffer(HttpHeader httpHeader, MimeHeaders mimeHeaders, HttpCodecFilter.HeaderParsingState parsingState, Buffer input)
protected static boolean parseHeaderFromBuffer(HttpHeader httpHeader, MimeHeaders mimeHeaders, HttpCodecFilter.HeaderParsingState parsingState, Buffer input)
protected static boolean parseHeaderName(HttpHeader httpHeader, MimeHeaders mimeHeaders, HttpCodecFilter.HeaderParsingState parsingState, Buffer input)
protected static int parseHeaderValue(HttpHeader httpHeader, HttpCodecFilter.HeaderParsingState parsingState, Buffer input)
public NextAction handleWrite(FilterChainContext ctx) throws IOException
HttpPacket
,
which may represent HTTP packet header, content or content chunk.
Filter gets HttpPacket
, which represents a HTTP header, content,
or content part. As the result of "write" transformation - we will get
Buffer
, which will represent serialized HTTP packet.handleWrite
in interface Filter
handleWrite
in class BaseFilter
ctx
- Request processing contextNextAction
IOException
protected void onIncomingUpgrade(FilterChainContext ctx, HttpHeader httpHeader)
ctx
- httpHeader
- protected void onOutgoingUpgrade(FilterChainContext ctx, HttpHeader httpHeader)
protected Buffer encodeHttpPacket(FilterChainContext ctx, HttpPacket input)
protected final Buffer encodeHttpPacket(FilterChainContext ctx, HttpHeader httpHeader, HttpContent httpContent, boolean isContentAlreadyEncoded)
protected static Buffer encodeKnownHeaders(MemoryManager memoryManager, Buffer buffer, HttpHeader httpHeader)
protected static Buffer encodeMimeHeaders(MemoryManager memoryManager, Buffer buffer, MimeHeaders mimeHeaders, byte[] tempEncodingBuffer)
protected static Buffer encodeMimeHeader(MemoryManager memoryManager, Buffer buffer, DataChunk name, DataChunk value, byte[] tempBuffer, boolean encodeLastCRLF)
protected static boolean isSecure(Connection connection)
HttpRequestPacket
or
HttpResponsePacket
.connection
- Connection
Connection
is secured, or false
otherwisepublic MonitoringConfig<HttpProbe> getMonitoringConfig()
MonitoringConfig
.getMonitoringConfig
in interface MonitoringAware<HttpProbe>
MonitoringConfig
.protected Object createJmxManagementObject()
Copyright © 2015 Oracle Corporation. All rights reserved.