インターフェース ClaimAccessor
- すべての既知のサブインターフェース:
IdTokenClaimAccessor
、JwtClaimAccessor
、OAuth2IntrospectionClaimAccessor
、OAuth2TokenIntrospectionClaimAccessor
、OidcUser
、StandardClaimAccessor
- すべての既知の実装クラス:
DefaultOidcUser
、Jwt
、JwtClaimsSet
、OAuth2IntrospectionAuthenticatedPrincipal
、OidcIdToken
、OidcUserInfo
public interface ClaimAccessor
「アクセサー」アサーションに使用できるクレームのセット。- 導入:
- 5.0
メソッドのサマリー
すべてのメソッド インスタンスメソッド 抽象メソッド デフォルトメソッド 非推奨のメソッド 修飾子と型 メソッド 説明 default java.lang.Boolean
containsClaim(java.lang.String claim)
使用すべきではありません。代わりにhasClaim(java.lang.String)
を使用してください。default <T> T
getClaim(java.lang.String claim)
クレーム値をT
型として返します。default java.lang.Boolean
getClaimAsBoolean(java.lang.String claim)
クレームが存在しない場合は、クレーム値をBoolean
またはnull
として返します。default java.time.Instant
getClaimAsInstant(java.lang.String claim)
要求値が存在しない場合、Instant
またはnull
としてクレーム値を返します。default java.util.Map<java.lang.String,java.lang.Object>
getClaimAsMap(java.lang.String claim)
クレームが存在しない場合は、クレーム値をMap<String, Object>
またはnull
として返します。default java.lang.String
getClaimAsString(java.lang.String claim)
要求値が存在しないか、null
と等しい場合、要求値をString
またはnull
として返します。default java.util.List<java.lang.String>
getClaimAsStringList(java.lang.String claim)
クレームが存在しない場合は、クレーム値をList<String>
またはnull
として返します。default java.net.URL
getClaimAsURL(java.lang.String claim)
要求値が存在しない場合、URL
またはnull
としてクレーム値を返します。java.util.Map<java.lang.String,java.lang.Object>
getClaims()
アサーションに使用できるクレームのセットを返します。default boolean
hasClaim(java.lang.String claim)
メソッドの詳細
getClaims
java.util.Map<java.lang.String,java.lang.Object> getClaims()
アサーションに使用できるクレームのセットを返します。- 戻り値:
Map
のクレーム
getClaim
default <T> T getClaim(java.lang.String claim)
クレーム値をT
型として返します。要求値は、型T
であることが期待されています。- 型パラメーター:
T
- クレーム値の型- パラメーター:
claim
- クレームの名前- 戻り値:
- クレーム値
- 導入:
- 5.2
hasClaim
default boolean hasClaim(java.lang.String claim)
- パラメーター:
claim
- クレームの名前- 戻り値:
- クレームが存在する場合は
true
、そうでない場合はfalse
- 導入:
- 5.5
containsClaim
@Deprecated default java.lang.Boolean containsClaim(java.lang.String claim)
使用すべきではありません。代わりにhasClaim(java.lang.String)
を使用してください。- パラメーター:
claim
- クレームの名前- 戻り値:
- クレームが存在する場合は
true
、そうでない場合はfalse
getClaimAsString
default java.lang.String getClaimAsString(java.lang.String claim)
要求値が存在しないか、null
と等しい場合、要求値をString
またはnull
として返します。- パラメーター:
claim
- クレームの名前- 戻り値:
- 要求値または
null
が存在しないか、null
と等しい場合
getClaimAsBoolean
default java.lang.Boolean getClaimAsBoolean(java.lang.String claim)
クレームが存在しない場合は、クレーム値をBoolean
またはnull
として返します。- パラメーター:
claim
- クレームの名前- 戻り値:
- クレーム値またはクレームが存在しない場合は
null
- 例外:
java.lang.IllegalArgumentException
- クレーム値をBoolean
に変換できない場合java.lang.NullPointerException
- クレーム値がnull
の場合
getClaimAsInstant
default java.time.Instant getClaimAsInstant(java.lang.String claim)
要求値が存在しない場合、Instant
またはnull
としてクレーム値を返します。- パラメーター:
claim
- クレームの名前- 戻り値:
- クレーム値または
null
(存在しない場合)
getClaimAsURL
default java.net.URL getClaimAsURL(java.lang.String claim)
要求値が存在しない場合、URL
またはnull
としてクレーム値を返します。- パラメーター:
claim
- クレームの名前- 戻り値:
- クレーム値または
null
(存在しない場合)
getClaimAsMap
default java.util.Map<java.lang.String,java.lang.Object> getClaimAsMap(java.lang.String claim)
クレームが存在しない場合は、クレーム値をMap<String, Object>
またはnull
として返します。- パラメーター:
claim
- クレームの名前- 戻り値:
- クレーム値またはクレームが存在しない場合は
null
- 例外:
java.lang.IllegalArgumentException
- クレーム値をList
に変換できない場合java.lang.NullPointerException
- クレーム値がnull
の場合
getClaimAsStringList
default java.util.List<java.lang.String> getClaimAsStringList(java.lang.String claim)
クレームが存在しない場合は、クレーム値をList<String>
またはnull
として返します。- パラメーター:
claim
- クレームの名前- 戻り値:
- クレーム値またはクレームが存在しない場合は
null
- 例外:
java.lang.IllegalArgumentException
- クレーム値をList
に変換できない場合java.lang.NullPointerException
- クレーム値がnull
の場合