com.nimbusds.openid.connect.sdk.claims

Enum ClaimsTransport

java.lang.Object

java.lang.Enum<ClaimsTransport>

com.nimbusds.openid.connect.sdk.claims.ClaimsTransport

All Implemented Interfaces:

Serializable, Comparable<ClaimsTransport>

public enum ClaimsTransport
extends Enum<ClaimsTransport>

Enumeration of the available claims transports.

Enum Constant Summary

Enum Constants

Enum Constant and Description
ID_TOKEN The claims are returned with the ID token.
USERINFO The claims are returned at the UserInfo endpoint.

Method Summary

Methods

Modifier and Type	Method and Description
static ClaimsTransport	getDefault() Returns the default claims transport.
static ClaimsTransport	valueOf(String name) Returns the enum constant of this type with the specified name.
static ClaimsTransport[]	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

USERINFO

public static final ClaimsTransport USERINFO

The claims are returned at the UserInfo endpoint.

ID_TOKEN

public static final ClaimsTransport ID_TOKEN

The claims are returned with the ID token.

Method Detail

values

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

Returns:

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

valueOf

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

getDefault

public static ClaimsTransport getDefault()

Returns the default claims transport.

Returns:

The default claims transport.