public class DefaultServerWebExchange extends java.lang.Object implements ServerWebExchange
ServerWebExchange
.ServerWebExchange.Builder
Modifier and Type | Field and Description |
---|---|
private ApplicationContext |
applicationContext |
private java.util.Map<java.lang.String,java.lang.Object> |
attributes |
private static <any> |
EMPTY_FORM_DATA |
private static <any> |
EMPTY_MULTIPART_DATA |
private static ResolvableType |
FORM_DATA_TYPE |
private <any> |
formDataMono |
private LocaleContextResolver |
localeContextResolver |
private java.lang.Object |
logId |
private java.lang.String |
logPrefix |
private static ResolvableType |
MULTIPART_DATA_TYPE |
private <any> |
multipartDataMono |
private boolean |
notModified |
private ServerHttpRequest |
request |
private ServerHttpResponse |
response |
private static java.util.List<HttpMethod> |
SAFE_METHODS |
private <any> |
sessionMono |
private java.util.function.Function<java.lang.String,java.lang.String> |
urlTransformer |
LOG_ID_ATTRIBUTE
Constructor and Description |
---|
DefaultServerWebExchange(ServerHttpRequest request,
ServerHttpResponse response,
WebSessionManager sessionManager,
ServerCodecConfigurer codecConfigurer,
LocaleContextResolver localeContextResolver) |
DefaultServerWebExchange(ServerHttpRequest request,
ServerHttpResponse response,
WebSessionManager sessionManager,
ServerCodecConfigurer codecConfigurer,
LocaleContextResolver localeContextResolver,
ApplicationContext applicationContext) |
Modifier and Type | Method and Description |
---|---|
void |
addUrlTransformer(java.util.function.Function<java.lang.String,java.lang.String> transformer)
Register an additional URL transformation function for use with
ServerWebExchange.transformUrl(java.lang.String) . |
boolean |
checkNotModified(java.time.Instant lastModified)
An overloaded variant of
ServerWebExchange.checkNotModified(String, Instant) with
a last-modified timestamp only. |
boolean |
checkNotModified(java.lang.String etag)
An overloaded variant of
ServerWebExchange.checkNotModified(String, Instant) with
an ETag (entity tag) value only. |
boolean |
checkNotModified(java.lang.String etag,
java.time.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. |
ApplicationContext |
getApplicationContext()
Return the
ApplicationContext associated with the web application,
if it was initialized with one via
WebHttpHandlerBuilder.applicationContext(ApplicationContext) . |
java.util.Map<java.lang.String,java.lang.Object> |
getAttributes()
Return a mutable map of request attributes for the current exchange.
|
<any> |
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 otherwise. |
LocaleContext |
getLocaleContext()
Return the
LocaleContext using the configured
LocaleContextResolver . |
java.lang.String |
getLogPrefix()
Return a log message prefix to use to correlate messages for this exchange.
|
<any> |
getMultipartData()
Return the parts of a multipart request if the Content-Type is
"multipart/form-data" or an empty map otherwise. |
<T extends java.security.Principal> |
getPrincipal()
Return the authenticated user for the request, if any.
|
ServerHttpRequest |
getRequest()
Return the current HTTP request.
|
private HttpHeaders |
getRequestHeaders() |
ServerHttpResponse |
getResponse()
Return the current HTTP response.
|
private HttpHeaders |
getResponseHeaders() |
<any> |
getSession()
Return the web session for the current request.
|
private static <any> |
initFormData(ServerHttpRequest request,
ServerCodecConfigurer configurer,
java.lang.String logPrefix) |
private static <any> |
initMultipartData(ServerHttpRequest request,
ServerCodecConfigurer configurer,
java.lang.String logPrefix) |
boolean |
isNotModified()
Returns
true if the one of the checkNotModified methods
in this contract were used and they returned true. |
private java.lang.String |
padEtagIfNecessary(java.lang.String etag) |
java.lang.String |
transformUrl(java.lang.String url)
Transform the given url according to the registered transformation function(s).
|
private boolean |
validateIfModifiedSince(java.time.Instant lastModified) |
private boolean |
validateIfNoneMatch(java.lang.String etag) |
private boolean |
validateIfUnmodifiedSince(java.time.Instant lastModified) |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
getAttribute, getAttributeOrDefault, getRequiredAttribute, mutate
private static final java.util.List<HttpMethod> SAFE_METHODS
private static final ResolvableType FORM_DATA_TYPE
private static final ResolvableType MULTIPART_DATA_TYPE
private static final <any> EMPTY_FORM_DATA
private static final <any> EMPTY_MULTIPART_DATA
private final ServerHttpRequest request
private final ServerHttpResponse response
private final java.util.Map<java.lang.String,java.lang.Object> attributes
private final <any> sessionMono
private final LocaleContextResolver localeContextResolver
private final <any> formDataMono
private final <any> multipartDataMono
@Nullable private final ApplicationContext applicationContext
private volatile boolean notModified
private java.util.function.Function<java.lang.String,java.lang.String> urlTransformer
@Nullable private java.lang.Object logId
private java.lang.String logPrefix
public DefaultServerWebExchange(ServerHttpRequest request, ServerHttpResponse response, WebSessionManager sessionManager, ServerCodecConfigurer codecConfigurer, LocaleContextResolver localeContextResolver)
DefaultServerWebExchange(ServerHttpRequest request, ServerHttpResponse response, WebSessionManager sessionManager, ServerCodecConfigurer codecConfigurer, LocaleContextResolver localeContextResolver, @Nullable ApplicationContext applicationContext)
private static <any> initFormData(ServerHttpRequest request, ServerCodecConfigurer configurer, java.lang.String logPrefix)
private static <any> initMultipartData(ServerHttpRequest request, ServerCodecConfigurer configurer, java.lang.String logPrefix)
public ServerHttpRequest getRequest()
ServerWebExchange
getRequest
in interface ServerWebExchange
private HttpHeaders getRequestHeaders()
public ServerHttpResponse getResponse()
ServerWebExchange
getResponse
in interface ServerWebExchange
private HttpHeaders getResponseHeaders()
public java.util.Map<java.lang.String,java.lang.Object> getAttributes()
ServerWebExchange
getAttributes
in interface ServerWebExchange
public <any> getSession()
ServerWebExchange
WebSession
for more details.getSession
in interface ServerWebExchange
public <T extends java.security.Principal> <any> getPrincipal()
ServerWebExchange
getPrincipal
in interface ServerWebExchange
public <any> getFormData()
ServerWebExchange
"application/x-www-form-urlencoded"
or an empty map otherwise.
Note: calling this method causes the request body to
be read and parsed in full and the resulting MultiValueMap
is
cached so that this method is safe to call more than once.
getFormData
in interface ServerWebExchange
public <any> getMultipartData()
ServerWebExchange
"multipart/form-data"
or an empty map otherwise.
Note: calling this method causes the request body to
be read and parsed in full and the resulting MultiValueMap
is
cached so that this method is safe to call more than once.
getMultipartData
in interface ServerWebExchange
public LocaleContext getLocaleContext()
ServerWebExchange
LocaleContext
using the configured
LocaleContextResolver
.getLocaleContext
in interface ServerWebExchange
@Nullable public ApplicationContext getApplicationContext()
ServerWebExchange
ApplicationContext
associated with the web application,
if it was initialized with one via
WebHttpHandlerBuilder.applicationContext(ApplicationContext)
.getApplicationContext
in interface ServerWebExchange
WebHttpHandlerBuilder.applicationContext(ApplicationContext)
public boolean isNotModified()
ServerWebExchange
true
if the one of the checkNotModified
methods
in this contract were used and they returned true.isNotModified
in interface ServerWebExchange
public boolean checkNotModified(java.time.Instant lastModified)
ServerWebExchange
ServerWebExchange.checkNotModified(String, Instant)
with
a last-modified timestamp only.checkNotModified
in interface ServerWebExchange
lastModified
- the last-modified timepublic boolean checkNotModified(java.lang.String etag)
ServerWebExchange
ServerWebExchange.checkNotModified(String, Instant)
with
an ETag
(entity tag) value only.checkNotModified
in interface ServerWebExchange
etag
- the entity tag for the underlying resource.public boolean checkNotModified(@Nullable java.lang.String etag, java.time.Instant lastModified)
ServerWebExchange
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)
.
checkNotModified
in interface ServerWebExchange
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 resourceprivate boolean validateIfUnmodifiedSince(java.time.Instant lastModified)
private boolean validateIfNoneMatch(@Nullable java.lang.String etag)
private java.lang.String padEtagIfNecessary(java.lang.String etag)
private boolean validateIfModifiedSince(java.time.Instant lastModified)
public java.lang.String transformUrl(java.lang.String url)
ServerWebExchange
url
, though additional
transformation functions can by registered with ServerWebExchange.addUrlTransformer(java.util.function.Function<java.lang.String, java.lang.String>)
transformUrl
in interface ServerWebExchange
url
- the URL to transformpublic void addUrlTransformer(java.util.function.Function<java.lang.String,java.lang.String> transformer)
ServerWebExchange
ServerWebExchange.transformUrl(java.lang.String)
.
The given function can be used to insert an id for authentication, a nonce for CSRF
protection, etc.
Note that the given function is applied after any previously registered functions.
addUrlTransformer
in interface ServerWebExchange
transformer
- a URL transformation function to addpublic java.lang.String getLogPrefix()
ServerWebExchange
ServerWebExchange.LOG_ID_ATTRIBUTE
along with some extra formatting so that the prefix can be conveniently
prepended with no further formatting no separators required.getLogPrefix
in interface ServerWebExchange
ServerWebExchange.LOG_ID_ATTRIBUTE
is not set.