クラス 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 の実装。
導入:
5.0
関連事項:
  • コンストラクターの詳細

    • OidcUserService

      public OidcUserService()
  • メソッドの詳細

    • createDefaultClaimTypeConverters

      public static MapSE<StringSE,org.springframework.core.convert.converter.Converter<ObjectSE,?>> createDefaultClaimTypeConverters()
      OidcUserInfo のクレーム値の型変換に使用されるデフォルト Converter を返します。
      戻り値:
      claim name によってキー設定された ConverterMapSE
      導入:
      5.2
    • loadUser

      public OidcUser loadUser(OidcUserRequest userRequest) throws OAuth2AuthenticationException
      インターフェースからコピーされた説明: OAuth2UserService
      UserInfo エンドポイントからエンドユーザーのユーザー属性を取得した後、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 を提供するファクトリを設定します。デフォルトは、すべての clientsClaimTypeConverter です。
      パラメーター:
      claimTypeConverterFactory - 特定の client のクレーム値の型変換に使用される Converter を提供するファクトリ
      導入:
      5.2
    • setRetrieveUserInfo

      public final void setRetrieveUserInfo(PredicateSE<OidcUserRequest> retrieveUserInfo)
      エンドユーザー (リソース所有者) に関する情報を取得するために UserInfo エンドポイントを呼び出す必要があるかどうかを決定するために使用される Predicate を設定します。

      デフォルトでは、次の条件がすべて満たされる場合に UserInfo エンドポイントが呼び出されます。

      パラメーター:
      retrieveUserInfo - Predicate は UserInfo エンドポイントを呼び出すかどうかを決定するために使用されます
      導入:
      6.3
    • setOidcUserConverter

      public void setOidcUserConverter(org.springframework.core.convert.converter.Converter<OidcUserSource,OidcUser> oidcUserConverter)
      OidcUserSource から OidcUser への変換を可能にします。
      パラメーター:
      oidcUserConverter - 使用する Converter。null にはできません。