Interface ServerHttpRequest
- All Superinterfaces:
HttpMessage
,HttpRequest
,ReactiveHttpInputMessage
- All Known Implementing Classes:
AbstractServerHttpRequest
,MockServerHttpRequest
,ServerHttpRequestDecorator
public interface ServerHttpRequest extends HttpRequest, ReactiveHttpInputMessage
Represents a reactive server-side HTTP request.- Since:
- 5.0
- Author:
- Arjen Poutsma, Rossen Stoyanchev, Sam Brannen
Nested Class Summary
Nested Classes Modifier and Type Interface Description static interface
ServerHttpRequest.Builder
Builder for mutating an existingServerHttpRequest
.
Method Summary
All Methods Instance Methods Abstract Methods Default Methods Modifier and Type Method Description MultiValueMap<String,HttpCookie>
getCookies()
Return a read-only map of cookies sent by the client.String
getId()
Return an id that represents the underlying connection, if available, or the request for the purpose of correlating log messages.default InetSocketAddress
getLocalAddress()
Return the local address the request was accepted on, if available.RequestPath
getPath()
Returns a structured representation of the request path including the context path + path within application portions, path segments with encoded and decoded values, and path parameters.MultiValueMap<String,String>
getQueryParams()
Return a read-only map with parsed and decoded query parameter values.default InetSocketAddress
getRemoteAddress()
Return the remote address where this request is connected to, if available.default SslInfo
getSslInfo()
Return the SSL session information if the request has been transmitted over a secure protocol including SSL certificates, if available.default ServerHttpRequest.Builder
mutate()
Return a builder to mutate properties of this request by wrapping it withServerHttpRequestDecorator
and returning either mutated values or delegating back to this instance.Methods inherited from interface org.springframework.http.HttpMessage
getHeaders
Methods inherited from interface org.springframework.http.HttpRequest
getMethod, getMethodValue, getURI
Methods inherited from interface org.springframework.http.ReactiveHttpInputMessage
getBody
Method Detail
getId
String getId()
Return an id that represents the underlying connection, if available, or the request for the purpose of correlating log messages.- Since:
- 5.1
- See Also:
ServerWebExchange.getLogPrefix()
getPath
RequestPath getPath()
Returns a structured representation of the request path including the context path + path within application portions, path segments with encoded and decoded values, and path parameters.
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.
getLocalAddress
@Nullable default InetSocketAddress getLocalAddress()
Return the local address the request was accepted on, if available.- Since:
- 5.2.3
getRemoteAddress
@Nullable default InetSocketAddress getRemoteAddress()
Return the remote address where this request is connected to, if available.
getSslInfo
@Nullable default SslInfo getSslInfo()
Return the SSL session information if the request has been transmitted over a secure protocol including SSL certificates, if available.- Returns:
- the session information, or
null
if none available - Since:
- 5.0.2
mutate
default ServerHttpRequest.Builder mutate()
Return a builder to mutate properties of this request by wrapping it withServerHttpRequestDecorator
and returning either mutated values or delegating back to this instance.