feat: Contract Termination

CHANGELOG.md

@@ -13,6 +13,8 @@ please see [changelog_updates.md](docs/dev/changelog_updates.md).
 
 #### Minor Changes
 
+- Added Contract Termination to allow users to stop sharing they data.
+
 #### Patch Changes
 
 ### Deployment Migration Notes

docs/api/sovity-edc-api-wrapper.yaml

@@ -256,7 +256,7 @@ paths:
       operationId: getContractAgreementPage
       requestBody:
         content:
-          '*/*':
+          application/json:
             schema:
               $ref: '#/components/schemas/ContractAgreementPageQuery'
       responses:
@@ -524,11 +524,11 @@ components:
     DataSourceType:
       type: string
       description: Supported Data Source Types by UiDataSource
-      default: CUSTOM
       enum:
       - HTTP_DATA
       - ON_REQUEST
       - CUSTOM
+      default: CUSTOM
     SecretValue:
       type: object
       properties:
@@ -736,14 +736,14 @@ components:
     UiDataSourceHttpDataMethod:
       type: string
       description: Supported HTTP Methods by UiDataSource
-      default: GET
       enum:
       - GET
       - POST
       - PUT
       - PATCH
       - DELETE
       - OPTIONS
+      default: GET
     UiDataSourceOnRequest:
       required:
       - contactEmail
@@ -1788,14 +1788,18 @@ components:
       - reason
       type: object
       properties:
-        reason:
-          title: Termination reason
-          type: string
-          description: A short reason why this contract was terminated
         detail:
           title: Termination detail
+          maxLength: 1000
+          minLength: 0
           type: string
           description: A user explanation to detail why the contract was terminated.
+        reason:
+          title: Termination reason
+          maxLength: 100
+          minLength: 0
+          type: string
+          description: A short reason why this contract was terminated
       description: Data for terminating a Contract Agreement
     AtomicConstraintDto:
       required:

docs/dev/checkstyle/checkstyle.md

@@ -0,0 +1,47 @@
+# Checkstyle
+
+## Note about Copyrights
+
+While it's close to impossible to write a regex to validate all the possible copyright messages, the one currently configured in [checkstyle-config.xml](checkstyle-config.xml) matches almost all the files in this project.
+
+Failing to use this template will make it progressively harder to fix the checkstyle errors as the copyright warnings will accumulate and dilute those errors, wasting precious brain time.
+
+IntelliJ has a feature to help maintain consistent copyright headers in
+
+`Settings > Editor > Copyright > Copyright profiles`.
+
+The copyright below passes the checkstyle when put in a Java multiline comment.
+
+```
+Copyright (c) 2024 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
+
+```
+
+Which once inserted at the top of a file will look like
+
+```java
+/*
+ *  Copyright (c) 2024 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 foo.bar;
+```

extensions/catalog-crawler/catalog-crawler-e2e-test/build.gradle.kts

