Spring Framework 6.1.4 · org.springframework.web.reactive.result.view.RequestContext

Modifier and Type	Field and Description
private final RequestDataValueProcessor	dataValueProcessor
private Boolean	defaultHtmlEscape
private Map<String, Errors>	errorsMap
private final ServerWebExchange	exchange
private Locale	locale
private final MessageSource	messageSource
private final Map<String, Object>	model
private TimeZone	timeZone

Access	Constructor and Description
public	RequestContext(ServerWebExchange exchange, Map<String, Object> model, MessageSource messageSource)
public	RequestContext(ServerWebExchange exchange, Map<String, Object> model, MessageSource messageSource, RequestDataValueProcessor dataValueProcessor)

Method Summary

Modifier and Type	Method and Description
public void	changeLocale(Locale locale) Change the current locale to the specified one.
public void	changeLocale(Locale locale, TimeZone timeZone) Change the current locale to the specified locale and time zone context.
public BindStatus	Returns: the new BindStatus instance getBindStatus(String the bean and property path for which values and errors will be resolved (e.g. "person.age") path) Create a BindStatus for the given bind object using the "defaultHtmlEscape" setting.
public BindStatus	Returns: the new BindStatus instance getBindStatus(String the bean and property path for which values and errors will be resolved (e.g. "person.age") path, boolean create a BindStatus with automatic HTML escaping? htmlEscape) Create a BindStatus for the given bind object, using the "defaultHtmlEscape" setting.
public String	getContextPath() Return the context path of the current web application.
public String	Returns: a URL that points back to the current web application with an absolute path also URL-encoded accordingly getContextUrl(String the relative URL part relativeUrl) Return a context-aware URl for the given relative URL.
public String	Returns: a URL that points back to the current web application with an absolute path also URL-encoded accordingly getContextUrl(String the relative URL part relativeUrl, Map<String, ?> a map of parameters to insert as placeholders in the url params) Return a context-aware URl for the given relative URL with placeholders -- named keys with braces `{}`.
public Boolean	Returns: whether default HTML escaping is enabled (null = no explicit default) getDefaultHtmlEscape() Return the default HTML escape setting, differentiating between no default specified and an explicit value.
public Errors	Returns: the Errors instance, or `null` if not found getErrors(String the name of the bind object name) Retrieve the Errors instance for the given bind object, using the "defaultHtmlEscape" setting.
public Errors	Returns: the Errors instance, or `null` if not found getErrors(String the name of the bind object name, boolean create an Errors instance with automatic HTML escaping? htmlEscape) Retrieve the Errors instance for the given bind object.
protected final ServerWebExchange	getExchange()
public final Locale	getLocale() Return the current Locale.
public String	Returns: the message getMessage(String the code of the message code, String the String to return if the lookup fails defaultMessage) Retrieve the message for the given code, using the "defaultHtmlEscape" setting.
public String	Returns: the message getMessage(String the code of the message code, Object[] arguments for the message, or `null` if none args, String the String to return if the lookup fails defaultMessage) Retrieve the message for the given code, using the "defaultHtmlEscape" setting.
public String	Returns: the message getMessage(String the code of the message code, List<?> arguments for the message as a List, or `null` if none args, String the String to return if the lookup fails defaultMessage) Retrieve the message for the given code, using the "defaultHtmlEscape" setting.
public String	Returns: the message getMessage(String the code of the message code, Object[] arguments for the message, or `null` if none args, String the String to return if the lookup fails defaultMessage, boolean if the message should be HTML-escaped htmlEscape) Retrieve the message for the given code.
public String	Returns: the message getMessage(String the code of the message code) Retrieve the message for the given code, using the "defaultHtmlEscape" setting.
public String	Returns: the message getMessage(String the code of the message code, Object[] arguments for the message, or `null` if none args) Retrieve the message for the given code, using the "defaultHtmlEscape" setting.
public String	Returns: the message getMessage(String the code of the message code, List<?> arguments for the message as a List, or `null` if none args) Retrieve the message for the given code, using the "defaultHtmlEscape" setting.
public String	Returns: the message getMessage(String the code of the message code, Object[] arguments for the message, or `null` if none args, boolean if the message should be HTML-escaped htmlEscape) Retrieve the message for the given code.
public String	Returns: the message getMessage(MessageSourceResolvable the MessageSourceResolvable resolvable) Retrieve the given MessageSourceResolvable (e.g. an ObjectError instance), using the "defaultHtmlEscape" setting.
public String	Returns: the message getMessage(MessageSourceResolvable the MessageSourceResolvable resolvable, boolean if the message should be HTML-escaped htmlEscape) Retrieve the given MessageSourceResolvable (e.g. an ObjectError instance).
public MessageSource	getMessageSource() Return the MessageSource in use with this request.
public Map<String, Object>	Returns: the populated model Map, or `null` if none available getModel() Return the model Map that this RequestContext encapsulates, if any.
protected <T> T	Returns: the model object getModelObject(String the name of the model object modelName) Retrieve the model object for the given model name, either from the model or from the request attributes.
public String	getQueryString() Return the query string of the current request.
public RequestDataValueProcessor	getRequestDataValueProcessor() Return the `RequestDataValueProcessor` instance to apply to in form tag libraries and to redirect URLs.
public String	getRequestPath() Return the request path of the request.
public TimeZone	getTimeZone() Return the current TimeZone.
public boolean	isDefaultHtmlEscape() Is default HTML escaping active?
public void	setDefaultHtmlEscape(boolean defaultHtmlEscape) (De)activate default HTML escaping for messages and errors, for the scope of this RequestContext.

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

