Spring Framework 6.1.4 · org.springframework.http.server.reactive.ServerHttpRequestDecorator

Modifier and Type	Field and Description
private final ServerHttpRequest	delegate

Access	Constructor and Description
public	ServerHttpRequestDecorator(ServerHttpRequest delegate)

Method Summary

Modifier and Type	Method and Description
public Flux<DataBuffer>	getBody() Implements org.springframework.http.ReactiveHttpInputMessage.getBody. Return the body of the message as a `Publisher`.
public MultiValueMap<String, HttpCookie>	getCookies() Implements org.springframework.http.server.reactive.ServerHttpRequest.getCookies. Return a read-only map of cookies sent by the client.
public ServerHttpRequest	getDelegate()
public HttpHeaders	getHeaders() Implements org.springframework.http.HttpMessage.getHeaders. Return the headers of this message.
public String	getId() Implements org.springframework.http.server.reactive.ServerHttpRequest.getId. Return an id that represents the underlying connection, if available, or the request for the purpose of correlating log messages.
public InetSocketAddress	getLocalAddress() Overrides default org.springframework.http.server.reactive.ServerHttpRequest.getLocalAddress. Return the local address the request was accepted on, if available.
public HttpMethod	getMethod() Implements org.springframework.http.HttpRequest.getMethod. Return the HTTP method of the request.
public static < the expected native request type T> T	getNativeRequest(ServerHttpRequest the request to check request) Return the native request of the underlying server API, if possible, also unwrapping `ServerHttpRequestDecorator` if necessary.
public RequestPath	getPath() Implements org.springframework.http.server.reactive.ServerHttpRequest.getPath. Returns a structured representation of the full request path up to but not including the `query`.
public MultiValueMap<String, String>	getQueryParams() Implements org.springframework.http.server.reactive.ServerHttpRequest.getQueryParams. Return a read-only map with parsed and decoded query parameter values.
public InetSocketAddress	getRemoteAddress() Overrides default org.springframework.http.server.reactive.ServerHttpRequest.getRemoteAddress. Return the remote address where this request is connected to, if available.
public SslInfo	getSslInfo() Overrides default org.springframework.http.server.reactive.ServerHttpRequest.getSslInfo. Return the SSL session information if the request has been transmitted over a secure protocol including SSL certificates, if available.
public URI	getURI() Implements org.springframework.http.HttpRequest.getURI. Return the URI of the request (including a query string if any, but only if it is well-formed for a URI representation).
public String	toString() Overrides java.lang.Object.toString. Returns a string representation of the object.

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll wait wait wait

delegate	back to summary
private final ServerHttpRequest delegate

ServerHttpRequestDecorator	back to summary
public ServerHttpRequestDecorator(ServerHttpRequest delegate)

Method Detail

getBody back to summary

getBody	back to summary
public Flux<DataBuffer> getBody() Implements org.springframework.http.ReactiveHttpInputMessage.getBody. Doc from org.springframework.http.ReactiveHttpInputMessage.getBody. Return the body of the message as a `Publisher`. Returns:Flux<DataBuffer> the body content publisher Annotations @Override

public Flux<DataBuffer> getBody()

Implements org.springframework.http.ReactiveHttpInputMessage.getBody.

Doc from org.springframework.http.ReactiveHttpInputMessage.getBody.

Return the body of the message as a Publisher.

Returns:Flux<DataBuffer>

the body content publisher

Annotations

@Override

getCookies

back to summary

public MultiValueMap<String, HttpCookie> getCookies()

Implements org.springframework.http.server.reactive.ServerHttpRequest.getCookies.

Doc from org.springframework.http.server.reactive.ServerHttpRequest.getCookies.

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

Annotations

@Override

getDelegate	back to summary
public ServerHttpRequest getDelegate()

getHeaders back to summary

getHeaders	back to summary
public HttpHeaders getHeaders() Implements org.springframework.http.HttpMessage.getHeaders. Doc from org.springframework.http.HttpMessage.getHeaders. Return the headers of this message. Returns:HttpHeaders a corresponding HttpHeaders object (never `null`) Annotations @Override

public HttpHeaders getHeaders()

Implements org.springframework.http.HttpMessage.getHeaders.

Doc from org.springframework.http.HttpMessage.getHeaders.

Return the headers of this message.

Returns:HttpHeaders

a corresponding HttpHeaders object (never null)

Annotations

@Override

getId	back to summary
public String getId() Implements org.springframework.http.server.reactive.ServerHttpRequest.getId. Doc from org.springframework.http.server.reactive.ServerHttpRequest.getId. Return an id that represents the underlying connection, if available, or the request for the purpose of correlating log messages. Annotations @Override

getId

back to summary

public String getId()

Implements org.springframework.http.server.reactive.ServerHttpRequest.getId.

Doc from org.springframework.http.server.reactive.ServerHttpRequest.getId.

Return an id that represents the underlying connection, if available, or the request for the purpose of correlating log messages.

Annotations

@Override

getLocalAddress	back to summary
public InetSocketAddress getLocalAddress() Overrides default org.springframework.http.server.reactive.ServerHttpRequest.getLocalAddress. Doc from org.springframework.http.server.reactive.ServerHttpRequest.getLocalAddress. Return the local address the request was accepted on, if available. Annotations @Override @Nullable

getLocalAddress

back to summary

public InetSocketAddress getLocalAddress()

Overrides default org.springframework.http.server.reactive.ServerHttpRequest.getLocalAddress.

Doc from org.springframework.http.server.reactive.ServerHttpRequest.getLocalAddress.

Return the local address the request was accepted on, if available.

Annotations

