refactor: clean up ids-transform and ids-spi

juliapampus · juliapampus · commit f1f9dc8a1a3c · 2022-07-28T16:05:48.000+02:00
diff --git a/data-protocols/ids/ids-api-multipart-dispatcher-v1/src/main/java/org/eclipse/dataspaceconnector/ids/api/multipart/dispatcher/sender/MultipartCatalogDescriptionRequestSender.java b/data-protocols/ids/ids-api-multipart-dispatcher-v1/src/main/java/org/eclipse/dataspaceconnector/ids/api/multipart/dispatcher/sender/MultipartCatalogDescriptionRequestSender.java
@@ -126,7 +126,6 @@ protected MultipartResponse<Catalog> getResponseContent(IdsMultipartParts parts)
         }
 
         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())));
         }
diff --git a/data-protocols/ids/ids-api-multipart-endpoint-v1/src/main/java/org/eclipse/dataspaceconnector/ids/api/multipart/handler/ContractAgreementHandler.java b/data-protocols/ids/ids-api-multipart-endpoint-v1/src/main/java/org/eclipse/dataspaceconnector/ids/api/multipart/handler/ContractAgreementHandler.java
@@ -18,9 +18,9 @@
 import de.fraunhofer.iais.eis.ContractAgreementMessage;
 import org.eclipse.dataspaceconnector.ids.api.multipart.message.MultipartRequest;
 import org.eclipse.dataspaceconnector.ids.api.multipart.message.MultipartResponse;
+import org.eclipse.dataspaceconnector.ids.spi.transform.ContractAgreementTransformerOutput;
+import org.eclipse.dataspaceconnector.ids.spi.transform.ContractTransformerInput;
 import org.eclipse.dataspaceconnector.ids.spi.transform.IdsTransformerRegistry;
-import org.eclipse.dataspaceconnector.ids.spi.types.container.ContractAgreementTransformerOutput;
-import org.eclipse.dataspaceconnector.ids.spi.types.container.ContractTransformerInput;
 import org.eclipse.dataspaceconnector.spi.contract.negotiation.ConsumerContractNegotiationManager;
 import org.eclipse.dataspaceconnector.spi.monitor.Monitor;
 import org.eclipse.dataspaceconnector.spi.types.domain.asset.Asset;
diff --git a/data-protocols/ids/ids-api-multipart-endpoint-v1/src/main/java/org/eclipse/dataspaceconnector/ids/api/multipart/handler/ContractRequestHandler.java b/data-protocols/ids/ids-api-multipart-endpoint-v1/src/main/java/org/eclipse/dataspaceconnector/ids/api/multipart/handler/ContractRequestHandler.java
@@ -20,10 +20,10 @@
 import de.fraunhofer.iais.eis.ContractRequestMessage;
 import org.eclipse.dataspaceconnector.ids.api.multipart.message.MultipartRequest;
 import org.eclipse.dataspaceconnector.ids.api.multipart.message.MultipartResponse;
+import org.eclipse.dataspaceconnector.ids.spi.transform.ContractTransformerInput;
 import org.eclipse.dataspaceconnector.ids.spi.transform.IdsTransformerRegistry;
 import org.eclipse.dataspaceconnector.ids.spi.types.IdsId;
 import org.eclipse.dataspaceconnector.ids.spi.types.MessageProtocol;
-import org.eclipse.dataspaceconnector.ids.spi.types.container.ContractTransformerInput;
 import org.eclipse.dataspaceconnector.spi.asset.AssetIndex;
 import org.eclipse.dataspaceconnector.spi.contract.negotiation.ProviderContractNegotiationManager;
 import org.eclipse.dataspaceconnector.spi.monitor.Monitor;
diff --git a/data-protocols/ids/ids-spi/src/main/java/org/eclipse/dataspaceconnector/ids/spi/transform/ContractAgreementTransformerOutput.java b/data-protocols/ids/ids-spi/src/main/java/org/eclipse/dataspaceconnector/ids/spi/transform/ContractAgreementTransformerOutput.java
@@ -12,7 +12,7 @@
  *
  */
 
