Contract Management

The Contract Management Service uses events defined by the TM Forum API to reflect the state of a contract in a data space. Depending on the provided data, permission to grant specified VerifiableCredentials is set at a Trusted Issuers List API service implementation.

Installation

Container

The Contract Management Service is provided as a container at quay.io.

The container can be started with

docker run --network host quay.io/fiware/contract-management:0.0.1

Configuration

Configurations can be provided with the standard mechanisms of the Micronaut-Framework, e.g. environment variables or appliction.yaml file. The following table concentrates on the most important configuration parameters:

Property	Env-Var	Description	Default
micronaut.server.port	MICRONAUT_SERVER_PORT	Server port to be used for the listener endpoint.	8080
micronaut.metrics.enabled	MICRONAUT_METRICS_ENABLED	Enable the metrics gathering	true
micronaut.http.services.til.url	MICRONAUT_HTTP_SERVICES_TIL_URL	URL of the Trusted Issuers List Endpoint	http://trusted-issuers-list:8080
micronaut.http.services.til.path	MICRONAUT_HTTP_SERVICES_TIL_PATH	Subpath of the Trusted Issuers List Endpoint	""
micronaut.http.services.product.url	MICRONAUT_HTTP_SERVICES_PRODUCT_URL	URL of the TM Forum Product Order Endpoint	http://tmforum:8080
micronaut.http.services.product.path	MICRONAUT_HTTP_SERVICES_PRODUCT_PATH	Subpath of the TM Forum Product Order Endpoint	"productordering"
micronaut.http.services.party.url	MICRONAUT_HTTP_SERVICES_PARTY_URL	URL of the TM Forum Party Endpoint	http://tmforum:8080
micronaut.http.services.party.path	MICRONAUT_HTTP_SERVICES_PARTY_PATH	Subpath of the TM Forum Party Endpoint	"party"
general.name	GENERAL_NAME	Name of the service, used for the callback/listener subscription	contract-management
general.basepath	GENERAL_BASEPATH	Basepath used for the provided listener endpoint	""
general.til.credentialType	GENERAL_TIL_CREDENTIALTYPE	Credential type for which the permissions/claims shall be added to	"MyCredential"
general.til.claims	GENERAL_TIL_CLAIMS[]	The claims that shall be added to the Trusted Issuers List	""

License

Trusted-Issuers-List is licensed under the MIT License. See LICENSE for the full license text.

© 2023 FIWARE Foundation e.V.