org.springframework.web.reactive.function.server

Interface ServerRequest.Headers

All Known Implementing Classes:

ServerRequestWrapper.HeadersWrapper

Enclosing interface:

ServerRequest

public static interface ServerRequest.Headers

Represents the headers of the HTTP request.

See Also:

ServerRequest.headers()

Method Summary

Modifier and Type	Method and Description
java.util.List<MediaType>	accept() Return the list of acceptable media types, as specified by the Accept header.
java.util.List<java.nio.charset.Charset>	acceptCharset() Return the list of acceptable charsets, as specified by the Accept-Charset header.
java.util.List<java.util.Locale.LanguageRange>	acceptLanguage() Return the list of acceptable languages, as specified by the Accept-Language header.
HttpHeaders	asHttpHeaders() Return the headers as a HttpHeaders instance.
java.util.OptionalLong	contentLength() Return the length of the body in bytes, as specified by the Content-Length header.
java.util.Optional<MediaType>	contentType() Return the media type of the body, as specified by the Content-Type header.
java.util.List<java.lang.String>	header(java.lang.String headerName) Return the header value(s), if any, for the header of the given name.
java.net.InetSocketAddress	host() Return the value of the required Host header.
java.util.List<HttpRange>	range() Return the value of the Range header.

Method Detail

accept

java.util.List<MediaType> accept()

Return the list of acceptable media types, as specified by the Accept header.

Returns an empty list when the acceptable media types are unspecified.

acceptCharset

java.util.List<java.nio.charset.Charset> acceptCharset()

Return the list of acceptable charsets, as specified by the Accept-Charset header.

acceptLanguage

java.util.List<java.util.Locale.LanguageRange> acceptLanguage()

Return the list of acceptable languages, as specified by the Accept-Language header.

contentLength

java.util.OptionalLong contentLength()

Return the length of the body in bytes, as specified by the Content-Length header.

contentType

java.util.Optional<MediaType> contentType()

Return the media type of the body, as specified by the Content-Type header.

host

@Nullable
java.net.InetSocketAddress host()

Return the value of the required Host header.

If the header value does not contain a port, the returned port will be 0.

range

java.util.List<HttpRange> range()

Return the value of the Range header.

Returns an empty list when the range is unknown.

header

java.util.List<java.lang.String> header(java.lang.String headerName)

Return the header value(s), if any, for the header of the given name.

Return an empty list if no header values are found.

Parameters:

headerName - the header name

asHttpHeaders

HttpHeaders asHttpHeaders()

Return the headers as a HttpHeaders instance.