Package net.shibboleth.idp.plugin.oidc.op.token.support

Class RefreshTokenClaimsSet

java.lang.Object

net.shibboleth.idp.plugin.oidc.op.token.support.TokenClaimsSet

net.shibboleth.idp.plugin.oidc.op.token.support.RefreshTokenClaimsSet

public final class RefreshTokenClaimsSet
extends TokenClaimsSet

Class wrapping claims set for refresh token.

Nested Class Summary

Nested classes/interfaces inherited from class net.shibboleth.idp.plugin.oidc.op.token.support.TokenClaimsSet

TokenClaimsSet.Builder<T extends TokenClaimsSet>

Field Summary

Fields

Modifier and Type	Field	Description
private org.slf4j.Logger	log	Class logger.
private static String	VALUE_TYPE_RF	Value of refresh token claims set type.

Fields inherited from class net.shibboleth.idp.plugin.oidc.op.token.support.TokenClaimsSet

KEY_AC_ID, KEY_ACR, KEY_AUTH_TIME, KEY_CLAIMS, KEY_CLIENTID, KEY_CODE_CHALLENGE, KEY_CONSENT_ENABLED, KEY_CONSENTED_CLAIMS, KEY_DELIVERY_CLAIMS, KEY_DELIVERY_CLAIMS_IDTOKEN, KEY_DELIVERY_CLAIMS_USERINFO, KEY_EXPIRATION_TIME, KEY_ISSUED_AT, KEY_ISSUER, KEY_NONCE, KEY_REDIRECT_URI, KEY_SCOPE, KEY_SUBJECT, KEY_TYPE, KEY_USER_PRINCIPAL

Constructor Summary

Constructors

Modifier	Constructor	Description
private	RefreshTokenClaimsSet(com.nimbusds.jwt.JWTClaimsSet refreshTokenClaimsSet)	Private constructor for the parser.
	RefreshTokenClaimsSet(TokenClaimsSet tokenClaimsSet, Instant iat, Instant exp)	Constructor for refresh token claims set when derived from authz code.

Method Summary

Modifier and Type	Method	Description
static RefreshTokenClaimsSet	parse(String refreshTokenClaimsSet)	Parses refresh token from string (JSON).
static RefreshTokenClaimsSet	parse(String wrappedAccessToken, DataSealer dataSealer)	Parses refresh token from sealed refresh token.

Methods inherited from class net.shibboleth.idp.plugin.oidc.op.token.support.TokenClaimsSet

getACR, getAuthenticationTime, getClaimsRequest, getClaimsSet, getClientID, getCodeChallenge, getConsentedClaims, getDeliveryClaims, getExp, getID, getIDTokenDeliveryClaims, getNonce, getPrincipal, getRedirectURI, getScope, getType, getUserinfoDeliveryClaims, isConsentEnabled, isExpired, serialize, serialize, setClaimsSet, verifyParsedClaims

Methods inherited from class java.lang.Object

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

Field Detail

VALUE_TYPE_RF

private static final String VALUE_TYPE_RF

Value of refresh token claims set type.

See Also:

Constant Field Values

log

@Nonnull
private org.slf4j.Logger log

Class logger.

Constructor Detail

RefreshTokenClaimsSet

public RefreshTokenClaimsSet(@Nonnull
                             TokenClaimsSet tokenClaimsSet,
                             @Nonnull
                             Instant iat,
                             @Nonnull
                             Instant exp)

Constructor for refresh token claims set when derived from authz code.

Parameters:

tokenClaimsSet - Authorize Code / Refresh Token this token is based on. Must not be NULL.

iat - Issue time of the token. Must not be NULL.

exp - Expiration time of the token. Must not be NULL.

Throws:

RuntimeException - if called with non allowed null parameters

RefreshTokenClaimsSet

private RefreshTokenClaimsSet(com.nimbusds.jwt.JWTClaimsSet refreshTokenClaimsSet)

Private constructor for the parser.

Parameters:

refreshTokenClaimsSet - refresh token claims set

Method Detail

parse

public static RefreshTokenClaimsSet parse(String refreshTokenClaimsSet)
                                   throws ParseException

Parses refresh token from string (JSON).

Parameters:

refreshTokenClaimsSet - JSON String representation of the code

Returns:

AccessTokenClaimsSet instance if parsing is successful.

Throws:

ParseException - if parsing fails for example due to incompatible types.

parse

public static RefreshTokenClaimsSet parse(@Nonnull
                                          String wrappedAccessToken,
                                          @Nonnull
                                          DataSealer dataSealer)
                                   throws ParseException,
                                          DataSealerException

Parses refresh token from sealed refresh token.

Parameters:

wrappedAccessToken - wrapped refresh token

dataSealer - sealer to unwrap the refresh token

Returns:

refresh token claims set.

Throws:

ParseException - is thrown if unwrapped refresh token is not understood

DataSealerException - is thrown if unwrapping fails