Interface CredentialUpdateResult

All Known Implementing Classes:

CredentialUpdateResult.NotFound, CredentialUpdateResult.Stale, CredentialUpdateResult.Updated

public sealed interface CredentialUpdateResult
permits CredentialUpdateResult.Updated, CredentialUpdateResult.Stale, CredentialUpdateResult.NotFound

Outcome of a compare-and-swap update against the CredentialStore.

Sealed so callers pattern-match exhaustively. CredentialUpdateResult.Stale is returned when the witness no longer matches the persisted record — typically because another concurrent verifier rehashed it first. Stale is not a security failure; the caller should re-read, decide whether to rehash again, and proceed or skip.

Update methods never throw on race or absence; they always collapse to one of these variants so audit timelines stay clean (CWE-362 / CWE-367).

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final record	CredentialUpdateResult.NotFound	No record existed under the supplied username.
static final record	CredentialUpdateResult.Stale	The witness did not match the persisted record.
static final record	CredentialUpdateResult.Updated	The CAS succeeded; newRecord is the value now stored.