Package com.bonitasoft.processbuilder.extension.template.auth

Record Class ApiKeyAuthConfig

java.lang.Object

java.lang.Record

com.bonitasoft.processbuilder.extension.template.auth.ApiKeyAuthConfig

All Implemented Interfaces:

AuthConfig

public record ApiKeyAuthConfig(String keyName, String keyValue, ApiKeyAuthConfig.Location location)
extends Record
implements AuthConfig

Configuration for API Key Authentication.

Since:

2025-02-06

Author:

Process Builder Team

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	ApiKeyAuthConfig.Location

Constructor Summary

Constructors

Constructor	Description
ApiKeyAuthConfig(String keyName, String keyValue)
ApiKeyAuthConfig(String keyName, String keyValue, ApiKeyAuthConfig.Location location)	Creates an instance of a ApiKeyAuthConfig record class.

Method Summary

Modifier and Type	Method	Description
final boolean	equals(Object o)	Indicates whether some other object is "equal to" this one.
static ApiKeyAuthConfig	fromJson(com.fasterxml.jackson.databind.JsonNode node)
String	getAuthType()	Gets the authentication type identifier.
final int	hashCode()	Returns a hash code value for this object.
static ApiKeyAuthConfig	header(String keyName, String keyValue)
String	keyName()	Returns the value of the keyName record component.
String	keyValue()	Returns the value of the keyValue record component.
ApiKeyAuthConfig.Location	location()	Returns the value of the location record component.
static ApiKeyAuthConfig	queryParam(String keyName, String keyValue)
com.fasterxml.jackson.databind.JsonNode	toJson(com.fasterxml.jackson.databind.ObjectMapper mapper)	Converts this configuration to a JSON node for storage.
com.fasterxml.jackson.databind.JsonNode	toJsonEncrypted(com.fasterxml.jackson.databind.ObjectMapper mapper)	Converts this configuration to a JSON node with sensitive fields encrypted.
final String	toString()	Returns a string representation of this record class.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Details

ApiKeyAuthConfig

public ApiKeyAuthConfig(String keyName,
 String keyValue,
 ApiKeyAuthConfig.Location location)

Creates an instance of a ApiKeyAuthConfig record class.

Parameters:

keyName - the value for the keyName record component

keyValue - the value for the keyValue record component

location - the value for the location record component

ApiKeyAuthConfig

public ApiKeyAuthConfig(String keyName,
 String keyValue)

Method Details

getAuthType

public String getAuthType()

Description copied from interface: AuthConfig

Gets the authentication type identifier.

Specified by:

getAuthType in interface AuthConfig

Returns:

The authentication type string (lowercase)

toJson

public com.fasterxml.jackson.databind.JsonNode toJson(com.fasterxml.jackson.databind.ObjectMapper mapper)

Description copied from interface: AuthConfig

Converts this configuration to a JSON node for storage.

Specified by:

toJson in interface AuthConfig

Parameters:

mapper - The ObjectMapper to use for JSON creation

Returns:

JSON representation of this configuration

toJsonEncrypted

public com.fasterxml.jackson.databind.JsonNode toJsonEncrypted(com.fasterxml.jackson.databind.ObjectMapper mapper)

Description copied from interface: AuthConfig

Converts this configuration to a JSON node with sensitive fields encrypted.

Specified by:

toJsonEncrypted in interface AuthConfig

Parameters:

mapper - The ObjectMapper to use for JSON creation

Returns:

JSON representation with encrypted sensitive fields

fromJson

public static ApiKeyAuthConfig fromJson(com.fasterxml.jackson.databind.JsonNode node)

queryParam

public static ApiKeyAuthConfig queryParam(String keyName,
 String keyValue)

header

public static ApiKeyAuthConfig header(String keyName,
 String keyValue)

toString

public final String toString()

Returns a string representation of this record class. The representation contains the name of the class, followed by the name and value of each of the record components.

Specified by:

toString in class Record

Returns:

a string representation of this object

hashCode

public final int hashCode()

Returns a hash code value for this object. The value is derived from the hash code of each of the record components.

Specified by:

hashCode in class Record

Returns:

a hash code value for this object

equals

public final boolean equals(Object o)

Indicates whether some other object is "equal to" this one. The objects are equal if the other object is of the same class and if all the record components are equal. All components in this record class are compared with Objects::equals(Object,Object).

Specified by:

equals in class Record

Parameters:

o - the object with which to compare

Returns:

true if this object is the same as the o argument; false otherwise.

keyName

public String keyName()

Returns the value of the keyName record component.

Returns:

the value of the keyName record component

keyValue

public String keyValue()

Returns the value of the keyValue record component.

Returns:

the value of the keyValue record component

location

public ApiKeyAuthConfig.Location location()

Returns the value of the location record component.

Returns:

the value of the location record component