org.springframework.http.server.reactive

Interface ServerHttpRequest

All Superinterfaces:

HttpMessage, HttpRequest, ReactiveHttpInputMessage

All Known Implementing Classes:

AbstractServerHttpRequest, MockServerHttpRequest, ReactorServerHttpRequest, RxNettyServerHttpRequest, ServerHttpRequestDecorator, ServletServerHttpRequest, UndertowServerHttpRequest

public interface ServerHttpRequest
extends HttpRequest, ReactiveHttpInputMessage

Represents a reactive server-side HTTP request

Since:

5.0

Author:

Arjen Poutsma, Rossen Stoyanchev

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	ServerHttpRequest.Builder Builder for mutating an existing ServerHttpRequest.

Method Summary

Modifier and Type	Method and Description
default String	getContextPath() Returns the portion of the URL path that represents the context path for the current HttpHandler.
MultiValueMap<String,HttpCookie>	getCookies() Return a read-only map of cookies sent by the client.
MultiValueMap<String,String>	getQueryParams() Return a read-only map with parsed and decoded query parameter values.
Optional<InetSocketAddress>	getRemoteAddress() Returns the remote address where this request is connected to.
default ServerHttpRequest.Builder	mutate() Return a builder to mutate properties of this request by wrapping it with ServerHttpRequestDecorator and returning either mutated values or delegating back to this instance.

Methods inherited from interface org.springframework.http.HttpRequest

getMethod, getURI

Methods inherited from interface org.springframework.http.ReactiveHttpInputMessage

getBody

Methods inherited from interface org.springframework.http.HttpMessage

getHeaders

Method Detail

getContextPath

default String getContextPath()

Returns the portion of the URL path that represents the context path for the current HttpHandler. The context path is always at the beginning of the request path. It starts with "/" but but does not end with "/". This method may return an empty string if no context path is configured.

Returns:

the context path (not decoded) or an empty string

getQueryParams

MultiValueMap<String,String> getQueryParams()

Return a read-only map with parsed and decoded query parameter values.

getCookies

MultiValueMap<String,HttpCookie> getCookies()

Return a read-only map of cookies sent by the client.

getRemoteAddress

Optional<InetSocketAddress> getRemoteAddress()

Returns the remote address where this request is connected to.

Returns:

remote address if available

mutate

default ServerHttpRequest.Builder mutate()

Return a builder to mutate properties of this request by wrapping it with ServerHttpRequestDecorator and returning either mutated values or delegating back to this instance.