added option to filter wallet documents by type

Signed-off-by: Philipp Etschel <philipp.etschel@ch.bosch.com>

Author: Philipp Etschel

backend/business-partner-agent/src/main/java/org/hyperledger/bpa/controller/WalletController.java

@@ -18,15 +18,18 @@
 package org.hyperledger.bpa.controller;
 
 import io.micronaut.core.annotation.Nullable;
+import io.micronaut.core.convert.format.Format;
 import io.micronaut.http.HttpResponse;
 import io.micronaut.http.annotation.*;
 import io.micronaut.scheduling.TaskExecutors;
 import io.micronaut.scheduling.annotation.ExecuteOn;
 import io.micronaut.security.annotation.Secured;
 import io.micronaut.security.rules.SecurityRule;
 import io.micronaut.validation.Validated;
+import io.swagger.v3.oas.annotations.Parameter;
 import io.swagger.v3.oas.annotations.tags.Tag;
 import jakarta.inject.Inject;
+import org.hyperledger.bpa.api.CredentialType;
 import org.hyperledger.bpa.api.MyDocumentAPI;
 import org.hyperledger.bpa.api.aries.AriesCredential;
 import org.hyperledger.bpa.controller.api.issuer.DeclineExchangeRequest;
@@ -59,11 +62,15 @@ public class WalletController {
     /**
      * List wallet documents
      *
+     * @param types {@link CredentialType} multi value list of types to filter
      * @return list of {@link MyDocumentAPI}
      */
     @Get("/document")
-    public HttpResponse<List<MyDocumentAPI>> getDocuments() {
-        final List<MyDocumentAPI> myCreds = docMgmt.getMyDocuments();
+    public HttpResponse<List<MyDocumentAPI>> getDocuments(
+            @Parameter(
+                    description = "types filter") @Nullable @QueryValue @Format("MULTI") List<CredentialType> types) {
+        final List<MyDocumentAPI> myCreds = docMgmt
+                .getMyDocuments(types != null ? types.toArray(new CredentialType[0]) : null);
         return HttpResponse.ok(myCreds);
     }
 

backend/business-partner-agent/src/main/java/org/hyperledger/bpa/impl/MyDocumentManager.java

@@ -17,10 +17,12 @@
  */
 package org.hyperledger.bpa.impl;
 
+import io.micronaut.core.util.ArrayUtils;
 import jakarta.inject.Inject;
 import jakarta.inject.Singleton;
 import lombok.NonNull;
 import lombok.Setter;
+import org.hyperledger.bpa.api.CredentialType;
 import org.hyperledger.bpa.api.MyDocumentAPI;
 import org.hyperledger.bpa.api.exception.WrongApiUsageException;
 import org.hyperledger.bpa.config.BPAMessageSource;
@@ -84,9 +86,12 @@ public MyDocumentAPI updateDocument(@NonNull UUID id, @NonNull MyDocumentAPI api
         throw new WrongApiUsageException(ms.getMessage("api.document.not.found", Map.of("id", id)));
     }
 
-    public List<MyDocumentAPI> getMyDocuments() {
+    public List<MyDocumentAPI> getMyDocuments(CredentialType... types) {
         List<MyDocumentAPI> result = new ArrayList<>();
-        docRepo.findAll().forEach(dbDoc -> result.add(converter.toApiObject(dbDoc)));
+        List<CredentialType> search = Arrays.asList(Objects.requireNonNullElseGet(
+                ArrayUtils.isEmpty(types) ? null : types,
+                CredentialType::values));
+        docRepo.findByTypeIn(search).forEach(dbDoc -> result.add(converter.toApiObject(dbDoc)));
         return result;
     }
 

backend/business-partner-agent/src/main/java/org/hyperledger/bpa/repository/MyDocumentRepository.java

@@ -38,6 +38,8 @@ public interface MyDocumentRepository extends CrudRepository<MyDocument, UUID> {
      */
     List<MyDocument> findByIsPublicTrue();
 
+    List<MyDocument> findByTypeIn(List<CredentialType> type);
+
     boolean existsByTypeEqualsAndIsPublicTrue(CredentialType type);
 
     // this one is for migration of old agent versions only

backend/business-partner-agent/src/test/java/org/hyperledger/bpa/impl/MyDocumentManagerTest.java

@@ -173,7 +173,8 @@ void testGetMyCredentialById() throws Exception {
         MyDocumentAPI myCred = mgmt.saveNewDocument(credential);
         UUID ID = myCred.getId();
 
-        assertEquals(1, mgmt.getMyDocuments().size());
+        assertEquals(0, mgmt.getMyDocuments(CredentialType.ORGANIZATIONAL_PROFILE_CREDENTIAL).size());
+        assertEquals(1, mgmt.getMyDocuments(CredentialType.INDY).size());
         Optional<MyDocumentAPI> result = mgmt.getMyDocumentById(ID);
         assertTrue(result.isPresent());
 

backend/pom.xml

@@ -56,13 +56,13 @@
         <log4j2.version>2.14.1</log4j2.version>
         <lombok.version>1.18.22</lombok.version>
         <lombok.maven.plugin.version>1.18.20.0</lombok.maven.plugin.version>
-        <micronaut.version>3.1.4</micronaut.version>
+        <micronaut.version>3.2.0</micronaut.version>
         <micronaut.data.version>3.2.0</micronaut.data.version>
         <micronaut.openapi.version>3.2.0</micronaut.openapi.version>
-        <micronaut.security.version>3.1.0</micronaut.security.version>
+        <micronaut.security.version>3.2.0</micronaut.security.version>
         <mockito.version>4.1.0</mockito.version>
         <org.mapstruct.version>1.4.2.Final</org.mapstruct.version>
-        <pmd.version>6.40.0</pmd.version>
+        <pmd.version>6.41.0</pmd.version>
         <spotbugs.version>4.5.0</spotbugs.version>
         <testcontainers.version>1.16.2</testcontainers.version>
         <!-- Plugin Versions -->