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

Class AccessTokenClaimsSet.Builder

java.lang.Object

net.shibboleth.idp.plugin.oidc.op.token.support.TokenClaimsSet.Builder<AccessTokenClaimsSet>

net.shibboleth.idp.plugin.oidc.op.token.support.AccessTokenClaimsSet.Builder

Enclosing class:

AccessTokenClaimsSet

public static final class AccessTokenClaimsSet.Builder
extends TokenClaimsSet.Builder<AccessTokenClaimsSet>

Builder to create instance of AccessTokenClaimsSet.

Field Summary

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

acr, audience, authTime, codeChallenge, consentedClaims, consentEnabled, customClaims, dlClaims, dlClaimsID, dlClaimsUI, exp, iat, iss, jwtid, nbt, nonce, principal, redirect, reqClaims, reqScope, rpId, sub

Constructor Summary

Constructors

Modifier	Constructor	Description
	Builder()	Default constructor.
private	Builder(TokenClaimsSet existing)	Bases a builder on an existing token claims set.
	Builder(TokenClaimsSet existing, com.nimbusds.oauth2.sdk.Scope scope, com.nimbusds.openid.connect.sdk.claims.ClaimsSet dlClaims, com.nimbusds.openid.connect.sdk.claims.ClaimsSet dlClaimsUI, Instant iat, Instant exp)	Constructor for access token claims set when derived from existing claims set.
	Builder(IdentifierGenerationStrategy idGenerator, com.nimbusds.oauth2.sdk.id.ClientID clientID, String issuer, String userPrincipal, String subject, Instant issuedAt, Instant expiresAt, Instant authenticationTime, URI redirectURI, com.nimbusds.oauth2.sdk.Scope scope)	Deprecated, for removal: This API element is subject to removal in a future version.

Method Summary

Modifier and Type	Method	Description
AccessTokenClaimsSet	build()	Builds AccessTokenClaimsSet.

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

addCustomClaim, buildJWTClaimsSet, setACR, setAudience, setAuthenticationTime, setClaims, setClaimsRequest, setClientID, setCodeChallenge, setConsentedClaims, setConsentEnabled, setCustomClaims, setDlClaims, setDlClaimsID, setDlClaimsUI, setExpiresAt, setIssuedAt, setIssuer, setJWTID, setJWTID, setNonce, setNotBefore, setPrincipal, setRedirectURI, setScope, setSubject

Methods inherited from class java.lang.Object

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

Constructor Detail

Builder

public Builder()

Default constructor.

Since:

3.1.0

Builder

@Deprecated(since="3.1.0",
            forRemoval=true)
public Builder(@Nonnull
               IdentifierGenerationStrategy idGenerator,
               @Nonnull
               com.nimbusds.oauth2.sdk.id.ClientID clientID,
               @Nonnull
               String issuer,
               @Nonnull
               String userPrincipal,
               @Nonnull
               String subject,
               @Nonnull
               Instant issuedAt,
               @Nonnull
               Instant expiresAt,
               @Nonnull
               Instant authenticationTime,
               @Nonnull
               URI redirectURI,
               @Nonnull
               com.nimbusds.oauth2.sdk.Scope scope)

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

Constructor for access token builder.

Parameters:

idGenerator - Generator for pseudo unique identifier for the code

clientID - Client Id of the rp

issuer - OP issuer value

userPrincipal - User Principal of the authenticated user

subject - subject of the authenticated user

issuedAt - Issue time of the authorize code

expiresAt - Expiration time of the authorize code

authenticationTime - Authentication time of the user

redirectURI - Validated redirect URI of the authentication request

scope - Scope of the authentication request

Builder

public Builder(@Nonnull
               TokenClaimsSet existing,
               @Nonnull
               com.nimbusds.oauth2.sdk.Scope scope,
               @Nullable
               com.nimbusds.openid.connect.sdk.claims.ClaimsSet dlClaims,
               @Nullable
               com.nimbusds.openid.connect.sdk.claims.ClaimsSet dlClaimsUI,
               @Nonnull
               Instant iat,
               @Nonnull
               Instant exp)

Constructor for access token claims set when derived from existing claims set.

Parameters:

existing - Authorize Code / Refresh Token this token is based on

scope - Validated and possibly reduced scope of the authentication request

dlClaims - Claims set for token delivery.

dlClaimsUI - Claims set for token delivery, user info only.

iat - Issue time of the token

exp - Expiration time of the token

Since:

3.1.0

Builder

private Builder(@Nonnull
                TokenClaimsSet existing)

Bases a builder on an existing token claims set.

Parameters:

existing - existing claim set

Method Detail

build

public AccessTokenClaimsSet build()

Builds AccessTokenClaimsSet.

Specified by:

build in class TokenClaimsSet.Builder<AccessTokenClaimsSet>

Returns:

AccessTokenClaimsSet instance

Since:

3.1.0