Package org.glassfish.grizzly.http2

Class Http2ServerFilter

java.lang.Object

org.glassfish.grizzly.filterchain.BaseFilter

org.glassfish.grizzly.http.HttpBaseFilter

org.glassfish.grizzly.http2.Http2BaseFilter

org.glassfish.grizzly.http2.Http2ServerFilter

All Implemented Interfaces:

Filter

public class Http2ServerFilter
extends Http2BaseFilter

Author:

oleksiys

Field Summary

Fields inherited from class org.glassfish.grizzly.http2.Http2BaseFilter

FIXED_LENGTH_ENCODING, threadPool

Constructor Summary

Constructors

Constructor	Description
Http2ServerFilter(Http2Configuration configuration)	Create a new Http2ServerFilter using the specified Http2Configuration.

Method Summary

Modifier and Type	Method	Description
NextAction	handleAccept(FilterChainContext ctx)	Execute a unit of processing work to be performed, when server channel has accepted the client connection.
NextAction	handleClose(FilterChainContext ctx)	Execute a unit of processing work to be performed, when connection has been closed.
NextAction	handleEvent(FilterChainContext ctx, FilterChainEvent event)	Handle custom event associated with the Connection.
NextAction	handleRead(FilterChainContext ctx)	Execute a unit of processing work to be performed, when channel will become available for reading.
boolean	isAllowPayloadForUndefinedHttpMethods()	The flag, which enables/disables payload support for HTTP methods, for which HTTP spec doesn't clearly state whether they support payload.
protected void	onHttpHeadersParsed(HttpHeader httpHeader, FilterChainContext ctx)
protected void	onPrefaceReceived(Http2Session http2Session)
protected void	processCompleteHeader(Http2Session http2Session, FilterChainContext context, HeaderBlockHead firstHeaderFrame)	The method is called once complete HTTP header block arrives on Http2Session.
protected void	processOutgoingHttpHeader(FilterChainContext ctx, Http2Session http2Session, HttpHeader httpHeader, HttpPacket entireHttpPacket)
void	setAllowPayloadForUndefinedHttpMethods(boolean allowPayloadForUndefinedHttpMethods)	The flag, which enables/disables payload support for HTTP methods, for which HTTP spec doesn't clearly state whether they support payload.

Methods inherited from class org.glassfish.grizzly.http2.Http2BaseFilter

checkRequestHeadersOnUpgrade, checkResponseHeadersOnUpgrade, createHttp2Session, getConfiguration, getHttp2UpgradeSettings, getLocalMaxFramePayloadSize, handleWrite, ignoreFrameForStreamId, isHttp2UpgradingVersion, obtainHttp2Session, onHttpContentEncoded, onHttpContentError, onHttpContentParsed, onHttpHeaderError, onHttpHeaderParsed, onHttpHeadersEncoded, onHttpPacketParsed, onInitialLineEncoded, onInitialLineParsed, prepareOutgoingRequest, processFrames, setLocalMaxFramePayloadSize

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

bind

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

createContext, exceptionOccurred, handleConnect, onAdded, onFilterChainChanged, onRemoved, toString

Methods inherited from class java.lang.Object

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

Constructor Details

Http2ServerFilter

public Http2ServerFilter(Http2Configuration configuration)

Create a new Http2ServerFilter using the specified Http2Configuration. Configuration may be changed post-construction by calling Http2BaseFilter.getConfiguration().

Method Details

isAllowPayloadForUndefinedHttpMethods

public boolean isAllowPayloadForUndefinedHttpMethods()

The flag, which enables/disables payload support for HTTP methods, for which HTTP spec doesn't clearly state whether they support payload.

Known "undefined" methods are: GET, HEAD, DELETE.

Returns:

true if "undefined" methods support payload, or false otherwise

setAllowPayloadForUndefinedHttpMethods

public void setAllowPayloadForUndefinedHttpMethods(boolean allowPayloadForUndefinedHttpMethods)

The flag, which enables/disables payload support for HTTP methods, for which HTTP spec doesn't clearly state whether they support payload.

Known "undefined" methods are: GET, HEAD, DELETE.

Parameters:

allowPayloadForUndefinedHttpMethods - true if "undefined" methods support payload, or false otherwise

handleAccept

public NextAction handleAccept(FilterChainContext ctx)
                        throws IOException

Description copied from class: BaseFilter

Execute a unit of processing work to be performed, when server channel has accepted the client connection. 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:

handleAccept in interface Filter

Overrides:

handleAccept in class BaseFilter

Parameters:

ctx - FilterChainContext

Returns:

NextAction instruction for FilterChain, how it should continue the execution

Throws:

IOException

handleClose

public NextAction handleClose(FilterChainContext ctx)
                       throws IOException

Description copied from class: BaseFilter

Execute a unit of processing work to be performed, when connection has been closed. 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:

handleClose in interface Filter

Overrides:

handleClose in class BaseFilter

Parameters:

ctx - FilterChainContext

Returns:

NextAction instruction for FilterChain, how it should continue the execution

Throws:

IOException

handleRead

public NextAction handleRead(FilterChainContext ctx)
                      throws IOException

Description copied from class: BaseFilter

Execute a unit of processing work to be performed, when channel will become available for reading. 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:

handleRead in interface Filter

Overrides:

handleRead in class BaseFilter

Parameters:

ctx - FilterChainContext

Returns:

NextAction instruction for FilterChain, how it should continue the execution

Throws:

IOException

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 Http2BaseFilter

Parameters:

ctx - FilterChainContext

Returns:

NextAction instruction for FilterChain, how it should continue the execution

Throws:

IOException

onPrefaceReceived

protected void onPrefaceReceived(Http2Session http2Session)

Overrides:

onPrefaceReceived in class Http2BaseFilter

processCompleteHeader

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

Description copied from class: Http2BaseFilter

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

Specified by:

processCompleteHeader in class Http2BaseFilter

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.

onHttpHeadersParsed

protected void onHttpHeadersParsed(HttpHeader httpHeader,
 FilterChainContext ctx)

Overrides:

onHttpHeadersParsed in class Http2BaseFilter

processOutgoingHttpHeader

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

Specified by:

processOutgoingHttpHeader in class Http2BaseFilter

Parameters:

ctx - the current FilterChainContext

http2Session - the Http2Session associated with this HttpHeader

httpHeader - the out-going HttpHeader

entireHttpPacket - the complete HttpPacket

Throws:

IOException - if an error occurs sending the packet