Record Class NuggetAuthenticationResult

java.lang.Object

java.lang.Record

org.j7m.middleware.operations.api.NuggetAuthenticationResult

Record Components:

outcome - outcome category

failureReason - safe failure reason

nuggetId - nugget id

correlationId - audit correlation id

admissionId - bounded expiring admission session id for this runtime process

retryAfter - delay hint for throttled callers

timestamp - result timestamp

error - normalized safe error, or null

metadata - redacted safe metadata

public record NuggetAuthenticationResult(NuggetAuthenticationOutcome outcome, NuggetAuthenticationFailureReason failureReason, String nuggetId, String correlationId, String admissionId, Duration retryAfter, Instant timestamp, RemoteError error, Map<String,String> metadata)
extends Record

Safe, immutable result of a nugget PIN admission attempt.

The result never contains clear PINs, verifier bytes, salts, hashes, KDF output, reusable authentication envelopes, or secret source values. A successful result is admission only and does not carry authorization. The admission id, when present, is a runtime-scoped session handle with bounded retention and expiration. Callers may reuse it for read-only operations until the service rejects it or it expires; possession of the id is never a bearer authorization grant.

Constructor Summary

Constructors

Constructor	Description
NuggetAuthenticationResult(NuggetAuthenticationOutcome outcome, NuggetAuthenticationFailureReason failureReason, String nuggetId, String correlationId, String admissionId, Duration retryAfter, Instant timestamp, RemoteError error, Map<String,String> metadata)	Creates a defensive immutable result.

Method Summary

Modifier and Type	Method	Description
boolean	accepted()	Returns whether the request was accepted for admission.
String	admissionId()	Returns the value of the admissionId record component.
String	correlationId()	Returns the value of the correlationId record component.
final boolean	equals(Object o)	Indicates whether some other object is "equal to" this one.
RemoteError	error()	Returns the value of the error record component.
NuggetAuthenticationFailureReason	failureReason()	Returns the value of the failureReason record component.
final int	hashCode()	Returns a hash code value for this object.
Map<String,String>	metadata()	Returns the value of the metadata record component.
String	nuggetId()	Returns the value of the nuggetId record component.
NuggetAuthenticationOutcome	outcome()	Returns the value of the outcome record component.
Duration	retryAfter()	Returns the value of the retryAfter record component.
Instant	timestamp()	Returns the value of the timestamp record component.
String	toString()

Methods inherited from class Object

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

Constructor Details

NuggetAuthenticationResult

public NuggetAuthenticationResult(NuggetAuthenticationOutcome outcome,
 NuggetAuthenticationFailureReason failureReason,
 String nuggetId,
 String correlationId,
 String admissionId,
 Duration retryAfter,
 Instant timestamp,
 RemoteError error,
 Map<String,String> metadata)

Creates a defensive immutable result.

Method Details

accepted

public boolean accepted()

Returns whether the request was accepted for admission.

Returns:

accepted flag

toString

public String toString()

Specified by:

toString in class Record

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.

outcome

public NuggetAuthenticationOutcome outcome()

Returns the value of the outcome record component.

Returns:

the value of the outcome record component

failureReason

public NuggetAuthenticationFailureReason failureReason()

Returns the value of the failureReason record component.

Returns:

the value of the failureReason record component

nuggetId

public String nuggetId()

Returns the value of the nuggetId record component.

Returns:

the value of the nuggetId record component

correlationId

public String correlationId()

Returns the value of the correlationId record component.

Returns:

the value of the correlationId record component

admissionId

public String admissionId()

Returns the value of the admissionId record component.

Returns:

the value of the admissionId record component

retryAfter

public Duration retryAfter()

Returns the value of the retryAfter record component.

Returns:

the value of the retryAfter record component

timestamp

public Instant timestamp()

Returns the value of the timestamp record component.

Returns:

the value of the timestamp record component

error

public RemoteError error()

Returns the value of the error record component.

Returns:

the value of the error record component

metadata

public Map<String,String> metadata()

Returns the value of the metadata record component.

Returns:

the value of the metadata record component