org.springframework.security.web.bind.support

Class CurrentSecurityContextArgumentResolver

java.lang.Object

org.springframework.security.web.bind.support.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

Constructor Summary

Constructors

Constructor and Description
CurrentSecurityContextArgumentResolver()

Method Summary

Modifier and Type	Method and 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) resolve the argument to inject into the controller parameter.
void	setBeanResolver(org.springframework.expression.BeanResolver beanResolver) Sets the BeanResolver to be used on the expressions
boolean	supportsParameter(org.springframework.core.MethodParameter parameter) check if this argument resolve can support the 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)

check if this argument resolve can support the parameter.

Specified by:

supportsParameter in interface org.springframework.web.method.support.HandlerMethodArgumentResolver

Parameters:

parameter - the method parameter.

Returns:

true = it can support parameter.

See Also:

supportsParameter(org.springframework.core.MethodParameter)

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)
                                 throws java.lang.Exception

resolve the argument to inject into the controller parameter.

Specified by:

resolveArgument in interface org.springframework.web.method.support.HandlerMethodArgumentResolver

Parameters:

parameter - the method parameter.

mavContainer - the model and view container.

webRequest - the web request.

binderFactory - the web data binder factory.

Throws:

java.lang.Exception

See Also:

resolveArgument (org.springframework.core.MethodParameter, org.springframework.web.method.support.ModelAndViewContainer, org.springframework.web.context.request.NativeWebRequest, org.springframework.web.bind.support.WebDataBinderFactory)

setBeanResolver

public void setBeanResolver(org.springframework.expression.BeanResolver beanResolver)

Sets the BeanResolver to be used on the expressions

Parameters:

beanResolver - the BeanResolver to use