Package org.glassfish.grizzly.http2

Class Http2BaseFilter

java.lang.Object

org.glassfish.grizzly.filterchain.BaseFilter

org.glassfish.grizzly.http.HttpBaseFilter

org.glassfish.grizzly.http2.Http2BaseFilter

All Implemented Interfaces:

Filter

Direct Known Subclasses:

Http2ClientFilter, Http2ServerFilter

public abstract class Http2BaseFilter
extends HttpBaseFilter

The Filter serves as a bridge between HTTP2 frames and upper-level HTTP layers by converting Http2Frames into HttpPackets and passing them up/down by the FilterChain. Additionally this Filter has logic responsible for checking HTTP2 protocol semantics and fire correspondent events and messages in case when HTTP2 semantics is broken.

Author:

Grizzly team

Field Summary

Fields

Modifier and Type	Field	Description
protected static final TransferEncoding	FIXED_LENGTH_ENCODING
protected final ExecutorService	threadPool

Constructor Summary

Constructors

Constructor	Description
Http2BaseFilter(Http2Configuration configuration)	Constructs Http2HandlerFilter.

Method Summary

Modifier and Type	Method	Description
protected boolean	checkRequestHeadersOnUpgrade(HttpRequestPacket httpRequest)
protected boolean	checkResponseHeadersOnUpgrade(HttpResponsePacket httpResponse)
protected Http2Session	createHttp2Session(Connection connection, boolean isServer)	Creates Http2Session with pre-configured initial-windows-size and max-concurrent-streams
Http2Configuration	getConfiguration()
protected SettingsFrame	getHttp2UpgradeSettings(HttpRequestPacket httpRequest)
int	getLocalMaxFramePayloadSize()
NextAction	handleEvent(FilterChainContext ctx, FilterChainEvent event)	Handle custom event associated with the Connection.
NextAction	handleWrite(FilterChainContext ctx)	Execute a unit of processing work to be performed, when some data should be written on channel.
protected static boolean	ignoreFrameForStreamId(Http2Session session, int streamId)
protected boolean	isHttp2UpgradingVersion(HttpHeader httpHeader)
protected final Http2Session	obtainHttp2Session(FilterChainContext context, boolean isUpStream)	Obtain Http2Session associated with the Connection and prepare it for use.
protected void	onHttpContentEncoded(HttpContent content, FilterChainContext ctx)
protected void	onHttpContentError(HttpHeader httpHeader, FilterChainContext ctx, Throwable t)
protected void	onHttpContentParsed(HttpContent content, FilterChainContext ctx)
protected void	onHttpHeaderError(HttpHeader httpHeader, FilterChainContext ctx, Throwable t)
protected boolean	onHttpHeaderParsed(HttpHeader httpHeader, Buffer buffer, FilterChainContext ctx)
protected void	onHttpHeadersEncoded(HttpHeader httpHeader, FilterChainContext ctx)
protected void	onHttpHeadersParsed(HttpHeader httpHeader, FilterChainContext ctx)
protected boolean	onHttpPacketParsed(HttpHeader httpHeader, FilterChainContext ctx)
protected void	onInitialLineEncoded(HttpHeader httpHeader, FilterChainContext ctx)
protected void	onInitialLineParsed(HttpHeader httpHeader, FilterChainContext ctx)
protected void	onPrefaceReceived(Http2Session http2Session)
protected void	prepareOutgoingRequest(HttpRequestPacket request)
protected abstract void	processCompleteHeader(Http2Session http2Session, FilterChainContext context, HeaderBlockHead firstHeaderFrame)	The method is called once complete HTTP header block arrives on Http2Session.
protected boolean	processFrames(FilterChainContext ctx, Http2Session http2Session, List<Http2Frame> framesList)
protected abstract void	processOutgoingHttpHeader(FilterChainContext ctx, Http2Session http2Session, HttpHeader httpHeader, HttpPacket entireHttpPacket)
void	setLocalMaxFramePayloadSize(int localMaxFramePayloadSize)	Sets the maximum allowed HTTP2 frame size.

Methods inherited from class org.glassfish.grizzly.http.HttpBaseFilter

bind

Methods inherited from class org.glassfish.grizzly.filterchain.BaseFilter

createContext, exceptionOccurred, handleAccept, handleClose, handleConnect, handleRead, onAdded, onFilterChainChanged, onRemoved, toString

Methods inherited from class java.lang.Object

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

Field Details

FIXED_LENGTH_ENCODING

protected static final TransferEncoding FIXED_LENGTH_ENCODING

threadPool

protected final ExecutorService threadPool

Constructor Details

Http2BaseFilter

public Http2BaseFilter(Http2Configuration configuration)

Constructs Http2HandlerFilter.

Method Details

getLocalMaxFramePayloadSize

public int getLocalMaxFramePayloadSize()

Returns:

the maximum allowed HTTP2 frame payload size

setLocalMaxFramePayloadSize

public void setLocalMaxFramePayloadSize(int localMaxFramePayloadSize)

Sets the maximum allowed HTTP2 frame size.

Parameters:

