Package org.springframework.graphql.data.method.annotation.support

Class AuthenticationPrincipalArgumentResolver

java.lang.Object

org.springframework.graphql.data.method.annotation.support.AuthenticationPrincipalArgumentResolver

All Implemented Interfaces:

HandlerMethodArgumentResolver

public class AuthenticationPrincipalArgumentResolver
extends Object
implements HandlerMethodArgumentResolver

Resolver to obtain Authentication.getPrincipal() from Spring Security context via SecurityContext.getAuthentication() for parameters annotated with AuthenticationPrincipal.

The resolver checks both ThreadLocal context via SecurityContextHolder for Spring MVC applications, and ReactiveSecurityContextHolder for Spring WebFlux applications.

Since:

1.0.0

Author:

Rob Winch

Constructor Summary

Constructors

Constructor	Description
AuthenticationPrincipalArgumentResolver(BeanResolver beanResolver)	Creates a new instance.

Method Summary

Modifier and Type	Method	Description
Object	resolveArgument(MethodParameter parameter, DataFetchingEnvironment environment)	Resolve a method parameter to a value.
boolean	supportsParameter(MethodParameter parameter)	Whether this resolver supports the given MethodParameter.

Methods inherited from class java.lang.Object

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

Constructor Details

AuthenticationPrincipalArgumentResolver

public AuthenticationPrincipalArgumentResolver(BeanResolver beanResolver)

Creates a new instance.

Parameters:

beanResolver - the BeanResolver used for resolving beans in SpEL expressions. Cannot be null.

Method Details

supportsParameter

public boolean supportsParameter(MethodParameter parameter)

Description copied from interface: HandlerMethodArgumentResolver

Whether this resolver supports the given MethodParameter.

Specified by:

supportsParameter in interface HandlerMethodArgumentResolver

resolveArgument

public Object resolveArgument(MethodParameter parameter,
 DataFetchingEnvironment environment)
                       throws Exception

Description copied from interface: HandlerMethodArgumentResolver

Resolve a method parameter to a value.

Specified by:

resolveArgument in interface HandlerMethodArgumentResolver

Parameters:

parameter - the method parameter to resolve. This parameter must have previously checked via HandlerMethodArgumentResolver.supportsParameter(org.springframework.core.MethodParameter).

environment - the environment to use to resolve the value

Returns:

the resolved value, which may be null if not resolved; the value may also be a Mono if it requires asynchronous resolution.

Throws:

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