Skip to content

Commit

Permalink
fix: 417: config table rendering issue (#450)
Browse files Browse the repository at this point in the history
  • Loading branch information
jobulcke authored Jan 11, 2024
1 parent 7e3388f commit 0308e55
Showing 1 changed file with 21 additions and 15 deletions.
36 changes: 21 additions & 15 deletions docs/_ldio/ldio-inputs/ldio-ldes-client-connector.md
Original file line number Diff line number Diff line change
@@ -1,24 +1,29 @@
---
layout: default
parent: LDIO Inputs
title: LDES Client with Connector
layout: default
parent: LDIO Inputs
title: LDES Client with Connector
---

# LDIO Ldes Client Connector

***be.vlaanderen.informatievlaanderen.ldes.ldio.LdioLdesClientConnector***

An EDC (Eclipse dataspace Connector) LDIO wrapper component for the [LDI LDES Client building block](../../core/ldi-inputs/ldes-client)
An EDC (Eclipse dataspace Connector) LDIO wrapper component for
the [LDI LDES Client building block](../../core/ldi-inputs/ldes-client)

This component adds EDC support to [the ldio ldes client](./ldio-ldes-client.md). If you'd like to know how to configure the LDES Client,
This component adds EDC support to [the ldio ldes client](./ldio-ldes-client.md). If you'd like to know how to configure
the LDES Client,
we refer to [the ldio ldes client](./ldio-ldes-client.md).
The additional functionality provided by this component makes it possible to use the Ldes Client to consume an LDES through an EDC connector.
The additional functionality provided by this component makes it possible to use the Ldes Client to consume an LDES
through an EDC connector.
This component exposes two endpoints:

1. http://<host>:<port>/<pipelines.name>/transfer
The Ldio component will start the data transfer with the connector. You have to send the transfer request to
the LdioLdesClientConnector instead of the EDC consumer connector. The LDIO Ldes Client Connector will start the transfer
with the connector and also keep the transfer alive while consuming the LDES (e.g. request a new token when it expires).
the LdioLdesClientConnector instead of the EDC consumer connector. The LDIO Ldes Client Connector will start the
transfer
with the connector and also keep the transfer alive while consuming the LDES (e.g. request a new token when it
expires).
3. http://<host>:<port>/<pipelines.name>/token
This endpoint should never be called directly. This is the callback to be provided in the transfer request.
The EDC connector will use this callback endpoint to provide the LDES Client with a token.
Expand All @@ -32,18 +37,19 @@ This component exposes two endpoints:
| connector-transfer-url | The transfer url of the EDC connector which has to be called to start a transfer | Yes | N/A | http://consumer-connector:29193/management/v2/transferprocesses | HTTP and HTTPS urls |
| proxy-url-to-replace | Makes it possible to proxy a part of the url of the LDES**. Indicates which part of the url should be replaced. | No | empty string | http://ldes-behind-connectors.dev | string |
| proxy-url-replacement | Makes it possible to proxy a part of the url of the LDES**. Indicates the replacement url part. | No | memory | http://consumer-connector:29193 | string |

** The url mentioned here are the actual url's used by the LDES Server (hostname). These are included in the results bodies to indicate relations, etc. This is a temporary solution until the client and server support relative urls.


## Examples

```yaml
input:
name: be.vlaanderen.informatievlaanderen.ldes.ldio.LdioLdesClientConnector
config:
url: http://consumer-connector:29291/public
connector-transfer-url: http://consumer-connector:29193/management/v2/transferprocesses
proxy-url-to-replace: http://localhost:8081/devices
proxy-url-replacement: http://consumer-connector:29291/public
source-format: application/n-quads
name: be.vlaanderen.informatievlaanderen.ldes.ldio.LdioLdesClientConnector
config:
url: http://consumer-connector:29291/public
connector-transfer-url: http://consumer-connector:29193/management/v2/transferprocesses
proxy-url-to-replace: http://localhost:8081/devices
proxy-url-replacement: http://consumer-connector:29291/public
source-format: application/n-quads
```

0 comments on commit 0308e55

Please sign in to comment.