localMaxFramePayloadSize - the maximum allowed HTTP2 frame size

getConfiguration

public Http2Configuration getConfiguration()

Returns:

the Http2Configuration backing this filter.

processFrames

protected boolean processFrames(FilterChainContext ctx,
 Http2Session http2Session,
 List<Http2Frame> framesList)

checkRequestHeadersOnUpgrade

protected boolean checkRequestHeadersOnUpgrade(HttpRequestPacket httpRequest)

checkResponseHeadersOnUpgrade

protected boolean checkResponseHeadersOnUpgrade(HttpResponsePacket httpResponse)

getHttp2UpgradeSettings

protected SettingsFrame getHttp2UpgradeSettings(HttpRequestPacket httpRequest)

isHttp2UpgradingVersion

protected boolean isHttp2UpgradingVersion(HttpHeader httpHeader)

onHttpPacketParsed

protected boolean onHttpPacketParsed(HttpHeader httpHeader,
 FilterChainContext ctx)

onHttpHeaderParsed

protected boolean onHttpHeaderParsed(HttpHeader httpHeader,
 Buffer buffer,
 FilterChainContext ctx)

onInitialLineParsed

protected void onInitialLineParsed(HttpHeader httpHeader,
 FilterChainContext ctx)

onInitialLineEncoded

protected void onInitialLineEncoded(HttpHeader httpHeader,
 FilterChainContext ctx)

onHttpHeadersParsed

protected void onHttpHeadersParsed(HttpHeader httpHeader,
 FilterChainContext ctx)

onHttpHeadersEncoded

protected void onHttpHeadersEncoded(HttpHeader httpHeader,
 FilterChainContext ctx)

onHttpContentParsed

protected void onHttpContentParsed(HttpContent content,
 FilterChainContext ctx)

onHttpContentEncoded

protected void onHttpContentEncoded(HttpContent content,
 FilterChainContext ctx)

onHttpHeaderError

protected void onHttpHeaderError(HttpHeader httpHeader,
 FilterChainContext ctx,
 Throwable t)
                          throws IOException

Throws:

IOException

onHttpContentError

protected void onHttpContentError(HttpHeader httpHeader,
 FilterChainContext ctx,
 Throwable t)
                           throws IOException

Throws:

IOException

processCompleteHeader

protected abstract void processCompleteHeader(Http2Session http2Session,
 FilterChainContext context,
 HeaderBlockHead firstHeaderFrame)
                                       throws IOException

The method is called once complete HTTP header block arrives on Http2Session.

Parameters:

http2Session - the Http2Session associated with this header.

context - the current FilterChainContext

firstHeaderFrame - the first HeaderBlockHead from the first HeadersFrame received.

Throws:

IOException - if an error occurs when dealing with the event.

handleWrite

public NextAction handleWrite(FilterChainContext ctx)
                       throws IOException

Description copied from class: BaseFilter

Execute a unit of processing work to be performed, when some data should be written on channel. This Filter may either complete the required processing and return false, or delegate remaining processing to the next Filter in a FilterChain containing this Filter by returning true.

Specified by:

handleWrite in interface Filter

Overrides:

handleWrite in class BaseFilter

Parameters:

ctx - FilterChainContext

Returns:

NextAction instruction for FilterChain, how it should continue the execution

Throws:

IOException

processOutgoingHttpHeader

protected abstract void processOutgoingHttpHeader(FilterChainContext ctx,
 Http2Session http2Session,
 HttpHeader httpHeader,
 HttpPacket entireHttpPacket)
                                           throws IOException

Throws:

IOException

prepareOutgoingRequest

protected void prepareOutgoingRequest(HttpRequestPacket request)

handleEvent

public NextAction handleEvent(FilterChainContext ctx,
 FilterChainEvent event)
                       throws IOException

Description copied from class: BaseFilter

Handle custom event associated with the Connection. This Filter may either complete the required processing and return StopAction, or delegate remaining processing to the next Filter in a FilterChain containing this Filter by returning InvokeAction.

Specified by:

handleEvent in interface Filter

Overrides:

handleEvent in class BaseFilter

Parameters:

ctx - FilterChainContext

Returns:

NextAction instruction for FilterChain, how it should continue the execution

Throws:

IOException

createHttp2Session

protected Http2Session createHttp2Session(Connection connection,
 boolean isServer)

Creates Http2Session with pre-configured initial-windows-size and max-concurrent-streams

Parameters:

connection - the TCP Connection

isServer - flag indicating whether this connection is server side or not.

Returns:

Http2Session

onPrefaceReceived

protected void onPrefaceReceived(Http2Session http2Session)

obtainHttp2Session

protected final Http2Session obtainHttp2Session(FilterChainContext context,
 boolean isUpStream)

Obtain Http2Session associated with the Connection and prepare it for use.

Parameters:

context - FilterChainContext

isUpStream - true if the FilterChainContext represents upstream FilterChain execution, or false otherwise

Returns:

Http2Session associated with the Connection and prepare it for use

ignoreFrameForStreamId

protected static boolean ignoreFrameForStreamId(Http2Session session,
 int streamId)