feat: introduce policy definition request/response dto

core/control-plane/contract/src/test/java/org/eclipse/dataspaceconnector/contract/negotiation/ProviderContractNegotiationManagerImplTest.java

@@ -429,7 +429,7 @@ void confirming_shouldSendAgreementAndTransitionConfirmed() {
         when(store.nextForState(eq(CONFIRMING.code()), anyInt())).thenReturn(List.of(negotiation)).thenReturn(emptyList());
         when(dispatcherRegistry.send(any(), any(), any())).thenReturn(completedFuture(null));
         when(store.find(negotiation.getId())).thenReturn(negotiation);
-        when(policyStore.findById(any())).thenReturn(PolicyDefinition.Builder.newInstance().policy(Policy.Builder.newInstance().build()).uid("policyId").build());
+        when(policyStore.findById(any())).thenReturn(PolicyDefinition.Builder.newInstance().policy(Policy.Builder.newInstance().build()).id("policyId").build());
 
         negotiationManager.start();
 

core/control-plane/contract/src/test/java/org/eclipse/dataspaceconnector/contract/offer/ContractDefinitionServiceImplTest.java

@@ -76,7 +76,7 @@ void definitionsFor_verifySatisfiesPolicies() {
     @Test
     void definitionsFor_verifyDoesNotSatisfyAccessPolicy() {
         var agent = new ParticipantAgent(Map.of(), Map.of());
-        var definition = PolicyDefinition.Builder.newInstance().policy(Policy.Builder.newInstance().build()).uid("access").build();
+        var definition = PolicyDefinition.Builder.newInstance().policy(Policy.Builder.newInstance().build()).id("access").build();
         when(policyStore.findById(any())).thenReturn(definition);
         var contractDefinition = ContractDefinition.Builder.newInstance().id("1").accessPolicyId("access").contractPolicyId("contract").selectorExpression(SELECT_ALL).build();
         when(policyEngine.evaluate(any(), any(), any())).thenReturn(Result.failure("invalid"));

core/control-plane/control-plane-core/src/test/java/org/eclipse/dataspaceconnector/core/controlplane/defaults/policystore/InMemoryPolicyDefinitionStoreTest.java

@@ -167,12 +167,12 @@ private PolicyDefinition createPolicyDef() {
 
     private PolicyDefinition createPolicyDef(String id) {
         return PolicyDefinition.Builder.newInstance()
-                .uid(id)
+                .id(id)
                 .policy(Policy.Builder.newInstance().build())
                 .build();
     }
 
     private PolicyDefinition createPolicyDef(String id, String target) {
-        return PolicyDefinition.Builder.newInstance().uid(id).policy(Policy.Builder.newInstance().target(target).build()).build();
+        return PolicyDefinition.Builder.newInstance().id(id).policy(Policy.Builder.newInstance().target(target).build()).build();
     }
 }

docs/swaggerui/swagger-spec.js

@@ -1433,7 +1433,7 @@ window.swaggerSpec={
                 "schema" : {
                   "type" : "array",
                   "items" : {
-                    "$ref" : "#/components/schemas/PolicyDefinition"
+                    "$ref" : "#/components/schemas/PolicyDefinitionResponseDto"
                   }
                 }
               }
@@ -1462,7 +1462,7 @@ window.swaggerSpec={
           "content" : {
             "application/json" : {
               "schema" : {
-                "$ref" : "#/components/schemas/PolicyDefinition"
+                "$ref" : "#/components/schemas/PolicyDefinitionRequestDto"
               }
             }
           }
@@ -1521,7 +1521,7 @@ window.swaggerSpec={
             "content" : {
               "application/json" : {
                 "schema" : {
-                  "$ref" : "#/components/schemas/PolicyDefinition"
+                  "$ref" : "#/components/schemas/PolicyDefinitionResponseDto"
                 }
               }
             }
@@ -2720,7 +2720,20 @@ window.swaggerSpec={
           }
         }
       },
-      "PolicyDefinition" : {
+      "PolicyDefinitionRequestDto" : {
+        "required" : [ "policy" ],
+        "type" : "object",
+        "properties" : {
+          "id" : {
+            "type" : "string"
+          },
+          "policy" : {
+            "$ref" : "#/components/schemas/Policy"
+          }
+        }
+      },
+      "PolicyDefinitionResponseDto" : {
+        "required" : [ "policy" ],
         "type" : "object",
         "properties" : {
           "createdAt" : {
@@ -2732,9 +2745,6 @@ window.swaggerSpec={
           },
           "policy" : {
             "$ref" : "#/components/schemas/Policy"
-          },
-          "uid" : {
-            "type" : "string"
           }
         }
       },

extensions/api/data-management/contractnegotiation/src/test/java/org/eclipse/dataspaceconnector/api/datamanagement/contractnegotiation/service/ContractNegotiationEventDispatchTest.java

@@ -113,7 +113,7 @@ void shouldDispatchEventsOnProviderContractNegotiationStateChanges(EventRouter e
         eventRouter.register(eventSubscriber);
         var policy = Policy.Builder.newInstance().build();
         contractDefinitionStore.save(ContractDefinition.Builder.newInstance().id("contractDefinitionId").contractPolicyId("policyId").accessPolicyId("policyId").selectorExpression(AssetSelectorExpression.SELECT_ALL).build());
-        policyDefinitionStore.save(PolicyDefinition.Builder.newInstance().uid("policyId").policy(policy).build());
+        policyDefinitionStore.save(PolicyDefinition.Builder.newInstance().id("policyId").policy(policy).build());
         ((AssetLoader) assetIndex).accept(Asset.Builder.newInstance().id("assetId").build(), DataAddress.Builder.newInstance().type("any").build());
 
         manager.requested(token, createContractOfferRequest(policy));

extensions/api/data-management/policydefinition/src/main/java/org/eclipse/dataspaceconnector/api/datamanagement/policy/PolicyDefinitionApi.java

@@ -22,9 +22,10 @@
 import io.swagger.v3.oas.annotations.responses.ApiResponse;
 import io.swagger.v3.oas.annotations.tags.Tag;
 import jakarta.validation.Valid;
+import org.eclipse.dataspaceconnector.api.datamanagement.policy.model.PolicyDefinitionRequestDto;
+import org.eclipse.dataspaceconnector.api.datamanagement.policy.model.PolicyDefinitionResponseDto;
 import org.eclipse.dataspaceconnector.api.query.QuerySpecDto;
 import org.eclipse.dataspaceconnector.spi.ApiErrorDetail;
-import org.eclipse.dataspaceconnector.spi.policy.PolicyDefinition;
 
 import java.util.List;
 
@@ -34,23 +35,23 @@ public interface PolicyDefinitionApi {
 
     @Operation(description = "Returns all policy definitions according to a query",
             responses = {
-                    @ApiResponse(responseCode = "200", content = @Content(array = @ArraySchema(schema = @Schema(implementation = PolicyDefinition.class)))),
+                    @ApiResponse(responseCode = "200", content = @Content(array = @ArraySchema(schema = @Schema(implementation = PolicyDefinitionResponseDto.class)))),
                     @ApiResponse(responseCode = "400", description = "Request was malformed",
                             content = @Content(array = @ArraySchema(schema = @Schema(implementation = ApiErrorDetail.class)))) }
     )
-    List<PolicyDefinition> getAllPolicies(@Valid QuerySpecDto querySpecDto);
+    List<PolicyDefinitionResponseDto> getAllPolicies(@Valid QuerySpecDto querySpecDto);
 
     @Operation(description = "Gets a policy definition with the given ID",
             responses = {
                     @ApiResponse(responseCode = "200", description = "The  policy definition",
-                            content = @Content(schema = @Schema(implementation = PolicyDefinition.class))),
+                            content = @Content(schema = @Schema(implementation = PolicyDefinitionResponseDto.class))),
                     @ApiResponse(responseCode = "400", description = "Request was malformed, e.g. id was null",
                             content = @Content(array = @ArraySchema(schema = @Schema(implementation = ApiErrorDetail.class)))),
                     @ApiResponse(responseCode = "404", description = "An  policy definition with the given ID does not exist",
                             content = @Content(array = @ArraySchema(schema = @Schema(implementation = ApiErrorDetail.class))))
             }
     )
-    PolicyDefinition getPolicy(String id);
+    PolicyDefinitionResponseDto getPolicy(String id);
 
     @Operation(description = "Creates a new policy definition",
             responses = {
@@ -60,7 +61,7 @@ public interface PolicyDefinitionApi {
                     @ApiResponse(responseCode = "409", description = "Could not create policy definition, because a contract definition with that ID already exists",
                             content = @Content(array = @ArraySchema(schema = @Schema(implementation = ApiErrorDetail.class)))) }
     )
-    void createPolicy(PolicyDefinition policy);
+    void createPolicy(PolicyDefinitionRequestDto policy);
 
     @Operation(description = "Removes a policy definition with the given ID if possible. Deleting a policy definition is only possible if that policy definition is not yet referenced " +
             "by a contract definition, in which case an error is returned. " +

extensions/api/data-management/policydefinition/src/main/java/org/eclipse/dataspaceconnector/api/datamanagement/policy/PolicyDefinitionApiController.java

@@ -25,6 +25,8 @@
 import jakarta.ws.rs.PathParam;
 import jakarta.ws.rs.Produces;
 import jakarta.ws.rs.core.MediaType;
+import org.eclipse.dataspaceconnector.api.datamanagement.policy.model.PolicyDefinitionRequestDto;
+import org.eclipse.dataspaceconnector.api.datamanagement.policy.model.PolicyDefinitionResponseDto;
 import org.eclipse.dataspaceconnector.api.datamanagement.policy.service.PolicyDefinitionService;
 import org.eclipse.dataspaceconnector.api.query.QuerySpecDto;
 import org.eclipse.dataspaceconnector.api.transformer.DtoTransformerRegistry;
@@ -34,10 +36,11 @@
 import org.eclipse.dataspaceconnector.spi.monitor.Monitor;
 import org.eclipse.dataspaceconnector.spi.policy.PolicyDefinition;
 import org.eclipse.dataspaceconnector.spi.query.QuerySpec;
+import org.eclipse.dataspaceconnector.spi.result.Result;
 
-import java.util.ArrayList;
 import java.util.List;
 import java.util.Optional;
+import java.util.stream.Collectors;
 
 import static java.lang.String.format;
 import static org.eclipse.dataspaceconnector.api.ServiceResultHandler.mapToException;
@@ -59,7 +62,7 @@ public PolicyDefinitionApiController(Monitor monitor, PolicyDefinitionService po
 
     @GET
     @Override
-    public List<PolicyDefinition> getAllPolicies(@Valid @BeanParam QuerySpecDto querySpecDto) {
+    public List<PolicyDefinitionResponseDto> getAllPolicies(@Valid @BeanParam QuerySpecDto querySpecDto) {
         var result = transformerRegistry.transform(querySpecDto, QuerySpec.class);
         if (result.failed()) {
             throw new InvalidRequestException(result.getFailureMessages());
@@ -73,30 +76,42 @@ public List<PolicyDefinition> getAllPolicies(@Valid @BeanParam QuerySpecDto quer
         if (queryResult.failed()) {
             throw mapToException(queryResult, PolicyDefinition.class, null);
         }
-        return new ArrayList<>(queryResult.getContent());
 
+        return queryResult.getContent().stream()
+                .map(it -> transformerRegistry.transform(it, PolicyDefinitionResponseDto.class))
+                .filter(Result::succeeded)
+                .map(Result::getContent)
+                .collect(Collectors.toList());
     }
 
     @GET
     @Path("{id}")
     @Override
-    public PolicyDefinition getPolicy(@PathParam("id") String id) {
+    public PolicyDefinitionResponseDto getPolicy(@PathParam("id") String id) {
         monitor.debug(format("Attempting to return policy with ID %s", id));
         return Optional.of(id)
                 .map(it -> policyDefinitionService.findById(id))
+                .map(it -> transformerRegistry.transform(it, PolicyDefinitionResponseDto.class))
+                .filter(Result::succeeded)
+                .map(Result::getContent)
                 .orElseThrow(() -> new ObjectNotFoundException(Policy.class, id));
     }
 
     @POST
     @Override
-    public void createPolicy(PolicyDefinition policy) {
+    public void createPolicy(PolicyDefinitionRequestDto requestDto) {
+        var transformResult = transformerRegistry.transform(requestDto, PolicyDefinition.class);
+        if (transformResult.failed()) {
+            throw new InvalidRequestException(transformResult.getFailureMessages());
+        }
 
-        var result = policyDefinitionService.create(policy);
+        var definition = transformResult.getContent();
 
+        var result = policyDefinitionService.create(definition);
         if (result.succeeded()) {
-            monitor.debug(format("Policy created %s", policy.getUid()));
+            monitor.debug(format("Policy definition created %s", definition.getId()));
         } else {
-            throw mapToException(result, PolicyDefinition.class, policy.getUid());
+            throw mapToException(result, PolicyDefinition.class, definition.getId());
         }
     }
 

extensions/api/data-management/policydefinition/src/main/java/org/eclipse/dataspaceconnector/api/datamanagement/policy/PolicyDefinitionApiExtension.java

@@ -18,6 +18,8 @@
 import org.eclipse.dataspaceconnector.api.datamanagement.policy.service.PolicyDefinitionEventListener;
 import org.eclipse.dataspaceconnector.api.datamanagement.policy.service.PolicyDefinitionService;
 import org.eclipse.dataspaceconnector.api.datamanagement.policy.service.PolicyDefinitionServiceImpl;
+import org.eclipse.dataspaceconnector.api.datamanagement.policy.transform.PolicyDefinitionRequestDtoToPolicyDefinitionTransformer;
+import org.eclipse.dataspaceconnector.api.datamanagement.policy.transform.PolicyDefinitionToPolicyDefinitionResponseDtoTransformer;
 import org.eclipse.dataspaceconnector.api.transformer.DtoTransformerRegistry;
 import org.eclipse.dataspaceconnector.spi.WebService;
 import org.eclipse.dataspaceconnector.spi.contract.offer.store.ContractDefinitionStore;
@@ -59,6 +61,9 @@ public String name() {
 
     @Override
     public void initialize(ServiceExtensionContext context) {
+        transformerRegistry.register(new PolicyDefinitionRequestDtoToPolicyDefinitionTransformer());
+        transformerRegistry.register(new PolicyDefinitionToPolicyDefinitionResponseDtoTransformer());
+
         var monitor = context.getMonitor();
 
         var policyDefinitionObservable = new PolicyDefinitionObservableImpl();

extensions/api/data-management/policydefinition/src/main/java/org/eclipse/dataspaceconnector/api/datamanagement/policy/model/PolicyDefinitionRequestDto.java

@@ -0,0 +1,88 @@
+/*
+ *  Copyright (c) 2022 Microsoft Corporation
+ *
+ *  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:
+ *       Microsoft Corporation - initial API and implementation
+ *
+ */
+
+package org.eclipse.dataspaceconnector.api.datamanagement.policy.model;
+
+import com.fasterxml.jackson.annotation.JsonCreator;
+import com.fasterxml.jackson.databind.annotation.JsonDeserialize;
+import com.fasterxml.jackson.databind.annotation.JsonPOJOBuilder;
+import jakarta.validation.constraints.NotNull;
+import org.eclipse.dataspaceconnector.policy.model.Policy;
+
+import java.util.Objects;
+
+@JsonDeserialize(builder = PolicyDefinitionRequestDto.Builder.class)
+public class PolicyDefinitionRequestDto {
+
+    private String id;
+    @NotNull
+    private Policy policy;
+
+    private PolicyDefinitionRequestDto() {
+    }
+
+    public String getId() {
+        return id;
+    }
+
+    public Policy getPolicy() {
+        return policy;
+    }
+
+    @Override
+    public int hashCode() {
+        return Objects.hash(Objects.hash(id), policy.hashCode());
+    }
+
+    @Override
+    public boolean equals(Object o) {
+        if (this == o) {
+            return true;
+        }
+        if (o == null || getClass() != o.getClass()) {
+            return false;
+        }
+        PolicyDefinitionRequestDto that = (PolicyDefinitionRequestDto) o;
+        return Objects.equals(id, that.id) && policy.equals(that.policy);
+    }
+
+    @JsonPOJOBuilder(withPrefix = "")
+    public static final class Builder {
+
+        private final PolicyDefinitionRequestDto dto = new PolicyDefinitionRequestDto();
+
+        private Builder() {
+
+        }
+
+        @JsonCreator
+        public static Builder newInstance() {
+            return new Builder();
+        }
+
+        public Builder id(String id) {
+            dto.id = id;
+            return this;
+        }
+
+        public Builder policy(Policy policy) {
+            dto.policy = policy;
+            return this;
+        }
+
+        public PolicyDefinitionRequestDto build() {
+            return dto;
+        }
+    }
+}