-
Notifications
You must be signed in to change notification settings - Fork 66
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #255 from AnuradhaSK/shared-role-mgt-handler
Add shared role managing event handler and event listener
- Loading branch information
Showing
6 changed files
with
944 additions
and
8 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
258 changes: 258 additions & 0 deletions
258
...n/java/org/wso2/carbon/identity/organization/management/handler/SharedRoleMgtHandler.java
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,258 @@ | ||
| /* | ||
| * Copyright (c) 2023, WSO2 LLC. (http://www.wso2.com). | ||
| * | ||
| * WSO2 LLC. licenses this file to you under the Apache License, | ||
| * Version 2.0 (the "License"); you may not use this file except | ||
| * in compliance with the License. | ||
| * You may obtain a copy of the License at | ||
| * | ||
| * http://www.apache.org/licenses/LICENSE-2.0 | ||
| * | ||
| * Unless required by applicable law or agreed to in writing, | ||
| * software distributed under the License is distributed on an | ||
| * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY | ||
| * KIND, either express or implied. See the License for the | ||
| * specific language governing permissions and limitations | ||
| * under the License. | ||
| */ | ||
|
|
||
| package org.wso2.carbon.identity.organization.management.handler; | ||
|
|
||
| import org.apache.commons.collections.MapUtils; | ||
| import org.apache.commons.logging.Log; | ||
| import org.apache.commons.logging.LogFactory; | ||
| import org.wso2.carbon.identity.application.common.IdentityApplicationManagementException; | ||
| import org.wso2.carbon.identity.application.common.model.RoleV2; | ||
| import org.wso2.carbon.identity.application.mgt.ApplicationManagementService; | ||
| import org.wso2.carbon.identity.event.IdentityEventConstants; | ||
| import org.wso2.carbon.identity.event.IdentityEventException; | ||
| import org.wso2.carbon.identity.event.event.Event; | ||
| import org.wso2.carbon.identity.event.handler.AbstractEventHandler; | ||
| import org.wso2.carbon.identity.organization.management.application.OrgApplicationManager; | ||
| import org.wso2.carbon.identity.organization.management.application.constant.OrgApplicationMgtConstants; | ||
| import org.wso2.carbon.identity.organization.management.application.model.SharedApplication; | ||
| import org.wso2.carbon.identity.organization.management.handler.internal.OrganizationManagementHandlerDataHolder; | ||
| import org.wso2.carbon.identity.organization.management.service.OrganizationManager; | ||
| import org.wso2.carbon.identity.organization.management.service.exception.OrganizationManagementException; | ||
| import org.wso2.carbon.identity.organization.management.service.util.OrganizationManagementUtil; | ||
| import org.wso2.carbon.identity.role.v2.mgt.core.RoleConstants; | ||
| import org.wso2.carbon.identity.role.v2.mgt.core.RoleManagementService; | ||
| import org.wso2.carbon.identity.role.v2.mgt.core.exception.IdentityRoleManagementException; | ||
| import org.wso2.carbon.identity.role.v2.mgt.core.model.RoleBasicInfo; | ||
|
|
||
| import java.util.Collections; | ||
| import java.util.List; | ||
| import java.util.Map; | ||
| import java.util.concurrent.CompletableFuture; | ||
| import java.util.concurrent.ExecutorService; | ||
| import java.util.concurrent.Executors; | ||
|
|
||
| /** | ||
| * Event handler to manage shared roles in sub-organizations. | ||
| */ | ||
| public class SharedRoleMgtHandler extends AbstractEventHandler { | ||
|
|
||
| private static final Log LOG = LogFactory.getLog(SharedRoleMgtHandler.class); | ||
| private final ExecutorService executorService = Executors.newFixedThreadPool(5); | ||
|
|
||
| @Override | ||
| public void handleEvent(Event event) throws IdentityEventException { | ||
|
|
||
| String eventName = event.getEventName(); | ||
| Map<String, Object> eventProperties = event.getEventProperties(); | ||
| switch (eventName) { | ||
| case OrgApplicationMgtConstants.EVENT_POST_SHARE_APPLICATION: | ||
| createSharedRolesOnApplicationSharing(eventProperties); | ||
| break; | ||
| case IdentityEventConstants.Event.POST_ADD_ROLE_V2_EVENT: | ||
| createSharedRolesOnNewRoleCreation(eventProperties); | ||
| break; | ||
| default: | ||
| if (LOG.isDebugEnabled()) { | ||
| LOG.debug("Unsupported event: " + eventName); | ||
| } | ||
| break; | ||
| } | ||
| } | ||
|
|
||
| private void createSharedRolesOnApplicationSharing(Map<String, Object> eventProperties) | ||
| throws IdentityEventException { | ||
|
|
||
| String parentOrganizationId = | ||
| (String) eventProperties.get(OrgApplicationMgtConstants.EVENT_PROP_PARENT_ORGANIZATION_ID); | ||
| String parentApplicationId = | ||
| (String) eventProperties.get(OrgApplicationMgtConstants.EVENT_PROP_PARENT_APPLICATION_ID); | ||
| String sharedOrganizationId = | ||
| (String) eventProperties.get(OrgApplicationMgtConstants.EVENT_PROP_SHARED_ORGANIZATION_ID); | ||
| String sharedApplicationId = | ||
| (String) eventProperties.get(OrgApplicationMgtConstants.EVENT_PROP_SHARED_APPLICATION_ID); | ||
| try { | ||
| String sharedAppTenantDomain = getOrganizationManager().resolveTenantDomain(sharedOrganizationId); | ||
| String mainAppTenantDomain = getOrganizationManager().resolveTenantDomain(parentOrganizationId); | ||
| String allowedAudienceForRoleAssociationInMainApp = | ||
| getApplicationMgtService().getAllowedAudienceForRoleAssociation(parentApplicationId, | ||
| mainAppTenantDomain); | ||
| switch (allowedAudienceForRoleAssociationInMainApp) { | ||
| case RoleConstants.APPLICATION: | ||
| // Create the roles, and add the relationship. | ||
| createSharedRolesWithAppAudience(parentApplicationId, mainAppTenantDomain, sharedApplicationId, | ||
| sharedAppTenantDomain); | ||
| break; | ||
| default: | ||
| // Create the role if not exists, and add the relationship. | ||
| List<RoleV2> associatedRolesOfApplication = | ||
| getApplicationMgtService().getAssociatedRolesOfApplication( | ||
| parentApplicationId, mainAppTenantDomain); | ||
| createSharedRolesWithOrgAudience(associatedRolesOfApplication, mainAppTenantDomain, | ||
| sharedOrganizationId); | ||
| break; | ||
| } | ||
| } catch (OrganizationManagementException | IdentityRoleManagementException | | ||
| IdentityApplicationManagementException e) { | ||
| throw new IdentityEventException( | ||
| String.format("Error while sharing roles related to application %s.", sharedApplicationId), e); | ||
| } | ||
| } | ||
|
|
||
| private void createSharedRolesWithOrgAudience(List<RoleV2> rolesList, String mainAppTenantDomain, | ||
| String sharedAppOrgId) | ||
| throws IdentityRoleManagementException, OrganizationManagementException { | ||
|
|
||
| if (rolesList == null) { | ||
| return; | ||
| } | ||
| String sharedAppTenantDomain = getOrganizationManager().resolveTenantDomain(sharedAppOrgId); | ||
| for (RoleV2 role : rolesList) { | ||
| // Check if the role exists in the application shared org. | ||
| boolean roleExistsInSharedOrg = | ||
| getRoleManagementServiceV2().isExistingRoleName(role.getName(), RoleConstants.ORGANIZATION, | ||
| sharedAppOrgId, sharedAppTenantDomain); | ||
| Map<String, String> mainRoleToSharedRoleMappingInSharedOrg = | ||
| getRoleManagementServiceV2().getMainRoleToSharedRoleMappingsBySubOrg( | ||
| Collections.singletonList(role.getId()), sharedAppTenantDomain); | ||
| boolean roleRelationshipExistsInSharedOrg = | ||
| MapUtils.isNotEmpty(mainRoleToSharedRoleMappingInSharedOrg); | ||
| if (roleExistsInSharedOrg && !roleRelationshipExistsInSharedOrg) { | ||
| // Add relationship between main role and shared role. | ||
| String roleIdInSharedOrg = | ||
| getRoleManagementServiceV2().getRoleIdByName(role.getName(), RoleConstants.ORGANIZATION, | ||
| sharedAppOrgId, sharedAppTenantDomain); | ||
| getRoleManagementServiceV2().addMainRoleToSharedRoleRelationship(role.getId(), | ||
| roleIdInSharedOrg, mainAppTenantDomain, sharedAppTenantDomain); | ||
| } else if (!roleExistsInSharedOrg && !roleRelationshipExistsInSharedOrg) { | ||
| // Create the role in the shared org. | ||
| RoleBasicInfo sharedRole = | ||
| getRoleManagementServiceV2().addRole(role.getName(), Collections.emptyList(), | ||
| Collections.emptyList(), Collections.emptyList(), RoleConstants.ORGANIZATION, | ||
| sharedAppOrgId, sharedAppTenantDomain); | ||
| // Add relationship between main role and shared role. | ||
| getRoleManagementServiceV2().addMainRoleToSharedRoleRelationship(role.getId(), | ||
| sharedRole.getId(), mainAppTenantDomain, sharedAppTenantDomain); | ||
| } | ||
| } | ||
| } | ||
|
|
||
| private void createSharedRolesWithAppAudience(String mainAppId, String mainAppTenantDomain, String sharedAppId, | ||
| String sharedAppTenantDomain) throws IdentityRoleManagementException { | ||
|
|
||
| // Get parent organization's roles which has application audience. | ||
| String filter = RoleConstants.AUDIENCE_ID + " " + RoleConstants.EQ + " " + mainAppId; | ||
| List<RoleBasicInfo> parentOrgRoles = | ||
| getRoleManagementServiceV2().getRoles(filter, null, 0, null, null, mainAppTenantDomain); | ||
| for (RoleBasicInfo parentOrgRole : parentOrgRoles) { | ||
| String parentOrgRoleName = parentOrgRole.getName(); | ||
| // Create the role in the shared org. | ||
| RoleBasicInfo subOrgRole = getRoleManagementServiceV2().addRole(parentOrgRoleName, Collections.emptyList(), | ||
| Collections.emptyList(), Collections.emptyList(), RoleConstants.APPLICATION, sharedAppId, | ||
| sharedAppTenantDomain); | ||
| // Add relationship between main role and the shared role. | ||
| getRoleManagementServiceV2().addMainRoleToSharedRoleRelationship(parentOrgRole.getId(), subOrgRole.getId(), | ||
| mainAppTenantDomain, sharedAppTenantDomain); | ||
| } | ||
| } | ||
|
|
||
| private void createSharedRolesOnNewRoleCreation(Map<String, Object> eventProperties) | ||
| throws IdentityEventException { | ||
|
|
||
| try { | ||
| String mainRoleUUID = (String) eventProperties.get(IdentityEventConstants.EventProperty.ROLE_ID); | ||
| String mainRoleName = (String) eventProperties.get(IdentityEventConstants.EventProperty.ROLE_NAME); | ||
| String roleTenantDomain = (String) eventProperties.get(IdentityEventConstants.EventProperty.TENANT_DOMAIN); | ||
| String roleAudienceType = (String) eventProperties.get(IdentityEventConstants.EventProperty.AUDIENCE); | ||
| String roleAudienceId = (String) eventProperties.get(IdentityEventConstants.EventProperty.AUDIENCE_ID); | ||
| String roleOrgId = getOrganizationManager().resolveOrganizationId(roleTenantDomain); | ||
| if (OrganizationManagementUtil.isOrganization(roleTenantDomain)) { | ||
| return; | ||
| } | ||
| switch (roleAudienceType) { | ||
| case RoleConstants.APPLICATION: | ||
| /* | ||
| If the audienced application is a shared application, create the role in | ||
| the shared apps' org space. | ||
| */ | ||
| List<SharedApplication> sharedApplications = | ||
| getOrgApplicationManager().getSharedApplications(roleOrgId, roleAudienceId); | ||
| int noOfSharedApps = sharedApplications.size(); | ||
| for (int i = 0; i < noOfSharedApps; i++) { | ||
| final int taskId = i; | ||
| CompletableFuture.runAsync(() -> { | ||
| try { | ||
| String sharedApplicationId = sharedApplications.get(taskId).getSharedApplicationId(); | ||
| String sharedOrganizationId = sharedApplications.get(taskId).getOrganizationId(); | ||
| String shareAppTenantDomain = | ||
| getOrganizationManager().resolveTenantDomain(sharedOrganizationId); | ||
| RoleBasicInfo sharedRoleInfo = | ||
| getRoleManagementServiceV2().addRole(mainRoleName, Collections.emptyList(), | ||
| Collections.emptyList(), | ||
| Collections.emptyList(), RoleConstants.APPLICATION, sharedApplicationId, | ||
| shareAppTenantDomain); | ||
| // Add relationship between main role and shared role. | ||
| getRoleManagementServiceV2().addMainRoleToSharedRoleRelationship(mainRoleUUID, | ||
| sharedRoleInfo.getId(), roleTenantDomain, shareAppTenantDomain); | ||
| } catch (IdentityRoleManagementException | OrganizationManagementException e) { | ||
| LOG.error("Error occurred while creating shared role in organization with id: " + | ||
| sharedApplications.get(taskId).getOrganizationId(), e); | ||
| } | ||
| }, executorService).exceptionally(throwable -> { | ||
| LOG.error(String.format( | ||
| "Exception occurred during creating a shared role: %s in organization: %s", | ||
| mainRoleName, sharedApplications.get(taskId).getOrganizationId()), throwable); | ||
| return null; | ||
| }); | ||
| } | ||
| break; | ||
| case RoleConstants.ORGANIZATION: | ||
| /* | ||
| Organization audience roles can't be attached to an application at the same time of role creation. | ||
| Organization audience role get shared to other application only if that role is associated with any | ||
| shared application in the organization. So nothing do in this case. | ||
| */ | ||
| break; | ||
| default: | ||
| LOG.error("Unsupported audience type: " + roleAudienceType); | ||
| } | ||
| } catch (OrganizationManagementException e) { | ||
| throw new IdentityEventException("Error occurred while retrieving shared applications.", e); | ||
| } | ||
| } | ||
|
|
||
| private static RoleManagementService getRoleManagementServiceV2() { | ||
|
|
||
| return OrganizationManagementHandlerDataHolder.getInstance().getRoleManagementServiceV2(); | ||
| } | ||
|
|
||
| private static OrganizationManager getOrganizationManager() { | ||
|
|
||
| return OrganizationManagementHandlerDataHolder.getInstance().getOrganizationManager(); | ||
| } | ||
|
|
||
| private static OrgApplicationManager getOrgApplicationManager() { | ||
|
|
||
| return OrganizationManagementHandlerDataHolder.getInstance().getOrgApplicationManager(); | ||
| } | ||
|
|
||
| private static ApplicationManagementService getApplicationMgtService() { | ||
|
|
||
| return OrganizationManagementHandlerDataHolder.getInstance().getApplicationManagementService(); | ||
| } | ||
| } |
Oops, something went wrong.