org.springframework.security.web.bind.support

Class AuthenticationPrincipalArgumentResolver

java.lang.Object

org.springframework.security.web.bind.support.AuthenticationPrincipalArgumentResolver

All Implemented Interfaces:

HandlerMethodArgumentResolver

Deprecated.

use org.springframework.security.web.method.annotation. AuthenticationPrincipalArgumentResolver

@Deprecated
public final class AuthenticationPrincipalArgumentResolver
extends Object
implements HandlerMethodArgumentResolver

Allows resolving the Authentication.getPrincipal() using the AuthenticationPrincipal annotation. For example, the following Controller:

 @Controller
 public class MyController {
     @RequestMapping("/user/current/show")
     public String show(@AuthenticationPrincipal CustomUser customUser) {
         // do something with CustomUser
         return "view";
     }
 }
 

Will resolve the CustomUser argument using Authentication.getPrincipal() from the SecurityContextHolder. If the Authentication or Authentication.getPrincipal() is null, it will return null. If the types do not match, null will be returned unless AuthenticationPrincipal.errorOnInvalidType() is true in which case a ClassCastException will be thrown.

Alternatively, users can create a custom meta annotation as shown below:

 @Target({ ElementType.PARAMETER })
 @Retention(RetentionPolicy.RUNTIME)
 @AuthenticationPrincipal
 public @interface CurrentUser {
 }
 

The custom annotation can then be used instead. For example:

 @Controller
 public class MyController {
     @RequestMapping("/user/current/show")
     public String show(@CurrentUser CustomUser customUser) {
         // do something with CustomUser
         return "view";
     }
 }
 

Since:

3.2

Constructor Summary

Constructors

Constructor and Description
AuthenticationPrincipalArgumentResolver() Deprecated.

Method Summary

Modifier and Type	Method and Description
Object	resolveArgument(MethodParameter parameter, ModelAndViewContainer mavContainer, NativeWebRequest webRequest, WebDataBinderFactory binderFactory) Deprecated.
boolean	supportsParameter(MethodParameter parameter) Deprecated.

Methods inherited from class java.lang.Object

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

Constructor Detail

AuthenticationPrincipalArgumentResolver

public AuthenticationPrincipalArgumentResolver()

Deprecated.

Method Detail

supportsParameter

public boolean supportsParameter(MethodParameter parameter)

Deprecated.

Specified by:

supportsParameter in interface HandlerMethodArgumentResolver

resolveArgument

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

Deprecated.

Specified by:

resolveArgument in interface HandlerMethodArgumentResolver

Throws:

Exception