クラス OidcUserService
java.lang.ObjectSE
org.springframework.security.oauth2.client.oidc.userinfo.OidcUserService
- 実装済みのインターフェース一覧:
OAuth2UserService<OidcUserRequest,OidcUser>
public class OidcUserService
extends ObjectSE
implements OAuth2UserService<OidcUserRequest,OidcUser>
OpenID Connect 1.0 プロバイダーをサポートする
OAuth2UserService の実装。コンストラクター概要
コンストラクター方法の概要
修飾子と型メソッド説明OidcUserInfoのクレーム値の型変換に使用されるデフォルトConverterを返します。loadUser(OidcUserRequest userRequest) UserInfo エンドポイントからエンドユーザーのユーザー属性を取得した後、OAuth2Userを返します。final voidsetClaimTypeConverterFactory(FunctionSE<ClientRegistration, org.springframework.core.convert.converter.Converter<MapSE<StringSE, ObjectSE>, MapSE<StringSE, ObjectSE>>> claimTypeConverterFactory) OidcUserInfoのクレーム値の型変換に使用されるConverterを提供するファクトリを設定します。final voidsetOauth2UserService(OAuth2UserService<OAuth2UserRequest, OAuth2User> oauth2UserService) ユーザー情報リソースをリクエストするときに使用されるOAuth2UserServiceを設定します。voidsetOidcUserConverter(org.springframework.core.convert.converter.Converter<OidcUserSource, OidcUser> oidcUserConverter) OidcUserSourceからOidcUserへの変換を可能にします。final voidsetRetrieveUserInfo(PredicateSE<OidcUserRequest> retrieveUserInfo) エンドユーザー (リソース所有者) に関する情報を取得するために UserInfo エンドポイントを呼び出す必要があるかどうかを決定するために使用されるPredicateを設定します。
コンストラクターの詳細
OidcUserService
public OidcUserService()
メソッドの詳細
createDefaultClaimTypeConverters
public static MapSE<StringSE,org.springframework.core.convert.converter.Converter<ObjectSE, createDefaultClaimTypeConverters()?>> OidcUserInfoのクレーム値の型変換に使用されるデフォルトConverterを返します。- 戻り値:
claim nameによってキー設定されたConverterのMapSE- 導入:
- 5.2
loadUser
インターフェースからコピーされた説明:OAuth2UserServiceUserInfo エンドポイントからエンドユーザーのユーザー属性を取得した後、OAuth2Userを返します。- 次で指定:
- インターフェース
OAuth2UserService<OidcUserRequest,のOidcUser> loadUser - パラメーター:
userRequest- ユーザーリクエスト- 戻り値:
OAuth2User- 例外:
OAuth2AuthenticationException- UserInfo エンドポイントからユーザー属性を取得しようとしてエラーが発生した場合
setOauth2UserService
public final void setOauth2UserService(OAuth2UserService<OAuth2UserRequest, OAuth2User> oauth2UserService) ユーザー情報リソースをリクエストするときに使用されるOAuth2UserServiceを設定します。- パラメーター:
oauth2UserService- ユーザー情報リソースをリクエストするときに使用されるOAuth2UserService。- 導入:
- 5.1
setClaimTypeConverterFactory
public final void setClaimTypeConverterFactory(FunctionSE<ClientRegistration, org.springframework.core.convert.converter.Converter<MapSE<StringSE, ObjectSE>, MapSE<StringSE, ObjectSE>>> claimTypeConverterFactory) OidcUserInfoのクレーム値の型変換に使用されるConverterを提供するファクトリを設定します。デフォルトは、すべてのclientsのClaimTypeConverterです。- パラメーター:
claimTypeConverterFactory- 特定のclientのクレーム値の型変換に使用されるConverterを提供するファクトリ- 導入:
- 5.2
setRetrieveUserInfo
エンドユーザー (リソース所有者) に関する情報を取得するために UserInfo エンドポイントを呼び出す必要があるかどうかを決定するために使用されるPredicateを設定します。デフォルトでは、次の条件がすべて満たされる場合に UserInfo エンドポイントが呼び出されます。
- ユーザー情報エンドポイントは ClientRegistration で定義されます
- クライアント登録には
AuthorizationGrantType.AUTHORIZATION_CODEを使用します
- パラメーター:
retrieveUserInfo-Predicateは UserInfo エンドポイントを呼び出すかどうかを決定するために使用されます- 導入:
- 6.3
setOidcUserConverter
public void setOidcUserConverter(org.springframework.core.convert.converter.Converter<OidcUserSource, OidcUser> oidcUserConverter) OidcUserSourceからOidcUserへの変換を可能にします。- パラメーター:
oidcUserConverter- 使用するConverter。null にはできません。