Class StoreBackedLoginAttemptPolicy

java.lang.Object

com.svenruppert.jsentinel.bruteforce.StoreBackedLoginAttemptPolicy

All Implemented Interfaces:

LoginAttemptPolicy

@ExperimentalJSentinelApi
public final class StoreBackedLoginAttemptPolicy
extends Object
implements LoginAttemptPolicy

LoginAttemptPolicy that stores its failure counters in a LoginAttemptStore.

Counter and last-failure timestamp survive a process restart — a lockout earned on Monday is still in effect on Tuesday. Unlike the InMemoryLoginAttemptPolicy default, this implementation runs a flat lockout: once LoginAttemptConfiguration.failureThreshold() failures accumulate within the configured LoginAttemptConfiguration.window(), the key locks for LoginAttemptConfiguration.initialLockout() starting at the last failure. The progressive backoff that the in-memory policy offers requires per-key history (lockout level, "just locked" flag) that the narrower LoginAttemptStore contract does not carry — applications that need progressive backoff stay on the in-memory policy or wrap this one with a richer key store.

Bound to one TenantId at construction. Multi-tenant deployments instantiate one policy per tenant or wrap with a resolver.

Constructor Summary

Constructors

Constructor	Description
StoreBackedLoginAttemptPolicy(LoginAttemptStore store)	Builds a policy with LoginAttemptConfiguration.defaults() and TenantId.DEFAULT.
StoreBackedLoginAttemptPolicy(LoginAttemptStore store, LoginAttemptConfiguration config, TenantId tenant, Clock clock)	Full constructor.

Method Summary

Modifier and Type	Method	Description
LoginAttemptDecision	beforeAttempt(LoginAttemptContext context)	Decides whether the attempt described by context may proceed.
void	recordFailure(LoginAttemptContext context)	Records a failed attempt.
void	recordSuccess(LoginAttemptContext context)	Records a successful attempt.

Methods inherited from class Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

StoreBackedLoginAttemptPolicy

public StoreBackedLoginAttemptPolicy(LoginAttemptStore store)

Builds a policy with LoginAttemptConfiguration.defaults() and TenantId.DEFAULT.

Parameters:

store - backing store; non-null

StoreBackedLoginAttemptPolicy

public StoreBackedLoginAttemptPolicy(LoginAttemptStore store,
 LoginAttemptConfiguration config,
 TenantId tenant,
 Clock clock)

Full constructor.

Parameters:

store - backing store; non-null

config - thresholds; non-null

tenant - tenant scope; null becomes TenantId.DEFAULT

clock - time source; non-null. Pass a fixed clock to make tests deterministic.

Method Details

beforeAttempt

public LoginAttemptDecision beforeAttempt(LoginAttemptContext context)

Description copied from interface: LoginAttemptPolicy

Decides whether the attempt described by context may proceed. Implementations must not mutate the failure counter here — that is the responsibility of LoginAttemptPolicy.recordSuccess(LoginAttemptContext) / LoginAttemptPolicy.recordFailure(LoginAttemptContext) after the actual check.

Specified by:

beforeAttempt in interface LoginAttemptPolicy

Parameters:

context - attempt context

Returns:

decision; never null

recordSuccess

public void recordSuccess(LoginAttemptContext context)

Description copied from interface: LoginAttemptPolicy

Records a successful attempt. Implementations typically reset the per-key failure counter so a successful login lifts a partial lockout immediately.

Specified by:

recordSuccess in interface LoginAttemptPolicy

Parameters:

context - attempt context

recordFailure

public void recordFailure(LoginAttemptContext context)

Description copied from interface: LoginAttemptPolicy

Records a failed attempt. Implementations typically increment a per-key counter and may escalate the throttling decision.

Specified by:

recordFailure in interface LoginAttemptPolicy

Parameters:

context - attempt context