Uses of Interface
io.helidon.common.http.Headers

Packages that use Headers

Package	Description
io.helidon.common.http	HTTP APIs and implementations usable by both server and client side of the HTTP story.
io.helidon.common.testing.http.junit5	Testing support for HTTP.
io.helidon.integrations.common.rest	Common classes for accessing JSON based REST APIs of third party systems.
io.helidon.nima.http.encoding	HTTP Content encoding support, usually used to compress entity, such as gzip.
io.helidon.nima.http.media	Entity Media handling support.
io.helidon.nima.http.media.jackson	Jackson media type support.
io.helidon.nima.http.media.jsonb	JSON-Binding Entity Media handling support.
io.helidon.nima.http.media.jsonp	JSON-Processing Entity Media handling support.
io.helidon.nima.http.media.multipart	Multipart Entity Media handling support.
io.helidon.nima.http2	HTTP/2 types common for client and server.
io.helidon.nima.webclient	WebClient APIs shared by all types of clients.
io.helidon.nima.webserver.http	WebServer HTTP specific APIs.
io.helidon.nima.webserver.http1	WebServer HTTP/1.1 specific APIs.
io.helidon.nima.websocket	WebSocket APIs.
io.helidon.nima.websocket.webserver	WebSocket server support.
io.helidon.reactive.media.common	Common classes for processing content with a specific HttpMediaType.
io.helidon.reactive.media.multipart	Helidon Reactive Media MultiPart.
io.helidon.reactive.webclient	A reactive client for rest calls.
io.helidon.reactive.webserver	Reactive web server API.

Uses of Headers in io.helidon.common.http

Subinterfaces of Headers in io.helidon.common.http

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

Methods in io.helidon.common.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 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 WritableHeaders<?>	WritableHeaders.create(Headers headers)	Create a new instance of writable headers from existing headers.

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(Http.HeaderName name)	A matcher for an Headers that checks that the header is present, ignoring its value.
static org.hamcrest.Matcher<Headers>	HttpHeaderMatcher.hasHeader(Http.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(Http.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.hasHeader(Http.HeaderValue header)	A matcher for an Headers that checks that the header is present and has the defined value.
static org.hamcrest.Matcher<Headers>	HttpHeaderMatcher.hasHeaderValue(Http.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(Http.HeaderName name)	A matcher for an Headers that checks that the header is not present.

Uses of Headers in io.helidon.integrations.common.rest

Methods in io.helidon.integrations.common.rest that return Headers

Modifier and Type	Method	Description
Headers	ApiResponse.Builder.headers()	Received HTTP headers.
Headers	ApiResponse.headers()	HTTP headers returned in the response.
Headers	ApiRestException.headers()	Response HTTP headers.

Methods in io.helidon.integrations.common.rest with parameters of type Headers

Modifier and Type	Method	Description
B	ApiResponse.Builder.headers(Headers headers)	Configure the HTTP headers returned by the API call.
B	ApiRestException.BaseBuilder.headers(Headers headers)	HTTP headers configured by RestApi.
B	ResponseBuilder.headers(Headers headers)	Configure the HTTP headers returned by the API call.

Uses of Headers in io.helidon.nima.http.encoding

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

Modifier and Type	Method	Description
ContentEncoder	ContentEncodingContext.encoder(Headers headers)	Discover content encoder based on the HTTP headers.

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

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

Modifier and Type	Method	Description
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)
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.nima.http.media.jackson

Methods in io.helidon.nima.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.nima.http.media.jsonb

Methods in io.helidon.nima.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.nima.http.media.jsonp

Methods in io.helidon.nima.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.nima.http.media.multipart

Methods in io.helidon.nima.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.nima.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.nima.http2

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

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

Methods in io.helidon.nima.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.nima.webclient

Methods in io.helidon.nima.webclient that return Headers

Modifier and Type	Method	Description
Headers	ClientResponse.headers()	Response headers.

Uses of Headers in io.helidon.nima.webserver.http

Methods in io.helidon.nima.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.nima.webserver.http1

Methods in io.helidon.nima.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.nima.websocket

Methods in io.helidon.nima.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.nima.websocket with parameters of type Headers

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

Uses of Headers in io.helidon.nima.websocket.webserver

Methods in io.helidon.nima.websocket.webserver 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.

Uses of Headers in io.helidon.reactive.media.common

Methods in io.helidon.reactive.media.common that return Headers

Modifier and Type	Method	Description
Headers	MessageBodyReaderContext.headers()	Get the underlying headers.

Methods in io.helidon.reactive.media.common with parameters of type Headers

Modifier and Type	Method	Description
static MessageBodyReaderContext	MessageBodyReaderContext.create(MediaContext mediaContext, MessageBodyContext.EventListener eventListener, Headers headers, Optional<HttpMediaType> contentType)	Create a new empty reader context backed by the specified headers.
static MessageBodyReaderContext	MessageBodyReaderContext.create(MessageBodyReaderContext parent, MessageBodyContext.EventListener eventListener, Headers headers, Optional<HttpMediaType> contentType)	Create a new empty reader context backed by the specified headers.

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

Subinterfaces of Headers in io.helidon.reactive.media.multipart

Modifier and Type	Interface	Description
interface	BodyPartHeaders	Body part headers.

Classes in io.helidon.reactive.media.multipart that implement Headers

Modifier and Type	Class	Description
final class	ReadableBodyPartHeaders	Readable body part headers.
final class	WriteableBodyPartHeaders	Writeable body part headers.

Uses of Headers in io.helidon.reactive.webclient

Subinterfaces of Headers in io.helidon.reactive.webclient

Modifier and Type	Interface	Description
interface	WebClientRequestHeaders	Headers that can be modified (until request is sent) for outbound request.
interface	WebClientResponseHeaders	Headers that may be available on response from server.

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

Modifier and Type	Method	Description
WebClientRequestHeaders	WebClientRequestHeaders.addAll(Headers parameters)	Add each header, combining values if header already exists.
default WebClientRequestBuilder	WebClientRequestBuilder.addHeaders(Headers parameters)	Copies all of the mappings from the specified parameters to this response headers instance.
WebClientRequestBuilder	WebClientRequestBuilder.headers(Headers headers)	Configure headers.
WebClientRequestHeaders	WebClientRequestHeaders.putAll(Headers parameters)	Add each header, replacing values if header already exists.

Method parameters in io.helidon.reactive.webclient with type arguments of type Headers

Modifier and Type	Method	Description
WebClientRequestBuilder	WebClientRequestBuilder.headers(Function<WebClientRequestHeaders,Headers> headers)	Function from parameter is executed on top of stored headers.

Uses of Headers in io.helidon.reactive.webserver

Subinterfaces of Headers in io.helidon.reactive.webserver

Modifier and Type	Interface	Description
interface	RequestHeaders	Extends Headers interface by adding HTTP request headers oriented convenient methods.
interface	ResponseHeaders	Extends ServerResponseHeaders interface by adding HTTP response headers oriented constants and convenient methods.