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

Enum JWTClaims

java.lang.Object

java.lang.Enum<JWTClaims>

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

All Implemented Interfaces:

Serializable, Comparable<JWTClaims>

public enum JWTClaims
extends Enum<JWTClaims>

Enum that represents the standard set of registered JWT claims.

Enum Constant Summary

Enum Constants

Enum Constant	Description
AUDIENCE_CLAIM	Audience(s) that this ID Token is intended for.
EXPIRATION_TIME_CLAIM	Expiration time on or after which the ID Token MUST NOT be accepted for processing.
ISSUED_AT_CLAIM	Time at which the JWT was issued.
ISSUER_CLAIM	Issuer Identifier for the Issuer of the response.
JWT_ID_CLAIM	The "jti" (JWT ID) claim provides a unique identifier for the JWT.
NOT_BEFORE_CLAIM	The "nbf" (not before) claim identifies the time before which the JWT MUST NOT be accepted for processing.
SUBJECT_CLAIM	Subject Identifier.

Field Summary

Fields

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

Constructor Summary

Constructors

Modifier	Constructor	Description
private	JWTClaims(String name)	Constructor.

Method Summary

Modifier and Type	Method	Description
String	getClaimName()	Get the IANA registered claim name.
static JWTClaims	valueOf(String name)	Returns the enum constant of this type with the specified name.
static JWTClaims[]	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

JWT_ID_CLAIM

public static final JWTClaims JWT_ID_CLAIM

The "jti" (JWT ID) claim provides a unique identifier for the JWT.

ISSUER_CLAIM

public static final JWTClaims ISSUER_CLAIM

Issuer Identifier for the Issuer of the response.

SUBJECT_CLAIM

public static final JWTClaims SUBJECT_CLAIM

Subject Identifier. A locally unique and never reassigned identifier within the Issuer for the End-User.

AUDIENCE_CLAIM

public static final JWTClaims AUDIENCE_CLAIM

Audience(s) that this ID Token is intended for.

EXPIRATION_TIME_CLAIM

public static final JWTClaims EXPIRATION_TIME_CLAIM

Expiration time on or after which the ID Token MUST NOT be accepted for processing.

ISSUED_AT_CLAIM

public static final JWTClaims ISSUED_AT_CLAIM

Time at which the JWT was issued.

NOT_BEFORE_CLAIM

public static final JWTClaims NOT_BEFORE_CLAIM

The "nbf" (not before) claim identifies the time before which the JWT MUST NOT be accepted for processing.

Field Detail

claimName

@Nonnull
@NotEmpty
private final String claimName

The IANA registered claim name.

Constructor Detail

JWTClaims

private JWTClaims(@Nonnull @NotEmpty
                  String name)

Constructor.

Parameters:

name - the IANA registered claim name.

Method Detail

values

public static JWTClaims[] 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 (JWTClaims c : JWTClaims.values())
    System.out.println(c);

Returns:

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

valueOf

public static JWTClaims 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 IANA registered claim name.

Returns:

the IANA registered claim name.