com.neurosys.menu.service

Class StaticMenuLogic

java.lang.Object

com.neurosys.menu.service.AuthMenuLogic

com.neurosys.menu.service.StaticMenuLogic

All Implemented Interfaces:

IMenuAuthLogic, IMenuStateLogic

public class StaticMenuLogic
extends AuthMenuLogic

Basic Menu Logic for a Static Menu. Does not alter any state; just maintains a static State tree; except Root focussed Item.

Author:

Arjun Dhar

Field Summary

Fields

Modifier and Type	Field and Description
protected MenuHelper	menuHelper

Constructor Summary

Constructors

Constructor and Description
StaticMenuLogic()

Method Summary

Modifier and Type	Method and Description
protected MenuItemState	changeMenuStateByAuth(MenuItemState state, User user) Change the current State for authorizations.
protected Boolean	checkIfChildrenHaveAutorization(MenuItemState state, User user) Menus that don't have authorization can be shown if they have a Child that does -- but any links then should be de-activated
MenuItemState	getCurrentState(MenuItem rootItem, MenuItem focussedItem, User user) Apart from User param (that is used to check is the User is auth to see/use a MenuItem, the rest is same as super#getCurrentState(MenuItem, MenuItem).
IAuthorizationService.AuthState	getItemAuthState(MenuItemState currentState, User user) Determine the Authorization State of a Menu Item after reading its Auth Configuration (If its MenuItem is of type AuthorizableMenuItem).
MenuHelper	getMenuHelper()
protected boolean	isMenuItemsEqual(MenuItem rootItem, MenuItem focussedItem) For logic that needs to identify if a menu Item should be focussed on or not.
void	setMenuHelper(MenuHelper menuHelper)

Methods inherited from class com.neurosys.menu.service.AuthMenuLogic

getCurrentState

Methods inherited from class java.lang.Object

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

Field Detail

menuHelper

protected MenuHelper menuHelper

Constructor Detail

StaticMenuLogic

public StaticMenuLogic()

Method Detail

isMenuItemsEqual

protected boolean isMenuItemsEqual(MenuItem rootItem,
                                   MenuItem focussedItem)

For logic that needs to identify if a menu Item should be focussed on or not. One can relate via the Menu Name or its reference or both. By default uses MenuItem.equals(Object) but one can override this logic for comparison.

Parameters:

rootItem - as MenuItem as the Menu (navigation tree)

focussedItem - as MenuItem; the item that is in Focus

getCurrentState

public MenuItemState getCurrentState(MenuItem rootItem,
                                     MenuItem focussedItem,
                                     User user)

Description copied from class: AuthMenuLogic

Apart from User param (that is used to check is the User is auth to see/use a MenuItem, the rest is same as super#getCurrentState(MenuItem, MenuItem). If User is null then it is upto the implementation on how it impace the resultant state.

Specified by:

getCurrentState in class AuthMenuLogic

Parameters:

rootItem - as MenuItem as the Menu (navigation tree)

focussedItem - as MenuItem; the item that is in Focus

user - as @nullable true

Returns:

MenuItemState

checkIfChildrenHaveAutorization

protected Boolean checkIfChildrenHaveAutorization(MenuItemState state,
                                                  User user)

Menus that don't have authorization can be shown if they have a Child that does -- but any links then should be de-activated

Returns:

Boolean @nullable true; If no children.

changeMenuStateByAuth

protected MenuItemState changeMenuStateByAuth(MenuItemState state,
                                              User user)

Change the current State for authorizations.

Parameters:

state - as MenuItemState

user - as User @nullable true

Returns:

MenuItemState; same object as param to support chaining

getItemAuthState

public IAuthorizationService.AuthState getItemAuthState(MenuItemState currentState,
                                                        User user)

Description copied from interface: IMenuAuthLogic

Determine the Authorization State of a Menu Item after reading its Auth Configuration (If its MenuItem is of type AuthorizableMenuItem). If it not of that sub-type then it is upto the implementation to decide the final state.

The Service implementation must define/accept the User so that the state can be validated against the users Roles.
TODO: Should auth be checked on State or the raw MenuItem? There may be future use case benifits to check on state in dynamic situations

Parameters:

currentState - as MenuItemState @nullable false

user - as User @nullable true

Returns:

IAuthorizationService.AuthState

getMenuHelper

public MenuHelper getMenuHelper()

setMenuHelper

public void setMenuHelper(MenuHelper menuHelper)