de.samply.bbmri.auth.client.jwt

Class JwtIdToken

java.lang.Object

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

de.samply.bbmri.auth.client.jwt.JwtIdToken

All Implemented Interfaces:

Serializable

public class JwtIdToken
extends AbstractJwt

The client side Jwt OpenID Token. Checks the signature and validity of a serialized OpenID ID Token Jwt. Contains for example the users real name, his email address, his address, and other fields.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
JwtIdToken(de.samply.common.config.OAuth2Client config, String serialized) AbstractJwt.AbstractJwt(OAuth2Client, String).
JwtIdToken(String clientId, PublicKey publicKey, String serialized) AbstractJwt.AbstractJwt(PublicKey, String).

Method Summary

Modifier and Type	Method and Description
List<RoleDto>	getRoles() Returns a list of roles.
protected 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 de.samply.bbmri.auth.client.jwt.AbstractJwt

getClaimsSet, getPublicKey, getSerialized, getSubject

Methods inherited from class java.lang.Object

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

Constructor Detail

JwtIdToken

public JwtIdToken(de.samply.common.config.OAuth2Client config,
                  String serialized)
           throws JwtException

AbstractJwt.AbstractJwt(OAuth2Client, String).

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

JwtIdToken

public JwtIdToken(String clientId,
                  PublicKey publicKey,
                  String serialized)
           throws JwtException

AbstractJwt.AbstractJwt(PublicKey, String).

Parameters:

clientId - Your client ID

publicKey - The IdP's public key

serialized - the serialized ID token

Throws:

JwtException - JwtException

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..

Overrides:

isValid in class AbstractJwt

Returns:

a boolean.

getRoles

public List<RoleDto> getRoles()

Returns a list of roles.

Returns:

list of roles

getTokenType

protected String getTokenType()

Description copied from class: AbstractJwt

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

 ACCESS_TOKEN
 ID_TOKEN
 REFRESH_TOKEN
 

Specified by:

getTokenType in class AbstractJwt

Returns:

typ of the token