de.samply.bbmri.auth.client.jwt

Class AbstractJwt

java.lang.Object

de.samply.bbmri.auth.client.jwt.AbstractJwt

All Implemented Interfaces:

Serializable

Direct Known Subclasses:

JwtAccessToken, JwtIdToken, JwtRefreshToken

public abstract class AbstractJwt
extends Object
implements Serializable

The abstract client-side Jwt used to verify a serialized Jwt using the providers public key.

See Also:

Serialized Form

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AbstractJwt(de.samply.common.config.OAuth2Client config, String serialized) Initializes this Jwt with an OAuth2Client configuration and the serialized string.
protected	AbstractJwt(PublicKey publicKey, String serialized) Initializes this Jwt with a public key and the serialized string.

Method Summary

Modifier and Type	Method and Description
com.nimbusds.jwt.JWTClaimsSet	getClaimsSet() Returns all claims.
PublicKey	getPublicKey() Returns the public key that has been used to verify this Jwt.
String	getSerialized() Returns the serialized string of this Jwt.
String	getSubject() Returns the subject.
protected abstract String	getTokenType() This method must return one of the currently defined token types.
boolean	isValid() Checks if this Jwt is valid.

Methods inherited from class java.lang.Object

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

Constructor Detail

AbstractJwt

protected AbstractJwt(de.samply.common.config.OAuth2Client config,
                      String serialized)
               throws JwtException

Initializes this Jwt with an OAuth2Client configuration and the serialized string. The public key is loaded from the base64 format in the OAuth2Client configuration.

Parameters:

config - the OAuth2 client side configuration. The public key is needed to check the signature.

serialized - the serialized Jwt

Throws:

JwtException - if any error occurs during deserialization or signature verification

AbstractJwt

protected AbstractJwt(PublicKey publicKey,
                      String serialized)
               throws JwtException

Initializes this Jwt with a public key and the serialized string. The public key is used to check the signature.

Parameters:

publicKey - The identity providers public key (needed to check the signature)

serialized - the serialized Jwt

Throws:

JwtException - if any error occurs during deserialization or signature verification

Method Detail

isValid

public boolean isValid()

Checks if this Jwt is valid. The signature is checked once, the expiration date is checked every time this method is called.

Returns:

a boolean.

getClaimsSet

public com.nimbusds.jwt.JWTClaimsSet getClaimsSet()

Returns all claims.

Returns:

a JWTClaimsSet object.

getSerialized

public String getSerialized()

Returns the serialized string of this Jwt.

Returns:

a String object.

getSubject

public String getSubject()

Returns the subject. This should be used as an user ID.

Returns:

a String object.

getPublicKey

public PublicKey getPublicKey()

Returns the public key that has been used to verify this Jwt.

Returns:

the publicKey

getTokenType

protected abstract String getTokenType()

This method must return one of the currently defined token types.

 ACCESS_TOKEN
 ID_TOKEN
 REFRESH_TOKEN
 

Returns:

typ of the token