dataValueProcessor	back to summary
private final RequestDataValueProcessor dataValueProcessor Annotations @Nullable

defaultHtmlEscape	back to summary
private Boolean defaultHtmlEscape Annotations @Nullable

errorsMap	back to summary
private Map<String, Errors> errorsMap Annotations @Nullable

exchange	back to summary
private final ServerWebExchange exchange

locale	back to summary
private Locale locale

messageSource	back to summary
private final MessageSource messageSource

model	back to summary
private final Map<String, Object> model

timeZone	back to summary
private TimeZone timeZone

RequestContext	back to summary
public RequestContext(ServerWebExchange exchange, Map<String, Object> model, MessageSource messageSource)

RequestContext	back to summary
public RequestContext(ServerWebExchange exchange, Map<String, Object> model, MessageSource messageSource, RequestDataValueProcessor dataValueProcessor)

Method Detail

changeLocale	back to summary
public void changeLocale(Locale locale) Change the current locale to the specified one.

changeLocale	back to summary
public void changeLocale(Locale locale, TimeZone timeZone) Change the current locale to the specified locale and time zone context.

getBindStatus	back to summary
public BindStatus getBindStatus(String path) throws IllegalStateException Create a BindStatus for the given bind object using the "defaultHtmlEscape" setting. Parameters path:String the bean and property path for which values and errors will be resolved (e.g. "person.age") Returns:BindStatus the new BindStatus instance Exceptions IllegalStateException: if no corresponding Errors object found

getBindStatus

back to summary

public BindStatus getBindStatus(String path) throws IllegalStateException

Create a BindStatus for the given bind object using the "defaultHtmlEscape" setting.

Parameters

path:String: the bean and property path for which values and errors will be resolved (e.g. "person.age")

Returns:BindStatus

the new BindStatus instance

Exceptions

IllegalStateException:: if no corresponding Errors object found

getBindStatus	back to summary
public BindStatus getBindStatus(String path, boolean htmlEscape) throws IllegalStateException Create a BindStatus for the given bind object, using the "defaultHtmlEscape" setting. Parameters path:String the bean and property path for which values and errors will be resolved (e.g. "person.age") htmlEscape:boolean create a BindStatus with automatic HTML escaping? Returns:BindStatus the new BindStatus instance Exceptions IllegalStateException: if no corresponding Errors object found

getBindStatus

back to summary

public BindStatus getBindStatus(String path, boolean htmlEscape) throws IllegalStateException

Create a BindStatus for the given bind object, using the "defaultHtmlEscape" setting.

Parameters

path:String: the bean and property path for which values and errors will be resolved (e.g. "person.age")
htmlEscape:boolean: create a BindStatus with automatic HTML escaping?

Returns:BindStatus

the new BindStatus instance

Exceptions

IllegalStateException:: if no corresponding Errors object found

getContextPath back to summary

