com.authlete.common.types

Enum DeliveryMode

java.lang.Object

java.lang.Enum<DeliveryMode>

com.authlete.common.types.DeliveryMode

All Implemented Interfaces:

Serializable, Comparable<DeliveryMode>

public enum DeliveryMode
extends Enum<DeliveryMode>

Backchannel token delivery mode defined in the specification of CIBA (Client Initiated Backchannel Authentication).

Since:

2.32

Enum Constant Summary

Enum Constants

Enum Constant and Description
PING Ping mode, a backchannel token delivery mode where a client is notified via its client notification endpoint and then gets tokens from the token endpoint.
POLL Poll mode, a backchannel token delivery mode where a client polls the token endpoint until it gets tokens.
PUSH Push mode, a backchannel token delivery mode where a client receives tokens at its client notification endpoint.

Method Summary

Modifier and Type	Method and Description
static DeliveryMode	getByValue(short value) Find an instance of this enum by a value.
short	getValue() Get the integer representation of this enum instance.
static DeliveryMode	parse(String grantType) Convert String to DeliveryMode.
static DeliveryMode[]	toArray(int bits)
static int	toBits(EnumSet<DeliveryMode> set)
static EnumSet<DeliveryMode>	toSet(DeliveryMode[] array)
static EnumSet<DeliveryMode>	toSet(int bits)
String	toString()
static DeliveryMode	valueOf(String name) Returns the enum constant of this type with the specified name.
static DeliveryMode[]	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

POLL

public static final DeliveryMode POLL

Poll mode, a backchannel token delivery mode where a client polls the token endpoint until it gets tokens.

PING

public static final DeliveryMode PING

Ping mode, a backchannel token delivery mode where a client is notified via its client notification endpoint and then gets tokens from the token endpoint.

PUSH

public static final DeliveryMode PUSH

Push mode, a backchannel token delivery mode where a client receives tokens at its client notification endpoint.

Method Detail

values

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

Returns:

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

valueOf

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

getValue

public short getValue()

Get the integer representation of this enum instance.

toString

public String toString()

Overrides:

toString in class Enum<DeliveryMode>

getByValue

public static DeliveryMode getByValue(short value)

Find an instance of this enum by a value.

Parameters:

value - The integer representation of the instance to find.

Returns:

An instance of this enum, or null if not found.

parse

public static DeliveryMode parse(String grantType)

Convert String to DeliveryMode.

Parameters:

grantType - A backchannel token delivery mode. For example, "poll".

Returns:

DeliveryMode instance, or null.

toBits

public static int toBits(EnumSet<DeliveryMode> set)

toArray

public static DeliveryMode[] toArray(int bits)

toSet

public static EnumSet<DeliveryMode> toSet(int bits)

toSet

public static EnumSet<DeliveryMode> toSet(DeliveryMode[] array)