Uses of Interface
io.helidon.http.Headers

Packages that use Headers

Package	Description
io.helidon.common.testing.http.junit5	Testing support for HTTP.
io.helidon.grpc.core	Core classes used by both the gRPC server and gRPC client.
io.helidon.http	HTTP APIs and implementations usable by both server and client side of the HTTP story.
io.helidon.http.encoding	HTTP Content encoding support, usually used to compress entity, such as gzip.
io.helidon.http.http1	Helidon Common HTTP/1.1 classes.
io.helidon.http.http2	Helidon Common HTTP/2 classes.
io.helidon.http.media	Helidon Media Support.
io.helidon.http.media.jackson	Jackson media type support.
io.helidon.http.media.json	Helidon JSON Media Support.
io.helidon.http.media.json.binding	Helidon JSON Binding Media Support.
io.helidon.http.media.json.smile	JSON Smile media support.
io.helidon.http.media.jsonb	JSON-Binding Entity Media handling support.
io.helidon.http.media.jsonp	JSON-Processing Entity Media handling support.
io.helidon.http.media.multipart	Multipart Entity Media handling support.
io.helidon.webclient.api	Helidon WebClient APIs shared by all types of clients.
io.helidon.webclient.http2	Helidon WebClient HTTP/2 Support.
io.helidon.webserver	Helidon WebServer module, combining common server API, HTTP API and HTTP/1.1 API to create a server.
io.helidon.webserver.http	Helidon WebServer HTTP specific APIs.
io.helidon.webserver.http1	Helidon WebServer HTTP/1.1 specific APIs.
io.helidon.webserver.http1.spi	Helidon WebServer HTTP/1.1 specific SPIs.
io.helidon.webserver.websocket	WebSocket server support.
io.helidon.websocket	WebSocket APIs.

Uses of Headers in io.helidon.common.testing.http.junit5

Methods in io.helidon.common.testing.http.junit5 that return types with arguments of type Headers

Modifier and Type	Method	Description
static org.hamcrest.Matcher<Headers>	HttpHeaderMatcher.hasHeader(Header header)	A matcher for an Headers that checks that the header is present and has the defined value.
static org.hamcrest.Matcher<Headers>	HttpHeaderMatcher.hasHeader(HeaderName name)	A matcher for an Headers that checks that the header is present, ignoring its value.
static org.hamcrest.Matcher<Headers>	HttpHeaderMatcher.hasHeader(HeaderName name, String... value)	A matcher for an Headers that checks that the header is present and has the defined value(s).
static org.hamcrest.Matcher<Headers>	HttpHeaderMatcher.hasHeader(HeaderName name, org.hamcrest.Matcher<Iterable<? extends String>> valuesMatcher)	A matcher for an Headers that checks that the header is present and values match the provided matcher.
static org.hamcrest.Matcher<Headers>	HttpHeaderMatcher.hasHeaderValue(HeaderName name, org.hamcrest.Matcher<String> valueMatcher)	A matcher for an Headers that checks that the header is present and its single value matches the provided matcher.
static org.hamcrest.Matcher<Headers>	HttpHeaderMatcher.noHeader(HeaderName name)	A matcher for an Headers that checks that the header is not present.

Uses of Headers in io.helidon.grpc.core

Methods in io.helidon.grpc.core with parameters of type Headers

Modifier and Type	Method	Description
static io.grpc.Metadata	GrpcHeadersUtil.toMetadata(Headers headers)	Converts HTTP headers into a Metadata instance.

Uses of Headers in io.helidon.http

Classes in io.helidon.http with type parameters of type Headers

Modifier and Type	Class	Description
class	Headers__ServiceDescriptor<T extends Headers>	Service descriptor for Headers.

Subinterfaces of Headers in io.helidon.http

