de.samply.auth.client.jwt

Class JWTIDToken

java.lang.Object

de.samply.auth.client.jwt.AbstractJWT

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

Methods

Modifier and Type	Method and Description
String	getEmail() Returns the users real email address
String	getExternalLabel() Returns the label of the external identity provider, might be null.
String	getLanguage() Returns the language the user selected in Samply.Auth.
String	getName() Returns the real name, or an empty string if this information is not available.
List<String>	getRoles() Returns a list of roles
protected String	getTokenType() This method must return one of the currently defined token types:
Usertype	getUsertype() Returns the usertype, one of "NORMAL", "REGISTRY", "BRIDGEHEAD".
boolean	isValid() Checks if this JWT is valid.

Methods inherited from class de.samply.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 -

publicKey -

serialized -

Throws:

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.

getEmail

public String getEmail()

Returns the users real email address

Returns:

the users real email address

getName

public String getName()

Returns the real name, or an empty string if this information is not available.

Returns:

the users real name

getLanguage

public String getLanguage()

Returns the language the user selected in Samply.Auth. Always "en" at this point.

Returns:

the language the user selected in the identity provider

getUsertype

public Usertype getUsertype()

Returns the usertype, one of "NORMAL", "REGISTRY", "BRIDGEHEAD".

Returns:

getExternalLabel

public String getExternalLabel()

Returns the label of the external identity provider, might be null.

Returns:

getRoles

public List<String> getRoles()

Returns a list of roles

Returns:

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: