Interface LoginAttemptDecision

All Known Implementing Classes:

LoginAttemptDecision.Allowed, LoginAttemptDecision.LockedOut

public sealed interface LoginAttemptDecision
permits LoginAttemptDecision.Allowed, LoginAttemptDecision.LockedOut

Outcome of LoginAttemptPolicy.beforeAttempt(LoginAttemptContext).

Sealed so callers can switch exhaustively without a default case — a future variant for, say, "rate-limited per IP only" forces a compile error at every existing call site.

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final record	LoginAttemptDecision.Allowed	The attempt may proceed.
static final record	LoginAttemptDecision.LockedOut	The caller is locked out.

Method Summary

Static Methods

Modifier and Type	Method	Description
static LoginAttemptDecision.Allowed	allowed()	Convenience for the singleton LoginAttemptDecision.Allowed.
static LoginAttemptDecision.LockedOut	lockedOut(Duration remaining, int failedAttempts)	Convenience for LoginAttemptDecision.LockedOut.

Method Details

allowed

static LoginAttemptDecision.Allowed allowed()

Convenience for the singleton LoginAttemptDecision.Allowed.

lockedOut

static LoginAttemptDecision.LockedOut lockedOut(Duration remaining,
 int failedAttempts)

Convenience for LoginAttemptDecision.LockedOut.

Parameters:

remaining - time until the lockout window expires

failedAttempts - number of failed attempts that caused the lockout

Returns:

a LoginAttemptDecision.LockedOut decision carrying both values