Modifier and Type	Interface	Description
interface	ClientRequestHeaders	Mutable headers of a client request.
interface	ClientResponseHeaders	HTTP Headers of a client response.
interface	ClientResponseTrailers	HTTP Trailer headers of a client response.
interface	ServerRequestHeaders	HTTP headers of a server request.
interface	ServerResponseHeaders	Mutable headers of a server response.
interface	ServerResponseTrailers	Mutable trailers of a server response.
interface	WritableHeaders<B extends WritableHeaders<B>>	HTTP Headers that are mutable.

Fields in io.helidon.http with type parameters of type Headers

Modifier and Type	Field	Description
static final Headers__ServiceDescriptor<Headers>	Headers__ServiceDescriptor.INSTANCE	Global singleton instance for this descriptor.

Methods in io.helidon.http that return Headers

Modifier and Type	Method	Description
Headers	HttpException.headers()	Headers as currently configured in this exception.

Methods in io.helidon.http with parameters of type Headers

Modifier and Type	Method	Description
static ClientRequestHeaders	ClientRequestHeaders.create(Headers headers)	Create client request headers from headers.
static ClientResponseHeaders	ClientResponseHeaders.create(Headers responseHeaders)	Create a new instance from headers parsed from client response.
static ClientResponseHeaders	ClientResponseHeaders.create(Headers responseHeaders, ParserMode parserMode)	Create a new instance from headers parsed from client response.
static ClientResponseTrailers	ClientResponseTrailers.create(Headers headers)	Create new trailers from headers future.
static List<Forwarded>	Forwarded.create(Headers headers)	Parse forwarded header(s) from the provided headers.
static ServerRequestHeaders	ServerRequestHeaders.create(Headers headers)	Create a new instance from headers.
static ServerResponseHeaders	ServerResponseHeaders.create(Headers existing)	Create a new instance of mutable server response headers.
static ServerResponseTrailers	ServerResponseTrailers.create(Headers existing)	Create a new instance of mutable server response trailers.
static WritableHeaders<?>	WritableHeaders.create(Headers headers)	Create a new instance of writable headers from existing headers.
String	LogFormatter.format(Headers headers)	Format headers for protocol logs.
String	LogFormatter.formatAll(Headers headers)	Format all header values for explicitly enabled unsafe protocol logs.
B	WritableHeaders.from(Headers headers)	For each header from the provided headers, set its value on these headers.

Uses of Headers in io.helidon.http.encoding

Methods in io.helidon.http.encoding with parameters of type Headers

Modifier and Type	Method	Description
static AcceptEncoding	AcceptEncoding.create(Headers headers)	Parse Accept-Encoding from headers.
ContentEncoder	ContentEncodingContext.encoder(Headers headers)	Discover content encoder based on the HTTP headers.

Uses of Headers in io.helidon.http.http1

Methods in io.helidon.http.http1 with parameters of type Headers

Modifier and Type	Method	Description
default void	Http1ConnectionListener.headers(SocketContext ctx, Headers headers)	Handle headers.
void	Http1LoggingConnectionListener.headers(SocketContext ctx, Headers headers)

Uses of Headers in io.helidon.http.http2

Methods in io.helidon.http.http2 that return Headers

Modifier and Type	Method	Description
Headers	Http2Headers.httpHeaders()	HTTP headers.

Methods in io.helidon.http.http2 with parameters of type Headers

Modifier and Type	Method	Description
static Http2Headers	Http2Headers.create(Headers headers)	Create HTTP/2 headers from HTTP headers.

Uses of Headers in io.helidon.http.media

Methods in io.helidon.http.media with parameters of type Headers

