From 0f42a523250344a4ee7a6c55ec820f8b5c0a7fa7 Mon Sep 17 00:00:00 2001 From: Mohammad Majadly Date: Wed, 6 Sep 2023 15:53:29 +0200 Subject: [PATCH 1/2] docs: IDS cleanup and replace with DSP --- basic/basic-03-configuration/README.md | 2 +- transfer/transfer-01-file-transfer/README.md | 10 +++++----- transfer/transfer-04-open-telemetry/README.md | 2 +- transfer/transfer-04-open-telemetry/contractoffer.json | 4 ++-- .../transfer-04-open-telemetry/docker-compose.yaml | 8 ++++---- transfer/transfer-06-consumer-pull-http/README.md | 4 ++-- .../consumer-configuration.properties | 2 +- .../provider-configuration.properties | 2 +- transfer/transfer-07-provider-push-http/README.md | 4 ++-- .../http-push-connector/build.gradle.kts | 3 --- .../consumer-configuration.properties | 2 +- .../provider-configuration.properties | 2 +- 12 files changed, 21 insertions(+), 24 deletions(-) diff --git a/basic/basic-03-configuration/README.md b/basic/basic-03-configuration/README.md index d838be63..1ddf965d 100644 --- a/basic/basic-03-configuration/README.md +++ b/basic/basic-03-configuration/README.md @@ -171,7 +171,7 @@ web.http.management.path=/management ``` _**Caution**: If you do not provide this configuration, it leads to the problem that the authentication mechanism is -also applied to EVERY request in the _default_ context of Jetty, which includes the IDS communication between two +also applied to EVERY request in the _default_ context of Jetty, which includes the DSP communication between two connectors._ --- diff --git a/transfer/transfer-01-file-transfer/README.md b/transfer/transfer-01-file-transfer/README.md index 7bccaa0f..e5f7ee47 100644 --- a/transfer/transfer-01-file-transfer/README.md +++ b/transfer/transfer-01-file-transfer/README.md @@ -9,7 +9,7 @@ more sophisticated storage locations, like a database or a cloud storage. This is quite a big step up from the previous sample, where we ran only one connector. Those are the concrete tasks: * Creating an additional connector, so that in the end we have two connectors, a consumer and a provider -* Providing communication between provider and consumer using IDS multipart messages +* Providing communication between provider and consumer using DSP multipart messages * Utilizing the management API to interact with the connector system * Performing a contract negotiation between provider and consumer * Performing a file transfer @@ -120,7 +120,7 @@ implementation(libs.edc.auth.tokenbased) ``` Three of these dependencies are new and have not been used in the previous samples: -1. `data-protocols:ids`: contains all IDS modules and therefore enables IDS Multipart communication with other connectors +1. `data-protocols:dsp`: contains all DSP modules and therefore enables DSP Multipart communication with other connectors 2. `extensions:iam:iam-mock`: provides a no-op identity provider, which does not require certificates and performs no checks 3. `extensions:api:auth-tokenbased`: adds authentication for management API endpoints @@ -136,7 +136,7 @@ implementation(project(":transfer:transfer-01-file-transfer:transfer-file-local" We also need to adjust the provider's `config.properties`. The property `edc.samples.transfer.01.asset.path` should point to an existing file in our local environment, as this is the file that will be transferred. We also configure a separate API context for the management API, like we learned in previous chapter. Then we add the property -`edc.dsp.callback.address`, which should point to our provider connector's IDS address. This is used as the callback +`edc.dsp.callback.address`, which should point to our provider connector's DSP address. This is used as the callback address during the contract negotiation. Since the DSP API is running on a different port (default is `8282`), we set the webhook address to `http://localhost:8282/protocol` accordingly. @@ -149,8 +149,8 @@ We configure the consumer's API ports in `consumer/config.properties`, so that i provider. In the config file, we also need to configure the API key authentication, as we're going to use endpoints from the EDC's management API in this sample and integrated the extension for token-based API authentication. Therefore, we add the property `edc.api.auth.key` and set it to e.g. `password`. And last, we also need -to configure the consumer's webhook address. We expose the IDS API endpoints on a different port and path than other -endpoints, so the property `edc.dsp.callback.address` is adjusted to match the IDS API port. +to configure the consumer's webhook address. We expose the DSP API endpoints on a different port and path than other +endpoints, so the property `edc.dsp.callback.address` is adjusted to match the DSP API port. The consumer connector also needs the `status-checker` extension for marking the transfer as completed on the consumer side. diff --git a/transfer/transfer-04-open-telemetry/README.md b/transfer/transfer-04-open-telemetry/README.md index fd8dfce6..77040306 100644 --- a/transfer/transfer-04-open-telemetry/README.md +++ b/transfer/transfer-04-open-telemetry/README.md @@ -94,7 +94,7 @@ which has to be stored in the root folder of this sample as well. The only addit WEB_HTTP_PATH: /api WEB_HTTP_MANAGEMENT_PORT: 8182 WEB_HTTP_MANAGEMENT_PATH: /management - IDS_WEBHOOK_ADDRESS: http://consumer:8181 + DSP_WEBHOOK_ADDRESS: http://consumer:8181 volumes: - ../:/samples ports: diff --git a/transfer/transfer-04-open-telemetry/contractoffer.json b/transfer/transfer-04-open-telemetry/contractoffer.json index 64ae5c1e..a06fd9f4 100644 --- a/transfer/transfer-04-open-telemetry/contractoffer.json +++ b/transfer/transfer-04-open-telemetry/contractoffer.json @@ -36,9 +36,9 @@ }, "asset": { "properties": { - "ids:byteSize": null, + "dsp:byteSize": null, "asset:prop:id": "test-document", - "ids:fileName": null + "dsp:fileName": null } } } diff --git a/transfer/transfer-04-open-telemetry/docker-compose.yaml b/transfer/transfer-04-open-telemetry/docker-compose.yaml index b0660041..ec4bae44 100644 --- a/transfer/transfer-04-open-telemetry/docker-compose.yaml +++ b/transfer/transfer-04-open-telemetry/docker-compose.yaml @@ -13,9 +13,9 @@ services: WEB_HTTP_PATH: /api WEB_HTTP_MANAGEMENT_PORT: 9192 WEB_HTTP_MANAGEMENT_PATH: /management - WEB_HTTP_IDS_PORT: 9292 - WEB_HTTP_IDS_PATH: /protocol - IDS_WEBHOOK_ADDRESS: http://consumer:9292 + WEB_HTTP_DSP_PORT: 9292 + WEB_HTTP_DSP_PATH: /protocol + DSP_WEBHOOK_ADDRESS: http://consumer:9292 EDC_API_AUTH_KEY: password volumes: - ../:/samples @@ -37,7 +37,7 @@ services: WEB_HTTP_PATH: /api WEB_HTTP_MANAGEMENT_PORT: 8182 WEB_HTTP_MANAGEMENT_PATH: /management - IDS_WEBHOOK_ADDRESS: http://provider:8282 + DSP_WEBHOOK_ADDRESS: http://provider:8282 EDC_SAMPLES_TRANSFER_01_ASSET_PATH: /samples/transfer-04-open-telemetry/input-file.txt volumes: - ../:/samples diff --git a/transfer/transfer-06-consumer-pull-http/README.md b/transfer/transfer-06-consumer-pull-http/README.md index f7ad87fc..704fec0b 100644 --- a/transfer/transfer-06-consumer-pull-http/README.md +++ b/transfer/transfer-06-consumer-pull-http/README.md @@ -102,8 +102,8 @@ java -Dedc.keystore=transfer/transfer-06-consumer-pull-http/certs/cert.pfx -Dedc ``` Assuming you didn't change the ports in config files, the consumer will listen on the -ports `29191`, `29192` (management API) and `29292` (IDS API) and the provider will listen on the -ports `12181`, `19182` (management API) and `19282` (IDS API). +ports `29191`, `29192` (management API) and `29292` (DSP API) and the provider will listen on the +ports `12181`, `19182` (management API) and `19282` (DSP API). # Run the sample diff --git a/transfer/transfer-06-consumer-pull-http/http-pull-consumer/consumer-configuration.properties b/transfer/transfer-06-consumer-pull-http/http-pull-consumer/consumer-configuration.properties index 64a00dc6..607877cd 100644 --- a/transfer/transfer-06-consumer-pull-http/http-pull-consumer/consumer-configuration.properties +++ b/transfer/transfer-06-consumer-pull-http/http-pull-consumer/consumer-configuration.properties @@ -1,5 +1,5 @@ edc.participant.id=consumer -edc.ids.id=urn:connector:consumer +edc.dsp.id=urn:connector:consumer edc.dsp.callback.address=http://localhost:29194/protocol web.http.port=29191 web.http.path=/api diff --git a/transfer/transfer-06-consumer-pull-http/http-pull-provider/provider-configuration.properties b/transfer/transfer-06-consumer-pull-http/http-pull-provider/provider-configuration.properties index 9065e6d0..5647959e 100644 --- a/transfer/transfer-06-consumer-pull-http/http-pull-provider/provider-configuration.properties +++ b/transfer/transfer-06-consumer-pull-http/http-pull-provider/provider-configuration.properties @@ -1,5 +1,5 @@ edc.participant.id=provider -edc.ids.id=urn:connector:provider +edc.dsp.id=urn:connector:provider edc.dsp.callback.address=http://localhost:19194/protocol web.http.port=19191 web.http.path=/api diff --git a/transfer/transfer-07-provider-push-http/README.md b/transfer/transfer-07-provider-push-http/README.md index 4545dd73..f70fc3b9 100644 --- a/transfer/transfer-07-provider-push-http/README.md +++ b/transfer/transfer-07-provider-push-http/README.md @@ -83,8 +83,8 @@ java -Dedc.keystore=transfer/transfer-07-provider-push-http/certs/cert.pfx -Dedc ``` Assuming you didn't change the ports in config files, the consumer will listen on the -ports `29191`, `29193` (management API) and `29194` (IDS API) and the provider will listen on the -ports `19191`, `19193` (management API) and `19194` (IDS API). +ports `29191`, `29193` (management API) and `29194` (DSP API) and the provider will listen on the +ports `19191`, `19193` (management API) and `19194` (DSP API). # Run the sample diff --git a/transfer/transfer-07-provider-push-http/http-push-connector/build.gradle.kts b/transfer/transfer-07-provider-push-http/http-push-connector/build.gradle.kts index 9f0fcf45..2961bee7 100644 --- a/transfer/transfer-07-provider-push-http/http-push-connector/build.gradle.kts +++ b/transfer/transfer-07-provider-push-http/http-push-connector/build.gradle.kts @@ -20,9 +20,6 @@ plugins { repositories { mavenCentral() - maven { - url = uri("https://maven.iais.fraunhofer.de/artifactory/eis-ids-public/") - } } dependencies { diff --git a/transfer/transfer-07-provider-push-http/http-push-consumer/consumer-configuration.properties b/transfer/transfer-07-provider-push-http/http-push-consumer/consumer-configuration.properties index cd031429..153e454b 100644 --- a/transfer/transfer-07-provider-push-http/http-push-consumer/consumer-configuration.properties +++ b/transfer/transfer-07-provider-push-http/http-push-consumer/consumer-configuration.properties @@ -1,4 +1,4 @@ -edc.ids.id=urn:connector:consumer +edc.dsp.id=urn:connector:consumer edc.participant.id=consumer edc.dsp.callback.address=http://localhost:29194/protocol web.http.port=29191 diff --git a/transfer/transfer-07-provider-push-http/http-push-provider/provider-configuration.properties b/transfer/transfer-07-provider-push-http/http-push-provider/provider-configuration.properties index c3dc20df..ed57fed6 100644 --- a/transfer/transfer-07-provider-push-http/http-push-provider/provider-configuration.properties +++ b/transfer/transfer-07-provider-push-http/http-push-provider/provider-configuration.properties @@ -1,4 +1,4 @@ -edc.ids.id=urn:connector:provider +edc.dsp.id=urn:connector:provider edc.participant.id=provider edc.dsp.callback.address=http://localhost:19194/protocol web.http.port=19191 From 6dbc6746c176acbcd4550fd331fe4592ee440081 Mon Sep 17 00:00:00 2001 From: Mohammad Majadly Date: Fri, 15 Sep 2023 16:07:33 +0200 Subject: [PATCH 2/2] docs: IDS cleanup and replace with DSP --- transfer/transfer-01-file-transfer/README.md | 4 ++-- transfer/transfer-04-open-telemetry/contractoffer.json | 4 +--- .../http-pull-consumer/consumer-configuration.properties | 1 - .../http-pull-provider/provider-configuration.properties | 1 - .../http-push-consumer/consumer-configuration.properties | 1 - .../http-push-provider/provider-configuration.properties | 1 - 6 files changed, 3 insertions(+), 9 deletions(-) diff --git a/transfer/transfer-01-file-transfer/README.md b/transfer/transfer-01-file-transfer/README.md index e5f7ee47..c74b4d6d 100644 --- a/transfer/transfer-01-file-transfer/README.md +++ b/transfer/transfer-01-file-transfer/README.md @@ -9,7 +9,7 @@ more sophisticated storage locations, like a database or a cloud storage. This is quite a big step up from the previous sample, where we ran only one connector. Those are the concrete tasks: * Creating an additional connector, so that in the end we have two connectors, a consumer and a provider -* Providing communication between provider and consumer using DSP multipart messages +* Providing communication between provider and consumer using DSP messages * Utilizing the management API to interact with the connector system * Performing a contract negotiation between provider and consumer * Performing a file transfer @@ -120,7 +120,7 @@ implementation(libs.edc.auth.tokenbased) ``` Three of these dependencies are new and have not been used in the previous samples: -1. `data-protocols:dsp`: contains all DSP modules and therefore enables DSP Multipart communication with other connectors +1. `data-protocols:dsp`: contains all DSP modules and therefore enables DSP communication with other connectors 2. `extensions:iam:iam-mock`: provides a no-op identity provider, which does not require certificates and performs no checks 3. `extensions:api:auth-tokenbased`: adds authentication for management API endpoints diff --git a/transfer/transfer-04-open-telemetry/contractoffer.json b/transfer/transfer-04-open-telemetry/contractoffer.json index a06fd9f4..db928391 100644 --- a/transfer/transfer-04-open-telemetry/contractoffer.json +++ b/transfer/transfer-04-open-telemetry/contractoffer.json @@ -36,9 +36,7 @@ }, "asset": { "properties": { - "dsp:byteSize": null, - "asset:prop:id": "test-document", - "dsp:fileName": null + "asset:prop:id": "test-document" } } } diff --git a/transfer/transfer-06-consumer-pull-http/http-pull-consumer/consumer-configuration.properties b/transfer/transfer-06-consumer-pull-http/http-pull-consumer/consumer-configuration.properties index 607877cd..bb7df005 100644 --- a/transfer/transfer-06-consumer-pull-http/http-pull-consumer/consumer-configuration.properties +++ b/transfer/transfer-06-consumer-pull-http/http-pull-consumer/consumer-configuration.properties @@ -1,5 +1,4 @@ edc.participant.id=consumer -edc.dsp.id=urn:connector:consumer edc.dsp.callback.address=http://localhost:29194/protocol web.http.port=29191 web.http.path=/api diff --git a/transfer/transfer-06-consumer-pull-http/http-pull-provider/provider-configuration.properties b/transfer/transfer-06-consumer-pull-http/http-pull-provider/provider-configuration.properties index 5647959e..4679ff53 100644 --- a/transfer/transfer-06-consumer-pull-http/http-pull-provider/provider-configuration.properties +++ b/transfer/transfer-06-consumer-pull-http/http-pull-provider/provider-configuration.properties @@ -1,5 +1,4 @@ edc.participant.id=provider -edc.dsp.id=urn:connector:provider edc.dsp.callback.address=http://localhost:19194/protocol web.http.port=19191 web.http.path=/api diff --git a/transfer/transfer-07-provider-push-http/http-push-consumer/consumer-configuration.properties b/transfer/transfer-07-provider-push-http/http-push-consumer/consumer-configuration.properties index 153e454b..881de29b 100644 --- a/transfer/transfer-07-provider-push-http/http-push-consumer/consumer-configuration.properties +++ b/transfer/transfer-07-provider-push-http/http-push-consumer/consumer-configuration.properties @@ -1,4 +1,3 @@ -edc.dsp.id=urn:connector:consumer edc.participant.id=consumer edc.dsp.callback.address=http://localhost:29194/protocol web.http.port=29191 diff --git a/transfer/transfer-07-provider-push-http/http-push-provider/provider-configuration.properties b/transfer/transfer-07-provider-push-http/http-push-provider/provider-configuration.properties index ed57fed6..4679ff53 100644 --- a/transfer/transfer-07-provider-push-http/http-push-provider/provider-configuration.properties +++ b/transfer/transfer-07-provider-push-http/http-push-provider/provider-configuration.properties @@ -1,4 +1,3 @@ -edc.dsp.id=urn:connector:provider edc.participant.id=provider edc.dsp.callback.address=http://localhost:19194/protocol web.http.port=19191