Package net.shibboleth.oidc.security.jwt.claims.impl

Enum IDTokenClaims

java.lang.Object

java.lang.Enum<IDTokenClaims>

net.shibboleth.oidc.security.jwt.claims.impl.IDTokenClaims

All Implemented Interfaces:

Serializable, Comparable<IDTokenClaims>

public enum IDTokenClaims
extends Enum<IDTokenClaims>

Enum of those OIDC ID token claims that are not part of the standard JWT claims set.

Enum Constant Summary

Enum Constants

Enum Constant	Description
AUTHENTICATION_CONTEXT_CLASS_REFERENCE	Authentication Context Class Reference.
AUTHENTICATION_METHODS_REFERENCES	Authentication Methods References.
AUTHENTICATION_TIME	Time when the End-User authentication occurred.
AUTHORIZED_PARTY	Authorized party - the party to which the ID Token was issued.
NONCE	String value used to associate a Client session with an ID Token, and to mitigate replay attacks.

Field Summary

Fields

Modifier and Type	Field	Description
private String	claimName	The registered claim name.

Constructor Summary

Constructors

Modifier	Constructor	Description
private	IDTokenClaims(String name)	Constructor.

Method Summary

Modifier and Type	Method	Description
String	getClaimName()	Get the registered claim name.
static IDTokenClaims	valueOf(String name)	Returns the enum constant of this type with the specified name.
static IDTokenClaims[]	values()	Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

AUTHENTICATION_TIME

public static final IDTokenClaims AUTHENTICATION_TIME

Time when the End-User authentication occurred.

NONCE

public static final IDTokenClaims NONCE

String value used to associate a Client session with an ID Token, and to mitigate replay attacks.

AUTHENTICATION_CONTEXT_CLASS_REFERENCE

public static final IDTokenClaims AUTHENTICATION_CONTEXT_CLASS_REFERENCE

Authentication Context Class Reference.

AUTHENTICATION_METHODS_REFERENCES

public static final IDTokenClaims AUTHENTICATION_METHODS_REFERENCES

Authentication Methods References.

AUTHORIZED_PARTY

public static final IDTokenClaims AUTHORIZED_PARTY

Authorized party - the party to which the ID Token was issued.

Field Detail

claimName

@Nonnull
@NotEmpty
private final String claimName

The registered claim name.

Constructor Detail

IDTokenClaims

private IDTokenClaims(@Nonnull @NotEmpty
                      String name)

Constructor.

Parameters:

name - the registered claim name.

Method Detail

values

public static IDTokenClaims[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (IDTokenClaims c : IDTokenClaims.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static IDTokenClaims valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null

getClaimName

@Nonnull
public String getClaimName()

Get the registered claim name.

Returns:

the registered claim name.