org.springframework.web.reactive.function.server

Class RequestPredicates.SubPathServerRequestWrapper

java.lang.Object

org.springframework.web.reactive.function.server.RequestPredicates.SubPathServerRequestWrapper

All Implemented Interfaces:

ServerRequest

Enclosing class:

RequestPredicates

private static class RequestPredicates.SubPathServerRequestWrapper
extends java.lang.Object
implements ServerRequest

Nested Class Summary

Nested classes/interfaces inherited from interface org.springframework.web.reactive.function.server.ServerRequest

ServerRequest.Headers

Field Summary

Fields

Modifier and Type	Field and Description
private ServerRequest	request
private java.lang.String	subPath

Constructor Summary

Constructors

Constructor and Description
SubPathServerRequestWrapper(ServerRequest request, java.lang.String subPath)

Method Summary

Modifier and Type	Method and Description
<T> java.util.Optional<T>	attribute(java.lang.String name) Return the request attribute value if present.
java.util.Map<java.lang.String,java.lang.Object>	attributes() Return a mutable map of request attributes.
<T> T	body(BodyExtractor<T,? super ServerHttpRequest> extractor) Extract the body with the given BodyExtractor.
<T> T	body(BodyExtractor<T,? super ServerHttpRequest> extractor, java.util.Map<java.lang.String,java.lang.Object> hints) Extract the body with the given BodyExtractor and hints.
<T> <any>	bodyToFlux(java.lang.Class<? extends T> elementClass) Extract the body to a Flux.
<T> <any>	bodyToMono(java.lang.Class<? extends T> elementClass) Extract the body to a Mono.
ServerRequest.Headers	headers() Return the headers of this request.
HttpMethod	method() Return the HTTP method.
java.lang.String	path() Return the request path.
java.lang.String	pathVariable(java.lang.String name) Return the path variable with the given name, if present.
java.util.Map<java.lang.String,java.lang.String>	pathVariables() Return all path variables.
java.util.Optional<java.lang.String>	queryParam(java.lang.String name) Return the first query parameter with the given name, if present.
java.util.List<java.lang.String>	queryParams(java.lang.String name) Return all query parameter with the given name.
<any>	session() Return the web session for the current request.
java.lang.String	toString()
java.net.URI	uri() Return the request URI.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

request

private final ServerRequest request

subPath

private final java.lang.String subPath

Constructor Detail

SubPathServerRequestWrapper

public SubPathServerRequestWrapper(ServerRequest request,
                                   java.lang.String subPath)

Method Detail

method

public HttpMethod method()

Description copied from interface: ServerRequest

Return the HTTP method.

Specified by:

method in interface ServerRequest

uri

public java.net.URI uri()

Description copied from interface: ServerRequest

Return the request URI.

Specified by:

uri in interface ServerRequest

path

public java.lang.String path()

Description copied from interface: ServerRequest

Return the request path.

Specified by:

path in interface ServerRequest

headers

public ServerRequest.Headers headers()

Description copied from interface: ServerRequest

Return the headers of this request.

Specified by:

headers in interface ServerRequest

body

public <T> T body(BodyExtractor<T,? super ServerHttpRequest> extractor)

Description copied from interface: ServerRequest

Extract the body with the given BodyExtractor.

Specified by:

body in interface ServerRequest

Type Parameters:

T - the type of the body returned

Parameters:

extractor - the BodyExtractor that reads from the request

Returns:

the extracted body

See Also:

ServerRequest.body(BodyExtractor, Map)

body

public <T> T body(BodyExtractor<T,? super ServerHttpRequest> extractor,
                  java.util.Map<java.lang.String,java.lang.Object> hints)

Description copied from interface: ServerRequest

Extract the body with the given BodyExtractor and hints.

Specified by:

body in interface ServerRequest

Type Parameters:

T - the type of the body returned

Parameters:

extractor - the BodyExtractor that reads from the request

hints - the map of hints like AbstractJackson2Codec.JSON_VIEW_HINT to use to customize body extraction

Returns:

the extracted body

bodyToMono

public <T> <any> bodyToMono(java.lang.Class<? extends T> elementClass)

Description copied from interface: ServerRequest

Extract the body to a Mono.

Specified by:

bodyToMono in interface ServerRequest

Type Parameters:

T - the element type

Parameters:

elementClass - the class of element in the Mono

Returns:

the body as a mono

bodyToFlux

public <T> <any> bodyToFlux(java.lang.Class<? extends T> elementClass)

Description copied from interface: ServerRequest

Extract the body to a Flux.

Specified by:

bodyToFlux in interface ServerRequest

Type Parameters:

T - the element type

Parameters:

elementClass - the class of element in the Flux

Returns:

the body as a flux

attribute

public <T> java.util.Optional<T> attribute(java.lang.String name)

Description copied from interface: ServerRequest

Return the request attribute value if present.

Specified by:

attribute in interface ServerRequest

Type Parameters:

T - the attribute type

Parameters:

name - the attribute name

Returns:

the attribute value

attributes

public java.util.Map<java.lang.String,java.lang.Object> attributes()

Description copied from interface: ServerRequest

Return a mutable map of request attributes.

Specified by:

attributes in interface ServerRequest

Returns:

the request attributes

queryParam

public java.util.Optional<java.lang.String> queryParam(java.lang.String name)

Description copied from interface: ServerRequest

Return the first query parameter with the given name, if present.

Specified by:

queryParam in interface ServerRequest

Parameters:

name - the parameter name

Returns:

the parameter value

queryParams

public java.util.List<java.lang.String> queryParams(java.lang.String name)

Description copied from interface: ServerRequest

Return all query parameter with the given name.

Returns an empty list if no values could be found.

Specified by:

queryParams in interface ServerRequest

Parameters:

name - the parameter name

Returns:

the parameter values

pathVariable

public java.lang.String pathVariable(java.lang.String name)

Description copied from interface: ServerRequest

Return the path variable with the given name, if present.

Specified by:

pathVariable in interface ServerRequest

Parameters:

name - the variable name

Returns:

the variable value

pathVariables

public java.util.Map<java.lang.String,java.lang.String> pathVariables()

Description copied from interface: ServerRequest

Return all path variables.

Specified by:

pathVariables in interface ServerRequest

Returns:

the path variables

session

public <any> session()

Description copied from interface: ServerRequest

Return the web session for the current request. Always guaranteed to return an instance either matching to the session id requested by the client, or with a new session id either because the client did not specify one or because the underlying session had expired. Use of this method does not automatically create a session.

Specified by:

session in interface ServerRequest

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object