Record Class AuthorizationDecision

java.lang.Object

java.lang.Record

org.j7m.middleware.security.api.AuthorizationDecision

Record Components:

allowed - whether request is allowed

authenticatedRequired - whether authentication was required and missing

policyId - policy id

reason - safe decision reason

metadata - public decision metadata

public record AuthorizationDecision(boolean allowed, boolean authenticatedRequired, String policyId, String reason, Map<String,String> metadata)
extends Record

Immutable authorization decision.

Constructor Summary

Constructors

Constructor	Description
AuthorizationDecision(boolean allowed, boolean authenticatedRequired, String policyId, String reason, Map<String,String> metadata)	Creates immutable metadata.

Method Summary

Modifier and Type	Method	Description
static AuthorizationDecision	allow(String policyId)	Returns an allow decision.
boolean	allowed()	Returns the value of the allowed record component.
boolean	authenticatedRequired()	Returns the value of the authenticatedRequired record component.
static AuthorizationDecision	deny(String policyId, String reason)	Returns a deny decision.
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.
Map<String,String>	metadata()	Returns the value of the metadata record component.
String	policyId()	Returns the value of the policyId record component.
String	reason()	Returns the value of the reason record component.
final String	toString()	Returns a string representation of this record class.
static AuthorizationDecision	unauthenticated(String policyId, String reason)	Returns an unauthenticated decision.

Methods inherited from class Object

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

Constructor Details

AuthorizationDecision

public AuthorizationDecision(boolean allowed,
 boolean authenticatedRequired,
 String policyId,
 String reason,
 Map<String,String> metadata)

Creates immutable metadata.

Method Details

allow

public static AuthorizationDecision allow(String policyId)

Returns an allow decision.

Parameters:

policyId - policy id

Returns:

allow decision

deny

public static AuthorizationDecision deny(String policyId,
 String reason)

Returns a deny decision.

Parameters:

policyId - policy id

reason - safe denial reason

Returns:

deny decision

unauthenticated

public static AuthorizationDecision unauthenticated(String policyId,
 String reason)

Returns an unauthenticated decision.

Parameters:

policyId - policy id

reason - safe denial reason

Returns:

unauthenticated decision

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. Reference components are compared with Objects::equals(Object,Object); primitive components are compared with the compare method from their corresponding wrapper classes.

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.

allowed

public boolean allowed()

Returns the value of the allowed record component.

Returns:

the value of the allowed record component

authenticatedRequired

public boolean authenticatedRequired()

Returns the value of the authenticatedRequired record component.

Returns:

the value of the authenticatedRequired record component

policyId

public String policyId()

Returns the value of the policyId record component.

Returns:

the value of the policyId record component

reason

public String reason()

Returns the value of the reason record component.

Returns:

the value of the reason record component

metadata

public Map<String,String> metadata()

Returns the value of the metadata record component.

Returns:

the value of the metadata record component