com.nimbusds.openid.connect.sdk.claims

Enum ClaimType

java.lang.Object

java.lang.Enum<ClaimType>

com.nimbusds.openid.connect.sdk.claims.ClaimType

All Implemented Interfaces:

Serializable, Comparable<ClaimType>

public enum ClaimType
extends Enum<ClaimType>

Enumeration of the claim types.

Related specifications:

• OpenID Connect Core 1.0, section 5.6.
• OpenID Connect Discovery 1.0, section 3.

Enum Constant Summary

Enum Constants

Enum Constant and Description
AGGREGATED Claims that are asserted by a claims provider other than the OpenID Connect Provider but are returned by OpenID Connect provider.
DISTRIBUTED Claims that are asserted by a claims provider other than the OpenID Connect provider but are returned as references by the OpenID Connect provider.
NORMAL Claims that are directly asserted by the OpenID Connect provider.

Method Summary

Methods

Modifier and Type	Method and Description
static ClaimType	parse(String s) Parses a claim type.
String	toString() Returns the string identifier of this claim type.
static ClaimType	valueOf(String name) Returns the enum constant of this type with the specified name.
static ClaimType[]	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, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

NORMAL

public static final ClaimType NORMAL

Claims that are directly asserted by the OpenID Connect provider.

AGGREGATED

public static final ClaimType AGGREGATED

Claims that are asserted by a claims provider other than the OpenID Connect Provider but are returned by OpenID Connect provider.

DISTRIBUTED

public static final ClaimType DISTRIBUTED

Claims that are asserted by a claims provider other than the OpenID Connect provider but are returned as references by the OpenID Connect provider.

Method Detail

values

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

Returns:

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

valueOf

public static ClaimType 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

toString

public String toString()

Returns the string identifier of this claim type.

Overrides:

toString in class Enum<ClaimType>

Returns:

The string identifier.

parse

public static ClaimType parse(String s)
                       throws ParseException

Parses a claim type.

Parameters:

s - The string to parse. Must not be null.

Returns:

The claim type.

Throws:

ParseException