インターフェース ClaimAccessor
- すべての既知のサブインターフェース:
IdTokenClaimAccessor
、JwtClaimAccessor
、LogoutTokenClaimAccessor
、OAuth2TokenIntrospectionClaimAccessor
、OidcUser
、StandardClaimAccessor
- すべての既知の実装クラス:
DefaultOidcUser
、Jwt
、JwtClaimsSet
、OAuth2IntrospectionAuthenticatedPrincipal
、OidcIdToken
、OidcLogoutToken
、OidcUserInfo
public interface ClaimAccessor
「アクセサー」アサーションに使用できるクレームのセット。
- 導入:
- 5.0
メソッドのサマリー
修飾子と型メソッド説明default <T> T
クレーム値をT
型として返します。default BooleanSE
getClaimAsBoolean
(StringSE claim) クレームが存在しない場合は、クレーム値をBoolean
またはnull
として返します。default InstantSE
getClaimAsInstant
(StringSE claim) 要求値が存在しない場合、Instant
またはnull
としてクレーム値を返します。getClaimAsMap
(StringSE claim) クレームが存在しない場合は、クレーム値をMap<String, Object>
またはnull
として返します。default StringSE
getClaimAsString
(StringSE claim) 要求値が存在しないか、null
と等しい場合、要求値をString
またはnull
として返します。getClaimAsStringList
(StringSE claim) クレームが存在しない場合は、クレーム値をList<String>
またはnull
として返します。default URLSE
getClaimAsURL
(StringSE claim) 要求値が存在しない場合、URL
またはnull
としてクレーム値を返します。アサーションに使用できるクレームのセットを返します。default boolean
メソッドの詳細
getClaims
アサーションに使用できるクレームのセットを返します。- 戻り値:
Map
のクレーム
getClaim
クレーム値をT
型として返します。要求値は、型T
であることが期待されています。- 型パラメーター:
T
- クレーム値の型- パラメーター:
claim
- クレームの名前- 戻り値:
- クレーム値
- 導入:
- 5.2
hasClaim
- パラメーター:
claim
- クレームの名前- 戻り値:
- クレームが存在する場合は
true
、そうでない場合はfalse
- 導入:
- 5.5
getClaimAsString
要求値が存在しないか、null
と等しい場合、要求値をString
またはnull
として返します。- パラメーター:
claim
- クレームの名前- 戻り値:
- 要求値または
null
が存在しないか、null
と等しい場合
getClaimAsBoolean
クレームが存在しない場合は、クレーム値をBoolean
またはnull
として返します。- パラメーター:
claim
- クレームの名前- 戻り値:
- クレーム値またはクレームが存在しない場合は
null
- 例外:
IllegalArgumentExceptionSE
- クレーム値をBoolean
に変換できない場合NullPointerExceptionSE
- クレーム値がnull
の場合
getClaimAsInstant
要求値が存在しない場合、Instant
またはnull
としてクレーム値を返します。- パラメーター:
claim
- クレームの名前- 戻り値:
- クレーム値または
null
(存在しない場合)
getClaimAsURL
要求値が存在しない場合、URL
またはnull
としてクレーム値を返します。- パラメーター:
claim
- クレームの名前- 戻り値:
- クレーム値または
null
(存在しない場合)
getClaimAsMap
クレームが存在しない場合は、クレーム値をMap<String, Object>
またはnull
として返します。- パラメーター:
claim
- クレームの名前- 戻り値:
- クレーム値またはクレームが存在しない場合は
null
- 例外:
IllegalArgumentExceptionSE
- クレーム値をMap
に変換できない場合NullPointerExceptionSE
- クレーム値がnull
の場合
getClaimAsStringList
クレームが存在しない場合は、クレーム値をList<String>
またはnull
として返します。- パラメーター:
claim
- クレームの名前- 戻り値:
- クレーム値またはクレームが存在しない場合は
null
- 例外:
IllegalArgumentExceptionSE
- クレーム値をList
に変換できない場合NullPointerExceptionSE
- クレーム値がnull
の場合