Module com.darkcollective.relix.lang.ast

Package com.darkcollective.relix.lang.ast.source

Record Class ApiKeyAuth

java.lang.Object

java.lang.Record

com.darkcollective.relix.lang.ast.source.ApiKeyAuth

Record Components:

name - the header name or query-parameter name; must not be blank

value - the key value (typically a ${ENV} reference, resolved when the request is made); must not be null

location - whether name/value is sent as a header or a query parameter; must not be null

All Implemented Interfaces:

AuthSpec

public record ApiKeyAuth(String name, String value, ApiKeyAuth.ApiKeyLocation location)
extends Record
implements AuthSpec

API-key authentication: the connector sends a named key either as a request header or as a URL query parameter.

Syntax:

   auth: apikey("X-API-Key", "${KEY}")        // header (default)
   auth: apikey(query("api_key"), "${KEY}")   // URL query parameter
 

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	ApiKeyAuth.ApiKeyLocation	Where an ApiKeyAuth key is placed in the request.

Constructor Summary

Constructors

Constructor	Description
ApiKeyAuth(String name, String value, ApiKeyAuth.ApiKeyLocation location)	Creates an instance of a ApiKeyAuth record class.

Method Summary

Modifier and Type	Method	Description
final boolean	equals(Object o)	Indicates whether some other object is "equal to" this one.
final int	hashCode()	Returns a hash code value for this object.
ApiKeyAuth.ApiKeyLocation	location()	Returns the value of the location record component.
String	name()	Returns the value of the name record component.
final String	toString()	Returns a string representation of this record class.
String	value()	Returns the value of the value record component.

Methods inherited from class java.lang.Object

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

Constructor Details

ApiKeyAuth

public ApiKeyAuth(String name,
 String value,
 ApiKeyAuth.ApiKeyLocation location)

Creates an instance of a ApiKeyAuth record class.

Parameters:

name - the value for the name record component

value - the value for the value record component

location - the value for the location record component

Method Details

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.

name

public String name()

Returns the value of the name record component.

Returns:

the value of the name record component

value

public String value()

Returns the value of the value record component.

Returns:

the value of the value record component

location

public ApiKeyAuth.ApiKeyLocation location()

Returns the value of the location record component.

Returns:

the value of the location record component