Class PrincipalMethodArgumentResolver

java.lang.Object

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

All Implemented Interfaces:

HandlerMethodArgumentResolver

public class PrincipalMethodArgumentResolver
extends Object
implements HandlerMethodArgumentResolver

Resolves an argument of type Principal, similar to ServletRequestMethodArgumentResolver but irrespective of whether the argument is annotated or not. This is done to enable custom argument resolution of a Principal argument (with a custom annotation).

Since:

5.3.1

Author:

Rossen Stoyanchev

Constructor Summary

Constructors

Constructor	Description
PrincipalMethodArgumentResolver()

Method Summary

Modifier and Type	Method	Description
Object	resolveArgument(MethodParameter parameter, @Nullable ModelAndViewContainer mavContainer, NativeWebRequest webRequest, @Nullable WebDataBinderFactory binderFactory)	Resolves a method parameter into an argument value from a given request.
boolean	supportsParameter(MethodParameter parameter)	Whether the given method parameter is supported by this resolver.

Methods inherited from class java.lang.Object

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

Constructor Details

PrincipalMethodArgumentResolver

public PrincipalMethodArgumentResolver()

Method Details

supportsParameter

public boolean supportsParameter(MethodParameter parameter)

Description copied from interface: HandlerMethodArgumentResolver

Whether the given method parameter is supported by this resolver.

Specified by:

supportsParameter in interface HandlerMethodArgumentResolver

Parameters:

parameter - the method parameter to check

Returns:

true if this resolver supports the supplied parameter; false otherwise

resolveArgument

public Object resolveArgument(MethodParameter parameter,
 @Nullable ModelAndViewContainer mavContainer,
 NativeWebRequest webRequest,
 @Nullable WebDataBinderFactory binderFactory)
                       throws Exception

Description copied from interface: HandlerMethodArgumentResolver

Resolves a method parameter into an argument value from a given request. A ModelAndViewContainer provides access to the model for the request. A WebDataBinderFactory provides a way to create a WebDataBinder instance when needed for data binding and type conversion purposes.

Specified by:

resolveArgument in interface HandlerMethodArgumentResolver

Parameters:

parameter - the method parameter to resolve. This parameter must have previously been passed to HandlerMethodArgumentResolver.supportsParameter(org.springframework.core.MethodParameter) which must have returned true.

mavContainer - the ModelAndViewContainer for the current request

webRequest - the current request

binderFactory - a factory for creating WebDataBinder instances

Returns:

the resolved argument value, or null if not resolvable

Throws:

Exception - in case of errors with the preparation of argument values