Modifier and Type	Method	Description
protected static Charset	EntityReaderBase.contentTypeCharset(Headers headers)	Get Content-Type from the provided headers (if available), then get its charset (if available), and return it, otherwise return UTF-8.
protected static Optional<Charset>	EntityReaderBase.findContentTypeCharset(Headers headers)	Get Content-Type from the provided headers (if available), then get its charset (if available), and return it, otherwise return empty optional.
default InstanceWriter	EntityWriter.instanceWriter(GenericType<T> type, T object, Headers requestHeaders, WritableHeaders<?> responseHeaders)	Server response entity instance writer.
protected boolean	MediaSupportBase.matchesClientRequest(GenericType<?> type, Headers requestHeaders)	Client request writer check.
protected boolean	MediaSupportBase.matchesClientResponse(GenericType<?> type, Headers responseHeaders)	Client response reader check.
protected boolean	MediaSupportBase.matchesServerRequest(GenericType<?> type, Headers requestHeaders)	Server request reader check.
protected boolean	MediaSupportBase.matchesServerResponse(GenericType<?> type, Headers requestHeaders, Headers responseHeaders)	Server response writer check.
T	EntityReader.read(GenericType<T> type, InputStream stream, Headers headers)	Read server request entity and close the stream.
T	EntityReader.read(GenericType<T> type, InputStream stream, Headers requestHeaders, Headers responseHeaders)	Read client response entity and close the stream.
<T> MediaSupport.ReaderResponse<T>	FormParamsSupport.reader(GenericType<T> type, Headers requestHeaders)
<T> MediaSupport.ReaderResponse<T>	FormParamsSupport.reader(GenericType<T> type, Headers requestHeaders, Headers responseHeaders)
<T> EntityReader<T>	MediaContext.reader(GenericType<T> type, Headers headers)	Reader for entity.
<T> EntityReader<T>	MediaContext.reader(GenericType<T> type, Headers requestHeaders, Headers responseHeaders)	Reader for client response entity.
default <T> MediaSupport.ReaderResponse<T>	MediaSupport.reader(GenericType<T> type, Headers headers)	Reader for an entity.
default <T> MediaSupport.ReaderResponse<T>	MediaSupport.reader(GenericType<T> type, Headers requestHeaders, Headers responseHeaders)	Client response reader.
<T> MediaSupport.ReaderResponse<T>	PathSupport.reader(GenericType<T> type, Headers requestHeaders)
<T> MediaSupport.ReaderResponse<T>	PathSupport.reader(GenericType<T> type, Headers requestHeaders, Headers responseHeaders)
<T> MediaSupport.ReaderResponse<T>	StringSupport.reader(GenericType<T> type, Headers requestHeaders)
<T> MediaSupport.ReaderResponse<T>	StringSupport.reader(GenericType<T> type, Headers requestHeaders, Headers responseHeaders)
protected Optional<Charset>	EntityWriterBase.serverResponseContentTypeAndCharset(Headers serverRequestHeaders, WritableHeaders<?> serverResponseHeaders)	Configure server response content type and return charset to use.
void	EntityWriter.write(GenericType<T> type, T object, OutputStream outputStream, Headers requestHeaders, WritableHeaders<?> responseHeaders)	Write server response entity and close the stream.
<T> MediaSupport.WriterResponse<T>	FormParamsSupport.writer(GenericType<T> type, Headers requestHeaders, WritableHeaders<?> responseHeaders)
<T> EntityWriter<T>	MediaContext.writer(GenericType<T> type, Headers requestHeaders, WritableHeaders<?> responseHeaders)	Writer for server response entity.
default <T> MediaSupport.WriterResponse<T>	MediaSupport.writer(GenericType<T> type, Headers requestHeaders, WritableHeaders<?> responseHeaders)	Server response writer.
<T> MediaSupport.WriterResponse<T>	PathSupport.writer(GenericType<T> type, Headers requestHeaders, WritableHeaders<?> responseHeaders)
<T> MediaSupport.WriterResponse<T>	StringSupport.writer(GenericType<T> type, Headers requestHeaders, WritableHeaders<?> responseHeaders)

Uses of Headers in io.helidon.http.media.jackson

Methods in io.helidon.http.media.jackson with parameters of type Headers