getContextPath	back to summary
public String getContextPath() Return the context path of the current web application. This is useful for building links to other resources within the application. Delegates to `ServerHttpRequest#getPath()`.

public String getContextPath()

Return the context path of the current web application. This is useful for building links to other resources within the application.

Delegates to ServerHttpRequest#getPath().

getContextUrl	back to summary
public String getContextUrl(String relativeUrl) Return a context-aware URl for the given relative URL. Parameters relativeUrl:String the relative URL part Returns:String a URL that points back to the current web application with an absolute path also URL-encoded accordingly

getContextUrl

back to summary

public String getContextUrl(String relativeUrl)

Return a context-aware URl for the given relative URL.

Parameters

relativeUrl:String: the relative URL part

Returns:String

a URL that points back to the current web application with an absolute path also URL-encoded accordingly

getContextUrl back to summary

getContextUrl	back to summary
public String getContextUrl(String relativeUrl, Map<String, ?> params) Return a context-aware URl for the given relative URL with placeholders -- named keys with braces `{}`. For example, send in a relative URL `foo/{bar}?spam={spam}` and a parameter map `{bar=baz,spam=nuts}` and the result will be `[contextpath]/foo/baz?spam=nuts`. Parameters relativeUrl:String the relative URL part params:Map<String, ?> a map of parameters to insert as placeholders in the url Returns:String a URL that points back to the current web application with an absolute path also URL-encoded accordingly

public String getContextUrl(String relativeUrl, Map<String, ?> params)

Return a context-aware URl for the given relative URL with placeholders -- named keys with braces {}. For example, send in a relative URL foo/{bar}?spam={spam} and a parameter map {bar=baz,spam=nuts} and the result will be [contextpath]/foo/baz?spam=nuts.

Parameters

relativeUrl:String: the relative URL part
params:Map<String, ?>: a map of parameters to insert as placeholders in the url

Returns:String

a URL that points back to the current web application with an absolute path also URL-encoded accordingly

getDefaultHtmlEscape	back to summary
public Boolean getDefaultHtmlEscape() Return the default HTML escape setting, differentiating between no default specified and an explicit value. Returns:Boolean whether default HTML escaping is enabled (null = no explicit default) Annotations @Nullable

getDefaultHtmlEscape

back to summary

public Boolean getDefaultHtmlEscape()

Return the default HTML escape setting, differentiating between no default specified and an explicit value.

Returns:Boolean

whether default HTML escaping is enabled (null = no explicit default)

Annotations

@Nullable

getErrors back to summary

getErrors	back to summary
public Errors getErrors(String name) Retrieve the Errors instance for the given bind object, using the "defaultHtmlEscape" setting. Parameters name:String the name of the bind object Returns:Errors the Errors instance, or `null` if not found Annotations @Nullable

public Errors getErrors(String name)

Retrieve the Errors instance for the given bind object, using the "defaultHtmlEscape" setting.

Parameters

name:String: the name of the bind object

Returns:Errors

the Errors instance, or null if not found

Annotations

@Nullable

getErrors back to summary

getErrors	back to summary
public Errors getErrors(String name, boolean htmlEscape) Retrieve the Errors instance for the given bind object. Parameters name:String the name of the bind object htmlEscape:boolean create an Errors instance with automatic HTML escaping? Returns:Errors the Errors instance, or `null` if not found Annotations @Nullable

public Errors getErrors(String name, boolean htmlEscape)

Retrieve the Errors instance for the given bind object.

Parameters

name:String: the name of the bind object
htmlEscape:boolean: create an Errors instance with automatic HTML escaping?

Returns:Errors

the Errors instance, or null if not found

Annotations

@Nullable

getExchange	back to summary
protected final ServerWebExchange getExchange()

getLocale	back to summary
public final Locale getLocale() Return the current Locale.

getMessage	back to summary
public String getMessage(String code, String defaultMessage) Retrieve the message for the given code, using the "defaultHtmlEscape" setting. Parameters code:String the code of the message defaultMessage:String the String to return if the lookup fails Returns:String the message

getMessage

back to summary

public String getMessage(String code, String defaultMessage)

Retrieve the message for the given code, using the "defaultHtmlEscape" setting.

Parameters

