org.springframework.web.server.adapter

Class DefaultServerWebExchange

java.lang.Object

org.springframework.web.server.adapter.DefaultServerWebExchange

All Implemented Interfaces:

ServerWebExchange

public class DefaultServerWebExchange
extends Object
implements ServerWebExchange

Default implementation of ServerWebExchange.

Since:

5.0

Author:

Rossen Stoyanchev

Nested Class Summary

Nested classes/interfaces inherited from interface org.springframework.web.server.ServerWebExchange

ServerWebExchange.Builder

Constructor Summary

Constructors

Constructor and Description
DefaultServerWebExchange(ServerHttpRequest request, ServerHttpResponse response, WebSessionManager sessionManager)

Method Summary

Modifier and Type	Method and Description
boolean	checkNotModified(Instant lastModified) An overloaded variant of ServerWebExchange.checkNotModified(String, Instant) with a last-modified timestamp only.
boolean	checkNotModified(String etag) An overloaded variant of ServerWebExchange.checkNotModified(String, Instant) with an ETag (entity tag) value only.
boolean	checkNotModified(String etag, Instant lastModified) Check whether the requested resource has been modified given the supplied ETag (entity tag) and last-modified timestamp as determined by the application.
<T> Optional<T>	getAttribute(String name) Return the request attribute value if present.
Map<String,Object>	getAttributes() Return a mutable map of request attributes for the current exchange.
reactor.core.publisher.Mono<org.springframework.util.MultiValueMap<String,String>>	getFormData() Return the form data from the body of the request if the Content-Type is "application/x-www-form-urlencoded" or an empty map.
<T extends Principal> reactor.core.publisher.Mono<T>	getPrincipal() Return the authenticated user for the request, if any.
ServerHttpRequest	getRequest() Return the current HTTP request.
reactor.core.publisher.Mono<org.springframework.util.MultiValueMap<String,String>>	getRequestParams() Return a combined map that represents both ServerHttpRequest.getQueryParams() and ServerWebExchange.getFormData() or an empty map.
ServerHttpResponse	getResponse() Return the current HTTP response.
reactor.core.publisher.Mono<WebSession>	getSession() Return the web session for the current request.
boolean	isNotModified() Returns true if the one of the checkNotModified methods in this contract were used and they returned true.

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.springframework.web.server.ServerWebExchange

mutate

Constructor Detail

DefaultServerWebExchange

public DefaultServerWebExchange(ServerHttpRequest request,
                                ServerHttpResponse response,
                                WebSessionManager sessionManager)

Method Detail

getRequest

public ServerHttpRequest getRequest()

Description copied from interface: ServerWebExchange

Return the current HTTP request.

Specified by:

getRequest in interface ServerWebExchange

getResponse

public ServerHttpResponse getResponse()

Description copied from interface: ServerWebExchange

Return the current HTTP response.

Specified by:

getResponse in interface ServerWebExchange

getAttributes

public Map<String,Object> getAttributes()

Description copied from interface: ServerWebExchange

Return a mutable map of request attributes for the current exchange.

Specified by:

getAttributes in interface ServerWebExchange

getAttribute

public <T> Optional<T> getAttribute(String name)

Description copied from interface: ServerWebExchange

Return the request attribute value if present.

Specified by:

getAttribute in interface ServerWebExchange

Type Parameters:

T - the attribute type

Parameters:

name - the attribute name

Returns:

the attribute value

getSession

public reactor.core.publisher.Mono<WebSession> getSession()

Description copied from interface: ServerWebExchange

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. See WebSession for more details.

Specified by:

getSession in interface ServerWebExchange

getPrincipal

public <T extends Principal> reactor.core.publisher.Mono<T> getPrincipal()

Description copied from interface: ServerWebExchange

Return the authenticated user for the request, if any.

Specified by:

getPrincipal in interface ServerWebExchange

getFormData

public reactor.core.publisher.Mono<org.springframework.util.MultiValueMap<String,String>> getFormData()

Description copied from interface: ServerWebExchange

Return the form data from the body of the request if the Content-Type is "application/x-www-form-urlencoded" or an empty map.

Specified by:

getFormData in interface ServerWebExchange

getRequestParams

public reactor.core.publisher.Mono<org.springframework.util.MultiValueMap<String,String>> getRequestParams()

Description copied from interface: ServerWebExchange

Return a combined map that represents both ServerHttpRequest.getQueryParams() and ServerWebExchange.getFormData() or an empty map.

Specified by:

getRequestParams in interface ServerWebExchange

isNotModified

public boolean isNotModified()

Description copied from interface: ServerWebExchange

Returns true if the one of the checkNotModified methods in this contract were used and they returned true.

Specified by:

isNotModified in interface ServerWebExchange

checkNotModified

public boolean checkNotModified(Instant lastModified)

Description copied from interface: ServerWebExchange

An overloaded variant of ServerWebExchange.checkNotModified(String, Instant) with a last-modified timestamp only.

Specified by:

checkNotModified in interface ServerWebExchange

Parameters:

lastModified - the last-modified time

Returns:

whether the request qualifies as not modified

checkNotModified

public boolean checkNotModified(String etag)

Description copied from interface: ServerWebExchange

An overloaded variant of ServerWebExchange.checkNotModified(String, Instant) with an ETag (entity tag) value only.

Specified by:

checkNotModified in interface ServerWebExchange

Parameters:

etag - the entity tag for the underlying resource.

Returns:

true if the request does not require further processing.

checkNotModified

public boolean checkNotModified(String etag,
                                Instant lastModified)

Description copied from interface: ServerWebExchange

Check whether the requested resource has been modified given the supplied ETag (entity tag) and last-modified timestamp as determined by the application. Also transparently prepares the response, setting HTTP status, and adding "ETag" and "Last-Modified" headers when applicable. This method works with conditional GET/HEAD requests as well as with conditional POST/PUT/DELETE requests.

Note: The HTTP specification recommends setting both ETag and Last-Modified values, but you can also use #checkNotModified(String) or ServerWebExchange.checkNotModified(Instant).

Specified by:

checkNotModified in interface ServerWebExchange

Parameters:

etag - the entity tag that the application determined for the underlying resource. This parameter will be padded with quotes (") if necessary.

lastModified - the last-modified timestamp that the application determined for the underlying resource

Returns:

true if the request does not require further processing.