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() Returns the (empty) list of audiences the token is issued for.
JsonObject	getClaimAsJsonObject(String claimName) Extracts the value of the given as a JsonObject.
String	getClaimAsString(String claimName) Extracts the value as string for the given claim.
List<String>	getClaimAsStringList(String claimName) Extracts the value as a list of strings for the given claim.
java.time.Instant	getExpiration() Returns the moment in time when the token will be expired.
String	getHeaderParameterAsString(String headerName) Returns the header parameter value as string for the given header parameter name.
java.time.Instant	getNotBefore() Returns the moment in time before which the token must not be accepted.
String	getTokenValue() Get the encoded jwt token, e.g.
boolean	hasClaim(String claimName) Checks whether the token contains a given claim.
int	hashCode()
boolean	hasHeaderParameter(String parameterName) Checks whether the token contains a given header parameter.
boolean	isExpired() Returns true if the token is expired.

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)

Description copied from interface: Token

Returns the header parameter value as string for the given header parameter name.

Specified by:

getHeaderParameterAsString in interface Token

Parameters:

headerName - the name of the header parameter as defined here TokenHeader

Returns:

the value for the given header name or null, if the header is not provided.

hasClaim

public boolean hasClaim(@Nonnull
                        String claimName)

Description copied from interface: Token

Checks whether the token contains a given claim.

Specified by:

hasClaim in interface Token

Parameters:

claimName - the name of the claim as defined here TokenClaims.

Returns:

true when the claim with the given name is found.

hasHeaderParameter

public boolean hasHeaderParameter(@Nonnull
                                  String parameterName)

Description copied from interface: Token

Checks whether the token contains a given header parameter.

Specified by:

hasHeaderParameter in interface Token

Parameters:

parameterName - the name of the header parameter as defined here TokenHeader

Returns:

true when the given header name is found.

getClaimAsString

@Nullable
public String getClaimAsString(@Nonnull
                                         String claimName)

Description copied from interface: Token

Extracts the value as string for the given claim. If the claim is not found, it will return null. If the given claim is not a string, it will throw a JsonParsingException.

Specified by:

getClaimAsString in interface Token

Parameters:

claimName - the name of the claim as defined here TokenClaims.

Returns:

the corresponding string value of the given claim or null.

getClaimAsStringList

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

Description copied from interface: Token

Extracts the value as a list of strings for the given claim. If the claim is not found, it will return null. If the given claim is not a list of strings, it will throw a JsonParsingException.

Specified by:

getClaimAsStringList in interface Token

Parameters:

claimName - the name of the claim as defined here TokenClaims.

Returns:

the data of the given claim as a list of strings or an empty list.

getClaimAsJsonObject

@Nullable
public JsonObject getClaimAsJsonObject(String claimName)

Description copied from interface: Token

Extracts the value of the given as a JsonObject. Use this to extract nested objects. If the claim is not found, it will return null. If the vale for the given claim is not an object, it will throw a JsonParsingException.

Specified by:

getClaimAsJsonObject in interface Token

Parameters:

claimName - the name of the claim for which the object should be extracted.

Returns:

the corresponding JsonObject for the given claim.

getExpiration

@Nullable
public java.time.Instant getExpiration()

Description copied from interface: Token

Returns the moment in time when the token will be expired.

Specified by:

getExpiration in interface Token

Returns:

the expiration point in time if present.

isExpired

public boolean isExpired()

Description copied from interface: Token

Returns true if the token is expired.

Specified by:

isExpired in interface Token

Returns:

true if the token is expired.

getNotBefore

@Nullable
public java.time.Instant getNotBefore()

Description copied from interface: Token

Returns the moment in time before which the token must not be accepted.

Specified by:

getNotBefore in interface Token

Returns:

the not before point in time if present.

getTokenValue

public String getTokenValue()

Description copied from interface: Token

Get the encoded jwt token, e.g. for token forwarding to another app.

Never expose this token via log or via HTTP.

Specified by:

getTokenValue in interface Token

Returns:

the encoded token.

getAudiences

public Set<String> getAudiences()

Description copied from interface: Token

Returns the (empty) list of audiences the token is issued for.

Specified by:

getAudiences in interface Token

Returns:

the audiences.

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