com.sap.cloud.security.token

Class AbstractToken

java.lang.Object

com.sap.cloud.security.token.AbstractToken

All Implemented Interfaces:

Token

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.

Field Summary

Fields

Modifier and Type	Field and Description
protected String	jwtToken
protected DefaultJsonObject	tokenBody
protected DefaultJsonObject	tokenHeader

Constructor Summary

Constructors

Constructor and 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 and Description
protected Principal	createPrincipalByName(String name)
boolean	equals(Object o)
Set<String>	getAudiences()
JsonObject	getClaimAsJsonObject(String claimName)
String	getClaimAsString(String claimName)
List<String>	getClaimAsStringList(String claimName)
java.time.Instant	getExpiration()
String	getHeaderParameterAsString(String headerName)
java.time.Instant	getNotBefore()
String	getTokenValue()
boolean	hasClaim(String claimName)
int	hashCode()
boolean	hasHeaderParameter(String parameterName)
boolean	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

getPrincipal, getService

Field Detail

tokenHeader

protected final DefaultJsonObject tokenHeader

tokenBody

protected final DefaultJsonObject tokenBody

jwtToken

protected final String jwtToken

Constructor Detail

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 Detail

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

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

Specified by:

getClaimAsStringList in interface Token

getClaimAsJsonObject

@Nullable
public JsonObject getClaimAsJsonObject(String claimName)

Specified by:

getClaimAsJsonObject in interface Token

getExpiration

@Nullable
public java.time.Instant getExpiration()

Specified by:

getExpiration in interface Token

isExpired

public boolean isExpired()

Specified by:

isExpired in interface Token

getNotBefore

@Nullable
public java.time.Instant getNotBefore()

Specified by:

getNotBefore in interface Token

getTokenValue

public String getTokenValue()

Specified by:

getTokenValue in interface Token

getAudiences

public Set<String> getAudiences()

Specified by:

getAudiences in interface Token

createPrincipalByName

protected Principal createPrincipalByName(String name)

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object