org.springframework.http.server.reactive

Interface ServerHttpRequest.Builder

Enclosing interface:

ServerHttpRequest

public static interface ServerHttpRequest.Builder

Builder for mutating an existing ServerHttpRequest.

Method Summary

Modifier and Type	Method and Description
ServerHttpRequest	build() Build a ServerHttpRequest decorator with the mutated properties.
ServerHttpRequest.Builder	contextPath(java.lang.String contextPath) Set the contextPath to use.
ServerHttpRequest.Builder	header(java.lang.String key, java.lang.String value) Set or override the specified header.
ServerHttpRequest.Builder	headers(java.util.function.Consumer<HttpHeaders> headersConsumer) Manipulate this request's headers with the given consumer.
ServerHttpRequest.Builder	method(HttpMethod httpMethod) Set the HTTP method to return.
ServerHttpRequest.Builder	path(java.lang.String path) Set the path to use instead of the "rawPath" of HttpRequest.getURI().
ServerHttpRequest.Builder	uri(java.net.URI uri) Set the URI to return.

Method Detail

method

ServerHttpRequest.Builder method(HttpMethod httpMethod)

Set the HTTP method to return.

uri

ServerHttpRequest.Builder uri(java.net.URI uri)

Set the URI to return.

path

ServerHttpRequest.Builder path(java.lang.String path)

Set the path to use instead of the "rawPath" of HttpRequest.getURI().

contextPath

ServerHttpRequest.Builder contextPath(java.lang.String contextPath)

Set the contextPath to use.

header

ServerHttpRequest.Builder header(java.lang.String key,
                                 java.lang.String value)

Set or override the specified header.

headers

ServerHttpRequest.Builder headers(java.util.function.Consumer<HttpHeaders> headersConsumer)

Manipulate this request's headers with the given consumer. The headers provided to the consumer are "live", so that the consumer can be used to overwrite existing header values, remove values, or use any of the other HttpHeaders methods.

Parameters:

headersConsumer - a function that consumes the HttpHeaders

Returns:

this builder

build

ServerHttpRequest build()

Build a ServerHttpRequest decorator with the mutated properties.