Top Description Methods
org.springframework.web.reactive.result.view

public Interface RequestDataValueProcessor

Imports
java.util.Map, org.springframework.lang.Nullable, org.springframework.web.server.ServerWebExchange

A contract for inspecting and potentially modifying request data values such as URL query parameters or form field values before they are rendered by a view or before a redirect.

Implementations may use this contract for example as part of a solution to provide data integrity, confidentiality, protection against cross-site request forgery (CSRF), and others or for other tasks such as automatically adding a hidden field to all forms and URLs.

View technologies that support this contract can obtain an instance to delegate to via RequestContext#getRequestDataValueProcessor().

Author
Rossen Stoyanchev
Since
5.0

Method Summary

Modifier and TypeMethod and Description
public Map<String, String>

Returns:

additional hidden form fields to be added, or null
getExtraHiddenFields
(ServerWebExchange
the current exchange
exchange
)

Invoked after all form fields have been rendered.

public String

Returns:

the action to use, possibly modified
processAction
(ServerWebExchange
the current exchange
exchange
,
String
the form action
action
,
String
the form HTTP method
httpMethod
)

Invoked when a new form action is rendered.

public String

Returns:

the form field value to use, possibly modified
processFormFieldValue
(ServerWebExchange
the current exchange
exchange
,
String
the form field name
name
,
String
the form field value
value
,
String
the form field type ("text", "hidden", etc.)
type
)

Invoked when a form field value is rendered.

public String

Returns:

the URL to use, possibly modified
processUrl
(ServerWebExchange
the current exchange
exchange
,
String
the URL value
url
)

Invoked when a URL is about to be rendered or redirected to.

Method Detail

getExtraHiddenFieldsback to summary
public Map<String, String> getExtraHiddenFields(ServerWebExchange exchange)

Invoked after all form fields have been rendered.

Parameters
exchange:ServerWebExchange

the current exchange

Returns:Map<String, String>

additional hidden form fields to be added, or null

Annotations
@Nullable
processActionback to summary
public String processAction(ServerWebExchange exchange, String action, String httpMethod)

Invoked when a new form action is rendered.

Parameters
exchange:ServerWebExchange

the current exchange

action:String

the form action

httpMethod:String

the form HTTP method

Returns:String

the action to use, possibly modified

processFormFieldValueback to summary
public String processFormFieldValue(ServerWebExchange exchange, String name, String value, String type)

Invoked when a form field value is rendered.

Parameters
exchange:ServerWebExchange

the current exchange

name:String

the form field name

value:String

the form field value

type:String

the form field type ("text", "hidden", etc.)

Returns:String

the form field value to use, possibly modified

processUrlback to summary
public String processUrl(ServerWebExchange exchange, String url)

Invoked when a URL is about to be rendered or redirected to.

Parameters
exchange:ServerWebExchange

the current exchange

url:String

the URL value

Returns:String

the URL to use, possibly modified