-
Notifications
You must be signed in to change notification settings - Fork 14
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
feat: log terminations to logging house (#1027)
- Loading branch information
1 parent
1825041
commit 4d35cf9
Showing
20 changed files
with
598 additions
and
28 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
35 changes: 35 additions & 0 deletions
35
...on/src/main/java/de/sovity/edc/extension/contacttermination/ContractTerminationEvent.java
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,35 @@ | ||
| /* | ||
| * 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 java.time.OffsetDateTime; | ||
|
|
||
| public record ContractTerminationEvent( | ||
| String contractAgreementId, | ||
| String detail, | ||
| String reason, | ||
| OffsetDateTime timestamp, | ||
| String origin | ||
| ) { | ||
| public static ContractTerminationEvent from(ContractTerminationParam contractTerminationParam, OffsetDateTime dateTime, String origin) { | ||
| return new ContractTerminationEvent( | ||
| contractTerminationParam.contractAgreementId(), | ||
| contractTerminationParam.detail(), | ||
| contractTerminationParam.reason(), | ||
| dateTime, | ||
| origin | ||
| ); | ||
| } | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
50 changes: 50 additions & 0 deletions
50
...src/main/java/de/sovity/edc/extension/contacttermination/ContractTerminationObserver.java
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,50 @@ | ||
| /* | ||
| * 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; | ||
|
|
||
| public interface ContractTerminationObserver { | ||
|
|
||
| /** | ||
| * Indicates that a contract termination was started by this EDC. | ||
| */ | ||
| default void contractTerminationStartedFromThisInstance(ContractTerminationEvent contractTerminationEvent) { | ||
| } | ||
|
|
||
| /** | ||
| * Indicates that the first step to terminate a contract, terminating a contract on this EDC instance itself, was successful. | ||
| * The contract is now marked as terminated on this EDC's side. | ||
| */ | ||
| default void contractTerminationCompletedOnThisInstance(ContractTerminationEvent contractTerminationEvent) { | ||
| } | ||
|
|
||
| /** | ||
| * Indicates that a contract termination on the counterparty EDC was started. | ||
| */ | ||
| default void contractTerminationOnCounterpartyStarted(ContractTerminationEvent contractTerminationEvent) { | ||
| } | ||
|
|
||
| /** | ||
| * Indicates that a contract termination was started by a counterparty EDC terminated successfully | ||
| */ | ||
| default void contractTerminatedByCounterpartyStarted(ContractTerminationEvent contractTerminationEvent) { | ||
| } | ||
|
|
||
| /** | ||
| * Indicates that a contract termination initiated by a counterparty EDC terminated successfully | ||
| * The contract is now marked as terminated on this EDC. | ||
| */ | ||
| default void contractTerminatedByCounterparty(ContractTerminationEvent contractTerminationEvent) { | ||
| } | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,44 @@ | ||
| <!-- 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 />MDS Contract Termination - LoggingHouse binder</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 | ||
|
|
||
| It links the Contract Termination events with the LoggingHouse. | ||
|
|
||
| ## Why does this extension exist? | ||
|
|
||
| MDS needs to log the events generated when terminating a contract with their Logging House extension. | ||
| The Logging House is an external dependency and the linkage must only happen for the MDS variant. | ||
|
|
||
| This extension implements this specific task. | ||
|
|
||
| ## Architecture | ||
|
|
||
| ```mermaid | ||
| flowchart TD | ||
| Binder(MDS LoggingHouse Binder) --> LoggingHouse(Logging House Extension) | ||
| Binder(MDS LoggingHouse Binder) --> ContractTermination(Contract Termination Extension) | ||
| MDS(MDS CE) --> Binder | ||
| ``` | ||
|
|
||
| ## License | ||
|
|
||
| Apache License 2.0 - see [LICENSE](../../LICENSE) | ||
|
|
||
| ## Contact | ||
|
|
||
| sovity GmbH - contact@sovity.de |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,62 @@ | ||
|
|
||
| plugins { | ||
| `java-library` | ||
| `maven-publish` | ||
| } | ||
|
|
||
| dependencies { | ||
| annotationProcessor(libs.lombok) | ||
| compileOnly(libs.lombok) | ||
|
|
||
| implementation(project(":extensions:contract-termination")) | ||
|
|
||
| implementation(libs.edc.coreSpi) | ||
| implementation(libs.edc.dspNegotiationTransform) | ||
| implementation(libs.edc.transferSpi) | ||
|
|
||
| implementation(libs.loggingHouse.client) | ||
| implementation(libs.jakarta.rsApi) | ||
|
|
||
|
|
||
| testAnnotationProcessor(libs.lombok) | ||
| testCompileOnly(libs.lombok) | ||
|
|
||
| testImplementation(project(":extensions:postgres-flyway")) | ||
| testImplementation(project(":utils:test-utils")) | ||
| testImplementation(project(":utils:versions")) | ||
|
|
||
| testImplementation(libs.edc.monitorJdkLogger) | ||
| 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.hibernate.validation) | ||
| testImplementation(libs.jakarta.el) | ||
| 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"]) | ||
| } | ||
| } | ||
| } |
56 changes: 56 additions & 0 deletions
56
...ginghouse-binder/src/main/java/de/sovity/edc/extension/mdslogginhousebinder/LogEntry.java
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,56 @@ | ||
| /* | ||
| * 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.mdslogginhousebinder; | ||
|
|
||
| import com.fasterxml.jackson.annotation.JsonProperty; | ||
| import de.sovity.edc.extension.contacttermination.ContractTerminationEvent; | ||
| import lombok.AllArgsConstructor; | ||
| import lombok.Builder; | ||
| import lombok.Data; | ||
| import lombok.NoArgsConstructor; | ||
|
|
||
| import java.time.OffsetDateTime; | ||
|
|
||
| @AllArgsConstructor | ||
| @Builder | ||
| @Data | ||
| @NoArgsConstructor | ||
| public class LogEntry { | ||
|
|
||
| @JsonProperty("contractAgreementId") | ||
| private String contractAgreementId; | ||
|
|
||
| @JsonProperty("event") | ||
| private String event; | ||
|
|
||
| @JsonProperty("detail") | ||
| private String detail; | ||
|
|
||
| @JsonProperty("reason") | ||
| private String reason; | ||
|
|
||
| @JsonProperty("timestamp") | ||
| private OffsetDateTime timestamp; | ||
|
|
||
| public static LogEntry from(String event, ContractTerminationEvent contractTerminationEvent) { | ||
| return LogEntry.builder() | ||
| .event(event) | ||
| .contractAgreementId(contractTerminationEvent.contractAgreementId()) | ||
| .detail(contractTerminationEvent.detail()) | ||
| .reason(contractTerminationEvent.reason()) | ||
| .timestamp(contractTerminationEvent.timestamp()) | ||
| .build(); | ||
| } | ||
| } |
Oops, something went wrong.