Class ServletCookieValueMethodArgumentResolver

java.lang.Object

org.springframework.web.method.annotation.AbstractNamedValueMethodArgumentResolver

org.springframework.web.method.annotation.AbstractCookieValueMethodArgumentResolver

org.springframework.web.servlet.mvc.method.annotation.ServletCookieValueMethodArgumentResolver

All Implemented Interfaces:

HandlerMethodArgumentResolver

public class ServletCookieValueMethodArgumentResolver
extends AbstractCookieValueMethodArgumentResolver

An AbstractCookieValueMethodArgumentResolver that resolves cookie values from an HttpServletRequest.

Since:

3.1

Author:

Rossen Stoyanchev

Nested Class Summary

Nested classes/interfaces inherited from class org.springframework.web.method.annotation.AbstractNamedValueMethodArgumentResolver

AbstractNamedValueMethodArgumentResolver.NamedValueInfo

Constructor Summary

Constructors

Constructor	Description
ServletCookieValueMethodArgumentResolver(@Nullable ConfigurableBeanFactory beanFactory)

Method Summary

Modifier and Type	Method	Description
protected @Nullable Object	resolveName(String cookieName, MethodParameter parameter, NativeWebRequest webRequest)	Resolve the given parameter type and value name into an argument value.
void	setUrlDecode(boolean urlDecode)	Whether to apply URL decoding to cookie values via UrlPathHelper.decodeRequestString(HttpServletRequest, String).
void	setUrlPathHelper(UrlPathHelper urlPathHelper)	Deprecated, for removal: This API element is subject to removal in a future version. use of PathMatcher and UrlPathHelper is deprecated for use at runtime in web modules in favor of parsed patterns with PathPatternParser.

Methods inherited from class org.springframework.web.method.annotation.AbstractCookieValueMethodArgumentResolver

createNamedValueInfo, handleMissingValue, handleMissingValueAfterConversion, supportsParameter

Methods inherited from class org.springframework.web.method.annotation.AbstractNamedValueMethodArgumentResolver

handleMissingValue, handleResolvedValue, resolveArgument

Methods inherited from class java.lang.Object

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

Constructor Details

ServletCookieValueMethodArgumentResolver

public ServletCookieValueMethodArgumentResolver(@Nullable ConfigurableBeanFactory beanFactory)

Method Details

setUrlDecode

public void setUrlDecode(boolean urlDecode)

Whether to apply URL decoding to cookie values via UrlPathHelper.decodeRequestString(HttpServletRequest, String). A shortcut for doing the same by setting a UrlPathHelper with its urlDecode property set accordingly.

By default, set to "true" in which case cookie values are decoded.

Since:

6.1.2

setUrlPathHelper

@Deprecated(since="7.0",
            forRemoval=true)
public void setUrlPathHelper(UrlPathHelper urlPathHelper)

Deprecated, for removal: This API element is subject to removal in a future version.

use of PathMatcher and UrlPathHelper is deprecated for use at runtime in web modules in favor of parsed patterns with PathPatternParser.

Set the UrlPathHelper to use to decode cookie values with via UrlPathHelper.decodeRequestString(HttpServletRequest, String). For most cases you can use setUrlDecode(boolean) instead.

resolveName

protected @Nullable Object resolveName(String cookieName,
 MethodParameter parameter,
 NativeWebRequest webRequest)
                                throws Exception

Description copied from class: AbstractNamedValueMethodArgumentResolver

Resolve the given parameter type and value name into an argument value.

Specified by:

resolveName in class AbstractNamedValueMethodArgumentResolver

Parameters:

cookieName - the name of the value being resolved

parameter - the method parameter to resolve to an argument value (pre-nested in case of a Optional declaration)

webRequest - the current request

Returns:

the resolved argument (may be null)

Throws:

Exception - in case of errors