code:String: the code of the message
defaultMessage:String: the String to return if the lookup fails

Returns:String

the message

getMessage back to summary

getMessage	back to summary
public String getMessage(String code, Object[] args, String defaultMessage) Retrieve the message for the given code, using the "defaultHtmlEscape" setting. Parameters code:String the code of the message args:Object[] arguments for the message, or `null` if none defaultMessage:String the String to return if the lookup fails Returns:String the message

public String getMessage(String code, Object[] args, String defaultMessage)

Retrieve the message for the given code, using the "defaultHtmlEscape" setting.

Parameters

code:String: the code of the message
args:Object[]: arguments for the message, or null if none
defaultMessage:String: the String to return if the lookup fails

Returns:String

the message

getMessage back to summary

getMessage	back to summary
public String getMessage(String code, List<?> args, String defaultMessage) Retrieve the message for the given code, using the "defaultHtmlEscape" setting. Parameters code:String the code of the message args:List<?> arguments for the message as a List, or `null` if none defaultMessage:String the String to return if the lookup fails Returns:String the message

public String getMessage(String code, List<?> args, String defaultMessage)

Retrieve the message for the given code, using the "defaultHtmlEscape" setting.

Parameters

code:String: the code of the message
args:List<?>: arguments for the message as a List, or null if none
defaultMessage:String: the String to return if the lookup fails

Returns:String

the message

getMessage back to summary

getMessage	back to summary
public String getMessage(String code, Object[] args, String defaultMessage, boolean htmlEscape) Retrieve the message for the given code. Parameters code:String the code of the message args:Object[] arguments for the message, or `null` if none defaultMessage:String the String to return if the lookup fails htmlEscape:boolean if the message should be HTML-escaped Returns:String the message

public String getMessage(String code, Object[] args, String defaultMessage, boolean htmlEscape)

Retrieve the message for the given code.

Parameters

code:String: the code of the message
args:Object[]: arguments for the message, or null if none
defaultMessage:String: the String to return if the lookup fails
htmlEscape:boolean: if the message should be HTML-escaped

Returns:String

the message

getMessage	back to summary
public String getMessage(String code) throws NoSuchMessageException Retrieve the message for the given code, using the "defaultHtmlEscape" setting. Parameters code:String the code of the message Returns:String the message Exceptions NoSuchMessageException: if not found

getMessage

back to summary

public String getMessage(String code) throws NoSuchMessageException

Retrieve the message for the given code, using the "defaultHtmlEscape" setting.

Parameters

code:String: the code of the message

Returns:String

the message

Exceptions

NoSuchMessageException:: if not found

getMessage back to summary

getMessage	back to summary
public String getMessage(String code, Object[] args) throws NoSuchMessageException Retrieve the message for the given code, using the "defaultHtmlEscape" setting. Parameters code:String the code of the message args:Object[] arguments for the message, or `null` if none Returns:String the message Exceptions NoSuchMessageException: if not found

public String getMessage(String code, Object[] args) throws NoSuchMessageException

Retrieve the message for the given code, using the "defaultHtmlEscape" setting.

Parameters

code:String: the code of the message
args:Object[]: arguments for the message, or null if none

Returns:String

the message

Exceptions

NoSuchMessageException:: if not found

getMessage back to summary

getMessage	back to summary
public String getMessage(String code, List<?> args) throws NoSuchMessageException Retrieve the message for the given code, using the "defaultHtmlEscape" setting. Parameters code:String the code of the message args:List<?> arguments for the message as a List, or `null` if none Returns:String the message Exceptions NoSuchMessageException: if not found

public String getMessage(String code, List<?> args) throws NoSuchMessageException

Retrieve the message for the given code, using the "defaultHtmlEscape" setting.

Parameters

code:String: the code of the message
args:List<?>: arguments for the message as a List, or null if none

Returns:String

the message

Exceptions

NoSuchMessageException:: if not found

getMessage back to summary

getMessage	back to summary
public String getMessage(String code, Object[] args, boolean htmlEscape) throws NoSuchMessageException Retrieve the message for the given code. Parameters code:String the code of the message args:Object[] arguments for the message, or `null` if none htmlEscape:boolean if the message should be HTML-escaped Returns:String the message Exceptions NoSuchMessageException: if not found

