Record Class NavigationAccessDecision.AccessDenied

java.lang.Object

java.lang.Record

com.svenruppert.jsentinel.authorization.navigation.NavigationAccessDecision.AccessDenied

Record Components:

alternativeRoute - the route to redirect to

asForward - if true, use forward instead of reroute

All Implemented Interfaces:

NavigationAccessDecision

Enclosing interface:

NavigationAccessDecision

public static record NavigationAccessDecision.AccessDenied(String alternativeRoute, boolean asForward)
extends Record
implements NavigationAccessDecision

The subject exists but lacks the required roles or permissions. Navigation should be redirected to the given alternative route.

Nested Class Summary

Nested classes/interfaces inherited from interface NavigationAccessDecision

NavigationAccessDecision.AccessDenied, NavigationAccessDecision.Allowed, NavigationAccessDecision.AlreadyLoggedIn, NavigationAccessDecision.LoginRequired

Modifier and Type	Interface	Description
static final record	NavigationAccessDecision.AccessDenied	The subject exists but lacks the required roles or permissions.
static final record	NavigationAccessDecision.Allowed	Navigation is allowed.
static final record	NavigationAccessDecision.AlreadyLoggedIn	The user is already logged in but is navigating to the login page.
static final record	NavigationAccessDecision.LoginRequired	The route is restricted and no subject is in the session.

Constructor Summary

Constructors

Constructor	Description
AccessDenied(String alternativeRoute, boolean asForward)	Creates an instance of a AccessDenied record class.

Method Summary

Modifier and Type	Method	Description
String	alternativeRoute()	Returns the value of the alternativeRoute record component.
boolean	asForward()	Returns the value of the asForward record component.
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.
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

AccessDenied

public AccessDenied(String alternativeRoute,
 boolean asForward)

Creates an instance of a AccessDenied record class.

Parameters:

alternativeRoute - the value for the alternativeRoute record component

asForward - the value for the asForward 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. 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.

alternativeRoute

public String alternativeRoute()

Returns the value of the alternativeRoute record component.

Returns:

the value of the alternativeRoute record component

asForward

public boolean asForward()

Returns the value of the asForward record component.

Returns:

the value of the asForward record component