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

Class OidcUserService

java.lang.Object

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

All Implemented Interfaces:

OAuth2UserService<OidcUserRequest,org.springframework.security.oauth2.core.oidc.user.OidcUser>

public class OidcUserService
extends java.lang.Object
implements OAuth2UserService<OidcUserRequest,org.springframework.security.oauth2.core.oidc.user.OidcUser>

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

Since:

5.0

See Also:

OAuth2UserService, OidcUserRequest, OidcUser, DefaultOidcUser, OidcUserInfo

Constructor Summary

Constructors

Constructor and Description
OidcUserService()

Method Summary

Modifier and Type	Method and Description
org.springframework.security.oauth2.core.oidc.user.OidcUser	loadUser(OidcUserRequest userRequest) Returns an OAuth2User after obtaining the user attributes of the End-User from the UserInfo Endpoint.
void	setOauth2UserService(OAuth2UserService<OAuth2UserRequest,org.springframework.security.oauth2.core.user.OAuth2User> oauth2UserService) Sets the OAuth2UserService used when requesting the user info resource.

Methods inherited from class java.lang.Object

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

Constructor Detail

OidcUserService

public OidcUserService()

Method Detail

loadUser

public org.springframework.security.oauth2.core.oidc.user.OidcUser loadUser(OidcUserRequest userRequest)
                                                                     throws org.springframework.security.oauth2.core.OAuth2AuthenticationException

Description copied from interface: OAuth2UserService

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

Specified by:

loadUser in interface OAuth2UserService<OidcUserRequest,org.springframework.security.oauth2.core.oidc.user.OidcUser>

Parameters:

userRequest - the user request

Returns:

an OAuth2User

Throws:

org.springframework.security.oauth2.core.OAuth2AuthenticationException - if an error occurs while attempting to obtain the user attributes from the UserInfo Endpoint

setOauth2UserService

public final void setOauth2UserService(OAuth2UserService<OAuth2UserRequest,org.springframework.security.oauth2.core.user.OAuth2User> oauth2UserService)

Sets the OAuth2UserService used when requesting the user info resource.

Parameters:

oauth2UserService - the OAuth2UserService used when requesting the user info resource.

Since:

5.1