Package org.springframework.security.messaging.context

Class AuthenticationPrincipalArgumentResolver

  • All Implemented Interfaces:
    org.springframework.messaging.handler.invocation.HandlerMethodArgumentResolver
    public final class AuthenticationPrincipalArgumentResolver
extends java.lang.Object
implements org.springframework.messaging.handler.invocation.HandlerMethodArgumentResolver
    Allows resolving the Authentication.getPrincipal() using the AuthenticationPrincipal annotation. For example, the following Controller: 
     @Controller
 public class MyController {
     @MessageMapping("/im")
     public void im(@AuthenticationPrincipal CustomUser customUser) {
         // do something with CustomUser
     }
 }

    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 {
     @MessageMapping("/im")
     public void im(@CurrentUser CustomUser customUser) {
         // do something with CustomUser
     }
 }
    Since:
    4.0

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      java.lang.Object resolveArgument​(org.springframework.core.MethodParameter parameter, org.springframework.messaging.Message<?> message)  
      boolean supportsParameter​(org.springframework.core.MethodParameter parameter)  

      • Methods inherited from class java.lang.Object

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

    • Constructor Detail

      • AuthenticationPrincipalArgumentResolver

        public AuthenticationPrincipalArgumentResolver()

    • Method Detail

      • supportsParameter

        public boolean supportsParameter​(org.springframework.core.MethodParameter parameter)
        Specified by:
        supportsParameter in interface org.springframework.messaging.handler.invocation.HandlerMethodArgumentResolver

      • resolveArgument

        public java.lang.Object resolveArgument​(org.springframework.core.MethodParameter parameter,
                                        org.springframework.messaging.Message<?> message)
        Specified by:
        resolveArgument in interface org.springframework.messaging.handler.invocation.HandlerMethodArgumentResolver