Package com.bonitasoft.processbuilder.enums

Enum Class RestApiKeyLocation

java.lang.Object

java.lang.Enum<RestApiKeyLocation>

com.bonitasoft.processbuilder.enums.RestApiKeyLocation

All Implemented Interfaces:

Serializable, Comparable<RestApiKeyLocation>, Constable

public enum RestApiKeyLocation
extends Enum<RestApiKeyLocation>

Defines where an API key should be placed in REST requests.

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
HEADER	API key is sent as an HTTP header.
QUERY_PARAM	API key is sent as a query parameter in the URL.

Method Summary

Modifier and Type	Method	Description
static Optional<RestApiKeyLocation>	fromKey(String key)	Finds a location by its key (case-insensitive).
static Map<String,String>	getAllData()	Retrieves all locations 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 location.
static RestApiKeyLocation	valueOf(String name)	Returns the enum constant of this class with the specified name.
static RestApiKeyLocation[]	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

HEADER

public static final RestApiKeyLocation HEADER

API key is sent as an HTTP header.

QUERY_PARAM

public static final RestApiKeyLocation QUERY_PARAM

API key is sent as a query parameter in the URL.

Method Details

values

public static RestApiKeyLocation[] 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 RestApiKeyLocation 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 location.

Parameters:

input - The string to validate (case-insensitive)

Returns:

true if the string is valid

fromKey

public static Optional<RestApiKeyLocation> fromKey(String key)

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

Parameters:

key - The key to search for

Returns:

Optional containing the matching location, or empty if not found

getAllData

public static Map<String,String> getAllData()

Retrieves all locations as a read-only Map.

Returns:

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

getAllKeysList

public static List<String> getAllKeysList()

Retrieves all keys as a read-only List.

Returns:

A list containing all location keys