Class SecuredMenuItem

java.lang.Object

com.svenruppert.jsentinel.components.SecuredMenuItem

@ExperimentalJSentinelApi
public final class SecuredMenuItem
extends Object

Permission-aware binding helper for Vaadin MenuItems.

Unlike SecuredButton and SecuredRouterLink this is not a subclass: MenuItem is created by the parent MenuBar.addItem(...) call and cannot be instantiated directly. The helper instead takes a freshly-added MenuItem and a SecuredVisibility.Requirement, performs the check once, and exposes a refresh() method for re-checks after a permission change.

Defaults to SecuredVisibilityMode.HIDE — menu entries the user can't trigger should not appear in the menu.

Typical usage:

  MenuBar menu = new MenuBar();
  MenuItem delete = menu.addItem("Delete", e -> svc.delete());
  SecuredMenuItem secured = SecuredMenuItem.bind(delete,
      SecuredVisibility.Requirement.permission(new PermissionName("document:delete")));
  // later, after a role change: secured.refresh();

This is a UI affordance only — the actual delete handler must still server-side-guard the operation.

Method Summary

Modifier and Type	Method	Description
static SecuredMenuItem	bind(com.vaadin.flow.component.contextmenu.MenuItem menuItem, SecuredVisibility.Requirement requirement)	Binds menuItem to requirement with SecuredVisibilityMode.HIDE and SPI-backed view lookup.
static SecuredMenuItem	bind(com.vaadin.flow.component.contextmenu.MenuItem menuItem, SecuredVisibility.Requirement requirement, SecuredVisibilityMode mode)	Binds with a custom mode and SPI-backed view lookup.
static SecuredMenuItem	bind(com.vaadin.flow.component.contextmenu.MenuItem menuItem, SecuredVisibility.Requirement requirement, SecuredVisibilityMode mode, Supplier<Optional<SecuredVisibility.JSentinelView>> viewSupplier)	Test-friendly binding: caller supplies the security view directly.
com.vaadin.flow.component.contextmenu.MenuItem	menuItem()
SecuredVisibilityMode	mode()
void	refresh()	Re-runs the visibility check against the current subject.
SecuredVisibility.Requirement	requirement()

Methods inherited from class Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Details

bind

public static SecuredMenuItem bind(com.vaadin.flow.component.contextmenu.MenuItem menuItem,
 SecuredVisibility.Requirement requirement)

Binds menuItem to requirement with SecuredVisibilityMode.HIDE and SPI-backed view lookup.

Parameters:

menuItem - non-null (typically just returned from MenuBar.addItem(String))

requirement - non-null

Returns:

binding instance for later refresh() calls

bind

public static SecuredMenuItem bind(com.vaadin.flow.component.contextmenu.MenuItem menuItem,
 SecuredVisibility.Requirement requirement,
 SecuredVisibilityMode mode)

Binds with a custom mode and SPI-backed view lookup.

Parameters:

menuItem - non-null

requirement - non-null

mode - non-null

Returns:

binding instance

bind

public static SecuredMenuItem bind(com.vaadin.flow.component.contextmenu.MenuItem menuItem,
 SecuredVisibility.Requirement requirement,
 SecuredVisibilityMode mode,
 Supplier<Optional<SecuredVisibility.JSentinelView>> viewSupplier)

Test-friendly binding: caller supplies the security view directly.

Parameters:

menuItem - non-null

requirement - non-null

mode - non-null

viewSupplier - non-null

Returns:

binding instance

refresh

public void refresh()

Re-runs the visibility check against the current subject.

menuItem

public com.vaadin.flow.component.contextmenu.MenuItem menuItem()

Returns:

the bound MenuItem

requirement

public SecuredVisibility.Requirement requirement()

Returns:

the requirement

mode

public SecuredVisibilityMode mode()

Returns:

the visibility mode