-package org.eclipse.dataspaceconnector.ids.spi.types.container;
+package org.eclipse.dataspaceconnector.ids.spi.transform;
 
 import org.eclipse.dataspaceconnector.policy.model.Policy;
 import org.eclipse.dataspaceconnector.spi.types.domain.contract.agreement.ContractAgreement;
diff --git a/data-protocols/ids/ids-spi/src/main/java/org/eclipse/dataspaceconnector/ids/spi/transform/ContractTransformerInput.java b/data-protocols/ids/ids-spi/src/main/java/org/eclipse/dataspaceconnector/ids/spi/transform/ContractTransformerInput.java
@@ -12,7 +12,7 @@
  *
  */
 
-package org.eclipse.dataspaceconnector.ids.spi.types.container;
+package org.eclipse.dataspaceconnector.ids.spi.transform;
 
 import de.fraunhofer.iais.eis.Contract;
 import org.eclipse.dataspaceconnector.spi.types.domain.asset.Asset;
diff --git a/data-protocols/ids/ids-transform-v1/src/main/java/org/eclipse/dataspaceconnector/ids/transform/IdsTransformServiceExtension.java b/data-protocols/ids/ids-transform-v1/src/main/java/org/eclipse/dataspaceconnector/ids/transform/IdsTransformServiceExtension.java
@@ -28,8 +28,7 @@
 import org.eclipse.dataspaceconnector.ids.transform.type.connector.SecurityProfileToIdsSecurityProfileTransformer;
 import org.eclipse.dataspaceconnector.ids.transform.type.contract.ContractAgreementFromIdsContractAgreementTransformer;
 import org.eclipse.dataspaceconnector.ids.transform.type.contract.ContractAgreementToIdsContractAgreementTransformer;
-import org.eclipse.dataspaceconnector.ids.transform.type.contract.ContractOfferFromIdsContractOfferTransformer;
-import org.eclipse.dataspaceconnector.ids.transform.type.contract.ContractOfferFromIdsContractRequestTransformer;
+import org.eclipse.dataspaceconnector.ids.transform.type.contract.ContractOfferFromIdsContractOfferOrRequestTransformer;
 import org.eclipse.dataspaceconnector.ids.transform.type.contract.ContractOfferToIdsContractOfferTransformer;
 import org.eclipse.dataspaceconnector.ids.transform.type.policy.ActionToIdsActionTransformer;
 import org.eclipse.dataspaceconnector.ids.transform.type.policy.ConstraintFromIdsConstraintTransformer;
