com.sap.cloud.security.token

Class XsuaaToken

java.lang.Object

com.sap.cloud.security.token.AbstractToken

com.sap.cloud.security.token.XsuaaToken

All Implemented Interfaces:

AccessToken, Token

public class XsuaaToken
extends AbstractToken
implements AccessToken

Decodes and parses encoded access token (JWT) for the Xsuaa identity service and provides access to token header parameters and claims.

Field Summary

Fields inherited from class com.sap.cloud.security.token.AbstractToken

jwtToken, tokenBody, tokenHeader

Constructor Summary

Constructors

Constructor and Description
XsuaaToken(DecodedJwt decodedJwt) Creates an instance.
XsuaaToken(String accessToken) Creates an instance.

Method Summary

Modifier and Type	Method and Description
GrantType	getGrantType() Returns the grant type of the jwt token.
Principal	getPrincipal() Returns a principal, which can be used to represent any entity, such as an individual, a corporation, and a login id.
Set<String>	getScopes() Returns the list of the claim "scope".
Service	getService() Returns the identity service, the token is issued by.
boolean	hasLocalScope(String scope) Check if a local scope is available in the authentication token.
boolean	hasScope(String scope) Checks if a scope is available in the access token.
XsuaaToken	withScopeConverter(ScopeConverter converter) Configures a scope converter, e.g.

Methods inherited from class com.sap.cloud.security.token.AbstractToken

createPrincipalByName, equals, getAudiences, getClaimAsJsonObject, getClaimAsString, getClaimAsStringList, getExpiration, getHeaderParameterAsString, getNotBefore, getTokenValue, hasClaim, hashCode, hasHeaderParameter, isExpired

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.sap.cloud.security.token.Token

getAudiences, getClaimAsJsonObject, getClaimAsString, getClaimAsStringList, getExpiration, getHeaderParameterAsString, getNotBefore, getTokenValue, hasClaim, hasHeaderParameter, isExpired

Constructor Detail

XsuaaToken

public XsuaaToken(@Nonnull
                  DecodedJwt decodedJwt)

Creates an instance.

Parameters:

decodedJwt - the decoded jwt

XsuaaToken

public XsuaaToken(@Nonnull
                  String accessToken)

Creates an instance.

Parameters:

accessToken - the encoded access token, e.g. from the Authorization header.

Method Detail

withScopeConverter

public XsuaaToken withScopeConverter(@Nullable
                                     ScopeConverter converter)

Configures a scope converter, e.g. required for the hasLocalScope(String)

Parameters:

converter - the scope converter, e.g. XsuaaScopeConverter

Returns:

the token itself

getScopes

public Set<String> getScopes()

Description copied from interface: AccessToken

Returns the list of the claim "scope".

Specified by:

getScopes in interface AccessToken

Returns:

the list of the claim scope or empty list.

getPrincipal

public Principal getPrincipal()

Description copied from interface: Token

Returns a principal, which can be used to represent any entity, such as an individual, a corporation, and a login id.

Specified by:

getPrincipal in interface Token

Returns:

the principal or null if not yet implemented.

getService

public Service getService()

Description copied from interface: Token

Returns the identity service, the token is issued by.

Specified by:

getService in interface Token

Returns:

the service.

hasScope

public boolean hasScope(String scope)

Description copied from interface: AccessToken

Checks if a scope is available in the access token.

Specified by:

hasScope in interface AccessToken

Parameters:

scope - name of the scope

Returns:

true if scope is available

hasLocalScope

public boolean hasLocalScope(@Nonnull
                             String scope)

Check if a local scope is available in the authentication token.
Requires a ScopeConverter to be configured with withScopeConverter(ScopeConverter).

Specified by:

hasLocalScope in interface AccessToken

Parameters:

scope - name of local scope (without the appId)

Returns:

true if local scope is available

getGrantType

public GrantType getGrantType()

Description copied from interface: AccessToken

Returns the grant type of the jwt token.

Specified by:

getGrantType in interface AccessToken

Returns:

the grant type