org.uberfire.client.menu

Class AuthFilterMenuVisitor

java.lang.Object

org.uberfire.client.menu.AuthFilterMenuVisitor

All Implemented Interfaces:

MenuVisitor

public class AuthFilterMenuVisitor
extends Object
implements MenuVisitor

Wraps a menu visitor, filtering out menu items that a given user is not allowed to access. The wrapped visitor only sees the items that the user is allowed to see.

Constructor Summary

Constructors

Constructor and Description
AuthFilterMenuVisitor(AuthorizationManager authzManager, org.jboss.errai.security.shared.api.identity.User user, MenuVisitor chainedVisitor) Wraps the given menu visitor, only forwarding calls that represent menu items the given user is allowed to see.

Method Summary

Modifier and Type	Method and Description
boolean	authorize(MenuItem item) Check the user is allowed to access the given menu item.
void	visit(MenuCustom<?> menuCustom)
void	visit(MenuItemCommand menuItemCommand)
void	visit(MenuItemPerspective menuItemPerspective)
void	visit(MenuItemPlain menuItemPlain)
boolean	visitEnter(MenuGroup menuGroup)
boolean	visitEnter(Menus menus)
void	visitLeave(MenuGroup menuGroup)
void	visitLeave(Menus menus)

Methods inherited from class java.lang.Object

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

Constructor Detail

AuthFilterMenuVisitor

public AuthFilterMenuVisitor(AuthorizationManager authzManager,
                             org.jboss.errai.security.shared.api.identity.User user,
                             MenuVisitor chainedVisitor)

Wraps the given menu visitor, only forwarding calls that represent menu items the given user is allowed to see.

Parameters:

authzManager - The authorization manager that decides what is visible. Not null.

user - The user who will see the menus being visited. Not null.

chainedVisitor - The menu visitor that receives calls for all authorized parts of the menu tree. Not null.

Method Detail

visitEnter

public boolean visitEnter(Menus menus)

Specified by:

visitEnter in interface MenuVisitor

visitLeave

public void visitLeave(Menus menus)

Specified by:

visitLeave in interface MenuVisitor

visitEnter

public boolean visitEnter(MenuGroup menuGroup)

Specified by:

visitEnter in interface MenuVisitor

visitLeave

public void visitLeave(MenuGroup menuGroup)

Specified by:

visitLeave in interface MenuVisitor

visit

public void visit(MenuItemPlain menuItemPlain)

Specified by:

visit in interface MenuVisitor

visit

public void visit(MenuItemCommand menuItemCommand)

Specified by:

visit in interface MenuVisitor

visit

public void visit(MenuCustom<?> menuCustom)

Specified by:

visit in interface MenuVisitor

visit

public void visit(MenuItemPerspective menuItemPerspective)

Specified by:

visit in interface MenuVisitor

authorize

public boolean authorize(MenuItem item)

Check the user is allowed to access the given menu item.

If the item has any references to resource actions ResourceActionRef or custom permissions then the access is granted provided all those references are also granted.