Skip to content

0.2.1.2
Compare
Choose a tag to compare
@ununhexium ununhexium released this 26 Apr 13:30
· 4 commits to sovity/0.2.1 since this release
v0.2.1.2
cf0b700

[0.2.1.2] - 2024-04-24

Overview

Re-release of 0.2.1-sovity1.0 as an official version following the established branches and version conventions.

Adds a workaround to preserve the asset parameterization feature from pre-0.1 releases in a provider push scenario.

Requirements

Eclipse EDC before version 0.1 used a different communication protocol that was capable of sending the parameterization data to the provider.

This is not possible anymore due to the current IDS specification for transfer messages.

This feature is needed by one of our clients.

Implementation

The only field (as of IDS version 2024-01) that lets us send data in the concerned message is the DataAddress's properties. This is the field, in combination with specific properties, that we use in this workaround to transfer the missing information to the provider.
This extra information is extracted on the provider's side and put back where it used to be, in the properties of the DataFlowRequest.

The workaround happens at this location:

org.eclipse.edc.connector.transfer.dataplane.flow.ProviderPushTransferDataFlowController.createRequest

With this workaround, a parameterized asset can be requested with the following query:

{
  "@type": "https://w3id.org/edc/v0.0.1/ns/TransferRequest",
  "https://w3id.org/edc/v0.0.1/ns/assetId": "{{ASSET_ID}}",
  "https://w3id.org/edc/v0.0.1/ns/contractId": "{{CONTRACT_ID}}",
  "https://w3id.org/edc/v0.0.1/ns/connectorAddress": "https://{{PROVIDER_EDC_FQDN}}/api/dsp",
  "https://w3id.org/edc/v0.0.1/ns/connectorId": "{{PROVIDER_EDC_PARTICIPANT_ID}}",
  "https://w3id.org/edc/v0.0.1/ns/dataDestination": {
    "https://w3id.org/edc/v0.0.1/ns/type": "HttpData",
    "https://w3id.org/edc/v0.0.1/ns/baseUrl": "{{DATA_SINK_URL}}",
    "https://sovity.de/workaround/proxy/param/pathSegments": "{{PARAMETERIZATION_PATH}}",
    "https://sovity.de/workaround/proxy/param/method": "{{PARAMETERIZATION_METHOD}}",
    "https://sovity.de/workaround/proxy/param/queryParams": "{{PARAMETERIZATION_QUERY}}",
    "https://sovity.de/workaround/proxy/param/mediaType": "{{PARAMETERIZATION_CONTENTTYPE}}",
    "https://sovity.de/workaround/proxy/param/body": "{{PARAMETERIZATION_BODY}}"
  },
  "https://w3id.org/edc/v0.0.1/ns/privateProperties": {},
  "https://w3id.org/edc/v0.0.1/ns/protocol": "dataspace-protocol-http",
  "https://w3id.org/edc/v0.0.1/ns/managedResources": false
}

Where the https://sovity.de/workaround/proxy/param/* carry the parameterization data.

Resolution plan

There is a ticket open on the IDS side

The goal is to

  • have this feature standardized
  • have it implemented in core EDC
  • use the new core EDC version

Compatibility

This change is targeting the provider push use-case only. The consumer pull use-case is not affected.

The parameterization feature must work between 2 EDCs that use this forked version.

The parameterization must work from an unpatched Consumer EDC, targeting a patched EDC provider, using the request mentioned in the Implementation section.

The parametrization will not work if the provider EDC is not using this patched version.

Expecting no other incompatibilities with core EDC 0.2.1.

Assets 2
Loading