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

Modifier and Type	Class	Description
static class	RefreshTokenClaimsSet.Builder	Builder to create instance of RefreshTokenClaimsSet.

Field Summary

Fields

Modifier and Type	Field	Description
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_AUDIENCE, 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_LEGACY_CLIENTID, KEY_NONCE, KEY_NOTBEFORE_TIME, 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)	Deprecated, for removal: This API element is subject to removal in a future version.

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, getAudience, getAuthenticationTime, getClaimsRequest, getClaimsSet, getClientID, getCodeChallenge, getConsentedClaims, getDeliveryClaims, getExp, getID, getIDTokenDeliveryClaims, getIssuedAt, getIssuer, getNonce, getNotBefore, getPrincipal, getRedirectURI, getScope, getSubject, getType, getUserinfoDeliveryClaims, isConsentEnabled, isExpired, isTimeValid, 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

@Nonnull
@NotEmpty
private static final String VALUE_TYPE_RF

Value of refresh token claims set type.

See Also:

Constant Field Values

Constructor Detail

RefreshTokenClaimsSet

@Deprecated(since="3.1.0",
            forRemoval=true)
public RefreshTokenClaimsSet(@Nonnull
                             TokenClaimsSet tokenClaimsSet,
                             @Nonnull
                             Instant iat,
                             @Nonnull
                             Instant exp)

Deprecated, for removal: This API element is subject to removal in a future version.

Constructor for refresh token claims set when derived from existing claim set.

Parameters:

tokenClaimsSet - code or token this token is based on

iat - new issue time of the token

exp - new expiration time of the token

RefreshTokenClaimsSet

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

Private constructor for the parser.

Parameters:

refreshTokenClaimsSet - refresh token claims set

Method Detail

parse

@Nonnull
public static RefreshTokenClaimsSet parse(@Nonnull @NotEmpty
                                          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

@Nonnull
public static RefreshTokenClaimsSet parse(@Nonnull @NotEmpty
                                          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