@@ -18,7 +18,6 @@ dependencies {
 
     testImplementation(libs.assertj.core)
     testImplementation(libs.mockito.core)
-    testImplementation(libs.mockito.inline)
     testImplementation(libs.edc.junit)
     testImplementation(libs.restAssured.restAssured)
     testImplementation(libs.testcontainers.testcontainers)

extensions/catalog-crawler/catalog-crawler-e2e-test/src/test/java/de/sovity/edc/ext/catalog/crawler/CrawlerE2eTest.java

@@ -8,7 +8,8 @@
  *  SPDX-License-Identifier: Apache-2.0
  *
  *  Contributors:
- *      sovity GmbH - init
+ *       sovity GmbH - init
+ *
  */
 
 package de.sovity.edc.ext.catalog.crawler;

extensions/catalog-crawler/catalog-crawler/build.gradle.kts

@@ -24,7 +24,6 @@ dependencies {
     testImplementation(project(":utils:test-connector-remote"))
     testImplementation(libs.assertj.core)
     testImplementation(libs.mockito.core)
-    testImplementation(libs.mockito.inline)
     testImplementation(libs.restAssured.restAssured)
     testImplementation(libs.testcontainers.testcontainers)
     testImplementation(libs.flyway.core)

extensions/contract-termination/README.md

@@ -0,0 +1,41 @@
+<!-- PROJECT LOGO -->
+<br />
+<div align="center">
+  <a href="https://github.com/sovity/edc-ce">
+    <img src="https://raw.githubusercontent.com/sovity/edc-ui/main/src/assets/images/sovity_logo.svg" alt="Logo" width="300">
+  </a>
+
+<h3 align="center">EDC-Connector Extension:<br />Contract Termination</h3>
+
+  <p align="center">
+    <a href="https://github.com/sovity/edc-ce/issues/new?template=bug_report.md">Report Bug</a>
+    ·
+    <a href="https://github.com/sovity/edc-ce/issues/new?template=feature_request.md">Request Feature</a>
+  </p>
+</div>
+
+
+## About this Extension
+
+To allow contracts termination and cancellation while no official specification for this feature is available, we added our own extension, keeping the Core EDC intact.
+
+## Why does this extension exist?
+
+Contracts termination is not natively supported the in the EDC. Contracts in general can be terminated and this feature has been added here, waiting for an official implementation to be available.
+
+## Details
+
+When a User clicks "Terminate contract" on a contract agreement, a request is sent to the EDC to mark the contract agreement as terminated, followed by a notification and registration of that same termination on the counterpart's side.
+
+The termination is saved in the EDC's database.
+Any transfer started from this contract agreement will be rejected.
+
+The contract agreements' implementation doesn't interfere with the existing EDC features besides forcefully preventing transfers that are started on terminated contract agreements.
+1
+## License
+
+Apache License 2.0 - see [LICENSE](../../LICENSE)
+
+## Contact
+
+sovity GmbH - [email protected]

extensions/contract-termination/build.gradle.kts

@@ -0,0 +1,60 @@
+
+plugins {
+    `java-library`
+    `maven-publish`
+}
+
+dependencies {
+    annotationProcessor(libs.lombok)
+    compileOnly(libs.lombok)
+
+    implementation(project(":utils:jooq-database-access"))
+    implementation(project(":extensions:database-direct-access"))
+    implementation(project(":extensions:sovity-messenger"))
+
+    implementation(libs.edc.coreSpi)
+    implementation(libs.edc.transferSpi)
+    implementation(libs.edc.dspNegotiationTransform)
+
+    implementation(libs.jakarta.rsApi)
+
+    testAnnotationProcessor(libs.lombok)
+    testCompileOnly(libs.lombok)
+
+    testImplementation(project(":extensions:postgres-flyway"))
+    testImplementation(project(":utils:test-connector-remote"))
+    testImplementation(project(":utils:test-utils"))
+    testImplementation(project(":utils:versions"))
+
+    testImplementation(libs.edc.http) {
+        exclude(group = "org.eclipse.jetty", module = "jetty-client")
+        exclude(group = "org.eclipse.jetty", module = "jetty-http")
+        exclude(group = "org.eclipse.jetty", module = "jetty-io")
+        exclude(group = "org.eclipse.jetty", module = "jetty-server")
+        exclude(group = "org.eclipse.jetty", module = "jetty-util")
+        exclude(group = "org.eclipse.jetty", module = "jetty-webapp")
+    }
+
+    // Updated jetty versions for e.g. CVE-2023-26048
+    testImplementation(libs.bundles.jetty.cve2023)
+
+    testImplementation(libs.assertj.core)
+    testImplementation(libs.flyway.core)
+    testImplementation(libs.junit.api)
+    testImplementation(libs.mockito.core)
+    testImplementation(libs.restAssured.restAssured)
+    testImplementation(libs.testcontainers.testcontainers)
+    testImplementation(libs.testcontainers.postgresql)
+
+    testRuntimeOnly(libs.junit.engine)
+}
+
+group = libs.versions.sovityEdcExtensionGroup.get()
+
+publishing {
+    publications {
+        create<MavenPublication>(project.name) {
+            from(components["java"])
+        }
+    }
+}

extensions/contract-termination/src/main/java/de/sovity/edc/extension/contacttermination/ContractAgreementTerminationDetails.java

@@ -0,0 +1,49 @@
+/*
+ *  Copyright (c) 2024 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.extension.contacttermination;
+
+import de.sovity.edc.ext.db.jooq.enums.ContractTerminatedBy;
+import lombok.Builder;
+import org.eclipse.edc.connector.contract.spi.types.negotiation.ContractNegotiation;
+import org.eclipse.edc.connector.contract.spi.types.negotiation.ContractNegotiationStates;
+
+import java.time.OffsetDateTime;
+
+@Builder(toBuilder = true)
+public record ContractAgreementTerminationDetails(
+    String contractAgreementId,
+    String counterpartyId,
+    String counterpartyAddress,
+    ContractNegotiationStates state,
+    ContractNegotiation.Type type,
+    String providerAgentId,
+    String consumerAgentId,
+    String reason,
+    String detail,
+    OffsetDateTime terminatedAt,
+    ContractTerminatedBy terminatedBy
+) {
+    public boolean isTerminated() {
+        return terminatedAt != null;
+    }
+
+    boolean isConsumer() {
+        return type.equals(ContractNegotiation.Type.CONSUMER);
+    }
+
+    boolean isProvider() {
+        return type.equals(ContractNegotiation.Type.PROVIDER);
+    }
+}