Package org.springframework.security.web.method.annotation

Class CurrentSecurityContextArgumentResolver

  • All Implemented Interfaces:
    org.springframework.web.method.support.HandlerMethodArgumentResolver
    public final class CurrentSecurityContextArgumentResolver
extends java.lang.Object
implements org.springframework.web.method.support.HandlerMethodArgumentResolver
    Allows resolving the SecurityContext using the CurrentSecurityContext annotation. For example, the following Controller: 
     @Controller
 public class MyController {
     @RequestMapping("/im")
     public void security(@CurrentSecurityContext SecurityContext context) {
         // do something with context
     }
 }
    it can also support the spring SPEL expression to get the value from SecurityContext 
     @Controller
 public class MyController {
     @RequestMapping("/im")
     public void security(@CurrentSecurityContext(expression="authentication") Authentication authentication) {
         // do something with context
     }
 }

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

    Since:
    5.2

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      java.lang.Object resolveArgument​(org.springframework.core.MethodParameter parameter, org.springframework.web.method.support.ModelAndViewContainer mavContainer, org.springframework.web.context.request.NativeWebRequest webRequest, org.springframework.web.bind.support.WebDataBinderFactory binderFactory)  
      void setBeanResolver​(org.springframework.expression.BeanResolver beanResolver)
      Set the BeanResolver to be used on the expressions
      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

      • CurrentSecurityContextArgumentResolver

        public CurrentSecurityContextArgumentResolver()

    • Method Detail

      • supportsParameter

        public boolean supportsParameter​(org.springframework.core.MethodParameter parameter)
        Specified by:
        supportsParameter in interface org.springframework.web.method.support.HandlerMethodArgumentResolver

      • resolveArgument

        public java.lang.Object resolveArgument​(org.springframework.core.MethodParameter parameter,
                                        org.springframework.web.method.support.ModelAndViewContainer mavContainer,
                                        org.springframework.web.context.request.NativeWebRequest webRequest,
                                        org.springframework.web.bind.support.WebDataBinderFactory binderFactory)
        Specified by:
        resolveArgument in interface org.springframework.web.method.support.HandlerMethodArgumentResolver

      • setBeanResolver

        public void setBeanResolver​(org.springframework.expression.BeanResolver beanResolver)
        Set the BeanResolver to be used on the expressions
        Parameters:
        beanResolver - the BeanResolver to use