public String getMessage(String code, Object[] args, boolean htmlEscape) throws NoSuchMessageException

Retrieve the message for the given code.

Parameters

code:String: the code of the message
args:Object[]: arguments for the message, or null if none
htmlEscape:boolean: if the message should be HTML-escaped

Returns:String

the message

Exceptions

NoSuchMessageException:: if not found

getMessage	back to summary
public String getMessage(MessageSourceResolvable resolvable) throws NoSuchMessageException Retrieve the given MessageSourceResolvable (e.g. an ObjectError instance), using the "defaultHtmlEscape" setting. Parameters resolvable:MessageSourceResolvable the MessageSourceResolvable Returns:String the message Exceptions NoSuchMessageException: if not found

getMessage

back to summary

public String getMessage(MessageSourceResolvable resolvable) throws NoSuchMessageException

Retrieve the given MessageSourceResolvable (e.g. an ObjectError instance), using the "defaultHtmlEscape" setting.

Parameters

resolvable:MessageSourceResolvable: the MessageSourceResolvable

Returns:String

the message

Exceptions

NoSuchMessageException:: if not found

getMessage	back to summary
public String getMessage(MessageSourceResolvable resolvable, boolean htmlEscape) throws NoSuchMessageException Retrieve the given MessageSourceResolvable (e.g. an ObjectError instance). Parameters resolvable:MessageSourceResolvable the MessageSourceResolvable htmlEscape:boolean if the message should be HTML-escaped Returns:String the message Exceptions NoSuchMessageException: if not found

getMessage

back to summary

public String getMessage(MessageSourceResolvable resolvable, boolean htmlEscape) throws NoSuchMessageException

Retrieve the given MessageSourceResolvable (e.g. an ObjectError instance).

Parameters

resolvable:MessageSourceResolvable: the MessageSourceResolvable
htmlEscape:boolean: if the message should be HTML-escaped

Returns:String

the message

Exceptions

NoSuchMessageException:: if not found

getMessageSource	back to summary
public MessageSource getMessageSource() Return the MessageSource in use with this request.

getModel back to summary

getModel	back to summary
public Map<String, Object> getModel() Return the model Map that this RequestContext encapsulates, if any. Returns:Map<String, Object> the populated model Map, or `null` if none available Annotations @Nullable

public Map<String, Object> getModel()

Return the model Map that this RequestContext encapsulates, if any.

Returns:Map<String, Object>

the populated model Map, or null if none available

Annotations

@Nullable

getModelObject	back to summary
protected <T> T getModelObject(String modelName) Retrieve the model object for the given model name, either from the model or from the request attributes. Parameters modelName:String the name of the model object Returns:T the model object Annotations @SuppressWarnings:unchecked @Nullable

getModelObject

back to summary

protected <T> T getModelObject(String modelName)

Retrieve the model object for the given model name, either from the model or from the request attributes.

Parameters

modelName:String: the name of the model object

Returns:T

the model object

Annotations

@SuppressWarnings:unchecked
@Nullable

getQueryString	back to summary
public String getQueryString() Return the query string of the current request. This is useful for building an HTML form action target in combination with the original request path.

getRequestDataValueProcessor back to summary

getRequestDataValueProcessor	back to summary
public RequestDataValueProcessor getRequestDataValueProcessor() Return the `RequestDataValueProcessor` instance to apply to in form tag libraries and to redirect URLs. Annotations @Nullable

public RequestDataValueProcessor getRequestDataValueProcessor()

Return the RequestDataValueProcessor instance to apply to in form tag libraries and to redirect URLs.

Annotations

@Nullable

getRequestPath	back to summary
public String getRequestPath() Return the request path of the request. This is useful as HTML form action target, also in combination with the original query string.

getTimeZone	back to summary
public TimeZone getTimeZone() Return the current TimeZone.

isDefaultHtmlEscape	back to summary
public boolean isDefaultHtmlEscape() Is default HTML escaping active? Falls back to `false` in case of no explicit default given.

setDefaultHtmlEscape	back to summary
public void setDefaultHtmlEscape(boolean defaultHtmlEscape) (De)activate default HTML escaping for messages and errors, for the scope of this RequestContext. Todo currently no application-wide setting ...

public Class RequestContext

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail