Record Class JSentinelRequirement

java.lang.Object

java.lang.Record

com.svenruppert.jsentinel.rest.openapi.JSentinelRequirement

Record Components:

scheme - what kind of authorization the requirement describes; non-null

operator - how the values combine; non-null

values - names of the required permissions / roles / policies; non-null, non-empty, immutable

@ExperimentalJSentinelApi
public record JSentinelRequirement(JSentinelRequirement.Scheme scheme, JSentinelRequirement.Operator operator, List<String> values)
extends Record

Adapter-neutral description of a single security requirement extracted from a @Requires… / @ProtectedBy annotation on a REST handler. Multiple requirements compose with AND semantics (the operation needs every requirement to pass — same model as the runtime evaluator).

The values list is interpreted relative to scheme and operator:

• JSentinelRequirement.Scheme.PERMISSION with JSentinelRequirement.Operator.ALL — subject must have every listed permission.
• JSentinelRequirement.Scheme.PERMISSION with JSentinelRequirement.Operator.ANY — subject must have at least one.
• JSentinelRequirement.Scheme.ROLE with JSentinelRequirement.Operator.ALL — subject must have every listed role.
• JSentinelRequirement.Scheme.POLICY with JSentinelRequirement.Operator.ALL — every listed policy name must permit the request.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	JSentinelRequirement.Operator	How the values combine.
static enum	JSentinelRequirement.Scheme	What the requirement is about.

Constructor Summary

Constructors

Constructor	Description
JSentinelRequirement(JSentinelRequirement.Scheme scheme, JSentinelRequirement.Operator operator, List<String> values)	Validates the components and freezes the values list.

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.
JSentinelRequirement.Operator	operator()	Returns the value of the operator record component.
JSentinelRequirement.Scheme	scheme()	Returns the value of the scheme record component.
final String	toString()	Returns a string representation of this record class.
List<String>	values()	Returns the value of the values record component.

Methods inherited from class Object

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

Constructor Details

JSentinelRequirement

public JSentinelRequirement(JSentinelRequirement.Scheme scheme,
 JSentinelRequirement.Operator operator,
 List<String> values)

Validates the components and freezes the values list.

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.

scheme

public JSentinelRequirement.Scheme scheme()

Returns the value of the scheme record component.

Returns:

the value of the scheme record component

operator

public JSentinelRequirement.Operator operator()

Returns the value of the operator record component.

Returns:

the value of the operator record component

values

public List<String> values()

Returns the value of the values record component.

Returns:

the value of the values record component