Enum Class CheckFailurePolicy

java.lang.Object

java.lang.Enum<CheckFailurePolicy>

com.svenruppert.jsentinel.credential.compromised.CheckFailurePolicy

All Implemented Interfaces:

Serializable, Comparable<CheckFailurePolicy>, Constable

public enum CheckFailurePolicy
extends Enum<CheckFailurePolicy>

Operator-configured behaviour when a CompromisedPasswordChecker returns CompromisedPasswordResult.CheckFailed.

Mirrors the language used in NIST SP 800-63B §5.1.1 and OWASP ASVS V2.1: a compromised-password check is a *control*, and the failure mode of that control must be a *deliberate* choice.

Nested Class Summary

Nested classes/interfaces inherited from class Enum

Enum.EnumDesc<E>

Enum Constant Summary

Enum Constants

Enum Constant	Description
ALLOW	Treat a failed check as Clean — the change proceeds.
BLOCK	Treat a failed check as a definitive negative outcome — the change is rejected.
WARN	Treat a failed check as Clean but raise a structured audit event so operators can review later.

Method Summary

Modifier and Type	Method	Description
static CheckFailurePolicy	valueOf(String name)	Returns the enum constant of this class with the specified name.
static CheckFailurePolicy[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class Enum

clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

ALLOW

public static final CheckFailurePolicy ALLOW

Treat a failed check as Clean — the change proceeds. Default for online checkers where availability would otherwise cause an outage in the credential pipeline.

WARN

public static final CheckFailurePolicy WARN

Treat a failed check as Clean but raise a structured audit event so operators can review later.

BLOCK

public static final CheckFailurePolicy BLOCK

Treat a failed check as a definitive negative outcome — the change is rejected. Suited for high-assurance deployments where a missing check is worse than a denied change.

Method Details

values

public static CheckFailurePolicy[] values()

Returns an array containing the constants of this enum class, in the order they are declared.

Returns:

an array containing the constants of this enum class, in the order they are declared

valueOf

public static CheckFailurePolicy valueOf(String name)

Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum class has no constant with the specified name

NullPointerException - if the argument is null