Modifier and Type	Method	Description
<T> MediaSupport.ReaderResponse<T>	JacksonSupport.reader(GenericType<T> type, Headers requestHeaders)
<T> MediaSupport.ReaderResponse<T>	JacksonSupport.reader(GenericType<T> type, Headers requestHeaders, Headers responseHeaders)
<T> MediaSupport.WriterResponse<T>	JacksonSupport.writer(GenericType<T> type, Headers requestHeaders, WritableHeaders<?> responseHeaders)

Uses of Headers in io.helidon.http.media.json

Methods in io.helidon.http.media.json with parameters of type Headers

Modifier and Type	Method	Description
<T> MediaSupport.ReaderResponse<T>	JsonSupport.reader(GenericType<T> type, Headers requestHeaders)
<T> MediaSupport.ReaderResponse<T>	JsonSupport.reader(GenericType<T> type, Headers requestHeaders, Headers responseHeaders)
<T> MediaSupport.WriterResponse<T>	JsonSupport.writer(GenericType<T> type, Headers requestHeaders, WritableHeaders<?> responseHeaders)

Uses of Headers in io.helidon.http.media.json.binding

Methods in io.helidon.http.media.json.binding with parameters of type Headers

Modifier and Type	Method	Description
<T> MediaSupport.ReaderResponse<T>	JsonBindingSupport.reader(GenericType<T> type, Headers requestHeaders)
<T> MediaSupport.ReaderResponse<T>	JsonBindingSupport.reader(GenericType<T> type, Headers requestHeaders, Headers responseHeaders)
<T> MediaSupport.WriterResponse<T>	JsonBindingSupport.writer(GenericType<T> type, Headers requestHeaders, WritableHeaders<?> responseHeaders)

Uses of Headers in io.helidon.http.media.json.smile

Methods in io.helidon.http.media.json.smile with parameters of type Headers

Modifier and Type	Method	Description
<T> MediaSupport.ReaderResponse<T>	SmileSupport.reader(GenericType<T> type, Headers requestHeaders)
<T> MediaSupport.ReaderResponse<T>	SmileSupport.reader(GenericType<T> type, Headers requestHeaders, Headers responseHeaders)
<T> MediaSupport.WriterResponse<T>	SmileSupport.writer(GenericType<T> type, Headers requestHeaders, WritableHeaders<?> responseHeaders)

Uses of Headers in io.helidon.http.media.jsonb

Methods in io.helidon.http.media.jsonb with parameters of type Headers

Modifier and Type	Method	Description
<T> MediaSupport.ReaderResponse<T>	JsonbSupport.reader(GenericType<T> type, Headers requestHeaders)
<T> MediaSupport.ReaderResponse<T>	JsonbSupport.reader(GenericType<T> type, Headers requestHeaders, Headers responseHeaders)
<T> MediaSupport.WriterResponse<T>	JsonbSupport.writer(GenericType<T> type, Headers requestHeaders, WritableHeaders<?> responseHeaders)

Uses of Headers in io.helidon.http.media.jsonp

Methods in io.helidon.http.media.jsonp with parameters of type Headers

Modifier and Type	Method	Description
<T> MediaSupport.ReaderResponse<T>	JsonpSupport.reader(GenericType<T> type, Headers requestHeaders)
<T> MediaSupport.ReaderResponse<T>	JsonpSupport.reader(GenericType<T> type, Headers requestHeaders, Headers responseHeaders)
<T> MediaSupport.WriterResponse<T>	JsonpSupport.writer(GenericType<T> type, Headers requestHeaders, WritableHeaders<?> responseHeaders)

Uses of Headers in io.helidon.http.media.multipart

Methods in io.helidon.http.media.multipart that return Headers

Modifier and Type	Method	Description
Headers	WriteablePart.headers()	Full set of configured headers of this part.
Headers	ReadablePart.partHeaders()	Headers of this part.

Methods in io.helidon.http.media.multipart with parameters of type Headers

