type-safe UiAsset

extensions/wrapper/client/src/test/java/de/sovity/edc/client/AssetApiServiceTest.java

@@ -14,7 +14,7 @@
 package de.sovity.edc.client;
 
 
-import de.sovity.edc.client.gen.model.AssetCreateRequest;
+import de.sovity.edc.client.gen.model.UiAssetCreateRequest;
 import de.sovity.edc.ext.wrapper.utils.EdcPropertyUtils;
 import lombok.SneakyThrows;
 import org.eclipse.edc.connector.spi.asset.AssetService;
@@ -28,6 +28,7 @@
 import org.junit.jupiter.api.extension.ExtendWith;
 
 import java.text.SimpleDateFormat;
+import java.util.List;
 import java.util.Map;
 
 import static org.assertj.core.api.Assertions.assertThat;
@@ -54,7 +55,7 @@ void assetPage(AssetService assetStore) {
         var privateProperties = Map.of("random-private-prop", "456");
         var properties = Map.of(
                 Asset.PROPERTY_ID, "asset-1",
-                "random-prop", "123"
+                "landingPage", "https://data-source.my-org/docs"
         );
         createAsset(assetStore, "2023-06-01", properties, privateProperties);
 
@@ -65,11 +66,11 @@ void assetPage(AssetService assetStore) {
         var assets = result.getAssets();
         assertThat(assets).hasSize(1);
         var asset = assets.get(0);
-        assertThat(asset.getProperties()).isEqualTo(properties);
+        assertThat(asset.getId()).isEqualTo(properties.get(Asset.PROPERTY_ID));
+        assertThat(asset.getLandingPageUrl()).isEqualTo(properties.get("landingPage"));
         assertThat(asset.getPrivateProperties()).isEqualTo(privateProperties);
     }
 
-
     @Test
     void assetPageSorting(AssetService assetService) {
         // arrange
@@ -83,39 +84,35 @@ void assetPageSorting(AssetService assetService) {
 
         // assert
         assertThat(result.getAssets())
-                .extracting(asset -> asset.getProperties().get(Asset.PROPERTY_ID))
+                .extracting(asset -> asset.getId())
                 .containsExactly("asset-3", "asset-2", "asset-1");
     }
 
     @Test
     void testAssetCreation(AssetService assetService) {
         // arrange
         var client = TestUtils.edcClient();
-        var properties = Map.of(
-                Asset.PROPERTY_ID, "asset-1",
-                "random-prop", "123"
-        );
-        var privateProperties = Map.of("random-private-prop", "456");
         var dataAddressProperties = Map.of(
                 EDC_DATA_ADDRESS_TYPE_PROPERTY, DATA_ADDRESS_TYPE,
                 "baseUrl", DATA_SINK
         );
-        var assetRequest = AssetCreateRequest.builder()
-                .properties(properties)
-                .privateProperties(privateProperties)
+        var uiAssetRequest = UiAssetCreateRequest.builder()
+                .id("asset-1")
+                .name("AssetName")
+                .keywords(List.of("keyword1", "keyword2"))
                 .dataAddressProperties(dataAddressProperties)
                 .build();
 
         // act
-        var response = client.uiApi().createAsset(assetRequest);
+        var response = client.uiApi().createAsset(uiAssetRequest);
 
         // assert
-        assertThat(response.getId()).isEqualTo(properties.get(Asset.PROPERTY_ID));
+        assertThat(response.getId()).isEqualTo("asset-1");
         var assets = assetService.query(QuerySpec.max()).getContent().toList();
         assertThat(assets).hasSize(1);
         var asset = assets.get(0);
-        assertThat(asset.getProperties()).isEqualTo(properties);
-        assertThat(asset.getPrivateProperties()).isEqualTo(privateProperties);
+        assertThat(asset.getName()).isEqualTo("AssetName");
+        assertThat(asset.getProperties().get("keywords")).isEqualTo(List.of("keyword1", "keyword2"));
         assertThat(asset.getDataAddress().getProperties()).isEqualTo(dataAddressProperties);
     }
 
@@ -161,6 +158,5 @@ private static long dateFormatterToLong(String date) {
         SimpleDateFormat formatter = new SimpleDateFormat("yyyy-MM-dd");
         return formatter.parse(date).getTime();
     }
-
 }
 

extensions/wrapper/client/src/test/java/de/sovity/edc/client/ContractAgreementPageTest.java

@@ -93,8 +93,8 @@ void testContractAgreementPage(
         assertThat(agreement.getCounterPartyAddress()).isEqualTo("http://other-connector");
         assertThat(agreement.getCounterPartyId()).isEqualTo("urn:connector:other-connector");
         assertThat(agreement.getContractSigningDate()).isEqualTo(todayPlusDays(0));
-        assertThat(agreement.getAsset().getProperties()).containsEntry("https://w3id.org/edc/v0.0.1/ns/id", ASSET_ID);
-        assertThat(agreement.getAsset().getProperties()).containsEntry("some-property", "X");
+        assertThat(agreement.getAsset().getId()).isEqualTo(ASSET_ID);
+        assertThat(agreement.getAsset().getLandingPageUrl()).isEqualTo("X");
         assertThat(agreement.getTransferProcesses()).hasSize(1);
 
         var transfer = agreement.getTransferProcesses().get(0);
@@ -178,7 +178,7 @@ private ContractNegotiation contractDefinition(int contract) {
     private Asset asset(String assetId) {
         return Asset.Builder.newInstance()
                 .id(assetId)
-                .property("some-property", "X")
+                .property("http://www.w3.org/ns/dcat#landingPage", "X")
                 .createdAt(todayEpochMillis)
                 .dataAddress(dataAddress())
                 .build();

extensions/wrapper/wrapper-common-api/build.gradle.kts

@@ -9,6 +9,7 @@ dependencies {
     annotationProcessor("org.projectlombok:lombok:${lombokVersion}")
     compileOnly("org.projectlombok:lombok:${lombokVersion}")
 
+
     api("jakarta.ws.rs:jakarta.ws.rs-api:3.1.0")
     api("jakarta.validation:jakarta.validation-api:3.0.2")
     api("io.swagger.core.v3:swagger-annotations-jakarta:2.2.15")

extensions/wrapper/wrapper-common-api/src/main/java/de/sovity/edc/ext/wrapper/api/common/model/UiAsset.java

@@ -22,17 +22,94 @@
 import lombok.Setter;
 import lombok.ToString;
 
+import java.util.List;
+import java.util.Map;
+
 @Getter
 @Setter
+
 @ToString
 @AllArgsConstructor
 @Builder(toBuilder = true)
 @RequiredArgsConstructor
 @Schema(description = "Type-Safe Asset Metadata as needed by our UI")
 public class UiAsset {
-    @Schema(description = "Asset ID", requiredMode = Schema.RequiredMode.REQUIRED)
-    private String assetId;
 
-    @Schema(description = "Asset name")
+    @Schema(description = "Asset Id", requiredMode = Schema.RequiredMode.REQUIRED)
+    private String id;
+
+    @Schema(description = "Asset Name", requiredMode = Schema.RequiredMode.NOT_REQUIRED)
     private String name;
+
+    @Schema(description = "Asset Title", requiredMode = Schema.RequiredMode.NOT_REQUIRED)
+    private String title;
+
+    @Schema(description = "Asset Language", requiredMode = Schema.RequiredMode.NOT_REQUIRED)
+    private String language;
+
+    @Schema(description = "Asset Description", requiredMode = Schema.RequiredMode.NOT_REQUIRED)
+    private String description;
+
+    @Schema(description = "Asset Organization Name", requiredMode = Schema.RequiredMode.NOT_REQUIRED)
+    private String creator;
+
+    @Schema(description = "Asset Homepage", requiredMode = Schema.RequiredMode.NOT_REQUIRED)
+    private String publisher;
+
+    @Schema(description = "License URL", requiredMode = Schema.RequiredMode.NOT_REQUIRED)
+    private String licenseUrl;
+
+    @Schema(description = "Version", requiredMode = Schema.RequiredMode.NOT_REQUIRED)
+    private String version;
+
+    @Schema(description = "Asset Keywords", requiredMode = Schema.RequiredMode.NOT_REQUIRED)
+    private List<String> keywords;
+
+    @Schema(description = "Asset MediaType", requiredMode = Schema.RequiredMode.NOT_REQUIRED)
+    private String distribution;
+
+    @Schema(description = "Landing Page URL", requiredMode = Schema.RequiredMode.NOT_REQUIRED)
+    private String landingPageUrl;
+
+    @Schema(description = "HTTP Datasource Hints Proxy Method", requiredMode = Schema.RequiredMode.NOT_REQUIRED)
+    private Boolean httpDatasourceHintsProxyMethod;
+
+    @Schema(description = "HTTP Datasource Hints Proxy Path", requiredMode = Schema.RequiredMode.NOT_REQUIRED)
+    private Boolean httpDatasourceHintsProxyPath;
+
+    @Schema(description = "HTTP Datasource Hints Proxy Query Params", requiredMode = Schema.RequiredMode.NOT_REQUIRED)
+    private Boolean httpDatasourceHintsProxyQueryParams;
+
+    @Schema(description = "HTTP Datasource Hints Proxy Body", requiredMode = Schema.RequiredMode.NOT_REQUIRED)
+    private Boolean httpDatasourceHintsProxyBody;
+
+    @Schema(description = "Data Category", requiredMode = Schema.RequiredMode.NOT_REQUIRED)
+    private String dataCategory;
+
+    @Schema(description = "Data Subcategory", requiredMode = Schema.RequiredMode.NOT_REQUIRED)
+    private String dataSubcategory;
+
+    @Schema(description = "Data Model", requiredMode = Schema.RequiredMode.NOT_REQUIRED)
+    private String dataModel;
+
+    @Schema(description = "Geo-Reference Method", requiredMode = Schema.RequiredMode.NOT_REQUIRED)
+    private String geoReferenceMethod;
+
+    @Schema(description = "Transport Mode", requiredMode = Schema.RequiredMode.NOT_REQUIRED)
+    private String transportMode;
+
+    @Schema(description = "Asset additional Properties", requiredMode = Schema.RequiredMode.NOT_REQUIRED)
+    private Map<String, String> additionalProperties;
+
+    @Schema(description = "Asset Private Properties", requiredMode = Schema.RequiredMode.NOT_REQUIRED)
+    private Map<String, Object> privateProperties;
+
+    @Schema(description = "Asset Json Properties", requiredMode = Schema.RequiredMode.NOT_REQUIRED)
+    private Map<String, String> additionalJsonProperties;
+
+    @Schema(description = "Asset DataAddress Properties", requiredMode = Schema.RequiredMode.NOT_REQUIRED)
+    private Map<String, String> dataAddressProperties;
+
+    @Schema(description = "Contains the entire asset in its original expanded JSON-LD format", requiredMode = Schema.RequiredMode.NOT_REQUIRED)
+    private String assetJsonLd;
 }

extensions/wrapper/wrapper-common-api/src/main/java/de/sovity/edc/ext/wrapper/api/common/model/UiAssetCreateRequest.java

@@ -0,0 +1,97 @@
+/*
+ *  Copyright (c) 2022 sovity GmbH
+ *
+ *  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:
+ *       sovity GmbH - initial API and implementation
+ *
+ */
+
+package de.sovity.edc.ext.wrapper.api.common.model;
+
+import io.swagger.v3.oas.annotations.media.Schema;
+import lombok.AllArgsConstructor;
+import lombok.Getter;
+import lombok.NoArgsConstructor;
+import lombok.Setter;
+
+import java.util.List;
+import java.util.Map;
+
+@Getter
+@Setter
+@NoArgsConstructor
+@AllArgsConstructor
+@Schema(description = "Type-Safe OpenAPI generator friendly Asset Create DTO that supports an opinionated subset of the original EDC Asset Entity.")
+public class UiAssetCreateRequest {
+    @Schema(description = "Asset Id", requiredMode = Schema.RequiredMode.REQUIRED)
+    private String id;
+
+    @Schema(description = "Asset Name", requiredMode = Schema.RequiredMode.NOT_REQUIRED)
+    private String name;
+
+    @Schema(description = "Asset Title", requiredMode = Schema.RequiredMode.NOT_REQUIRED)
+    private String title;
+
+    @Schema(description = "Asset Language", requiredMode = Schema.RequiredMode.NOT_REQUIRED)
+    private String language;
+
+    @Schema(description = "Asset Description", requiredMode = Schema.RequiredMode.NOT_REQUIRED)
+    private String description;
+
+    @Schema(description = "Asset Organization Name", requiredMode = Schema.RequiredMode.NOT_REQUIRED)
+    private String creator;
+
+    @Schema(description = "Asset Homepage", requiredMode = Schema.RequiredMode.NOT_REQUIRED)
+    private String publisher;
+
+    @Schema(description = "License URL", requiredMode = Schema.RequiredMode.NOT_REQUIRED)
+    private String licenseUrl;
+
+    @Schema(description = "Version", requiredMode = Schema.RequiredMode.NOT_REQUIRED)
+    private String version;
+
+    @Schema(description = "Asset Keywords", requiredMode = Schema.RequiredMode.NOT_REQUIRED)
+    private List<String> keywords;
+
+    @Schema(description = "Asset MediaType", requiredMode = Schema.RequiredMode.NOT_REQUIRED)
+    private String distribution;
+
+    @Schema(description = "Landing Page URL", requiredMode = Schema.RequiredMode.NOT_REQUIRED)
+    private String landingPageUrl;
+
+    @Schema(description = "Data Category", requiredMode = Schema.RequiredMode.NOT_REQUIRED)
+    private String dataCategory;
+
+    @Schema(description = "Data Subcategory", requiredMode = Schema.RequiredMode.NOT_REQUIRED)
+    private String dataSubcategory;
+
+    @Schema(description = "Data Model", requiredMode = Schema.RequiredMode.NOT_REQUIRED)
+    private String dataModel;
+
+    @Schema(description = "Geo-Reference Method", requiredMode = Schema.RequiredMode.NOT_REQUIRED)
+    private String geoReferenceMethod;
+
+    @Schema(description = "Transport Mode", requiredMode = Schema.RequiredMode.NOT_REQUIRED)
+    private String transportMode;
+
+    @Schema(description = "Data Address", requiredMode = Schema.RequiredMode.REQUIRED)
+    private Map<String, String> dataAddressProperties;
+
+    @Schema(description = "Asset additional Properties", requiredMode = Schema.RequiredMode.NOT_REQUIRED)
+    private Map<String, String> additionalProperties;
+
+    @Schema(description = "Asset Private Properties", requiredMode = Schema.RequiredMode.NOT_REQUIRED)
+    private Map<String, Object> privateProperties;
+
+    @Schema(description = "Asset Json Properties", requiredMode = Schema.RequiredMode.NOT_REQUIRED)
+    private Map<String, String> additionalJsonProperties;
+
+    @Schema(description = "Contains the entire asset in its original expanded JSON-LD format", requiredMode = Schema.RequiredMode.NOT_REQUIRED)
+    private String assetJsonLd;
+}