Package org.springframework.security.oauth2.client.oidc.userinfo

Class OidcReactiveOAuth2UserService

java.lang.Object

org.springframework.security.oauth2.client.oidc.userinfo.OidcReactiveOAuth2UserService

All Implemented Interfaces:

ReactiveOAuth2UserService<OidcUserRequest,OidcUser>

public class OidcReactiveOAuth2UserService
extends java.lang.Object
implements ReactiveOAuth2UserService<OidcUserRequest,OidcUser>

An implementation of an ReactiveOAuth2UserService that supports OpenID Connect 1.0 Provider's.

Since:

5.1

See Also:

ReactiveOAuth2UserService, OidcUserRequest, OidcUser, DefaultOidcUser, OidcUserInfo

Constructor Summary

Constructors

Constructor	Description
OidcReactiveOAuth2UserService()

Method Summary

Modifier and Type	Method	Description
static java.util.Map<java.lang.String,org.springframework.core.convert.converter.Converter<java.lang.Object,?>>	createDefaultClaimTypeConverters()	Returns the default Converter's used for type conversion of claim values for an OidcUserInfo.
reactor.core.publisher.Mono<OidcUser>	loadUser(OidcUserRequest userRequest)	Returns an OAuth2User after obtaining the user attributes of the End-User from the UserInfo Endpoint.
void	setClaimTypeConverterFactory(java.util.function.Function<ClientRegistration,org.springframework.core.convert.converter.Converter<java.util.Map<java.lang.String,java.lang.Object>,java.util.Map<java.lang.String,java.lang.Object>>> claimTypeConverterFactory)	Sets the factory that provides a Converter used for type conversion of claim values for an OidcUserInfo.
void	setOauth2UserService(ReactiveOAuth2UserService<OAuth2UserRequest,OAuth2User> oauth2UserService)

Methods inherited from class java.lang.Object

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

Constructor Detail

OidcReactiveOAuth2UserService

public OidcReactiveOAuth2UserService()

Method Detail

createDefaultClaimTypeConverters

public static java.util.Map<java.lang.String,org.springframework.core.convert.converter.Converter<java.lang.Object,?>> createDefaultClaimTypeConverters()

Returns the default Converter's used for type conversion of claim values for an OidcUserInfo.

Returns:

a Map of Converter's keyed by claim name

Since:

5.2

loadUser

public reactor.core.publisher.Mono<OidcUser> loadUser(OidcUserRequest userRequest)
                                               throws OAuth2AuthenticationException

Description copied from interface: ReactiveOAuth2UserService

Returns an OAuth2User after obtaining the user attributes of the End-User from the UserInfo Endpoint.

Specified by:

loadUser in interface ReactiveOAuth2UserService<OidcUserRequest,OidcUser>

Parameters:

userRequest - the user request

Returns:

an OAuth2User

Throws:

OAuth2AuthenticationException - if an error occurs while attempting to obtain the user attributes from the UserInfo Endpoint

setOauth2UserService

public void setOauth2UserService(ReactiveOAuth2UserService<OAuth2UserRequest,OAuth2User> oauth2UserService)

setClaimTypeConverterFactory

public final void setClaimTypeConverterFactory(java.util.function.Function<ClientRegistration,org.springframework.core.convert.converter.Converter<java.util.Map<java.lang.String,java.lang.Object>,java.util.Map<java.lang.String,java.lang.Object>>> claimTypeConverterFactory)

Sets the factory that provides a Converter used for type conversion of claim values for an OidcUserInfo. The default is ClaimTypeConverter for all clients.

Parameters:

claimTypeConverterFactory - the factory that provides a Converter used for type conversion of claim values for a specific client

Since:

5.2