com.authlete.common.types

Enum CodeChallengeMethod

java.lang.Object

java.lang.Enum<CodeChallengeMethod>

com.authlete.common.types.CodeChallengeMethod

All Implemented Interfaces:

Serializable, Comparable<CodeChallengeMethod>

public enum CodeChallengeMethod
extends Enum<CodeChallengeMethod>

Values for code_challenge_method.

Since:

1.21

Author:

Takahiko Kawasaki

See Also:

RFC 7636 (Proof Key for Code Exchange by OAuth Public Clients)

Enum Constant Summary

Enum Constants

Enum Constant and Description
PLAIN plain, meaning code_challenge = code_verifier.
S256 S256, meaning code_challenge = BASE64URL-ENCODE(SHA256(ASCII(code_verifier))).

Method Summary

Modifier and Type	Method and Description
static CodeChallengeMethod	getByValue(short value) Find an instance of this enum by a value.
short	getValue() Get the integer representation of this enum instance.
static CodeChallengeMethod	parse(String method) Convert String to CodeChallengeMethod.
String	toString()
static CodeChallengeMethod	valueOf(String name) Returns the enum constant of this type with the specified name.
static CodeChallengeMethod[]	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

PLAIN

public static final CodeChallengeMethod PLAIN

plain, meaning code_challenge = code_verifier. See RFC 7636 for details.

S256

public static final CodeChallengeMethod S256

S256, meaning code_challenge = BASE64URL-ENCODE(SHA256(ASCII(code_verifier))). See RFC 7636 for details.

Method Detail

values

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

Returns:

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

valueOf

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

getByValue

public static CodeChallengeMethod 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 CodeChallengeMethod parse(String method)

Convert String to CodeChallengeMethod.

Parameters:

method - A value of code_challenge_method parameter. For example, "plain".

Returns:

CodeChallengeMethod instance, or null.