@Override
@Nullable

getMethod	back to summary
public HttpMethod getMethod() Implements org.springframework.http.HttpRequest.getMethod. Doc from org.springframework.http.HttpRequest.getMethod. Return the HTTP method of the request. Returns:HttpMethod the HTTP method as an HttpMethod value Annotations @Override

getMethod

back to summary

public HttpMethod getMethod()

Implements org.springframework.http.HttpRequest.getMethod.

Doc from org.springframework.http.HttpRequest.getMethod.

Return the HTTP method of the request.

Returns:HttpMethod

the HTTP method as an HttpMethod value

Annotations

@Override

getNativeRequest back to summary

getNativeRequest	back to summary
public static <T> T getNativeRequest(ServerHttpRequest request) Return the native request of the underlying server API, if possible, also unwrapping `ServerHttpRequestDecorator` if necessary. Parameters <T> the expected native request type request:ServerHttpRequest the request to check Exceptions IllegalArgumentException: if the native request can't be obtained Since 5.3.3

public static <T> T getNativeRequest(ServerHttpRequest request)

Return the native request of the underlying server API, if possible, also unwrapping ServerHttpRequestDecorator if necessary.

Parameters

<T>: the expected native request type
request:ServerHttpRequest: the request to check

Exceptions

IllegalArgumentException:: if the native request can't be obtained

Since

5.3.3

getPath back to summary

getPath	back to summary
public RequestPath getPath() Implements org.springframework.http.server.reactive.ServerHttpRequest.getPath. Doc from org.springframework.http.server.reactive.ServerHttpRequest.getPath. Returns a structured representation of the full request path up to but not including the `query`. The returned path is subdivided into a `RequestPath#contextPath()` portion and the remaining `pathWithinApplication` portion. The latter can be passed into methods of `org.springframework.web.util.pattern.PathPattern` for path matching purposes. Annotations @Override

public RequestPath getPath()

Implements org.springframework.http.server.reactive.ServerHttpRequest.getPath.

Doc from org.springframework.http.server.reactive.ServerHttpRequest.getPath.

Returns a structured representation of the full request path up to but not including the query.

The returned path is subdivided into a RequestPath#contextPath() portion and the remaining pathWithinApplication portion. The latter can be passed into methods of org.springframework.web.util.pattern.PathPattern for path matching purposes.

Annotations

@Override

getQueryParams	back to summary
public MultiValueMap<String, String> getQueryParams() Implements org.springframework.http.server.reactive.ServerHttpRequest.getQueryParams. Doc from org.springframework.http.server.reactive.ServerHttpRequest.getQueryParams. Return a read-only map with parsed and decoded query parameter values. Annotations @Override

getQueryParams

back to summary

public MultiValueMap<String, String> getQueryParams()

Implements org.springframework.http.server.reactive.ServerHttpRequest.getQueryParams.

Doc from org.springframework.http.server.reactive.ServerHttpRequest.getQueryParams.

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

Annotations

@Override

getRemoteAddress	back to summary
public InetSocketAddress getRemoteAddress() Overrides default org.springframework.http.server.reactive.ServerHttpRequest.getRemoteAddress. Doc from org.springframework.http.server.reactive.ServerHttpRequest.getRemoteAddress. Return the remote address where this request is connected to, if available. Annotations @Override @Nullable

getRemoteAddress

back to summary

public InetSocketAddress getRemoteAddress()

Overrides default org.springframework.http.server.reactive.ServerHttpRequest.getRemoteAddress.

Doc from org.springframework.http.server.reactive.ServerHttpRequest.getRemoteAddress.

Return the remote address where this request is connected to, if available.

Annotations

@Override
@Nullable

getSslInfo back to summary

getSslInfo	back to summary
public SslInfo getSslInfo() Overrides default org.springframework.http.server.reactive.ServerHttpRequest.getSslInfo. Doc from org.springframework.http.server.reactive.ServerHttpRequest.getSslInfo. Return the SSL session information if the request has been transmitted over a secure protocol including SSL certificates, if available. Returns:SslInfo the session information, or `null` if none available Annotations @Override @Nullable

public SslInfo getSslInfo()

Overrides default org.springframework.http.server.reactive.ServerHttpRequest.getSslInfo.

Doc from org.springframework.http.server.reactive.ServerHttpRequest.getSslInfo.

Return the SSL session information if the request has been transmitted over a secure protocol including SSL certificates, if available.

Returns:SslInfo

the session information, or null if none available

Annotations

@Override
@Nullable

getURI back to summary

getURI	back to summary
public URI getURI() Implements org.springframework.http.HttpRequest.getURI. Doc from org.springframework.http.HttpRequest.getURI. Return the URI of the request (including a query string if any, but only if it is well-formed for a URI representation). Returns:URI the URI of the request (never `null`) Annotations @Override

public URI getURI()

Implements org.springframework.http.HttpRequest.getURI.

Doc from org.springframework.http.HttpRequest.getURI.

Return the URI of the request (including a query string if any, but only if it is well-formed for a URI representation).

Returns:URI

the URI of the request (never null)

Annotations

@Override

toString back to summary

toString	back to summary
public String toString() Overrides java.lang.Object.toString. Doc from java.lang.Object.toString. Returns a string representation of the object. Satisfying this method's contract implies a non-`null` result must be returned. Returns:String a string representation of the object Annotations @Override

public String toString()

Overrides java.lang.Object.toString.

Doc from java.lang.Object.toString.

Returns a string representation of the object. Satisfying this method's contract implies a non-null result must be returned.

Returns:String

a string representation of the object

Annotations

@Override

public Class ServerHttpRequestDecorator

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail