パッケージ org.springframework.security.oauth2.core

インターフェース ClaimAccessor

すべての既知のサブインターフェース:
IdTokenClaimAccessor、JwtClaimAccessor、LogoutTokenClaimAccessor、OAuth2TokenIntrospectionClaimAccessor、OidcUser、StandardClaimAccessor
すべての既知の実装クラス:
DefaultOidcUser、Jwt、JwtClaimsSet、OAuth2IntrospectionAuthenticatedPrincipal、OidcIdToken、OidcLogoutToken、OidcUserInfo
public interface ClaimAccessor
「アクセサー」アサーションに使用できるクレームのセット。
導入:
5.0

  • メソッドのサマリー

    修飾子と型
    メソッド
    説明
    default <T> T
    getClaim(StringSE claim)
    クレーム値を T 型として返します。
    default BooleanSE
    getClaimAsBoolean(StringSE claim)
    クレームが存在しない場合は、クレーム値を Boolean または null として返します。
    default InstantSE
    getClaimAsInstant(StringSE claim)
    要求値が存在しない場合、Instant または null としてクレーム値を返します。
    default MapSE<StringSE,ObjectSE>
    getClaimAsMap(StringSE claim)
    クレームが存在しない場合は、クレーム値を Map<String, Object> または null として返します。
    default StringSE
    getClaimAsString(StringSE claim)
    要求値が存在しないか、null と等しい場合、要求値を String または null として返します。
    default ListSE<StringSE>
    getClaimAsStringList(StringSE claim)
    クレームが存在しない場合は、クレーム値を List<String> または null として返します。
    default URLSE
    getClaimAsURL(StringSE claim)
    要求値が存在しない場合、URL または null としてクレーム値を返します。
    MapSE<StringSE,ObjectSE>
    getClaims()
    アサーションに使用できるクレームのセットを返します。
    default boolean
    hasClaim(StringSE claim)
    getClaims() にクレームが存在する場合は true を返し、そうでない場合は false を返します。

  • メソッドの詳細

    • getClaims

      MapSE<StringSE,ObjectSE> getClaims()
      アサーションに使用できるクレームのセットを返します。
      戻り値:
      Map のクレーム

    • getClaim

      default <T> T getClaim(StringSE claim)
      クレーム値を T 型として返します。要求値は、型 T であることが期待されています。
      型パラメーター:
      T - クレーム値の型
      パラメーター:
      claim - クレームの名前
      戻り値:
      クレーム値
      導入:
      5.2

    • hasClaim

      default boolean hasClaim(StringSE claim)
      getClaims() にクレームが存在する場合は true を返し、そうでない場合は false を返します。
      パラメーター:
      claim - クレームの名前
      戻り値:
      クレームが存在する場合は true、そうでない場合は false
      導入:
      5.5

    • getClaimAsString

      default StringSE getClaimAsString(StringSE claim)
      要求値が存在しないか、null と等しい場合、要求値を String または null として返します。
      パラメーター:
      claim - クレームの名前
      戻り値:
      要求値または null が存在しないか、null と等しい場合

    • getClaimAsBoolean

      default BooleanSE getClaimAsBoolean(StringSE claim)
      クレームが存在しない場合は、クレーム値を Boolean または null として返します。
      パラメーター:
      claim - クレームの名前
      戻り値:
      クレーム値またはクレームが存在しない場合は null 
      例外:
      IllegalArgumentExceptionSE - クレーム値を Boolean に変換できない場合
      NullPointerExceptionSE - クレーム値が null の場合

    • getClaimAsInstant

      default InstantSE getClaimAsInstant(StringSE claim)
      要求値が存在しない場合、Instant または null としてクレーム値を返します。
      パラメーター:
      claim - クレームの名前
      戻り値:
      クレーム値または null （存在しない場合）

    • getClaimAsURL

      default URLSE getClaimAsURL(StringSE claim)
      要求値が存在しない場合、URL または null としてクレーム値を返します。
      パラメーター:
      claim - クレームの名前
      戻り値:
      クレーム値または null （存在しない場合）

    • getClaimAsMap

      default MapSE<StringSE,ObjectSE> getClaimAsMap(StringSE claim)
      クレームが存在しない場合は、クレーム値を Map<String, Object> または null として返します。
      パラメーター:
      claim - クレームの名前
      戻り値:
      クレーム値またはクレームが存在しない場合は null 
      例外:
      IllegalArgumentExceptionSE - クレーム値を Map に変換できない場合
      NullPointerExceptionSE - クレーム値が null の場合

    • getClaimAsStringList

      default ListSE<StringSE> getClaimAsStringList(StringSE claim)
      クレームが存在しない場合は、クレーム値を List<String> または null として返します。
      パラメーター:
      claim - クレームの名前
      戻り値:
      クレーム値またはクレームが存在しない場合は null 
      例外:
      IllegalArgumentExceptionSE - クレーム値を List に変換できない場合
      NullPointerExceptionSE - クレーム値が null の場合