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

Class RegistrationClaimsSet.Builder

java.lang.Object

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

Enclosing class:

RegistrationClaimsSet

public static class RegistrationClaimsSet.Builder
extends Object

The builder for RegistrationClaimsSet.

Field Summary

Fields

Modifier and Type	Field	Description
private String	authContext	The authentication context class reference value of the performed authentication.
private Instant	authTime	The authentication time of the performed authentication.
private String	clientId	Client identifier.
private Instant	expiration	Expiration time of the token.
private Instant	issuedAt	Issuance time of the token.
private String	issuer	Issuer of the token.
private String	jti	Identifier for the token.
private String	keyType	Type of the token.
private Map<String,MetadataPolicy>	metadata	Allowed metadata values to be issued with the token.
private String	principal	The principal who issued the token.
private String	relyingPartyId	Relying party identifier.
private Boolean	replacement	Flag to signal replacement use of the token.

Constructor Summary

Constructors

Constructor	Description
Builder(String id)	Constructor.

Method Summary

Modifier and Type	Method	Description
RegistrationClaimsSet	build()	Build the claims set object.
RegistrationClaimsSet.Builder	withAcr(String acr)	Set the authentication context class reference value of the performed authentication.
RegistrationClaimsSet.Builder	withAuthTime(Instant time)	Set the authentication time of the performed authentication.
RegistrationClaimsSet.Builder	withClientId(String id)	Set the client identifier.
RegistrationClaimsSet.Builder	withExpiration(Instant exp)	Set the expiration time of the token.
RegistrationClaimsSet.Builder	withIssuedAt(Instant iat)	Set the issuance time of the token.
RegistrationClaimsSet.Builder	withIssuer(String iss)	Sets the issuer of the token.
RegistrationClaimsSet.Builder	withMetadata(Map<String,MetadataPolicy> data)	Set the allowed metadata values to be issued with the token.
RegistrationClaimsSet.Builder	withPrincipal(String prncpl)	Set the principal who issued the token.
RegistrationClaimsSet.Builder	withRelyingPartyId(String id)	Set the relying party identifier.
RegistrationClaimsSet.Builder	withReplacement(Boolean flag)	Set the flag to signal replacement use of the token.
RegistrationClaimsSet.Builder	withType(String type)	Sets the type of the token.

Methods inherited from class java.lang.Object

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

Field Details

jti

@Nullable
@NotEmpty
private String jti

Identifier for the token.

keyType

@Nullable
@NotEmpty
private String keyType

Type of the token.

issuer

@Nullable
@NotEmpty
private String issuer

Issuer of the token.

expiration

@Nullable
private Instant expiration

Expiration time of the token.

issuedAt

@Nullable
private Instant issuedAt

Issuance time of the token.

principal

@Nullable
@NotEmpty
private String principal

The principal who issued the token.

authContext

@Nullable
@NotEmpty
private String authContext

The authentication context class reference value of the performed authentication.

authTime

@Nullable
private Instant authTime

The authentication time of the performed authentication.

metadata

@Nullable
@NonnullElements
private Map<String,MetadataPolicy> metadata

Allowed metadata values to be issued with the token.

relyingPartyId

@Nullable
@NotEmpty
private String relyingPartyId

Relying party identifier.

clientId

@Nullable
@NotEmpty
private String clientId

Client identifier.

replacement

@Nullable
private Boolean replacement

Flag to signal replacement use of the token.

Constructor Details

Builder

public Builder(@Nullable @NotEmpty
 String id)

Constructor.

Parameters:

id - The identifier for the token.

Method Details

withType

public RegistrationClaimsSet.Builder withType(@Nullable @NotEmpty
 String type)

Sets the type of the token.

Parameters:

type - What to set.

Returns:

The builder instance.

withIssuer

public RegistrationClaimsSet.Builder withIssuer(@Nullable @NotEmpty
 String iss)

Sets the issuer of the token.

Parameters:

iss - What to set.

Returns:

The builder instance.

withExpiration

public RegistrationClaimsSet.Builder withExpiration(@Nullable
 Instant exp)

Set the expiration time of the token.

Parameters:

exp - What to set.

Returns:

The builder instance.

withIssuedAt

public RegistrationClaimsSet.Builder withIssuedAt(@Nullable
 Instant iat)

Set the issuance time of the token.

Parameters:

iat - What to set.

Returns:

The builder instance.

withPrincipal

public RegistrationClaimsSet.Builder withPrincipal(@Nullable @NotEmpty
 String prncpl)

Set the principal who issued the token.

Parameters:

prncpl - What to set.

Returns:

The builder instance.

withAcr

public RegistrationClaimsSet.Builder withAcr(@Nullable @NotEmpty
 String acr)

Set the authentication context class reference value of the performed authentication.

Parameters:

acr - What to set.

Returns:

The builder instance.

withAuthTime

public RegistrationClaimsSet.Builder withAuthTime(@Nullable
 Instant time)

Set the authentication time of the performed authentication.

Parameters:

time - What to set.

Returns:

The builder instance.

withMetadata

public RegistrationClaimsSet.Builder withMetadata(@Nullable @NonnullElements
 Map<String,MetadataPolicy> data)

Set the allowed metadata values to be issued with the token.

Parameters:

data - What to set.

Returns:

The builder instance.

withRelyingPartyId

public RegistrationClaimsSet.Builder withRelyingPartyId(@Nullable @NotEmpty
 String id)

Set the relying party identifier.

Parameters:

id - What to set.

Returns:

The builder instance.

withClientId

public RegistrationClaimsSet.Builder withClientId(@Nullable @NotEmpty
 String id)

Set the client identifier.

Parameters:

id - What to set

Returns:

The builder instance.

withReplacement

public RegistrationClaimsSet.Builder withReplacement(@Nullable
 Boolean flag)

Set the flag to signal replacement use of the token.

Parameters:

flag - What to set

Returns:

The builder instance

build

@Nonnull
public RegistrationClaimsSet build()

Build the claims set object.

Returns:

The claims set object.