Merge branch 'develop' into copyTests

Author: rishikunnath2747

README.md

@@ -16,6 +16,7 @@ This plugin can be consumed by the CAP application deployed on BTP to store thei
 - Maximum allowed uploads: Provides the capability to define the maximum number of uploads allowed for the user.
 - Multiple attachment facets: Provides the capability to define multiple attachment facets/sections in the CAP Entity.
 - Technical user support: Provides the capability to consume the plugin using technical user.
+- Copy attachments: Provides the capability to copy attachments from one entity to another entity.
 
 ## Table of Contents
 
@@ -28,6 +29,7 @@ This plugin can be consumed by the CAP application deployed on BTP to store thei
 - [Support for Maximum allowed uploads](#support-for-maximum-allowed-uploads)
 - [Support for Multiple attachment facets](#support-for-multiple-attachment-facets)
 - [Support for Technical user](#support-for-technical-user)
+- [Support for Copy attachments](#support-for-copy-attachments)
 - [Known Restrictions](#known-restrictions)
 - [Support, Feedback, Contributing](#support-feedback-contributing)
 - [Code of Conduct](#code-of-conduct)
@@ -314,10 +316,9 @@ Follow these steps if you want to integrate the SDM CAP Plugin with your own CAP
 
 ## Support for Multitenancy
 
-
 This plugin provides APIs for onboarding and offboarding of repositories for multitenant CAP SaaS applications. 
 
-GetDependencies,subscribe and unsubscribe are the mandatory steps to be performed to support multitenancy.
+GetDependencies, subscribe and unsubscribe are the mandatory steps to be performed to support multitenancy.
 
 Refer the below example to pass the SDM Service dependencies to SaaSRegistry so that SDM credentials are passed to subscribing tenant.
 ```java
@@ -514,6 +515,47 @@ request =
       .build();
 ```
 
+## Support for copy attachments
+
+This plugin provides capability to copy attachments from one entity to another. This capability will copy attachments metadata on CAP as well as actual content on the SAP Document Management service repository. This feature can be used in following two ways.
+
+1. **A helper method to copy attachments from one entity to another**
+   
+   The `AttachmentService` instance can be used to call `copyAttachments` method. This method expects an object of `CopyAttachmentInput` which requires new entity's Id (`up__Id`), the `attachments facet name` and the `list of objectIds` corresponding to attachments that are to be copied.
+
+   Example usage:
+   ```java
+      String up__ID = "123";
+      List<String> objectIds = ["abc", "xyz"];
+      String facet = "AdminService.Books.attachments" // Target facet. This can be usually obtained from context.getTarget().getQualifiedName()
+      boolean isSystemUser = false;
+      var copyEventInput =
+         new CopyAttachmentInput(up__ID, facet, objectIds);
+      attachmentService.copyAttachments(copyEventInput, isSystemUser);
+   ```
+2. **OData API to copy attachments from one entity to another**
+   
+   You can also use an OData API call to trigger the copy operation.
+   `AttachmentsService` endpoint URL can be used with suffix `/<Service_name>.copyAttachments` . This request expects the following request body:
+   ```json
+   {
+      "up__ID" : "<up__ID>",  // ID of the new entity
+      "objectIds" : "abc","xyz" // objectIds corresponding to attachments that are to be copied
+   }
+   ```
+
+   Example usage:  
+   ```
+   HTTP Method: POST
+   Request URL:
+   <app_url>/odata/v4/<Service_Name>/<Entity_Name>(ID=<up__ID>,IsActiveEntity=false)/attachments/<Service_name>.copyAttachments
+   Request Body:
+   {
+      "up__ID": "<up__ID>",
+      "objectIds": "abc","xyz"
+   }
+   ```
+
 ## Known Restrictions
 
 - UI5 Version 1.135.0: This version causes error in upload of attachments.

sdm/pom.xml

@@ -559,6 +559,9 @@
                         <exclude>
                             com/sap/cds/sdm/caching/**
                         </exclude>
+                        <exclude>
+                            com/sap/cds/sdm/service/handler/AttachmentCopyEventContext.class
+                        </exclude>
                     </excludes>
                 </configuration>
                 <executions>

sdm/src/main/java/com/sap/cds/sdm/configuration/Registration.java

@@ -10,6 +10,9 @@
 import com.sap.cds.sdm.persistence.DBQuery;
 import com.sap.cds.sdm.service.*;
 import com.sap.cds.sdm.service.handler.SDMAttachmentsServiceHandler;
+import com.sap.cds.sdm.service.handler.SDMCustomServiceHandler;
+import com.sap.cds.sdm.service.handler.SDMServiceGenericHandler;
+import com.sap.cds.services.draft.DraftService;
 import com.sap.cds.services.environment.CdsEnvironment;
 import com.sap.cds.services.environment.CdsProperties;
 import com.sap.cds.services.handler.EventHandler;
@@ -48,12 +51,19 @@ public void eventHandlers(CdsRuntimeConfigurer configurer) {
             .getCdsRuntime()
             .getServiceCatalog()
             .getService(PersistenceService.class, PersistenceService.DEFAULT_NAME);
+    var attachmentService =
+        configurer
+            .getCdsRuntime()
+            .getServiceCatalog()
+            .getService(RegisterService.class, RegisterService.SDM_NAME);
     List<ServiceBinding> bindings =
         environment
             .getServiceBindings()
             .filter(b -> ServiceBindingUtils.matches(b, SDMConstants.SDM_ENV_NAME))
             .toList();
     var binding = !bindings.isEmpty() ? bindings.get(0) : null;
+    List<DraftService> draftServiceList =
+        configurer.getCdsRuntime().getServiceCatalog().getServices(DraftService.class).toList();
 
     // get HTTP connection pool configuration
     var connectionPool = getConnectionPool(environment);
@@ -77,6 +87,9 @@ public void eventHandlers(CdsRuntimeConfigurer configurer) {
             documentService,
             tokenHandlerInstance,
             dbQueryInstance));
+    configurer.eventHandler(new SDMServiceGenericHandler(attachmentService));
+    configurer.eventHandler(
+        new SDMCustomServiceHandler(sdmService, draftServiceList, tokenHandlerInstance));
   }
 
   private AttachmentService buildAttachmentService() {

sdm/src/main/java/com/sap/cds/sdm/constants/SDMConstants.java

@@ -69,6 +69,10 @@ private SDMConstants() {
   public static final String NAMED_USER_FLOW = "TOKEN_EXCHANGE";
   public static final String ANNOTATION_IS_MEDIA_DATA = "_is_media_data";
   public static final String DRAFT_READONLY_CONTEXT = "DRAFT_READONLY_CONTEXT";
+  public static final String FAILED_TO_COPY_ATTACHMENT = "Failed to copy attachment";
+  public static final String FAILED_TO_FETCH_UP_ID = "Failed to fetch up_id";
+  public static final String FAILED_TO_FETCH_FACET =
+      "Invalid facet format, unable to extract required information.";
 
   public static String nameConstraintMessage(
       List<String> fileNameWithRestrictedCharacters, String operation) {

sdm/src/main/java/com/sap/cds/sdm/model/CopyAttachmentInput.java

@@ -0,0 +1,12 @@
+package com.sap.cds.sdm.model;
+
+import java.util.List;
+
+/**
+ * The class {@link CopyAttachmentInput} is used to store the input for creating an attachment.
+ *
+ * @param upId The keys for the attachment entity
+ * @param facet
+ * @param objectIds
+ */
+public record CopyAttachmentInput(String upId, String facet, List<String> objectIds) {}

sdm/src/main/java/com/sap/cds/sdm/service/DocumentUploadService.java

@@ -50,7 +50,7 @@ public DocumentUploadService(
    * Implementation to create document.
    */
   public JSONObject createDocument(
-      CmisDocument cmisDocument, SDMCredentials sdmCredentials, Boolean isSystemUser)
+      CmisDocument cmisDocument, SDMCredentials sdmCredentials, boolean isSystemUser)
       throws IOException {
     try {
       long totalSize = cmisDocument.getContentLength();
@@ -93,7 +93,7 @@ private void appendContentStream(
       int bytesRead,
       boolean isLastChunk,
       int chunkIndex,
-      Boolean isSystemUser)
+      boolean isSystemUser)
       throws IOException, ParseException {
 
     MultipartEntityBuilder builder = MultipartEntityBuilder.create();
@@ -132,7 +132,7 @@ private void appendContentStream(
   }
 
   private JSONObject createEmptyDocument(
-      CmisDocument cmisDocument, String sdmUrl, Boolean isSystemUser) {
+      CmisDocument cmisDocument, String sdmUrl, boolean isSystemUser) {
 
     MultipartEntityBuilder builder = MultipartEntityBuilder.create();
     builder.addTextBody("cmisaction", "createDocument");
@@ -157,7 +157,7 @@ private JSONObject createEmptyDocument(
   }
 
   public JSONObject uploadSingleChunk(
-      CmisDocument cmisDocument, SDMCredentials sdmCredentials, Boolean isSystemUser)
+      CmisDocument cmisDocument, SDMCredentials sdmCredentials, boolean isSystemUser)
       throws IOException {
 
     InputStream originalStream = cmisDocument.getContent();
@@ -194,7 +194,7 @@ public JSONObject uploadSingleChunk(
   }
 
   private JSONObject uploadLargeFileInChunks(
-      CmisDocument cmisDocument, String sdmUrl, int chunkSize, Boolean isSystemUser)
+      CmisDocument cmisDocument, String sdmUrl, int chunkSize, boolean isSystemUser)
       throws IOException {
 
     try (ReadAheadInputStream chunkedStream =

sdm/src/main/java/com/sap/cds/sdm/service/RegisterService.java

@@ -1,7 +1,11 @@
 package com.sap.cds.sdm.service;
 
+import com.sap.cds.sdm.model.CopyAttachmentInput;
 import com.sap.cds.services.Service;
 
 public interface RegisterService extends Service {
   String SDM_NAME = "SDMAttachmentService$Default";
+  String EVENT_COPY_ATTACHMENT = "COPY_ATTACHMENT";
+
+  public void copyAttachments(CopyAttachmentInput input, boolean isSystemUser);
 }

sdm/src/main/java/com/sap/cds/sdm/service/SDMAttachmentsService.java

@@ -10,6 +10,8 @@
 import com.sap.cds.feature.attachments.service.model.servicehandler.AttachmentReadEventContext;
 import com.sap.cds.feature.attachments.service.model.servicehandler.AttachmentRestoreEventContext;
 import com.sap.cds.feature.attachments.service.model.servicehandler.DeletionUserInfo;
+import com.sap.cds.sdm.model.CopyAttachmentInput;
+import com.sap.cds.sdm.service.handler.AttachmentCopyEventContext;
 import com.sap.cds.services.ServiceDelegator;
 import com.sap.cds.services.request.UserInfo;
 import java.io.InputStream;
@@ -25,6 +27,23 @@ public SDMAttachmentsService() {
     super(SDM_NAME);
   }
 
+  @Override
+  public void copyAttachments(CopyAttachmentInput input, boolean isSystemUser) {
+    logger.info(
+        "Copying attachments for upId: {}, facet: {}, objectIds: {}, isSystemUser: {}",
+        input.upId(),
+        input.facet(),
+        input.objectIds(),
+        isSystemUser);
+    var copyContext = AttachmentCopyEventContext.create();
+    copyContext.setUpId(input.upId());
+    copyContext.setFacet(input.facet());
+    copyContext.setObjectIds(input.objectIds());
+    copyContext.setSystemUser(isSystemUser);
+
+    emit(copyContext);
+  }
+
   @Override
   public InputStream readAttachment(String contentId) {
     logger.info("Reading attachment with document id: {}", contentId);

sdm/src/main/java/com/sap/cds/sdm/service/SDMService.java

@@ -16,15 +16,15 @@ public JSONObject createDocument(
       CmisDocument cmisDocument, SDMCredentials sdmCredentials, String jwtToken) throws IOException;
 
   public String createFolder(
-      String parentId, String repositoryId, SDMCredentials sdmCredentials, Boolean isSystemUser)
+      String parentId, String repositoryId, SDMCredentials sdmCredentials, boolean isSystemUser)
       throws IOException;
 
   public String getFolderId(
-      Result result, PersistenceService persistenceService, String upID, Boolean isSystemUser)
+      Result result, PersistenceService persistenceService, String upID, boolean isSystemUser)
       throws IOException;
 
   public String getFolderIdByPath(
-      String parentId, String repositoryId, SDMCredentials sdmCredentials, Boolean isSystemUser)
+      String parentId, String repositoryId, SDMCredentials sdmCredentials, boolean isSystemUser)
       throws IOException;
 
   public String checkRepositoryType(String repositoryId, String tenant) throws IOException;
@@ -44,19 +44,23 @@ public int updateAttachments(
       CmisDocument cmisDocument,
       Map<String, String> secondaryProperties,
       Map<String, String> secondaryPropertiesWithInvalidDefinitions,
-      Boolean isSystemUser)
+      boolean isSystemUser)
       throws ServiceException;
 
-  public String getObject(String objectId, SDMCredentials sdmCredentials, Boolean isSystemUser)
+  public String getObject(String objectId, SDMCredentials sdmCredentials, boolean isSystemUser)
       throws IOException;
 
   public List<String> getSecondaryTypes(
-      String repositoryId, SDMCredentials sdmCredentials, Boolean isSystemUser) throws IOException;
+      String repositoryId, SDMCredentials sdmCredentials, boolean isSystemUser) throws IOException;
 
   public List<String> getValidSecondaryProperties(
       List<String> secondaryTypes,
       SDMCredentials sdmCredentials,
       String repositoryId,
-      Boolean isSystemUser)
+      boolean isSystemUser)
+      throws IOException;
+
+  public List<String> copyAttachment(
+      CmisDocument cmisDocument, SDMCredentials sdmCredentials, boolean isSystemUser)
       throws IOException;
 }