Package com.sap.cloud.security.token

Class AbstractToken

java.lang.Object

com.sap.cloud.security.token.AbstractToken

All Implemented Interfaces:

Token, Serializable

Direct Known Subclasses:

SapIdToken, XsuaaToken

public abstract class AbstractToken
extends Object
implements Token

Decodes and parses encoded JSON Web Token (JWT) and provides access to token header parameters and claims.

See Also:

• Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
protected final DefaultJsonObject	tokenBody
protected final DefaultJsonObject	tokenHeader

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

DEFAULT_TOKEN_FACTORY, services

Constructor Summary

Constructors

Constructor	Description
AbstractToken(DecodedJwt decodedJwt)
AbstractToken(String jwtToken)	Creates a Token object for simple access to the header parameters and its claims.

Method Summary

Modifier and Type	Method	Description
protected Principal	createPrincipalByName(String name)
boolean	equals(Object obj)
JsonObject	getClaimAsJsonObject(String claimName)
String	getClaimAsString(String claimName)
List<String>	getClaimAsStringList(String claimName)
Map<String,Object>	getClaims()
Instant	getExpiration()
String	getHeaderParameterAsString(String headerName)
Map<String,Object>	getHeaders()
Instant	getNotBefore()
String	getTokenValue()
boolean	hasClaim(String claimName)
int	hashCode()
boolean	hasHeaderParameter(String parameterName)
boolean	isExpired()
boolean	isXsuaaToken()
String	toString()

Methods inherited from class java.lang.Object

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

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

getAppTid, getAttributeFromClaimAsString, getAttributeFromClaimAsStringList, getAudiences, getClientId, getGrantType, getIssuer, getPrincipal, getService, getZoneId

Field Details

tokenHeader

protected final DefaultJsonObject tokenHeader

tokenBody

protected final DefaultJsonObject tokenBody

Constructor Details

AbstractToken

public AbstractToken(@Nonnull
 DecodedJwt decodedJwt)

AbstractToken

public AbstractToken(@Nonnull
 String jwtToken)

Creates a Token object for simple access to the header parameters and its claims.

Parameters:

jwtToken - the encoded JWT token (access_token or id_token), e.g. from the Authorization Header.

Method Details

getHeaderParameterAsString

@Nullable
public String getHeaderParameterAsString(@Nonnull
 String headerName)

Specified by:

getHeaderParameterAsString in interface Token

hasClaim

public boolean hasClaim(@Nonnull
 String claimName)

Specified by:

hasClaim in interface Token

hasHeaderParameter

public boolean hasHeaderParameter(@Nonnull
 String parameterName)

Specified by:

hasHeaderParameter in interface Token

getClaimAsString

@Nullable
public String getClaimAsString(@Nonnull
 String claimName)

Specified by:

getClaimAsString in interface Token

getClaimAsStringList

@Nonnull
public List<String> getClaimAsStringList(@Nonnull
 String claimName)

Specified by:

getClaimAsStringList in interface Token

getClaimAsJsonObject

@Nullable
public JsonObject getClaimAsJsonObject(@Nonnull
 String claimName)

Specified by:

getClaimAsJsonObject in interface Token

getExpiration

@Nullable
public Instant getExpiration()

Specified by:

getExpiration in interface Token

isExpired

public boolean isExpired()

Specified by:

isExpired in interface Token

getNotBefore

@Nullable
public Instant getNotBefore()

Specified by:

getNotBefore in interface Token

getTokenValue

public String getTokenValue()

Specified by:

getTokenValue in interface Token

isXsuaaToken

public boolean isXsuaaToken()

createPrincipalByName

protected Principal createPrincipalByName(String name)

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object

getHeaders

public Map<String,Object> getHeaders()

Specified by:

getHeaders in interface Token

getClaims

public Map<String,Object> getClaims()

Specified by:

getClaims in interface Token