Package org.glassfish.grizzly.http2

Class Http2ClientFilter

java.lang.Object

org.glassfish.grizzly.filterchain.BaseFilter

org.glassfish.grizzly.http.HttpBaseFilter

org.glassfish.grizzly.http2.Http2BaseFilter

org.glassfish.grizzly.http2.Http2ClientFilter

All Implemented Interfaces:

Filter

public class Http2ClientFilter
extends Http2BaseFilter

Author:

oleksiys

Field Summary

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

FIXED_LENGTH_ENCODING, threadPool

Constructor Summary

Constructors

Constructor	Description
Http2ClientFilter(Http2Configuration configuration)

Method Summary

Modifier and Type	Method	Description
protected Http2Session	createClientHttp2Session(Connection connection)	Creates client-side Http2Session with pre-configured initial-windows-size and max-concurrent-streams.
protected AlpnClientNegotiator	getClientAlpnNegotiator()
NextAction	handleConnect(FilterChainContext ctx)	Execute a unit of processing work to be performed, when channel gets connected.
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.
NextAction	handleWrite(FilterChainContext ctx)	Execute a unit of processing work to be performed, when some data should be written on channel.
boolean	isNeverForceUpgrade()
boolean	isSendPushRequestUpstream()
protected SettingsFrame.SettingsFrameBuilder	prepareSettings(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)	Process the provided outbound header/packet.
void	setNeverForceUpgrade(boolean neverForceUpgrade)	Configure this filter to completely disable attempts to upgrade to HTTP/2.
void	setSendPushRequestUpstream(boolean sendPushRequestUpstream)

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

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

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

bind

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

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

Methods inherited from class java.lang.Object

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

Constructor Details

Http2ClientFilter

public Http2ClientFilter(Http2Configuration configuration)

Method Details

isNeverForceUpgrade

public boolean isNeverForceUpgrade()

Returns:

true if an upgrade to HTTP/2 will not be performed, otherwise false

setNeverForceUpgrade

public void setNeverForceUpgrade(boolean neverForceUpgrade)

Configure this filter to completely disable attempts to upgrade to HTTP/2.

Parameters:

neverForceUpgrade - true to disable upgrade attempts, otherwise false

isSendPushRequestUpstream

public boolean isSendPushRequestUpstream()

Returns:

true if the push request has to be sent upstream, so a user have a chance to process it, or false otherwise

setSendPushRequestUpstream

public void setSendPushRequestUpstream(boolean sendPushRequestUpstream)

Parameters:

sendPushRequestUpstream - true if the push request has to be sent upstream, so a user have a chance to process it, or false otherwise

handleConnect

public NextAction handleConnect(FilterChainContext ctx)
                         throws IOException

Description copied from class: BaseFilter

Execute a unit of processing work to be performed, when channel gets connected. 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:

handleConnect in interface Filter

Overrides:

handleConnect 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

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 Http2BaseFilter

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

processOutgoingHttpHeader

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

Process the provided outbound header/packet.

Specified by:

processOutgoingHttpHeader in class Http2BaseFilter

Parameters:

ctx - the current FilterChainContext

http2Session - the Http2Session that's being written to.

httpHeader - the HttpHeader to write.

entireHttpPacket - the HttpPacket to write.

Throws:

IOException - if an I/O error occurs.

createClientHttp2Session

protected Http2Session createClientHttp2Session(Connection connection)

Creates client-side Http2Session with pre-configured initial-windows-size and max-concurrent-streams. Note: Should be called with disabled OP_READ (or during OP_READ processing), because peer frames must not be processed at the time this method is running.

Parameters:

connection - the TCP connection

Returns:

Http2Session

getClientAlpnNegotiator

protected AlpnClientNegotiator getClientAlpnNegotiator()

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.

prepareSettings

protected SettingsFrame.SettingsFrameBuilder prepareSettings(Http2Session http2Session)