Introduce Resource Sharing Policy Management Component #416

BimsaraBodaragama · 2024-11-25T20:10:30Z

This PR adds a new component to manage resource-sharing policies between organizations in the WSO2 Identity Server. It enables defining, storing, and retrieving resource-sharing policies for users, applications, and identity providers.

Purpose

This feature addresses the need for a structured and scalable solution to manage resource-sharing policies across organizational hierarchies. It resolves the following issues:

Introduce a Centralized Resource Sharing Policy Management Service #21815

Goals

Provide a unified interface for managing resource-sharing policies.

Enable consistent policy definitions across resource types.

Support dynamic and hierarchical sharing options, such as sharing with all current and future organizations or selected organizational hierarchies.

Approach

Created a new component for resource-sharing policy management.

Developed a core service with DAO and utility classes for CRUD operations.

Defined constants and enums for resource types and sharing policies.

Implemented robust exception handling mechanisms.

Release note

Introduced a centralized resource-sharing policy management service to unify and streamline sharing policies across all resource types.

Documentation

N/A (Documentation updates will be tracked separately.)

Test environment

JDK 11

macOS 15.1.1 (24B91)

H2 Database

Related Issue

Introduce a Centralized Resource Sharing Policy Management Service #21815

…licy record and shared resource attributes by resource sharing policy id

… attributes rather than deleting it from record id since that way of deletion is not currently needed.

… attributes rather than deleting it from record id since that way of deletion is not currently needed - Part 2.

…attributes

… tables

…yManagement component

components/org.wso2.carbon.identity.organization.resource.sharing.policy.management/pom.xml

codecov · 2024-11-26T14:17:59Z

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 48.57%. Comparing base (021650f) to head (c30c9d5).

Additional details and impacted files

@@             Coverage Diff              @@
##               main     #416      +/-   ##
============================================
+ Coverage     47.13%   48.57%   +1.44%     
- Complexity     1024     1080      +56     
============================================
  Files           112      115       +3     
  Lines          6710     6898     +188     
  Branches        802      810       +8     
============================================
+ Hits           3163     3351     +188     
  Misses         3259     3259              
  Partials        288      288

Flag	Coverage Δ
unit	`32.18% <100.00%> (+3.07%)`	⬆️

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

…tters.

…ed org id.

…aredAttributeTypes.

… 190: Software Design Studio (Winter 2018) standards[1]. [1] https://web.stanford.edu/~ouster/cgi-bin/cs190-winter18/lecture.php?topic=comments

...identity.organization.resource.sharing.policy.management/src/test/resources/dbscripts/h2.sql

...sharing.policy.management/src/test/resources/mokito-extensions/org.mockito.plugins.MockMaker

...identity.organization.resource.sharing.policy.management/src/test/resources/dbscripts/h2.sql

...ntity/organization/resource/sharing/policy/management/constant/ResourceSharingConstants.java

...organization/resource/sharing/policy/management/dao/ResourceSharingPolicyHandlerDAOImpl.java

BimsaraBodaragama · 2024-12-11T08:52:03Z

...organization/resource/sharing/policy/management/dao/ResourceSharingPolicyHandlerDAOImpl.java

