de.samply.bbmri.auth.client.jwt

Class JwtAccessToken

java.lang.Object

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

de.samply.bbmri.auth.client.jwt.JwtAccessToken

All Implemented Interfaces:

Serializable

public class JwtAccessToken
extends AbstractJwt

The client side Jwt access token. Checks the signature and validity of a serialized Jwt. Contains informations about access control. Use this token in the Authorization Header in HTTP requests.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
JwtAccessToken(de.samply.common.config.OAuth2Client config, String serialized) AbstractJwt.AbstractJwt(OAuth2Client, String).
JwtAccessToken(PublicKey key, String serialized) AbstractJwt.AbstractJwt(PublicKey, String).

Method Summary

Modifier and Type	Method and Description
String	getHeader() Returns the string that must be used in the "Authorization" header.
List<String>	getScopes() Returns all scopes this access token was issued for.
String	getState() Returns the included state from the request.
protected String	getTokenType() This method must return one of the currently defined token types.
boolean	isExtended() Checks if there this is an extended access token.

Methods inherited from class de.samply.bbmri.auth.client.jwt.AbstractJwt

getClaimsSet, getPublicKey, getSerialized, getSubject, isValid

Methods inherited from class java.lang.Object

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

Constructor Detail

JwtAccessToken

public JwtAccessToken(PublicKey key,
                      String serialized)
               throws JwtException

AbstractJwt.AbstractJwt(PublicKey, String).

Parameters:

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

JwtAccessToken

public JwtAccessToken(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

Method Detail

getScopes

public List<String> getScopes()

Returns all scopes this access token was issued for.

Returns:

the list of scopes

isExtended

public boolean isExtended()

Checks if there this is an extended access token.

Returns:

if the access token is extended

getState

public String getState()

Returns the included state from the request.

Returns:

the included state

getHeader

public String getHeader()

Returns the string that must be used in the "Authorization" header.

Returns:

Bearer + token

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