Package com.bonitasoft.processbuilder.enums

Enum Class RestOAuth2ClientAuthMethod

java.lang.Object

java.lang.Enum<RestOAuth2ClientAuthMethod>

com.bonitasoft.processbuilder.enums.RestOAuth2ClientAuthMethod

All Implemented Interfaces:

Serializable, Comparable<RestOAuth2ClientAuthMethod>, Constable

public enum RestOAuth2ClientAuthMethod
extends Enum<RestOAuth2ClientAuthMethod>

Defines how OAuth2 client credentials are sent to the token endpoint.

Since:

1.0

Author:

Bonitasoft

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
BODY	Client credentials sent in the request body as form parameters.
HEADER	Client credentials sent as HTTP Basic Auth header.

Method Summary

Modifier and Type	Method	Description
static Optional<RestOAuth2ClientAuthMethod>	fromKey(String key)	Finds a method by its key (case-insensitive).
static Map<String,String>	getAllData()	Retrieves all methods as a read-only Map.
static List<String>	getAllKeysList()	Retrieves all keys as a read-only List.
String	getDescription()	Gets the description.
String	getKey()	Gets the technical key.
static boolean	isValid(String input)	Checks if a given string corresponds to a valid method.
static RestOAuth2ClientAuthMethod	valueOf(String name)	Returns the enum constant of this class with the specified name.
static RestOAuth2ClientAuthMethod[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

BODY

public static final RestOAuth2ClientAuthMethod BODY

Client credentials sent in the request body as form parameters.

HEADER

public static final RestOAuth2ClientAuthMethod HEADER

Client credentials sent as HTTP Basic Auth header.

Method Details

values

public static RestOAuth2ClientAuthMethod[] values()

Returns an array containing the constants of this enum class, in the order they are declared.

Returns:

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

valueOf

public static RestOAuth2ClientAuthMethod valueOf(String name)

Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (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 class has no constant with the specified name

NullPointerException - if the argument is null

getKey

public String getKey()

Gets the technical key.

Returns:

The key

getDescription

public String getDescription()

Gets the description.

Returns:

The description

isValid

public static boolean isValid(String input)

Checks if a given string corresponds to a valid method.

Parameters:

input - The string to validate (case-insensitive)

Returns:

true if the string is valid

fromKey

public static Optional<RestOAuth2ClientAuthMethod> fromKey(String key)

Finds a method by its key (case-insensitive).

Parameters:

key - The key to search for

Returns:

Optional containing the matching method, or empty if not found

getAllData

public static Map<String,String> getAllData()

Retrieves all methods as a read-only Map.

Returns:

A map containing all method data (Key -> Description)

getAllKeysList

public static List<String> getAllKeysList()

Retrieves all keys as a read-only List.

Returns:

A list containing all method keys