Interface OAuth2TokenIntrospectionClaimAccessor
-
- All Superinterfaces:
ClaimAccessor
- All Known Subinterfaces:
OAuth2IntrospectionClaimAccessor
- All Known Implementing Classes:
OAuth2IntrospectionAuthenticatedPrincipal
public interface OAuth2TokenIntrospectionClaimAccessor extends ClaimAccessor
AClaimAccessor
for the "claims" that may be contained in the Introspection Response.- Since:
- 5.6
- See Also:
ClaimAccessor
,OAuth2TokenIntrospectionClaimNames
, Introspection Response
-
-
Method Summary
All Methods Instance Methods Default Methods Modifier and Type Method Description default java.util.List<java.lang.String>
getAudience()
Returns the intended audience(aud)
for the tokendefault java.lang.String
getClientId()
Returns the client identifier(client_id)
for the tokendefault java.time.Instant
getExpiresAt()
Returns a timestamp(exp)
indicating when the token expiresdefault java.lang.String
getId()
Returns the identifier(jti)
for the tokendefault java.time.Instant
getIssuedAt()
Returns a timestamp(iat)
indicating when the token was issueddefault java.net.URL
getIssuer()
Returns the issuer(iss)
of the tokendefault java.time.Instant
getNotBefore()
Returns a timestamp(nbf)
indicating when the token is not to be used beforedefault java.util.List<java.lang.String>
getScopes()
Returns the scopes(scope)
associated with the tokendefault java.lang.String
getSubject()
Returns usually a machine-readable identifier(sub)
of the resource owner who authorized the tokendefault java.lang.String
getTokenType()
Returns the type of the token(token_type)
, for examplebearer
.default java.lang.String
getUsername()
Returns a human-readable identifier(username)
for the resource owner that authorized the tokendefault boolean
isActive()
Returns the indicator(active)
whether or not the token is currently active-
Methods inherited from interface org.springframework.security.oauth2.core.ClaimAccessor
containsClaim, getClaim, getClaimAsBoolean, getClaimAsInstant, getClaimAsMap, getClaimAsString, getClaimAsStringList, getClaimAsURL, getClaims, hasClaim
-
-
-
-
Method Detail
-
isActive
default boolean isActive()
Returns the indicator(active)
whether or not the token is currently active- Returns:
- the indicator whether or not the token is currently active
-
getUsername
@Nullable default java.lang.String getUsername()
Returns a human-readable identifier(username)
for the resource owner that authorized the token- Returns:
- a human-readable identifier for the resource owner that authorized the token
-
getClientId
@Nullable default java.lang.String getClientId()
Returns the client identifier(client_id)
for the token- Returns:
- the client identifier for the token
-
getScopes
@Nullable default java.util.List<java.lang.String> getScopes()
Returns the scopes(scope)
associated with the token- Returns:
- the scopes associated with the token
-
getTokenType
@Nullable default java.lang.String getTokenType()
Returns the type of the token(token_type)
, for examplebearer
.- Returns:
- the type of the token, for example
bearer
.
-
getExpiresAt
@Nullable default java.time.Instant getExpiresAt()
Returns a timestamp(exp)
indicating when the token expires- Returns:
- a timestamp indicating when the token expires
-
getIssuedAt
@Nullable default java.time.Instant getIssuedAt()
Returns a timestamp(iat)
indicating when the token was issued- Returns:
- a timestamp indicating when the token was issued
-
getNotBefore
@Nullable default java.time.Instant getNotBefore()
Returns a timestamp(nbf)
indicating when the token is not to be used before- Returns:
- a timestamp indicating when the token is not to be used before
-
getSubject
@Nullable default java.lang.String getSubject()
Returns usually a machine-readable identifier(sub)
of the resource owner who authorized the token- Returns:
- usually a machine-readable identifier of the resource owner who authorized the token
-
getAudience
@Nullable default java.util.List<java.lang.String> getAudience()
Returns the intended audience(aud)
for the token- Returns:
- the intended audience for the token
-
getIssuer
@Nullable default java.net.URL getIssuer()
Returns the issuer(iss)
of the token- Returns:
- the issuer of the token
-
getId
@Nullable default java.lang.String getId()
Returns the identifier(jti)
for the token- Returns:
- the identifier for the token
-
-