Package org.openiam.srvc.am

Interface AuthorizationManagerMenuWebService

All Known Implementing Classes:

AuthorizationManagerMenuWebServiceImpl

public interface AuthorizationManagerMenuWebService

Method Summary

Modifier and Type	Method	Description
MenuSaveResponse	deleteMenuTree(String rootId)
Response	entitle(MenuEntitlementsRequest menuEntitlementsRequest)
AuthorizationMenu	getMenuTree(String menuId)
AuthorizationMenu	getMenuTreeForUserId(MenuRequest request)
AuthorizationMenu	getNonCachedMenuTree(String menuId, String principalId, String principalType)	This method gets a non-cached version of a user's, group's, role's, or resource's entitlements to a particular tree.
boolean	isUserAuthenticatedToMenuWithURL(String userId, String url, String menuId, boolean defaultResult)
MenuSaveResponse	saveMenuTree(AuthorizationMenu root)	Called after the menu tree has been validated
Response	sweep()

Method Detail

isUserAuthenticatedToMenuWithURL

boolean isUserAuthenticatedToMenuWithURL(String userId,
                                         String url,
                                         String menuId,
                                         boolean defaultResult)

getMenuTreeForUserId

AuthorizationMenu getMenuTreeForUserId(MenuRequest request)

getMenuTree

AuthorizationMenu getMenuTree(String menuId)

saveMenuTree

MenuSaveResponse saveMenuTree(AuthorizationMenu root)

Called after the menu tree has been validated

Parameters:

root - - root of the menu tree

Returns:

deleteMenuTree

MenuSaveResponse deleteMenuTree(String rootId)

getNonCachedMenuTree

AuthorizationMenu getNonCachedMenuTree(String menuId,
                                       String principalId,
                                       String principalType)

This method gets a non-cached version of a user's, group's, role's, or resource's entitlements to a particular tree. It should NOT be called by anything that requires good performance, as this method will make lots and lots of DB calls before completing. It is designed for use ONLY for Admin purposes, nothing more. If you call this method outside of an Administrative console - don't call it.

Parameters:

menuId - - ID of the menu

principalId - - the "id" of the user, group, role, or resource

principalType - - the "type" represented by the

principalId

. Valid values are 'group', 'role', 'user', or 'resource'

Returns:

An AuthorizationMenu representing the tree, and the entity's entitlements to this tree. Returns null if the menu can't be found, or of the principal of the type can't be found.

entitle

Response entitle(MenuEntitlementsRequest menuEntitlementsRequest)

sweep

Response sweep()