@@ -84,8 +83,7 @@ public void initialize(ServiceExtensionContext context) {
                 new ConstraintFromIdsConstraintTransformer(),
                 new ConstraintFromIdsLogicalConstraintTransformer(),
                 new ContractAgreementFromIdsContractAgreementTransformer(),
-                new ContractOfferFromIdsContractOfferTransformer(),
-                new ContractOfferFromIdsContractRequestTransformer(),
+                new ContractOfferFromIdsContractOfferOrRequestTransformer(),
                 new ExpressionFromIdsLeftOperandTransformer(),
                 new PermissionFromIdsPermissionTransformer(),
                 new ProhibitionFromIdsProhibitionTransformer(),
diff --git a/data-protocols/ids/ids-transform-v1/src/main/java/org/eclipse/dataspaceconnector/ids/transform/type/TransformUtils.java b/data-protocols/ids/ids-transform-v1/src/main/java/org/eclipse/dataspaceconnector/ids/transform/type/TransformUtils.java
@@ -12,12 +12,14 @@
  *
  */
 
-package org.eclipse.dataspaceconnector.ids.transform.type.util;
+package org.eclipse.dataspaceconnector.ids.transform.type;
 
 import org.eclipse.dataspaceconnector.ids.spi.types.IdsId;
 import org.eclipse.dataspaceconnector.ids.spi.types.IdsType;
 import org.eclipse.dataspaceconnector.spi.transformer.TransformerContext;
 
+import java.util.List;
+
 public final class TransformUtils {
 
     /**
@@ -26,19 +28,19 @@ public final class TransformUtils {
      *
      * @param context transformer context.
      * @param idsId value to check.
-     * @param type expected type.
+     * @param types list of expected types.
      * @param ignore set to false if missing id should cause malformed object handling
      * @return valid or not.
      */
-    public static boolean isInvalidId(TransformerContext context, IdsId idsId, IdsType type, Boolean ignore) {
+    public static boolean isInvalidId(TransformerContext context, IdsId idsId, List<IdsType> types, Boolean ignore) {
         if (idsId == null) {
-            context.reportProblem(String.format("id of incoming IDS %s expected to be not null", type.getValue()));
+            context.reportProblem(String.format("id of incoming IDS %s expected to be not null", types.toString()));
 
             // do not continue with an object that is expected to have an id
             return !ignore;
         } else {
-            if (idsId.getType() != type) {
-                context.reportProblem(String.format("handled object is not of type IDS %s", type.getValue()));
+            if (!types.contains(idsId.getType())) {
+                context.reportProblem(String.format("handled object is not of types IDS %s", types.toString()));
             }
         }
 
diff --git a/data-protocols/ids/ids-transform-v1/src/main/java/org/eclipse/dataspaceconnector/ids/transform/type/asset/AssetFromIdsArtifactTransformer.java b/data-protocols/ids/ids-transform-v1/src/main/java/org/eclipse/dataspaceconnector/ids/transform/type/asset/AssetFromIdsArtifactTransformer.java
@@ -19,12 +19,13 @@
 import org.eclipse.dataspaceconnector.ids.spi.transform.IdsTypeTransformer;
 import org.eclipse.dataspaceconnector.ids.spi.types.IdsId;
 import org.eclipse.dataspaceconnector.ids.spi.types.IdsType;
-import org.eclipse.dataspaceconnector.ids.transform.type.util.TransformUtils;
+import org.eclipse.dataspaceconnector.ids.transform.type.TransformUtils;
 import org.eclipse.dataspaceconnector.spi.transformer.TransformerContext;
 import org.eclipse.dataspaceconnector.spi.types.domain.asset.Asset;
 import org.jetbrains.annotations.NotNull;
 import org.jetbrains.annotations.Nullable;
 
+import java.util.List;
 import java.util.Objects;
 import java.util.UUID;
 
@@ -48,7 +49,7 @@ public Class<Asset> getOutputType() {
         }
 
         var idsId = IdsId.from(object.getId());
-        if (TransformUtils.isInvalidId(context, idsId, IdsType.ARTIFACT, true)) {
+        if (TransformUtils.isInvalidId(context, idsId, List.of(IdsType.ARTIFACT), true)) {
             return null;
         }
 
diff --git a/data-protocols/ids/ids-transform-v1/src/main/java/org/eclipse/dataspaceconnector/ids/transform/type/asset/AssetFromIdsRepresentationTransformer.java b/data-protocols/ids/ids-transform-v1/src/main/java/org/eclipse/dataspaceconnector/ids/transform/type/asset/AssetFromIdsRepresentationTransformer.java
@@ -20,12 +20,13 @@
 import org.eclipse.dataspaceconnector.ids.spi.transform.IdsTypeTransformer;
 import org.eclipse.dataspaceconnector.ids.spi.types.IdsId;
 import org.eclipse.dataspaceconnector.ids.spi.types.IdsType;
-import org.eclipse.dataspaceconnector.ids.transform.type.util.TransformUtils;
+import org.eclipse.dataspaceconnector.ids.transform.type.TransformUtils;
 import org.eclipse.dataspaceconnector.spi.transformer.TransformerContext;
 import org.eclipse.dataspaceconnector.spi.types.domain.asset.Asset;
 import org.jetbrains.annotations.NotNull;
 import org.jetbrains.annotations.Nullable;
 
+import java.util.List;
 import java.util.Objects;
 import java.util.UUID;
 
@@ -54,7 +55,7 @@ public Class<Asset> getOutputType() {
         }
 
         var idsId = IdsId.from(object.getId());
-        if (TransformUtils.isInvalidId(context, idsId, IdsType.REPRESENTATION, true)) {
+        if (TransformUtils.isInvalidId(context, idsId, List.of(IdsType.REPRESENTATION), true)) {
             return null;
         }
 
diff --git a/data-protocols/ids/ids-transform-v1/src/main/java/org/eclipse/dataspaceconnector/ids/transform/type/asset/AssetFromIdsResourceTransformer.java b/data-protocols/ids/ids-transform-v1/src/main/java/org/eclipse/dataspaceconnector/ids/transform/type/asset/AssetFromIdsResourceTransformer.java
@@ -22,12 +22,13 @@
 import org.eclipse.dataspaceconnector.ids.spi.transform.IdsTypeTransformer;
 import org.eclipse.dataspaceconnector.ids.spi.types.IdsId;
 import org.eclipse.dataspaceconnector.ids.spi.types.IdsType;
-import org.eclipse.dataspaceconnector.ids.transform.type.util.TransformUtils;
+import org.eclipse.dataspaceconnector.ids.transform.type.TransformUtils;
 import org.eclipse.dataspaceconnector.spi.transformer.TransformerContext;
 import org.eclipse.dataspaceconnector.spi.types.domain.asset.Asset;
 import org.jetbrains.annotations.NotNull;
 import org.jetbrains.annotations.Nullable;
 
+import java.util.List;
 import java.util.Objects;
 import java.util.UUID;
 
@@ -56,7 +57,7 @@ public Class<Asset> getOutputType() {
         }
 
         var idsId = IdsId.from(object.getId());
-        if (TransformUtils.isInvalidId(context, idsId, IdsType.RESOURCE, true)) {
+        if (TransformUtils.isInvalidId(context, idsId, List.of(IdsType.RESOURCE), true)) {
             return null;
         }
 
diff --git a/data-protocols/ids/ids-transform-v1/src/main/java/org/eclipse/dataspaceconnector/ids/transform/type/connector/CatalogFromIdsResourceCatalogTransformer.java b/data-protocols/ids/ids-transform-v1/src/main/java/org/eclipse/dataspaceconnector/ids/transform/type/connector/CatalogFromIdsResourceCatalogTransformer.java
@@ -16,10 +16,10 @@
 package org.eclipse.dataspaceconnector.ids.transform.type.connector;
 
 import de.fraunhofer.iais.eis.ResourceCatalog;
+import org.eclipse.dataspaceconnector.ids.spi.transform.ContractTransformerInput;
 import org.eclipse.dataspaceconnector.ids.spi.transform.IdsTypeTransformer;
 import org.eclipse.dataspaceconnector.ids.spi.types.IdsId;
 import org.eclipse.dataspaceconnector.ids.spi.types.IdsType;
-import org.eclipse.dataspaceconnector.ids.spi.types.container.ContractTransformerInput;
 import org.eclipse.dataspaceconnector.spi.transformer.TransformerContext;
 import org.eclipse.dataspaceconnector.spi.types.domain.asset.Asset;
 import org.eclipse.dataspaceconnector.spi.types.domain.catalog.Catalog;
diff --git a/data-protocols/ids/ids-transform-v1/src/main/java/org/eclipse/dataspaceconnector/ids/transform/type/contract/ContractAgreementFromIdsContractAgreementTransformer.java b/data-protocols/ids/ids-transform-v1/src/main/java/org/eclipse/dataspaceconnector/ids/transform/type/contract/ContractAgreementFromIdsContractAgreementTransformer.java
@@ -17,12 +17,12 @@
 package org.eclipse.dataspaceconnector.ids.transform.type.contract;
 
 import de.fraunhofer.iais.eis.Contract;
+import org.eclipse.dataspaceconnector.ids.spi.transform.ContractAgreementTransformerOutput;
+import org.eclipse.dataspaceconnector.ids.spi.transform.ContractTransformerInput;
 import org.eclipse.dataspaceconnector.ids.spi.transform.IdsTypeTransformer;
 import org.eclipse.dataspaceconnector.ids.spi.types.IdsId;
 import org.eclipse.dataspaceconnector.ids.spi.types.IdsType;
-import org.eclipse.dataspaceconnector.ids.spi.types.container.ContractAgreementTransformerOutput;
-import org.eclipse.dataspaceconnector.ids.spi.types.container.ContractTransformerInput;
-import org.eclipse.dataspaceconnector.ids.transform.type.util.TransformUtils;
+import org.eclipse.dataspaceconnector.ids.transform.type.TransformUtils;
 import org.eclipse.dataspaceconnector.policy.model.Duty;
 import org.eclipse.dataspaceconnector.policy.model.Permission;
 import org.eclipse.dataspaceconnector.policy.model.Policy;
@@ -33,6 +33,7 @@
 import org.jetbrains.annotations.Nullable;
 
 import java.util.Collection;
+import java.util.List;
 import java.util.Objects;
 import java.util.Optional;
 import java.util.stream.Collectors;
@@ -94,7 +95,7 @@ public Class<ContractAgreementTransformerOutput> getOutputType() {
 
         var idsId = IdsId.from(contractAgreement.getId());
         // contract agreement builder requires id to be not null
-        if (TransformUtils.isInvalidId(context, idsId, IdsType.CONTRACT_AGREEMENT, false)) {
+        if (TransformUtils.isInvalidId(context, idsId, List.of(IdsType.CONTRACT_AGREEMENT), false)) {
             return null;
         }
 
diff --git a/data-protocols/ids/ids-transform-v1/src/main/java/org/eclipse/dataspaceconnector/ids/transform/type/contract/ContractOfferFromIdsContractOfferOrRequestTransformer.java b/data-protocols/ids/ids-transform-v1/src/main/java/org/eclipse/dataspaceconnector/ids/transform/type/contract/ContractOfferFromIdsContractOfferOrRequestTransformer.java
@@ -15,11 +15,11 @@
 
 package org.eclipse.dataspaceconnector.ids.transform.type.contract;
 
+import org.eclipse.dataspaceconnector.ids.spi.transform.ContractTransformerInput;
 import org.eclipse.dataspaceconnector.ids.spi.transform.IdsTypeTransformer;
 import org.eclipse.dataspaceconnector.ids.spi.types.IdsId;
 import org.eclipse.dataspaceconnector.ids.spi.types.IdsType;
-import org.eclipse.dataspaceconnector.ids.spi.types.container.ContractTransformerInput;
-import org.eclipse.dataspaceconnector.ids.transform.type.util.TransformUtils;
+import org.eclipse.dataspaceconnector.ids.transform.type.TransformUtils;
 import org.eclipse.dataspaceconnector.policy.model.Duty;
 import org.eclipse.dataspaceconnector.policy.model.Permission;
 import org.eclipse.dataspaceconnector.policy.model.Policy;
@@ -30,12 +30,13 @@
 import org.jetbrains.annotations.Nullable;
 
 import java.util.ArrayList;
+import java.util.List;
 import java.util.Objects;
 
 /**
  * Transforms an IDS ContractRequest into an {@link ContractOffer}.
  */
-public class ContractOfferFromIdsContractRequestTransformer implements IdsTypeTransformer<ContractTransformerInput, ContractOffer> {
+public class ContractOfferFromIdsContractOfferOrRequestTransformer implements IdsTypeTransformer<ContractTransformerInput, ContractOffer> {
 
     @Override
     public Class<ContractTransformerInput> getInputType() {
@@ -91,10 +92,9 @@ public Class<ContractOffer> getOutputType() {
                 .provider(contract.getProvider())
                 .asset(asset);
 
-        var idsId = IdsId.from(contract.getId());
+        var idsId = IdsId.from(contract.getId().toString());
         // contract offer builder requires id to be not null
-        if (TransformUtils.isInvalidId(context, idsId, IdsType.CONTRACT_REQUEST, false) &&
-                TransformUtils.isInvalidId(context, idsId, IdsType.CONTRACT_OFFER, false)) {
+        if (TransformUtils.isInvalidId(context, idsId, List.of(IdsType.CONTRACT_REQUEST, IdsType.CONTRACT_OFFER), false)) {
             return null;
         }
 
diff --git a/data-protocols/ids/ids-transform-v1/src/main/java/org/eclipse/dataspaceconnector/ids/transform/type/contract/ContractOfferFromIdsContractOfferTransformer.java b/data-protocols/ids/ids-transform-v1/src/main/java/org/eclipse/dataspaceconnector/ids/transform/type/contract/ContractOfferFromIdsContractOfferTransformer.java
diff --git a/data-protocols/ids/ids-transform-v1/src/test/java/org/eclipse/dataspaceconnector/ids/transform/ContractAgreementFromIdsContractAgreementTransformerTest.java b/data-protocols/ids/ids-transform-v1/src/test/java/org/eclipse/dataspaceconnector/ids/transform/ContractAgreementFromIdsContractAgreementTransformerTest.java
@@ -14,7 +14,7 @@
 
 package org.eclipse.dataspaceconnector.ids.transform;
 
-import org.eclipse.dataspaceconnector.ids.spi.types.container.ContractTransformerInput;
+import org.eclipse.dataspaceconnector.ids.spi.transform.ContractTransformerInput;
 import org.eclipse.dataspaceconnector.ids.transform.type.contract.ContractAgreementFromIdsContractAgreementTransformer;
 import org.eclipse.dataspaceconnector.policy.model.Duty;
 import org.eclipse.dataspaceconnector.policy.model.Permission;
diff --git a/data-protocols/ids/ids-transform-v1/src/test/java/org/eclipse/dataspaceconnector/ids/transform/ContractOfferFromIdsContractOfferTransformerTest.java b/data-protocols/ids/ids-transform-v1/src/test/java/org/eclipse/dataspaceconnector/ids/transform/ContractOfferFromIdsContractOfferTransformerTest.java
diff --git a/data-protocols/ids/ids-transform-v1/src/test/java/org/eclipse/dataspaceconnector/ids/transform/ContractOfferFromIdsContractRequestTransformerTest.java b/data-protocols/ids/ids-transform-v1/src/test/java/org/eclipse/dataspaceconnector/ids/transform/ContractOfferFromIdsContractRequestTransformerTest.java
diff --git a/data-protocols/ids/ids-transform-v1/src/test/java/org/eclipse/dataspaceconnector/ids/transform/IdsTransformServiceExtensionTest.java b/data-protocols/ids/ids-transform-v1/src/test/java/org/eclipse/dataspaceconnector/ids/transform/IdsTransformServiceExtensionTest.java
diff --git a/samples/04.0-file-transfer/contractoffer.json b/samples/04.0-file-transfer/contractoffer.json

Original file line number	Diff line number	Diff line change
`@@ -126,7 +126,6 @@ protected MultipartResponse<Catalog> getResponseContent(IdsMultipartParts parts)`
`126`	`126`	`}`
`127`	`127`
`128`	`128`	`var transformResult = getTransformerRegistry().transform(resourceCatalog, Catalog.class);`
`129`		`-`
`130`	`129`	`if (transformResult.failed()) {`
`131`	`130`	`throw new EdcException(String.format("Could not transform ids data catalog: %s", String.join(", ", transformResult.getFailureMessages())));`
`132`	`131`	`}`
Original file line number	Diff line number	Diff line change
`@@ -12,7 +12,7 @@`
`12`	`12`	`*`
`13`	`13`	`*/`
`14`	`14`
`15`		`-package org.eclipse.dataspaceconnector.ids.spi.types.container;`
	`15`	`+package org.eclipse.dataspaceconnector.ids.spi.transform;`
`16`	`16`
`17`	`17`	`import org.eclipse.dataspaceconnector.policy.model.Policy;`
`18`	`18`	`import org.eclipse.dataspaceconnector.spi.types.domain.contract.agreement.ContractAgreement;`