Modifier and Type	Class and Description
public static class	Http2Configuration.Http2ConfigurationBuilder

Modifier and Type	Field and Description
private volatile int	cleanFrequencyCheck
private volatile float	cleanPercentage
public static final int	DEFAULT_CLEAN_FREQUENCY_CHECK
public static final int	DEFAULT_MAX_HEADER_LIST_SIZE
public static final float	DEFAULT_STREAMS_CLEAN_PERCENTAGE
public static final float	DEFAULT_STREAMS_HIGH_WATER_MARK
private volatile boolean	disableCipherCheck
private final ExecutorService	executorService
private volatile int	initialWindowSize
private volatile int	maxConcurrentStreams
private volatile int	maxFramePayloadSize
private volatile int	maxHeaderListSize
private volatile boolean	priorKnowledge
private volatile boolean	pushEnabled
private volatile float	streamsHighWaterMark
private final ThreadPoolConfig	threadPoolConfig

Access	Constructor and Description
private	Http2Configuration(final Http2Configuration.Http2ConfigurationBuilder builder)

Method Summary

Modifier and Type	Method and Description
public static Http2Configuration.Http2ConfigurationBuilder	builder() Returns: a new `Http2ConfigurationBuilder` instance.
public int	getCleanFrequencyCheck() Returns: how often, in terms of closed streams, the streams structure will be checked for cleaning.
public float	getCleanPercentage() Returns: the number of streams to attempt to remove from the streams structure.
public ExecutorService	getExecutorService() Returns: a pre-existing `ExecutorService`, if any.
public int	getInitialWindowSize() Returns: the default initial stream window size (in bytes) for new HTTP2 connections.
public int	getMaxConcurrentStreams() Returns: the default maximum number of concurrent streams allowed for one session.
public int	getMaxFramePayloadSize() Returns: the maximum allowed HTTP2 frame payload size.
public int	getMaxHeaderListSize() Returns: the maximum size, in bytes, of header list.
public float	getStreamsHighWaterMark() Returns: the high-water mark indicating streams old closed streams should be cleaned up.
public ThreadPoolConfig	getThreadPoolConfig() Returns: the thread pool configuration for servicing HTTP/2 streams, if any.
public boolean	isDisableCipherCheck() Returns: whether or not strict cipher suite checking against RFC 7540's blacklist is performed or not.
public boolean	isPriorKnowledge() Returns: `true` if this filter will bypass using the HTTP/1.1 upgrade mechanism and send the client preface immediately with the knowledge that the remote endpoint supports HTTP/2.
public boolean	isPushEnabled() Returns: `true` if push to be allowed by the server endpoint, otherwise `false`.
public void	setCleanFrequencyCheck(final int cleanFrequencyCheck) Set the number of streams that must be closed before checking if the number of streams exceeds the high-water mark.
public void	setCleanPercentage(final float cleanPercentage) The number of streams to attempt to remove from the streams structure.
public void	setDisableCipherCheck(final boolean pass `true` to disable the checking. disableCipherCheck) Allows the developer to disable strict cipher suite checking of the connection against RFC 7540's blacklist.
public void	setInitialWindowSize(final int initialWindowSize) Sets the default initial stream window size (in bytes) for new HTTP2 connections.
public void	setMaxConcurrentStreams(final int maxConcurrentStreams) Sets the default maximum number of concurrent streams allowed for one session.
public void	setMaxFramePayloadSize(final int maxFramePayloadSize) Sets the maximum allowed HTTP2 frame payload size.
public void	setMaxHeaderListSize(final int maxHeaderListSize) Set the maximum size, in bytes, of the header list.
public void	setPriorKnowledge(final boolean `true` if it's known that the server supports HTTP/2. By default no prior knowledge is assumed. priorKnowledge) Control how the HTTP/2 connection is established with the server.
public void	setPushEnabled(final boolean pushEnabled) Configure whether push should be allowed by the server endpoint.
public void	setStreamsHighWaterMark(final float streamsHighWaterMark) Streams are maintained and periodically cleaned when the stream count (open or otherwise) surpasses the the specified high-water mark.

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Field Detail

cleanFrequencyCheck	back to summary
private volatile int cleanFrequencyCheck

cleanPercentage	back to summary
private volatile float cleanPercentage

DEFAULT_CLEAN_FREQUENCY_CHECK	back to summary
public static final int DEFAULT_CLEAN_FREQUENCY_CHECK

DEFAULT_MAX_HEADER_LIST_SIZE	back to summary
public static final int DEFAULT_MAX_HEADER_LIST_SIZE

DEFAULT_STREAMS_CLEAN_PERCENTAGE	back to summary
public static final float DEFAULT_STREAMS_CLEAN_PERCENTAGE

DEFAULT_STREAMS_HIGH_WATER_MARK	back to summary
public static final float DEFAULT_STREAMS_HIGH_WATER_MARK

disableCipherCheck	back to summary
private volatile boolean disableCipherCheck

executorService	back to summary
private final ExecutorService executorService

initialWindowSize	back to summary
private volatile int initialWindowSize

maxConcurrentStreams	back to summary
private volatile int maxConcurrentStreams

maxFramePayloadSize	back to summary
private volatile int maxFramePayloadSize

maxHeaderListSize	back to summary
private volatile int maxHeaderListSize

priorKnowledge	back to summary
private volatile boolean priorKnowledge

pushEnabled	back to summary
private volatile boolean pushEnabled

streamsHighWaterMark	back to summary
private volatile float streamsHighWaterMark

threadPoolConfig	back to summary
private final ThreadPoolConfig threadPoolConfig

Http2Configuration	back to summary
private Http2Configuration(final Http2Configuration.Http2ConfigurationBuilder builder)

Method Detail

builder	back to summary
public static Http2Configuration.Http2ConfigurationBuilder builder() Returns:Http2Configuration.Http2ConfigurationBuilder a new `Http2ConfigurationBuilder` instance.

getCleanFrequencyCheck	back to summary
public int getCleanFrequencyCheck() Returns:int how often, in terms of closed streams, the streams structure will be checked for cleaning. If not explicitly configured, this returns 50

getCleanPercentage	back to summary
public float getCleanPercentage() Returns:float the number of streams to attempt to remove from the streams structure. Note that only closed streams will ultimately be removed. If not explicitly configured, this returns 0.5.

getExecutorService	back to summary
public ExecutorService getExecutorService() Returns:ExecutorService a pre-existing `ExecutorService`, if any.

getInitialWindowSize	back to summary
public int getInitialWindowSize() Returns:int the default initial stream window size (in bytes) for new HTTP2 connections.

getMaxConcurrentStreams	back to summary
public int getMaxConcurrentStreams() Returns:int the default maximum number of concurrent streams allowed for one session. Negative value means "unlimited".

getMaxFramePayloadSize	back to summary
public int getMaxFramePayloadSize() Returns:int the maximum allowed HTTP2 frame payload size.

getMaxHeaderListSize	back to summary
public int getMaxHeaderListSize() Returns:int the maximum size, in bytes, of header list. If not explicitly configured, the default of `DEFAULT_MAX_HEADER_LIST_SIZE` is used.

getStreamsHighWaterMark	back to summary
public float getStreamsHighWaterMark() Returns:float the high-water mark indicating streams old closed streams should be cleaned up. If not explicitly configured, this returns 0.5.

getThreadPoolConfig	back to summary
public ThreadPoolConfig getThreadPoolConfig() Returns:ThreadPoolConfig the thread pool configuration for servicing HTTP/2 streams, if any.

isDisableCipherCheck	back to summary
public boolean isDisableCipherCheck() Returns:boolean whether or not strict cipher suite checking against RFC 7540's blacklist is performed or not. If not explicitly configured, checking will be performed.

isPriorKnowledge	back to summary
public boolean isPriorKnowledge() Returns:boolean `true` if this filter will bypass using the HTTP/1.1 upgrade mechanism and send the client preface immediately with the knowledge that the remote endpoint supports HTTP/2.

isPushEnabled	back to summary
public boolean isPushEnabled() Returns:boolean `true` if push to be allowed by the server endpoint, otherwise `false`.

setCleanFrequencyCheck	back to summary
public void setCleanFrequencyCheck(final int cleanFrequencyCheck) Set the number of streams that must be closed before checking if the number of streams exceeds the high-water mark.

setCleanPercentage	back to summary
public void setCleanPercentage(final float cleanPercentage) The number of streams to attempt to remove from the streams structure. Note that only closed streams will ultimately be removed. This value is applied against the computed result for the streams high water mark. For example, if the max concurrent streams is 100 and the mark percentage is .5, then the high water mark for a clean attempt would be 50. The number of streams to process in the clean attempt, assuming the clean percentage is .5, would be 25.

setCleanPercentage

back to summary

public void setCleanPercentage(final float cleanPercentage)

The number of streams to attempt to remove from the streams structure. Note that only closed streams will ultimately be removed. This value is applied against the computed result for the streams high water mark. For example, if the max concurrent streams is 100 and the mark percentage is .5, then the high water mark for a clean attempt would be 50. The number of streams to process in the clean attempt, assuming the clean percentage is .5, would be 25.

setDisableCipherCheck back to summary

setDisableCipherCheck	back to summary
public void setDisableCipherCheck(final boolean disableCipherCheck) Allows the developer to disable strict cipher suite checking of the connection against RFC 7540's blacklist. Parameters disableCipherCheck:boolean pass `true` to disable the checking.

public void setDisableCipherCheck(final boolean disableCipherCheck)

Allows the developer to disable strict cipher suite checking of the connection against RFC 7540's blacklist.

Parameters

disableCipherCheck:boolean: pass true to disable the checking.

setInitialWindowSize	back to summary
public void setInitialWindowSize(final int initialWindowSize) Sets the default initial stream window size (in bytes) for new HTTP2 connections.

setMaxConcurrentStreams	back to summary
public void setMaxConcurrentStreams(final int maxConcurrentStreams) Sets the default maximum number of concurrent streams allowed for one session. Negative value means "unlimited".

setMaxFramePayloadSize	back to summary
public void setMaxFramePayloadSize(final int maxFramePayloadSize) Sets the maximum allowed HTTP2 frame payload size.

setMaxHeaderListSize	back to summary
public void setMaxHeaderListSize(final int maxHeaderListSize) Set the maximum size, in bytes, of the header list.

setPriorKnowledge back to summary

setPriorKnowledge	back to summary
public void setPriorKnowledge(final boolean priorKnowledge) Control how the HTTP/2 connection is established with the server. Parameters priorKnowledge:boolean `true` if it's known that the server supports HTTP/2. By default no prior knowledge is assumed.

public void setPriorKnowledge(final boolean priorKnowledge)

Control how the HTTP/2 connection is established with the server.

Parameters

priorKnowledge:boolean: true if it's known that the server supports HTTP/2. By default no prior knowledge is assumed.

setPushEnabled	back to summary
public void setPushEnabled(final boolean pushEnabled) Configure whether push should be allowed by the server endpoint.

setStreamsHighWaterMark	back to summary
public void setStreamsHighWaterMark(final float streamsHighWaterMark) Streams are maintained and periodically cleaned when the stream count (open or otherwise) surpasses the the specified high-water mark. This value is applied against the max concurrent streams for the endpoint which HTTP2 is being configured for. For example, if the max concurrent streams is 100 and the mark percentage is .5, then the high water mark for a clean attempt would be 50.

setStreamsHighWaterMark

back to summary

public void setStreamsHighWaterMark(final float streamsHighWaterMark)

Streams are maintained and periodically cleaned when the stream count (open or otherwise) surpasses the the specified high-water mark. This value is applied against the max concurrent streams for the endpoint which HTTP2 is being configured for. For example, if the max concurrent streams is 100 and the mark percentage is .5, then the high water mark for a clean attempt would be 50.

org.glassfish.grizzly.http2 back to summary

public final Class Http2Configuration.Http2ConfigurationBuilder

Class Inheritance

extends Object

java.lang.Object
org.glassfish.grizzly.http2.Http2Configuration.Http2ConfigurationBuilder

Field Summary

Modifier and Type	Field and Description
private int	cleanFrequencyCheck
private float	cleanPercentage
private boolean	disableCipherCheck
private ExecutorService	executorService
private int	initialWindowSize
private int	maxConcurrentStreams
private int	maxFramePayloadSize
private int	maxHeaderListSize
private boolean	priorKnowledge
private boolean	pushEnabled
private float	streamsHighWaterMark
private ThreadPoolConfig	threadPoolConfig

Constructor Summary

Access	Constructor and Description
private	Http2ConfigurationBuilder()

Method Summary

Modifier and Type	Method and Description
public Http2Configuration	build() Returns: a new `Http2Configuration` instances based on the values of this builder.
public Http2Configuration.Http2ConfigurationBuilder	cleanFrequencyCheck(final int val)
public Http2Configuration.Http2ConfigurationBuilder	cleanPercentage(final float val)
public Http2Configuration.Http2ConfigurationBuilder	disableCipherCheck(final boolean val)
public Http2Configuration.Http2ConfigurationBuilder	enablePush(final boolean val)
public Http2Configuration.Http2ConfigurationBuilder	executorService(final ExecutorService val) Specifies a pre-existing `ExecutorService` for handling HTTP/2 streams.
public Http2Configuration.Http2ConfigurationBuilder	initialWindowSize(final int val)
public Http2Configuration.Http2ConfigurationBuilder	maxConcurrentStreams(final int val)
public Http2Configuration.Http2ConfigurationBuilder	maxFramePayloadSize(final int val)
public Http2Configuration.Http2ConfigurationBuilder	maxHeaderListSize(final int val)
public Http2Configuration.Http2ConfigurationBuilder	priorKnowledge(final boolean val)
public Http2Configuration.Http2ConfigurationBuilder	streamsHighWaterMark(final float val)
public Http2Configuration.Http2ConfigurationBuilder	threadPoolConfig(final ThreadPoolConfig val) Specifies a thread pool configuration that will be used to create a new `ExecutorService` handling HTTP/2 streams.

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Field Detail

cleanFrequencyCheck	back to summary
private int cleanFrequencyCheck

cleanPercentage	back to summary
private float cleanPercentage

disableCipherCheck	back to summary
private boolean disableCipherCheck

executorService	back to summary
private ExecutorService executorService

initialWindowSize	back to summary
private int initialWindowSize

maxConcurrentStreams	back to summary
private int maxConcurrentStreams

maxFramePayloadSize	back to summary
private int maxFramePayloadSize

maxHeaderListSize	back to summary
private int maxHeaderListSize

priorKnowledge	back to summary
private boolean priorKnowledge

pushEnabled	back to summary
private boolean pushEnabled

streamsHighWaterMark	back to summary
private float streamsHighWaterMark

threadPoolConfig	back to summary
private ThreadPoolConfig threadPoolConfig

Constructor Detail

Http2ConfigurationBuilder	back to summary
private Http2ConfigurationBuilder()

Method Detail

build	back to summary
public Http2Configuration build() Returns:Http2Configuration a new `Http2Configuration` instances based on the values of this builder.

cleanFrequencyCheck	back to summary
public Http2Configuration.Http2ConfigurationBuilder cleanFrequencyCheck(final int val) See Also `setCleanFrequencyCheck(int)`

cleanPercentage	back to summary
public Http2Configuration.Http2ConfigurationBuilder cleanPercentage(final float val) See Also `setCleanPercentage(float)`

disableCipherCheck	back to summary
public Http2Configuration.Http2ConfigurationBuilder disableCipherCheck(final boolean val) See Also `setDisableCipherCheck(boolean)`

enablePush	back to summary
public Http2Configuration.Http2ConfigurationBuilder enablePush(final boolean val) See Also `setPushEnabled(boolean)`

executorService	back to summary
public Http2Configuration.Http2ConfigurationBuilder executorService(final ExecutorService val) Specifies a pre-existing `ExecutorService` for handling HTTP/2 streams. If called, it will clear any value set previously by `threadPoolConfig(ThreadPoolConfig)`.

initialWindowSize	back to summary
public Http2Configuration.Http2ConfigurationBuilder initialWindowSize(final int val) See Also `setInitialWindowSize(int)`

maxConcurrentStreams	back to summary
public Http2Configuration.Http2ConfigurationBuilder maxConcurrentStreams(final int val) See Also `setMaxConcurrentStreams(int)`

maxFramePayloadSize	back to summary
public Http2Configuration.Http2ConfigurationBuilder maxFramePayloadSize(final int val) See Also `setMaxFramePayloadSize(int)`

maxHeaderListSize	back to summary
public Http2Configuration.Http2ConfigurationBuilder maxHeaderListSize(final int val) See Also `setMaxHeaderListSize(int)`

priorKnowledge	back to summary
public Http2Configuration.Http2ConfigurationBuilder priorKnowledge(final boolean val) See Also `setPriorKnowledge(boolean)`

streamsHighWaterMark	back to summary
public Http2Configuration.Http2ConfigurationBuilder streamsHighWaterMark(final float val) See Also `setStreamsHighWaterMark(float)`

threadPoolConfig	back to summary
public Http2Configuration.Http2ConfigurationBuilder threadPoolConfig(final ThreadPoolConfig val) Specifies a thread pool configuration that will be used to create a new `ExecutorService` handling HTTP/2 streams.

public Class Http2Configuration

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

public final Class Http2Configuration.Http2ConfigurationBuilder

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail