client: Source code for the client extension (automated contract negotiation)
config: Checkstyle files for code formatting
data-plane-aas: AAS data plane implementation (following HTTP data plane)
edc-extension4aas: Source code for the AAS extension
example: Example use case for the edc-extension4aas and client extension with a preconfigured EDC launcher.
public-api-management: Managing outward facing endpoints (http) which require no authentication
Example Usage
For a data transfer example using two connectors communicating with the DSP protocol, check
the Example's README.
Functionality
AAS data can be shared over the EDC by linking an EDC Asset to the HTTP endpoint of the AAS element. Additionally,
contracts have to be defined for each element. In order to minimize configuration effort and prevent errors, this
extension is able to link running AAS into EDC Assets. Furthermore, this extension can also start AAS by reading an AAS
model. A default contract can be chosen to be applied for all elements. For critical elements, additional contracts can
be placed. External changes to the model of an AAS are automatically synchronized by the extension.
Additionally, a client extension providing API calls for aggregations of processes such as contract negotiation and data
transfer is available. The result is a one-click negotiation and data transfer, ideal for SME or individuals.
Use Cases
Provide digital twin (AAS) data to business partners in Data Spaces like Catena-X or Manufacturing-X.
Technical Details
Interfaces
Provider Interfaces
HTTP Method
Interface (edc:1234/api/...) ((a) = only for authenticated users)
Parameters ((r) = required)
Description
GET
config (a)
-
Get current extension configuration values.
PUT
config (a)
Body: Updated config values (JSON) (r)
Update config values.
POST
client (a)
Query Parameter "url" (r)
Register a standalone AAS service (e.g., FA³ST) to this extension.
DELETE
client (a)
Query Parameter "url" (r)
Unregister an AAS service (e.g., FA³ST) from this extension, possibly shutting down the service if it has been started internally.
POST
environment (a)
Query Parameter "environment": Path to new AAS environment (r), Query Parameter "port": Port of service to be created , Query Parameter "config": Path of AAS service configuration file
Create a new AAS service. Either (http) "port" or "config" must be given to ensure communication with the AAS service via an HTTP endpoint on the service's side. This command returns the URL of the newly created AAS service on success, which can be used to remove the service using the interface "DELETE /client"
GET
selfDescription
-
Return self description of extension.
Client Interfaces
HTTP Method
Interface (edc:1234/api/automated/...) ((a) = only for authenticated users)
Perform an automated contract negotiation with a provider (given provider URL and ID) and get the data stored for the specified asset. Optionally, a data destination URL can be specified where the data is sent to instead of the extension's log.
Submits a data transfer request to the providerUrl. On success, returns the data behind the specified asset. Optionally, a data destination URL can be specified where the data is sent to instead of the extension's log.
POST
acceptedPolicies (a)
request body: List of PolicyDefinitions (JSON) (r)
Adds the given PolicyDefinitions to the accepted PolicyDefinitions list (Explanation: On fully automated negotiation, the provider's PolicyDefinition is matched against the consumer's accepted PolicyDefinitions list. If any PolicyDefinition fits the provider's, the negotiation continues.) Returns "OK"-Response if requestBody is valid.
GET
acceptedPolicies (a)
-
Returns the client extension's accepted policy definitions for fully automated negotiation.
Accept self-signed certificates from ALL AAS services (internal+external, provider+consumer)
edc.dataplane.aas.acceptOwnSelfSignedCertificates
True/False
Accept self-signed certificates from registered services (example: Creating AAS service in extension -> extension registers service at dataplane to allow its self-signed certificate)
edc.client.acceptAllProviderOffers
True/False
If true, the client accepts any contractOffer offered by a provider connector on automated contract negotiation (e.g., trusted provider). Default value: false
EDC-Extension-for-AAS Configurations
Key
Value Type
Description
edc.aas.remoteAasLocation
URL
A URL of an AAS service (such as FA³ST) that is already running and is conformant with official AAS API specification
Port to locally created AAS service. Required, if localAASModelPath is defined and localAASServiceConfigPath is not defined.
edc.aas.localAASServiceConfigPath
path
Path to AAS config for locally started AAS service. Required, if localAASServicePort is not defined, but localAASModelPath is defined.
edc.aas.syncPeriod
whole number in seconds
Time period in which AAS services should be polled for structural changes (added/deleted elements etc.). Default value is 5 (seconds). Note: This configuration value is only read on startup, the synchronization period cannot be changed at runtime.
edc.aas.exposeSelfDescription
boolean
Whether the Self Description should be exposed on {edc}/api/selfDescription. When set to False, the selfDescription is still available for authenticated requests.
edc.aas.defaultAccessPolicyPath
path
Path to an access policy file (JSON). This policy will be used as the default access policy for all assets created after the configuration value has been set.
edc.aas.defaultContractPolicyPath
path
Path to a contract policy file (JSON). This policy will be used as the default contract policy for all assets created after the configuration value has been set.
edc.aas.onlySubmodels
boolean
(Provider) Only list submodels of AAS services
Client Extension Configurations
Key
Value Type
Description
edc.client.waitForAgreementTimeout
whole number in seconds
How long should the extension wait for an agreement when automatically negotiating a contract? Default value is 10(s).
edc.client.waitForTransferTimeout
whole number in seconds
How long should the extension wait for a data transfer when automatically negotiating a contract? Default value is 10(s).
edc.client.acceptedPolicyDefinitionsPath
path
Path pointing to a JSON-file containing acceptable PolicyDefinitions for automated contract negotiation in a list (only policies must match in a provider's PolicyDefinition)