Interface NavigationAccessDecision

All Known Implementing Classes:

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

public sealed interface NavigationAccessDecision
permits NavigationAccessDecision.Allowed, NavigationAccessDecision.LoginRequired, NavigationAccessDecision.AlreadyLoggedIn, NavigationAccessDecision.AccessDenied

Result of a navigation security decision.

This is a pure value type with no Vaadin dependencies, making it suitable for unit testing without an adapter runtime. Adapter listeners translate this decision into framework-specific navigation calls.

Nested Class Summary

Nested Classes

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.

Method Summary

Static Methods

Modifier and Type	Method	Description
static NavigationAccessDecision	accessDenied(String alternativeRoute, boolean asForward)	Creates an NavigationAccessDecision.AccessDenied decision with a redirect target.
static NavigationAccessDecision	allowed()	Creates an NavigationAccessDecision.Allowed decision.
static NavigationAccessDecision	alreadyLoggedIn()	Creates an NavigationAccessDecision.AlreadyLoggedIn decision.
static NavigationAccessDecision	loginRequired()	Creates a NavigationAccessDecision.LoginRequired decision.

Method Details

allowed

static NavigationAccessDecision allowed()

Creates an NavigationAccessDecision.Allowed decision.

Returns:

navigation allowed

loginRequired

static NavigationAccessDecision loginRequired()

Creates a NavigationAccessDecision.LoginRequired decision.

Returns:

login required

alreadyLoggedIn

static NavigationAccessDecision alreadyLoggedIn()

Creates an NavigationAccessDecision.AlreadyLoggedIn decision.

Returns:

already logged in

accessDenied

static NavigationAccessDecision accessDenied(String alternativeRoute,
 boolean asForward)

Creates an NavigationAccessDecision.AccessDenied decision with a redirect target.

Parameters:

alternativeRoute - the route to redirect to

asForward - true for forward, false for reroute

Returns:

access denied with redirect