+        AtomicReference<ResourceSharingPolicy> resourceSharingPolicy = new AtomicReference<>(null);
+
+        try {
+            namedJdbcTemplate.executeQuery(


fetchSingle

BimsaraBodaragama · 2024-12-11T08:54:07Z

...organization/resource/sharing/policy/management/dao/ResourceSharingPolicyHandlerDAOImpl.java

+            throws ResourceSharingPolicyMgtServerException {
+
+        NamedJdbcTemplate namedJdbcTemplate = getNewTemplate();
+        AtomicReference<ResourceSharingPolicy> resourceSharingPolicy = new AtomicReference<>(null);


Research the need of AtomicReference

BimsaraBodaragama · 2024-12-11T08:57:06Z

...ity/organization/resource/sharing/policy/management/ResourceSharingPolicyHandlerService.java

+ * these attributes.
+ * </p>
+ */
+public interface ResourceSharingPolicyHandlerService {


add two new methods POST and GET to both resource and its attributes at once.

BimsaraBodaragama · 2024-12-11T08:59:19Z

...organization/resource/sharing/policy/management/dao/ResourceSharingPolicyHandlerDAOImpl.java

+
+        String orgIdsString = policyHoldingOrganizationIds.stream().map(id -> "'" + id + "'")
+                .collect(Collectors.joining(","));
+        String query = GET_RESOURCE_SHARING_POLICIES_BY_ORG_IDS_HEAD + "(" + orgIdsString + ");";


Write in a way to avoid to SQL injections.

BimsaraBodaragama · 2024-12-11T09:02:24Z

...organization/resource/sharing/policy/management/dao/ResourceSharingPolicyHandlerDAOImpl.java

+
+    @Override
+    public boolean deleteResourceSharingPolicyRecordById(int resourceSharingPolicyId,
+                                                         String deleteRequestInitiatedOrgId)


deleteRequestInitiatedOrgId -> sharingPolicyInitiatedOrgId

Check all places.

...organization/resource/sharing/policy/management/dao/ResourceSharingPolicyHandlerDAOImpl.java

...esource/sharing/policy/management/internal/ResourceSharingPolicyHandlerServiceComponent.java

pom.xml

.../identity/organization/resource/sharing/policy/management/model/SharedResourceAttribute.java

...nization/resource/sharing/policy/management/ResourceSharingPolicyHandlerServiceImplTest.java

BimsaraBodaragama added 19 commits November 26, 2024 00:53

cmp_resource: Initiate Resource Sharing policy management Component

91de7f1

cmp_resource: Checkstyle format

d528223

cmp_resource: Introduce PolicyEnum to resource sharing policy manager

350e476

cmp_resource: Introduce add resource sharing policy record

7b44434

cmp_resource: Introduce add shared resource attribute record

262ce9f

cmp_resource: Make adding of shared resource attributes dumb

142c6c2

cmp_resource: Add new delete methods for deleting resource sharing po…

341a3f2

…licy record and shared resource attributes by resource sharing policy id

cmp_resource: Remove deleting resource sharing policy by querying its…

12dbac4

… attributes rather than deleting it from record id since that way of deletion is not currently needed.

cmp_resource: Remove deleting resource sharing policy by querying its…

f155832

… attributes rather than deleting it from record id since that way of deletion is not currently needed - Part 2.

cmp_resource: Add a batch insert with transaction when adding shared …

1d66d83

…attributes

cmp_resource: Implement GET to SharedResourceAttributes

9b52181

cmp_resource: Implement GET to SharedResourceAttributes - Part 2

7c3dc5d

cmp_resource: Support to implement get sharing policy

789504e

cmp_resource: Put the ids in the models to reference UM_IDs in the DB…

be9407a

… tables

cmp_resource: Restructured SharedResourceAttribute

1e4e1fc

cmp_resource: Implement GETTERS for the SharedResourceAttributes

ff15b6c

cmp_resource: Implement GETTERS for the ResourceSharingPolicies

4fa453e

cmp_resource: Implement DELETE with type and id

84eb221

cmp_resource: Restructure method sequence in the ResourceSharingPolic…

be18f1b

…yManagement component

BimsaraBodaragama self-assigned this Nov 25, 2024

dhaura reviewed Nov 26, 2024

View reviewed changes

components/org.wso2.carbon.identity.organization.resource.sharing.policy.management/pom.xml Show resolved Hide resolved

dhaura reviewed Nov 26, 2024

View reviewed changes

components/org.wso2.carbon.identity.organization.resource.sharing.policy.management/pom.xml Outdated Show resolved Hide resolved

cmp_resource: Rename models to model

33018fa

BimsaraBodaragama added 6 commits November 27, 2024 00:33

cmp_resource: Remove Builders from the GETs and replaced them with se…

1a6dacc

…tters.

cmp_resource: Refactor query in DELETE of ResourceSharingPolicy

63b63f3

cmp_resource: Refactor deletions to support only from sharing initiat…

56f7967

…ed org id.

cmp_resource: Unit test suits

1ea53cc

cmp_resource: Unit test suits refactor

511730c

cmp_resource: Restructure the method sequence in the component.

74a581c

BimsaraBodaragama added 3 commits December 2, 2024 14:04

cmp_resource: Restructure the ResourceTypes to hold the applicable Sh…

1de61d8

…aredAttributeTypes.

cmp_resource: Refine tests.

d3f58a7

cmp_resource: Improve javadoc comments on interfaces following the CS…

a4a4230

… 190: Software Design Studio (Winter 2018) standards[1]. [1] https://web.stanford.edu/~ouster/cgi-bin/cs190-winter18/lecture.php?topic=comments