Record Class AdapterCredentialRequirement

java.lang.Object

java.lang.Record

org.j7m.middleware.adapter.spi.AdapterCredentialRequirement

Record Components:

name - stable credential name

required - whether the adapter requires the credential before it can run

secret - whether values for this credential must always be redacted

description - human-readable safe description of the credential purpose

public record AdapterCredentialRequirement(String name, boolean required, boolean secret, String description)
extends Record

Credential declaration required by an optional adapter.

The record is immutable and thread-safe. It describes credential shape and redaction requirements only; it never stores credential values. Equality is structural so reports can compare declarations across TCK runs.

Constructor Summary

Constructors

Constructor	Description
AdapterCredentialRequirement(String name, boolean required, boolean secret, String description)	Creates a credential requirement.

Method Summary

Modifier and Type	Method	Description
String	description()	Returns the value of the description record component.
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.
String	name()	Returns the value of the name record component.
boolean	required()	Returns the value of the required record component.
boolean	secret()	Returns the value of the secret record component.
final String	toString()	Returns a string representation of this record class.

Methods inherited from class Object

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

Constructor Details

AdapterCredentialRequirement

public AdapterCredentialRequirement(String name,
 boolean required,
 boolean secret,
 String description)

Creates a credential requirement.

Throws:

IllegalArgumentException - if name or description is blank

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. Reference components are compared with Objects::equals(Object,Object); primitive components are compared with the compare method from their corresponding wrapper classes.

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

required

public boolean required()

Returns the value of the required record component.

Returns:

the value of the required record component

secret

public boolean secret()

Returns the value of the secret record component.

Returns:

the value of the secret record component

description

public String description()

Returns the value of the description record component.

Returns:

the value of the description record component