Record Class ApiKey

java.lang.Object

java.lang.Record

com.svenruppert.jsentinel.credential.propagation.ApiKey

All Implemented Interfaces:

TokenCredential

@ExperimentalJSentinelApi
public record ApiKey(String value, Optional<Instant> expiresAt, Optional<String> audience, Optional<String> issuerHash)
extends Record
implements TokenCredential

Opaque API key. Never prefixed with Bearer by PassThroughStrategy — consumers register their own header strategy if they want one.

Since:

00.74.00

Constructor Summary

Constructors

Constructor	Description
ApiKey(String value, Optional<Instant> expiresAt, Optional<String> audience, Optional<String> issuerHash)	Creates an instance of a ApiKey record class.

Method Summary

Modifier and Type	Method	Description
Optional<String>	audience()	Returns the value of the audience record component.
final boolean	equals(Object o)	Indicates whether some other object is "equal to" this one.
Optional<Instant>	expiresAt()	Returns the value of the expiresAt record component.
final int	hashCode()	Returns a hash code value for this object.
Optional<String>	issuerHash()	Returns the value of the issuerHash record component.
String	toString()	Returns a string representation of this record class.
String	value()	Returns the value of the value record component.

Methods inherited from class Object

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

Constructor Details

ApiKey

public ApiKey(String value,
 Optional<Instant> expiresAt,
 Optional<String> audience,
 Optional<String> issuerHash)

Creates an instance of a ApiKey record class.

Parameters:

value - the value for the value record component

expiresAt - the value for the expiresAt record component

audience - the value for the audience record component

issuerHash - the value for the issuerHash record component

Method Details

toString

public 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.

value

public String value()

Returns the value of the value record component.

Specified by:

value in interface TokenCredential

Returns:

the value of the value record component

expiresAt

public Optional<Instant> expiresAt()

Returns the value of the expiresAt record component.

Specified by:

expiresAt in interface TokenCredential

Returns:

the value of the expiresAt record component

audience

public Optional<String> audience()

Returns the value of the audience record component.

Specified by:

audience in interface TokenCredential

Returns:

the value of the audience record component

issuerHash

public Optional<String> issuerHash()

Returns the value of the issuerHash record component.

Specified by:

issuerHash in interface TokenCredential

Returns:

the value of the issuerHash record component