Package org.openiam.srvc.am

Class AuthorizationManagerMenuWebServiceImpl

java.lang.Object

org.openiam.srvc.AbstractApiService

org.openiam.srvc.am.AuthorizationManagerMenuWebServiceImpl

All Implemented Interfaces:

AuthorizationManagerMenuWebService

@Service("authorizationManagerMenuWebService")
public class AuthorizationManagerMenuWebServiceImpl
extends AbstractApiService
implements AuthorizationManagerMenuWebService

Field Summary

Fields inherited from class org.openiam.srvc.AbstractApiService

applicationContext, rabbitMQSender

Constructor Summary

Constructors

Constructor	Description
AuthorizationManagerMenuWebServiceImpl(AMMenuQueue queue)

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()

Methods inherited from class org.openiam.srvc.AbstractApiService

broadcast, crudRequest, getBooleanValue, getIntValue, getIntValue, getRabbitMqQueue, getResponse, getResponse, getValue, getValue, getValueList, getValueList, idRequest, manageApiRequest, manageApiRequest, manageCrudApiRequest, manageCrudApiRequest, manageCrudApiRequest, manageCrudApiRequest, membershipRequestProcessing, membershipRequestProcessing, publish, publish, sendAsync, sendAsync

Methods inherited from class java.lang.Object

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

Constructor Detail

AuthorizationManagerMenuWebServiceImpl

@Autowired
public AuthorizationManagerMenuWebServiceImpl(AMMenuQueue queue)

Method Detail

getMenuTreeForUserId

public AuthorizationMenu getMenuTreeForUserId(MenuRequest request)

Specified by:

getMenuTreeForUserId in interface AuthorizationManagerMenuWebService

getMenuTree

public AuthorizationMenu getMenuTree(String menuId)

Specified by:

getMenuTree in interface AuthorizationManagerMenuWebService

getNonCachedMenuTree

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

Description copied from interface: AuthorizationManagerMenuWebService

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.

Specified by:

getNonCachedMenuTree in interface AuthorizationManagerMenuWebService

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.

deleteMenuTree

public MenuSaveResponse deleteMenuTree(String rootId)

Specified by:

deleteMenuTree in interface AuthorizationManagerMenuWebService

isUserAuthenticatedToMenuWithURL

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

Specified by:

isUserAuthenticatedToMenuWithURL in interface AuthorizationManagerMenuWebService

sweep

public Response sweep()

Specified by:

sweep in interface AuthorizationManagerMenuWebService

saveMenuTree

public MenuSaveResponse saveMenuTree(AuthorizationMenu root)

Description copied from interface: AuthorizationManagerMenuWebService

Called after the menu tree has been validated

Specified by:

saveMenuTree in interface AuthorizationManagerMenuWebService

Parameters:

root - - root of the menu tree

Returns:

entitle

public Response entitle(MenuEntitlementsRequest menuEntitlementsRequest)

Specified by:

entitle in interface AuthorizationManagerMenuWebService