From 680f61a7c7c99218fa90880f90f2e1c66b7926a4 Mon Sep 17 00:00:00 2001 From: eclipse-edc-bot Date: Thu, 5 Nov 2026 09:01:50 +0000 Subject: [PATCH] docs: update autodoc markdowns --- content/en/documentation/autodoc/connector.md | 5944 +---------------- .../en/documentation/autodoc/identity-hub.md | 339 +- 2 files changed, 237 insertions(+), 6046 deletions(-) diff --git a/content/en/documentation/autodoc/connector.md b/content/en/documentation/autodoc/connector.md index f4f4653..52bd9bc 100644 --- a/content/en/documentation/autodoc/connector.md +++ b/content/en/documentation/autodoc/connector.md @@ -3,5673 +3,9 @@ weight: 10 --- -Module `accesstokendata-store-sql` ----------------------------------- -**Artifact:** org.eclipse.edc:accesstokendata-store-sql:0.18.0 - -**Categories:** _None_ - -### Extension points -_None_ - -### Extensions -#### Class: `org.eclipse.edc.connector.dataplane.store.sql.SqlAccessTokenDataStoreExtension` -**Name:** "Sql AccessTokenData Store" - -**Overview:** Provides Sql Store for {@link AccessTokenData} objects - - - -### Configuration - -| Key | Required | Type | Default | Pattern | Min | Max | Description | -| ------------------------------------------ | -------- | -------- | --------- | ------- | --- | --- | ------------------------- | -| `edc.sql.store.accesstokendata.datasource` | `*` | `string` | `default` | | | | The datasource to be used | - -#### Provided services -- `org.eclipse.edc.connector.dataplane.spi.store.AccessTokenDataStore` - -#### Referenced (injected) services -- `org.eclipse.edc.transaction.datasource.spi.DataSourceRegistry` (required) -- `org.eclipse.edc.transaction.spi.TransactionContext` (required) -- `org.eclipse.edc.connector.dataplane.store.sql.schema.AccessTokenDataStatements` (optional) -- `java.time.Clock` (required) -- `org.eclipse.edc.spi.types.TypeManager` (required) -- `org.eclipse.edc.sql.QueryExecutor` (required) -- `org.eclipse.edc.sql.bootstrapper.SqlSchemaBootstrapper` (required) - -Module `aes-encryption` ------------------------ -**Artifact:** org.eclipse.edc:aes-encryption:0.18.0 - -**Categories:** _None_ - -### Extension points -_None_ - -### Extensions -#### Class: `org.eclipse.edc.encryption.aes.AesEncryptionExtension` -**Name:** "AES Encryption Extension" - -**Overview:** No overview provided. - - -### Configuration - -| Key | Required | Type | Default | Pattern | Min | Max | Description | -| ------------------------------ | -------- | -------- | ------- | ------- | --- | --- | --------------------------------------------------------------- | -| `edc.encryption.aes.key.alias` | | `string` | `` | | | | The AES encryption key used for encrypting and decrypting data. | - -#### Provided services -_None_ - -#### Referenced (injected) services -- `org.eclipse.edc.spi.security.Vault` (required) -- `org.eclipse.edc.spi.monitor.Monitor` (required) -- `org.eclipse.edc.encryption.EncryptionAlgorithmRegistry` (required) - -Module `api-core` ------------------ -**Artifact:** org.eclipse.edc:api-core:0.18.0 - -**Categories:** _None_ - -### Extension points -_None_ - -### Extensions -#### Class: `org.eclipse.edc.api.ApiCoreDefaultServicesExtension` -**Name:** "ApiCoreDefaultServicesExtension" - -**Overview:** No overview provided. - - -### Configuration_None_ - -#### Provided services -- `org.eclipse.edc.api.auth.spi.registry.ApiAuthenticationRegistry` -- `org.eclipse.edc.api.auth.spi.registry.ApiAuthenticationProviderRegistry` - -#### Referenced (injected) services -_None_ - -#### Class: `org.eclipse.edc.api.ApiCoreExtension` -**Name:** "API Core" - -**Overview:** No overview provided. - - -### Configuration_None_ - -#### Provided services -_None_ - -#### Referenced (injected) services -- `org.eclipse.edc.transform.spi.TypeTransformerRegistry` (required) -- `org.eclipse.edc.validator.spi.JsonObjectValidatorRegistry` (required) -- `org.eclipse.edc.spi.query.CriterionOperatorRegistry` (required) - -Module `api-observability` --------------------------- -**Artifact:** org.eclipse.edc:api-observability:0.18.0 - -**Categories:** _None_ - -### Extension points -_None_ - -### Extensions -#### Class: `org.eclipse.edc.api.observability.ObservabilityApiExtension` -**Name:** "Observability API" - -**Overview:** No overview provided. - - -### Configuration_None_ - -#### Provided services -_None_ - -#### Referenced (injected) services -- `org.eclipse.edc.web.spi.WebService` (required) -- `org.eclipse.edc.spi.system.health.HealthCheckService` (required) -- `org.eclipse.edc.spi.types.TypeManager` (required) -- `org.eclipse.edc.spi.system.apiversion.ApiVersionService` (required) - -Module `asset-api` ------------------- -**Artifact:** org.eclipse.edc:asset-api:0.18.0 - -**Categories:** _None_ - -### Extension points -_None_ - -### Extensions -#### Class: `org.eclipse.edc.connector.controlplane.api.management.asset.AssetApiExtension` -**Name:** "Management API: Asset" - -**Overview:** No overview provided. - - -### Configuration_None_ - -#### Provided services -_None_ - -#### Referenced (injected) services -- `org.eclipse.edc.web.spi.WebService` (required) -- `org.eclipse.edc.transform.spi.TypeTransformerRegistry` (required) -- `org.eclipse.edc.connector.controlplane.services.spi.asset.AssetService` (required) -- `org.eclipse.edc.validator.spi.JsonObjectValidatorRegistry` (required) -- `org.eclipse.edc.jsonld.spi.JsonLd` (required) -- `org.eclipse.edc.spi.types.TypeManager` (required) -- `org.eclipse.edc.participantcontext.single.spi.SingleParticipantContextSupplier` (required) - -Module `asset-api-v5` ---------------------- -**Artifact:** org.eclipse.edc:asset-api-v5:0.18.0 - -**Categories:** _None_ - -### Extension points -_None_ - -### Extensions -#### Class: `org.eclipse.edc.connector.controlplane.api.management.asset.AssetApiV5Extension` -**Name:** "Management API: Asset V5" - -**Overview:** No overview provided. - - -### Configuration_None_ - -#### Provided services -_None_ - -#### Referenced (injected) services -- `org.eclipse.edc.web.spi.WebService` (required) -- `org.eclipse.edc.transform.spi.TypeTransformerRegistry` (required) -- `org.eclipse.edc.connector.controlplane.services.spi.asset.AssetService` (required) -- `org.eclipse.edc.validator.spi.JsonObjectValidatorRegistry` (required) -- `org.eclipse.edc.jsonld.spi.JsonLd` (required) -- `org.eclipse.edc.spi.types.TypeManager` (required) -- `org.eclipse.edc.api.auth.spi.AuthorizationService` (required) - -Module `asset-index-sql` ------------------------- -**Artifact:** org.eclipse.edc:asset-index-sql:0.18.0 - -**Categories:** _None_ - -### Extension points - - `org.eclipse.edc.connector.controlplane.store.sql.assetindex.schema.AssetStatements` - -### Extensions -#### Class: `org.eclipse.edc.connector.controlplane.store.sql.assetindex.SqlAssetIndexServiceExtension` -**Name:** "SQL asset index" - -**Overview:** No overview provided. - - -### Configuration - -| Key | Required | Type | Default | Pattern | Min | Max | Description | -| -------------------------------- | -------- | -------- | --------- | ------- | --- | --- | ------------------------- | -| `edc.sql.store.asset.datasource` | `*` | `string` | `default` | | | | The datasource to be used | - -#### Provided services -- `org.eclipse.edc.connector.controlplane.asset.spi.index.AssetIndex` -- `org.eclipse.edc.connector.controlplane.asset.spi.index.DataAddressResolver` - -#### Referenced (injected) services -- `org.eclipse.edc.transaction.datasource.spi.DataSourceRegistry` (required) -- `org.eclipse.edc.transaction.spi.TransactionContext` (required) -- `org.eclipse.edc.connector.controlplane.store.sql.assetindex.schema.AssetStatements` (optional) -- `org.eclipse.edc.spi.types.TypeManager` (required) -- `org.eclipse.edc.sql.QueryExecutor` (required) -- `org.eclipse.edc.sql.bootstrapper.SqlSchemaBootstrapper` (required) - -Module `auth-configuration` ---------------------------- -**Artifact:** org.eclipse.edc:auth-configuration:0.18.0 - -**Categories:** _None_ - -### Extension points -_None_ - -### Extensions -#### Class: `org.eclipse.edc.api.auth.configuration.ApiAuthenticationConfigurationExtension` -**Name:** "Api Authentication Configuration Extension" - -**Overview:** No overview provided. - - -### Configuration - -| Key | Required | Type | Default | Pattern | Min | Max | Description | -| ---------------------------- | -------- | -------- | ------- | ------- | --- | --- | ----------- | -| `web.http..auth.type` | | `string` | `` | | | | | -| `web.http..auth` | `*` | `string` | `` | | | | | - -#### Provided services -_None_ - -#### Referenced (injected) services -- `org.eclipse.edc.api.auth.spi.registry.ApiAuthenticationProviderRegistry` (required) -- `org.eclipse.edc.api.auth.spi.registry.ApiAuthenticationRegistry` (required) -- `org.eclipse.edc.web.spi.WebService` (required) -- `org.eclipse.edc.spi.monitor.Monitor` (required) - -Module `auth-delegated` ------------------------ -**Artifact:** org.eclipse.edc:auth-delegated:0.18.0 - -**Categories:** _None_ - -### Extension points -_None_ - -### Extensions -#### Class: `org.eclipse.edc.api.auth.delegated.DelegatedAuthenticationExtension` -**Name:** "Delegating Authentication Service Extension" - -**Overview:** Extension that registers an AuthenticationService that delegates authentication and authorization to a third-party IdP - and register an {@link ApiAuthenticationProvider} under the type called delegated - - - -### Configuration - -| Key | Required | Type | Default | Pattern | Min | Max | Description | -| --------------------------------------------------------------- | -------- | -------- | ----------- | ------- | --- | --- | ------------------------------------------------------------------------------------------ | -| `web.http..auth.dac.key.url` | `*` | `string` | `` | | | | URL where the third-party IdP's public key(s) can be resolved for the configured | -| `web.http..auth.dac.cache.validity` | `*` | `string` | `300000` | | | | Duration (in ms) that the internal key cache is valid for the configured | -| `edc.participant.id` | `*` | `string` | `anonymous` | | | | Configures the participant id this runtime is operating on behalf of | -| `edc.api.auth.dac.validation.tolerance` | `*` | `string` | `5000` | | | | Default token validation time tolerance (in ms), e.g. for nbf or exp claims | -| `web.http..auth.web.http.management.auth.dac.audience` | | `string` | `` | | | | Expected audience in the token received by the api management | - -#### Provided services -_None_ - -#### Referenced (injected) services -- `org.eclipse.edc.api.auth.spi.registry.ApiAuthenticationProviderRegistry` (required) -- `org.eclipse.edc.token.spi.TokenValidationRulesRegistry` (required) -- `org.eclipse.edc.keys.spi.KeyParserRegistry` (required) -- `org.eclipse.edc.token.spi.TokenValidationService` (required) -- `java.time.Clock` (required) - -Module `auth-spi` ------------------ -**Name:** Auth services -**Artifact:** org.eclipse.edc:auth-spi:0.18.0 - -**Categories:** _None_ - -### Extension points - - `org.eclipse.edc.api.auth.spi.registry.ApiAuthenticationProviderRegistry` - - `org.eclipse.edc.api.auth.spi.ApiAuthenticationProvider` - - `org.eclipse.edc.api.auth.spi.AuthenticationService` - -### Extensions -Module `auth-tokenbased` ------------------------- -**Artifact:** org.eclipse.edc:auth-tokenbased:0.18.0 - -**Categories:** _None_ - -### Extension points -_None_ - -### Extensions -#### Class: `org.eclipse.edc.api.auth.token.TokenBasedAuthenticationExtension` -**Name:** "Static token API Authentication" - -**Overview:** Extension that registers an AuthenticationService that uses API Keys and register - an {@link ApiAuthenticationProvider} under the type called tokenbased - - - -### Configuration - -| Key | Required | Type | Default | Pattern | Min | Max | Description | -| ----------------------------------- | -------- | -------- | ------- | ------- | --- | --- | ------------------------------------------------ | -| `web.http..auth.key` | `*` | `string` | `` | | | | The api key to use for the | -| `web.http..auth.key.alias` | `*` | `string` | `` | | | | The vault api key alias to use for the | - -#### Provided services -_None_ - -#### Referenced (injected) services -- `org.eclipse.edc.spi.security.Vault` (required) -- `org.eclipse.edc.api.auth.spi.registry.ApiAuthenticationProviderRegistry` (required) - -Module `boot` -------------- -**Artifact:** org.eclipse.edc:boot:0.18.0 - -**Categories:** _None_ - -### Extension points -_None_ - -### Extensions -#### Class: `org.eclipse.edc.boot.BootServicesExtension` -**Name:** "Boot Services" - -**Overview:** No overview provided. - - -### Configuration - -| Key | Required | Type | Default | Pattern | Min | Max | Description | -| ------------------ | -------- | -------- | --------------- | ------- | --- | --- | ---------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `edc.runtime.id` | `*` | `string` | `` | | | | Configures the runtime id. This should be fully or partly randomized, and need not be stable across restarts. It is recommended to leave this value blank. | -| `edc.component.id` | `*` | `string` | `` | | | | Configures this component's ID. This should be a unique, stable and deterministic identifier. | - -#### Provided services -- `java.time.Clock` -- `org.eclipse.edc.spi.telemetry.Telemetry` -- `org.eclipse.edc.spi.system.health.HealthCheckService` -- `org.eclipse.edc.spi.system.ExecutorInstrumentation` -- `org.eclipse.edc.spi.security.Vault` - -#### Referenced (injected) services -- `org.eclipse.edc.participantcontext.single.spi.SingleParticipantContextSupplier` (optional) - -Module `callback-event-dispatcher` ----------------------------------- -**Artifact:** org.eclipse.edc:callback-event-dispatcher:0.18.0 - -**Categories:** _None_ - -### Extension points -_None_ - -### Extensions -#### Class: `org.eclipse.edc.connector.controlplane.callback.dispatcher.CallbackEventDispatcherDefaultExtension` -**Name:** "Callback event dispatcher default services" - -**Overview:** No overview provided. - - -### Configuration_None_ - -#### Provided services -- `org.eclipse.edc.connector.controlplane.services.spi.callback.CallbackClient` - -#### Referenced (injected) services -- `org.eclipse.edc.http.spi.EdcHttpClient` (required) -- `org.eclipse.edc.spi.types.TypeManager` (required) -- `org.eclipse.edc.spi.security.Vault` (required) - -#### Class: `org.eclipse.edc.connector.controlplane.callback.dispatcher.CallbackEventDispatcherExtension` -**Name:** "Callback event dispatcher" - -**Overview:** No overview provided. - - -### Configuration_None_ - -#### Provided services -_None_ - -#### Referenced (injected) services -- `org.eclipse.edc.spi.event.EventRouter` (required) -- `org.eclipse.edc.spi.monitor.Monitor` (required) -- `org.eclipse.edc.connector.controlplane.services.spi.callback.CallbackRegistry` (required) -- `org.eclipse.edc.connector.controlplane.services.spi.callback.CallbackClient` (required) - -Module `callback-static-endpoint` ---------------------------------- -**Artifact:** org.eclipse.edc:callback-static-endpoint:0.18.0 - -**Categories:** _None_ - -### Extension points -_None_ - -### Extensions -#### Class: `org.eclipse.edc.connector.controlplane.callback.staticendpoint.CallbackStaticEndpointExtension` -**Name:** "Static callbacks extension" - -**Overview:** Extension for configuring the static endpoints for callbacks - - - -### Configuration - -| Key | Required | Type | Default | Pattern | Min | Max | Description | -| -------------------------------------- | -------- | -------- | ------- | ------- | --- | --- | ----------------------------------------------------------------------------------------------------------------------- | -| `edc.callback..uri` | `*` | `string` | `` | | | | URI of the callback endpoint. | -| `edc.callback..events` | `*` | `string` | `` | | | | Comma separated list of events to trigger the callback. If not provided, the callback will be triggered for all events. | -| `edc.callback..transactional` | `*` | `string` | `` | | | | Whether the callback should be invoked in a transactional context. Default is false. | -| `edc.callback..auth.key` | `*` | `string` | `` | | | | Authentication key to use for the callback. If not provided, no authentication will be used. | -| `edc.callback..auth.codeid` | `*` | `string` | `` | | | | Vault Alias of the authentication token to use for the callback. If not provided, no authentication will be used. | - -#### Provided services -_None_ - -#### Referenced (injected) services -- `org.eclipse.edc.connector.controlplane.services.spi.callback.CallbackRegistry` (required) -- `org.eclipse.edc.spi.monitor.Monitor` (required) - -Module `catalog-api` --------------------- -**Artifact:** org.eclipse.edc:catalog-api:0.18.0 - -**Categories:** _None_ - -### Extension points -_None_ - -### Extensions -#### Class: `org.eclipse.edc.connector.controlplane.api.management.catalog.CatalogApiExtension` -**Name:** "Management API: Catalog" - -**Overview:** No overview provided. - - -### Configuration_None_ - -#### Provided services -_None_ - -#### Referenced (injected) services -- `org.eclipse.edc.web.spi.WebService` (required) -- `org.eclipse.edc.transform.spi.TypeTransformerRegistry` (required) -- `org.eclipse.edc.connector.controlplane.services.spi.catalog.CatalogService` (required) -- `org.eclipse.edc.validator.spi.JsonObjectValidatorRegistry` (required) -- `org.eclipse.edc.spi.query.CriterionOperatorRegistry` (required) -- `org.eclipse.edc.jsonld.spi.JsonLd` (required) -- `org.eclipse.edc.spi.types.TypeManager` (required) -- `org.eclipse.edc.participantcontext.single.spi.SingleParticipantContextSupplier` (required) - -Module `catalog-api-v5` ------------------------ -**Artifact:** org.eclipse.edc:catalog-api-v5:0.18.0 - -**Categories:** _None_ - -### Extension points -_None_ - -### Extensions -#### Class: `org.eclipse.edc.connector.controlplane.api.management.catalog.CatalogApiV5Extension` -**Name:** "Management API: Catalog" - -**Overview:** No overview provided. - - -### Configuration_None_ - -#### Provided services -_None_ - -#### Referenced (injected) services -- `org.eclipse.edc.web.spi.WebService` (required) -- `org.eclipse.edc.transform.spi.TypeTransformerRegistry` (required) -- `org.eclipse.edc.connector.controlplane.services.spi.catalog.CatalogService` (required) -- `org.eclipse.edc.validator.spi.JsonObjectValidatorRegistry` (required) -- `org.eclipse.edc.jsonld.spi.JsonLd` (required) -- `org.eclipse.edc.spi.types.TypeManager` (required) -- `org.eclipse.edc.api.auth.spi.AuthorizationService` (required) -- `org.eclipse.edc.participantcontext.spi.service.ParticipantContextService` (required) -- `org.eclipse.edc.protocol.spi.ParticipantProfileService` (required) - -Module `catalog-crawler-core` ------------------------------ -**Artifact:** org.eclipse.edc:catalog-crawler-core:0.18.0 - -**Categories:** _None_ - -### Extension points -_None_ - -### Extensions -#### Class: `org.eclipse.edc.catalog.crawler.CatalogCrawlerActionExtension` -**Name:** "Federated Catalog Cache DSP 2025/1" - -**Overview:** No overview provided. - - -### Configuration_None_ - -#### Provided services -_None_ - -#### Referenced (injected) services -- `org.eclipse.edc.connector.controlplane.services.spi.protocol.ProtocolRemoteMessageDispatcher` (required) -- `org.eclipse.edc.crawler.spi.CrawlerActionRegistry` (required) -- `org.eclipse.edc.spi.types.TypeManager` (required) -- `org.eclipse.edc.transform.spi.TypeTransformerRegistry` (required) -- `org.eclipse.edc.jsonld.spi.JsonLd` (required) -- `org.eclipse.edc.participantcontext.single.spi.SingleParticipantContextSupplier` (required) - -#### Class: `org.eclipse.edc.catalog.crawler.CatalogCrawlerCoreExtension` -**Name:** "Catalog Crawler Core" - -**Overview:** No overview provided. - - -### Configuration - -| Key | Required | Type | Default | Pattern | Min | Max | Description | -| -------------------------------------------- | -------- | -------- | ------- | ------- | --- | --- | --------------------------------------------------------------------------------------------------------------- | -| `edc.catalog.cache.execution.enabled` | `*` | `string` | `true` | | | | Determines whether catalog crawling is globally enabled or disabled | -| `edc.catalog.cache.partition.num.crawlers` | `*` | `string` | `2` | | | | The number of crawlers (execution threads) that should be used. The engine will re-use crawlers when necessary. | -| `edc.catalog.cache.execution.period.seconds` | `*` | `string` | `60` | | | | The time to elapse between two crawl runs | -| `edc.catalog.cache.execution.delay.seconds` | | `string` | `0` | | | | The initial delay for the cache crawler engine | -| `edc.catalog.cache.retry.retries.max` | `*` | `string` | `5` | | | | How many retries will be executed in case of crawler failure | -| `edc.catalog.cache.retry.delay.seconds` | `*` | `string` | `10` | | | | How many seconds the crawler will await after a failure before retry | - -#### Provided services -_None_ - -#### Referenced (injected) services -- `org.eclipse.edc.catalog.spi.FederatedCatalogCache` (required) -- `org.eclipse.edc.crawler.spi.CrawlerActionRegistry` (required) -- `org.eclipse.edc.crawler.spi.TargetNodeDirectory` (required) -- `org.eclipse.edc.crawler.spi.TargetNodeFilter` (optional) -- `org.eclipse.edc.spi.system.health.HealthCheckService` (optional) - -#### Class: `org.eclipse.edc.catalog.crawler.CatalogCrawlerDefaultServicesExtension` -**Name:** "CatalogCrawlerDefaultServicesExtension" - -**Overview:** No overview provided. - - -### Configuration_None_ - -#### Provided services -- `org.eclipse.edc.catalog.spi.FederatedCatalogCache` -- `org.eclipse.edc.crawler.spi.TargetNodeDirectory` -- `org.eclipse.edc.catalog.spi.QueryService` -- `org.eclipse.edc.crawler.spi.CrawlerActionRegistry` - -#### Referenced (injected) services -- `org.eclipse.edc.catalog.spi.FederatedCatalogCache` (required) - -Module `cel-api-v5` -------------------- -**Artifact:** org.eclipse.edc:cel-api-v5:0.18.0 - -**Categories:** _None_ - -### Extension points -_None_ - -### Extensions -#### Class: `org.eclipse.edc.connector.controlplane.api.management.cel.CelExpressionManagementApiExtension` -**Name:** "CEL management API Extension" - -**Overview:** No overview provided. - - -### Configuration_None_ - -#### Provided services -_None_ - -#### Referenced (injected) services -- `org.eclipse.edc.web.spi.WebService` (required) -- `org.eclipse.edc.transform.spi.TypeTransformerRegistry` (required) -- `org.eclipse.edc.validator.spi.JsonObjectValidatorRegistry` (required) -- `org.eclipse.edc.jsonld.spi.JsonLd` (required) -- `org.eclipse.edc.spi.types.TypeManager` (required) -- `org.eclipse.edc.policy.cel.service.CelPolicyExpressionService` (required) - -Module `cel-core` ------------------ -**Artifact:** org.eclipse.edc:cel-core:0.18.0 - -**Categories:** _None_ - -### Extension points -_None_ - -### Extensions -#### Class: `org.eclipse.edc.policy.cel.CelPolicyDefaultServicesExtension` -**Name:** "Common Expression Language Policy Core Extension" - -**Overview:** No overview provided. - - -### Configuration_None_ - -#### Provided services -- `org.eclipse.edc.policy.cel.store.CelExpressionStore` - -#### Referenced (injected) services -- `org.eclipse.edc.spi.query.CriterionOperatorRegistry` (required) - -#### Class: `org.eclipse.edc.policy.cel.CelPolicyCoreExtension` -**Name:** "Common Expression Language Policy Core Extension" - -**Overview:** No overview provided. - - -### Configuration_None_ - -#### Provided services -- `org.eclipse.edc.policy.cel.engine.CelExpressionEngine` -- `org.eclipse.edc.policy.cel.service.CelPolicyExpressionService` -- `org.eclipse.edc.policy.cel.function.context.CelParticipantAgentClaimMapperRegistry` - -#### Referenced (injected) services -- `org.eclipse.edc.policy.engine.spi.PolicyEngine` (required) -- `org.eclipse.edc.policy.cel.store.CelExpressionStore` (required) -- `org.eclipse.edc.transaction.spi.TransactionContext` (required) -- `org.eclipse.edc.policy.engine.spi.RuleBindingRegistry` (required) -- `org.eclipse.edc.spi.monitor.Monitor` (required) - -Module `cel-store-sql` ----------------------- -**Artifact:** org.eclipse.edc:cel-store-sql:0.18.0 - -**Categories:** _None_ - -### Extension points -_None_ - -### Extensions -#### Class: `org.eclipse.edc.policy.cel.store.sql.SqlCelExpressionStoreExtension` -**Name:** "Cel Expressions SQL Store Extension" - -**Overview:** No overview provided. - - -### Configuration - -| Key | Required | Type | Default | Pattern | Min | Max | Description | -| ------------------------------ | -------- | -------- | --------- | ------- | --- | --- | ------------------------- | -| `edc.sql.store.cel.datasource` | `*` | `string` | `default` | | | | The datasource to be used | - -#### Provided services -- `org.eclipse.edc.policy.cel.store.CelExpressionStore` - -#### Referenced (injected) services -- `org.eclipse.edc.transaction.datasource.spi.DataSourceRegistry` (required) -- `org.eclipse.edc.transaction.spi.TransactionContext` (required) -- `org.eclipse.edc.spi.types.TypeManager` (required) -- `org.eclipse.edc.sql.QueryExecutor` (required) -- `org.eclipse.edc.policy.cel.store.sql.CelExpressionStoreStatements` (optional) -- `org.eclipse.edc.sql.bootstrapper.SqlSchemaBootstrapper` (required) - -Module `configuration-filesystem` ---------------------------------- -**Artifact:** org.eclipse.edc:configuration-filesystem:0.18.0 - -**Categories:** _None_ - -### Extension points -_None_ - -### Extensions -#### Class: `org.eclipse.edc.configuration.filesystem.FsConfigurationExtension` -**Name:** "FS Configuration" - -**Overview:** Sources configuration values from a properties file. - - - -### Configuration - -| Key | Required | Type | Default | Pattern | Min | Max | Description | -| --------------- | -------- | -------- | ------- | ------- | --- | --- | ----------- | -| `edc.fs.config` | `*` | `string` | `` | | | | | - -#### Provided services -_None_ - -#### Referenced (injected) services -_None_ - -Module `connector-core` ------------------------ -**Artifact:** org.eclipse.edc:connector-core:0.18.0 - -**Categories:** _None_ - -### Extension points -_None_ - -### Extensions -#### Class: `org.eclipse.edc.connector.core.SecurityDefaultServicesExtension` -**Name:** "Security Default Services Extension" - -**Overview:** No overview provided. - - -### Configuration_None_ - -#### Provided services -- `org.eclipse.edc.keys.spi.PrivateKeyResolver` -- `org.eclipse.edc.keys.spi.KeyParserRegistry` - -#### Referenced (injected) services -- `org.eclipse.edc.spi.security.Vault` (required) -- `org.eclipse.edc.spi.types.TypeManager` (required) - -#### Class: `org.eclipse.edc.connector.core.CoreDefaultServicesExtension` -**Name:** "CoreDefaultServicesExtension" - -**Overview:** No overview provided. - - -### Configuration_None_ - -#### Provided services -- `org.eclipse.edc.api.auth.spi.ControlClientAuthenticationProvider` -- `org.eclipse.edc.participant.spi.ParticipantIdMapper` - -#### Referenced (injected) services -_None_ - -#### Class: `org.eclipse.edc.connector.core.LocalPublicKeyDefaultExtension` -**Name:** "Security Default Services Extension" - -**Overview:** No overview provided. - - -### Configuration - -| Key | Required | Type | Default | Pattern | Min | Max | Description | -| ---------------------------------- | -------- | -------- | ------- | ------- | --- | --- | ------------------------------------------------------------------------------------------------------------------------------------------------ | -| `edc.iam.publickeys..id` | `*` | `string` | `` | | | | ID of the public key. | -| `edc.iam.publickeys..value` | | `string` | `` | | | | Value of the public key. Multiple formats are supported, depending on the KeyParsers registered in the runtime | -| `edc.iam.publickeys..path` | | `string` | `` | | | | Path to a file that holds the public key, e.g. a PEM file. Multiple formats are supported, depending on the KeyParsers registered in the runtime | - -#### Provided services -- `org.eclipse.edc.keys.spi.LocalPublicKeyService` - -#### Referenced (injected) services -- `org.eclipse.edc.keys.spi.KeyParserRegistry` (required) -- `org.eclipse.edc.spi.security.Vault` (required) - -#### Class: `org.eclipse.edc.connector.core.CoreServicesExtension` -**Name:** "Core Services" - -**Overview:** No overview provided. - - -### Configuration_None_ - -#### Provided services -- `org.eclipse.edc.participant.spi.ParticipantAgentService` -- `org.eclipse.edc.policy.engine.spi.RuleBindingRegistry` -- `org.eclipse.edc.policy.engine.spi.PolicyEngine` -- `org.eclipse.edc.validator.spi.DataAddressValidatorRegistry` -- `org.eclipse.edc.http.spi.ControlApiHttpClient` - -#### Referenced (injected) services -- `org.eclipse.edc.spi.types.TypeManager` (required) -- `org.eclipse.edc.http.spi.EdcHttpClient` (required) -- `org.eclipse.edc.api.auth.spi.ControlClientAuthenticationProvider` (required) - -Module `connector-runtime` --------------------------- -**Artifact:** org.eclipse.edc:connector-runtime:0.18.0 - -**Categories:** _None_ - -### Extension points -_None_ - -### Extensions -#### Class: `org.eclipse.edc.federatedcatalog.end2end.DataplaneInstanceRegistrationExtension` -**Name:** "DataplaneInstanceRegistrationExtension" - -### Configuration_None_ - -#### Provided services -- `org.eclipse.edc.connector.dataplane.selector.spi.client.DataPlaneClientFactory` - -#### Referenced (injected) services -- `org.eclipse.edc.connector.dataplane.selector.spi.store.DataPlaneInstanceStore` (required) - -Module `console-monitor` ------------------------- -**Artifact:** org.eclipse.edc:console-monitor:0.18.0 - -**Categories:** _None_ - -### Extension points -_None_ - -### Extensions -#### Class: `org.eclipse.edc.monitor.console.ConsoleMonitorExtension` -**Name:** "Console Monitor Extension" - -**Overview:** No overview provided. - - -### Configuration_None_ - -#### Provided services -_None_ - -#### Referenced (injected) services -_None_ - -Module `contract-agreement-api` -------------------------------- -**Artifact:** org.eclipse.edc:contract-agreement-api:0.18.0 - -**Categories:** _None_ - -### Extension points -_None_ - -### Extensions -#### Class: `org.eclipse.edc.connector.controlplane.api.management.contractagreement.ContractAgreementApiExtension` -**Name:** "Management API: Contract Agreement" - -**Overview:** No overview provided. - - -### Configuration_None_ - -#### Provided services -_None_ - -#### Referenced (injected) services -- `org.eclipse.edc.web.spi.WebService` (required) -- `org.eclipse.edc.transform.spi.TypeTransformerRegistry` (required) -- `org.eclipse.edc.connector.controlplane.services.spi.contractagreement.ContractAgreementService` (required) -- `org.eclipse.edc.validator.spi.JsonObjectValidatorRegistry` (required) -- `org.eclipse.edc.jsonld.spi.JsonLd` (required) -- `org.eclipse.edc.spi.types.TypeManager` (required) - -Module `contract-agreement-api-v5` ----------------------------------- -**Artifact:** org.eclipse.edc:contract-agreement-api-v5:0.18.0 - -**Categories:** _None_ - -### Extension points -_None_ - -### Extensions -#### Class: `org.eclipse.edc.connector.controlplane.api.management.contractagreement.ContractAgreementApiV5Extension` -**Name:** "Management API: Contract Agreement" - -**Overview:** No overview provided. - - -### Configuration_None_ - -#### Provided services -_None_ - -#### Referenced (injected) services -- `org.eclipse.edc.web.spi.WebService` (required) -- `org.eclipse.edc.transform.spi.TypeTransformerRegistry` (required) -- `org.eclipse.edc.connector.controlplane.services.spi.contractagreement.ContractAgreementService` (required) -- `org.eclipse.edc.validator.spi.JsonObjectValidatorRegistry` (required) -- `org.eclipse.edc.jsonld.spi.JsonLd` (required) -- `org.eclipse.edc.spi.types.TypeManager` (required) -- `org.eclipse.edc.api.auth.spi.AuthorizationService` (required) - -Module `contract-definition-api` --------------------------------- -**Artifact:** org.eclipse.edc:contract-definition-api:0.18.0 - -**Categories:** _None_ - -### Extension points -_None_ - -### Extensions -#### Class: `org.eclipse.edc.connector.controlplane.api.management.contractdefinition.ContractDefinitionApiExtension` -**Name:** "Management API: Contract Definition" - -**Overview:** No overview provided. - - -### Configuration_None_ - -#### Provided services -_None_ - -#### Referenced (injected) services -- `org.eclipse.edc.web.spi.WebService` (required) -- `org.eclipse.edc.transform.spi.TypeTransformerRegistry` (required) -- `org.eclipse.edc.connector.controlplane.services.spi.contractdefinition.ContractDefinitionService` (required) -- `org.eclipse.edc.validator.spi.JsonObjectValidatorRegistry` (required) -- `org.eclipse.edc.spi.types.TypeManager` (required) -- `org.eclipse.edc.spi.query.CriterionOperatorRegistry` (required) -- `org.eclipse.edc.jsonld.spi.JsonLd` (required) -- `org.eclipse.edc.participantcontext.single.spi.SingleParticipantContextSupplier` (required) - -Module `contract-definition-api-v5` ------------------------------------ -**Artifact:** org.eclipse.edc:contract-definition-api-v5:0.18.0 - -**Categories:** _None_ - -### Extension points -_None_ - -### Extensions -#### Class: `org.eclipse.edc.connector.controlplane.api.management.contractdefinition.ContractDefinitionApiV5Extension` -**Name:** "Management API: Contract Definition" - -**Overview:** No overview provided. - - -### Configuration_None_ - -#### Provided services -_None_ - -#### Referenced (injected) services -- `org.eclipse.edc.web.spi.WebService` (required) -- `org.eclipse.edc.transform.spi.TypeTransformerRegistry` (required) -- `org.eclipse.edc.connector.controlplane.services.spi.contractdefinition.ContractDefinitionService` (required) -- `org.eclipse.edc.validator.spi.JsonObjectValidatorRegistry` (required) -- `org.eclipse.edc.jsonld.spi.JsonLd` (required) -- `org.eclipse.edc.spi.types.TypeManager` (required) -- `org.eclipse.edc.api.auth.spi.AuthorizationService` (required) - -Module `contract-definition-store-sql` --------------------------------------- -**Artifact:** org.eclipse.edc:contract-definition-store-sql:0.18.0 - -**Categories:** _None_ - -### Extension points -_None_ - -### Extensions -#### Class: `org.eclipse.edc.connector.controlplane.store.sql.contractdefinition.SqlContractDefinitionStoreExtension` -**Name:** "SQL contract definition store" - -**Overview:** No overview provided. - - -### Configuration - -| Key | Required | Type | Default | Pattern | Min | Max | Description | -| --------------------------------------------- | -------- | -------- | --------- | ------- | --- | --- | ------------------------- | -| `edc.sql.store.contractdefinition.datasource` | `*` | `string` | `default` | | | | The datasource to be used | - -#### Provided services -- `org.eclipse.edc.connector.controlplane.contract.spi.offer.store.ContractDefinitionStore` - -#### Referenced (injected) services -- `org.eclipse.edc.transaction.datasource.spi.DataSourceRegistry` (required) -- `org.eclipse.edc.transaction.spi.TransactionContext` (required) -- `org.eclipse.edc.connector.controlplane.store.sql.contractdefinition.schema.ContractDefinitionStatements` (optional) -- `org.eclipse.edc.spi.types.TypeManager` (required) -- `org.eclipse.edc.sql.QueryExecutor` (required) -- `org.eclipse.edc.sql.bootstrapper.SqlSchemaBootstrapper` (required) - -Module `contract-negotiation-api` ---------------------------------- -**Artifact:** org.eclipse.edc:contract-negotiation-api:0.18.0 - -**Categories:** _None_ - -### Extension points -_None_ - -### Extensions -#### Class: `org.eclipse.edc.connector.controlplane.api.management.contractnegotiation.ContractNegotiationApiExtension` -**Name:** "Management API: Contract Negotiation" - -**Overview:** No overview provided. - - -### Configuration_None_ - -#### Provided services -_None_ - -#### Referenced (injected) services -- `org.eclipse.edc.web.spi.WebService` (required) -- `org.eclipse.edc.transform.spi.TypeTransformerRegistry` (required) -- `org.eclipse.edc.connector.controlplane.services.spi.contractnegotiation.ContractNegotiationService` (required) -- `org.eclipse.edc.validator.spi.JsonObjectValidatorRegistry` (required) -- `org.eclipse.edc.jsonld.spi.JsonLd` (required) -- `org.eclipse.edc.spi.types.TypeManager` (required) -- `org.eclipse.edc.participantcontext.single.spi.SingleParticipantContextSupplier` (required) - -Module `contract-negotiation-api-v5` ------------------------------------- -**Artifact:** org.eclipse.edc:contract-negotiation-api-v5:0.18.0 - -**Categories:** _None_ - -### Extension points -_None_ - -### Extensions -#### Class: `org.eclipse.edc.connector.controlplane.api.management.contractnegotiation.ContractNegotiationApiV5Extension` -**Name:** "Management API: Contract Negotiation" - -**Overview:** No overview provided. - - -### Configuration_None_ - -#### Provided services -_None_ - -#### Referenced (injected) services -- `org.eclipse.edc.web.spi.WebService` (required) -- `org.eclipse.edc.transform.spi.TypeTransformerRegistry` (required) -- `org.eclipse.edc.connector.controlplane.services.spi.contractnegotiation.ContractNegotiationService` (required) -- `org.eclipse.edc.validator.spi.JsonObjectValidatorRegistry` (required) -- `org.eclipse.edc.jsonld.spi.JsonLd` (required) -- `org.eclipse.edc.spi.types.TypeManager` (required) -- `org.eclipse.edc.api.auth.spi.AuthorizationService` (required) -- `org.eclipse.edc.participantcontext.spi.service.ParticipantContextService` (required) -- `org.eclipse.edc.protocol.spi.ParticipantProfileService` (required) - -Module `contract-negotiation-store-sql` ---------------------------------------- -**Artifact:** org.eclipse.edc:contract-negotiation-store-sql:0.18.0 - -**Categories:** _None_ - -### Extension points -_None_ - -### Extensions -#### Class: `org.eclipse.edc.connector.controlplane.store.sql.contractnegotiation.SqlContractNegotiationStoreExtension` -**Name:** "SQL contract negotiation store" - -**Overview:** No overview provided. - - -### Configuration - -| Key | Required | Type | Default | Pattern | Min | Max | Description | -| ---------------------------------------------- | -------- | -------- | --------- | ------- | --- | --- | ------------------------- | -| `edc.sql.store.contractnegotiation.datasource` | `*` | `string` | `default` | | | | The datasource to be used | - -#### Provided services -- `org.eclipse.edc.connector.controlplane.contract.spi.negotiation.store.ContractNegotiationStore` - -#### Referenced (injected) services -- `org.eclipse.edc.transaction.datasource.spi.DataSourceRegistry` (required) -- `org.eclipse.edc.transaction.spi.TransactionContext` (required) -- `java.time.Clock` (required) -- `org.eclipse.edc.connector.controlplane.store.sql.contractnegotiation.store.schema.ContractNegotiationStatements` (optional) -- `org.eclipse.edc.spi.types.TypeManager` (required) -- `org.eclipse.edc.sql.QueryExecutor` (required) -- `org.eclipse.edc.sql.bootstrapper.SqlSchemaBootstrapper` (required) -- `org.eclipse.edc.sql.lease.spi.SqlLeaseContextBuilderProvider` (required) -- `org.eclipse.edc.sql.lease.spi.LeaseStatements` (required) - -Module `contract-spi` ---------------------- -**Name:** Contract services -**Artifact:** org.eclipse.edc:contract-spi:0.18.0 - -**Categories:** _None_ - -### Extension points - - `org.eclipse.edc.connector.controlplane.contract.spi.validation.ContractValidationService` - - `org.eclipse.edc.connector.controlplane.contract.spi.negotiation.NegotiationWaitStrategy` - - `org.eclipse.edc.connector.controlplane.contract.spi.negotiation.ContractNegotiationPendingGuard` - - `org.eclipse.edc.connector.controlplane.contract.spi.negotiation.store.ContractNegotiationStore` - - `org.eclipse.edc.connector.controlplane.contract.spi.negotiation.observe.ContractNegotiationObservable` - - `org.eclipse.edc.connector.controlplane.contract.spi.negotiation.ConsumerContractNegotiationManager` - - `org.eclipse.edc.connector.controlplane.contract.spi.negotiation.ProviderContractNegotiationManager` - - `org.eclipse.edc.connector.controlplane.contract.spi.offer.store.ContractDefinitionStore` - -### Extensions -Module `control-api-configuration` ----------------------------------- -**Artifact:** org.eclipse.edc:control-api-configuration:0.18.0 - -**Categories:** _None_ - -### Extension points -_None_ - -### Extensions -#### Class: `org.eclipse.edc.connector.api.control.configuration.ControlApiConfigurationExtension` -**Name:** "Control API configuration" - -**Overview:** Tells all the Control API controllers under which context alias they need to register their resources: either - `default` or `control` - - - -### Configuration - -| Key | Required | Type | Default | Pattern | Min | Max | Description | -| ----------------------- | -------- | -------- | -------------- | ------- | --- | --- | ------------------------------------------------------------------------------------------------------------ | -| `web.http.control.port` | `*` | `string` | `9191` | | | | Port for control api context | -| `web.http.control.path` | `*` | `string` | `/api/control` | | | | Path for control api context | -| `edc.control.endpoint` | | `string` | `` | | | | Configures endpoint for reaching the Control API. If it's missing it defaults to the hostname configuration. | - -#### Provided services -- `org.eclipse.edc.web.spi.configuration.context.ControlApiUrl` - -#### Referenced (injected) services -- `org.eclipse.edc.web.spi.configuration.PortMappingRegistry` (required) -- `org.eclipse.edc.web.spi.WebService` (required) -- `org.eclipse.edc.spi.system.Hostname` (required) -- `org.eclipse.edc.jsonld.spi.JsonLd` (required) -- `org.eclipse.edc.spi.types.TypeManager` (required) -- `org.eclipse.edc.spi.system.apiversion.ApiVersionService` (required) - -Module `control-plane-aggregate-services` ------------------------------------------ -**Artifact:** org.eclipse.edc:control-plane-aggregate-services:0.18.0 - -**Categories:** _None_ - -### Extension points -_None_ - -### Extensions -#### Class: `org.eclipse.edc.connector.controlplane.services.ControlPlaneServicesExtension` -**Name:** "Control Plane Services" - -**Overview:** No overview provided. - - -### Configuration - -| Key | Required | Type | Default | Pattern | Min | Max | Description | -| ------------------------------- | -------- | -------- | ------- | ------- | --- | --- | ----------------------------------------------------------------------------------- | -| `edc.policy.validation.enabled` | `*` | `string` | `true` | | | | If true enables the policy validation when creating and updating policy definitions | - -#### Provided services -- `org.eclipse.edc.connector.controlplane.services.spi.asset.AssetService` -- `org.eclipse.edc.connector.spi.service.SecretService` -- `org.eclipse.edc.connector.controlplane.services.spi.catalog.CatalogService` -- `org.eclipse.edc.connector.controlplane.services.spi.catalog.CatalogProtocolService` -- `org.eclipse.edc.connector.controlplane.services.spi.contractagreement.ContractAgreementService` -- `org.eclipse.edc.connector.controlplane.services.spi.contractdefinition.ContractDefinitionService` -- `org.eclipse.edc.connector.controlplane.services.spi.contractnegotiation.ContractNegotiationService` -- `org.eclipse.edc.connector.controlplane.services.spi.contractnegotiation.ContractNegotiationProtocolService` -- `org.eclipse.edc.connector.controlplane.services.spi.policydefinition.PolicyDefinitionService` -- `org.eclipse.edc.connector.controlplane.services.spi.transferprocess.TransferProcessService` -- `org.eclipse.edc.connector.controlplane.services.spi.transferprocess.TransferProcessProtocolService` -- `org.eclipse.edc.connector.controlplane.services.spi.protocol.ProtocolTokenValidator` -- `org.eclipse.edc.connector.controlplane.services.spi.protocol.VersionProtocolService` - -#### Referenced (injected) services -- `java.time.Clock` (required) -- `org.eclipse.edc.spi.monitor.Monitor` (required) -- `org.eclipse.edc.spi.event.EventRouter` (required) -- `org.eclipse.edc.connector.controlplane.services.spi.protocol.ProtocolRemoteMessageDispatcher` (required) -- `org.eclipse.edc.connector.controlplane.asset.spi.index.AssetIndex` (required) -- `org.eclipse.edc.spi.security.Vault` (required) -- `org.eclipse.edc.connector.controlplane.contract.spi.offer.store.ContractDefinitionStore` (required) -- `org.eclipse.edc.connector.controlplane.contract.spi.negotiation.store.ContractNegotiationStore` (required) -- `org.eclipse.edc.connector.controlplane.policy.spi.store.PolicyDefinitionStore` (required) -- `org.eclipse.edc.connector.controlplane.transfer.spi.store.TransferProcessStore` (required) -- `org.eclipse.edc.transaction.spi.TransactionContext` (required) -- `org.eclipse.edc.connector.controlplane.contract.spi.validation.ContractValidationService` (required) -- `org.eclipse.edc.connector.controlplane.contract.spi.offer.ConsumerOfferResolver` (required) -- `org.eclipse.edc.connector.controlplane.contract.spi.negotiation.observe.ContractNegotiationObservable` (required) -- `org.eclipse.edc.connector.controlplane.transfer.spi.observe.TransferProcessObservable` (required) -- `org.eclipse.edc.spi.telemetry.Telemetry` (required) -- `org.eclipse.edc.participant.spi.ParticipantAgentService` (required) -- `org.eclipse.edc.connector.controlplane.catalog.spi.DataServiceRegistry` (required) -- `org.eclipse.edc.connector.controlplane.catalog.spi.DatasetResolver` (required) -- `org.eclipse.edc.spi.command.CommandHandlerRegistry` (required) -- `org.eclipse.edc.spi.iam.IdentityService` (required) -- `org.eclipse.edc.policy.engine.spi.PolicyEngine` (required) -- `org.eclipse.edc.connector.controlplane.services.spi.protocol.ProtocolTokenValidator` (optional) -- `org.eclipse.edc.protocol.spi.DataspaceProfileContextRegistry` (required) -- `org.eclipse.edc.participantcontext.spi.identity.ParticipantIdentityResolver` (required) -- `org.eclipse.edc.connector.controlplane.transfer.spi.flow.DataFlowController` (required) -- `org.eclipse.edc.connector.controlplane.transfer.spi.types.DataAddressStore` (required) - -Module `control-plane-api` --------------------------- -**Artifact:** org.eclipse.edc:control-plane-api:0.18.0 - -**Categories:** _None_ - -### Extension points -_None_ - -### Extensions -#### Class: `org.eclipse.edc.connector.controlplane.api.ControlPlaneApiExtension` -**Name:** "Control Plane API" - -**Overview:** {@link ControlPlaneApiExtension } exposes HTTP endpoints for internal interaction with the Control Plane - - - -### Configuration_None_ - -#### Provided services -_None_ - -#### Referenced (injected) services -- `org.eclipse.edc.web.spi.WebService` (required) -- `org.eclipse.edc.connector.controlplane.services.spi.transferprocess.TransferProcessService` (required) -- `org.eclipse.edc.spi.types.TypeManager` (required) - -Module `control-plane-api-client` ---------------------------------- -**Artifact:** org.eclipse.edc:control-plane-api-client:0.18.0 - -**Categories:** _None_ - -### Extension points -_None_ - -### Extensions -#### Class: `org.eclipse.edc.connector.controlplane.api.client.ControlPlaneApiClientExtension` -**Name:** "Control Plane HTTP API client" - -**Overview:** Extensions that contains clients for Control Plane HTTP APIs - - - -### Configuration_None_ - -#### Provided services -- `org.eclipse.edc.connector.dataplane.spi.port.TransferProcessApiClient` - -#### Referenced (injected) services -- `org.eclipse.edc.spi.types.TypeManager` (required) -- `org.eclipse.edc.http.spi.ControlApiHttpClient` (required) - -Module `control-plane-catalog` ------------------------------- -**Artifact:** org.eclipse.edc:control-plane-catalog:0.18.0 - -**Categories:** _None_ - -### Extension points -_None_ - -### Extensions -#### Class: `org.eclipse.edc.connector.controlplane.catalog.CatalogDefaultServicesExtension` -**Name:** "Catalog Default Services" - -**Overview:** No overview provided. - - -### Configuration_None_ - -#### Provided services -- `org.eclipse.edc.connector.controlplane.catalog.spi.DataServiceRegistry` -- `org.eclipse.edc.connector.controlplane.catalog.spi.DistributionResolver` - -#### Referenced (injected) services -- `org.eclipse.edc.connector.controlplane.transfer.spi.flow.DataFlowController` (required) -- `org.eclipse.edc.spi.monitor.Monitor` (required) - -#### Class: `org.eclipse.edc.connector.controlplane.catalog.CatalogCoreExtension` -**Name:** "Catalog Core" - -**Overview:** No overview provided. - - -### Configuration_None_ - -#### Provided services -- `org.eclipse.edc.connector.controlplane.catalog.spi.DatasetResolver` - -#### Referenced (injected) services -- `org.eclipse.edc.connector.controlplane.asset.spi.index.AssetIndex` (required) -- `org.eclipse.edc.connector.controlplane.policy.spi.store.PolicyDefinitionStore` (required) -- `org.eclipse.edc.connector.controlplane.catalog.spi.DistributionResolver` (required) -- `org.eclipse.edc.spi.query.CriterionOperatorRegistry` (required) -- `org.eclipse.edc.connector.controlplane.contract.spi.offer.store.ContractDefinitionStore` (required) -- `org.eclipse.edc.policy.engine.spi.PolicyEngine` (required) -- `org.eclipse.edc.spi.monitor.Monitor` (required) - -Module `control-plane-contract` -------------------------------- -**Artifact:** org.eclipse.edc:control-plane-contract:0.18.0 - -**Categories:** _None_ - -### Extension points -_None_ - -### Extensions -#### Class: `org.eclipse.edc.connector.controlplane.contract.ContractCoreExtension` -**Name:** "Contract Core" - -**Overview:** Adds a {@link CommandHandlerRegistry} to the context and registers the - handlers the core provides. - - - -### Configuration - -| Key | Required | Type | Default | Pattern | Min | Max | Description | -| ----------------------------------------------------- | -------- | -------- | ------- | ------- | --- | --- | --------------------------------------------------------------------------- | -| `edc.negotiation.state-machine.iteration-wait-millis` | `*` | `string` | `1000` | | | | The iteration wait time in milliseconds in the state machine. | -| `edc.negotiation.state-machine.batch-size` | `*` | `string` | `20` | | | | The number of entities to be processed on every iteration. | -| `edc.negotiation.send.retry.limit` | `*` | `string` | `7` | | | | How many times a specific operation must be tried before failing with error | -| `edc.negotiation.send.retry.base-delay.ms` | `*` | `string` | `1000` | | | | The base delay for the consumer negotiation retry mechanism in millisecond | - -#### Provided services -- `org.eclipse.edc.connector.controlplane.contract.spi.validation.ContractValidationService` -- `org.eclipse.edc.connector.controlplane.contract.spi.negotiation.NegotiationProcessors` - -#### Referenced (injected) services -- `org.eclipse.edc.connector.controlplane.asset.spi.index.AssetIndex` (required) -- `org.eclipse.edc.policy.engine.spi.PolicyEngine` (required) -- `org.eclipse.edc.spi.monitor.Monitor` (required) -- `java.time.Clock` (required) -- `org.eclipse.edc.spi.event.EventRouter` (required) -- `org.eclipse.edc.spi.types.TypeManager` (required) -- `org.eclipse.edc.policy.engine.spi.RuleBindingRegistry` (required) -- `org.eclipse.edc.connector.controlplane.contract.spi.negotiation.observe.ContractNegotiationObservable` (required) -- `org.eclipse.edc.protocol.spi.ProtocolWebhookResolver` (required) -- `org.eclipse.edc.connector.controlplane.contract.spi.negotiation.store.ContractNegotiationStore` (required) -- `org.eclipse.edc.participantcontext.spi.identity.ParticipantIdentityResolver` (required) -- `org.eclipse.edc.connector.controlplane.services.spi.protocol.ProtocolRemoteMessageDispatcher` (required) - -#### Class: `org.eclipse.edc.connector.controlplane.contract.ContractNegotiationDefaultServicesExtension` -**Name:** "Contract Negotiation Default Services" - -**Overview:** Adds a {@link CommandHandlerRegistry} to the context and registers the - handlers the core provides. - - - -### Configuration_None_ - -#### Provided services -- `org.eclipse.edc.connector.controlplane.contract.spi.offer.ConsumerOfferResolver` -- `org.eclipse.edc.connector.controlplane.contract.spi.negotiation.observe.ContractNegotiationObservable` -- `org.eclipse.edc.connector.controlplane.policy.spi.store.PolicyArchive` -- `org.eclipse.edc.connector.controlplane.contract.spi.negotiation.ContractNegotiationPendingGuard` - -#### Referenced (injected) services -- `org.eclipse.edc.connector.controlplane.contract.spi.offer.store.ContractDefinitionStore` (required) -- `org.eclipse.edc.connector.controlplane.policy.spi.store.PolicyDefinitionStore` (required) -- `org.eclipse.edc.connector.controlplane.contract.spi.negotiation.store.ContractNegotiationStore` (required) - -#### Class: `org.eclipse.edc.connector.controlplane.contract.ContractNegotiationCommandExtension` -**Name:** "Contract Negotiation command handlers" - -**Overview:** Adds a {@link CommandHandlerRegistry} to the context and registers the - handlers the core provides. - - - -### Configuration_None_ - -#### Provided services -_None_ - -#### Referenced (injected) services -- `org.eclipse.edc.connector.controlplane.contract.spi.negotiation.store.ContractNegotiationStore` (required) -- `org.eclipse.edc.spi.command.CommandHandlerRegistry` (required) -- `org.eclipse.edc.connector.controlplane.contract.spi.negotiation.observe.ContractNegotiationObservable` (required) -- `org.eclipse.edc.spi.telemetry.Telemetry` (required) - -Module `control-plane-contract-manager` ---------------------------------------- -**Artifact:** org.eclipse.edc:control-plane-contract-manager:0.18.0 - -**Categories:** _None_ - -### Extension points -_None_ - -### Extensions -#### Class: `org.eclipse.edc.connector.controlplane.contract.ContractManagerExtension` -**Name:** "Contract Manager" - -**Overview:** No overview provided. - - -### Configuration - -| Key | Required | Type | Default | Pattern | Min | Max | Description | -| ----------------------------------------------------- | -------- | -------- | ------- | ------- | --- | --- | --------------------------------------------------------------------------- | -| `edc.negotiation.state-machine.iteration-wait-millis` | `*` | `string` | `1000` | | | | The iteration wait time in milliseconds in the state machine. | -| `edc.negotiation.state-machine.batch-size` | `*` | `string` | `20` | | | | The number of entities to be processed on every iteration. | -| `edc.negotiation.send.retry.limit` | `*` | `string` | `7` | | | | How many times a specific operation must be tried before failing with error | -| `edc.negotiation.send.retry.base-delay.ms` | `*` | `string` | `1000` | | | | The base delay for the consumer negotiation retry mechanism in millisecond | - -#### Provided services -- `org.eclipse.edc.connector.controlplane.contract.spi.negotiation.ConsumerContractNegotiationManager` -- `org.eclipse.edc.connector.controlplane.contract.spi.negotiation.ProviderContractNegotiationManager` - -#### Referenced (injected) services -- `org.eclipse.edc.connector.controlplane.contract.spi.negotiation.store.ContractNegotiationStore` (required) -- `org.eclipse.edc.spi.monitor.Monitor` (required) -- `org.eclipse.edc.spi.telemetry.Telemetry` (required) -- `java.time.Clock` (required) -- `org.eclipse.edc.connector.controlplane.contract.spi.negotiation.ContractNegotiationPendingGuard` (required) -- `org.eclipse.edc.spi.system.ExecutorInstrumentation` (required) -- `org.eclipse.edc.connector.controlplane.contract.spi.negotiation.NegotiationProcessors` (required) - -Module `control-plane-contract-task-executor` ---------------------------------------------- -**Artifact:** org.eclipse.edc:control-plane-contract-task-executor:0.18.0 - -**Categories:** _None_ - -### Extension points -_None_ - -### Extensions -#### Class: `org.eclipse.edc.controlplane.contract.negotiation.tasks.ContractNegotiationTaskExtension` -**Name:** "Contract Negotiation Task Extension" - -**Overview:** No overview provided. - - -### Configuration_None_ - -#### Provided services -- `org.eclipse.edc.controlplane.contract.spi.negotiation.ContractNegotiationTaskExecutor` - -#### Referenced (injected) services -- `org.eclipse.edc.connector.controlplane.contract.spi.negotiation.store.ContractNegotiationStore` (required) -- `org.eclipse.edc.transaction.spi.TransactionContext` (required) -- `org.eclipse.edc.connector.controlplane.contract.spi.negotiation.ContractNegotiationPendingGuard` (required) -- `org.eclipse.edc.spi.monitor.Monitor` (required) -- `org.eclipse.edc.controlplane.tasks.TaskService` (required) -- `org.eclipse.edc.connector.controlplane.contract.spi.negotiation.NegotiationProcessors` (required) -- `java.time.Clock` (required) -- `org.eclipse.edc.connector.controlplane.contract.spi.negotiation.observe.ContractNegotiationObservable` (required) - -Module `control-plane-core` ---------------------------- -**Artifact:** org.eclipse.edc:control-plane-core:0.18.0 - -**Categories:** _None_ - -### Extension points -_None_ - -### Extensions -#### Class: `org.eclipse.edc.connector.controlplane.ControlPlaneDefaultServicesExtension` -**Name:** "Control Plane Default Services" - -**Overview:** Provides default service implementations for fallback - - - -### Configuration_None_ - -#### Provided services -- `org.eclipse.edc.connector.controlplane.asset.spi.index.AssetIndex` -- `org.eclipse.edc.connector.controlplane.asset.spi.index.DataAddressResolver` -- `org.eclipse.edc.connector.controlplane.contract.spi.offer.store.ContractDefinitionStore` -- `org.eclipse.edc.connector.controlplane.contract.spi.negotiation.store.ContractNegotiationStore` -- `org.eclipse.edc.connector.controlplane.transfer.spi.store.TransferProcessStore` -- `org.eclipse.edc.connector.controlplane.policy.spi.store.PolicyDefinitionStore` -- `org.eclipse.edc.connector.controlplane.services.spi.callback.CallbackRegistry` -- `org.eclipse.edc.protocol.spi.DataspaceProfileContextRegistry` - -#### Referenced (injected) services -- `java.time.Clock` (required) -- `org.eclipse.edc.spi.query.CriterionOperatorRegistry` (required) - -#### Class: `org.eclipse.edc.connector.controlplane.discovery.DiscoveryDefaultServicesExtension` -**Name:** "Discovery Default Services" - -**Overview:** Provides default service implementations for fallback - - - -### Configuration_None_ - -#### Provided services -- `org.eclipse.edc.protocol.spi.discovery.DiscoveryService` - -#### Referenced (injected) services -- `org.eclipse.edc.http.spi.EdcHttpClient` (required) -- `org.eclipse.edc.protocol.spi.ParticipantProfileService` (required) -- `org.eclipse.edc.spi.types.TypeManager` (required) - -#### Class: `org.eclipse.edc.connector.controlplane.discovery.DiscoveryServicesExtension` -**Name:** "Discovery Services" - -**Overview:** Provides default service implementations for fallback - - - -### Configuration_None_ - -#### Provided services -_None_ - -#### Referenced (injected) services -- `org.eclipse.edc.protocol.spi.discovery.DiscoveryService` (required) - -Module `control-plane-transfer` -------------------------------- -**Artifact:** org.eclipse.edc:control-plane-transfer:0.18.0 - -**Categories:** _None_ - -### Extension points -_None_ - -### Extensions -#### Class: `org.eclipse.edc.connector.controlplane.transfer.TransferCoreExtension` -**Name:** "Transfer Core" - -**Overview:** Provides core data transfer services to the system. - - - -### Configuration - -| Key | Required | Type | Default | Pattern | Min | Max | Description | -| -------------------------------------------------- | -------- | -------- | ------- | ------- | --- | --- | --------------------------------------------------------------------------- | -| `edc.transfer.state-machine.iteration-wait-millis` | `*` | `string` | `1000` | | | | The iteration wait time in milliseconds in the state machine. | -| `edc.transfer.state-machine.batch-size` | `*` | `string` | `20` | | | | The number of entities to be processed on every iteration. | -| `edc.transfer.send.retry.limit` | `*` | `string` | `7` | | | | How many times a specific operation must be tried before failing with error | -| `edc.transfer.send.retry.base-delay.ms` | `*` | `string` | `1000` | | | | The base delay for the consumer negotiation retry mechanism in millisecond | - -#### Provided services -- `org.eclipse.edc.connector.controlplane.transfer.spi.TransferProcessors` - -#### Referenced (injected) services -- `org.eclipse.edc.connector.controlplane.transfer.spi.observe.TransferProcessObservable` (required) -- `org.eclipse.edc.spi.event.EventRouter` (required) -- `org.eclipse.edc.transform.spi.TypeTransformerRegistry` (required) -- `org.eclipse.edc.spi.types.TypeManager` (required) -- `org.eclipse.edc.connector.controlplane.policy.spi.store.PolicyArchive` (required) -- `org.eclipse.edc.connector.controlplane.transfer.spi.flow.DataFlowController` (required) -- `org.eclipse.edc.connector.controlplane.transfer.spi.types.DataAddressStore` (required) -- `org.eclipse.edc.connector.controlplane.transfer.spi.store.TransferProcessStore` (required) -- `org.eclipse.edc.spi.monitor.Monitor` (required) -- `org.eclipse.edc.connector.controlplane.asset.spi.index.DataAddressResolver` (required) -- `org.eclipse.edc.protocol.spi.ProtocolWebhookResolver` (required) -- `org.eclipse.edc.connector.controlplane.services.spi.protocol.ProtocolRemoteMessageDispatcher` (required) -- `java.time.Clock` (required) - -#### Class: `org.eclipse.edc.connector.controlplane.transfer.TransferProcessDefaultServicesExtension` -**Name:** "Transfer Process Default Services" - -**Overview:** Provides core data transfer services to the system. - - - -### Configuration_None_ - -#### Provided services -- `org.eclipse.edc.connector.controlplane.transfer.spi.observe.TransferProcessObservable` -- `org.eclipse.edc.connector.controlplane.transfer.spi.TransferProcessPendingGuard` -- `org.eclipse.edc.connector.controlplane.transfer.spi.flow.TransferTypeParser` -- `org.eclipse.edc.connector.controlplane.transfer.spi.types.DataAddressStore` -- `org.eclipse.edc.connector.controlplane.transfer.spi.types.DataPlaneProtocolInUse` - -#### Referenced (injected) services -- `org.eclipse.edc.spi.security.Vault` (required) -- `org.eclipse.edc.transform.spi.TypeTransformerRegistry` (required) -- `org.eclipse.edc.jsonld.spi.JsonLd` (required) -- `org.eclipse.edc.spi.types.TypeManager` (required) - -#### Class: `org.eclipse.edc.connector.controlplane.transfer.TransferProcessCommandExtension` -**Name:** "TransferProcessCommandExtension" - -**Overview:** Provides core data transfer services to the system. - - - -### Configuration_None_ - -#### Provided services -_None_ - -#### Referenced (injected) services -- `org.eclipse.edc.connector.controlplane.transfer.spi.store.TransferProcessStore` (required) -- `org.eclipse.edc.connector.controlplane.transfer.spi.observe.TransferProcessObservable` (required) -- `org.eclipse.edc.connector.controlplane.transfer.spi.types.DataAddressStore` (required) -- `java.time.Clock` (required) -- `org.eclipse.edc.spi.telemetry.Telemetry` (required) -- `org.eclipse.edc.spi.command.CommandHandlerRegistry` (required) -- `org.eclipse.edc.connector.controlplane.contract.spi.negotiation.store.ContractNegotiationStore` (required) - -Module `control-plane-transfer-manager` ---------------------------------------- -**Artifact:** org.eclipse.edc:control-plane-transfer-manager:0.18.0 - -**Categories:** _None_ - -### Extension points -_None_ - -### Extensions -#### Class: `org.eclipse.edc.connector.controlplane.transfer.TransferManagerExtension` -**Name:** "Transfer Manager" - -**Overview:** Provides transfer manager service to the system. - - - -### Configuration - -| Key | Required | Type | Default | Pattern | Min | Max | Description | -| -------------------------------------------------- | -------- | -------- | ------- | ------- | --- | --- | --------------------------------------------------------------------------- | -| `edc.transfer.state-machine.iteration-wait-millis` | `*` | `string` | `1000` | | | | The iteration wait time in milliseconds in the state machine. | -| `edc.transfer.state-machine.batch-size` | `*` | `string` | `20` | | | | The number of entities to be processed on every iteration. | -| `edc.transfer.send.retry.limit` | `*` | `string` | `7` | | | | How many times a specific operation must be tried before failing with error | -| `edc.transfer.send.retry.base-delay.ms` | `*` | `string` | `1000` | | | | The base delay for the consumer negotiation retry mechanism in millisecond | - -#### Provided services -- `org.eclipse.edc.connector.controlplane.transfer.spi.TransferProcessManager` - -#### Referenced (injected) services -- `org.eclipse.edc.connector.controlplane.transfer.spi.store.TransferProcessStore` (required) -- `java.time.Clock` (required) -- `org.eclipse.edc.spi.telemetry.Telemetry` (required) -- `org.eclipse.edc.connector.controlplane.transfer.spi.TransferProcessPendingGuard` (required) -- `org.eclipse.edc.spi.system.ExecutorInstrumentation` (required) -- `org.eclipse.edc.connector.controlplane.transfer.spi.TransferProcessors` (required) - -Module `control-plane-transfer-task-executor` ---------------------------------------------- -**Artifact:** org.eclipse.edc:control-plane-transfer-task-executor:0.18.0 - -**Categories:** _None_ - -### Extension points -_None_ - -### Extensions -#### Class: `org.eclipse.edc.controlplane.transfer.process.tasks.TransferProcessTaskExtension` -**Name:** "Transfer Task Extension" - -**Overview:** No overview provided. - - -### Configuration_None_ - -#### Provided services -- `org.eclipse.edc.controlplane.transfer.spi.TransferProcessTaskExecutor` - -#### Referenced (injected) services -- `org.eclipse.edc.connector.controlplane.transfer.spi.store.TransferProcessStore` (required) -- `org.eclipse.edc.transaction.spi.TransactionContext` (required) -- `org.eclipse.edc.connector.controlplane.transfer.spi.TransferProcessPendingGuard` (required) -- `org.eclipse.edc.spi.monitor.Monitor` (required) -- `org.eclipse.edc.controlplane.tasks.TaskService` (required) -- `org.eclipse.edc.connector.controlplane.transfer.spi.TransferProcessors` (required) -- `java.time.Clock` (required) -- `org.eclipse.edc.connector.controlplane.transfer.spi.observe.TransferProcessObservable` (required) - -Module `core-spi` ------------------ -**Name:** Core services -**Artifact:** org.eclipse.edc:core-spi:0.18.0 - -**Categories:** _None_ - -### Extension points - - `org.eclipse.edc.spi.event.EventRouter` - - `org.eclipse.edc.spi.iam.AudienceResolver` - - `org.eclipse.edc.spi.iam.IdentityService` - - `org.eclipse.edc.spi.command.CommandHandlerRegistry` - -### Extensions -Module `data-plane` -------------------- -**Artifact:** org.eclipse.edc:data-plane:0.18.0 - -**Categories:** _None_ - -### Extension points -_None_ - -### Extensions -#### Class: `org.eclipse.edc.test.e2e.runtime.dataplane.PollingHttpExtension` -**Name:** "PollingHttpExtension" - -### Configuration_None_ - -#### Provided services -_None_ - -#### Referenced (injected) services -- `org.eclipse.edc.connector.dataplane.spi.pipeline.PipelineService` (required) -- `org.eclipse.edc.http.spi.EdcHttpClient` (required) - -Module `data-plane-core` ------------------------- -**Artifact:** org.eclipse.edc:data-plane-core:0.18.0 - -**Categories:** _None_ - -### Extension points -_None_ - -### Extensions -#### Class: `org.eclipse.edc.connector.dataplane.framework.DataPlaneFrameworkExtension` -**Name:** "Data Plane Framework" - -**Overview:** Provides core services for the Data Plane Framework. - - @deprecated please look into Data Plane Signaling. - - - -### Configuration - -| Key | Required | Type | Default | Pattern | Min | Max | Description | -| --------------------------------------------------- | -------- | -------- | ------- | ------- | --- | --- | -------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `edc.dataplane.state-machine.iteration-wait-millis` | `*` | `string` | `1000` | | | | The iteration wait time in milliseconds in the state machine. | -| `edc.dataplane.state-machine.batch-size` | `*` | `string` | `20` | | | | The number of entities to be processed on every iteration. | -| `edc.dataplane.send.retry.limit` | `*` | `string` | `7` | | | | How many times a specific operation must be tried before failing with error | -| `edc.dataplane.send.retry.base-delay.ms` | `*` | `string` | `1000` | | | | The base delay for the consumer negotiation retry mechanism in millisecond | -| `edc.dataplane.state-machine.flow.lease.time` | `*` | `string` | `500` | | | | The time in milliseconds after which a runtime renews its ownership on a started data flow. | -| `edc.dataplane.state-machine.flow.lease.factor` | `*` | `string` | `5` | | | | After flow lease time * factor a started data flow will be considered abandoned by the owner and so another runtime can caught it up and start it again. | -| `edc.dataplane.transfer.threads` | `*` | `string` | `20` | | | | Size of the transfer thread pool. It is advisable to set it bigger than the state machine batch size | - -#### Provided services -- `org.eclipse.edc.connector.dataplane.spi.manager.DataPlaneManager` -- `org.eclipse.edc.connector.dataplane.spi.registry.TransferServiceRegistry` -- `org.eclipse.edc.connector.dataplane.spi.pipeline.DataTransferExecutorServiceContainer` - -#### Referenced (injected) services -- `org.eclipse.edc.connector.dataplane.spi.store.DataPlaneStore` (required) -- `org.eclipse.edc.connector.dataplane.spi.port.TransferProcessApiClient` (required) -- `org.eclipse.edc.spi.system.ExecutorInstrumentation` (required) -- `org.eclipse.edc.spi.telemetry.Telemetry` (required) -- `java.time.Clock` (required) -- `org.eclipse.edc.connector.dataplane.spi.pipeline.PipelineService` (required) -- `org.eclipse.edc.connector.dataplane.spi.edr.EndpointDataReferenceServiceRegistry` (required) -- `org.eclipse.edc.connector.dataplane.spi.provision.ResourceDefinitionGeneratorManager` (required) -- `org.eclipse.edc.connector.dataplane.spi.provision.ProvisionerManager` (required) - -#### Class: `org.eclipse.edc.connector.dataplane.framework.DataPlaneDefaultServicesExtension` -**Name:** "Data Plane Framework Default Services" - -**Overview:** Provides core services for the Data Plane Framework. - - @deprecated please look into Data Plane Signaling. - - - -### Configuration_None_ - -#### Provided services -- `org.eclipse.edc.connector.dataplane.spi.store.DataPlaneStore` -- `org.eclipse.edc.connector.dataplane.spi.store.AccessTokenDataStore` -- `org.eclipse.edc.connector.dataplane.spi.pipeline.PipelineService` -- `org.eclipse.edc.connector.dataplane.spi.iam.PublicEndpointGeneratorService` -- `org.eclipse.edc.connector.dataplane.spi.iam.DataPlaneAuthorizationService` -- `org.eclipse.edc.connector.dataplane.spi.edr.EndpointDataReferenceServiceRegistry` -- `org.eclipse.edc.connector.dataplane.spi.provision.ResourceDefinitionGeneratorManager` -- `org.eclipse.edc.connector.dataplane.spi.provision.ProvisionerManager` - -#### Referenced (injected) services -- `java.time.Clock` (required) -- `org.eclipse.edc.spi.query.CriterionOperatorRegistry` (required) - -Module `data-plane-http` ------------------------- -**Artifact:** org.eclipse.edc:data-plane-http:0.18.0 - -**Categories:** _None_ - -### Extension points -_None_ - -### Extensions -#### Class: `org.eclipse.edc.connector.dataplane.http.DataPlaneHttpExtension` -**Name:** "Data Plane HTTP" - -**Overview:** Provides support for reading data from an HTTP endpoint and sending data to an HTTP endpoint. - - - -### Configuration - -| Key | Required | Type | Default | Pattern | Min | Max | Description | -| ---------------------------------------- | -------- | -------- | ------- | ------- | --- | --- | ------------------------------------------------------------------ | -| `edc.dataplane.http.sink.partition.size` | `*` | `string` | `5` | | | | Number of partitions for parallel message push in the HttpDataSink | - -#### Provided services -- `org.eclipse.edc.connector.dataplane.http.spi.HttpRequestParamsProvider` - -#### Referenced (injected) services -- `org.eclipse.edc.http.spi.EdcHttpClient` (required) -- `org.eclipse.edc.connector.dataplane.spi.pipeline.PipelineService` (required) -- `org.eclipse.edc.connector.dataplane.spi.pipeline.DataTransferExecutorServiceContainer` (required) -- `org.eclipse.edc.spi.security.Vault` (required) -- `org.eclipse.edc.spi.types.TypeManager` (required) - -Module `data-plane-http-oauth2-core` ------------------------------------- -**Artifact:** org.eclipse.edc:data-plane-http-oauth2-core:0.18.0 - -**Categories:** _None_ - -### Extension points -_None_ - -### Extensions -#### Class: `org.eclipse.edc.connector.dataplane.http.oauth2.DataPlaneHttpOauth2Extension` -**Name:** "Data Plane HTTP OAuth2" - -**Overview:** Provides support for adding OAuth2 authentication to http data transfer - - - -### Configuration_None_ - -#### Provided services -_None_ - -#### Referenced (injected) services -- `java.time.Clock` (required) -- `org.eclipse.edc.connector.dataplane.http.spi.HttpRequestParamsProvider` (required) -- `org.eclipse.edc.spi.security.Vault` (required) -- `org.eclipse.edc.jwt.spi.signer.JwsSignerProvider` (required) -- `org.eclipse.edc.iam.oauth2.spi.client.Oauth2Client` (required) - -Module `data-plane-iam` ------------------------ -**Artifact:** org.eclipse.edc:data-plane-iam:0.18.0 - -**Categories:** _None_ - -### Extension points -_None_ - -### Extensions -#### Class: `org.eclipse.edc.connector.dataplane.iam.DataPlaneIamExtension` -**Name:** "Data Plane IAM" - -**Overview:** No overview provided. - - -### Configuration - -| Key | Required | Type | Default | Pattern | Min | Max | Description | -| -------------------- | -------- | -------- | ----------- | ------- | --- | --- | -------------------------------------------------------------------- | -| `edc.participant.id` | `*` | `string` | `anonymous` | | | | Configures the participant id this runtime is operating on behalf of | - -#### Provided services -- `org.eclipse.edc.connector.dataplane.spi.iam.DataPlaneAuthorizationService` - -#### Referenced (injected) services -- `java.time.Clock` (required) -- `org.eclipse.edc.connector.dataplane.spi.iam.DataPlaneAccessTokenService` (required) -- `org.eclipse.edc.connector.dataplane.spi.iam.DataPlaneAccessControlService` (required) -- `org.eclipse.edc.connector.dataplane.spi.iam.PublicEndpointGeneratorService` (required) -- `org.eclipse.edc.connector.dataplane.spi.edr.EndpointDataReferenceServiceRegistry` (required) - -#### Class: `org.eclipse.edc.connector.dataplane.iam.DataPlaneIamDefaultServicesExtension` -**Name:** "Data Plane Default IAM Services" - -**Overview:** No overview provided. - - -### Configuration - -| Key | Required | Type | Default | Pattern | Min | Max | Description | -| --------------------------------------------------- | -------- | -------- | ------- | ------- | --- | --- | --------------------------------------------------------------------------------- | -| `edc.transfer.proxy.token.signer.privatekey.alias` | `*` | `string` | `` | | | | Alias of private key used for signing tokens, retrieved from private key resolver | -| `edc.transfer.proxy.token.verifier.publickey.alias` | `*` | `string` | `` | | | | Alias of public key used for verifying the tokens, retrieved from the vault | - -#### Provided services -- `org.eclipse.edc.connector.dataplane.spi.iam.DataPlaneAccessControlService` -- `org.eclipse.edc.connector.dataplane.spi.iam.DataPlaneAccessTokenService` - -#### Referenced (injected) services -- `org.eclipse.edc.connector.dataplane.spi.store.AccessTokenDataStore` (required) -- `org.eclipse.edc.token.spi.TokenValidationService` (required) -- `org.eclipse.edc.keys.spi.LocalPublicKeyService` (required) -- `org.eclipse.edc.jwt.spi.signer.JwsSignerProvider` (required) - -Module `data-plane-instance-store-sql` --------------------------------------- -**Artifact:** org.eclipse.edc:data-plane-instance-store-sql:0.18.0 - -**Categories:** _None_ - -### Extension points -_None_ - -### Extensions -#### Class: `org.eclipse.edc.connector.dataplane.selector.store.sql.SqlDataPlaneInstanceStoreExtension` -**Name:** "Sql Data Plane Instance Store" - -**Overview:** Extensions that expose an implementation of {@link DataPlaneInstanceStore} that uses SQL as backend storage - - - -### Configuration - -| Key | Required | Type | Default | Pattern | Min | Max | Description | -| -------------------------------------------- | -------- | -------- | --------- | ------- | --- | --- | ------------------------- | -| `edc.sql.store.dataplaneinstance.datasource` | `*` | `string` | `default` | | | | The datasource to be used | - -#### Provided services -- `org.eclipse.edc.connector.dataplane.selector.spi.store.DataPlaneInstanceStore` - -#### Referenced (injected) services -- `org.eclipse.edc.transaction.datasource.spi.DataSourceRegistry` (required) -- `org.eclipse.edc.transaction.spi.TransactionContext` (required) -- `org.eclipse.edc.connector.dataplane.selector.store.sql.schema.DataPlaneInstanceStatements` (optional) -- `org.eclipse.edc.spi.types.TypeManager` (required) -- `org.eclipse.edc.sql.QueryExecutor` (required) -- `java.time.Clock` (required) -- `org.eclipse.edc.sql.bootstrapper.SqlSchemaBootstrapper` (required) -- `org.eclipse.edc.sql.lease.spi.SqlLeaseContextBuilderProvider` (required) -- `org.eclipse.edc.sql.lease.spi.LeaseStatements` (required) - -Module `data-plane-kafka` -------------------------- -**Artifact:** org.eclipse.edc:data-plane-kafka:0.18.0 - -**Categories:** _None_ - -### Extension points -_None_ - -### Extensions -#### Class: `org.eclipse.edc.connector.dataplane.kafka.DataPlaneKafkaExtension` -**Name:** "Data Plane Kafka" - -**Overview:** No overview provided. - - -### Configuration - -| Key | Required | Type | Default | Pattern | Min | Max | Description | -| ----------------------------------------- | -------- | -------- | ------- | ------- | --- | --- | --------------------------------------------- | -| `edc.dataplane.kafka.sink.partition.size` | `*` | `string` | `5` | | | | The partitionSize used by the kafka data sink | - -#### Provided services -_None_ - -#### Referenced (injected) services -- `org.eclipse.edc.connector.dataplane.spi.pipeline.DataTransferExecutorServiceContainer` (required) -- `org.eclipse.edc.connector.dataplane.spi.pipeline.PipelineService` (required) -- `java.time.Clock` (required) - -Module `data-plane-provision-http` ----------------------------------- -**Artifact:** org.eclipse.edc:data-plane-provision-http:0.18.0 - -**Categories:** _None_ - -### Extension points -_None_ - -### Extensions -#### Class: `org.eclipse.edc.connector.dataplane.provision.http.DataPlaneProvisionHttpExtension` -**Name:** "Data Plane Provision Http" - -**Overview:** No overview provided. - - -### Configuration - -| Key | Required | Type | Default | Pattern | Min | Max | Description | -| --------------------------------------- | -------- | -------- | --------------- | ------- | --- | --- | -------------------------------------------------- | -| `web.http.provision.port` | `*` | `string` | `8765` | | | | Port for provision api context | -| `web.http.provision.path` | `*` | `string` | `/provisioning` | | | | Path for provision api context | -| `edc.dataplane.provision.http.endpoint` | | `string` | `` | | | | Configures endpoint for reaching the Provision API | - -#### Provided services -_None_ - -#### Referenced (injected) services -- `org.eclipse.edc.connector.dataplane.spi.provision.ResourceDefinitionGeneratorManager` (required) -- `org.eclipse.edc.connector.dataplane.spi.provision.ProvisionerManager` (required) -- `org.eclipse.edc.http.spi.EdcHttpClient` (required) -- `org.eclipse.edc.spi.monitor.Monitor` (required) -- `org.eclipse.edc.spi.types.TypeManager` (required) -- `org.eclipse.edc.web.spi.WebService` (required) -- `org.eclipse.edc.connector.dataplane.spi.manager.DataPlaneManager` (required) -- `org.eclipse.edc.spi.system.Hostname` (required) -- `org.eclipse.edc.web.spi.configuration.PortMappingRegistry` (required) - -Module `data-plane-selector-api` --------------------------------- -**Artifact:** org.eclipse.edc:data-plane-selector-api:0.18.0 - -**Categories:** _None_ - -### Extension points -_None_ - -### Extensions -#### Class: `org.eclipse.edc.connector.dataplane.selector.DataPlaneSelectorApiExtension` -**Name:** "DataPlane selector API" - -**Overview:** No overview provided. - - -### Configuration_None_ - -#### Provided services -_None_ - -#### Referenced (injected) services -- `org.eclipse.edc.web.spi.WebService` (required) -- `org.eclipse.edc.connector.dataplane.selector.spi.DataPlaneSelectorService` (required) -- `org.eclipse.edc.spi.types.TypeManager` (required) -- `org.eclipse.edc.jsonld.spi.JsonLd` (required) -- `org.eclipse.edc.transform.spi.TypeTransformerRegistry` (required) - -Module `data-plane-selector-client` ------------------------------------ -**Artifact:** org.eclipse.edc:data-plane-selector-client:0.18.0 - -**Categories:** _None_ - -### Extension points -_None_ - -### Extensions -#### Class: `org.eclipse.edc.connector.dataplane.selector.DataPlaneSelectorClientExtension` -**Name:** "DataPlane Selector client" - -**Overview:** No overview provided. - - -### Configuration - -| Key | Required | Type | Default | Pattern | Min | Max | Description | -| ---------------------- | -------- | -------- | ------- | ------- | --- | --- | -------------------------- | -| `edc.dpf.selector.url` | | `string` | `` | | | | DataPlane selector api URL | - -#### Provided services -- `org.eclipse.edc.connector.dataplane.selector.spi.DataPlaneSelectorService` - -#### Referenced (injected) services -- `org.eclipse.edc.http.spi.ControlApiHttpClient` (required) -- `org.eclipse.edc.spi.types.TypeManager` (required) -- `org.eclipse.edc.transform.spi.TypeTransformerRegistry` (required) -- `org.eclipse.edc.jsonld.spi.JsonLd` (required) -- `org.eclipse.edc.connector.dataplane.selector.spi.store.DataPlaneInstanceStore` (optional) - -Module `data-plane-selector-control-api` ----------------------------------------- -**Artifact:** org.eclipse.edc:data-plane-selector-control-api:0.18.0 - -**Categories:** _None_ - -### Extension points -_None_ - -### Extensions -#### Class: `org.eclipse.edc.connector.dataplane.selector.control.api.DataplaneSelectorControlApiExtension` -**Name:** "Dataplane Selector Control API" - -**Overview:** No overview provided. - - -### Configuration_None_ - -#### Provided services -_None_ - -#### Referenced (injected) services -- `org.eclipse.edc.web.spi.WebService` (required) -- `org.eclipse.edc.validator.spi.JsonObjectValidatorRegistry` (required) -- `org.eclipse.edc.spi.types.TypeManager` (required) -- `org.eclipse.edc.transform.spi.TypeTransformerRegistry` (required) -- `org.eclipse.edc.connector.dataplane.selector.spi.DataPlaneSelectorService` (required) -- `java.time.Clock` (required) -- `org.eclipse.edc.participantcontext.single.spi.SingleParticipantContextSupplier` (required) - -Module `data-plane-selector-core` ---------------------------------- -**Artifact:** org.eclipse.edc:data-plane-selector-core:0.18.0 - -**Categories:** _None_ - -### Extension points -_None_ - -### Extensions -#### Class: `org.eclipse.edc.connector.dataplane.selector.DataPlaneSelectorDefaultServicesExtension` -**Name:** "DataPlaneSelectorDefaultServicesExtension" - -**Overview:** No overview provided. - - -### Configuration_None_ - -#### Provided services -- `org.eclipse.edc.connector.dataplane.selector.spi.store.DataPlaneInstanceStore` -- `org.eclipse.edc.connector.dataplane.selector.spi.strategy.SelectionStrategyRegistry` - -#### Referenced (injected) services -- `java.time.Clock` (required) -- `org.eclipse.edc.spi.query.CriterionOperatorRegistry` (required) - -#### Class: `org.eclipse.edc.connector.dataplane.selector.DataPlaneSelectorExtension` -**Name:** "Data Plane Selector core" - -**Overview:** No overview provided. - - -### Configuration - -| Key | Required | Type | Default | Pattern | Min | Max | Description | -| ---------------------------------------- | -------- | -------- | -------- | ------- | --- | --- | -------------------------------------------------------------------------------------------------------- | -| `edc.dataplane.client.selector.strategy` | `*` | `string` | `random` | | | | Defines strategy for Data Plane instance selection in case Data Plane is not embedded in current runtime | - -#### Provided services -- `org.eclipse.edc.connector.dataplane.selector.spi.DataPlaneSelectorService` - -#### Referenced (injected) services -- `org.eclipse.edc.connector.dataplane.selector.spi.store.DataPlaneInstanceStore` (required) -- `org.eclipse.edc.transaction.spi.TransactionContext` (required) -- `org.eclipse.edc.connector.dataplane.selector.spi.strategy.SelectionStrategyRegistry` (required) - -Module `data-plane-selector-spi` --------------------------------- -**Name:** DataPlane selector services -**Artifact:** org.eclipse.edc:data-plane-selector-spi:0.18.0 - -**Categories:** _None_ - -### Extension points - - `org.eclipse.edc.connector.dataplane.selector.spi.DataPlaneSelectorService` - - `org.eclipse.edc.connector.dataplane.selector.spi.client.DataPlaneClient` - -### Extensions -Module `data-plane-self-registration` -------------------------------------- -**Artifact:** org.eclipse.edc:data-plane-self-registration:0.18.0 - -**Categories:** _None_ - -### Extension points -_None_ - -### Extensions -#### Class: `org.eclipse.edc.connector.dataplane.registration.DataplaneSelfRegistrationExtension` -**Name:** "Dataplane Self Registration" - -**Overview:** No overview provided. - - -### Configuration - -| Key | Required | Type | Default | Pattern | Min | Max | Description | -| ------------------------------------ | -------- | -------- | ------- | ------- | --- | --- | ---------------------------------------------------------------------------------------- | -| `edc.data.plane.self.unregistration` | `*` | `string` | `false` | | | | Enable data-plane un-registration at shutdown (not suggested for clustered environments) | - -#### Provided services -_None_ - -#### Referenced (injected) services -- `org.eclipse.edc.connector.dataplane.selector.spi.DataPlaneSelectorService` (required) -- `org.eclipse.edc.web.spi.configuration.context.ControlApiUrl` (required) -- `org.eclipse.edc.connector.dataplane.spi.pipeline.PipelineService` (required) -- `org.eclipse.edc.connector.dataplane.spi.edr.EndpointDataReferenceServiceRegistry` (required) -- `org.eclipse.edc.spi.system.health.HealthCheckService` (required) -- `org.eclipse.edc.connector.dataplane.spi.provision.ResourceDefinitionGeneratorManager` (required) - -Module `data-plane-signaling-api` ---------------------------------- -**Artifact:** org.eclipse.edc:data-plane-signaling-api:0.18.0 - -**Categories:** _None_ - -### Extension points -_None_ - -### Extensions -#### Class: `org.eclipse.edc.connector.dataplane.api.DataPlaneSignalingApiExtension` -**Name:** "DataPlane Signaling API extension" - -**Overview:** No overview provided. - - -### Configuration_None_ - -#### Provided services -_None_ - -#### Referenced (injected) services -- `org.eclipse.edc.web.spi.WebService` (required) -- `org.eclipse.edc.transform.spi.TypeTransformerRegistry` (required) -- `org.eclipse.edc.connector.dataplane.spi.manager.DataPlaneManager` (required) -- `org.eclipse.edc.spi.types.TypeManager` (required) - -Module `data-plane-signaling-client` ------------------------------------- -**Artifact:** org.eclipse.edc:data-plane-signaling-client:0.18.0 - -**Categories:** _None_ - -### Extension points -_None_ - -### Extensions -#### Class: `org.eclipse.edc.connector.dataplane.client.LegacyDataPlaneSignalingClientExtension` -**Name:** "Legacy Data Plane Signaling Client" - -**Overview:** This extension provides an implementation of {@link DataPlaneClient} compliant with the data plane signaling protocol - - - -### Configuration_None_ - -#### Provided services -- `org.eclipse.edc.connector.dataplane.selector.spi.client.DataPlaneClientFactory` - -#### Referenced (injected) services -- `org.eclipse.edc.http.spi.ControlApiHttpClient` (optional) -- `org.eclipse.edc.spi.types.TypeManager` (required) -- `org.eclipse.edc.transform.spi.TypeTransformerRegistry` (required) -- `org.eclipse.edc.jsonld.spi.JsonLd` (required) -- `org.eclipse.edc.connector.dataplane.spi.manager.DataPlaneManager` (optional) - -#### Class: `org.eclipse.edc.connector.dataplane.client.DataPlaneSignalingClientTransformExtension` -**Name:** "Legacy Data Plane Signaling transform Client" - -**Overview:** This extension provides an implementation of {@link DataPlaneClient} compliant with the data plane signaling protocol - - - -### Configuration_None_ - -#### Provided services -_None_ - -#### Referenced (injected) services -- `org.eclipse.edc.transform.spi.TypeTransformerRegistry` (required) -- `org.eclipse.edc.spi.types.TypeManager` (required) - -Module `data-plane-signaling-core` ----------------------------------- -**Artifact:** org.eclipse.edc:data-plane-signaling-core:0.18.0 - -**Categories:** _None_ - -### Extension points -_None_ - -### Extensions -#### Class: `org.eclipse.edc.signaling.DataPlaneSignalingApiExtension` -**Name:** "Data Plane Signaling Api" - -**Overview:** No overview provided. - - -### Configuration - -| Key | Required | Type | Default | Pattern | Min | Max | Description | -| ------------------------------- | -------- | -------- | ---------------- | ------- | --- | --- | --------------------------------------------------------------------------------------- | -| `web.http.signaling.port` | `*` | `string` | `8182` | | | | Port for signaling api context | -| `web.http.signaling.path` | `*` | `string` | `/api/signaling` | | | | Path for signaling api context | -| `web.http.signaling.public.uri` | | `string` | `` | | | | Public uri for signaling api context. If not defined, the 'localhost' one will be used. | - -#### Provided services -_None_ - -#### Referenced (injected) services -- `org.eclipse.edc.web.spi.configuration.PortMappingRegistry` (required) -- `org.eclipse.edc.connector.dataplane.selector.spi.DataPlaneSelectorService` (required) -- `org.eclipse.edc.web.spi.WebService` (required) -- `org.eclipse.edc.connector.controlplane.services.spi.transferprocess.TransferProcessService` (required) -- `org.eclipse.edc.transform.spi.TypeTransformerRegistry` (required) -- `org.eclipse.edc.spi.system.apiversion.ApiVersionService` (required) -- `org.eclipse.edc.signaling.spi.authorization.SignalingAuthorizationRegistry` (required) -- `org.eclipse.edc.participantcontext.single.spi.SingleParticipantContextSupplier` (optional) -- `org.eclipse.edc.api.auth.spi.AuthorizationService` (optional) - -#### Class: `org.eclipse.edc.signaling.DataPlaneSignalingExtension` -**Name:** "Data Plane Signaling" - -**Overview:** No overview provided. - - -### Configuration_None_ - -#### Provided services -- `org.eclipse.edc.signaling.spi.authorization.SignalingAuthorizationRegistry` -- `org.eclipse.edc.signaling.port.ClientFactory` - -#### Referenced (injected) services -- `org.eclipse.edc.http.spi.EdcHttpClient` (required) -- `org.eclipse.edc.spi.types.TypeManager` (required) -- `org.eclipse.edc.spi.monitor.Monitor` (required) - -#### Class: `org.eclipse.edc.signaling.DataPlaneSignalingFlowControllerExtension` -**Name:** "Data Plane Signaling Api" - -**Overview:** No overview provided. - - -### Configuration - -| Key | Required | Type | Default | Pattern | Min | Max | Description | -| ------------------------------- | -------- | -------- | ---------------- | ------- | --- | --- | --------------------------------------------------------------------------------------- | -| `web.http.signaling.port` | `*` | `string` | `8182` | | | | Port for signaling api context | -| `web.http.signaling.path` | `*` | `string` | `/api/signaling` | | | | Path for signaling api context | -| `web.http.signaling.public.uri` | | `string` | `` | | | | Public uri for signaling api context. If not defined, the 'localhost' one will be used. | - -#### Provided services -- `org.eclipse.edc.connector.controlplane.transfer.spi.flow.DataFlowController` - -#### Referenced (injected) services -- `org.eclipse.edc.transform.spi.TypeTransformerRegistry` (required) -- `org.eclipse.edc.signaling.port.ClientFactory` (required) -- `org.eclipse.edc.connector.dataplane.selector.spi.DataPlaneSelectorService` (required) -- `org.eclipse.edc.connector.controlplane.transfer.spi.types.DataAddressStore` (required) -- `org.eclipse.edc.connector.controlplane.asset.spi.index.AssetIndex` (required) - -Module `data-plane-signaling-oauth2` ------------------------------------- -**Artifact:** org.eclipse.edc:data-plane-signaling-oauth2:0.18.0 - -**Categories:** _None_ - -### Extension points -_None_ - -### Extensions -#### Class: `org.eclipse.edc.signaling.oauth2.DataPlaneSignalingOauth2Extension` -**Name:** "DataPlaneSignalingOauth2Extension" - -### Configuration_None_ - -#### Provided services -_None_ - -#### Referenced (injected) services -- `org.eclipse.edc.signaling.spi.authorization.SignalingAuthorizationRegistry` (required) -- `org.eclipse.edc.iam.oauth2.spi.client.Oauth2Client` (required) -- `org.eclipse.edc.token.spi.TokenValidationService` (required) -- `org.eclipse.edc.token.spi.TokenValidationRulesRegistry` (required) -- `java.time.Clock` (required) -- `org.eclipse.edc.jwt.validation.jti.JtiValidationStore` (required) -- `org.eclipse.edc.keys.spi.KeyParserRegistry` (required) - -Module `data-plane-spi` ------------------------ -**Name:** DataPlane services -**Artifact:** org.eclipse.edc:data-plane-spi:0.18.0 - -**Categories:** _None_ - -### Extension points - - `org.eclipse.edc.connector.dataplane.spi.manager.DataPlaneManager` - - `org.eclipse.edc.connector.dataplane.spi.registry.TransferServiceRegistry` - - `org.eclipse.edc.connector.dataplane.spi.iam.DataPlaneAccessTokenService` - - `org.eclipse.edc.connector.dataplane.spi.iam.DataPlaneAccessControlService` - - `org.eclipse.edc.connector.dataplane.spi.pipeline.PipelineService` - - `org.eclipse.edc.connector.dataplane.spi.port.TransferProcessApiClient` - -### Extensions -Module `data-plane-store-sql` ------------------------------ -**Artifact:** org.eclipse.edc:data-plane-store-sql:0.18.0 - -**Categories:** _None_ - -### Extension points -_None_ - -### Extensions -#### Class: `org.eclipse.edc.connector.dataplane.store.sql.SqlDataPlaneStoreExtension` -**Name:** "Sql Data Plane Store" - -**Overview:** Provides Sql Store for Data Plane Flow Requests states - - - -### Configuration - -| Key | Required | Type | Default | Pattern | Min | Max | Description | -| ------------------------------------ | -------- | -------- | --------- | ------- | --- | --- | ------------------------- | -| `edc.sql.store.dataplane.datasource` | `*` | `string` | `default` | | | | The datasource to be used | - -#### Provided services -- `org.eclipse.edc.connector.dataplane.spi.store.DataPlaneStore` - -#### Referenced (injected) services -- `org.eclipse.edc.transaction.datasource.spi.DataSourceRegistry` (required) -- `org.eclipse.edc.transaction.spi.TransactionContext` (required) -- `org.eclipse.edc.connector.dataplane.store.sql.schema.DataFlowStatements` (optional) -- `java.time.Clock` (required) -- `org.eclipse.edc.spi.types.TypeManager` (required) -- `org.eclipse.edc.sql.QueryExecutor` (required) -- `org.eclipse.edc.sql.bootstrapper.SqlSchemaBootstrapper` (required) -- `org.eclipse.edc.sql.lease.spi.SqlLeaseContextBuilderProvider` (required) -- `org.eclipse.edc.sql.lease.spi.LeaseStatements` (required) - -Module `dataspace-profile-context-api-v5` ------------------------------------------ -**Artifact:** org.eclipse.edc:dataspace-profile-context-api-v5:0.18.0 - -**Categories:** _None_ - -### Extension points -_None_ - -### Extensions -#### Class: `org.eclipse.edc.connector.controlplane.api.management.participantcontext.profile.DataspaceProfileContextManagementApiExtension` -**Name:** "ParticipantContext config management API Extension" - -**Overview:** No overview provided. - - -### Configuration_None_ - -#### Provided services -_None_ - -#### Referenced (injected) services -- `org.eclipse.edc.web.spi.WebService` (required) -- `org.eclipse.edc.transform.spi.TypeTransformerRegistry` (required) -- `org.eclipse.edc.validator.spi.JsonObjectValidatorRegistry` (required) -- `org.eclipse.edc.jsonld.spi.JsonLd` (required) -- `org.eclipse.edc.spi.types.TypeManager` (required) -- `org.eclipse.edc.protocol.spi.ParticipantProfileService` (required) -- `org.eclipse.edc.spi.monitor.Monitor` (required) -- `org.eclipse.edc.api.auth.spi.AuthorizationService` (required) - -Module `decentralized-claims-cel` ---------------------------------- -**Artifact:** org.eclipse.edc:decentralized-claims-cel:0.18.0 - -**Categories:** _None_ - -### Extension points -_None_ - -### Extensions -#### Class: `org.eclipse.edc.iam.decentralizedclaims.cel.DcpCelExtension` -**Name:** "DCP Common Expression Language Extensions" - -**Overview:** Common Expression Language extensions for decentralized claims processing. - - - -### Configuration_None_ - -#### Provided services -_None_ - -#### Referenced (injected) services -- `org.eclipse.edc.policy.cel.function.context.CelParticipantAgentClaimMapperRegistry` (required) - -Module `decentralized-claims-core` ----------------------------------- -**Artifact:** org.eclipse.edc:decentralized-claims-core:0.18.0 - -**Categories:** _iam, transform, jsonld, iam, transform, jsonld_ - -### Extension points -_None_ - -### Extensions -#### Class: `org.eclipse.edc.iam.decentralizedclaims.core.DynamicDcpScopeConfigurationExtension` -**Name:** "DCP Dynamic Scope Configuration Extension" - -**Overview:** No overview provided. - - -### Configuration - -| Key | Required | Type | Default | Pattern | Min | Max | Description | -| --------------------------------------------- | -------- | -------- | ------- | ------- | --- | --- | ----------------------------------------------------------------------------------------------------------- | -| `edc.iam.dcp.scopes..id` | `*` | `string` | `` | | | | ID of the scope. | -| `edc.iam.dcp.scopes..type` | `*` | `string` | `` | | | | The type of the scope. Supported values are 'DEFAULT' and 'POLICY'. | -| `edc.iam.dcp.scopes..value` | `*` | `string` | `` | | | | The value of the scope. | -| ~~edc.iam.dcp.scopes..prefix-mapping~~ | | `string` | `` | | | | The prefix mapping for the left operand for applying the scope. Required if type is 'POLICY (Legacy Config) | -| `edc.iam.dcp.scopes..prefix.mapping` | | `string` | `` | | | | The prefix mapping for the left operand for applying the scope. Required if type is 'POLICY | -| `edc.iam.dcp.scopes..profile` | `*` | `string` | `*` | | | | The profile this scope applies to. Use '*' to apply to all profiles. | - -#### Provided services -_None_ - -#### Referenced (injected) services -- `org.eclipse.edc.iam.decentralizedclaims.spi.scope.DcpScopeRegistry` (required) -- `org.eclipse.edc.spi.monitor.Monitor` (required) - -#### Class: `org.eclipse.edc.iam.decentralizedclaims.core.DcpPresentationRequestExtension` -**Name:** "DCP Presentation Request Extension" - -**Overview:** No overview provided. - - -### Configuration_None_ - -#### Provided services -- `org.eclipse.edc.iam.decentralizedclaims.spi.PresentationRequestService` -- `org.eclipse.edc.iam.decentralizedclaims.spi.CredentialServiceClient` - -#### Referenced (injected) services -- `org.eclipse.edc.iam.decentralizedclaims.spi.SecureTokenService` (required) -- `org.eclipse.edc.iam.did.spi.resolution.DidResolverRegistry` (required) -- `org.eclipse.edc.transform.spi.TypeTransformerRegistry` (required) -- `org.eclipse.edc.spi.types.TypeManager` (required) -- `org.eclipse.edc.http.spi.EdcHttpClient` (required) -- `org.eclipse.edc.jsonld.spi.JsonLd` (required) - -#### Class: `org.eclipse.edc.iam.decentralizedclaims.core.DcpDefaultServicesExtension` -**Name:** "DCP Extension to register default services" - -**Overview:** No overview provided. - - -### Configuration_None_ - -#### Provided services -- `org.eclipse.edc.iam.verifiablecredentials.spi.validation.TrustedIssuerRegistry` -- `org.eclipse.edc.iam.decentralizedclaims.spi.verification.SignatureSuiteRegistry` -- `org.eclipse.edc.protocol.spi.DefaultParticipantIdExtractionFunction` -- `org.eclipse.edc.iam.decentralizedclaims.spi.scope.ScopeExtractorRegistry` -- `org.eclipse.edc.spi.iam.AudienceResolver` -- `org.eclipse.edc.iam.decentralizedclaims.spi.ClaimTokenCreatorFunction` -- `org.eclipse.edc.iam.decentralizedclaims.spi.scope.store.DcpScopeStore` - -#### Referenced (injected) services -- `org.eclipse.edc.spi.query.CriterionOperatorRegistry` (required) - -#### Class: `org.eclipse.edc.iam.decentralizedclaims.core.DcpScopeExtractorExtension` -**Name:** "DCP scope extractor extension" - -**Overview:** No overview provided. - - -### Configuration_None_ - -#### Provided services -_None_ - -#### Referenced (injected) services -- `org.eclipse.edc.policy.engine.spi.PolicyEngine` (required) -- `org.eclipse.edc.iam.decentralizedclaims.spi.scope.ScopeExtractorRegistry` (required) -- `org.eclipse.edc.spi.monitor.Monitor` (required) - -#### Class: `org.eclipse.edc.iam.decentralizedclaims.core.DcpCoreExtension` -**Name:** "DCP Core Extension" - -**Overview:** No overview provided. - - -### Configuration - -| Key | Required | Type | Default | Pattern | Min | Max | Description | -| ------------------------------------ | -------- | -------- | ------- | ------- | --- | --- | ------------------------------------------------------------------------------------- | -| `edc.participant.did` | | `string` | `` | | | | DID of the participant, only needed if different from the value in edc.participant.id | -| ~~edc.iam.issuer.id~~ | `*` | `string` | `` | | | | DEPRECATED: DID of the participant, please refer to edc.participant.did | -| `edc.sql.store.jti.cleanup.period` | `*` | `string` | `60` | | | | The period of the JTI entry reaper thread in seconds | -| `edc.iam.accesstoken.jti.validation` | `*` | `string` | `true` | | | | Activate or deactivate JTI validation | - -#### Provided services -- `org.eclipse.edc.spi.iam.IdentityService` -- `org.eclipse.edc.iam.verifiablecredentials.spi.validation.PresentationVerifier` - -#### Referenced (injected) services -- `org.eclipse.edc.iam.decentralizedclaims.spi.SecureTokenService` (required) -- `org.eclipse.edc.iam.verifiablecredentials.spi.validation.TrustedIssuerRegistry` (required) -- `org.eclipse.edc.spi.types.TypeManager` (required) -- `org.eclipse.edc.iam.decentralizedclaims.spi.verification.SignatureSuiteRegistry` (required) -- `org.eclipse.edc.jsonld.spi.JsonLd` (required) -- `java.time.Clock` (required) -- `org.eclipse.edc.iam.did.spi.resolution.DidResolverRegistry` (required) -- `org.eclipse.edc.token.spi.TokenValidationService` (required) -- `org.eclipse.edc.token.spi.TokenValidationRulesRegistry` (required) -- `org.eclipse.edc.iam.did.spi.resolution.DidPublicKeyResolver` (required) -- `org.eclipse.edc.iam.decentralizedclaims.spi.ClaimTokenCreatorFunction` (required) -- `org.eclipse.edc.participant.spi.ParticipantAgentService` (required) -- `org.eclipse.edc.iam.decentralizedclaims.spi.DcpParticipantAgentServiceExtension` (optional) -- `org.eclipse.edc.iam.verifiablecredentials.spi.model.RevocationServiceRegistry` (required) -- `org.eclipse.edc.participantcontext.spi.config.ParticipantContextConfig` (required) -- `org.eclipse.edc.jwt.validation.jti.JtiValidationStore` (required) -- `org.eclipse.edc.spi.system.ExecutorInstrumentation` (required) -- `org.eclipse.edc.iam.decentralizedclaims.spi.PresentationRequestService` (required) -- `org.eclipse.edc.protocol.spi.discovery.DiscoveryService` (required) - -#### Class: `org.eclipse.edc.iam.decentralizedclaims.core.DcpTransformExtension` -**Name:** "DCP Transform Extension" - -**Overview:** No overview provided. - - -### Configuration_None_ - -#### Provided services -_None_ - -#### Referenced (injected) services -- `org.eclipse.edc.transform.spi.TypeTransformerRegistry` (required) -- `org.eclipse.edc.jsonld.spi.JsonLd` (required) -- `org.eclipse.edc.spi.types.TypeManager` (required) -- `org.eclipse.edc.spi.monitor.Monitor` (required) - -#### Class: `org.eclipse.edc.iam.decentralizedclaims.core.DynamicDcpScopeExtension` -**Name:** "DCP Dynamic Scope Extension" - -**Overview:** No overview provided. - - -### Configuration_None_ - -#### Provided services -- `org.eclipse.edc.iam.decentralizedclaims.spi.scope.DcpScopeRegistry` - -#### Referenced (injected) services -- `org.eclipse.edc.policy.engine.spi.PolicyEngine` (required) -- `org.eclipse.edc.transaction.spi.TransactionContext` (required) -- `org.eclipse.edc.iam.decentralizedclaims.spi.scope.store.DcpScopeStore` (required) -- `org.eclipse.edc.iam.decentralizedclaims.spi.scope.ScopeExtractorRegistry` (required) - -Module `decentralized-claims-issuers-configuration` ---------------------------------------------------- -**Artifact:** org.eclipse.edc:decentralized-claims-issuers-configuration:0.18.0 - -**Categories:** _None_ - -### Extension points -_None_ - -### Extensions -#### Class: `org.eclipse.edc.iam.decentralizedclaims.issuer.configuration.TrustedIssuerConfigurationExtension` -**Name:** "Trusted Issuers Configuration Extensions" - -**Overview:** This DCP extension makes it possible to configure a list of trusted issuers, that will be matched against the Verifiable Credential issuers. - - - -### Configuration - -| Key | Required | Type | Default | Pattern | Min | Max | Description | -| ----------------------------------------------- | -------- | -------- | ------- | ------- | --- | --- | ---------------------------------------------------------------------- | -| `edc.iam.trusted-issuer..id` | `*` | `string` | `` | | | | ID of the issuer. | -| `edc.iam.trusted-issuer..supportedtypes` | `*` | `string` | `["*"]` | | | | Supported credential types for this issuer, as a JSON serialized list. | -| `edc.iam.trusted-issuer..properties` | `*` | `string` | `{}` | | | | Additional properties of the issuer, as a JSON serialized object. | -| `edc.iam.trustedissuer..id` | `*` | `string` | `` | | | | ID of the issuer. | -| `edc.iam.trustedissuer..supportedtypes` | `*` | `string` | `["*"]` | | | | Supported credential types for this issuer, as a JSON serialized list. | -| `edc.iam.trustedissuer..properties` | `*` | `string` | `{}` | | | | Additional properties of the issuer, as a JSON serialized object. | - -#### Provided services -_None_ - -#### Referenced (injected) services -- `org.eclipse.edc.iam.verifiablecredentials.spi.validation.TrustedIssuerRegistry` (required) -- `org.eclipse.edc.spi.types.TypeManager` (required) -- `org.eclipse.edc.spi.monitor.Monitor` (required) - -Module `decentralized-claims-sts-remote-client` ------------------------------------------------ -**Artifact:** org.eclipse.edc:decentralized-claims-sts-remote-client:0.18.0 - -**Categories:** _None_ - -### Extension points -_None_ - -### Extensions -#### Class: `org.eclipse.edc.iam.decentralizedclaims.sts.remote.client.StsRemoteClientExtension` -**Name:** "Sts remote client extension" - -**Overview:** Configuration Extension for the STS OAuth2 client - - - -### Configuration - -| Key | Required | Type | Default | Pattern | Min | Max | Description | -| --------------------------------------- | -------- | -------- | ------- | ------- | --- | --- | ------------------------------------------ | -| `edc.iam.sts.oauth.token.url` | `*` | `string` | `` | | | | STS OAuth2 endpoint for requesting a token | -| `edc.iam.sts.oauth.client.id` | `*` | `string` | `` | | | | STS OAuth2 client id | -| `edc.iam.sts.oauth.client.secret.alias` | `*` | `string` | `` | | | | Vault alias of STS OAuth2 client secret | - -#### Provided services -- `org.eclipse.edc.iam.decentralizedclaims.spi.SecureTokenService` - -#### Referenced (injected) services -- `org.eclipse.edc.iam.oauth2.spi.client.Oauth2Client` (required) -- `org.eclipse.edc.participantcontext.spi.config.ParticipantContextConfig` (required) -- `org.eclipse.edc.spi.security.Vault` (required) - -Module `discovery-api-v5` -------------------------- -**Artifact:** org.eclipse.edc:discovery-api-v5:0.18.0 - -**Categories:** _None_ - -### Extension points -_None_ - -### Extensions -#### Class: `org.eclipse.edc.connector.controlplane.api.management.discovery.DiscoveryApiV5Extension` -**Name:** "Discovery Management API Extension" - -**Overview:** No overview provided. - - -### Configuration_None_ - -#### Provided services -_None_ - -#### Referenced (injected) services -- `org.eclipse.edc.web.spi.WebService` (required) -- `org.eclipse.edc.transform.spi.TypeTransformerRegistry` (required) -- `org.eclipse.edc.validator.spi.JsonObjectValidatorRegistry` (required) -- `org.eclipse.edc.jsonld.spi.JsonLd` (required) -- `org.eclipse.edc.spi.types.TypeManager` (required) -- `org.eclipse.edc.protocol.spi.discovery.DiscoveryService` (required) -- `org.eclipse.edc.spi.monitor.Monitor` (required) -- `org.eclipse.edc.api.auth.spi.AuthorizationService` (required) - -Module `dps-tck-connector-under-test` -------------------------------------- -**Artifact:** org.eclipse.edc:dps-tck-connector-under-test:0.18.0 - -**Categories:** _None_ - -### Extension points -_None_ - -### Extensions -#### Class: `org.eclipse.edc.tck.dps.signaling.DpsTckExtension` -**Name:** "DPS TCK Signaling Trigger" - -**Overview:** Registers a webhook endpoint on the "tck" context that the TCK uses to trigger - DataFlowPrepareMessage dispatching via a real TransferProcess. - - - -### Configuration - -| Key | Required | Type | Default | Pattern | Min | Max | Description | -| ---------------------------- | -------- | -------- | ---------------------- | ------- | --- | --- | -------------------------------------------------------------------------------- | -| `web.http.tck.port` | `*` | `string` | `8687` | | | | Port for tck api context | -| `web.http.tck.path` | `*` | `string` | `/tck` | | | | Path for tck api context | -| `edc.participant.context.id` | `*` | `string` | `participantContextId` | | | | Configures the participant context id for the tck suite runtime | -| `edc.tck.dataplane.url` | `*` | `string` | `` | | | | Base URL of the TCK acting as data plane, equal to dataspacetck.callback.address | - -#### Provided services -_None_ - -#### Referenced (injected) services -- `org.eclipse.edc.web.spi.configuration.PortMappingRegistry` (required) -- `org.eclipse.edc.web.spi.WebService` (required) -- `org.eclipse.edc.connector.controlplane.services.spi.transferprocess.TransferProcessService` (required) -- `org.eclipse.edc.connector.dataplane.selector.spi.DataPlaneSelectorService` (required) -- `org.eclipse.edc.participantcontext.single.spi.SingleParticipantContextSupplier` (required) -- `org.eclipse.edc.connector.controlplane.contract.spi.negotiation.store.ContractNegotiationStore` (required) -- `org.eclipse.edc.connector.controlplane.services.spi.asset.AssetService` (required) -- `org.eclipse.edc.spi.monitor.Monitor` (required) - -Module `dsp-catalog-http-api-2025` ----------------------------------- -**Artifact:** org.eclipse.edc:dsp-catalog-http-api-2025:0.18.0 - -**Categories:** _None_ - -### Extension points -_None_ - -### Extensions -#### Class: `org.eclipse.edc.protocol.dsp.catalog.http.api.v2025.DspCatalogApi2025Extension` -**Name:** "Dataspace Protocol 2025/1 API Catalog Extension" - -**Overview:** Creates and registers the controller for dataspace protocol v2025/1 catalog requests. - - - -### Configuration_None_ - -#### Provided services -_None_ - -#### Referenced (injected) services -- `org.eclipse.edc.web.spi.WebService` (required) -- `org.eclipse.edc.connector.controlplane.services.spi.catalog.CatalogProtocolService` (required) -- `org.eclipse.edc.connector.controlplane.catalog.spi.DataServiceRegistry` (required) -- `org.eclipse.edc.validator.spi.JsonObjectValidatorRegistry` (required) -- `org.eclipse.edc.protocol.dsp.http.spi.message.DspRequestHandler` (required) -- `org.eclipse.edc.spi.query.CriterionOperatorRegistry` (required) -- `org.eclipse.edc.protocol.spi.DataspaceProfileContextRegistry` (required) -- `org.eclipse.edc.transform.spi.TypeTransformerRegistry` (required) -- `org.eclipse.edc.spi.monitor.Monitor` (required) -- `org.eclipse.edc.spi.types.TypeManager` (required) -- `org.eclipse.edc.jsonld.spi.JsonLd` (required) -- `org.eclipse.edc.participantcontext.single.spi.SingleParticipantContextSupplier` (required) -- `org.eclipse.edc.protocol.spi.ProtocolWebhookResolver` (required) - -Module `dsp-catalog-http-api-2025-virtual` ------------------------------------------- -**Artifact:** org.eclipse.edc:dsp-catalog-http-api-2025-virtual:0.18.0 - -**Categories:** _None_ - -### Extension points -_None_ - -### Extensions -#### Class: `org.eclipse.edc.protocol.dsp.catalog.http.api.v2025.virtual.DspVirtualCatalogApi2025Extension` -**Name:** "Dataspace Protocol 2025/1 API Catalog Extension" - -**Overview:** Creates and registers the controller for dataspace protocol v2025/1 catalog requests. - - - -### Configuration_None_ - -#### Provided services -_None_ - -#### Referenced (injected) services -- `org.eclipse.edc.connector.controlplane.services.spi.catalog.CatalogProtocolService` (required) -- `org.eclipse.edc.connector.controlplane.catalog.spi.DataServiceRegistry` (required) -- `org.eclipse.edc.validator.spi.JsonObjectValidatorRegistry` (required) -- `org.eclipse.edc.protocol.dsp.http.spi.message.DspRequestHandler` (required) -- `org.eclipse.edc.spi.query.CriterionOperatorRegistry` (required) -- `org.eclipse.edc.protocol.spi.ProtocolWebhookResolver` (required) -- `org.eclipse.edc.transform.spi.TypeTransformerRegistry` (required) -- `org.eclipse.edc.spi.monitor.Monitor` (required) -- `org.eclipse.edc.spi.types.TypeManager` (required) -- `org.eclipse.edc.jsonld.spi.JsonLd` (required) -- `org.eclipse.edc.participantcontext.spi.service.ParticipantContextService` (required) -- `org.eclipse.edc.protocol.spi.ParticipantProfileService` (required) -- `org.eclipse.edc.protocol.spi.DataspaceProfileContextRegistry` (required) -- `org.eclipse.edc.protocol.dsp.spi.http.DspVirtualSubResourceLocator` (required) - -Module `dsp-catalog-http-dispatcher` ------------------------------------- -**Artifact:** org.eclipse.edc:dsp-catalog-http-dispatcher:0.18.0 - -**Categories:** _None_ - -### Extension points -_None_ - -### Extensions -#### Class: `org.eclipse.edc.protocol.dsp.catalog.http.dispatcher.DspCatalogHttpDispatcherExtension` -**Name:** "Dataspace Protocol Catalog HTTP Dispatcher Extension" - -**Overview:** Creates and registers the HTTP dispatcher delegate for sending a catalog request as defined in - the dataspace protocol specification. - - - -### Configuration_None_ - -#### Provided services -_None_ - -#### Referenced (injected) services -- `org.eclipse.edc.connector.controlplane.services.spi.protocol.ProtocolRemoteMessageDispatcher` (required) -- `org.eclipse.edc.protocol.dsp.http.spi.serialization.JsonLdRemoteMessageSerializer` (required) -- `org.eclipse.edc.connector.controlplane.services.spi.protocol.RequestBasePathProvider` (required) - -Module `dsp-catalog-transform-2025` ------------------------------------ -**Artifact:** org.eclipse.edc:dsp-catalog-transform-2025:0.18.0 - -**Categories:** _None_ - -### Extension points -_None_ - -### Extensions -#### Class: `org.eclipse.edc.protocol.dsp.catalog.transform.v2025.DspCatalogTransformV2025Extension` -**Name:** "Dataspace Protocol 2025/1 Catalog Transform Extension" - -**Overview:** Provides the transformers for DSP v2025/1 catalog message types via the {@link TypeTransformerRegistry}. - - - -### Configuration_None_ - -#### Provided services -_None_ - -#### Referenced (injected) services -- `org.eclipse.edc.transform.spi.TypeTransformerRegistry` (required) -- `org.eclipse.edc.spi.types.TypeManager` (required) -- `org.eclipse.edc.participant.spi.ParticipantIdMapper` (required) -- `org.eclipse.edc.spi.query.CriterionOperatorRegistry` (required) - -Module `dsp-http-api-base-configuration` ----------------------------------------- -**Artifact:** org.eclipse.edc:dsp-http-api-base-configuration:0.18.0 - -**Categories:** _None_ - -### Extension points -_None_ - -### Extensions -#### Class: `org.eclipse.edc.protocol.dsp.http.api.configuration.DspApiBaseConfigurationExtension` -**Name:** "Dataspace Protocol API Base Configuration Extension" - -**Overview:** No overview provided. - - -### Configuration - -| Key | Required | Type | Default | Pattern | Min | Max | Description | -| --------------------------- | -------- | -------- | --------------- | ------- | --- | --- | ------------------------------------------------------------------------------------------------------ | -| `web.http.protocol.port` | `*` | `string` | `8282` | | | | Port for protocol api context | -| `web.http.protocol.path` | `*` | `string` | `/api/protocol` | | | | Path for protocol api context | -| `web.http.protocol.virtual` | `*` | `string` | `false` | | | | Fill the participant context param in the protocol path in case the callback address is not configured | -| `edc.dsp.callback.address` | | `string` | `` | | | | Configures endpoint for reaching the Protocol API in the form "" | - -#### Provided services -- `org.eclipse.edc.protocol.dsp.http.spi.api.DspBaseWebhookAddress` - -#### Referenced (injected) services -- `org.eclipse.edc.spi.system.Hostname` (required) -- `org.eclipse.edc.web.spi.configuration.PortMappingRegistry` (required) -- `org.eclipse.edc.web.spi.WebService` (required) -- `org.eclipse.edc.spi.types.TypeManager` (required) - -Module `dsp-http-api-configuration-2025` ----------------------------------------- -**Artifact:** org.eclipse.edc:dsp-http-api-configuration-2025:0.18.0 - -**Categories:** _None_ - -### Extension points -_None_ - -### Extensions -#### Class: `org.eclipse.edc.protocol.dsp.http.api.configuration.v2025.DspApiConfigurationV2025Extension` -**Name:** "Dataspace Protocol 2025/1 API Configuration Extension" - -**Overview:** Registers protocol webhook, API transformers and namespaces for DSP v2025/1. - - - -### Configuration_None_ - -#### Provided services -_None_ - -#### Referenced (injected) services -- `org.eclipse.edc.spi.types.TypeManager` (required) -- `org.eclipse.edc.jsonld.spi.JsonLd` (required) -- `org.eclipse.edc.transform.spi.TypeTransformerRegistry` (required) -- `org.eclipse.edc.participant.spi.ParticipantIdMapper` (required) -- `org.eclipse.edc.protocol.dsp.http.spi.api.DspBaseWebhookAddress` (required) -- `org.eclipse.edc.protocol.spi.DataspaceProfileContextRegistry` (required) -- `org.eclipse.edc.protocol.spi.DefaultParticipantIdExtractionFunction` (required) -- `org.eclipse.edc.spi.query.CriterionOperatorRegistry` (required) - -Module `dsp-http-api-configuration-2025-virtual` ------------------------------------------------- -**Artifact:** org.eclipse.edc:dsp-http-api-configuration-2025-virtual:0.18.0 - -**Categories:** _None_ - -### Extension points -_None_ - -### Extensions -#### Class: `org.eclipse.edc.protocol.dsp.http.api.configuration.v2025.virtual.DspVirtualApiConfigurationV2025Extension` -**Name:** "Dataspace Protocol 2025/1 API Virtual Configuration Extension" - -**Overview:** Registers protocol webhook, API transformers and namespaces for DSP v2025/1 in virtual connector mode. - - - -### Configuration_None_ - -#### Provided services -_None_ - -#### Referenced (injected) services -- `org.eclipse.edc.spi.types.TypeManager` (required) -- `org.eclipse.edc.jsonld.spi.JsonLd` (required) -- `org.eclipse.edc.transform.spi.TypeTransformerRegistry` (required) -- `org.eclipse.edc.participant.spi.ParticipantIdMapper` (required) -- `org.eclipse.edc.protocol.dsp.http.spi.api.DspBaseWebhookAddress` (required) -- `org.eclipse.edc.protocol.spi.DataspaceProfileContextRegistry` (required) -- `org.eclipse.edc.protocol.spi.DefaultParticipantIdExtractionFunction` (required) -- `org.eclipse.edc.spi.query.CriterionOperatorRegistry` (required) - -Module `dsp-http-core` ----------------------- -**Artifact:** org.eclipse.edc:dsp-http-core:0.18.0 - -**Categories:** _None_ - -### Extension points -_None_ - -### Extensions -#### Class: `org.eclipse.edc.protocol.dsp.http.DspHttpCoreExtension` -**Name:** "Dataspace Protocol Core Extension" - -**Overview:** Provides an implementation of {@link ProtocolRemoteMessageDispatcher} to support sending dataspace - protocol messages. The dispatcher can then be used by other extensions to add support for - specific message types. - - - -### Configuration_None_ - -#### Provided services -- `org.eclipse.edc.connector.controlplane.services.spi.protocol.ProtocolRemoteMessageDispatcher` -- `org.eclipse.edc.protocol.dsp.http.spi.message.DspRequestHandler` -- `org.eclipse.edc.protocol.dsp.http.spi.serialization.JsonLdRemoteMessageSerializer` -- `org.eclipse.edc.protocol.dsp.spi.transform.DspProtocolTypeTransformerRegistry` -- `org.eclipse.edc.connector.controlplane.services.spi.protocol.RequestBasePathProvider` - -#### Referenced (injected) services -- `org.eclipse.edc.http.spi.EdcHttpClient` (required) -- `org.eclipse.edc.spi.iam.IdentityService` (required) -- `org.eclipse.edc.transform.spi.TypeTransformerRegistry` (required) -- `org.eclipse.edc.spi.types.TypeManager` (required) -- `org.eclipse.edc.jsonld.spi.JsonLd` (required) -- `org.eclipse.edc.token.spi.TokenDecorator` (optional) -- `org.eclipse.edc.policy.engine.spi.PolicyEngine` (required) -- `org.eclipse.edc.spi.iam.AudienceResolver` (required) -- `org.eclipse.edc.spi.monitor.Monitor` (required) -- `org.eclipse.edc.validator.spi.JsonObjectValidatorRegistry` (required) -- `org.eclipse.edc.protocol.spi.DataspaceProfileContextRegistry` (required) - -Module `dsp-http-core-virtual` ------------------------------- -**Artifact:** org.eclipse.edc:dsp-http-core-virtual:0.18.0 - -**Categories:** _None_ - -### Extension points -_None_ - -### Extensions -#### Class: `org.eclipse.edc.protocol.dsp.http.DspVirtualHttpCoreExtension` -**Name:** "Dataspace Protocol Core Virtual Extension" - -**Overview:** No overview provided. - - -### Configuration_None_ - -#### Provided services -- `org.eclipse.edc.protocol.dsp.spi.http.DspVirtualSubResourceLocator` - -#### Referenced (injected) services -- `org.eclipse.edc.jsonld.spi.JsonLd` (required) -- `org.eclipse.edc.spi.types.TypeManager` (required) -- `org.eclipse.edc.web.spi.WebService` (required) -- `org.eclipse.edc.protocol.spi.DataspaceProfileContextRegistry` (required) -- `org.eclipse.edc.protocol.spi.ParticipantProfileService` (required) - -#### Class: `org.eclipse.edc.protocol.dsp.http.profile.DataspaceProfileConfigurationExtension` -**Name:** "Dataspace Profile Configuration Extension" - -**Overview:** No overview provided. - - -### Configuration - -| Key | Required | Type | Default | Pattern | Min | Max | Description | -| ---------------------------------------------------- | -------- | -------- | ------- | ------- | --- | --- | ----------------------------------------------------------------------------- | -| `edc.dataspace.profiles..name` | `*` | `string` | `` | | | | The name of the dataspace profile. | -| `edc.dataspace.profiles..protocol.version` | `*` | `string` | `` | | | | The version of the DSP protocol this profile binds to. | -| `edc.dataspace.profiles..protocol.binding` | `*` | `string` | `` | | | | The protocol binding (e.g. 'http') of the DSP protocol this profile binds to. | -| `edc.dataspace.profiles..protocol.namespace` | `*` | `string` | `` | | | | The JSON-LD namespace of the dataspace profile. | -| `edc.dataspace.profiles..jsonld.context.urls` | `*` | `string` | `` | | | | The JSON-LD context URLs of the dataspace profile. | - -#### Provided services -_None_ - -#### Referenced (injected) services -- `org.eclipse.edc.protocol.spi.DefaultParticipantIdExtractionFunction` (required) -- `org.eclipse.edc.protocol.spi.DataspaceProfileContextRegistry` (required) -- `org.eclipse.edc.protocol.dsp.http.spi.api.DspBaseWebhookAddress` (required) - -Module `dsp-metadata-http-api-virtual` --------------------------------------- -**Artifact:** org.eclipse.edc:dsp-metadata-http-api-virtual:0.18.0 - -**Categories:** _None_ - -### Extension points -_None_ - -### Extensions -#### Class: `org.eclipse.edc.protocol.dsp.metadata.http.api.DspVirtualMetadataApiExtension` -**Name:** "Dataspace Protocol Virtual Metadata Api" - -**Overview:** Provide API for the protocol versions. - - - -### Configuration_None_ - -#### Provided services -_None_ - -#### Referenced (injected) services -- `org.eclipse.edc.web.spi.WebService` (required) -- `org.eclipse.edc.transform.spi.TypeTransformerRegistry` (required) -- `org.eclipse.edc.protocol.spi.ParticipantProfileService` (required) -- `org.eclipse.edc.jsonld.spi.JsonLd` (required) -- `org.eclipse.edc.spi.types.TypeManager` (required) -- `org.eclipse.edc.participantcontext.spi.service.ParticipantContextService` (required) - -Module `dsp-negotiation-http-api-2025` --------------------------------------- -**Artifact:** org.eclipse.edc:dsp-negotiation-http-api-2025:0.18.0 - -**Categories:** _None_ - -### Extension points -_None_ - -### Extensions -#### Class: `org.eclipse.edc.protocol.dsp.negotiation.http.api.v2025.DspNegotiationApi2025Extension` -**Name:** "Dataspace Protocol Negotiation Api v2025/1" - -**Overview:** Creates and registers the controller for dataspace protocol v2025/1 negotiation requests. - - - -### Configuration_None_ - -#### Provided services -_None_ - -#### Referenced (injected) services -- `org.eclipse.edc.web.spi.WebService` (required) -- `org.eclipse.edc.connector.controlplane.services.spi.contractnegotiation.ContractNegotiationProtocolService` (required) -- `org.eclipse.edc.validator.spi.JsonObjectValidatorRegistry` (required) -- `org.eclipse.edc.protocol.dsp.http.spi.message.DspRequestHandler` (required) -- `org.eclipse.edc.protocol.spi.DataspaceProfileContextRegistry` (required) -- `org.eclipse.edc.jsonld.spi.JsonLd` (required) -- `org.eclipse.edc.spi.types.TypeManager` (required) -- `org.eclipse.edc.participantcontext.single.spi.SingleParticipantContextSupplier` (required) - -Module `dsp-negotiation-http-api-2025-virtual` ----------------------------------------------- -**Artifact:** org.eclipse.edc:dsp-negotiation-http-api-2025-virtual:0.18.0 - -**Categories:** _None_ - -### Extension points -_None_ - -### Extensions -#### Class: `org.eclipse.edc.protocol.dsp.negotiation.http.api.v2025.virtual.DspVirtualNegotiationApi2025Extension` -**Name:** "Dataspace Protocol Negotiation Api v2025/1" - -**Overview:** Creates and registers the controller for dataspace protocol v2025/1 negotiation requests. - - - -### Configuration_None_ - -#### Provided services -_None_ - -#### Referenced (injected) services -- `org.eclipse.edc.connector.controlplane.services.spi.contractnegotiation.ContractNegotiationProtocolService` (required) -- `org.eclipse.edc.validator.spi.JsonObjectValidatorRegistry` (required) -- `org.eclipse.edc.protocol.dsp.http.spi.message.DspRequestHandler` (required) -- `org.eclipse.edc.protocol.spi.DataspaceProfileContextRegistry` (required) -- `org.eclipse.edc.spi.types.TypeManager` (required) -- `org.eclipse.edc.participantcontext.spi.service.ParticipantContextService` (required) -- `org.eclipse.edc.protocol.spi.ParticipantProfileService` (required) -- `org.eclipse.edc.protocol.dsp.spi.http.DspVirtualSubResourceLocator` (required) - -Module `dsp-negotiation-http-dispatcher` ----------------------------------------- -**Artifact:** org.eclipse.edc:dsp-negotiation-http-dispatcher:0.18.0 - -**Categories:** _None_ - -### Extension points -_None_ - -### Extensions -#### Class: `org.eclipse.edc.protocol.dsp.negotiation.http.dispatcher.DspNegotiationHttpDispatcherExtension` -**Name:** "Dataspace Protocol Negotiation HTTP Dispatcher Extension" - -**Overview:** No overview provided. - - -### Configuration_None_ - -#### Provided services -_None_ - -#### Referenced (injected) services -- `org.eclipse.edc.connector.controlplane.services.spi.protocol.ProtocolRemoteMessageDispatcher` (required) -- `org.eclipse.edc.protocol.dsp.http.spi.serialization.JsonLdRemoteMessageSerializer` (required) -- `org.eclipse.edc.spi.types.TypeManager` (required) -- `org.eclipse.edc.protocol.dsp.spi.transform.DspProtocolTypeTransformerRegistry` (required) -- `org.eclipse.edc.jsonld.spi.JsonLd` (required) -- `org.eclipse.edc.connector.controlplane.services.spi.protocol.RequestBasePathProvider` (required) - -Module `dsp-negotiation-transform-2025` ---------------------------------------- -**Artifact:** org.eclipse.edc:dsp-negotiation-transform-2025:0.18.0 - -**Categories:** _None_ - -### Extension points -_None_ - -### Extensions -#### Class: `org.eclipse.edc.protocol.dsp.negotiation.transform.v2025.DspNegotiationTransformV2025Extension` -**Name:** "Dataspace Protocol 2025/1 Negotiation Transform Extension" - -**Overview:** Provides the transformers for DSP v2025/1 negotiation message types via the {@link TypeTransformerRegistry}. - - - -### Configuration_None_ - -#### Provided services -_None_ - -#### Referenced (injected) services -- `org.eclipse.edc.transform.spi.TypeTransformerRegistry` (required) - -Module `dsp-transfer-process-http-api-2025` -------------------------------------------- -**Artifact:** org.eclipse.edc:dsp-transfer-process-http-api-2025:0.18.0 - -**Categories:** _None_ - -### Extension points -_None_ - -### Extensions -#### Class: `org.eclipse.edc.protocol.dsp.transferprocess.http.api.v2025.DspTransferProcessApi2025Extension` -**Name:** "Dataspace Protocol 2025/1: TransferProcess API Extension" - -**Overview:** Creates and registers the controller for dataspace protocol v2025/1 transfer process requests. - - - -### Configuration_None_ - -#### Provided services -_None_ - -#### Referenced (injected) services -- `org.eclipse.edc.web.spi.WebService` (required) -- `org.eclipse.edc.connector.controlplane.services.spi.transferprocess.TransferProcessProtocolService` (required) -- `org.eclipse.edc.protocol.dsp.http.spi.message.DspRequestHandler` (required) -- `org.eclipse.edc.validator.spi.JsonObjectValidatorRegistry` (required) -- `org.eclipse.edc.protocol.spi.DataspaceProfileContextRegistry` (required) -- `org.eclipse.edc.jsonld.spi.JsonLd` (required) -- `org.eclipse.edc.spi.types.TypeManager` (required) -- `org.eclipse.edc.participantcontext.single.spi.SingleParticipantContextSupplier` (required) - -Module `dsp-transfer-process-http-api-2025-virtual` ---------------------------------------------------- -**Artifact:** org.eclipse.edc:dsp-transfer-process-http-api-2025-virtual:0.18.0 - -**Categories:** _None_ - -### Extension points -_None_ - -### Extensions -#### Class: `org.eclipse.edc.protocol.dsp.transferprocess.http.api.v2025.virtual.DspVirtualTransferProcessApi2025Extension` -**Name:** "Dataspace Protocol 2025/1: TransferProcess API Extension" - -**Overview:** Creates and registers the controller for dataspace protocol v2025/1 transfer process requests. - - - -### Configuration_None_ - -#### Provided services -_None_ - -#### Referenced (injected) services -- `org.eclipse.edc.connector.controlplane.services.spi.transferprocess.TransferProcessProtocolService` (required) -- `org.eclipse.edc.protocol.dsp.http.spi.message.DspRequestHandler` (required) -- `org.eclipse.edc.validator.spi.JsonObjectValidatorRegistry` (required) -- `org.eclipse.edc.protocol.spi.DataspaceProfileContextRegistry` (required) -- `org.eclipse.edc.spi.types.TypeManager` (required) -- `org.eclipse.edc.participantcontext.spi.service.ParticipantContextService` (required) -- `org.eclipse.edc.protocol.spi.ParticipantProfileService` (required) -- `org.eclipse.edc.protocol.dsp.spi.http.DspVirtualSubResourceLocator` (required) - -Module `dsp-transfer-process-http-dispatcher` ---------------------------------------------- -**Artifact:** org.eclipse.edc:dsp-transfer-process-http-dispatcher:0.18.0 - -**Categories:** _None_ - -### Extension points -_None_ - -### Extensions -#### Class: `org.eclipse.edc.protocol.dsp.transferprocess.http.dispatcher.DspTransferProcessDispatcherExtension` -**Name:** "Dataspace Protocol Transfer HTTP Dispatcher Extension" - -**Overview:** Provides HTTP dispatching for Dataspace Protocol transfer process messages via the {@link ProtocolRemoteMessageDispatcher}. - - - -### Configuration_None_ - -#### Provided services -_None_ - -#### Referenced (injected) services -- `org.eclipse.edc.connector.controlplane.services.spi.protocol.ProtocolRemoteMessageDispatcher` (required) -- `org.eclipse.edc.protocol.dsp.http.spi.serialization.JsonLdRemoteMessageSerializer` (required) -- `org.eclipse.edc.spi.types.TypeManager` (required) -- `org.eclipse.edc.protocol.dsp.spi.transform.DspProtocolTypeTransformerRegistry` (required) -- `org.eclipse.edc.jsonld.spi.JsonLd` (required) -- `org.eclipse.edc.connector.controlplane.services.spi.protocol.RequestBasePathProvider` (required) - -Module `dsp-transfer-process-transform-2025` --------------------------------------------- -**Artifact:** org.eclipse.edc:dsp-transfer-process-transform-2025:0.18.0 - -**Categories:** _None_ - -### Extension points -_None_ - -### Extensions -#### Class: `org.eclipse.edc.protocol.dsp.transferprocess.transform.v2025.DspTransferProcessTransformV2025Extension` -**Name:** "Dataspace Protocol 2025/1 Transfer Process Transform Extension" - -**Overview:** Provides the transformers for DSP v2025/1 transferprocess message types via the {@link TypeTransformerRegistry}. - - - -### Configuration_None_ - -#### Provided services -_None_ - -#### Referenced (injected) services -- `org.eclipse.edc.transform.spi.TypeTransformerRegistry` (required) -- `org.eclipse.edc.spi.types.TypeManager` (required) - -Module `dsp-version-http-api` ------------------------------ -**Artifact:** org.eclipse.edc:dsp-version-http-api:0.18.0 - -**Categories:** _None_ - -### Extension points -_None_ - -### Extensions -#### Class: `org.eclipse.edc.protocol.dsp.version.http.api.DspVersionApiExtension` -**Name:** "Dataspace Protocol Version Api" - -**Overview:** Provide API for the protocol versions. - - - -### Configuration_None_ - -#### Provided services -_None_ - -#### Referenced (injected) services -- `org.eclipse.edc.web.spi.WebService` (required) -- `org.eclipse.edc.transform.spi.TypeTransformerRegistry` (required) -- `org.eclipse.edc.connector.controlplane.services.spi.protocol.VersionProtocolService` (required) -- `org.eclipse.edc.jsonld.spi.JsonLd` (required) -- `org.eclipse.edc.spi.types.TypeManager` (required) - -Module `edr-cache-api` ----------------------- -**Artifact:** org.eclipse.edc:edr-cache-api:0.18.0 - -**Categories:** _None_ - -### Extension points -_None_ - -### Extensions -#### Class: `org.eclipse.edc.connector.controlplane.api.management.edr.EdrCacheApiExtension` -**Name:** "Management API: EDR cache" - -**Overview:** No overview provided. - - -### Configuration_None_ - -#### Provided services -_None_ - -#### Referenced (injected) services -- `org.eclipse.edc.web.spi.WebService` (required) -- `org.eclipse.edc.transform.spi.TypeTransformerRegistry` (required) -- `org.eclipse.edc.validator.spi.JsonObjectValidatorRegistry` (required) -- `org.eclipse.edc.edr.spi.store.EndpointDataReferenceStore` (required) -- `org.eclipse.edc.spi.monitor.Monitor` (required) -- `org.eclipse.edc.jsonld.spi.JsonLd` (required) -- `org.eclipse.edc.spi.types.TypeManager` (required) - -Module `edr-index-sql` ----------------------- -**Artifact:** org.eclipse.edc:edr-index-sql:0.18.0 - -**Categories:** _None_ - -### Extension points -_None_ - -### Extensions -#### Class: `org.eclipse.edc.edr.store.index.SqlEndpointDataReferenceEntryIndexExtension` -**Name:** "SQL edr entry store" - -**Overview:** No overview provided. - - -### Configuration - -| Key | Required | Type | Default | Pattern | Min | Max | Description | -| ------------------------------ | -------- | -------- | --------- | ------- | --- | --- | ------------------------- | -| `edc.sql.store.edr.datasource` | `*` | `string` | `default` | | | | The datasource to be used | - -#### Provided services -- `org.eclipse.edc.edr.spi.store.EndpointDataReferenceEntryIndex` - -#### Referenced (injected) services -- `org.eclipse.edc.transaction.datasource.spi.DataSourceRegistry` (required) -- `org.eclipse.edc.transaction.spi.TransactionContext` (required) -- `org.eclipse.edc.edr.store.index.sql.schema.EndpointDataReferenceEntryStatements` (optional) -- `org.eclipse.edc.sql.QueryExecutor` (required) -- `org.eclipse.edc.spi.types.TypeManager` (required) -- `org.eclipse.edc.sql.bootstrapper.SqlSchemaBootstrapper` (required) - -Module `edr-store-core` ------------------------ -**Artifact:** org.eclipse.edc:edr-store-core:0.18.0 - -**Categories:** _None_ - -### Extension points -_None_ - -### Extensions -#### Class: `org.eclipse.edc.edr.store.EndpointDataReferenceStoreDefaultServicesExtension` -**Name:** "Endpoint Data Reference Core Default Services Extension" - -**Overview:** No overview provided. - - -### Configuration - -| Key | Required | Type | Default | Pattern | Min | Max | Description | -| -------------------- | -------- | -------- | ------- | ------- | --- | --- | -------------------------------------------------------------------------------------------------- | -| `edc.edr.vault.path` | | `string` | `` | | | | Directory/Path where to store EDRs in the vault for vaults that supports hierarchical structuring. | - -#### Provided services -- `org.eclipse.edc.edr.spi.store.EndpointDataReferenceCache` -- `org.eclipse.edc.edr.spi.store.EndpointDataReferenceEntryIndex` - -#### Referenced (injected) services -- `org.eclipse.edc.spi.query.CriterionOperatorRegistry` (required) -- `org.eclipse.edc.spi.security.Vault` (required) -- `org.eclipse.edc.spi.types.TypeManager` (required) - -#### Class: `org.eclipse.edc.edr.store.EndpointDataReferenceStoreExtension` -**Name:** "Endpoint Data Reference Core Extension" - -**Overview:** No overview provided. - - -### Configuration_None_ - -#### Provided services -- `org.eclipse.edc.edr.spi.store.EndpointDataReferenceStore` - -#### Referenced (injected) services -- `org.eclipse.edc.edr.spi.store.EndpointDataReferenceEntryIndex` (required) -- `org.eclipse.edc.edr.spi.store.EndpointDataReferenceCache` (required) -- `org.eclipse.edc.transaction.spi.TransactionContext` (required) - -Module `edr-store-receiver` ---------------------------- -**Artifact:** org.eclipse.edc:edr-store-receiver:0.18.0 - -**Categories:** _None_ - -### Extension points -_None_ - -### Extensions -#### Class: `org.eclipse.edc.connector.controlplane.edr.store.receiver.EndpointDataReferenceStoreReceiverExtension` -**Name:** "Endpoint Data Reference Store Receiver Extension" - -**Overview:** No overview provided. - - -### Configuration - -| Key | Required | Type | Default | Pattern | Min | Max | Description | -| ----------------------- | -------- | -------- | ------- | ------- | --- | --- | ------------------------------------------------------------------- | -| `edc.edr.receiver.sync` | `*` | `string` | `false` | | | | If true the EDR receiver will be registered as synchronous listener | - -#### Provided services -_None_ - -#### Referenced (injected) services -- `org.eclipse.edc.spi.event.EventRouter` (required) -- `org.eclipse.edc.edr.spi.store.EndpointDataReferenceStore` (required) -- `org.eclipse.edc.spi.monitor.Monitor` (required) -- `org.eclipse.edc.connector.controlplane.services.spi.contractagreement.ContractAgreementService` (required) -- `org.eclipse.edc.connector.controlplane.policy.spi.store.PolicyArchive` (required) -- `org.eclipse.edc.transaction.spi.TransactionContext` (required) - -Module `events-cloud-http` --------------------------- -**Artifact:** org.eclipse.edc:events-cloud-http:0.18.0 - -**Categories:** _None_ - -### Extension points -_None_ - -### Extensions -#### Class: `org.eclipse.edc.event.cloud.http.CloudEventsHttpExtension` -**Name:** "Cloud events HTTP" - -**Overview:** No overview provided. - - -### Configuration - -| Key | Required | Type | Default | Pattern | Min | Max | Description | -| --------------------------------- | -------- | -------- | ------- | ------- | --- | --- | ----------- | -| `edc.events.cloudevents.endpoint` | `*` | `string` | `` | | | | | - -#### Provided services -_None_ - -#### Referenced (injected) services -- `org.eclipse.edc.http.spi.EdcHttpClient` (required) -- `org.eclipse.edc.spi.event.EventRouter` (required) -- `org.eclipse.edc.spi.types.TypeManager` (required) -- `java.time.Clock` (required) -- `org.eclipse.edc.spi.system.Hostname` (required) - -Module `events-nats` --------------------- -**Artifact:** org.eclipse.edc:events-nats:0.18.0 - -**Categories:** _None_ - -### Extension points -_None_ - -### Extensions -#### Class: `org.eclipse.edc.event.nats.NatsPublishingExtension` -**Name:** "NATS Event Publishing Extension" - -**Overview:** No overview provided. - - -### Configuration - -| Key | Required | Type | Default | Pattern | Min | Max | Description | -| ------------------------------------- | -------- | -------- | ------- | ------- | --- | --- | -------------------------------------------------------------------------------- | -| `edc.events.nats.url` | `*` | `string` | `` | | | | The URL of the NATS server' | -| `edc.events.nats.stream` | `*` | `string` | `` | | | | The name of the NATS stream to use for event publishing' | -| `edc.events.nats.stream.create` | | `string` | `true` | | | | If the stream should be attempted to be created. May fail if the stream exists.' | -| `edc.events.nats.stream.create.force` | | `string` | `false` | | | | If the stream should be created, and overwritten if it exists' | - -#### Provided services -_None_ - -#### Referenced (injected) services -- `org.eclipse.edc.spi.event.EventRouter` (required) -- `org.eclipse.edc.spi.monitor.Monitor` (required) -- `io.nats.client.Options` (optional) -- `org.eclipse.edc.spi.types.TypeManager` (required) -- `org.eclipse.edc.spi.system.Hostname` (required) -- `org.eclipse.edc.spi.telemetry.Telemetry` (required) - -Module `federated-catalog-api` ------------------------------- -**Artifact:** org.eclipse.edc:federated-catalog-api:0.18.0 - -**Categories:** _None_ - -### Extension points -_None_ - -### Extensions -#### Class: `org.eclipse.edc.catalog.api.query.FederatedCatalogApiExtension` -**Name:** "Management API: Federated Catalog" - -**Overview:** No overview provided. - - -### Configuration_None_ - -#### Provided services -_None_ - -#### Referenced (injected) services -- `org.eclipse.edc.web.spi.WebService` (required) -- `org.eclipse.edc.catalog.spi.QueryService` (required) -- `org.eclipse.edc.jsonld.spi.JsonLd` (required) -- `org.eclipse.edc.spi.types.TypeManager` (required) -- `org.eclipse.edc.transform.spi.TypeTransformerRegistry` (required) -- `org.eclipse.edc.validator.spi.JsonObjectValidatorRegistry` (required) -- `org.eclipse.edc.participant.spi.ParticipantIdMapper` (required) - -Module `federated-catalog-cache-sql` ------------------------------------- -**Artifact:** org.eclipse.edc:federated-catalog-cache-sql:0.18.0 - -**Categories:** _None_ - -### Extension points -_None_ - -### Extensions -#### Class: `org.eclipse.edc.catalog.cache.sql.SqlFederatedCatalogCacheExtension` -**Name:** "SQL federated catalog cache" - -**Overview:** No overview provided. - - -### Configuration - -| Key | Required | Type | Default | Pattern | Min | Max | Description | -| ------------------------------------------- | -------- | -------- | --------- | ------- | --- | --- | ------------------------- | -| `edc.sql.store.federatedcatalog.datasource` | `*` | `string` | `default` | | | | The datasource to be used | - -#### Provided services -- `org.eclipse.edc.catalog.spi.FederatedCatalogCache` - -#### Referenced (injected) services -- `org.eclipse.edc.transaction.datasource.spi.DataSourceRegistry` (required) -- `org.eclipse.edc.transaction.spi.TransactionContext` (required) -- `org.eclipse.edc.catalog.cache.sql.FederatedCatalogCacheStatements` (optional) -- `org.eclipse.edc.spi.types.TypeManager` (required) -- `org.eclipse.edc.sql.QueryExecutor` (required) -- `org.eclipse.edc.sql.bootstrapper.SqlSchemaBootstrapper` (required) - -Module `federated-catalog-spi` ------------------------------- -**Name:** Catalog services -**Artifact:** org.eclipse.edc:federated-catalog-spi:0.18.0 - -**Categories:** _None_ - -### Extension points - - `org.eclipse.edc.catalog.spi.FederatedCatalogCache` - -### Extensions -Module `iam-mock` ------------------ -**Artifact:** org.eclipse.edc:iam-mock:0.18.0 - -**Categories:** _None_ - -### Extension points -_None_ - -### Extensions -#### Class: `org.eclipse.edc.iam.mock.IamMockExtension` -**Name:** "Mock IAM" - -**Overview:** An IAM provider mock used for testing. - - - -### Configuration - -| Key | Required | Type | Default | Pattern | Min | Max | Description | -| --------------------------- | -------- | -------- | ---------------- | ------- | --- | --- | ------------------------------------------------------------------------------------- | -| `edc.participant.id` | `*` | `string` | `` | | | | Configures the participant id this runtime is operating on behalf of | -| `edc.mock.faulty_client_id` | `*` | `string` | `faultyClientId` | | | | Configures the faulty participant id that the requests to fail (for testing purposes) | - -#### Provided services -- `org.eclipse.edc.spi.iam.IdentityService` -- `org.eclipse.edc.protocol.spi.DefaultParticipantIdExtractionFunction` -- `org.eclipse.edc.spi.iam.AudienceResolver` - -#### Referenced (injected) services -- `org.eclipse.edc.spi.types.TypeManager` (required) -- `org.eclipse.edc.participantcontext.spi.config.ParticipantContextConfig` (required) - -Module `identity-did-core` --------------------------- -**Artifact:** org.eclipse.edc:identity-did-core:0.18.0 - -**Categories:** _None_ - -### Extension points -_None_ - -### Extensions -#### Class: `org.eclipse.edc.iam.did.IdentityDidCoreExtension` -**Name:** "Identity Did Core" - -**Overview:** No overview provided. - - -### Configuration - -| Key | Required | Type | Default | Pattern | Min | Max | Description | -| ------------------------------- | -------- | -------- | -------- | ------- | --- | --- | ----------------------------------------------------- | -| `edc.did.resolver.cache.expiry` | `*` | `string` | `300000` | | | | Expiry time for caching DID Documents in milliseconds | - -#### Provided services -- `org.eclipse.edc.iam.did.spi.resolution.DidResolverRegistry` -- `org.eclipse.edc.iam.did.spi.resolution.DidPublicKeyResolver` - -#### Referenced (injected) services -- `org.eclipse.edc.keys.spi.KeyParserRegistry` (required) -- `java.time.Clock` (required) - -Module `identity-did-spi` -------------------------- -**Name:** IAM DID services -**Artifact:** org.eclipse.edc:identity-did-spi:0.18.0 - -**Categories:** _None_ - -### Extension points - - `org.eclipse.edc.iam.did.spi.resolution.DidPublicKeyResolver` - - `org.eclipse.edc.iam.did.spi.resolution.DidResolverRegistry` - - `org.eclipse.edc.iam.did.spi.credentials.CredentialsVerifier` - - `org.eclipse.edc.iam.did.spi.store.DidStore` - -### Extensions -Module `identity-did-web` -------------------------- -**Artifact:** org.eclipse.edc:identity-did-web:0.18.0 - -**Categories:** _None_ - -### Extension points -_None_ - -### Extensions -#### Class: `org.eclipse.edc.iam.did.web.WebDidExtension` -**Name:** "Web DID" - -**Overview:** Initializes support for resolving Web DIDs. - - - -### Configuration - -| Key | Required | Type | Default | Pattern | Min | Max | Description | -| --------------------------- | -------- | -------- | ------- | ------- | --- | --- | ----------- | -| `edc.webdid.doh.url` | `*` | `string` | `` | | | | | -| `edc.iam.did.web.use.https` | `*` | `string` | `` | | | | | - -#### Provided services -_None_ - -#### Referenced (injected) services -- `org.eclipse.edc.iam.did.spi.resolution.DidResolverRegistry` (required) -- `org.eclipse.edc.http.spi.EdcHttpClient` (required) -- `org.eclipse.edc.spi.types.TypeManager` (required) - -Module `jersey-core` --------------------- -**Artifact:** org.eclipse.edc:jersey-core:0.18.0 - -**Categories:** _None_ - -### Extension points -_None_ - -### Extensions -#### Class: `org.eclipse.edc.web.jersey.JerseyExtension` -**Name:** "JerseyExtension" - -### Configuration - -| Key | Required | Type | Default | Pattern | Min | Max | Description | -| --------------------------- | -------- | -------- | ------- | ------- | --- | --- | ----------- | -| `edc.web.rest.cors.origins` | `*` | `string` | `` | | | | | -| `edc.web.rest.cors.enabled` | `*` | `string` | `` | | | | | -| `edc.web.rest.cors.headers` | `*` | `string` | `` | | | | | -| `edc.web.rest.cors.methods` | `*` | `string` | `` | | | | | - -#### Provided services -- `org.eclipse.edc.web.spi.WebService` -- `org.eclipse.edc.web.spi.validation.InterceptorFunctionRegistry` - -#### Referenced (injected) services -- `org.eclipse.edc.web.spi.WebServer` (required) -- `org.eclipse.edc.spi.types.TypeManager` (required) - -Module `jersey-micrometer` --------------------------- -**Artifact:** org.eclipse.edc:jersey-micrometer:0.18.0 - -**Categories:** _None_ - -### Extension points -_None_ - -### Extensions -#### Class: `org.eclipse.edc.web.jersey.micrometer.JerseyMicrometerExtension` -**Name:** "JerseyMicrometerExtension" - -### Configuration - -| Key | Required | Type | Default | Pattern | Min | Max | Description | -| ---------------------------- | -------- | -------- | ------- | ------- | --- | --- | ----------- | -| `edc.metrics.enabled` | `*` | `string` | `` | | | | | -| `edc.metrics.jersey.enabled` | `*` | `string` | `` | | | | | - -#### Provided services -_None_ - -#### Referenced (injected) services -- `org.eclipse.edc.web.spi.WebService` (required) -- `io.micrometer.core.instrument.MeterRegistry` (required) - -Module `jetty-core` -------------------- -**Artifact:** org.eclipse.edc:jetty-core:0.18.0 - -**Categories:** _None_ - -### Extension points -_None_ - -### Extensions -#### Class: `org.eclipse.edc.web.jetty.JettyExtension` -**Name:** "JettyExtension" - -### Configuration - -| Key | Required | Type | Default | Pattern | Min | Max | Description | -| ----------------------------------- | -------- | -------- | ---------- | ------- | --- | --- | ---------------------------- | -| `edc.web.https.keystore.password` | `*` | `string` | `password` | | | | Keystore password | -| `edc.web.https.keymanager.password` | `*` | `string` | `password` | | | | Keymanager password | -| `web.http.port` | `*` | `string` | `8181` | | | | Port for default api context | -| `web.http.path` | `*` | `string` | `/api` | | | | Path for default api context | -| `edc.web.https.keystore.path` | | `string` | `` | | | | Keystore path | -| `edc.web.https.keystore.type` | `*` | `string` | `PKCS12` | | | | Keystore type | - -#### Provided services -- `org.eclipse.edc.web.spi.WebServer` -- `org.eclipse.edc.web.jetty.JettyService` -- `org.eclipse.edc.web.spi.configuration.PortMappingRegistry` - -#### Referenced (injected) services -_None_ - -Module `jetty-micrometer` -------------------------- -**Artifact:** org.eclipse.edc:jetty-micrometer:0.18.0 - -**Categories:** _None_ - -### Extension points -_None_ - -### Extensions -#### Class: `org.eclipse.edc.web.jetty.micrometer.JettyMicrometerExtension` -**Name:** "Jetty Micrometer Metrics" - -**Overview:** An extension that registers Micrometer {@link JettyConnectionMetrics} into Jetty to - provide server metrics. - - - -### Configuration - -| Key | Required | Type | Default | Pattern | Min | Max | Description | -| --------------------------- | -------- | -------- | ------- | ------- | --- | --- | ----------- | -| `edc.metrics.enabled` | `*` | `string` | `` | | | | | -| `edc.metrics.jetty.enabled` | `*` | `string` | `` | | | | | - -#### Provided services -_None_ - -#### Referenced (injected) services -- `org.eclipse.edc.web.jetty.JettyService` (required) -- `io.micrometer.core.instrument.MeterRegistry` (required) - -Module `json-ld` ----------------- -**Artifact:** org.eclipse.edc:json-ld:0.18.0 - -**Categories:** _None_ - -### Extension points -_None_ - -### Extensions -#### Class: `org.eclipse.edc.jsonld.JsonLdExtension` -**Name:** "JSON-LD Extension" - -**Overview:** Adds support for working with JSON-LD. Provides an ObjectMapper that works with Jakarta JSON-P - types through the TypeManager context {@link CoreConstants#JSON_LD} and a registry - for {@link JsonLdTransformer}s. The module also offers - functions for working with JSON-LD structures. - - - -### Configuration - -| Key | Required | Type | Default | Pattern | Min | Max | Description | -| ---------------------------------- | -------- | -------- | ------- | ------- | --- | --- | ----------------------------------------------------------------------------------------------- | -| `edc.jsonld.document..path` | `*` | `string` | `` | | | | Path of the JSON-LD document to cache | -| `edc.jsonld.document..url` | `*` | `string` | `` | | | | URL of the JSON-LD document to cache | -| `edc.jsonld.http.enabled` | `*` | `string` | `false` | | | | If set enable http json-ld document resolution | -| `edc.jsonld.https.enabled` | `*` | `string` | `false` | | | | If set enable https json-ld document resolution | -| `edc.jsonld.vocab.disable` | `*` | `string` | `false` | | | | If true disable the @vocab context definition. This could be used to avoid api breaking changes | -| `edc.jsonld.prefixes.check` | `*` | `string` | `true` | | | | If true a validation on expended object will be made against configured prefixes | - -#### Provided services -- `org.eclipse.edc.jsonld.spi.JsonLd` - -#### Referenced (injected) services -- `org.eclipse.edc.spi.types.TypeManager` (required) - -Module `jti-validation-store-sql` ---------------------------------- -**Artifact:** org.eclipse.edc:jti-validation-store-sql:0.18.0 - -**Categories:** _None_ - -### Extension points -_None_ - -### Extensions -#### Class: `org.eclipse.edc.jtivalidation.store.sql.SqlJtiValidationStoreExtension` -**Name:** "SQL JTI Validation store" - -**Overview:** No overview provided. - - -### Configuration - -| Key | Required | Type | Default | Pattern | Min | Max | Description | -| ------------------------------ | -------- | -------- | --------- | ------- | --- | --- | ------------------------- | -| `edc.sql.store.jti.datasource` | `*` | `string` | `default` | | | | The datasource to be used | - -#### Provided services -- `org.eclipse.edc.jwt.validation.jti.JtiValidationStore` - -#### Referenced (injected) services -- `org.eclipse.edc.transaction.datasource.spi.DataSourceRegistry` (required) -- `org.eclipse.edc.transaction.spi.TransactionContext` (required) -- `org.eclipse.edc.jtivalidation.store.sql.schema.JtiValidationStoreStatements` (optional) -- `org.eclipse.edc.sql.QueryExecutor` (required) -- `org.eclipse.edc.spi.types.TypeManager` (required) -- `org.eclipse.edc.sql.bootstrapper.SqlSchemaBootstrapper` (required) - -Module `management-api-authorization` -------------------------------------- -**Artifact:** org.eclipse.edc:management-api-authorization:0.18.0 - -**Categories:** _None_ - -### Extension points -_None_ - -### Extensions -#### Class: `org.eclipse.edc.connector.api.management.authz.ManagementApiAuthorizationExtension` -**Name:** "Management API Authorization Extension" - -**Overview:** No overview provided. - - -### Configuration_None_ - -#### Provided services -- `org.eclipse.edc.api.auth.spi.AuthorizationService` - -#### Referenced (injected) services -- `org.eclipse.edc.web.spi.WebService` (required) - -Module `management-api-configuration` -------------------------------------- -**Artifact:** org.eclipse.edc:management-api-configuration:0.18.0 - -**Categories:** _None_ - -### Extension points -_None_ - -### Extensions -#### Class: `org.eclipse.edc.connector.api.management.configuration.ManagementApiConfigurationExtension` -**Name:** "Management API configuration" - -**Overview:** Configure 'management' api context. - - - -### Configuration - -| Key | Required | Type | Default | Pattern | Min | Max | Description | -| -------------------------------- | -------- | -------- | ----------------- | ------- | --- | --- | --------------------------------------------------------------------------------------------------------------- | -| `web.http.management.port` | `*` | `string` | `8181` | | | | Port for management api context | -| `web.http.management.path` | `*` | `string` | `/api/management` | | | | Path for management api context | -| `edc.management.endpoint` | | `string` | `` | | | | Configures endpoint for reaching the Management API, in the format "" | -| `edc.management.context.enabled` | `*` | `string` | `false` | | | | If set enable the usage of management api JSON-LD context. | - -#### Provided services -- `org.eclipse.edc.web.spi.configuration.context.ManagementApiUrl` - -#### Referenced (injected) services -- `org.eclipse.edc.web.spi.WebService` (required) -- `org.eclipse.edc.web.spi.configuration.PortMappingRegistry` (required) -- `org.eclipse.edc.spi.types.TypeManager` (required) -- `org.eclipse.edc.jsonld.spi.JsonLd` (required) -- `org.eclipse.edc.transform.spi.TypeTransformerRegistry` (required) -- `org.eclipse.edc.participant.spi.ParticipantIdMapper` (required) -- `org.eclipse.edc.spi.system.Hostname` (required) -- `org.eclipse.edc.spi.query.CriterionOperatorRegistry` (required) -- `org.eclipse.edc.spi.system.apiversion.ApiVersionService` (required) - -Module `management-api-oauth2-authentication` ---------------------------------------------- -**Artifact:** org.eclipse.edc:management-api-oauth2-authentication:0.18.0 - -**Categories:** _None_ - -### Extension points -_None_ - -### Extensions -#### Class: `org.eclipse.edc.connector.api.management.authn.ManagementApiOauth2AuthenticationExtension` -**Name:** "Management API OAuth2 Authentication Extension" - -**Overview:** No overview provided. - - -### Configuration - -| Key | Required | Type | Default | Pattern | Min | Max | Description | -| ------------------------------------ | -------- | -------- | -------- | ------- | --- | --- | ---------------------------------------------------------- | -| `edc.iam.oauth2.issuer` | | `string` | `` | | | | Issuer of the OAuth2 server | -| `edc.iam.oauth2.jwks.url` | `*` | `string` | `` | | | | Absolute URL where the JWKS of the OAuth2 server is hosted | -| `edc.iam.oauth2.jwks.cache.validity` | `*` | `string` | `300000` | | | | Time (in ms) that cached JWKS are cached | - -#### Provided services -_None_ - -#### Referenced (injected) services -- `org.eclipse.edc.web.spi.WebService` (required) -- `java.time.Clock` (required) -- `org.eclipse.edc.keys.spi.KeyParserRegistry` (required) -- `org.eclipse.edc.participantcontext.spi.service.ParticipantContextService` (required) -- `org.eclipse.edc.token.spi.TokenValidationService` (required) -- `org.eclipse.edc.spi.monitor.Monitor` (required) - -Module `management-api-schema-validator` ----------------------------------------- -**Artifact:** org.eclipse.edc:management-api-schema-validator:0.18.0 - -**Categories:** _None_ - -### Extension points -_None_ - -### Extensions -#### Class: `org.eclipse.edc.connector.api.management.schema.ManagementApiSchemaValidatorExtension` -**Name:** "Management API Schema Validator" - -**Overview:** No overview provided. - - -### Configuration - -| Key | Required | Type | Default | Pattern | Min | Max | Description | -| ------------------------------------------------------------------ | -------- | -------- | ------- | ------- | --- | --- | --------------------------------------------------------------------------------------------------------------------------- | -| `edc.mgmt.api.schema..version` | `*` | `string` | `` | | | | Namespace prefix used when registering custom validators on JsonObjectValidatorRegistry, e.g. 'v4'. | -| `edc.mgmt.api.schema..mapping.from` | | `string` | `` | | | | Optional schema URL prefix to remap to a local location (paired with 'mapping.to'). | -| `edc.mgmt.api.schema..mapping.to` | | `string` | `` | | | | Optional local URI the schema prefix is remapped to, e.g. 'file:///path' or 'classpath:/path' (paired with 'mapping.from'). | -| `edc.mgmt.api.schema..validator..type` | `*` | `string` | `` | | | | JSON-LD @type term the schema is registered against. | -| `edc.mgmt.api.schema..validator..schema` | `*` | `string` | `` | | | | Absolute schema URL (resolved through 'mapping.from'/'mapping.to' when configured). | -| `edc.mgmt.api.schema..validator..profiles` | | `string` | `` | | | | Optional profile to associate with the validator in order to be activated | - -#### Provided services -_None_ - -#### Referenced (injected) services -- `org.eclipse.edc.spi.types.TypeManager` (required) -- `org.eclipse.edc.validator.spi.JsonObjectValidatorRegistry` (required) - -Module `micrometer-core` ------------------------- -**Artifact:** org.eclipse.edc:micrometer-core:0.18.0 - -**Categories:** _None_ - -### Extension points -_None_ - -### Extensions -#### Class: `org.eclipse.edc.metrics.micrometer.MicrometerExtension` -**Name:** "Micrometer Metrics" - -**Overview:** No overview provided. - - -### Configuration - -| Key | Required | Type | Default | Pattern | Min | Max | Description | -| ------------------------------ | -------- | -------- | ------- | ------- | --- | --- | ----------- | -| `edc.metrics.enabled` | `*` | `string` | `` | | | | | -| `edc.metrics.system.enabled` | `*` | `string` | `` | | | | | -| `edc.metrics.okhttp.enabled` | `*` | `string` | `` | | | | | -| `edc.metrics.executor.enabled` | `*` | `string` | `` | | | | | - -#### Provided services -- `okhttp3.EventListener` -- `org.eclipse.edc.spi.system.ExecutorInstrumentation` -- `io.micrometer.core.instrument.MeterRegistry` - -#### Referenced (injected) services -_None_ - -Module `negotiation-tasks-publisher-nats` ------------------------------------------ -**Artifact:** org.eclipse.edc:negotiation-tasks-publisher-nats:0.18.0 - -**Categories:** _None_ - -### Extension points -_None_ - -### Extensions -#### Class: `org.eclipse.edc.controlplane.tasks.publisher.nats.NegotiationTaskNatsPublisherExtension` -**Name:** "NegotiationTaskNatsPublisherExtension" - -### Configuration - -| Key | Required | Type | Default | Pattern | Min | Max | Description | -| -------------------------------------- | -------- | -------- | ----------------------- | ------- | --- | --- | ----------------------------------------------------------------------------------- | -| `edc.nats.cn.publisher.url` | `*` | `string` | `nats://localhost:4222` | | | | The URL of the NATS server to connect to for publishing contract negotiation tasks. | -| `edc.nats.cn.publisher.subject-prefix` | `*` | `string` | `negotiations` | | | | The prefix for the subjects | - -#### Provided services -_None_ - -#### Referenced (injected) services -- `org.eclipse.edc.spi.types.TypeManager` (required) -- `java.time.Clock` (required) -- `org.eclipse.edc.spi.monitor.Monitor` (required) -- `org.eclipse.edc.controlplane.tasks.TaskObservable` (required) - -Module `negotiation-tasks-subscriber-nats` ------------------------------------------- -**Artifact:** org.eclipse.edc:negotiation-tasks-subscriber-nats:0.18.0 - -**Categories:** _None_ - -### Extension points -_None_ - -### Extensions -#### Class: `org.eclipse.edc.virtual.controlplane.contract.negotiation.subscriber.NatsContractNegotiationSubscriberExtension` -**Name:** "NatsContractNegotiationSubscriberExtension" - -### Configuration - -| Key | Required | Type | Default | Pattern | Min | Max | Description | -| ------------------------------------ | -------- | -------- | ----------------------- | ------- | --- | --- | ---------------------------------------------------------------------------------- | -| `edc.nats.cn.subscriber.url` | `*` | `string` | `nats://localhost:4222` | | | | The URL of the NATS server to connect to for contract negotiation events. | -| `edc.nats.cn.subscriber.name` | `*` | `string` | `cn-subscriber` | | | | The name of the consumer for contract negotiation events | -| `edc.nats.cn.subscriber.autocreate` | `*` | `string` | `false` | | | | When true, it will automatically create the stream and the consumer if not present | -| `edc.nats.cn.subscriber.stream` | `*` | `string` | `cn-stream` | | | | The stream name where to attach the consumer | -| `edc.nats.cn.subscriber.subject` | `*` | `string` | `negotiations.>` | | | | The subject of the consumer for contract negotiation events | -| `edc.nats.cn.subscriber.batch-size` | `*` | `string` | `100` | | | | The size of the batch when fetching messages | -| `edc.nats.cn.subscriber.max-wait` | `*` | `string` | `100` | | | | The max waiting time for messages (ms) | -| `edc.nats.cn.subscriber.max-retries` | `*` | `string` | `3` | | | | Max retries for task execution failure on transient errors | - -#### Provided services -_None_ - -#### Referenced (injected) services -- `org.eclipse.edc.spi.types.TypeManager` (required) -- `org.eclipse.edc.controlplane.contract.spi.negotiation.ContractNegotiationTaskExecutor` (required) -- `org.eclipse.edc.spi.system.ExecutorInstrumentation` (required) -- `org.eclipse.edc.spi.monitor.Monitor` (required) -- `org.eclipse.edc.controlplane.tasks.TaskService` (required) -- `org.eclipse.edc.transaction.spi.TransactionContext` (required) -- `java.time.Clock` (required) - -Module `oauth2-client` ----------------------- -**Artifact:** org.eclipse.edc:oauth2-client:0.18.0 - -**Categories:** _None_ - -### Extension points -_None_ - -### Extensions -#### Class: `org.eclipse.edc.iam.oauth2.client.Oauth2ClientExtension` -**Name:** "OAuth2 Client" - -**Overview:** No overview provided. - - -### Configuration_None_ - -#### Provided services -- `org.eclipse.edc.iam.oauth2.spi.client.Oauth2Client` - -#### Referenced (injected) services -- `org.eclipse.edc.http.spi.EdcHttpClient` (required) -- `org.eclipse.edc.spi.types.TypeManager` (required) - -Module `oauth2-spi` -------------------- -**Name:** OAuth2 services -**Artifact:** org.eclipse.edc:oauth2-spi:0.18.0 - -**Categories:** _None_ - -### Extension points - - `org.eclipse.edc.iam.oauth2.spi.client.Oauth2Client` - -### Extensions -Module `otel-monitor` ---------------------- -**Artifact:** org.eclipse.edc:otel-monitor:0.18.0 - -**Categories:** _None_ - -### Extension points -_None_ - -### Extensions -#### Class: `org.eclipse.edc.monitor.opentelemetry.OtelMonitorExtension` -**Name:** "OpenTelemetry Monitor Extension" - -**Overview:** No overview provided. - - -### Configuration_None_ - -#### Provided services -_None_ - -#### Referenced (injected) services -_None_ - -Module `participant-context-api-v5` ------------------------------------ -**Artifact:** org.eclipse.edc:participant-context-api-v5:0.18.0 - -**Categories:** _None_ - -### Extension points -_None_ - -### Extensions -#### Class: `org.eclipse.edc.connector.controlplane.api.management.participantcontext.ParticipantContextManagementApiExtension` -**Name:** "ParticipantContext management API Extension" - -**Overview:** No overview provided. - - -### Configuration_None_ - -#### Provided services -_None_ - -#### Referenced (injected) services -- `org.eclipse.edc.web.spi.WebService` (required) -- `org.eclipse.edc.transform.spi.TypeTransformerRegistry` (required) -- `org.eclipse.edc.validator.spi.JsonObjectValidatorRegistry` (required) -- `org.eclipse.edc.jsonld.spi.JsonLd` (required) -- `org.eclipse.edc.spi.types.TypeManager` (required) -- `org.eclipse.edc.api.auth.spi.AuthorizationService` (required) -- `org.eclipse.edc.participantcontext.spi.service.ParticipantContextService` (required) -- `org.eclipse.edc.spi.monitor.Monitor` (required) - -Module `participant-context-config-api-v5` ------------------------------------------- -**Artifact:** org.eclipse.edc:participant-context-config-api-v5:0.18.0 - -**Categories:** _None_ - -### Extension points -_None_ - -### Extensions -#### Class: `org.eclipse.edc.connector.controlplane.api.management.participantcontext.config.ParticipantContextConfigManagementApiExtension` -**Name:** "ParticipantContext config management API Extension" - -**Overview:** No overview provided. - - -### Configuration_None_ - -#### Provided services -_None_ - -#### Referenced (injected) services -- `org.eclipse.edc.web.spi.WebService` (required) -- `org.eclipse.edc.transform.spi.TypeTransformerRegistry` (required) -- `org.eclipse.edc.validator.spi.JsonObjectValidatorRegistry` (required) -- `org.eclipse.edc.jsonld.spi.JsonLd` (required) -- `org.eclipse.edc.spi.types.TypeManager` (required) -- `org.eclipse.edc.participantcontext.spi.config.service.ParticipantContextConfigService` (required) - -Module `participant-context-config-core` ----------------------------------------- -**Artifact:** org.eclipse.edc:participant-context-config-core:0.18.0 - -**Categories:** _None_ - -### Extension points -_None_ - -### Extensions -#### Class: `org.eclipse.edc.participantcontext.config.ParticipantContextConfigServicesExtension` -**Name:** "Participant Context Config Services Extension" - -**Overview:** No overview provided. - - -### Configuration - -| Key | Required | Type | Default | Pattern | Min | Max | Description | -| ---------------------------------------------- | -------- | -------- | ------- | ------- | --- | --- | ----------------------------------------------------------------------------- | -| `edc.participants.config.encryption.algorithm` | | `string` | `` | | | | The encryption algorithm used for encrypting and decrypting sensitive config. | - -#### Provided services -- `org.eclipse.edc.participantcontext.spi.config.service.ParticipantContextConfigService` -- `org.eclipse.edc.participantcontext.spi.config.ParticipantContextConfig` - -#### Referenced (injected) services -- `org.eclipse.edc.participantcontext.spi.config.store.ParticipantContextConfigStore` (required) -- `org.eclipse.edc.transaction.spi.TransactionContext` (required) -- `org.eclipse.edc.encryption.EncryptionAlgorithmRegistry` (required) -- `org.eclipse.edc.spi.monitor.Monitor` (required) - -#### Class: `org.eclipse.edc.participantcontext.config.defaults.ParticipantContextConfigDefaultServicesExtension` -**Name:** "Participant Context Config Default Services Extension" - -**Overview:** No overview provided. - - -### Configuration_None_ - -#### Provided services -- `org.eclipse.edc.participantcontext.spi.config.store.ParticipantContextConfigStore` - -#### Referenced (injected) services -_None_ - -Module `participant-context-connector-classic-core` ---------------------------------------------------- -**Artifact:** org.eclipse.edc:participant-context-connector-classic-core:0.18.0 - -**Categories:** _None_ - -### Extension points -_None_ - -### Extensions -#### Class: `org.eclipse.edc.participantcontext.connector.ClassicParticipantContextDefaultServicesExtension` -**Name:** "Single Participant Context Default Services Extension" - -**Overview:** No overview provided. - - -### Configuration - -| Key | Required | Type | Default | Pattern | Min | Max | Description | -| ---------------------------- | -------- | -------- | ----------- | ------- | --- | --- | ------------------------------------------------------------------------ | -| `edc.participant.id` | `*` | `string` | `anonymous` | | | | Configures the participant id this runtime is operating on behalf of | -| `edc.participant.context.id` | | `string` | `` | | | | Configures the participant context id for the single participant runtime | - -#### Provided services -- `org.eclipse.edc.participantcontext.single.spi.SingleParticipantContextSupplier` -- `org.eclipse.edc.participantcontext.spi.config.store.ParticipantContextConfigStore` - -#### Referenced (injected) services -- `org.eclipse.edc.spi.monitor.Monitor` (required) - -#### Class: `org.eclipse.edc.participantcontext.connector.ClassicParticipantContextServicesExtension` -**Name:** "Classic Participant Context Services Extension" - -**Overview:** No overview provided. - - -### Configuration - -| Key | Required | Type | Default | Pattern | Min | Max | Description | -| ---------------------------- | -------- | -------- | ----------- | ------- | --- | --- | ------------------------------------------------------------------------ | -| `edc.participant.id` | `*` | `string` | `anonymous` | | | | Configures the participant id this runtime is operating on behalf of | -| `edc.participant.context.id` | | `string` | `` | | | | Configures the participant context id for the single participant runtime | - -#### Provided services -_None_ - -#### Referenced (injected) services -- `org.eclipse.edc.spi.monitor.Monitor` (required) -- `org.eclipse.edc.participantcontext.spi.store.ParticipantContextStore` (required) - -Module `participant-context-connector-core` -------------------------------------------- -**Artifact:** org.eclipse.edc:participant-context-connector-core:0.18.0 - -**Categories:** _None_ - -### Extension points -_None_ - -### Extensions -#### Class: `org.eclipse.edc.participantcontext.connector.ConnectorParticipantContextExtension` -**Name:** "Connector Participant Context Extension" - -**Overview:** No overview provided. - - -### Configuration - -| Key | Required | Type | Default | Pattern | Min | Max | Description | -| ----------------------------------- | -------- | -------- | ------- | ------- | --- | --- | ---------------------------------------------------------------------------------------------------------- | -| `edc.dataspace.enable.profiles.all` | `*` | `string` | `false` | | | | When running in virtual mode, enable all the participants to use all the profiles enabled in the connector | - -#### Provided services -- `org.eclipse.edc.protocol.spi.ProtocolWebhookResolver` -- `org.eclipse.edc.protocol.spi.ParticipantProfileService` -- `org.eclipse.edc.participantcontext.spi.identity.ParticipantIdentityResolver` - -#### Referenced (injected) services -- `org.eclipse.edc.protocol.spi.DataspaceProfileContextRegistry` (required) -- `org.eclipse.edc.participantcontext.spi.service.ParticipantContextService` (required) -- `org.eclipse.edc.participantcontext.spi.config.store.ParticipantContextConfigStore` (required) -- `org.eclipse.edc.transaction.spi.TransactionContext` (required) -- `org.eclipse.edc.spi.monitor.Monitor` (required) - -Module `participant-context-core` ---------------------------------- -**Artifact:** org.eclipse.edc:participant-context-core:0.18.0 - -**Categories:** _None_ - -### Extension points -_None_ - -### Extensions -#### Class: `org.eclipse.edc.participantcontext.ParticipantContextServicesExtension` -**Name:** "Participant Context Default Services Extension" - -**Overview:** No overview provided. - - -### Configuration_None_ - -#### Provided services -- `org.eclipse.edc.participantcontext.spi.service.ParticipantContextService` - -#### Referenced (injected) services -- `org.eclipse.edc.participantcontext.spi.store.ParticipantContextStore` (required) -- `org.eclipse.edc.transaction.spi.TransactionContext` (required) - -#### Class: `org.eclipse.edc.participantcontext.ParticipantContextDefaultServicesExtension` -**Name:** "Participant Context Default Services Extension" - -**Overview:** No overview provided. - - -### Configuration_None_ - -#### Provided services -- `org.eclipse.edc.participantcontext.spi.store.ParticipantContextStore` - -#### Referenced (injected) services -- `org.eclipse.edc.spi.query.CriterionOperatorRegistry` (required) - -Module `participantcontext-config-store-sql` --------------------------------------------- -**Artifact:** org.eclipse.edc:participantcontext-config-store-sql:0.18.0 - -**Categories:** _None_ - -### Extension points -_None_ - -### Extensions -#### Class: `org.eclipse.edc.connector.store.sql.participantcontext.config.SqlParticipantContextConfigStoreExtension` -**Name:** "ParticipantContextConfig SQL Store Extension" - -**Overview:** No overview provided. - - -### Configuration - -| Key | Required | Type | Default | Pattern | Min | Max | Description | -| --------------------------------------------------- | -------- | -------- | --------- | ------- | --- | --- | ------------------------- | -| `edc.sql.store.participantcontextconfig.datasource` | `*` | `string` | `default` | | | | The datasource to be used | - -#### Provided services -- `org.eclipse.edc.participantcontext.spi.config.store.ParticipantContextConfigStore` - -#### Referenced (injected) services -- `org.eclipse.edc.transaction.datasource.spi.DataSourceRegistry` (required) -- `org.eclipse.edc.transaction.spi.TransactionContext` (required) -- `org.eclipse.edc.spi.types.TypeManager` (required) -- `org.eclipse.edc.sql.QueryExecutor` (required) -- `org.eclipse.edc.connector.store.sql.participantcontext.config.ParticipantContextConfigStoreStatements` (optional) -- `org.eclipse.edc.sql.bootstrapper.SqlSchemaBootstrapper` (required) - -Module `participantcontext-store-sql` -------------------------------------- -**Artifact:** org.eclipse.edc:participantcontext-store-sql:0.18.0 - -**Categories:** _None_ - -### Extension points -_None_ - -### Extensions -#### Class: `org.eclipse.edc.connector.store.sql.participantcontext.SqlParticipantContextStoreExtension` -**Name:** "ParticipantContext SQL Store Extension" - -**Overview:** No overview provided. - - -### Configuration - -| Key | Required | Type | Default | Pattern | Min | Max | Description | -| --------------------------------------------- | -------- | -------- | --------- | ------- | --- | --- | ------------------------- | -| `edc.sql.store.participantcontext.datasource` | `*` | `string` | `default` | | | | The datasource to be used | - -#### Provided services -- `org.eclipse.edc.participantcontext.spi.store.ParticipantContextStore` - -#### Referenced (injected) services -- `org.eclipse.edc.transaction.datasource.spi.DataSourceRegistry` (required) -- `org.eclipse.edc.transaction.spi.TransactionContext` (required) -- `org.eclipse.edc.spi.types.TypeManager` (required) -- `org.eclipse.edc.sql.QueryExecutor` (required) -- `org.eclipse.edc.connector.store.sql.participantcontext.ParticipantContextStoreStatements` (optional) -- `org.eclipse.edc.sql.bootstrapper.SqlSchemaBootstrapper` (required) - -Module `policy-definition-api` ------------------------------- -**Artifact:** org.eclipse.edc:policy-definition-api:0.18.0 - -**Categories:** _None_ - -### Extension points -_None_ - -### Extensions -#### Class: `org.eclipse.edc.connector.controlplane.api.management.policy.PolicyDefinitionApiExtension` -**Name:** "Management API: Policy Definition" - -**Overview:** No overview provided. - - -### Configuration_None_ - -#### Provided services -_None_ - -#### Referenced (injected) services -- `org.eclipse.edc.transform.spi.TypeTransformerRegistry` (required) -- `org.eclipse.edc.web.spi.WebService` (required) -- `org.eclipse.edc.connector.controlplane.services.spi.policydefinition.PolicyDefinitionService` (required) -- `org.eclipse.edc.validator.spi.JsonObjectValidatorRegistry` (required) -- `org.eclipse.edc.spi.types.TypeManager` (required) -- `org.eclipse.edc.jsonld.spi.JsonLd` (required) -- `org.eclipse.edc.participantcontext.single.spi.SingleParticipantContextSupplier` (required) - -Module `policy-definition-api-v5` ---------------------------------- -**Artifact:** org.eclipse.edc:policy-definition-api-v5:0.18.0 - -**Categories:** _None_ - -### Extension points -_None_ - -### Extensions -#### Class: `org.eclipse.edc.connector.controlplane.api.management.policy.PolicyDefinitionApiV5Extension` -**Name:** "Management API: Policy Definition" - -**Overview:** No overview provided. - - -### Configuration_None_ - -#### Provided services -_None_ - -#### Referenced (injected) services -- `org.eclipse.edc.web.spi.WebService` (required) -- `org.eclipse.edc.transform.spi.TypeTransformerRegistry` (required) -- `org.eclipse.edc.connector.controlplane.services.spi.policydefinition.PolicyDefinitionService` (required) -- `org.eclipse.edc.validator.spi.JsonObjectValidatorRegistry` (required) -- `org.eclipse.edc.jsonld.spi.JsonLd` (required) -- `org.eclipse.edc.spi.types.TypeManager` (required) -- `org.eclipse.edc.api.auth.spi.AuthorizationService` (required) - -Module `policy-definition-store-sql` ------------------------------------- -**Artifact:** org.eclipse.edc:policy-definition-store-sql:0.18.0 - -**Categories:** _None_ - -### Extension points - - `org.eclipse.edc.connector.controlplane.store.sql.policydefinition.store.schema.SqlPolicyStoreStatements` - -### Extensions -#### Class: `org.eclipse.edc.connector.controlplane.store.sql.policydefinition.SqlPolicyStoreExtension` -**Name:** "SQL policy store" - -**Overview:** No overview provided. - - -### Configuration - -| Key | Required | Type | Default | Pattern | Min | Max | Description | -| --------------------------------- | -------- | -------- | --------- | ------- | --- | --- | ------------------------- | -| `edc.sql.store.policy.datasource` | `*` | `string` | `default` | | | | The datasource to be used | - -#### Provided services -- `org.eclipse.edc.connector.controlplane.policy.spi.store.PolicyDefinitionStore` - -#### Referenced (injected) services -- `org.eclipse.edc.transaction.datasource.spi.DataSourceRegistry` (required) -- `org.eclipse.edc.transaction.spi.TransactionContext` (required) -- `org.eclipse.edc.connector.controlplane.store.sql.policydefinition.store.schema.SqlPolicyStoreStatements` (optional) -- `org.eclipse.edc.spi.types.TypeManager` (required) -- `org.eclipse.edc.sql.QueryExecutor` (required) -- `org.eclipse.edc.sql.bootstrapper.SqlSchemaBootstrapper` (required) - -Module `policy-engine-spi` --------------------------- -**Name:** Policy Engine services -**Artifact:** org.eclipse.edc:policy-engine-spi:0.18.0 - -**Categories:** _None_ - -### Extension points - - `org.eclipse.edc.policy.engine.spi.PolicyEngine` - - `org.eclipse.edc.policy.engine.spi.RuleBindingRegistry` - -### Extensions -Module `policy-monitor-core` ----------------------------- -**Artifact:** org.eclipse.edc:policy-monitor-core:0.18.0 - -**Categories:** _None_ - -### Extension points -_None_ - -### Extensions -#### Class: `org.eclipse.edc.connector.policy.monitor.PolicyMonitorExtension` -**Name:** "Policy Monitor" - -**Overview:** No overview provided. - - -### Configuration - -| Key | Required | Type | Default | Pattern | Min | Max | Description | -| ------------------------------- | -------- | -------- | ------- | ------- | --- | --- | --------------------------------------------------------------------------- | -| `edc.policy.monitor.batch-size` | `*` | `string` | `20` | | | | The number of policy monitor entries to be evaluated on every watchdog run. | -| `edc.policy.monitor.period` | `*` | `string` | `PT1H` | | | | Time period between policy monitor evaluations in ISO-8061 duration format. | - -#### Provided services -- `org.eclipse.edc.connector.policy.monitor.spi.PolicyMonitorManager` - -#### Referenced (injected) services -- `org.eclipse.edc.spi.system.ExecutorInstrumentation` (required) -- `org.eclipse.edc.spi.telemetry.Telemetry` (required) -- `java.time.Clock` (required) -- `org.eclipse.edc.spi.event.EventRouter` (required) -- `org.eclipse.edc.connector.controlplane.services.spi.contractagreement.ContractAgreementService` (required) -- `org.eclipse.edc.policy.engine.spi.PolicyEngine` (required) -- `org.eclipse.edc.connector.controlplane.services.spi.transferprocess.TransferProcessService` (required) -- `org.eclipse.edc.connector.policy.monitor.spi.PolicyMonitorStore` (required) -- `org.eclipse.edc.policy.engine.spi.RuleBindingRegistry` (required) -- `org.eclipse.edc.transaction.spi.TransactionContext` (required) - -#### Class: `org.eclipse.edc.connector.policy.monitor.PolicyMonitorDefaultServicesExtension` -**Name:** "PolicyMonitor Default Services" - -**Overview:** No overview provided. - - -### Configuration_None_ - -#### Provided services -- `org.eclipse.edc.connector.policy.monitor.spi.PolicyMonitorStore` - -#### Referenced (injected) services -- `java.time.Clock` (required) -- `org.eclipse.edc.spi.query.CriterionOperatorRegistry` (required) - -Module `policy-monitor-store-sql` ---------------------------------- -**Artifact:** org.eclipse.edc:policy-monitor-store-sql:0.18.0 - -**Categories:** _None_ - -### Extension points -_None_ - -### Extensions -#### Class: `org.eclipse.edc.connector.policy.monitor.store.sql.SqlPolicyMonitorStoreExtension` -**Name:** "SqlPolicyMonitorStoreExtension" - -### Configuration - -| Key | Required | Type | Default | Pattern | Min | Max | Description | -| ----------------------------------------- | -------- | -------- | --------- | ------- | --- | --- | ------------------------- | -| `edc.sql.store.policy-monitor.datasource` | `*` | `string` | `default` | | | | The datasource to be used | - -#### Provided services -- `org.eclipse.edc.connector.policy.monitor.spi.PolicyMonitorStore` - -#### Referenced (injected) services -- `org.eclipse.edc.transaction.datasource.spi.DataSourceRegistry` (required) -- `org.eclipse.edc.transaction.spi.TransactionContext` (required) -- `org.eclipse.edc.connector.policy.monitor.store.sql.schema.PolicyMonitorStatements` (optional) -- `java.time.Clock` (required) -- `org.eclipse.edc.spi.types.TypeManager` (required) -- `org.eclipse.edc.sql.QueryExecutor` (required) -- `org.eclipse.edc.sql.bootstrapper.SqlSchemaBootstrapper` (required) -- `org.eclipse.edc.sql.lease.spi.SqlLeaseContextBuilderProvider` (required) -- `org.eclipse.edc.sql.lease.spi.LeaseStatements` (required) - -Module `policy-spi` -------------------- -**Name:** Policy services -**Artifact:** org.eclipse.edc:policy-spi:0.18.0 - -**Categories:** _None_ - -### Extension points - - `org.eclipse.edc.connector.controlplane.policy.spi.store.PolicyArchive` - - `org.eclipse.edc.connector.controlplane.policy.spi.store.PolicyDefinitionStore` - -### Extensions -Module `runtime-core` ---------------------- -**Artifact:** org.eclipse.edc:runtime-core:0.18.0 - -**Categories:** _None_ - -### Extension points -_None_ - -### Extensions -#### Class: `org.eclipse.edc.runtime.core.RuntimeDefaultCoreServicesExtension` -**Name:** "Runtime Default Core Services" - -**Overview:** No overview provided. - - -### Configuration - -| Key | Required | Type | Default | Pattern | Min | Max | Description | -| ---------------------------------------- | -------- | -------- | ------- | ------- | --- | --- | ------------------------------------------------------------------- | -| `edc.core.retry.retries.max` | `*` | `string` | `5` | | | | RetryPolicy: Maximum retries before a failure is propagated | -| `edc.core.retry.backoff.min` | `*` | `string` | `500` | | | | RetryPolicy: Minimum number of milliseconds for exponential backoff | -| `edc.core.retry.backoff.max` | `*` | `string` | `10000` | | | | RetryPolicy: Maximum number of milliseconds for exponential backoff | -| `edc.core.retry.log.on.retry` | `*` | `string` | `false` | | | | RetryPolicy: Log onRetry events | -| `edc.core.retry.log.on.retry.scheduled` | `*` | `string` | `false` | | | | RetryPolicy: Log onRetryScheduled events | -| `edc.core.retry.log.on.retries.exceeded` | `*` | `string` | `false` | | | | RetryPolicy: Log onRetriesExceeded events | -| `edc.core.retry.log.on.failed.attempt` | `*` | `string` | `false` | | | | RetryPolicy: Log onFailedAttempt events | -| `edc.core.retry.log.on.abort` | `*` | `string` | `false` | | | | RetryPolicy: Log onAbort events | -| `edc.http.client.https.enforce` | `*` | `string` | `false` | | | | OkHttpClient: If true, enable HTTPS call enforcement | -| `edc.http.client.timeout.connect` | `*` | `string` | `30` | | | | OkHttpClient: connect timeout, in seconds | -| `edc.http.client.timeout.read` | `*` | `string` | `30` | | | | OkHttpClient: read timeout, in seconds | -| `edc.http.client.send.buffer.size` | `*` | `string` | `0` | | | | OkHttpClient: send buffer size, in bytes | -| `edc.http.client.receive.buffer.size` | `*` | `string` | `0` | | | | OkHttpClient: receive buffer size, in bytes | - -#### Provided services -- `org.eclipse.edc.transaction.spi.TransactionContext` -- `org.eclipse.edc.transaction.datasource.spi.DataSourceRegistry` -- `dev.failsafe.RetryPolicy` -- `okhttp3.OkHttpClient` -- `org.eclipse.edc.spi.types.TypeManager` - -#### Referenced (injected) services -- `okhttp3.EventListener` (optional) - -#### Class: `org.eclipse.edc.runtime.core.RuntimeCoreServicesExtension` -**Name:** "Runtime Default Core Services" - -**Overview:** No overview provided. - - -### Configuration - -| Key | Required | Type | Default | Pattern | Min | Max | Description | -| -------------- | -------- | -------- | ----------- | ------- | --- | --- | ---------------------------------------------------- | -| `edc.hostname` | `*` | `string` | `localhost` | | | | Runtime hostname, which e.g. is used in referer urls | - -#### Provided services -- `org.eclipse.edc.spi.system.Hostname` -- `org.eclipse.edc.http.spi.EdcHttpClient` -- `org.eclipse.edc.spi.command.CommandHandlerRegistry` -- `org.eclipse.edc.spi.event.EventRouter` -- `org.eclipse.edc.transform.spi.TypeTransformerRegistry` -- `org.eclipse.edc.validator.spi.JsonObjectValidatorRegistry` -- `org.eclipse.edc.spi.query.CriterionOperatorRegistry` -- `org.eclipse.edc.encryption.EncryptionAlgorithmRegistry` -- `org.eclipse.edc.spi.system.apiversion.ApiVersionService` - -#### Referenced (injected) services -- `okhttp3.OkHttpClient` (required) -- `dev.failsafe.RetryPolicy` (required) -- `java.time.Clock` (required) -- `org.eclipse.edc.spi.types.TypeManager` (required) - -Module `secrets-api` --------------------- -**Artifact:** org.eclipse.edc:secrets-api:0.18.0 - -**Categories:** _None_ - -### Extension points -_None_ - -### Extensions -#### Class: `org.eclipse.edc.connector.api.management.secret.SecretsApiExtension` -**Name:** "Management API: Secret" - -**Overview:** No overview provided. - - -### Configuration_None_ - -#### Provided services -_None_ - -#### Referenced (injected) services -- `org.eclipse.edc.web.spi.WebService` (required) -- `org.eclipse.edc.transform.spi.TypeTransformerRegistry` (required) -- `org.eclipse.edc.connector.spi.service.SecretService` (required) -- `org.eclipse.edc.validator.spi.JsonObjectValidatorRegistry` (required) -- `org.eclipse.edc.jsonld.spi.JsonLd` (required) -- `org.eclipse.edc.spi.types.TypeManager` (required) - -Module `signaling-data-plane` ------------------------------ -**Artifact:** org.eclipse.edc:signaling-data-plane:0.18.0 - -**Categories:** _None_ - -### Extension points -_None_ - -### Extensions -#### Class: `org.eclipse.edc.test.runtime.signaling.SignalingDataPlaneRuntimeExtension` -**Name:** "SignalingDataPlaneRuntimeExtension" - -### Configuration - -| Key | Required | Type | Default | Pattern | Min | Max | Description | -| --------------- | -------- | -------- | ------- | ------- | --- | --- | ----------- | -| `web.http.path` | `*` | `string` | `` | | | | | -| `web.http.port` | `*` | `string` | `` | | | | | -| `dataplane.id` | `*` | `string` | `` | | | | | - -#### Provided services -_None_ - -#### Referenced (injected) services -- `org.eclipse.edc.web.spi.WebService` (required) -- `org.eclipse.edc.spi.monitor.Monitor` (required) - -Module `sql-bootstrapper` -------------------------- -**Artifact:** org.eclipse.edc:sql-bootstrapper:0.18.0 - -**Categories:** _sql, persistence, storage, sql, persistence, storage_ - -### Extension points -_None_ - -### Extensions -#### Class: `org.eclipse.edc.sql.bootstrapper.SqlSchemaBootstrapperExtension` -**Name:** "SQL Schema Bootstrapper Extension" - -**Overview:** No overview provided. - - -### Configuration - -| Key | Required | Type | Default | Pattern | Min | Max | Description | -| --------------------------- | -------- | -------- | ------- | ------- | --- | --- | --------------------------------------------------------------------------------------------------- | -| `edc.sql.schema.autocreate` | | `string` | `false` | | | | When true, the schema for the sql stores will be created automatically on the configured datasource | - -#### Provided services -- `org.eclipse.edc.sql.bootstrapper.SqlSchemaBootstrapper` - -#### Referenced (injected) services -- `org.eclipse.edc.transaction.spi.TransactionContext` (required) -- `org.eclipse.edc.sql.QueryExecutor` (required) -- `org.eclipse.edc.transaction.datasource.spi.DataSourceRegistry` (required) -- `org.eclipse.edc.spi.monitor.Monitor` (required) - -Module `sql-core` ------------------ -**Artifact:** org.eclipse.edc:sql-core:0.18.0 - -**Categories:** _None_ - -### Extension points -_None_ - -### Extensions -#### Class: `org.eclipse.edc.sql.SqlCoreExtension` -**Name:** "SQL Core" - -**Overview:** No overview provided. - - -### Configuration - -| Key | Required | Type | Default | Pattern | Min | Max | Description | -| -------------------- | -------- | -------- | ------- | ------- | --- | --- | ------------------------------------ | -| `edc.sql.fetch.size` | `*` | `string` | `5000` | | | | Fetch size value used in SQL queries | - -#### Provided services -- `org.eclipse.edc.sql.QueryExecutor` -- `org.eclipse.edc.sql.ConnectionFactory` - -#### Referenced (injected) services -- `org.eclipse.edc.transaction.spi.TransactionContext` (required) - -Module `sql-lease-core` ------------------------ -**Artifact:** org.eclipse.edc:sql-lease-core:0.18.0 - -**Categories:** _None_ - -### Extension points -_None_ - -### Extensions -#### Class: `org.eclipse.edc.sql.lease.SqlLeaseStatementsExtension` -**Name:** "SQL Lease Statements" - -**Overview:** No overview provided. - - -### Configuration_None_ - -#### Provided services -- `org.eclipse.edc.sql.lease.spi.LeaseStatements` - -#### Referenced (injected) services -_None_ - -#### Class: `org.eclipse.edc.sql.lease.SqlLeaseCoreExtension` -**Name:** "SQL Lease Core" - -**Overview:** No overview provided. - - -### Configuration_None_ - -#### Provided services -- `org.eclipse.edc.sql.lease.spi.SqlLeaseContextBuilderProvider` - -#### Referenced (injected) services -- `org.eclipse.edc.transaction.spi.TransactionContext` (required) -- `java.time.Clock` (required) -- `org.eclipse.edc.sql.QueryExecutor` (required) -- `org.eclipse.edc.sql.lease.spi.LeaseStatements` (required) - -Module `sql-pool-apache-commons` --------------------------------- -**Artifact:** org.eclipse.edc:sql-pool-apache-commons:0.18.0 - -**Categories:** _None_ - -### Extension points -_None_ - -### Extensions -#### Class: `org.eclipse.edc.sql.pool.commons.CommonsConnectionPoolServiceExtension` -**Name:** "Commons Connection Pool" - -**Overview:** No overview provided. - - -### Configuration - -| Key | Required | Type | Default | Pattern | Min | Max | Description | -| -------------------------------------------------------- | -------- | -------- | ------- | ------- | --- | --- | --------------------------------------------------------------------------------------------------------------------------- | -| `edc.datasource..url` | | `string` | `` | | | | JDBC url | -| `edc.datasource..user` | | `string` | `` | | | | Username to be used for the JDBC connection. Can be omitted if not required, or if the user is encoded in the JDBC url. | -| `edc.datasource..password` | | `string` | `` | | | | Username to be used for the JDBC connection. Can be omitted if not required, or if the password is encoded in the JDBC url. | -| `edc.datasource..pool.connections.max-idle` | | `string` | `` | | | | Pool max idle connections | -| `edc.datasource..pool.connections.max-total` | | `string` | `` | | | | Pool max total connections | -| `edc.datasource..pool.connections.min-idle` | | `string` | `` | | | | Pool min idle connections | -| `edc.datasource..pool.connection.test.on-borrow` | | `string` | `` | | | | Pool test on borrow | -| `edc.datasource..pool.connection.test.on-create` | | `string` | `` | | | | Pool test on create | -| `edc.datasource..pool.connection.test.on-return` | | `string` | `` | | | | Pool test on return | -| `edc.datasource..pool.connection.test.while-idle` | | `string` | `` | | | | Pool test while idle | -| `edc.datasource..pool.connection.test.query` | | `string` | `` | | | | Pool test query | - -#### Provided services -_None_ - -#### Referenced (injected) services -- `org.eclipse.edc.transaction.datasource.spi.DataSourceRegistry` (required) -- `org.eclipse.edc.spi.monitor.Monitor` (required) -- `org.eclipse.edc.sql.ConnectionFactory` (required) -- `org.eclipse.edc.spi.security.Vault` (required) - -Module `target-node-directory-sql` ----------------------------------- -**Artifact:** org.eclipse.edc:target-node-directory-sql:0.18.0 - -**Categories:** _None_ - -### Extension points -_None_ - -### Extensions -#### Class: `org.eclipse.edc.catalog.directory.sql.SqlTargetNodeDirectoryExtension` -**Name:** "SQL target node directory" - -**Overview:** No overview provided. - - -### Configuration - -| Key | Required | Type | Default | Pattern | Min | Max | Description | -| ---------------------------------------------- | -------- | -------- | --------- | ------- | --- | --- | ------------------------- | -| `edc.sql.store.targetnodedirectory.datasource` | `*` | `string` | `default` | | | | The datasource to be used | - -#### Provided services -- `org.eclipse.edc.crawler.spi.TargetNodeDirectory` - -#### Referenced (injected) services -- `org.eclipse.edc.transaction.datasource.spi.DataSourceRegistry` (required) -- `org.eclipse.edc.transaction.spi.TransactionContext` (required) -- `org.eclipse.edc.catalog.directory.sql.TargetNodeStatements` (optional) -- `org.eclipse.edc.spi.types.TypeManager` (required) -- `org.eclipse.edc.sql.QueryExecutor` (required) -- `org.eclipse.edc.sql.bootstrapper.SqlSchemaBootstrapper` (required) - -Module `task-core` ------------------- -**Artifact:** org.eclipse.edc:task-core:0.18.0 - -**Categories:** _None_ - -### Extension points -_None_ - -### Extensions -#### Class: `org.eclipse.edc.controlplane.tasks.defaults.TasksDefaultServicesExtension` -**Name:** "Tasks Default Services" - -**Overview:** No overview provided. - - -### Configuration_None_ - -#### Provided services -- `org.eclipse.edc.controlplane.tasks.store.TaskStore` - -#### Referenced (injected) services -- `org.eclipse.edc.spi.query.CriterionOperatorRegistry` (required) - -#### Class: `org.eclipse.edc.controlplane.tasks.TasksServicesExtension` -**Name:** "Tasks Core Services" - -**Overview:** No overview provided. - - -### Configuration_None_ - -#### Provided services -- `org.eclipse.edc.controlplane.tasks.TaskService` -- `org.eclipse.edc.controlplane.tasks.TaskObservable` - -#### Referenced (injected) services -- `org.eclipse.edc.controlplane.tasks.store.TaskStore` (required) -- `org.eclipse.edc.transaction.spi.TransactionContext` (required) -- `org.eclipse.edc.spi.types.TypeManager` (required) - -Module `task-store-sql` ------------------------ -**Artifact:** org.eclipse.edc:task-store-sql:0.18.0 - -**Categories:** _None_ - -### Extension points -_None_ - -### Extensions -#### Class: `org.eclipse.edc.controlplane.tasks.sql.SqlTaskStoreExtension` -**Name:** "Tasks SQL Store Extension" - -**Overview:** No overview provided. - - -### Configuration - -| Key | Required | Type | Default | Pattern | Min | Max | Description | -| -------------------------------- | -------- | -------- | --------- | ------- | --- | --- | ------------------------- | -| `edc.sql.store.tasks.datasource` | `*` | `string` | `default` | | | | The datasource to be used | - -#### Provided services -- `org.eclipse.edc.controlplane.tasks.store.TaskStore` - -#### Referenced (injected) services -- `org.eclipse.edc.transaction.datasource.spi.DataSourceRegistry` (required) -- `org.eclipse.edc.transaction.spi.TransactionContext` (required) -- `org.eclipse.edc.spi.types.TypeManager` (required) -- `org.eclipse.edc.sql.QueryExecutor` (required) -- `org.eclipse.edc.controlplane.tasks.sql.TaskStatements` (optional) -- `org.eclipse.edc.sql.bootstrapper.SqlSchemaBootstrapper` (required) - -Module `tasks-tck-extension` ----------------------------- -**Artifact:** org.eclipse.edc:tasks-tck-extension:0.18.0 - -**Categories:** _None_ - -### Extension points -_None_ - -### Extensions -#### Class: `org.eclipse.edc.tasks.tck.dsp.controller.TckControllerExtension` -**Name:** "TckControllerExtension" - -**Overview:** Loads customizations and seed data for the TCK. - - - -### Configuration - -| Key | Required | Type | Default | Pattern | Min | Max | Description | -| ------------------- | -------- | -------- | ------- | ------- | --- | --- | ------------------------ | -| `web.http.tck.port` | `*` | `string` | `8687` | | | | Port for tck api context | -| `web.http.tck.path` | `*` | `string` | `/tck` | | | | Path for tck api context | - -#### Provided services -_None_ - -#### Referenced (injected) services -- `org.eclipse.edc.web.spi.configuration.PortMappingRegistry` (required) -- `org.eclipse.edc.web.spi.WebService` (required) -- `org.eclipse.edc.web.spi.WebServer` (required) -- `org.eclipse.edc.connector.controlplane.services.spi.contractnegotiation.ContractNegotiationService` (required) -- `org.eclipse.edc.connector.controlplane.services.spi.transferprocess.TransferProcessService` (required) -- `org.eclipse.edc.participantcontext.spi.service.ParticipantContextService` (required) -- `org.eclipse.edc.spi.monitor.Monitor` (required) - -#### Class: `org.eclipse.edc.tasks.tck.dsp.setup.TckSetupExtension` -**Name:** "DSP TCK Setup" - -**Overview:** Loads customizations and seed data for the TCK. - - - -### Configuration - -| Key | Required | Type | Default | Pattern | Min | Max | Description | -| ---------------------------- | -------- | -------- | ---------------------- | ------- | --- | --- | --------------------------------------------------------------- | -| `edc.participant.context.id` | `*` | `string` | `participantContextId` | | | | Configures the participant context id for the tck suite runtime | - -#### Provided services -_None_ - -#### Referenced (injected) services -- `org.eclipse.edc.connector.controlplane.asset.spi.index.AssetIndex` (required) -- `org.eclipse.edc.connector.controlplane.services.spi.policydefinition.PolicyDefinitionService` (required) -- `org.eclipse.edc.connector.controlplane.services.spi.contractdefinition.ContractDefinitionService` (required) -- `org.eclipse.edc.connector.controlplane.contract.spi.negotiation.store.ContractNegotiationStore` (required) -- `org.eclipse.edc.participantcontext.spi.service.ParticipantContextService` (required) -- `org.eclipse.edc.participantcontext.spi.config.service.ParticipantContextConfigService` (required) -- `org.eclipse.edc.spi.monitor.Monitor` (required) - -#### Class: `org.eclipse.edc.tasks.tck.dsp.guard.TckGuardExtension` -**Name:** "TckGuardExtension" - -**Overview:** Loads customizations and seed data for the TCK. - - - -### Configuration_None_ - -#### Provided services -- `org.eclipse.edc.connector.controlplane.contract.spi.negotiation.ContractNegotiationPendingGuard` -- `org.eclipse.edc.connector.controlplane.transfer.spi.TransferProcessPendingGuard` - -#### Referenced (injected) services -- `org.eclipse.edc.connector.controlplane.contract.spi.negotiation.store.ContractNegotiationStore` (required) -- `org.eclipse.edc.connector.controlplane.transfer.spi.store.TransferProcessStore` (required) -- `org.eclipse.edc.transaction.spi.TransactionContext` (required) -- `org.eclipse.edc.spi.event.EventRouter` (required) -- `org.eclipse.edc.spi.monitor.Monitor` (required) -- `org.eclipse.edc.controlplane.tasks.TaskService` (required) -- `java.time.Clock` (required) - -#### Class: `org.eclipse.edc.tasks.tck.dsp.transfer.TckDataPlaneExtension` -**Name:** "TckDataPlaneExtension" - -**Overview:** Loads customizations and seed data for the TCK. - - - -### Configuration_None_ - -#### Provided services -- `org.eclipse.edc.connector.controlplane.transfer.spi.flow.DataFlowController` - -#### Referenced (injected) services -_None_ - -Module `tck-extension` ----------------------- -**Artifact:** org.eclipse.edc:tck-extension:0.18.0 - -**Categories:** _None_ - -### Extension points -_None_ - -### Extensions -#### Class: `org.eclipse.edc.tck.dsp.guard.TckGuardExtension` -**Name:** "TckGuardExtension" - -**Overview:** Loads customizations and seed data for the TCK. - - - -### Configuration_None_ - -#### Provided services -- `org.eclipse.edc.connector.controlplane.contract.spi.negotiation.ContractNegotiationPendingGuard` -- `org.eclipse.edc.connector.controlplane.transfer.spi.TransferProcessPendingGuard` - -#### Referenced (injected) services -- `org.eclipse.edc.connector.controlplane.contract.spi.negotiation.store.ContractNegotiationStore` (required) -- `org.eclipse.edc.connector.controlplane.transfer.spi.store.TransferProcessStore` (required) -- `org.eclipse.edc.transaction.spi.TransactionContext` (required) -- `org.eclipse.edc.spi.event.EventRouter` (required) -- `org.eclipse.edc.spi.monitor.Monitor` (required) - -#### Class: `org.eclipse.edc.tck.dsp.transfer.TckDataPlaneExtension` -**Name:** "TckDataPlaneExtension" - -**Overview:** Loads customizations and seed data for the TCK. - - - -### Configuration_None_ - -#### Provided services -- `org.eclipse.edc.connector.controlplane.transfer.spi.flow.DataFlowController` - -#### Referenced (injected) services -_None_ - -#### Class: `org.eclipse.edc.tck.dsp.identity.TckIdentityExtension` -**Name:** "TckIdentityExtension" - -**Overview:** Loads customizations and seed data for the TCK. - - - -### Configuration_None_ - -#### Provided services -- `org.eclipse.edc.spi.iam.IdentityService` -- `org.eclipse.edc.protocol.spi.DefaultParticipantIdExtractionFunction` -- `org.eclipse.edc.spi.iam.AudienceResolver` - -#### Referenced (injected) services -_None_ - -#### Class: `org.eclipse.edc.tck.dsp.controller.TckControllerExtension` -**Name:** "TckControllerExtension" - -**Overview:** Loads customizations and seed data for the TCK. - - - -### Configuration - -| Key | Required | Type | Default | Pattern | Min | Max | Description | -| ------------------- | -------- | -------- | ------- | ------- | --- | --- | ------------------------ | -| `web.http.tck.port` | `*` | `string` | `8687` | | | | Port for tck api context | -| `web.http.tck.path` | `*` | `string` | `/tck` | | | | Path for tck api context | - -#### Provided services -_None_ - -#### Referenced (injected) services -- `org.eclipse.edc.web.spi.configuration.PortMappingRegistry` (required) -- `org.eclipse.edc.web.spi.WebService` (required) -- `org.eclipse.edc.connector.controlplane.services.spi.contractnegotiation.ContractNegotiationService` (required) -- `org.eclipse.edc.connector.controlplane.services.spi.transferprocess.TransferProcessService` (required) -- `org.eclipse.edc.spi.monitor.Monitor` (required) -- `org.eclipse.edc.participantcontext.single.spi.SingleParticipantContextSupplier` (required) - -#### Class: `org.eclipse.edc.tck.dsp.setup.TckSetupExtension` -**Name:** "DSP TCK Setup" - -**Overview:** Loads customizations and seed data for the TCK. - - - -### Configuration - -| Key | Required | Type | Default | Pattern | Min | Max | Description | -| ---------------------------- | -------- | -------- | ---------------------- | ------- | --- | --- | --------------------------------------------------------------- | -| `edc.participant.context.id` | `*` | `string` | `participantContextId` | | | | Configures the participant context id for the tck suite runtime | - -#### Provided services -_None_ - -#### Referenced (injected) services -- `org.eclipse.edc.connector.controlplane.asset.spi.index.AssetIndex` (required) -- `org.eclipse.edc.connector.controlplane.services.spi.policydefinition.PolicyDefinitionService` (required) -- `org.eclipse.edc.connector.controlplane.services.spi.contractdefinition.ContractDefinitionService` (required) -- `org.eclipse.edc.connector.controlplane.contract.spi.negotiation.store.ContractNegotiationStore` (required) - -Module `token-core` -------------------- -**Artifact:** org.eclipse.edc:token-core:0.18.0 - -**Categories:** _token, security, auth, token, security, auth_ - -### Extension points -_None_ - -### Extensions -#### Class: `org.eclipse.edc.token.TokenServicesExtension` -**Name:** "Token Services Extension" - -**Overview:** This extension registers the {@link TokenValidationService} and the {@link TokenValidationRulesRegistry} - which can then be used by downstream modules. - - - -### Configuration_None_ - -#### Provided services -- `org.eclipse.edc.token.spi.TokenValidationRulesRegistry` -- `org.eclipse.edc.token.spi.TokenValidationService` -- `org.eclipse.edc.token.spi.TokenDecoratorRegistry` -- `org.eclipse.edc.jwt.spi.signer.JwsSignerProvider` -- `org.eclipse.edc.jwt.validation.jti.JtiValidationStore` - -#### Referenced (injected) services -- `org.eclipse.edc.keys.spi.PrivateKeyResolver` (required) - -Module `token-spi` ------------------- -**Name:** Token services -**Artifact:** org.eclipse.edc:token-spi:0.18.0 - -**Categories:** _None_ - -### Extension points -_None_ - -### Extensions -Module `transaction-atomikos` ------------------------------ -**Artifact:** org.eclipse.edc:transaction-atomikos:0.18.0 - -**Categories:** _None_ - -### Extension points -_None_ - -### Extensions -#### Class: `org.eclipse.edc.transaction.atomikos.AtomikosTransactionExtension` -**Name:** "Atomikos Transaction" - -**Overview:** Provides an implementation of a {@link DataSourceRegistry} and a {@link TransactionContext} backed by Atomikos. - - - -### Configuration - -| Key | Required | Type | Default | Pattern | Min | Max | Description | -| ---------------------------------- | -------- | -------- | ------- | ------- | --- | --- | ----------- | -| `driver.class` | `*` | `string` | `` | | | | | -| `url` | `*` | `string` | `` | | | | | -| `type` | `*` | `string` | `` | | | | | -| `username` | `*` | `string` | `` | | | | | -| `password` | `*` | `string` | `` | | | | | -| `pool.size` | `*` | `string` | `` | | | | | -| `max.pool.size` | `*` | `string` | `` | | | | | -| `min.pool.size` | `*` | `string` | `` | | | | | -| `connection.timeout` | `*` | `string` | `` | | | | | -| `login.timeout` | `*` | `string` | `` | | | | | -| `maintenance.interval` | `*` | `string` | `` | | | | | -| `max.idle` | `*` | `string` | `` | | | | | -| `query` | `*` | `string` | `` | | | | | -| `properties` | `*` | `string` | `` | | | | | -| `edc.atomikos.timeout` | | `string` | `` | | | | | -| `edc.atomikos.directory` | | `string` | `` | | | | | -| `edc.atomikos.threaded2pc` | | `string` | `` | | | | | -| `edc.atomikos.logging` | | `string` | `` | | | | | -| `edc.atomikos.checkpoint.interval` | | `string` | `` | | | | | - -#### Provided services -- `org.eclipse.edc.transaction.spi.TransactionContext` -- `org.eclipse.edc.transaction.datasource.spi.DataSourceRegistry` - -#### Referenced (injected) services -_None_ - -Module `transaction-datasource-spi` ------------------------------------ -**Name:** DataSource services -**Artifact:** org.eclipse.edc:transaction-datasource-spi:0.18.0 - -**Categories:** _None_ - -### Extension points - - `org.eclipse.edc.transaction.datasource.spi.DataSourceRegistry` - -### Extensions -Module `transaction-local` --------------------------- -**Artifact:** org.eclipse.edc:transaction-local:0.18.0 - -**Categories:** _None_ - -### Extension points -_None_ - -### Extensions -#### Class: `org.eclipse.edc.transaction.local.LocalTransactionExtension` -**Name:** "Local Transaction" - -**Overview:** Support for transaction context backed by one or more local resources, including a {@link DataSourceRegistry}. - - - -### Configuration_None_ - -#### Provided services -- `org.eclipse.edc.transaction.datasource.spi.DataSourceRegistry` -- `org.eclipse.edc.transaction.spi.TransactionContext` - -#### Referenced (injected) services -_None_ - -Module `transaction-spi` ------------------------- -**Name:** Transactional context services -**Artifact:** org.eclipse.edc:transaction-spi:0.18.0 - -**Categories:** _None_ - -### Extension points - - `org.eclipse.edc.transaction.spi.TransactionContext` - -### Extensions -Module `transfer-data-plane-signaling` --------------------------------------- -**Artifact:** org.eclipse.edc:transfer-data-plane-signaling:0.18.0 - -**Categories:** _None_ - -### Extension points -_None_ - -### Extensions -#### Class: `org.eclipse.edc.connector.controlplane.transfer.dataplane.TransferDataPlaneSignalingExtension` -**Name:** "DEPRECATED: Legacy Data Plane Signaling Extension" - -**Overview:** No overview provided. - - -### Configuration - -| Key | Required | Type | Default | Pattern | Min | Max | Description | -| ---------------------------------------- | -------- | -------- | -------- | ------- | --- | --- | -------------------------------------------------------------------------------------------------------- | -| `edc.dataplane.client.selector.strategy` | `*` | `string` | `random` | | | | Defines strategy for Data Plane instance selection in case Data Plane is not embedded in current runtime | - -#### Provided services -- `org.eclipse.edc.connector.controlplane.transfer.spi.flow.DataFlowController` - -#### Referenced (injected) services -- `org.eclipse.edc.web.spi.configuration.context.ControlApiUrl` (optional) -- `org.eclipse.edc.connector.dataplane.selector.spi.DataPlaneSelectorService` (required) -- `org.eclipse.edc.connector.dataplane.selector.spi.client.DataPlaneClientFactory` (required) -- `org.eclipse.edc.connector.controlplane.transfer.spi.flow.DataFlowPropertiesProvider` (optional) -- `org.eclipse.edc.connector.controlplane.transfer.spi.flow.TransferTypeParser` (required) -- `org.eclipse.edc.connector.controlplane.asset.spi.index.AssetIndex` (required) -- `org.eclipse.edc.connector.controlplane.transfer.spi.types.DataAddressStore` (required) -- `org.eclipse.edc.spi.monitor.Monitor` (required) -- `org.eclipse.edc.connector.controlplane.transfer.spi.types.DataPlaneProtocolInUse` (required) - -Module `transfer-process-api` ------------------------------ -**Artifact:** org.eclipse.edc:transfer-process-api:0.18.0 - -**Categories:** _None_ - -### Extension points -_None_ - -### Extensions -#### Class: `org.eclipse.edc.connector.controlplane.api.management.transferprocess.TransferProcessApiExtension` -**Name:** "Management API: Transfer Process" - -**Overview:** No overview provided. - - -### Configuration_None_ - -#### Provided services -_None_ - -#### Referenced (injected) services -- `org.eclipse.edc.web.spi.WebService` (required) -- `org.eclipse.edc.transform.spi.TypeTransformerRegistry` (required) -- `org.eclipse.edc.connector.controlplane.services.spi.transferprocess.TransferProcessService` (required) -- `org.eclipse.edc.validator.spi.JsonObjectValidatorRegistry` (required) -- `org.eclipse.edc.jsonld.spi.JsonLd` (required) -- `org.eclipse.edc.spi.types.TypeManager` (required) -- `org.eclipse.edc.participantcontext.single.spi.SingleParticipantContextSupplier` (required) - -Module `transfer-process-api-v5` --------------------------------- -**Artifact:** org.eclipse.edc:transfer-process-api-v5:0.18.0 - -**Categories:** _None_ - -### Extension points -_None_ - -### Extensions -#### Class: `org.eclipse.edc.connector.controlplane.api.management.transferprocess.TransferProcessApiV5Extension` -**Name:** "Management API: Transfer Process" - -**Overview:** No overview provided. - - -### Configuration_None_ - -#### Provided services -_None_ - -#### Referenced (injected) services -- `org.eclipse.edc.web.spi.WebService` (required) -- `org.eclipse.edc.transform.spi.TypeTransformerRegistry` (required) -- `org.eclipse.edc.connector.controlplane.services.spi.transferprocess.TransferProcessService` (required) -- `org.eclipse.edc.validator.spi.JsonObjectValidatorRegistry` (required) -- `org.eclipse.edc.jsonld.spi.JsonLd` (required) -- `org.eclipse.edc.spi.types.TypeManager` (required) -- `org.eclipse.edc.api.auth.spi.AuthorizationService` (required) -- `org.eclipse.edc.participantcontext.spi.service.ParticipantContextService` (required) -- `org.eclipse.edc.protocol.spi.ParticipantProfileService` (required) - -Module `transfer-process-store-sql` ------------------------------------ -**Artifact:** org.eclipse.edc:transfer-process-store-sql:0.18.0 - -**Categories:** _None_ - -### Extension points - - `org.eclipse.edc.connector.controlplane.store.sql.transferprocess.store.schema.TransferProcessStoreStatements` - -### Extensions -#### Class: `org.eclipse.edc.connector.controlplane.store.sql.transferprocess.SqlTransferProcessStoreExtension` -**Name:** "SQL transfer process store" - -**Overview:** No overview provided. - - -### Configuration - -| Key | Required | Type | Default | Pattern | Min | Max | Description | -| ------------------------------------------ | -------- | -------- | --------- | ------- | --- | --- | ------------------------- | -| `edc.sql.store.transferprocess.datasource` | `*` | `string` | `default` | | | | The datasource to be used | - -#### Provided services -- `org.eclipse.edc.connector.controlplane.transfer.spi.store.TransferProcessStore` - -#### Referenced (injected) services -- `org.eclipse.edc.transaction.datasource.spi.DataSourceRegistry` (required) -- `org.eclipse.edc.transaction.spi.TransactionContext` (required) -- `java.time.Clock` (required) -- `org.eclipse.edc.connector.controlplane.store.sql.transferprocess.store.schema.TransferProcessStoreStatements` (optional) -- `org.eclipse.edc.spi.types.TypeManager` (required) -- `org.eclipse.edc.sql.QueryExecutor` (required) -- `org.eclipse.edc.sql.bootstrapper.SqlSchemaBootstrapper` (required) -- `org.eclipse.edc.sql.lease.spi.SqlLeaseContextBuilderProvider` (required) -- `org.eclipse.edc.sql.lease.spi.LeaseStatements` (required) - -Module `transfer-spi` ---------------------- -**Name:** Transfer services -**Artifact:** org.eclipse.edc:transfer-spi:0.18.0 - -**Categories:** _None_ - -### Extension points - - `org.eclipse.edc.connector.controlplane.transfer.spi.store.TransferProcessStore` - - `org.eclipse.edc.connector.controlplane.transfer.spi.TransferProcessManager` - - `org.eclipse.edc.connector.controlplane.transfer.spi.TransferProcessPendingGuard` - - `org.eclipse.edc.connector.controlplane.transfer.spi.observe.TransferProcessObservable` - - `org.eclipse.edc.connector.controlplane.transfer.spi.flow.DataFlowPropertiesProvider` - -### Extensions -Module `transfer-tasks-publisher-nats` --------------------------------------- -**Artifact:** org.eclipse.edc:transfer-tasks-publisher-nats:0.18.0 +Module `transfer-tasks-subscriber-nats` +--------------------------------------- +**Artifact:** org.eclipse.edc:transfer-tasks-subscriber-nats:1.0.0-RC5 **Categories:** _None_ @@ -5677,28 +13,43 @@ Module `transfer-tasks-publisher-nats` _None_ ### Extensions -#### Class: `org.eclipse.edc.controlplane.tasks.publisher.nats.TransferTaskNatsPublisherExtension` -**Name:** "TransferTaskNatsPublisherExtension" +#### Class: `org.eclipse.edc.virtual.controlplane.transfer.subscriber.nats.NatsTransferProcessTaskSubscriberExtension` +**Name:** "NatsTransferProcessTaskSubscriberExtension" ### Configuration -| Key | Required | Type | Default | Pattern | Min | Max | Description | -| -------------------------------------- | -------- | -------- | ----------------------- | ------- | --- | --- | ------------------------------------------------------------------------------- | -| `edc.nats.tp.publisher.url` | `*` | `string` | `nats://localhost:4222` | | | | The URL of the NATS server to connect to for publishing transfer process tasks. | -| `edc.nats.tp.publisher.subject-prefix` | `*` | `string` | `transfers` | | | | The prefix for the subjects | +| Key | Required | Type | Default | Pattern | Min | Max | Description | +| -------------------------------------------- | -------- | -------- | ----------------------- | ------- | --- | --- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `edc.nats.tp.subscriber.url` | `*` | `string` | `nats://localhost:4222` | | | | The URL of the NATS server to connect to for transfer process events. | +| `edc.nats.tp.subscriber.name` | `*` | `string` | `tp-subscriber` | | | | The name of the consumer for transfer process events | +| `edc.nats.tp.subscriber.autocreate` | `*` | `string` | `false` | | | | Convenience flag: when true, it will automatically create both the stream and the consumer if not present | +| `edc.nats.tp.subscriber.stream.autocreate` | `*` | `string` | `false` | | | | When true, it will automatically create the stream if not present | +| `edc.nats.tp.subscriber.consumer.autocreate` | `*` | `string` | `false` | | | | When true, it will automatically create the consumer if not present | +| `edc.nats.tp.subscriber.stream` | `*` | `string` | `tp-stream` | | | | The stream name where to attach the consumer | +| `edc.nats.tp.subscriber.subject` | `*` | `string` | `transfers.>` | | | | The subject of the consumer for transfer process events | +| `edc.nats.tp.subscriber.batch-size` | `*` | `string` | `100` | | | | The size of the batch when fetching messages | +| `edc.nats.tp.subscriber.max-wait` | `*` | `string` | `100` | | | | The max waiting time for messages (ms) | +| `edc.nats.tp.subscriber.max-retries` | `*` | `string` | `3` | | | | Max number of message deliveries while the referenced task is not yet visible in the store (e.g. published before its transaction committed), after which the message is dropped. It does not cap processor/business retries, which are bounded by edc.transfer.send.retry.limit. | +| `edc.transfer.send.retry.base-delay.ms` | `*` | `string` | `1000` | | | | The base delay (ms) before a transfer process task that failed with a retryable error is delivered again; it doubles at every delivery. Shared with the polling state machine. | +| `edc.transfer.send.retry.limit` | `*` | `string` | `7` | | | | The number of deliveries after which a transfer process task whose handling keeps throwing an exception is given up. Shared with the polling state machine. | #### Provided services _None_ #### Referenced (injected) services - `org.eclipse.edc.spi.types.TypeManager` (required) -- `java.time.Clock` (required) +- `org.eclipse.edc.controlplane.transfer.spi.TransferProcessTaskExecutor` (required) +- `org.eclipse.edc.spi.system.ExecutorInstrumentation` (required) - `org.eclipse.edc.spi.monitor.Monitor` (required) -- `org.eclipse.edc.controlplane.tasks.TaskObservable` (required) +- `org.eclipse.edc.controlplane.tasks.TaskService` (required) +- `java.time.Clock` (required) +- `org.eclipse.edc.transaction.spi.TransactionContext` (required) +- `org.eclipse.edc.spi.system.health.HealthCheckService` (required) +- `io.nats.client.Options` (optional) Module `transfer-tasks-subscriber-nats` --------------------------------------- -**Artifact:** org.eclipse.edc:transfer-tasks-subscriber-nats:0.18.0 +**Artifact:** org.eclipse.edc:transfer-tasks-subscriber-nats:1.0.0-RC5 **Categories:** _None_ @@ -5711,16 +62,20 @@ _None_ ### Configuration -| Key | Required | Type | Default | Pattern | Min | Max | Description | -| ------------------------------------ | -------- | -------- | ----------------------- | ------- | --- | --- | ---------------------------------------------------------------------------------- | -| `edc.nats.tp.subscriber.url` | `*` | `string` | `nats://localhost:4222` | | | | The URL of the NATS server to connect to for transfer process events. | -| `edc.nats.tp.subscriber.name` | `*` | `string` | `tp-subscriber` | | | | The name of the consumer for transfer process events | -| `edc.nats.tp.subscriber.autocreate` | `*` | `string` | `false` | | | | When true, it will automatically create the stream and the consumer if not present | -| `edc.nats.tp.subscriber.stream` | `*` | `string` | `tp-stream` | | | | The stream name where to attach the consumer | -| `edc.nats.tp.subscriber.subject` | `*` | `string` | `transfers.>` | | | | The subject of the consumer for contract negotiation events | -| `edc.nats.tp.subscriber.batch-size` | `*` | `string` | `100` | | | | The size of the batch when fetching messages | -| `edc.nats.tp.subscriber.max-wait` | `*` | `string` | `100` | | | | The max waiting time for messages (ms) | -| `edc.nats.tp.subscriber.max-retries` | `*` | `string` | `3` | | | | Max retries for task execution failure on transient errors | +| Key | Required | Type | Default | Pattern | Min | Max | Description | +| -------------------------------------------- | -------- | -------- | ----------------------- | ------- | --- | --- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `edc.nats.tp.subscriber.url` | `*` | `string` | `nats://localhost:4222` | | | | The URL of the NATS server to connect to for transfer process events. | +| `edc.nats.tp.subscriber.name` | `*` | `string` | `tp-subscriber` | | | | The name of the consumer for transfer process events | +| `edc.nats.tp.subscriber.autocreate` | `*` | `string` | `false` | | | | Convenience flag: when true, it will automatically create both the stream and the consumer if not present | +| `edc.nats.tp.subscriber.stream.autocreate` | `*` | `string` | `false` | | | | When true, it will automatically create the stream if not present | +| `edc.nats.tp.subscriber.consumer.autocreate` | `*` | `string` | `false` | | | | When true, it will automatically create the consumer if not present | +| `edc.nats.tp.subscriber.stream` | `*` | `string` | `tp-stream` | | | | The stream name where to attach the consumer | +| `edc.nats.tp.subscriber.subject` | `*` | `string` | `transfers.>` | | | | The subject of the consumer for transfer process events | +| `edc.nats.tp.subscriber.batch-size` | `*` | `string` | `100` | | | | The size of the batch when fetching messages | +| `edc.nats.tp.subscriber.max-wait` | `*` | `string` | `100` | | | | The max waiting time for messages (ms) | +| `edc.nats.tp.subscriber.max-retries` | `*` | `string` | `3` | | | | Max number of message deliveries while the referenced task is not yet visible in the store (e.g. published before its transaction committed), after which the message is dropped. It does not cap processor/business retries, which are bounded by edc.transfer.send.retry.limit. | +| `edc.transfer.send.retry.base-delay.ms` | `*` | `string` | `1000` | | | | The base delay (ms) before a transfer process task that failed with a retryable error is delivered again; it doubles at every delivery. Shared with the polling state machine. | +| `edc.transfer.send.retry.limit` | `*` | `string` | `7` | | | | The number of deliveries after which a transfer process task whose handling keeps throwing an exception is given up. Shared with the polling state machine. | #### Provided services _None_ @@ -5733,221 +88,6 @@ _None_ - `org.eclipse.edc.controlplane.tasks.TaskService` (required) - `java.time.Clock` (required) - `org.eclipse.edc.transaction.spi.TransactionContext` (required) - -Module `validator-data-address-http-data` ------------------------------------------ -**Artifact:** org.eclipse.edc:validator-data-address-http-data:0.18.0 - -**Categories:** _None_ - -### Extension points -_None_ - -### Extensions -#### Class: `org.eclipse.edc.validator.dataaddress.httpdata.HttpDataDataAddressValidatorExtension` -**Name:** "DataAddress HttpData Validator" - -**Overview:** No overview provided. - - -### Configuration_None_ - -#### Provided services -_None_ - -#### Referenced (injected) services -- `org.eclipse.edc.validator.spi.DataAddressValidatorRegistry` (required) - -Module `validator-data-address-kafka` -------------------------------------- -**Artifact:** org.eclipse.edc:validator-data-address-kafka:0.18.0 - -**Categories:** _None_ - -### Extension points -_None_ - -### Extensions -#### Class: `org.eclipse.edc.validator.dataaddress.kafka.KafkaDataAddressValidatorExtension` -**Name:** "DataAddress Kafka Validator" - -**Overview:** No overview provided. - - -### Configuration_None_ - -#### Provided services -_None_ - -#### Referenced (injected) services -- `org.eclipse.edc.validator.spi.DataAddressValidatorRegistry` (required) - -Module `vault-hashicorp` ------------------------- -**Artifact:** org.eclipse.edc:vault-hashicorp:0.18.0 - -**Categories:** _None_ - -### Extension points -_None_ - -### Extensions -#### Class: `org.eclipse.edc.vault.hashicorp.health.HashicorpVaultHealthExtension` -**Name:** "Hashicorp Vault Health" - -**Overview:** No overview provided. - - -### Configuration - -| Key | Required | Type | Default | Pattern | Min | Max | Description | -| ----------------------------------------------------- | -------- | -------- | ---------------- | ------- | --- | --- | ---------------------------------------------------------------------------------------------------------------------------------- | -| `edc.vault.hashicorp.url` | `*` | `string` | `` | | | | The URL of the Hashicorp Vault | -| `edc.vault.hashicorp.health.check.enabled` | `*` | `string` | `true` | | | | Whether or not the vault health check is enabled | -| `edc.vault.hashicorp.api.health.check.path` | `*` | `string` | `/v1/sys/health` | | | | The URL path of the vault's /health endpoint | -| `edc.vault.hashicorp.health.check.standby.ok` | `*` | `string` | `false` | | | | Specifies if being a standby should still return the active status code instead of the standby status code | -| ~~edc.vault.hashicorp.token.scheduled-renew-enabled~~ | `*` | `string` | `true` | | | | Whether the automatic token renewal process will be triggered or not. Should be disabled only for development and testing purposes | -| `edc.vault.hashicorp.token.scheduledrenew.enabled` | `*` | `string` | `true` | | | | Whether the automatic token renewal process will be triggered or not. Should be disabled only for development and testing purposes | -| `edc.vault.hashicorp.token.ttl` | `*` | `string` | `300` | | | | The time-to-live (ttl) value of the Hashicorp Vault token in seconds | -| `edc.vault.hashicorp.token.renew-buffer` | `*` | `string` | `30` | | | | The renew buffer of the Hashicorp Vault token in seconds | -| `edc.vault.hashicorp.api.secret.path` | `*` | `string` | `/v1/secret` | | | | The URL path of the vault's /secret endpoint | -| `edc.vault.hashicorp.folder` | | `string` | `` | | | | The path of the folder that the secret is stored in, relative to VAULT_FOLDER_PATH | -| ~~edc.vault.hashicorp.allow-fallback~~ | `*` | `string` | `true` | | | | Allow fallback to default vault partition if vault partitioning is not set up | -| `edc.vault.hashicorp.allowfallback` | `*` | `string` | `true` | | | | Allow fallback to default vault partition if vault partitioning is not set up | - -#### Provided services -_None_ - -#### Referenced (injected) services - `org.eclipse.edc.spi.system.health.HealthCheckService` (required) -- `org.eclipse.edc.vault.hashicorp.client.HashicorpVaultHealthService` (required) - -#### Class: `org.eclipse.edc.vault.hashicorp.HashicorpVaultExtension` -**Name:** "Hashicorp Vault" - -**Overview:** No overview provided. - - -### Configuration - -| Key | Required | Type | Default | Pattern | Min | Max | Description | -| ----------------------------------------------------- | -------- | -------- | ---------------- | ------- | --- | --- | ---------------------------------------------------------------------------------------------------------------------------------- | -| `edc.vault.hashicorp.url` | `*` | `string` | `` | | | | The URL of the Hashicorp Vault | -| `edc.vault.hashicorp.health.check.enabled` | `*` | `string` | `true` | | | | Whether or not the vault health check is enabled | -| `edc.vault.hashicorp.api.health.check.path` | `*` | `string` | `/v1/sys/health` | | | | The URL path of the vault's /health endpoint | -| `edc.vault.hashicorp.health.check.standby.ok` | `*` | `string` | `false` | | | | Specifies if being a standby should still return the active status code instead of the standby status code | -| ~~edc.vault.hashicorp.token.scheduled-renew-enabled~~ | `*` | `string` | `true` | | | | Whether the automatic token renewal process will be triggered or not. Should be disabled only for development and testing purposes | -| `edc.vault.hashicorp.token.scheduledrenew.enabled` | `*` | `string` | `true` | | | | Whether the automatic token renewal process will be triggered or not. Should be disabled only for development and testing purposes | -| `edc.vault.hashicorp.token.ttl` | `*` | `string` | `300` | | | | The time-to-live (ttl) value of the Hashicorp Vault token in seconds | -| `edc.vault.hashicorp.token.renew-buffer` | `*` | `string` | `30` | | | | The renew buffer of the Hashicorp Vault token in seconds | -| `edc.vault.hashicorp.api.secret.path` | `*` | `string` | `/v1/secret` | | | | The URL path of the vault's /secret endpoint | -| `edc.vault.hashicorp.folder` | | `string` | `` | | | | The path of the folder that the secret is stored in, relative to VAULT_FOLDER_PATH | -| ~~edc.vault.hashicorp.allow-fallback~~ | `*` | `string` | `true` | | | | Allow fallback to default vault partition if vault partitioning is not set up | -| `edc.vault.hashicorp.allowfallback` | `*` | `string` | `true` | | | | Allow fallback to default vault partition if vault partitioning is not set up | - -#### Provided services -- `org.eclipse.edc.spi.security.Vault` -- `org.eclipse.edc.spi.security.SignatureService` -- `@org.jetbrains.annotations.NotNull org.eclipse.edc.vault.hashicorp.client.HashicorpVaultHealthService` - -#### Referenced (injected) services -- `org.eclipse.edc.http.spi.EdcHttpClient` (required) -- `org.eclipse.edc.spi.system.ExecutorInstrumentation` (required) -- `org.eclipse.edc.vault.hashicorp.spi.auth.HashicorpVaultTokenProviderFactory` (required) -- `org.eclipse.edc.participantcontext.spi.config.ParticipantContextConfig` (required) - -#### Class: `org.eclipse.edc.vault.hashicorp.auth.HashicorpVaultAuthenticationExtension` -**Name:** "Hashicorp Vault Authentication" - -**Overview:** No overview provided. - - -### Configuration - -| Key | Required | Type | Default | Pattern | Min | Max | Description | -| --------------------------------------------------------- | -------- | -------- | ------------- | ------- | --- | --- | ------------------------------------------------------------------------------------------------------------------------------------------------ | -| `edc.vault.hashicorp.token` | | `string` | `` | | | | The token used to access the Hashicorp Vault. Only required if static token authentication is used. | -| `edc.vault.hashicorp.url` | | `string` | `` | | | | The URL of the Hashicorp Vault. Required if token-exchange authentication is used. | -| `edc.vault.hashicorp.auth.tokenexchange.url` | | `string` | `` | | | | URL of the token-exchange service (e.g. jwtlet) used to exchange the workload token for a participant-scoped token | -| `edc.vault.hashicorp.auth.tokenexchange.subjecttokenpath` | | `string` | `` | | | | Path to the file holding the projected workload (ServiceAccount) token used as the subject token in the exchange | -| `edc.vault.hashicorp.auth.tokenexchange.audience` | `*` | `string` | `edcv` | | | | The audience requested for the exchanged token. Must match the token-exchange service's configured audience. | -| `edc.vault.hashicorp.auth.tokenexchange.scope` | `*` | `string` | `read` | | | | The abstract scope (tier) requested for the exchanged token | -| `edc.vault.hashicorp.auth.tokenexchange.resource` | | `string` | `` | | | | The resource (participant context id) used for the default vault partition. Only relevant when token exchange is used for the default partition. | -| `edc.vault.hashicorp.auth.jwt.role` | `*` | `string` | `participant` | | | | The Hashicorp Vault JWT auth method role to authenticate with | - -#### Provided services -- `org.eclipse.edc.vault.hashicorp.spi.auth.HashicorpVaultTokenProviderFactory` - -#### Referenced (injected) services -- `org.eclipse.edc.http.spi.EdcHttpClient` (optional) - -Module `verifiable-credentials` -------------------------------- -**Artifact:** org.eclipse.edc:verifiable-credentials:0.18.0 - -**Categories:** _None_ - -### Extension points -_None_ - -### Extensions -#### Class: `org.eclipse.edc.iam.verifiablecredentials.RevocationServiceRegistryExtension` -**Name:** "Revocation Service Registry" - -**Overview:** No overview provided. - - -### Configuration - -| Key | Required | Type | Default | Pattern | Min | Max | Description | -| ---------------------------------------------- | -------- | -------- | -------- | ------- | --- | --- | ----------------------------------------------------------------------------------- | -| `edc.iam.credential.revocation.cache.validity` | `*` | `string` | `900000` | | | | Validity period of cached StatusList2021 credential entries in milliseconds. | -| `edc.iam.credential.revocation.mimetype` | `*` | `string` | `*/*` | | | | A comma-separated list of accepted content types of the revocation list credential. | - -#### Provided services -- `org.eclipse.edc.iam.verifiablecredentials.spi.model.RevocationServiceRegistry` - -#### Referenced (injected) services -- `org.eclipse.edc.spi.types.TypeManager` (required) -- `org.eclipse.edc.http.spi.EdcHttpClient` (required) -- `org.eclipse.edc.token.spi.TokenValidationService` (required) -- `org.eclipse.edc.iam.did.spi.resolution.DidPublicKeyResolver` (required) - -Module `version-api` --------------------- -**Artifact:** org.eclipse.edc:version-api:0.18.0 - -**Categories:** _None_ - -### Extension points -_None_ - -### Extensions -#### Class: `org.eclipse.edc.connector.api.management.version.VersionApiExtension` -**Name:** "Management API: Version Information" - -**Overview:** No overview provided. - - -### Configuration_None_ - -#### Provided services -_None_ - -#### Referenced (injected) services -- `org.eclipse.edc.web.spi.WebService` (required) -- `org.eclipse.edc.spi.system.apiversion.ApiVersionService` (required) - -Module `web-spi` ----------------- -**Name:** Web services -**Artifact:** org.eclipse.edc:web-spi:0.18.0 - -**Categories:** _None_ - -### Extension points - - `org.eclipse.edc.web.spi.WebService` - - `org.eclipse.edc.web.spi.WebServer` - - `org.eclipse.edc.web.spi.validation.InterceptorFunctionRegistry` +- `io.nats.client.Options` (optional) -### Extensions diff --git a/content/en/documentation/autodoc/identity-hub.md b/content/en/documentation/autodoc/identity-hub.md index 509420b..2784156 100644 --- a/content/en/documentation/autodoc/identity-hub.md +++ b/content/en/documentation/autodoc/identity-hub.md @@ -5,7 +5,7 @@ Module `attestation-api` ------------------------ -**Artifact:** org.eclipse.edc:attestation-api:0.18.0 +**Artifact:** org.eclipse.edc:attestation-api:1.0.0-RC4 **Categories:** _None_ @@ -31,7 +31,7 @@ _None_ Module `common-core` -------------------- -**Artifact:** org.eclipse.edc:common-core:0.18.0 +**Artifact:** org.eclipse.edc:common-core:1.0.0-RC4 **Categories:** _None_ @@ -69,6 +69,7 @@ _None_ - `org.eclipse.edc.jsonld.spi.JsonLd` (required) - `org.eclipse.edc.jwt.validation.jti.JtiValidationStore` (required) - `org.eclipse.edc.identityhub.spi.transformation.DiscriminatorMappingRegistry` (required) +- `org.eclipse.edc.identityhub.spi.transformation.ScopeMappingRegistry` (required) #### Class: `org.eclipse.edc.identityhub.DiscriminatorMappingExtension` **Name:** "Discriminator Mapping Extension" @@ -89,9 +90,30 @@ _None_ #### Referenced (injected) services _None_ +#### Class: `org.eclipse.edc.identityhub.ScopeMappingExtension` +**Name:** "Scope Mapping Extension" + +**Overview:** No overview provided. + + +### Configuration + +| Key | Required | Type | Default | Pattern | Min | Max | Description | +| -------------------------------------------- | -------- | -------- | ------- | ------- | --- | --- | ------------------------------------------------------------------------------------------ | +| `edc.identityhub.scope..pattern` | `*` | `string` | `` | | | | The regular expression the scope string is matched against. | +| `edc.identityhub.scope..leftoperand` | `*` | `string` | `` | | | | The left operand of the resulting criterion, may reference regex capture groups (e.g. $1) | +| `edc.identityhub.scope..operator` | `*` | `string` | `` | | | | The operator of the resulting criterion, e.g. 'contains' | +| `edc.identityhub.scope..rightoperand` | `*` | `string` | `` | | | | The right operand of the resulting criterion, may reference regex capture groups (e.g. $1) | + +#### Provided services +- `org.eclipse.edc.identityhub.spi.transformation.ScopeMappingRegistry` + +#### Referenced (injected) services +_None_ + Module `credential-definition-api` ---------------------------------- -**Artifact:** org.eclipse.edc:credential-definition-api:0.18.0 +**Artifact:** org.eclipse.edc:credential-definition-api:1.0.0-RC4 **Categories:** _None_ @@ -117,7 +139,7 @@ _None_ Module `credential-offer-api` ----------------------------- -**Artifact:** org.eclipse.edc:credential-offer-api:0.18.0 +**Artifact:** org.eclipse.edc:credential-offer-api:1.0.0-RC4 **Categories:** _None_ @@ -147,10 +169,12 @@ _None_ - `org.eclipse.edc.spi.monitor.Monitor` (required) - `org.eclipse.edc.identityhub.spi.participantcontext.IdentityHubParticipantContextService` (required) - `org.eclipse.edc.identityhub.spi.verifiablecredentials.offer.CredentialOfferService` (required) +- `org.eclipse.edc.iam.did.spi.resolution.DidResolverRegistry` (required) +- `org.eclipse.edc.http.spi.EdcHttpClient` (required) Module `credential-offer-handler` --------------------------------- -**Artifact:** org.eclipse.edc:credential-offer-handler:0.18.0 +**Artifact:** org.eclipse.edc:credential-offer-handler:1.0.0-RC4 **Categories:** _None_ @@ -178,7 +202,7 @@ _None_ Module `credential-watchdog` ---------------------------- -**Artifact:** org.eclipse.edc:credential-watchdog:0.18.0 +**Artifact:** org.eclipse.edc:credential-watchdog:1.0.0-RC4 **Categories:** _None_ @@ -212,7 +236,7 @@ _None_ Module `credentials-api` ------------------------ -**Artifact:** org.eclipse.edc:credentials-api:0.18.0 +**Artifact:** org.eclipse.edc:credentials-api:1.0.0-RC4 **Categories:** _None_ @@ -240,7 +264,7 @@ _None_ Module `credentials-api-configuration` -------------------------------------- -**Artifact:** org.eclipse.edc:credentials-api-configuration:0.18.0 +**Artifact:** org.eclipse.edc:credentials-api-configuration:1.0.0-RC4 **Categories:** _None_ @@ -272,7 +296,7 @@ _None_ Module `dcp-core` ----------------- -**Artifact:** org.eclipse.edc:dcp-core:0.18.0 +**Artifact:** org.eclipse.edc:dcp-core:1.0.0-RC4 **Categories:** _None_ @@ -296,7 +320,7 @@ _None_ Module `dcp-identityhub-core` ----------------------------- -**Artifact:** org.eclipse.edc:dcp-identityhub-core:0.18.0 +**Artifact:** org.eclipse.edc:dcp-identityhub-core:1.0.0-RC4 **Categories:** _None_ @@ -327,7 +351,7 @@ _None_ Module `dcp-issuer-api` ----------------------- -**Artifact:** org.eclipse.edc:dcp-issuer-api:0.18.0 +**Artifact:** org.eclipse.edc:dcp-issuer-api:1.0.0-RC4 **Categories:** _None_ @@ -367,7 +391,7 @@ _None_ Module `dcp-issuer-core` ------------------------ -**Artifact:** org.eclipse.edc:dcp-issuer-core:0.18.0 +**Artifact:** org.eclipse.edc:dcp-issuer-core:1.0.0-RC4 **Categories:** _None_ @@ -409,6 +433,7 @@ _None_ - `java.time.Clock` (required) - `org.eclipse.edc.http.spi.EdcHttpClient` (required) - `org.eclipse.edc.identityhub.spi.authentication.ParticipantSecureTokenService` (required) +- `org.eclipse.edc.spi.security.Vault` (required) - `org.eclipse.edc.spi.monitor.Monitor` (required) - `org.eclipse.edc.spi.types.TypeManager` (required) - `org.eclipse.edc.iam.did.spi.resolution.DidResolverRegistry` (required) @@ -419,7 +444,7 @@ _None_ Module `did-api` ---------------- -**Artifact:** org.eclipse.edc:did-api:0.18.0 +**Artifact:** org.eclipse.edc:did-api:1.0.0-RC4 **Categories:** _None_ @@ -446,19 +471,19 @@ _None_ Module `did-spi` ---------------- **Name:** Identity Hub DID services -**Artifact:** org.eclipse.edc:did-spi:0.18.0 +**Artifact:** org.eclipse.edc:did-spi:1.0.0-RC4 **Categories:** _None_ ### Extension points - - `org.eclipse.edc.identityhub.spi.did.DidWebParser` - `org.eclipse.edc.identityhub.spi.did.store.DidResourceStore` + - `org.eclipse.edc.identityhub.spi.did.DidWebParser` - `org.eclipse.edc.identityhub.spi.did.DidDocumentPublisher` ### Extensions Module `holder-api` ------------------- -**Artifact:** org.eclipse.edc:holder-api:0.18.0 +**Artifact:** org.eclipse.edc:holder-api:1.0.0-RC4 **Categories:** _None_ @@ -484,7 +509,7 @@ _None_ Module `holder-credential-offer-store-sql` ------------------------------------------ -**Artifact:** org.eclipse.edc:holder-credential-offer-store-sql:0.18.0 +**Artifact:** org.eclipse.edc:holder-credential-offer-store-sql:1.0.0-RC4 **Categories:** _None_ @@ -515,11 +540,12 @@ _None_ - `org.eclipse.edc.identityhub.store.sql.credentialoffer.schema.CredentialOfferStoreStatements` (optional) - `org.eclipse.edc.sql.bootstrapper.SqlSchemaBootstrapper` (required) - `org.eclipse.edc.sql.lease.spi.SqlLeaseContextBuilderProvider` (required) +- `org.eclipse.edc.sql.lease.spi.LeaseStatements` (required) - `java.time.Clock` (required) Module `holder-credential-request-store-sql` -------------------------------------------- -**Artifact:** org.eclipse.edc:holder-credential-request-store-sql:0.18.0 +**Artifact:** org.eclipse.edc:holder-credential-request-store-sql:1.0.0-RC4 **Categories:** _None_ @@ -550,11 +576,12 @@ _None_ - `org.eclipse.edc.identityhub.store.sql.credentialrequest.schema.HolderCredentialRequestStoreStatements` (optional) - `org.eclipse.edc.sql.bootstrapper.SqlSchemaBootstrapper` (required) - `org.eclipse.edc.sql.lease.spi.SqlLeaseContextBuilderProvider` (required) +- `org.eclipse.edc.sql.lease.spi.LeaseStatements` (required) - `java.time.Clock` (required) Module `identity-api-authentication-oauth2` ------------------------------------------- -**Artifact:** org.eclipse.edc:identity-api-authentication-oauth2:0.18.0 +**Artifact:** org.eclipse.edc:identity-api-authentication-oauth2:1.0.0-RC4 **Categories:** _None_ @@ -590,7 +617,7 @@ _None_ Module `identity-api-authorization-oauth2` ------------------------------------------ -**Artifact:** org.eclipse.edc:identity-api-authorization-oauth2:0.18.0 +**Artifact:** org.eclipse.edc:identity-api-authorization-oauth2:1.0.0-RC4 **Categories:** _None_ @@ -614,7 +641,7 @@ _None_ Module `identity-api-configuration` ----------------------------------- -**Artifact:** org.eclipse.edc:identity-api-configuration:0.18.0 +**Artifact:** org.eclipse.edc:identity-api-configuration:1.0.0-RC4 **Categories:** _None_ @@ -645,7 +672,7 @@ _None_ Module `identity-hub-core` -------------------------- -**Artifact:** org.eclipse.edc:identity-hub-core:0.18.0 +**Artifact:** org.eclipse.edc:identity-hub-core:1.0.0-RC4 **Categories:** _None_ @@ -660,7 +687,12 @@ _None_ -### Configuration_None_ +### Configuration + +| Key | Required | Type | Default | Pattern | Min | Max | Description | +| -------------------------------------------------- | -------- | -------- | ------- | ------- | --- | --- | ------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `edc.iam.credential.request.status.poll.interval` | `*` | `string` | `5000` | | | | Interval in milliseconds at which the Issuer is asked about the status of credential requests that are still awaiting their credentials | +| ~~edc.iam.credential.request.bearer.access.scope~~ | | `string` | `` | | | | The scope that will be used to issue an access token to be included in the Self-Issued ID token in the 'token' claim. By default, no token will be generated. | #### Provided services - `org.eclipse.edc.identityhub.spi.verification.SelfIssuedTokenVerifier` @@ -705,7 +737,7 @@ _None_ Module `identity-hub-credentials-store-sql` ------------------------------------------- -**Artifact:** org.eclipse.edc:identity-hub-credentials-store-sql:0.18.0 +**Artifact:** org.eclipse.edc:identity-hub-credentials-store-sql:1.0.0-RC4 **Categories:** _None_ @@ -738,7 +770,7 @@ _None_ Module `identity-hub-did` ------------------------- -**Artifact:** org.eclipse.edc:identity-hub-did:0.18.0 +**Artifact:** org.eclipse.edc:identity-hub-did:1.0.0-RC4 **Categories:** _None_ @@ -746,8 +778,8 @@ Module `identity-hub-did` _None_ ### Extensions -#### Class: `org.eclipse.edc.identityhub.did.DidServicesExtension` -**Name:** "DID Service Extension" +#### Class: `org.eclipse.edc.identityhub.did.defaults.DidDefaultServicesExtension` +**Name:** "DID Default Services Extension" **Overview:** No overview provided. @@ -755,19 +787,13 @@ _None_ ### Configuration_None_ #### Provided services -- `org.eclipse.edc.identityhub.spi.did.DidDocumentPublisherRegistry` -- `org.eclipse.edc.identityhub.spi.did.DidDocumentService` +- `org.eclipse.edc.identityhub.spi.did.store.DidResourceStore` #### Referenced (injected) services -- `org.eclipse.edc.transaction.spi.TransactionContext` (required) -- `org.eclipse.edc.identityhub.spi.did.store.DidResourceStore` (required) -- `org.eclipse.edc.spi.event.EventRouter` (required) -- `org.eclipse.edc.keys.spi.KeyParserRegistry` (required) -- `org.eclipse.edc.participantcontext.spi.store.ParticipantContextStore` (required) -- `org.eclipse.edc.spi.telemetry.Telemetry` (required) +- `org.eclipse.edc.spi.query.CriterionOperatorRegistry` (required) -#### Class: `org.eclipse.edc.identityhub.did.defaults.DidDefaultServicesExtension` -**Name:** "DID Default Services Extension" +#### Class: `org.eclipse.edc.identityhub.did.DidServicesExtension` +**Name:** "DID Service Extension" **Overview:** No overview provided. @@ -775,14 +801,20 @@ _None_ ### Configuration_None_ #### Provided services -- `org.eclipse.edc.identityhub.spi.did.store.DidResourceStore` +- `org.eclipse.edc.identityhub.spi.did.DidDocumentPublisherRegistry` +- `org.eclipse.edc.identityhub.spi.did.DidDocumentService` #### Referenced (injected) services -- `org.eclipse.edc.spi.query.CriterionOperatorRegistry` (required) +- `org.eclipse.edc.transaction.spi.TransactionContext` (required) +- `org.eclipse.edc.identityhub.spi.did.store.DidResourceStore` (required) +- `org.eclipse.edc.spi.event.EventRouter` (required) +- `org.eclipse.edc.keys.spi.KeyParserRegistry` (required) +- `org.eclipse.edc.participantcontext.spi.store.ParticipantContextStore` (required) +- `org.eclipse.edc.spi.telemetry.Telemetry` (required) Module `identity-hub-did-store-sql` ----------------------------------- -**Artifact:** org.eclipse.edc:identity-hub-did-store-sql:0.18.0 +**Artifact:** org.eclipse.edc:identity-hub-did-store-sql:1.0.0-RC4 **Categories:** _None_ @@ -815,7 +847,7 @@ _None_ Module `identity-hub-keypair-store-sql` --------------------------------------- -**Artifact:** org.eclipse.edc:identity-hub-keypair-store-sql:0.18.0 +**Artifact:** org.eclipse.edc:identity-hub-keypair-store-sql:1.0.0-RC4 **Categories:** _None_ @@ -848,7 +880,7 @@ _None_ Module `identity-hub-keypairs` ------------------------------ -**Artifact:** org.eclipse.edc:identity-hub-keypairs:0.18.0 +**Artifact:** org.eclipse.edc:identity-hub-keypairs:1.0.0-RC4 **Categories:** _None_ @@ -878,7 +910,7 @@ _None_ Module `identity-hub-keypairs-transit` -------------------------------------- -**Artifact:** org.eclipse.edc:identity-hub-keypairs-transit:0.18.0 +**Artifact:** org.eclipse.edc:identity-hub-keypairs-transit:1.0.0-RC4 **Categories:** _None_ @@ -886,25 +918,6 @@ Module `identity-hub-keypairs-transit` _None_ ### Extensions -#### Class: `org.eclipse.edc.identityhub.keypairs.TransitKeyPairServiceExtension` -**Name:** "Hashicorp Transit KeyPair Service Extension" - -**Overview:** No overview provided. - - -### Configuration_None_ - -#### Provided services -- `org.eclipse.edc.identityhub.spi.keypair.KeyPairService` - -#### Referenced (injected) services -- `org.eclipse.edc.identityhub.spi.keypair.store.KeyPairResourceStore` (required) -- `org.eclipse.edc.spi.event.EventRouter` (required) -- `org.eclipse.edc.transaction.spi.TransactionContext` (required) -- `org.eclipse.edc.participantcontext.spi.store.ParticipantContextStore` (required) -- `org.eclipse.edc.identityhub.spi.keypair.events.KeyPairObservable` (required) -- `org.eclipse.edc.identityhub.transit.TransitEngine` (required) - #### Class: `org.eclipse.edc.identityhub.TransitSecurityExtension` **Name:** "Hashicorp Transit Security Extension" @@ -926,9 +939,28 @@ _None_ - `org.eclipse.edc.http.spi.EdcHttpClient` (required) - `org.eclipse.edc.spi.types.TypeManager` (required) +#### Class: `org.eclipse.edc.identityhub.keypairs.TransitKeyPairServiceExtension` +**Name:** "Hashicorp Transit KeyPair Service Extension" + +**Overview:** No overview provided. + + +### Configuration_None_ + +#### Provided services +- `org.eclipse.edc.identityhub.spi.keypair.KeyPairService` + +#### Referenced (injected) services +- `org.eclipse.edc.identityhub.spi.keypair.store.KeyPairResourceStore` (required) +- `org.eclipse.edc.spi.event.EventRouter` (required) +- `org.eclipse.edc.transaction.spi.TransactionContext` (required) +- `org.eclipse.edc.participantcontext.spi.store.ParticipantContextStore` (required) +- `org.eclipse.edc.identityhub.spi.keypair.events.KeyPairObservable` (required) +- `org.eclipse.edc.identityhub.transit.TransitEngine` (required) + Module `identity-hub-participants` ---------------------------------- -**Artifact:** org.eclipse.edc:identity-hub-participants:0.18.0 +**Artifact:** org.eclipse.edc:identity-hub-participants:1.0.0-RC4 **Categories:** _None_ @@ -980,7 +1012,7 @@ _None_ Module `identityhub-api-authentication` --------------------------------------- -**Artifact:** org.eclipse.edc:identityhub-api-authentication:0.18.0 +**Artifact:** org.eclipse.edc:identityhub-api-authentication:1.0.0-RC4 **Categories:** _None_ @@ -1006,7 +1038,7 @@ _None_ Module `identityhub-api-authorization` -------------------------------------- -**Artifact:** org.eclipse.edc:identityhub-api-authorization:0.18.0 +**Artifact:** org.eclipse.edc:identityhub-api-authorization:1.0.0-RC4 **Categories:** _None_ @@ -1030,7 +1062,7 @@ _None_ Module `issuance-process-api` ----------------------------- -**Artifact:** org.eclipse.edc:issuance-process-api:0.18.0 +**Artifact:** org.eclipse.edc:issuance-process-api:1.0.0-RC4 **Categories:** _None_ @@ -1056,7 +1088,7 @@ _None_ Module `issuance-process-store-sql` ----------------------------------- -**Artifact:** org.eclipse.edc:issuance-process-store-sql:0.18.0 +**Artifact:** org.eclipse.edc:issuance-process-store-sql:1.0.0-RC4 **Categories:** _None_ @@ -1087,11 +1119,12 @@ _None_ - `org.eclipse.edc.issuerservice.store.sql.issuanceprocess.IssuanceProcessStoreStatements` (optional) - `org.eclipse.edc.sql.bootstrapper.SqlSchemaBootstrapper` (required) - `org.eclipse.edc.sql.lease.spi.SqlLeaseContextBuilderProvider` (required) +- `org.eclipse.edc.sql.lease.spi.LeaseStatements` (required) - `java.time.Clock` (required) Module `issuer-admin-api-authentication` ---------------------------------------- -**Artifact:** org.eclipse.edc:issuer-admin-api-authentication:0.18.0 +**Artifact:** org.eclipse.edc:issuer-admin-api-authentication:1.0.0-RC4 **Categories:** _None_ @@ -1117,7 +1150,7 @@ _None_ Module `issuer-admin-api-authentication-oauth2` ----------------------------------------------- -**Artifact:** org.eclipse.edc:issuer-admin-api-authentication-oauth2:0.18.0 +**Artifact:** org.eclipse.edc:issuer-admin-api-authentication-oauth2:1.0.0-RC4 **Categories:** _None_ @@ -1153,7 +1186,7 @@ _None_ Module `issuer-admin-api-authorization-oauth2` ---------------------------------------------- -**Artifact:** org.eclipse.edc:issuer-admin-api-authorization-oauth2:0.18.0 +**Artifact:** org.eclipse.edc:issuer-admin-api-authorization-oauth2:1.0.0-RC4 **Categories:** _None_ @@ -1177,7 +1210,7 @@ _None_ Module `issuer-admin-api-configuration` --------------------------------------- -**Artifact:** org.eclipse.edc:issuer-admin-api-configuration:0.18.0 +**Artifact:** org.eclipse.edc:issuer-admin-api-configuration:1.0.0-RC4 **Categories:** _None_ @@ -1208,7 +1241,7 @@ _None_ Module `issuerservice-attestation-definition-store-sql` ------------------------------------------------------- -**Artifact:** org.eclipse.edc:issuerservice-attestation-definition-store-sql:0.18.0 +**Artifact:** org.eclipse.edc:issuerservice-attestation-definition-store-sql:1.0.0-RC4 **Categories:** _None_ @@ -1241,7 +1274,7 @@ _None_ Module `issuerservice-core` --------------------------- -**Artifact:** org.eclipse.edc:issuerservice-core:0.18.0 +**Artifact:** org.eclipse.edc:issuerservice-core:1.0.0-RC4 **Categories:** _None_ @@ -1269,7 +1302,7 @@ _None_ Module `issuerservice-credential-definition-store-sql` ------------------------------------------------------ -**Artifact:** org.eclipse.edc:issuerservice-credential-definition-store-sql:0.18.0 +**Artifact:** org.eclipse.edc:issuerservice-credential-definition-store-sql:1.0.0-RC4 **Categories:** _None_ @@ -1303,7 +1336,7 @@ _None_ Module `issuerservice-credentials` ---------------------------------- -**Artifact:** org.eclipse.edc:issuerservice-credentials:0.18.0 +**Artifact:** org.eclipse.edc:issuerservice-credentials:1.0.0-RC4 **Categories:** _None_ @@ -1355,10 +1388,11 @@ _None_ - `org.eclipse.edc.identityhub.protocols.dcp.issuer.spi.DcpIssuerMetadataService` (required) - `org.eclipse.edc.issuerservice.spi.credentials.statuslist.StatusListInfoFactoryRegistry` (required) - `org.eclipse.edc.issuerservice.spi.credentials.statuslist.StatusListManager` (required) +- `org.eclipse.edc.jsonld.spi.JsonLd` (required) Module `issuerservice-database-attestations` -------------------------------------------- -**Artifact:** org.eclipse.edc:issuerservice-database-attestations:0.18.0 +**Artifact:** org.eclipse.edc:issuerservice-database-attestations:1.0.0-RC4 **Categories:** _None_ @@ -1386,7 +1420,7 @@ _None_ Module `issuerservice-holder-attestations` ------------------------------------------ -**Artifact:** org.eclipse.edc:issuerservice-holder-attestations:0.18.0 +**Artifact:** org.eclipse.edc:issuerservice-holder-attestations:1.0.0-RC4 **Categories:** _None_ @@ -1411,7 +1445,7 @@ _None_ Module `issuerservice-holder-store-sql` --------------------------------------- -**Artifact:** org.eclipse.edc:issuerservice-holder-store-sql:0.18.0 +**Artifact:** org.eclipse.edc:issuerservice-holder-store-sql:1.0.0-RC4 **Categories:** _None_ @@ -1444,7 +1478,7 @@ _None_ Module `issuerservice-holders` ------------------------------ -**Artifact:** org.eclipse.edc:issuerservice-holders:0.18.0 +**Artifact:** org.eclipse.edc:issuerservice-holders:1.0.0-RC4 **Categories:** _None_ @@ -1469,7 +1503,7 @@ _None_ Module `issuerservice-issuance` ------------------------------- -**Artifact:** org.eclipse.edc:issuerservice-issuance:0.18.0 +**Artifact:** org.eclipse.edc:issuerservice-issuance:1.0.0-RC4 **Categories:** _None_ @@ -1477,38 +1511,6 @@ Module `issuerservice-issuance` _None_ ### Extensions -#### Class: `org.eclipse.edc.issuerservice.issuance.IssuanceServicesExtension` -**Name:** "IssuerService Issuance Services Extension" - -**Overview:** No overview provided. - - -### Configuration_None_ - -#### Provided services -- `org.eclipse.edc.issuerservice.spi.issuance.credentialdefinition.CredentialDefinitionService` -- `org.eclipse.edc.issuerservice.spi.issuance.attestation.AttestationDefinitionService` -- `org.eclipse.edc.issuerservice.spi.issuance.attestation.AttestationPipeline` -- `org.eclipse.edc.issuerservice.spi.issuance.attestation.AttestationSourceFactoryRegistry` -- `org.eclipse.edc.issuerservice.spi.issuance.rule.CredentialRuleDefinitionEvaluator` -- `org.eclipse.edc.issuerservice.spi.issuance.mapping.IssuanceClaimsMapper` -- `org.eclipse.edc.issuerservice.spi.issuance.rule.CredentialRuleFactoryRegistry` -- `org.eclipse.edc.issuerservice.spi.issuance.rule.CredentialRuleDefinitionValidatorRegistry` -- `org.eclipse.edc.issuerservice.spi.issuance.generator.CredentialGeneratorRegistry` -- `org.eclipse.edc.issuerservice.spi.issuance.attestation.AttestationDefinitionValidatorRegistry` -- `org.eclipse.edc.issuerservice.spi.issuance.events.IssuanceObservable` - -#### Referenced (injected) services -- `org.eclipse.edc.transaction.spi.TransactionContext` (required) -- `org.eclipse.edc.issuerservice.spi.issuance.credentialdefinition.store.CredentialDefinitionStore` (required) -- `org.eclipse.edc.issuerservice.spi.issuance.attestation.AttestationDefinitionStore` (required) -- `org.eclipse.edc.identityhub.spi.keypair.KeyPairService` (required) -- `org.eclipse.edc.jwt.spi.signer.JwsSignerProvider` (required) -- `org.eclipse.edc.issuerservice.spi.holder.HolderService` (required) -- `java.time.Clock` (required) -- `org.eclipse.edc.identityhub.spi.participantcontext.IdentityHubParticipantContextService` (required) -- `org.eclipse.edc.spi.event.EventRouter` (required) - #### Class: `org.eclipse.edc.issuerservice.issuance.IssuanceCoreExtension` **Name:** "Issuance Core Extension" @@ -1533,6 +1535,7 @@ _None_ - `org.eclipse.edc.issuerservice.spi.issuance.generator.CredentialGeneratorRegistry` (required) - `org.eclipse.edc.issuerservice.spi.issuance.credentialdefinition.store.CredentialDefinitionStore` (required) - `org.eclipse.edc.identityhub.spi.verifiablecredentials.store.CredentialStore` (required) +- `org.eclipse.edc.spi.security.Vault` (required) - `org.eclipse.edc.spi.monitor.Monitor` (required) - `org.eclipse.edc.spi.telemetry.Telemetry` (required) - `org.eclipse.edc.spi.system.ExecutorInstrumentation` (required) @@ -1543,9 +1546,41 @@ _None_ - `org.eclipse.edc.issuerservice.spi.credentials.CredentialStatusService` (required) - `org.eclipse.edc.issuerservice.spi.issuance.events.IssuanceObservable` (required) +#### Class: `org.eclipse.edc.issuerservice.issuance.IssuanceServicesExtension` +**Name:** "IssuerService Issuance Services Extension" + +**Overview:** No overview provided. + + +### Configuration_None_ + +#### Provided services +- `org.eclipse.edc.issuerservice.spi.issuance.credentialdefinition.CredentialDefinitionService` +- `org.eclipse.edc.issuerservice.spi.issuance.attestation.AttestationDefinitionService` +- `org.eclipse.edc.issuerservice.spi.issuance.attestation.AttestationPipeline` +- `org.eclipse.edc.issuerservice.spi.issuance.attestation.AttestationSourceFactoryRegistry` +- `org.eclipse.edc.issuerservice.spi.issuance.rule.CredentialRuleDefinitionEvaluator` +- `org.eclipse.edc.issuerservice.spi.issuance.mapping.IssuanceClaimsMapper` +- `org.eclipse.edc.issuerservice.spi.issuance.rule.CredentialRuleFactoryRegistry` +- `org.eclipse.edc.issuerservice.spi.issuance.rule.CredentialRuleDefinitionValidatorRegistry` +- `org.eclipse.edc.issuerservice.spi.issuance.generator.CredentialGeneratorRegistry` +- `org.eclipse.edc.issuerservice.spi.issuance.attestation.AttestationDefinitionValidatorRegistry` +- `org.eclipse.edc.issuerservice.spi.issuance.events.IssuanceObservable` + +#### Referenced (injected) services +- `org.eclipse.edc.transaction.spi.TransactionContext` (required) +- `org.eclipse.edc.issuerservice.spi.issuance.credentialdefinition.store.CredentialDefinitionStore` (required) +- `org.eclipse.edc.issuerservice.spi.issuance.attestation.AttestationDefinitionStore` (required) +- `org.eclipse.edc.identityhub.spi.keypair.KeyPairService` (required) +- `org.eclipse.edc.jwt.spi.signer.JwsSignerProvider` (required) +- `org.eclipse.edc.issuerservice.spi.holder.HolderService` (required) +- `java.time.Clock` (required) +- `org.eclipse.edc.identityhub.spi.participantcontext.IdentityHubParticipantContextService` (required) +- `org.eclipse.edc.spi.event.EventRouter` (required) + Module `issuerservice-issuance-rules` ------------------------------------- -**Artifact:** org.eclipse.edc:issuerservice-issuance-rules:0.18.0 +**Artifact:** org.eclipse.edc:issuerservice-issuance-rules:1.0.0-RC4 **Categories:** _None_ @@ -1570,7 +1605,7 @@ _None_ Module `keypair-api` -------------------- -**Artifact:** org.eclipse.edc:keypair-api:0.18.0 +**Artifact:** org.eclipse.edc:keypair-api:1.0.0-RC4 **Categories:** _None_ @@ -1597,7 +1632,7 @@ _None_ Module `local-did-publisher` ---------------------------- -**Artifact:** org.eclipse.edc:local-did-publisher:0.18.0 +**Artifact:** org.eclipse.edc:local-did-publisher:1.0.0-RC4 **Categories:** _None_ @@ -1632,7 +1667,7 @@ _None_ Module `local-statuslist-publisher` ----------------------------------- -**Artifact:** org.eclipse.edc:local-statuslist-publisher:0.18.0 +**Artifact:** org.eclipse.edc:local-statuslist-publisher:1.0.0-RC4 **Categories:** _None_ @@ -1667,7 +1702,7 @@ _None_ Module `participant-context-api` -------------------------------- -**Artifact:** org.eclipse.edc:participant-context-api:0.18.0 +**Artifact:** org.eclipse.edc:participant-context-api:1.0.0-RC4 **Categories:** _None_ @@ -1694,7 +1729,7 @@ _None_ Module `presentation-api` ------------------------- -**Artifact:** org.eclipse.edc:presentation-api:0.18.0 +**Artifact:** org.eclipse.edc:presentation-api:1.0.0-RC4 **Categories:** _None_ @@ -1726,7 +1761,7 @@ _None_ Module `storage-api` -------------------- -**Artifact:** org.eclipse.edc:storage-api:0.18.0 +**Artifact:** org.eclipse.edc:storage-api:1.0.0-RC4 **Categories:** _None_ @@ -1758,7 +1793,7 @@ _None_ Module `sts-account-provisioner` -------------------------------- -**Artifact:** org.eclipse.edc:sts-account-provisioner:0.18.0 +**Artifact:** org.eclipse.edc:sts-account-provisioner:1.0.0-RC4 **Categories:** _None_ @@ -1786,7 +1821,7 @@ _None_ Module `sts-account-service-local` ---------------------------------- -**Artifact:** org.eclipse.edc:sts-account-service-local:0.18.0 +**Artifact:** org.eclipse.edc:sts-account-service-local:1.0.0-RC4 **Categories:** _None_ @@ -1813,7 +1848,7 @@ _None_ Module `sts-api` ---------------- -**Artifact:** org.eclipse.edc:sts-api:0.18.0 +**Artifact:** org.eclipse.edc:sts-api:1.0.0-RC4 **Categories:** _None_ @@ -1821,6 +1856,22 @@ Module `sts-api` _None_ ### Extensions +#### Class: `org.eclipse.edc.api.iam.decentralizedclaims.sts.SecureTokenServiceApiExtension` +**Name:** "Secure Token Service API" + +**Overview:** No overview provided. + + +### Configuration_None_ + +#### Provided services +_None_ + +#### Referenced (injected) services +- `org.eclipse.edc.iam.decentralizedclaims.sts.spi.service.StsAccountService` (required) +- `org.eclipse.edc.iam.decentralizedclaims.sts.spi.service.StsClientTokenGeneratorService` (required) +- `org.eclipse.edc.web.spi.WebService` (required) + #### Class: `org.eclipse.edc.api.iam.decentralizedclaims.sts.StsApiConfigurationExtension` **Name:** "Secure Token Service API configuration" @@ -1842,25 +1893,9 @@ _None_ - `org.eclipse.edc.spi.types.TypeManager` (required) - `org.eclipse.edc.spi.system.apiversion.ApiVersionService` (required) -#### Class: `org.eclipse.edc.api.iam.decentralizedclaims.sts.SecureTokenServiceApiExtension` -**Name:** "Secure Token Service API" - -**Overview:** No overview provided. - - -### Configuration_None_ - -#### Provided services -_None_ - -#### Referenced (injected) services -- `org.eclipse.edc.iam.decentralizedclaims.sts.spi.service.StsAccountService` (required) -- `org.eclipse.edc.iam.decentralizedclaims.sts.spi.service.StsClientTokenGeneratorService` (required) -- `org.eclipse.edc.web.spi.WebService` (required) - Module `sts-client-store-sql` ----------------------------- -**Artifact:** org.eclipse.edc:sts-client-store-sql:0.18.0 +**Artifact:** org.eclipse.edc:sts-client-store-sql:1.0.0-RC4 **Categories:** _None_ @@ -1893,7 +1928,7 @@ _None_ Module `sts-core` ----------------- -**Artifact:** org.eclipse.edc:sts-core:0.18.0 +**Artifact:** org.eclipse.edc:sts-core:1.0.0-RC4 **Categories:** _None_ @@ -1929,18 +1964,34 @@ _None_ #### Provided services - `org.eclipse.edc.identityhub.spi.authentication.ParticipantSecureTokenService` -- `org.eclipse.edc.iam.decentralizedclaims.sts.spi.service.StsClientTokenGeneratorService` #### Referenced (injected) services - `java.time.Clock` (required) - `org.eclipse.edc.jwt.spi.signer.JwsSignerProvider` (required) - `org.eclipse.edc.transaction.spi.TransactionContext` (required) -- `org.eclipse.edc.iam.decentralizedclaims.sts.spi.service.StsAccountService` (required) - `org.eclipse.edc.identityhub.spi.keypair.KeyPairService` (required) +#### Class: `org.eclipse.edc.iam.decentralizedclaims.sts.StsClientTokenGeneratorExtension` +**Name:** "STS Client Token Generator Extension" + +**Overview:** No overview provided. + + +### Configuration + +| Key | Required | Type | Default | Pattern | Min | Max | Description | +| ------------------------------ | -------- | -------- | ------- | ------- | --- | --- | ------------------------------------------------------------------- | +| `edc.iam.sts.token.expiration` | `*` | `string` | `5` | | | | Self-issued ID Token expiration in minutes. By default is 5 minutes | + +#### Provided services +- `org.eclipse.edc.iam.decentralizedclaims.sts.spi.service.StsClientTokenGeneratorService` + +#### Referenced (injected) services +- `org.eclipse.edc.identityhub.spi.authentication.ParticipantSecureTokenService` (required) + Module `test-attestations` -------------------------- -**Artifact:** org.eclipse.edc:test-attestations:0.18.0 +**Artifact:** org.eclipse.edc:test-attestations:1.0.0-RC4 **Categories:** _None_ @@ -1965,7 +2016,7 @@ _None_ Module `verifiable-credentials-api` ----------------------------------- -**Artifact:** org.eclipse.edc:verifiable-credentials-api:0.18.0 +**Artifact:** org.eclipse.edc:verifiable-credentials-api:1.0.0-RC4 **Categories:** _None_