feat: add private properties to contract definition entity

extensions/control-plane/api/management-api/contract-definition-api/src/main/java/org/eclipse/edc/connector/api/management/contractdefinition/ContractDefinitionApiExtension.java

@@ -10,6 +10,7 @@
  *  Contributors:
  *       Microsoft Corporation - initial API and implementation
  *       Bayerische Motoren Werke Aktiengesellschaft (BMW AG) - improvements
+ *       SAP SE - add private properties to contract definition
  *
  */
 
@@ -26,12 +27,14 @@
 import org.eclipse.edc.runtime.metamodel.annotation.Inject;
 import org.eclipse.edc.spi.system.ServiceExtension;
 import org.eclipse.edc.spi.system.ServiceExtensionContext;
+import org.eclipse.edc.spi.types.TypeManager;
 import org.eclipse.edc.validator.spi.JsonObjectValidatorRegistry;
 import org.eclipse.edc.web.spi.WebService;
 
 import java.util.Map;
 
 import static org.eclipse.edc.connector.contract.spi.types.offer.ContractDefinition.CONTRACT_DEFINITION_TYPE;
+import static org.eclipse.edc.spi.CoreConstants.JSON_LD;
 
 @Extension(value = ContractDefinitionApiExtension.NAME)
 public class ContractDefinitionApiExtension implements ServiceExtension {
@@ -53,6 +56,9 @@ public class ContractDefinitionApiExtension implements ServiceExtension {
     @Inject
     JsonObjectValidatorRegistry validatorRegistry;
 
+    @Inject
+    private TypeManager typeManager;
+
     @Override
     public String name() {
         return NAME;
@@ -61,7 +67,8 @@ public String name() {
     @Override
     public void initialize(ServiceExtensionContext context) {
         var jsonFactory = Json.createBuilderFactory(Map.of());
-        transformerRegistry.register(new JsonObjectFromContractDefinitionTransformer(jsonFactory));
+        var mapper = typeManager.getMapper(JSON_LD);
+        transformerRegistry.register(new JsonObjectFromContractDefinitionTransformer(jsonFactory, mapper));
         transformerRegistry.register(new JsonObjectToContractDefinitionTransformer());
 
         validatorRegistry.register(CONTRACT_DEFINITION_TYPE, ContractDefinitionValidator.instance());

extensions/control-plane/api/management-api/contract-definition-api/src/main/java/org/eclipse/edc/connector/api/management/contractdefinition/transform/JsonObjectFromContractDefinitionTransformer.java

@@ -9,11 +9,13 @@
  *
  *  Contributors:
  *       Bayerische Motoren Werke Aktiengesellschaft (BMW AG) - initial API and implementation
+ *       SAP SE - add private properties to contract definition
  *
  */
 
 package org.eclipse.edc.connector.api.management.contractdefinition.transform;
 
+import com.fasterxml.jackson.databind.ObjectMapper;
 import jakarta.json.JsonBuilderFactory;
 import jakarta.json.JsonObject;
 import org.eclipse.edc.connector.contract.spi.types.offer.ContractDefinition;
@@ -31,11 +33,13 @@
 import static org.eclipse.edc.jsonld.spi.JsonLdKeywords.TYPE;
 
 public class JsonObjectFromContractDefinitionTransformer extends AbstractJsonLdTransformer<ContractDefinition, JsonObject> {
+    private final ObjectMapper mapper;
     private final JsonBuilderFactory jsonFactory;
 
-    public JsonObjectFromContractDefinitionTransformer(JsonBuilderFactory jsonFactory) {
+    public JsonObjectFromContractDefinitionTransformer(JsonBuilderFactory jsonFactory, ObjectMapper jsonLdMapper) {
         super(ContractDefinition.class, JsonObject.class);
         this.jsonFactory = jsonFactory;
+        this.mapper = jsonLdMapper;
     }
 
     @Override
@@ -44,12 +48,19 @@ public JsonObjectFromContractDefinitionTransformer(JsonBuilderFactory jsonFactor
                 .map(criterion -> context.transform(criterion, JsonObject.class))
                 .collect(toJsonArray());
 
-        return jsonFactory.createObjectBuilder()
+        var builder = jsonFactory.createObjectBuilder()
                 .add(ID, contractDefinition.getId())
                 .add(TYPE, CONTRACT_DEFINITION_TYPE)
                 .add(CONTRACT_DEFINITION_ACCESSPOLICY_ID, contractDefinition.getAccessPolicyId())
                 .add(CONTRACT_DEFINITION_CONTRACTPOLICY_ID, contractDefinition.getContractPolicyId())
-                .add(CONTRACT_DEFINITION_ASSETS_SELECTOR, criteria)
-                .build();
+                .add(CONTRACT_DEFINITION_ASSETS_SELECTOR, criteria);
+
+        if (!contractDefinition.getPrivateProperties().isEmpty()) {
+            var privatePropBuilder = jsonFactory.createObjectBuilder();
+            transformProperties(contractDefinition.getPrivateProperties(), privatePropBuilder, mapper, context);
+            builder.add(ContractDefinition.CONTRACT_DEFINITION_PRIVATE_PROPERTIES, privatePropBuilder);
+        }
+
+        return builder.build();
     }
 }

extensions/control-plane/api/management-api/contract-definition-api/src/main/java/org/eclipse/edc/connector/api/management/contractdefinition/transform/JsonObjectToContractDefinitionTransformer.java

@@ -9,12 +9,14 @@
  *
  *  Contributors:
  *       Bayerische Motoren Werke Aktiengesellschaft (BMW AG) - initial API and implementation
+ *       SAP SE - add private properties to contract definition
  *
  */
 
 package org.eclipse.edc.connector.api.management.contractdefinition.transform;
 
 import jakarta.json.JsonObject;
+import jakarta.json.JsonValue;
 import org.eclipse.edc.connector.contract.spi.types.offer.ContractDefinition;
 import org.eclipse.edc.jsonld.spi.transformer.AbstractJsonLdTransformer;
 import org.eclipse.edc.spi.query.Criterion;
@@ -25,7 +27,7 @@
 import static org.eclipse.edc.connector.contract.spi.types.offer.ContractDefinition.CONTRACT_DEFINITION_ACCESSPOLICY_ID;
 import static org.eclipse.edc.connector.contract.spi.types.offer.ContractDefinition.CONTRACT_DEFINITION_ASSETS_SELECTOR;
 import static org.eclipse.edc.connector.contract.spi.types.offer.ContractDefinition.CONTRACT_DEFINITION_CONTRACTPOLICY_ID;
-
+import static org.eclipse.edc.connector.contract.spi.types.offer.ContractDefinition.CONTRACT_DEFINITION_PRIVATE_PROPERTIES;
 
 public class JsonObjectToContractDefinitionTransformer extends AbstractJsonLdTransformer<JsonObject, ContractDefinition> {
 
@@ -36,19 +38,23 @@ public JsonObjectToContractDefinitionTransformer() {
     @Override
     public @Nullable ContractDefinition transform(@NotNull JsonObject object, @NotNull TransformerContext context) {
         var builder = ContractDefinition.Builder.newInstance();
-
         builder.id(nodeId(object));
-
-        visitProperties(object, (key, value) -> {
-            switch (key) {
-                case CONTRACT_DEFINITION_ACCESSPOLICY_ID -> builder.accessPolicyId(transformString(value, context));
-                case CONTRACT_DEFINITION_CONTRACTPOLICY_ID -> builder.contractPolicyId(transformString(value, context));
-                case CONTRACT_DEFINITION_ASSETS_SELECTOR -> builder.assetsSelector(transformArray(value, Criterion.class, context));
-                default -> { }
-            }
-        });
-
+        visitProperties(object, (s, jsonValue) -> transformProperties(s, jsonValue, builder, context));
         return builderResult(builder::build, context);
     }
 
+    private void transformProperties(String key, JsonValue jsonValue, ContractDefinition.Builder builder, TransformerContext context) {
+        switch (key) {
+            case CONTRACT_DEFINITION_ACCESSPOLICY_ID -> builder.accessPolicyId(transformString(jsonValue, context));
+            case CONTRACT_DEFINITION_CONTRACTPOLICY_ID -> builder.contractPolicyId(transformString(jsonValue, context));
+            case CONTRACT_DEFINITION_ASSETS_SELECTOR -> builder.assetsSelector(transformArray(jsonValue, Criterion.class, context));
+            case CONTRACT_DEFINITION_PRIVATE_PROPERTIES -> {
+                var props = jsonValue.asJsonArray().getJsonObject(0);
+                visitProperties(props, (k, val) -> transformProperties(k, val, builder, context));
+            }
+            default -> {
+                builder.privateProperty(key, transformGenericProperty(jsonValue, context));
+            }
+        }
+    }
 }

extensions/control-plane/api/management-api/contract-definition-api/src/test/java/org/eclipse/edc/connector/api/management/contractdefinition/transform/JsonObjectFromContractDefinitionTransformerTest.java

@@ -9,6 +9,7 @@
  *
  *  Contributors:
  *       Bayerische Motoren Werke Aktiengesellschaft (BMW AG) - initial API and implementation
+ *       SAP SE - add private properties to contract definition
  *
  */
 
@@ -29,9 +30,11 @@
 import static org.eclipse.edc.connector.contract.spi.types.offer.ContractDefinition.CONTRACT_DEFINITION_ACCESSPOLICY_ID;
 import static org.eclipse.edc.connector.contract.spi.types.offer.ContractDefinition.CONTRACT_DEFINITION_ASSETS_SELECTOR;
 import static org.eclipse.edc.connector.contract.spi.types.offer.ContractDefinition.CONTRACT_DEFINITION_CONTRACTPOLICY_ID;
+import static org.eclipse.edc.connector.contract.spi.types.offer.ContractDefinition.CONTRACT_DEFINITION_PRIVATE_PROPERTIES;
 import static org.eclipse.edc.connector.contract.spi.types.offer.ContractDefinition.CONTRACT_DEFINITION_TYPE;
 import static org.eclipse.edc.jsonld.spi.JsonLdKeywords.ID;
 import static org.eclipse.edc.jsonld.spi.JsonLdKeywords.TYPE;
+import static org.eclipse.edc.jsonld.util.JacksonJsonLd.createObjectMapper;
 import static org.eclipse.edc.spi.query.Criterion.criterion;
 import static org.mockito.ArgumentMatchers.anyString;
 import static org.mockito.ArgumentMatchers.eq;
@@ -46,7 +49,7 @@ class JsonObjectFromContractDefinitionTransformerTest {
     private final JsonBuilderFactory jsonFactory = Json.createBuilderFactory(Map.of());
     private final TransformerContext context = mock(TransformerContext.class);
 
-    private final JsonObjectFromContractDefinitionTransformer transformer = new JsonObjectFromContractDefinitionTransformer(jsonFactory);
+    private final JsonObjectFromContractDefinitionTransformer transformer = new JsonObjectFromContractDefinitionTransformer(jsonFactory, createObjectMapper());
 
     @Test
     void transform() {
@@ -72,4 +75,24 @@ void transform() {
         verify(context, never()).reportProblem(anyString());
     }
 
+
+    @Test
+    void transform_withPrivateProperties_simpleTypes() {
+        var criterionJson = jsonFactory.createObjectBuilder().build();
+        when(context.transform(isA(Criterion.class), eq(JsonObject.class))).thenReturn(criterionJson);
+        var criterion = criterion("left", "=", "right");
+        var contractDefinition = ContractDefinition.Builder.newInstance()
+                .id("id")
+                .accessPolicyId("accessPolicyId")
+                .contractPolicyId("contractPolicyId")
+                .assetsSelector(List.of(criterion))
+                .privateProperty("some-key", "some-value")
+                .build();
+
+        var jsonObject = transformer.transform(contractDefinition, context);
+
+        assertThat(jsonObject).isNotNull();
+        assertThat(jsonObject.getJsonObject(CONTRACT_DEFINITION_PRIVATE_PROPERTIES).getJsonString("some-key").getString()).isEqualTo("some-value");
+    }
+
 }

extensions/control-plane/api/management-api/contract-definition-api/src/test/java/org/eclipse/edc/connector/api/management/contractdefinition/transform/JsonObjectToContractDefinitionTransformerTest.java

@@ -9,13 +9,17 @@
  *
  *  Contributors:
  *       Bayerische Motoren Werke Aktiengesellschaft (BMW AG) - initial API and implementation
+ *       SAP SE - add private properties to contract definition
  *
  */
 
 package org.eclipse.edc.connector.api.management.contractdefinition.transform;
 
 import jakarta.json.JsonObject;
+import jakarta.json.JsonObjectBuilder;
 import org.eclipse.edc.connector.contract.spi.types.offer.ContractDefinition;
+import org.eclipse.edc.jsonld.TitaniumJsonLd;
+import org.eclipse.edc.spi.monitor.Monitor;
 import org.eclipse.edc.spi.query.Criterion;
 import org.eclipse.edc.transform.spi.TransformerContext;
 import org.junit.jupiter.api.Test;
@@ -26,8 +30,14 @@
 import static org.eclipse.edc.connector.contract.spi.types.offer.ContractDefinition.CONTRACT_DEFINITION_ACCESSPOLICY_ID;
 import static org.eclipse.edc.connector.contract.spi.types.offer.ContractDefinition.CONTRACT_DEFINITION_ASSETS_SELECTOR;
 import static org.eclipse.edc.connector.contract.spi.types.offer.ContractDefinition.CONTRACT_DEFINITION_CONTRACTPOLICY_ID;
+import static org.eclipse.edc.connector.contract.spi.types.offer.ContractDefinition.CONTRACT_DEFINITION_PRIVATE_PROPERTIES;
 import static org.eclipse.edc.connector.contract.spi.types.offer.ContractDefinition.CONTRACT_DEFINITION_TYPE;
+import static org.eclipse.edc.jsonld.spi.JsonLdKeywords.CONTEXT;
+import static org.eclipse.edc.jsonld.spi.JsonLdKeywords.ID;
 import static org.eclipse.edc.jsonld.spi.JsonLdKeywords.TYPE;
+import static org.eclipse.edc.jsonld.spi.JsonLdKeywords.VOCAB;
+import static org.eclipse.edc.spi.CoreConstants.EDC_NAMESPACE;
+import static org.eclipse.edc.spi.CoreConstants.EDC_PREFIX;
 import static org.mockito.ArgumentMatchers.any;
 import static org.mockito.ArgumentMatchers.eq;
 import static org.mockito.Mockito.mock;
@@ -40,6 +50,8 @@ class JsonObjectToContractDefinitionTransformerTest {
     private final JsonObjectToContractDefinitionTransformer transformer = new JsonObjectToContractDefinitionTransformer();
     private final TransformerContext context = mock(TransformerContext.class);
 
+    private final TitaniumJsonLd jsonLd = new TitaniumJsonLd(mock(Monitor.class));
+
     @Test
     void types() {
         assertThat(transformer.getInputType()).isEqualTo(JsonObject.class);
@@ -84,4 +96,35 @@ void transform_whenNoAssetSelectorItShouldBeAnEmptyList() {
         verify(context, never()).transform(any(), any());
     }
 
+
+    @Test
+    void transform_withPrivateProperties() {
+        when(context.transform(any(), eq(Object.class))).thenReturn("test-val");
+        var jsonObj = createObjectBuilder()
+                .add(CONTEXT, createContextBuilder().addNull(EDC_PREFIX).build())
+                .add(ID, "some-contract-definition-id")
+                .add(TYPE, CONTRACT_DEFINITION_TYPE)
+                .add(CONTRACT_DEFINITION_ACCESSPOLICY_ID, "accessPolicyId")
+                .add(CONTRACT_DEFINITION_CONTRACTPOLICY_ID, "contractPolicyId")
+                .add(CONTRACT_DEFINITION_PRIVATE_PROPERTIES, createArrayBuilder().add(createObjectBuilder().add("test-prop", "test-val").build()).build())
+                .build();
+
+        jsonObj = expand(jsonObj);
+        var contractDefinition = transformer.transform(jsonObj, context);
+
+        assertThat(contractDefinition.getPrivateProperties())
+                .hasSize(1)
+                .containsEntry(EDC_NAMESPACE + "test-prop", "test-val");
+    }
+
+    private JsonObject expand(JsonObject jsonObject) {
+        return jsonLd.expand(jsonObject).orElseThrow(f -> new AssertionError(f.getFailureDetail()));
+    }
+
+    private JsonObjectBuilder createContextBuilder() {
+        return createObjectBuilder()
+                .add(VOCAB, EDC_NAMESPACE)
+                .add(EDC_PREFIX, EDC_NAMESPACE);
+    }
+
 }

extensions/control-plane/store/sql/contract-definition-store-sql/docs/er.puml

@@ -5,5 +5,6 @@ entity edc_contract_definitions {
   * access_policy: string <<json>>
   * contract_policy: string <<json>>
   * assets_selector: string <<json>>
+  * private_properties: string <<json>>
 }
 @enduml

extensions/control-plane/store/sql/contract-definition-store-sql/docs/schema.sql

@@ -10,6 +10,7 @@
 --  Contributors:
 --       Daimler TSS GmbH - Initial SQL Query
 --       Microsoft Corporation - refactoring
+--       SAP SE - add private properties to contract definition
 --
 
 -- table: edc_contract_definitions
@@ -21,5 +22,6 @@ CREATE TABLE IF NOT EXISTS edc_contract_definitions
     access_policy_id       VARCHAR NOT NULL,
     contract_policy_id     VARCHAR NOT NULL,
     assets_selector        JSON    NOT NULL,
+    private_properties     JSON,
     PRIMARY KEY (contract_definition_id)
 );

extensions/control-plane/store/sql/contract-definition-store-sql/src/main/java/org/eclipse/edc/connector/store/sql/contractdefinition/SqlContractDefinitionStore.java

@@ -12,6 +12,7 @@
  *       Microsoft Corporation - refactoring, bugfixing
  *       Fraunhofer Institute for Software and Systems Engineering - added method
  *       Bayerische Motoren Werke Aktiengesellschaft (BMW AG) - improvements
+ *       SAP SE - add private properties to contract definition
  *
  */
 
@@ -37,6 +38,7 @@
 import java.sql.ResultSet;
 import java.sql.SQLException;
 import java.util.List;
+import java.util.Map;
 import java.util.Objects;
 import java.util.stream.Stream;
 
@@ -48,6 +50,9 @@ public class SqlContractDefinitionStore extends AbstractSqlStore implements Cont
     public static final TypeReference<List<Criterion>> CRITERION_LIST = new TypeReference<>() {
     };
 
+    private static final TypeReference<Map<String, Object>> PRIVATE_PROPERTIES_TYPE = new TypeReference<>() {
+    };
+
     public SqlContractDefinitionStore(DataSourceRegistry dataSourceRegistry, String dataSourceName,
                                       TransactionContext transactionContext, ContractDefinitionStatements statements,
                                       ObjectMapper objectMapper, QueryExecutor queryExecutor) {
@@ -142,6 +147,7 @@ private ContractDefinition mapResultSet(ResultSet resultSet) throws Exception {
                 .accessPolicyId(resultSet.getString(statements.getAccessPolicyIdColumn()))
                 .contractPolicyId(resultSet.getString(statements.getContractPolicyIdColumn()))
                 .assetsSelector(fromJson(resultSet.getString(statements.getAssetsSelectorColumn()), CRITERION_LIST))
+                .privateProperties(fromJson(resultSet.getString(statements.getPrivatePropertiesColumn()), PRIVATE_PROPERTIES_TYPE))
                 .build();
     }
 
@@ -152,7 +158,8 @@ private void insertInternal(Connection connection, ContractDefinition definition
                     definition.getAccessPolicyId(),
                     definition.getContractPolicyId(),
                     toJson(definition.getAssetsSelector()),
-                    definition.getCreatedAt());
+                    definition.getCreatedAt(),
+                    toJson(definition.getPrivateProperties()));
         });
     }
 
@@ -164,6 +171,7 @@ private void updateInternal(Connection connection, ContractDefinition definition
                 definition.getContractPolicyId(),
                 toJson(definition.getAssetsSelector()),
                 definition.getCreatedAt(),
+                toJson(definition.getPrivateProperties()),
                 definition.getId());
     }
 
@@ -182,5 +190,4 @@ private ContractDefinition findById(Connection connection, String id) {
         var sql = statements.getFindByTemplate();
         return queryExecutor.single(connection, false, this::mapResultSet, sql, id);
     }
-
 }

extensions/control-plane/store/sql/contract-definition-store-sql/src/main/java/org/eclipse/edc/connector/store/sql/contractdefinition/schema/BaseSqlDialectStatements.java

@@ -40,11 +40,11 @@ public String getInsertTemplate() {
                 .column(getContractPolicyIdColumn())
                 .jsonColumn(getAssetsSelectorColumn())
                 .column(getCreatedAtColumn())
+                .jsonColumn(getPrivatePropertiesColumn())
                 .insertInto(getContractDefinitionTable());
     }
 
     @Override
-
     public String getCountTemplate() {
         return format("SELECT COUNT (%s) FROM %s WHERE %s = ?",
                 getIdColumn(),
@@ -60,6 +60,7 @@ public String getUpdateTemplate() {
                 .column(getContractPolicyIdColumn())
                 .jsonColumn(getAssetsSelectorColumn())
                 .column(getCreatedAtColumn())
+                .jsonColumn(getPrivatePropertiesColumn())
                 .update(getContractDefinitionTable(), getIdColumn());
 
     }