Package io.servicetalk.http.netty

Class H2HeadersFactory

java.lang.Object

io.servicetalk.http.netty.H2HeadersFactory

All Implemented Interfaces:

HttpHeadersFactory

public final class H2HeadersFactory
extends Object
implements HttpHeadersFactory

A HttpHeadersFactory optimized for HTTP/2.

Field Summary

Fields

Modifier and Type	Field	Description
static final HttpHeadersFactory	INSTANCE

Constructor Summary

Constructors

Constructor	Description
H2HeadersFactory(boolean validateNames, boolean validateCookies, boolean validateValues)	Create an instance of the factory with the default array size hint.
H2HeadersFactory(boolean validateNames, boolean validateCookies, boolean validateValues, int headersArraySizeHint, int trailersArraySizeHint)	Create an instance of the factory.

Method Summary

Modifier and Type	Method	Description
HttpHeaders	newEmptyTrailers()	Create an HttpHeaders instance designed to hold trailers, possibly optimized for being empty.
HttpHeaders	newHeaders()	Create an HttpHeaders instance.
HttpHeaders	newTrailers()	Create an HttpHeaders instance designed to hold trailers.
String	toString()
boolean	validateCookies()	Determine if cookies should be validated during parsing into HttpSetCookies.
boolean	validateNames()	Determine if header names should be validated during parsing into HttpHeaderss.
boolean	validateValues()	Determine if header values should be validated during parsing into HttpHeaderss.

Methods inherited from class java.lang.Object

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

Field Details

INSTANCE

public static final HttpHeadersFactory INSTANCE

Constructor Details

H2HeadersFactory

public H2HeadersFactory(boolean validateNames,
 boolean validateCookies,
 boolean validateValues)

Create an instance of the factory with the default array size hint.

Parameters:

validateNames - true to validate header/trailer names.

validateCookies - true to validate cookie contents when parsing.

validateValues - true to validate header values.

H2HeadersFactory

public H2HeadersFactory(boolean validateNames,
 boolean validateCookies,
 boolean validateValues,
 int headersArraySizeHint,
 int trailersArraySizeHint)

Create an instance of the factory.

Parameters:

validateNames - true to validate header/trailer names.

validateCookies - true to validate cookie contents when parsing.

validateValues - true to validate header values.

headersArraySizeHint - A hint as to how large the hash data structure should be for the headers.

trailersArraySizeHint - A hint as to how large the hash data structure should be for the trailers.

Method Details

newHeaders

public HttpHeaders newHeaders()

Description copied from interface: HttpHeadersFactory

Create an HttpHeaders instance.

Specified by:

newHeaders in interface HttpHeadersFactory

Returns:

an HttpHeaders instance.

newTrailers

public HttpHeaders newTrailers()

Description copied from interface: HttpHeadersFactory

Create an HttpHeaders instance designed to hold trailers.

Specified by:

newTrailers in interface HttpHeadersFactory

Returns:

an HttpHeaders instance.

newEmptyTrailers

public HttpHeaders newEmptyTrailers()

Description copied from interface: HttpHeadersFactory

Create an HttpHeaders instance designed to hold trailers, possibly optimized for being empty.

Note: this should not return an immutable instance unless it is known that no code will need to mutate the trailers.

Specified by:

newEmptyTrailers in interface HttpHeadersFactory

Returns:

an HttpHeaders instance.

validateNames

public boolean validateNames()

Description copied from interface: HttpHeadersFactory

Determine if header names should be validated during parsing into HttpHeaderss.

Specified by:

validateNames in interface HttpHeadersFactory

Returns:

true if header names should be validated during parsing into HttpHeaderss.

validateCookies

public boolean validateCookies()

Description copied from interface: HttpHeadersFactory

Determine if cookies should be validated during parsing into HttpSetCookies.

Specified by:

validateCookies in interface HttpHeadersFactory

Returns:

true if a cookies should be validated during parsing into HttpSetCookies.

validateValues

public boolean validateValues()

Description copied from interface: HttpHeadersFactory

Determine if header values should be validated during parsing into HttpHeaderss.

Specified by:

validateValues in interface HttpHeadersFactory

Returns:

true if header values should be validated during parsing into HttpHeaderss.

toString

public String toString()

Overrides:

toString in class Object