extensions: implement catalog for data management api

CHANGELOG.md

@@ -20,6 +20,7 @@ in the detailed section referring to by linking pull requests or issues.
 * Add domain model documentation (#1158)
 * Add gradle test summary (#1148)
 * Check to avoid duplicated module names (#1190)
+* Implement Catalog service for Data Management API (#1195)
 
 #### Changed
 

core/base/src/main/java/org/eclipse/dataspaceconnector/core/base/RemoteMessageDispatcherRegistryImpl.java

@@ -27,6 +27,8 @@
 import java.util.Objects;
 import java.util.concurrent.CompletableFuture;
 
+import static java.util.concurrent.CompletableFuture.failedFuture;
+
 public class RemoteMessageDispatcherRegistryImpl implements RemoteMessageDispatcherRegistry {
 
     private final Map<String, RemoteMessageDispatcher> dispatchers = new HashMap<>();
@@ -39,12 +41,10 @@ public void register(RemoteMessageDispatcher dispatcher) {
     @Override
     public <T> CompletableFuture<T> send(Class<T> responseType, RemoteMessage message, MessageContext context) {
         Objects.requireNonNull(message, "Message was null");
-        String protocol = message.getProtocol();
-        RemoteMessageDispatcher dispatcher = getDispatcher(protocol);
+        var protocol = message.getProtocol();
+        var dispatcher = getDispatcher(protocol);
         if (dispatcher == null) {
-            var future = new CompletableFuture<T>();
-            future.completeExceptionally(new EdcException("No provider dispatcher registered for protocol: " + protocol));
-            return future;
+            return failedFuture(new EdcException("No provider dispatcher registered for protocol: " + protocol));
         }
         return dispatcher.send(responseType, message, context);
     }

data-protocols/ids/ids-api-multipart-dispatcher-v1/src/main/java/org/eclipse/dataspaceconnector/ids/api/multipart/dispatcher/sender/MultipartCatalogDescriptionRequestSender.java

@@ -29,7 +29,6 @@
 import org.eclipse.dataspaceconnector.spi.EdcException;
 import org.eclipse.dataspaceconnector.spi.iam.IdentityService;
 import org.eclipse.dataspaceconnector.spi.monitor.Monitor;
-import org.eclipse.dataspaceconnector.spi.result.Result;
 import org.eclipse.dataspaceconnector.spi.types.domain.catalog.Catalog;
 import org.eclipse.dataspaceconnector.spi.types.domain.catalog.CatalogRequest;
 import org.jetbrains.annotations.NotNull;
@@ -87,21 +86,21 @@ protected Catalog getResponseContent(IdsMultipartParts parts) {
             throw new EdcException("Payload was null but connector self-description was expected");
         }
 
-        BaseConnector baseConnector = getBaseConnector(getObjectMapper(), parts);
+        var baseConnector = getBaseConnector(getObjectMapper(), parts);
         if (baseConnector.getResourceCatalog() == null || baseConnector.getResourceCatalog().isEmpty()) {
             throw new EdcException("Resource catalog is null in connector self-description, should not happen");
         }
 
         // If there is no resource catalog in connector self-description, we initialize a new empty resource catalog.
-        ResourceCatalog resourceCatalog = baseConnector.getResourceCatalog().stream()
+        var resourceCatalog = baseConnector.getResourceCatalog().stream()
                 .findFirst()
                 .orElse(new ResourceCatalogBuilder().build());
 
         if (catalogDoesNotContainAnyOfferResource(resourceCatalog)) {
             createOfferResourcesFromProperties(resourceCatalog, getObjectMapper());
         }
 
-        Result<Catalog> transformResult = getTransformerRegistry().transform(resourceCatalog, Catalog.class);
+        var transformResult = getTransformerRegistry().transform(resourceCatalog, Catalog.class);
 
         if (transformResult.failed()) {
             throw new EdcException(String.format("Could not transform ids data catalog: %s", String.join(", ", transformResult.getFailureMessages())));

extensions/api/data-management/build.gradle.kts

@@ -18,14 +18,14 @@ plugins {
 
 dependencies {
     api(project(":extensions:api:api-core"))
-    api(project(":extensions:api:data-management:contractdefinition"))
+    api(project(":extensions:api:data-management:api-configuration"))
+    api(project(":extensions:api:data-management:asset"))
+    api(project(":extensions:api:data-management:catalog-api"))
     api(project(":extensions:api:data-management:contractagreement"))
-    api(project(":extensions:api:data-management:transferprocess"))
+    api(project(":extensions:api:data-management:contractdefinition"))
     api(project(":extensions:api:data-management:contractnegotiation"))
     api(project(":extensions:api:data-management:policydefinition"))
     api(project(":extensions:api:data-management:transferprocess"))
-    api(project(":extensions:api:data-management:asset"))
-    api(project(":extensions:api:data-management:api-configuration"))
 }
 
 publishing {

extensions/api/data-management/catalog-api/build.gradle.kts

@@ -0,0 +1,45 @@
+/*
+ *  Copyright (c) 2020 - 2022 Bayerische Motoren Werke Aktiengesellschaft (BMW AG)
+ *
+ *  This program and the accompanying materials are made available under the
+ *  terms of the Apache License, Version 2.0 which is available at
+ *  https://www.apache.org/licenses/LICENSE-2.0
+ *
+ *  SPDX-License-Identifier: Apache-2.0
+ *
+ *  Contributors:
+ *       Bayerische Motoren Werke Aktiengesellschaft (BMW AG) - initial API and implementation
+
+ *
+ */
+
+val rsApi: String by project
+val restAssured: String by project
+
+plugins {
+    `java-library`
+    id("io.swagger.core.v3.swagger-gradle-plugin")
+}
+
+dependencies {
+    implementation(project(":extensions:api:api-core"))
+    implementation(project(":extensions:api:auth-spi"))
+    implementation(project(":extensions:api:data-management:api-configuration"))
+
+    implementation("jakarta.ws.rs:jakarta.ws.rs-api:${rsApi}")
+
+    testImplementation(project(":extensions:http"))
+    testImplementation(project(":extensions:iam:iam-mock"))
+    testImplementation(testFixtures(project(":common:util")))
+    testImplementation(testFixtures(project(":launchers:junit")))
+    testImplementation("io.rest-assured:rest-assured:${restAssured}")
+}
+
+publishing {
+    publications {
+        create<MavenPublication>("catalog-api") {
+            artifactId = "catalog-api"
+            from(components["java"])
+        }
+    }
+}

extensions/api/data-management/catalog-api/src/main/java/org/eclipse/dataspaceconnector/api/datamanagement/catalog/CatalogApi.java

@@ -0,0 +1,35 @@
+/*
+ *  Copyright (c) 2020 - 2022 Bayerische Motoren Werke Aktiengesellschaft
+ *
+ *  This program and the accompanying materials are made available under the
+ *  terms of the Apache License, Version 2.0 which is available at
+ *  https://www.apache.org/licenses/LICENSE-2.0
+ *
+ *  SPDX-License-Identifier: Apache-2.0
+ *
+ *  Contributors:
+ *       Bayerische Motoren Werke Aktiengesellschaft - initial API and implementation
+ *
+ */
+
+package org.eclipse.dataspaceconnector.api.datamanagement.catalog;
+
+import io.swagger.v3.oas.annotations.OpenAPIDefinition;
+import io.swagger.v3.oas.annotations.Operation;
+import io.swagger.v3.oas.annotations.media.Content;
+import io.swagger.v3.oas.annotations.media.Schema;
+import io.swagger.v3.oas.annotations.responses.ApiResponse;
+import io.swagger.v3.oas.annotations.tags.Tag;
+import jakarta.ws.rs.container.AsyncResponse;
+import org.eclipse.dataspaceconnector.spi.types.domain.catalog.Catalog;
+
+@OpenAPIDefinition
+@Tag(name = "Catalog")
+public interface CatalogApi {
+
+    @Operation(responses = {
+            @ApiResponse(content = @Content(mediaType = "application/json", schema = @Schema(implementation = Catalog.class)))
+    })
+    void getCatalog(String provider, AsyncResponse response);
+
+}

extensions/api/data-management/catalog-api/src/main/java/org/eclipse/dataspaceconnector/api/datamanagement/catalog/CatalogApiController.java

@@ -0,0 +1,48 @@
+/*
+ *  Copyright (c) 2022 Bayerische Motoren Werke Aktiengesellschaft (BMW AG)
+ *
+ *  This program and the accompanying materials are made available under the
+ *  terms of the Apache License, Version 2.0 which is available at
+ *  https://www.apache.org/licenses/LICENSE-2.0
+ *
+ *  SPDX-License-Identifier: Apache-2.0
+ *
+ *  Contributors:
+ *       Bayerische Motoren Werke Aktiengesellschaft (BMW AG) - improvements
+ *
+ */
+
+package org.eclipse.dataspaceconnector.api.datamanagement.catalog;
+
+import jakarta.ws.rs.GET;
+import jakarta.ws.rs.Path;
+import jakarta.ws.rs.Produces;
+import jakarta.ws.rs.QueryParam;
+import jakarta.ws.rs.container.AsyncResponse;
+import jakarta.ws.rs.container.Suspended;
+import jakarta.ws.rs.core.MediaType;
+import org.eclipse.dataspaceconnector.api.datamanagement.catalog.service.CatalogService;
+
+@Path("/catalog")
+@Produces({ MediaType.APPLICATION_JSON })
+public class CatalogApiController implements CatalogApi {
+
+    private final CatalogService service;
+
+    public CatalogApiController(CatalogService service) {
+        this.service = service;
+    }
+
+    @Override
+    @GET
+    public void getCatalog(@QueryParam("providerUrl") String providerUrl, @Suspended AsyncResponse response) {
+        service.getByProviderUrl(providerUrl)
+                .whenComplete((content, throwable) -> {
+                    if (throwable == null) {
+                        response.resume(content);
+                    } else {
+                        response.resume(throwable);
+                    }
+                });
+    }
+}

extensions/api/data-management/catalog-api/src/main/java/org/eclipse/dataspaceconnector/api/datamanagement/catalog/CatalogApiExtension.java

@@ -0,0 +1,45 @@
+/*
+ *  Copyright (c) 2022 Bayerische Motoren Werke Aktiengesellschaft (BMW AG)
+ *
+ *  This program and the accompanying materials are made available under the
+ *  terms of the Apache License, Version 2.0 which is available at
+ *  https://www.apache.org/licenses/LICENSE-2.0
+ *
+ *  SPDX-License-Identifier: Apache-2.0
+ *
+ *  Contributors:
+ *       Bayerische Motoren Werke Aktiengesellschaft (BMW AG) - improvements
+ *
+ */
+
+package org.eclipse.dataspaceconnector.api.datamanagement.catalog;
+
+import org.eclipse.dataspaceconnector.api.datamanagement.catalog.service.CatalogServiceImpl;
+import org.eclipse.dataspaceconnector.api.datamanagement.configuration.DataManagementApiConfiguration;
+import org.eclipse.dataspaceconnector.spi.WebService;
+import org.eclipse.dataspaceconnector.spi.message.RemoteMessageDispatcherRegistry;
+import org.eclipse.dataspaceconnector.spi.system.Inject;
+import org.eclipse.dataspaceconnector.spi.system.ServiceExtension;
+import org.eclipse.dataspaceconnector.spi.system.ServiceExtensionContext;
+
+public class CatalogApiExtension implements ServiceExtension {
+    @Inject
+    WebService webService;
+
+    @Inject
+    DataManagementApiConfiguration config;
+
+    @Inject
+    RemoteMessageDispatcherRegistry dispatcher;
+
+    @Override
+    public String name() {
+        return "Data Management API: Catalog";
+    }
+
+    @Override
+    public void initialize(ServiceExtensionContext context) {
+        var service = new CatalogServiceImpl(dispatcher);
+        webService.registerResource(config.getContextAlias(), new CatalogApiController(service));
+    }
+}

extensions/api/data-management/catalog-api/src/main/java/org/eclipse/dataspaceconnector/api/datamanagement/catalog/service/CatalogService.java

@@ -0,0 +1,29 @@
+/*
+ *  Copyright (c) 2020 - 2022 Bayerische Motoren Werke Aktiengesellschaft
+ *
+ *  This program and the accompanying materials are made available under the
+ *  terms of the Apache License, Version 2.0 which is available at
+ *  https://www.apache.org/licenses/LICENSE-2.0
+ *
+ *  SPDX-License-Identifier: Apache-2.0
+ *
+ *  Contributors:
+ *       Bayerische Motoren Werke Aktiengesellschaft - initial API and implementation
+ *
+ */
+
+package org.eclipse.dataspaceconnector.api.datamanagement.catalog.service;
+
+import org.eclipse.dataspaceconnector.spi.types.domain.catalog.Catalog;
+
+import java.util.concurrent.CompletableFuture;
+
+public interface CatalogService {
+    /**
+     * Return the catalog of the passed provider url
+     *
+     * @param providerUrl the url of the provider
+     * @return the provider's catalog
+     */
+    CompletableFuture<Catalog> getByProviderUrl(String providerUrl);
+}

extensions/api/data-management/catalog-api/src/main/java/org/eclipse/dataspaceconnector/api/datamanagement/catalog/service/CatalogServiceImpl.java

@@ -0,0 +1,40 @@
+/*
+ *  Copyright (c) 2020 - 2022 Bayerische Motoren Werke Aktiengesellschaft
+ *
+ *  This program and the accompanying materials are made available under the
+ *  terms of the Apache License, Version 2.0 which is available at
+ *  https://www.apache.org/licenses/LICENSE-2.0
+ *
+ *  SPDX-License-Identifier: Apache-2.0
+ *
+ *  Contributors:
+ *       Bayerische Motoren Werke Aktiengesellschaft - initial API and implementation
+ *
+ */
+
+package org.eclipse.dataspaceconnector.api.datamanagement.catalog.service;
+
+import org.eclipse.dataspaceconnector.spi.message.RemoteMessageDispatcherRegistry;
+import org.eclipse.dataspaceconnector.spi.types.domain.catalog.Catalog;
+import org.eclipse.dataspaceconnector.spi.types.domain.catalog.CatalogRequest;
+
+import java.util.concurrent.CompletableFuture;
+
+public class CatalogServiceImpl implements CatalogService {
+    private final RemoteMessageDispatcherRegistry dispatcher;
+
+    public CatalogServiceImpl(RemoteMessageDispatcherRegistry dispatcher) {
+        this.dispatcher = dispatcher;
+    }
+
+    @Override
+    public CompletableFuture<Catalog> getByProviderUrl(String providerUrl) {
+        var request = CatalogRequest.Builder.newInstance()
+                .protocol("ids-multipart")
+                .connectorId(providerUrl)
+                .connectorAddress(providerUrl)
+                .build();
+
+        return dispatcher.send(Catalog.class, request, () -> null);
+    }
+}

extensions/api/data-management/catalog-api/src/main/resources/META-INF/services/org.eclipse.dataspaceconnector.spi.system.ServiceExtension

@@ -0,0 +1,15 @@
+#
+#  Copyright (c) 2020 - 2022 Bayerische Motoren Werke Aktiengesellschaft
+#
+#  This program and the accompanying materials are made available under the
+#  terms of the Apache License, Version 2.0 which is available at
+#  https://www.apache.org/licenses/LICENSE-2.0
+#
+#  SPDX-License-Identifier: Apache-2.0
+#
+#  Contributors:
+#       Bayerische Motoren Werke Aktiengesellschaft - initial implementation
+#
+#
+
+org.eclipse.dataspaceconnector.api.datamanagement.catalog.CatalogApiExtension