Record Class PolicyDecision.Allowed

java.lang.Object

java.lang.Record

com.svenruppert.jsentinel.policy.api.PolicyDecision.Allowed

Record Components:

reason - short, adapter-neutral diagnostic

All Implemented Interfaces:

PolicyDecision

Enclosing interface:

PolicyDecision

public static record PolicyDecision.Allowed(String reason)
extends Record
implements PolicyDecision

Access is permitted.

Nested Class Summary

Nested classes/interfaces inherited from interface PolicyDecision

PolicyDecision.Allowed, PolicyDecision.Denied, PolicyDecision.StepUpMethod, PolicyDecision.StepUpRequired

Modifier and Type	Interface	Description
static final record	PolicyDecision.Allowed	Access is permitted.
static final record	PolicyDecision.Denied	Access is denied.
static enum	PolicyDecision.StepUpMethod	Step-up mechanism a policy may ask for.
static final record	PolicyDecision.StepUpRequired	Subject is authenticated but a step-up challenge is required before access can be granted.

Constructor Summary

Constructors

Constructor	Description
Allowed(String reason)	Creates an instance of a Allowed record class.

Method Summary

Modifier and Type	Method	Description
final boolean	equals(Object o)	Indicates whether some other object is "equal to" this one.
final int	hashCode()	Returns a hash code value for this object.
String	reason()	Returns the value of the reason record component.
final String	toString()	Returns a string representation of this record class.

Methods inherited from class Object

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

Constructor Details

Allowed

public Allowed(String reason)

Creates an instance of a Allowed record class.

Parameters:

reason - the value for the reason record component

Method Details

toString

public final String toString()

Returns a string representation of this record class. The representation contains the name of the class, followed by the name and value of each of the record components.

Specified by:

toString in class Record

Returns:

a string representation of this object

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.

reason

public String reason()

Returns the value of the reason record component.

Returns:

the value of the reason record component