Modifier and Type	Method	Description
<T> MediaSupport.ReaderResponse<T>	MultiPartSupport.reader(GenericType<T> type, Headers requestHeaders)
<T> MediaSupport.ReaderResponse<T>	MultiPartSupport.reader(GenericType<T> type, Headers requestHeaders, Headers responseHeaders)
<T> MediaSupport.WriterResponse<T>	MultiPartSupport.writer(GenericType<T> type, Headers requestHeaders, WritableHeaders<?> responseHeaders)
void	WriteablePart.writeServerResponse(MediaContext context, OutputStream outputStream, Headers requestHeaders)	Write this part as part of server response.

Uses of Headers in io.helidon.webclient.api

Methods in io.helidon.webclient.api with parameters of type Headers

Modifier and Type	Method	Description
T	ClientRequest.headers(Headers headers)	Configure headers.
T	ClientRequestBase.headers(Headers headers)

Uses of Headers in io.helidon.webclient.http2

Methods in io.helidon.webclient.http2 that return types with arguments of type Headers

Modifier and Type	Method	Description
CompletableFuture<Headers>	Http2ClientStream.trailers()	Future that shall be completed once trailers are received.

Uses of Headers in io.helidon.webserver

Methods in io.helidon.webserver with parameters of type Headers

Modifier and Type	Method	Description
static RequestException	SniRequestSupport.missingAuthority(HttpPrologue prologue, Headers headers)	Create the request exception for a missing authority.
static String	SniRequestSupport.singleHostAuthority(HttpPrologue prologue, Headers headers)	Return the single HTTP/1 Host header authority required by SNI policy.
static void	SniRequestSupport.validateAuthority(SniContext sniContext, HttpPrologue prologue, Headers headers, UriAuthority authority)	Validate an already parsed HTTP authority against the connection SNI context.
static void	SniRequestSupport.validateAuthority(SniContext sniContext, HttpPrologue prologue, Headers headers, String authority)	Validate an HTTP authority against the connection SNI context.
static void	SniRequestSupport.validateAuthorityCheck(SniContext.AuthorityCheck check, HttpPrologue prologue, Headers headers)	Validate an already parsed SNI authority check result.

Uses of Headers in io.helidon.webserver.http

Methods in io.helidon.webserver.http with parameters of type Headers

Modifier and Type	Method	Description
static DirectHandler.TransportRequest	DirectTransportRequest.create(HttpPrologue prologue, Headers headers)	Configure a simple request from known prologue and headers.

Uses of Headers in io.helidon.webserver.http1

Methods in io.helidon.webserver.http1 with parameters of type Headers

Modifier and Type	Method	Description
default void	Http1ConnectionListener.headers(ConnectionContext ctx, Headers headers)	Handle headers.
void	Http1LoggingConnectionListener.headers(ConnectionContext ctx, Headers headers)

Uses of Headers in io.helidon.webserver.http1.spi

Methods in io.helidon.webserver.http1.spi with parameters of type Headers

Modifier and Type	Method	Description
void	Http1UpgradeResponse.sendSwitchingProtocols(Headers requiredHeaders)	Send the configured 101 Switching Protocols response.

Uses of Headers in io.helidon.webserver.websocket

Methods in io.helidon.webserver.websocket with parameters of type Headers

Modifier and Type	Method	Description
static WsConnection	WsConnection.create(ConnectionContext ctx, HttpPrologue prologue, Headers upgradeHeaders, String wsKey, WsRoute wsRoute)	Create a new connection using a route.
static WsConnection	WsConnection.create(ConnectionContext ctx, HttpPrologue prologue, Headers upgradeHeaders, String wsKey, WsListener wsListener)	Create a new connection using a listener.

Uses of Headers in io.helidon.websocket

Methods in io.helidon.websocket that return types with arguments of type Headers

Modifier and Type	Method	Description
default Optional<Headers>	WsListener.onHttpUpgrade(HttpPrologue prologue, Headers headers)	Invoked during handshake process.

Methods in io.helidon.websocket with parameters of type Headers

Modifier and Type	Method	Description
default Optional<Headers>	WsListener.onHttpUpgrade(HttpPrologue prologue, Headers headers)	Invoked during handshake process.