クラス DefaultOAuth2UserService
- java.lang.Object
-
- org.springframework.security.oauth2.client.userinfo.DefaultOAuth2UserService
- 実装されたすべてのインターフェース:
OAuth2UserService<OAuth2UserRequest,OAuth2User>
public class DefaultOAuth2UserService extends java.lang.Object implements OAuth2UserService<OAuth2UserRequest,OAuth2User>
標準の OAuth 2.0 プロバイダーをサポートするOAuth2UserService
の実装。標準の OAuth 2.0 プロバイダーの場合、UserInfo レスポンスからユーザーの名前にアクセスするために使用される属性名が必要であるため、
UserInfoEndpoint.getUserNameAttributeName()
を介して使用可能でなければなりません。注 : 属性名はプロバイダー間で標準化されていないため、異なる場合があります。サポートされるユーザー属性名のセットについては、プロバイダーの API ドキュメントを参照してください。
- 導入:
- 5.0
- 関連事項:
OAuth2UserService
,OAuth2UserRequest
,OAuth2User
,DefaultOAuth2User
コンストラクターのサマリー
コンストラクター コンストラクター 説明 DefaultOAuth2UserService()
メソッドのサマリー
すべてのメソッド インスタンスメソッド 具象メソッド 修飾子と型 メソッド 説明 OAuth2User
loadUser(OAuth2UserRequest userRequest)
UserInfo エンドポイントからエンドユーザーのユーザー属性を取得した後、OAuth2User
を返します。void
setRequestEntityConverter(org.springframework.core.convert.converter.Converter<OAuth2UserRequest,org.springframework.http.RequestEntity<?>> requestEntityConverter)
void
setRestOperations(org.springframework.web.client.RestOperations restOperations)
UserInfo リソースをリクエストするときに使用されるRestOperations
を設定します。
メソッドの詳細
loadUser
public OAuth2User loadUser(OAuth2UserRequest userRequest) throws OAuth2AuthenticationException
インターフェースからコピーされた説明:OAuth2UserService
UserInfo エンドポイントからエンドユーザーのユーザー属性を取得した後、OAuth2User
を返します。- 次で指定:
- インターフェース
OAuth2UserService<OAuth2UserRequest,OAuth2User>
のloadUser
- パラメーター:
userRequest
- ユーザーリクエスト- 戻り値:
OAuth2User
- 例外:
OAuth2AuthenticationException
- UserInfo エンドポイントからユーザー属性を取得しようとしてエラーが発生した場合
setRequestEntityConverter
public final void setRequestEntityConverter(org.springframework.core.convert.converter.Converter<OAuth2UserRequest,org.springframework.http.RequestEntity<?>> requestEntityConverter)
- パラメーター:
requestEntityConverter
- UserInfo リクエストのRequestEntity
表現への変換に使用されるConverter
- 導入:
- 5.1
setRestOperations
public final void setRestOperations(org.springframework.web.client.RestOperations restOperations)
UserInfo リソースをリクエストするときに使用されるRestOperations
を設定します。注意 : 少なくとも、提供されている
restOperations
は、以下で構成する必要があります。ResponseErrorHandler
-OAuth2ErrorResponseErrorHandler
- パラメーター:
restOperations
- UserInfo リソースをリクエストするときに使用されるRestOperations
- 導入:
- 5.1