EDDIE Framework

Appearance

Region Connector for CDS (Carbon Data Specification) ​

The region connector for CDS allows the EP to request data from CDS compatible servers. No registration is required, but can be done anyway to create test CDS servers. See https://demo.cdsgateway.com/en/

Configuration of the Region Connector ​

The region connector needs a set of configuration values to be able to function correctly, how you provide these values depends on the way you deploy the region connector.

Configuration valuesDescription
region-connector.cds.enabledEnables the region connector
region-connector.cds.redirect-urlThe redirect url for the OAuth flow. The redirect url will be used when new CDS servers are registered. Should not be changed after oauth clients have been created!
region-connector.cds.client-nameThe name that will be used for OAuth clients when a new CDS server is registered.
region-connector.cds.par.enabledEither true or false defaults to false, if enabled experimental pushed authorization requests are used to send the authorization request to the CDS server. Currently, PAR is not supported by the sandbox environment.
region-connector.cds.retryThe interval in which messages are sent to the CDS server again, after it failed the first time. There are two types of messages: Creating the permission request at the PA's side, which only works if region-connector.cds.par.enabled=true, and terminating permission requests, which works all the time. Uses Spring Cron syntax. Default is every hour.
region-connector.cds.pollingSets the polling interval to poll future validated historical data. Uses Spring Cron expression. Default is 0 0 17 * * *.

The region connector can be configured using Spring properties or environment variables. When using environment variables, the configuration values need to be converted in the following way:

  • Replace all non-alphanumeric characters with an underscore (_)
  • Optionally convert all letters to upper case
properties
region-connector.cds.enabled=true
region-connector.cds.redirect-url=${eddie.public.url}/region-connectors/cds/callback
region-connector.cds.client-name=EDDIE
region-connector.cds.par.enabled=false
region-connector.cds.retry=0 0 * * * *
region-connector.cds.polling=0 0 17 * * *
yaml
region-connector:
  cds:
    enabled: true
    redirect-url: ${eddie.public.url}/region-connectors/cds/callback
    client-name: EDDIE
    par:
      enabled: false
    retry: 0 0 * * * *
    polling: 0 0 17 * * *
dotenv
REGION_CONNECTOR_CDS_ENABLED=true
REGION_CONNECTOR_CDS_REDIRECT_URL=${eddie.public.url}/region-connectors/cds/callback
REGION_CONNECTOR_CDS_CLIENT_NAME=EDDIE
REGION_CONNECTOR_CDS_PAR_ENABLED=false
REGION_CONNECTOR_CDS_RETRY=0 0 * * * *
REGION_CONNECTOR_CDS_POLLING=0 0 17 * * *

Register new CDS Server ​

The region connector provides a REST API to register a new CDS server. A new CDS server can only be registered by the eligible party. Therefore, the endpoint is only available via the management port. Registering the same CDS server twice will not have any effects and will not create new OAuth credentials.

http
### Register a new CDS server
POST http://localhost:${eddie.management.server.port}/region-connectors/cds/${eddie.management.server.urlprefix}/register
Content-Type: application/json

{
  "cdsServerUri": "{{cds_server_url}}"
}