This is the multi-page printable view of this section. Click here to print.

Return to the regular view of this page.

Autodoc

This section contains rendering of the autodoc plugin (details).

1 - Connector

Module aes-encryption

Artifact: org.eclipse.edc:aes-encryption:1.0.0-RC7

Categories: None

Extension points

None

Extensions

Class: org.eclipse.edc.encryption.aes.AesEncryptionExtension

Name: “AES Encryption Extension”

Overview: No overview provided.

Configuration

KeyRequiredTypeDefaultPatternMinMaxDescription
edc.encryption.aes.key.aliasstring``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:1.0.0-RC7

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:1.0.0-RC7

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:1.0.0-RC7

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:1.0.0-RC7

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:1.0.0-RC7

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

KeyRequiredTypeDefaultPatternMinMaxDescription
edc.sql.store.asset.datasource*stringdefaultThe 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:1.0.0-RC7

Categories: None

Extension points

None

Extensions

Class: org.eclipse.edc.api.auth.configuration.ApiAuthenticationConfigurationExtension

Name: “Api Authentication Configuration Extension”

Overview: No overview provided.

Configuration

KeyRequiredTypeDefaultPatternMinMaxDescription
web.http.<alias>.auth.typestring``
web.http.<alias>.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:1.0.0-RC7

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

KeyRequiredTypeDefaultPatternMinMaxDescription
web.http.<context>.auth.dac.key.url*string``URL where the third-party IdP’s public key(s) can be resolved for the configured
web.http.<context>.auth.dac.cache.validity*string300000Duration (in ms) that the internal key cache is valid for the configured
edc.participant.id*stringanonymousConfigures the participant id this runtime is operating on behalf of
edc.api.auth.dac.validation.tolerance*string5000Default token validation time tolerance (in ms), e.g. for nbf or exp claims
web.http.management.auth.dac.audiencestring``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-tokenbased

Artifact: org.eclipse.edc:auth-tokenbased:1.0.0-RC7

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

KeyRequiredTypeDefaultPatternMinMaxDescription
web.http.<context>.auth.key*string``The api key to use for the
web.http.<context>.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:1.0.0-RC7

Categories: None

Extension points

None

Extensions

Class: org.eclipse.edc.boot.BootServicesExtension

Name: “Boot Services”

Overview: No overview provided.

Configuration

KeyRequiredTypeDefaultPatternMinMaxDescription
edc.runtime.id*string<random UUID>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<random UUID>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:1.0.0-RC7

Categories: None

Extension points

None

Extensions

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)
  • org.eclipse.edc.connector.controlplane.services.spi.callback.ParticipantCallbackResolver (required)

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
  • org.eclipse.edc.connector.controlplane.services.spi.callback.ParticipantCallbackResolver

Referenced (injected) services

  • org.eclipse.edc.http.spi.EdcHttpClient (required)
  • org.eclipse.edc.spi.types.TypeManager (required)
  • org.eclipse.edc.spi.security.Vault (required)
  • org.eclipse.edc.participantcontext.spi.config.ParticipantContextConfig (optional)
  • org.eclipse.edc.participantcontext.spi.config.validation.ParticipantContextConfigValidatorRegistry (optional)
  • org.eclipse.edc.spi.monitor.Monitor (required)

Module callback-static-endpoint

Artifact: org.eclipse.edc:callback-static-endpoint:1.0.0-RC7

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

KeyRequiredTypeDefaultPatternMinMaxDescription
edc.callback.<alias>.uri*string``URI of the callback endpoint.
edc.callback.<alias>.events*string``Comma separated list of events to trigger the callback. If not provided, the callback will be triggered for all events.
edc.callback.<alias>.transactional*stringfalseWhether the callback should be invoked in a transactional context. Default is false.
edc.callback.<alias>.auth.keystring``Authentication key to use for the callback. If not provided, no authentication will be used.
edc.callback.<alias>.auth.codeidstring``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)

Module catalog-api

Artifact: org.eclipse.edc:catalog-api:1.0.0-RC7

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:1.0.0-RC7

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:1.0.0-RC7

Categories: None

Extension points

None

Extensions

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

Referenced (injected) services

  • org.eclipse.edc.catalog.spi.FederatedCatalogCache (required)

Class: org.eclipse.edc.catalog.crawler.CatalogCrawlerCoreExtension

Name: “Catalog Crawler Core”

Overview: No overview provided.

Configuration

KeyRequiredTypeDefaultPatternMinMaxDescription
edc.catalog.cache.execution.enabled*stringtrueDetermines whether catalog crawling is globally enabled or disabled
edc.catalog.cache.partition.num.crawlers*string2The number of crawlers (execution threads) that should be used. The engine will re-use crawlers when necessary.
edc.catalog.cache.execution.period.seconds*string60The time to elapse between two crawl runs
edc.catalog.cache.execution.delay.secondsstring0The initial delay for the cache crawler engine
edc.catalog.cache.retry.retries.max*string5How many retries will be executed in case of crawler failure
edc.catalog.cache.retry.delay.seconds*string10How 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.TargetNodeDirectory (required)
  • org.eclipse.edc.participantcontext.spi.store.ParticipantContextStore (required)
  • org.eclipse.edc.connector.controlplane.services.spi.protocol.ProtocolRemoteMessageDispatcher (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.spi.event.EventRouter (required)
  • org.eclipse.edc.crawler.spi.TargetNodeFilter (optional)
  • org.eclipse.edc.spi.system.health.HealthCheckService (optional)

Module cel-api-v5

Artifact: org.eclipse.edc:cel-api-v5:1.0.0-RC7

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:1.0.0-RC7

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

KeyRequiredTypeDefaultPatternMinMaxDescription
edc.policy.cel.expressions.cache.ttl.ms*string5000How long (in milliseconds) the registered CEL expressions are kept in memory before they are read from the store again. Changes made through this runtime apply immediately, changes made by other replicas within this time. 0 reads them from the store on every policy evaluation.

Provided services

  • org.eclipse.edc.policy.cel.engine.CelExpressionEngine
  • org.eclipse.edc.policy.cel.service.CelPolicyExpressionService
  • org.eclipse.edc.policy.cel.function.context.CelParticipantAgentClaimMapperRegistry
  • org.eclipse.edc.policy.cel.function.CelFunctionRegistry

Referenced (injected) services

  • java.time.Clock (required)
  • 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.spi.monitor.Monitor (required)

Module cel-store-sql

Artifact: org.eclipse.edc:cel-store-sql:1.0.0-RC7

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

KeyRequiredTypeDefaultPatternMinMaxDescription
edc.sql.store.cel.datasource*stringdefaultThe 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:1.0.0-RC7

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

KeyRequiredTypeDefaultPatternMinMaxDescription
edc.fs.config*string``

Provided services

None

Referenced (injected) services

None

Module connector-core

Artifact: org.eclipse.edc:connector-core:1.0.0-RC7

Categories: None

Extension points

None

Extensions

Class: org.eclipse.edc.connector.core.CoreDefaultServicesExtension

Name: “CoreDefaultServicesExtension”

Overview: No overview provided.

Configuration_None_

Provided services

  • org.eclipse.edc.participant.spi.ParticipantIdMapper
  • org.eclipse.edc.protocol.spi.DataspaceProfileContextRegistry
  • org.eclipse.edc.policy.engine.spi.RuleBindingRegistry

Referenced (injected) services

None

Class: org.eclipse.edc.connector.core.discovery.DiscoveryServicesExtension

Name: “Discovery Services”

Overview: No overview provided.

Configuration_None_

Provided services

None

Referenced (injected) services

  • org.eclipse.edc.protocol.spi.discovery.DiscoveryService (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.PolicyEngine
  • org.eclipse.edc.policy.context.request.spi.RequestScopeExtractorRegistry

Referenced (injected) services

  • org.eclipse.edc.spi.types.TypeManager (required)
  • org.eclipse.edc.policy.engine.spi.RuleBindingRegistry (required)

Class: org.eclipse.edc.connector.core.discovery.DiscoveryDefaultServicesExtension

Name: “Discovery Default Services”

Overview: No overview provided.

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)

Module connector-runtime

Artifact: org.eclipse.edc:connector-runtime:1.0.0-RC7

Categories: None

Extension points

None

Extensions

Class: org.eclipse.edc.federatedcatalog.end2end.DataplaneInstanceRegistrationExtension

Name: “DataplaneInstanceRegistrationExtension”

Configuration_None_

Provided services

None

Referenced (injected) services

  • org.eclipse.edc.connector.controlplane.dataplane.spi.store.DataPlaneInstanceStore (required)
  • org.eclipse.edc.participantcontext.single.spi.SingleParticipantContextSupplier (required)

Module console-monitor

Artifact: org.eclipse.edc:console-monitor:1.0.0-RC7

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:1.0.0-RC7

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:1.0.0-RC7

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:1.0.0-RC7

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:1.0.0-RC7

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:1.0.0-RC7

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

KeyRequiredTypeDefaultPatternMinMaxDescription
edc.sql.store.contractdefinition.datasource*stringdefaultThe 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:1.0.0-RC7

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:1.0.0-RC7

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.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:1.0.0-RC7

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

KeyRequiredTypeDefaultPatternMinMaxDescription
edc.sql.store.contractnegotiation.datasource*stringdefaultThe datasource to be used
edc.negotiation.state-machine.lease-duration*stringPT60SHow long a runtime keeps the lease on a contract negotiation while processing it, in ISO-8601 duration format. It must be longer than the slowest processing step, e.g. a protocol message dispatch including HTTP timeouts and retries, otherwise the contract negotiation can be processed again, by another runtime or by the same one

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)

Module control-plane-aggregate-services

Artifact: org.eclipse.edc:control-plane-aggregate-services:1.0.0-RC7

Categories: None

Extension points

None

Extensions

Class: org.eclipse.edc.connector.controlplane.services.ControlPlaneServicesExtension

Name: “Control Plane Services”

Overview: No overview provided.

Configuration

KeyRequiredTypeDefaultPatternMinMaxDescription
edc.policy.validation.enabled*stringtrueIf 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.partner.PartnerService
  • org.eclipse.edc.connector.controlplane.services.spi.partner.PartnerGroupService
  • 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.policy.context.request.spi.RequestScopeExtractorRegistry (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)
  • org.eclipse.edc.connector.controlplane.partner.spi.store.PartnerStore (required)
  • org.eclipse.edc.connector.controlplane.partner.spi.store.PartnerGroupStore (required)

Class: org.eclipse.edc.connector.controlplane.services.ControlPlaneDataPlaneServicesExtension

Name: “Control Plane Data Plane Services”

Overview: No overview provided.

Configuration

KeyRequiredTypeDefaultPatternMinMaxDescription
edc.dataplane.client.selector.strategy*stringrandomDefines strategy for Data Plane instance selection in case Data Plane is not embedded in current runtime

Provided services

  • org.eclipse.edc.connector.controlplane.dataplane.spi.DataPlaneSelectorService

Referenced (injected) services

  • org.eclipse.edc.connector.controlplane.dataplane.spi.store.DataPlaneInstanceStore (required)
  • org.eclipse.edc.connector.controlplane.dataplane.spi.strategy.SelectionStrategyRegistry (required)
  • org.eclipse.edc.transaction.spi.TransactionContext (required)

Module control-plane-catalog

Artifact: org.eclipse.edc:control-plane-catalog:1.0.0-RC7

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:1.0.0-RC7

Categories: None

Extension points

None

Extensions

Class: org.eclipse.edc.connector.controlplane.contract.ContractNegotiationDefaultServicesExtension

Name: “Contract Negotiation Default Services”

Overview: No overview provided.

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: No overview provided.

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)

Class: org.eclipse.edc.connector.controlplane.contract.ContractCoreExtension

Name: “Contract Core”

Overview: No overview provided.

Configuration

KeyRequiredTypeDefaultPatternMinMaxDescription
edc.negotiation.state-machine.iteration-wait-millis*string1000The iteration wait time in milliseconds in the state machine.
edc.negotiation.state-machine.batch-size*string20The number of entities to be processed on every iteration.
edc.negotiation.send.retry.limit*string7How many times a specific operation must be tried before failing with error
edc.negotiation.send.retry.base-delay.ms*string1000The base delay for the consumer negotiation retry mechanism in millisecond
edc.negotiation.approval.enabled*stringfalseEnables the manual approval of provider contract negotiations, driven by the contract policy evaluation in the ‘approval.contract.negotiation’ scope

Provided services

  • org.eclipse.edc.connector.controlplane.contract.spi.validation.ContractValidationService
  • org.eclipse.edc.connector.controlplane.contract.spi.negotiation.ContractNegotiationPendingGuardRegistry
  • 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.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.connector.controlplane.contract.spi.offer.store.ContractDefinitionStore (required)
  • org.eclipse.edc.participantcontext.spi.identity.ParticipantIdentityResolver (required)
  • org.eclipse.edc.connector.controlplane.services.spi.protocol.ProtocolRemoteMessageDispatcher (required)

Module control-plane-contract-manager

Artifact: org.eclipse.edc:control-plane-contract-manager:1.0.0-RC7

Categories: None

Extension points

None

Extensions

Class: org.eclipse.edc.connector.controlplane.contract.ContractManagerExtension

Name: “Contract Manager”

Overview: No overview provided.

Configuration

KeyRequiredTypeDefaultPatternMinMaxDescription
edc.negotiation.state-machine.iteration-wait-millis*string1000The iteration wait time in milliseconds in the state machine.
edc.negotiation.state-machine.batch-size*string20The number of entities to be processed on every iteration.
edc.negotiation.send.retry.limit*string7How many times a specific operation must be tried before failing with error
edc.negotiation.send.retry.base-delay.ms*string1000The 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.connector.controlplane.contract.spi.negotiation.ContractNegotiationPendingGuardRegistry (required)
  • org.eclipse.edc.spi.system.ExecutorInstrumentation (required)
  • org.eclipse.edc.connector.controlplane.contract.spi.negotiation.NegotiationProcessors (required)
  • org.eclipse.edc.spi.system.health.HealthCheckService (required)

Module control-plane-contract-task-executor

Artifact: org.eclipse.edc:control-plane-contract-task-executor:1.0.0-RC7

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.connector.controlplane.contract.spi.negotiation.ContractNegotiationPendingGuardRegistry (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)
  • org.eclipse.edc.spi.telemetry.Telemetry (required)

Module control-plane-core

Artifact: org.eclipse.edc:control-plane-core:1.0.0-RC7

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

KeyRequiredTypeDefaultPatternMinMaxDescription
edc.transfer.state-machine.lease-duration*stringPT60SHow long a runtime keeps the lease on a transfer process while processing it, in ISO-8601 duration format. It must be longer than the slowest processing step, e.g. a protocol message dispatch including HTTP timeouts and retries, otherwise the transfer process can be processed again, by another runtime or by the same one
edc.negotiation.state-machine.lease-duration*stringPT60SHow long a runtime keeps the lease on a contract negotiation while processing it, in ISO-8601 duration format. It must be longer than the slowest processing step, e.g. a protocol message dispatch including HTTP timeouts and retries, otherwise the contract negotiation can be processed again, by another runtime or by the same one

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.protocol.spi.store.DataspaceProfileStore
  • org.eclipse.edc.connector.controlplane.partner.spi.store.PartnerStore
  • org.eclipse.edc.connector.controlplane.partner.spi.store.PartnerGroupStore
  • org.eclipse.edc.connector.controlplane.services.spi.callback.CallbackRegistry
  • org.eclipse.edc.connector.controlplane.dataplane.spi.store.DataPlaneInstanceStore
  • org.eclipse.edc.connector.controlplane.dataplane.spi.strategy.SelectionStrategyRegistry

Referenced (injected) services

  • java.time.Clock (required)
  • org.eclipse.edc.spi.query.CriterionOperatorRegistry (required)
  • org.eclipse.edc.spi.monitor.Monitor (required)

Module control-plane-spi

Name: Control Plane SPI Artifact: org.eclipse.edc:control-plane-spi:1.0.0-RC7

Categories: None

Extension points

  • org.eclipse.edc.spi.iam.IdentityService
  • org.eclipse.edc.participant.spi.ParticipantIdMapper
  • org.eclipse.edc.crawler.spi.TargetNodeFilter
  • org.eclipse.edc.crawler.spi.TargetNodeDirectory
  • org.eclipse.edc.participantcontext.spi.config.validation.ParticipantContextConfigValidatorRegistry
  • org.eclipse.edc.participantcontext.single.spi.SingleParticipantContextSupplier
  • org.eclipse.edc.catalog.spi.FederatedCatalogCache
  • org.eclipse.edc.policy.context.request.spi.RequestScopeExtractorRegistry
  • org.eclipse.edc.policy.cel.function.context.CelParticipantAgentClaimMapperRegistry
  • org.eclipse.edc.policy.cel.function.CelFunctionRegistry
  • org.eclipse.edc.policy.engine.spi.PolicyEngine
  • org.eclipse.edc.policy.engine.spi.RuleBindingRegistry
  • org.eclipse.edc.controlplane.tasks.TaskObservable
  • org.eclipse.edc.controlplane.iam.AudienceResolver
  • org.eclipse.edc.controlplane.contract.spi.negotiation.ContractNegotiationTaskExecutor
  • org.eclipse.edc.controlplane.transfer.spi.TransferProcessTaskExecutor
  • 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.ContractNegotiationPendingGuard
  • org.eclipse.edc.connector.controlplane.contract.spi.negotiation.ProviderContractNegotiationManager
  • org.eclipse.edc.connector.controlplane.contract.spi.negotiation.NegotiationWaitStrategy
  • org.eclipse.edc.connector.controlplane.contract.spi.negotiation.ConsumerContractNegotiationManager
  • org.eclipse.edc.connector.controlplane.contract.spi.negotiation.ContractNegotiationPendingGuardRegistry
  • org.eclipse.edc.connector.controlplane.contract.spi.offer.store.ContractDefinitionStore
  • org.eclipse.edc.connector.controlplane.contract.spi.validation.ContractValidationService
  • org.eclipse.edc.connector.controlplane.services.spi.callback.CallbackRegistry
  • org.eclipse.edc.connector.controlplane.services.spi.callback.ParticipantCallbackResolver
  • org.eclipse.edc.connector.controlplane.services.spi.protocol.ProtocolTokenValidator
  • org.eclipse.edc.connector.controlplane.services.spi.policydefinition.PolicyDefinitionService
  • org.eclipse.edc.connector.controlplane.catalog.spi.ContractDefinitionResolver
  • org.eclipse.edc.connector.controlplane.policy.spi.store.PolicyArchive
  • org.eclipse.edc.connector.controlplane.policy.spi.store.PolicyDefinitionStore
  • org.eclipse.edc.connector.controlplane.asset.spi.index.AssetIndex
  • org.eclipse.edc.connector.controlplane.asset.spi.index.DataAddressResolver
  • org.eclipse.edc.connector.controlplane.transfer.spi.store.TransferProcessStore
  • org.eclipse.edc.connector.controlplane.transfer.spi.observe.TransferProcessObservable
  • org.eclipse.edc.connector.controlplane.transfer.spi.TransferProcessManager
  • org.eclipse.edc.connector.controlplane.transfer.spi.TransferProcessPendingGuard
  • org.eclipse.edc.connector.controlplane.dataplane.spi.DataPlaneSelectorService
  • org.eclipse.edc.connector.controlplane.partner.spi.store.PartnerStore
  • org.eclipse.edc.connector.controlplane.partner.spi.store.PartnerGroupStore
  • org.eclipse.edc.protocol.spi.ParticipantProfileService
  • org.eclipse.edc.protocol.spi.store.DataspaceProfileStore
  • org.eclipse.edc.protocol.spi.DefaultParticipantIdExtractionFunction
  • org.eclipse.edc.protocol.spi.service.DataspaceProfileService
  • org.eclipse.edc.protocol.spi.ProtocolWebhookResolver
  • org.eclipse.edc.protocol.spi.discovery.DiscoveryService
  • org.eclipse.edc.protocol.spi.ParticipantIdExtractionFunction

Extensions

Module control-plane-transfer

Artifact: org.eclipse.edc:control-plane-transfer:1.0.0-RC7

Categories: None

Extension points

None

Extensions

Class: org.eclipse.edc.connector.controlplane.transfer.TransferCoreExtension

Name: “Transfer Core”

Overview: No overview provided.

Configuration

KeyRequiredTypeDefaultPatternMinMaxDescription
edc.transfer.state-machine.iteration-wait-millis*string1000The iteration wait time in milliseconds in the state machine.
edc.transfer.state-machine.batch-size*string20The number of entities to be processed on every iteration.
edc.transfer.send.retry.limit*string7How many times a specific operation must be tried before failing with error
edc.transfer.send.retry.base-delay.ms*string1000The 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: No overview provided.

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.types.DataAddressStore

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: No overview provided.

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:1.0.0-RC7

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

KeyRequiredTypeDefaultPatternMinMaxDescription
edc.transfer.state-machine.iteration-wait-millis*string1000The iteration wait time in milliseconds in the state machine.
edc.transfer.state-machine.batch-size*string20The number of entities to be processed on every iteration.
edc.transfer.send.retry.limit*string7How many times a specific operation must be tried before failing with error
edc.transfer.send.retry.base-delay.ms*string1000The 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)
  • org.eclipse.edc.spi.system.health.HealthCheckService (required)

Module control-plane-transfer-task-executor

Artifact: org.eclipse.edc:control-plane-transfer-task-executor:1.0.0-RC7

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)
  • org.eclipse.edc.spi.telemetry.Telemetry (required)

Module core-spi

Name: Core services Artifact: org.eclipse.edc:core-spi:1.0.0-RC7

Categories: None

Extension points

  • org.eclipse.edc.spi.security.SignatureService
  • org.eclipse.edc.spi.security.Vault
  • org.eclipse.edc.spi.monitor.Monitor
  • org.eclipse.edc.spi.event.EventRouter
  • org.eclipse.edc.spi.command.CommandHandlerRegistry
  • org.eclipse.edc.spi.system.ExecutorInstrumentation
  • org.eclipse.edc.spi.system.health.HealthCheckService
  • org.eclipse.edc.keys.spi.PrivateKeyResolver
  • org.eclipse.edc.keys.spi.LocalPublicKeyService
  • org.eclipse.edc.iam.oauth2.spi.client.Oauth2Client
  • org.eclipse.edc.iam.did.spi.store.DidStore
  • org.eclipse.edc.iam.did.spi.resolution.DidResolverRegistry
  • org.eclipse.edc.iam.did.spi.resolution.DidPublicKeyResolver
  • org.eclipse.edc.iam.did.spi.credentials.CredentialsVerifier
  • org.eclipse.edc.document.cache.spi.store.CachedDocumentStore
  • org.eclipse.edc.document.cache.spi.CachedDocumentService
  • org.eclipse.edc.document.cache.spi.resolver.DocumentResolver
  • org.eclipse.edc.transaction.spi.TransactionContext
  • org.eclipse.edc.transaction.datasource.spi.DataSourceRegistry
  • org.eclipse.edc.web.spi.WebService
  • org.eclipse.edc.web.spi.WebServer
  • org.eclipse.edc.web.spi.validation.InterceptorFunctionRegistry
  • org.eclipse.edc.api.auth.spi.ApiAuthenticationProvider
  • org.eclipse.edc.api.auth.spi.AuthenticationService
  • org.eclipse.edc.api.auth.spi.registry.ApiAuthenticationProviderRegistry
  • org.eclipse.edc.encryption.EncryptionAlgorithmRegistry
  • org.eclipse.edc.jwt.spi.signer.JwsSignerProvider
  • org.eclipse.edc.jwt.validation.jti.JtiValidationStore
  • org.eclipse.edc.vault.hashicorp.spi.auth.HashicorpVaultTokenProviderFactory
  • org.eclipse.edc.vault.hashicorp.spi.auth.HashicorpVaultTokenProvider
  • org.eclipse.edc.validator.registration.spi.store.SchemaValidatorRegistrationStore
  • org.eclipse.edc.validator.registration.spi.SchemaValidatorFactory
  • org.eclipse.edc.validator.registration.spi.SchemaValidatorRegistrationService

Extensions

Module data-plane-instance-store-sql

Artifact: org.eclipse.edc:data-plane-instance-store-sql:1.0.0-RC7

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

KeyRequiredTypeDefaultPatternMinMaxDescription
edc.sql.store.dataplaneinstance.datasource*stringdefaultThe datasource to be used

Provided services

  • org.eclipse.edc.connector.controlplane.dataplane.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)
  • org.eclipse.edc.sql.bootstrapper.SqlSchemaBootstrapper (required)

Module data-plane-selector-api

Artifact: org.eclipse.edc:data-plane-selector-api:1.0.0-RC7

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.controlplane.dataplane.spi.DataPlaneSelectorService (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.participantcontext.single.spi.SingleParticipantContextSupplier (required)

Module data-plane-selector-api-v5

Artifact: org.eclipse.edc:data-plane-selector-api-v5:1.0.0-RC7

Categories: None

Extension points

None

Extensions

Class: org.eclipse.edc.connector.dataplane.selector.DataPlaneSelectorApiV5Extension

Name: “Management API: Dataplane Selector V5”

Overview: No overview provided.

Configuration_None_

Provided services

None

Referenced (injected) services

  • org.eclipse.edc.web.spi.WebService (required)
  • org.eclipse.edc.connector.controlplane.dataplane.spi.DataPlaneSelectorService (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.api.auth.spi.AuthorizationService (required)

Module data-plane-signaling-core

Artifact: org.eclipse.edc:data-plane-signaling-core:1.0.0-RC7

Categories: None

Extension points

None

Extensions

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.DataPlaneSignalingApiExtension

Name: “Data Plane Signaling Api”

Overview: No overview provided.

Configuration

KeyRequiredTypeDefaultPatternMinMaxDescription
web.http.signaling.port*string8182Port for signaling api context
web.http.signaling.path*string/api/signalingPath for signaling api context

Provided services

None

Referenced (injected) services

  • org.eclipse.edc.web.spi.configuration.PortMappingRegistry (required)
  • org.eclipse.edc.connector.controlplane.dataplane.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.DataPlaneSignalingFlowControllerExtension

Name: “Data Plane Signaling Api”

Overview: No overview provided.

Configuration_None_

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.controlplane.dataplane.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:1.0.0-RC7

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-signaling-oauth2-token-exchange

Artifact: org.eclipse.edc:data-plane-signaling-oauth2-token-exchange:1.0.0-RC7

Categories: None

Extension points

None

Extensions

Class: org.eclipse.edc.signaling.oauth2.tokenexchange.DataPlaneSignalingOauth2TokenExchangeExtension

Name: “Data Plane Signaling OAuth2 Token Exchange”

Overview: Registers the {@code oauth2_token_exchange} Data Plane Signaling authorization profile.

Configuration

KeyRequiredTypeDefaultPatternMinMaxDescription
edc.dps.oauth2.tokenexchange.subjecttokenpath*string/var/run/secrets/kubernetes.io/serviceaccount/tokenPath to the file holding the workload credential (e.g. a projected Kubernetes ServiceAccount token) presented to the token exchange broker as the subject token
edc.dps.oauth2.tokenexchange.scopestring``The scope requested for the exchanged token, used when the authorization profile does not carry one
edc.dps.oauth2.tokenexchange.audience*stringedcvThe audience requested for the exchanged token. Must match the token-exchange service’s configured audience.

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)
  • org.eclipse.edc.keys.spi.KeyParserRegistry (required)
  • org.eclipse.edc.jwt.validation.jti.JtiValidationStore (required)
  • java.time.Clock (required)

Module dataspace-profile-context-api-v5

Artifact: org.eclipse.edc:dataspace-profile-context-api-v5:1.0.0-RC7

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)
  • org.eclipse.edc.protocol.spi.service.DataspaceProfileService (required)

Module dataspace-profile-store-sql

Artifact: org.eclipse.edc:dataspace-profile-store-sql:1.0.0-RC7

Categories: None

Extension points

  • org.eclipse.edc.connector.controlplane.store.sql.dataspaceprofile.store.schema.DataspaceProfileStoreStatements

Extensions

Class: org.eclipse.edc.connector.controlplane.store.sql.dataspaceprofile.SqlDataspaceProfileStoreExtension

Name: “SQL dataspace profile store”

Overview: No overview provided.

Configuration

KeyRequiredTypeDefaultPatternMinMaxDescription
edc.sql.store.dataspaceprofile.datasource*stringdefaultThe datasource to be used

Provided services

  • org.eclipse.edc.protocol.spi.store.DataspaceProfileStore

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.dataspaceprofile.store.schema.DataspaceProfileStoreStatements (optional)
  • org.eclipse.edc.spi.types.TypeManager (required)
  • org.eclipse.edc.sql.QueryExecutor (required)
  • org.eclipse.edc.sql.bootstrapper.SqlSchemaBootstrapper (required)

Module dcp-scope-api-v5

Artifact: org.eclipse.edc:dcp-scope-api-v5:1.0.0-RC7

Categories: None

Extension points

None

Extensions

Class: org.eclipse.edc.connector.controlplane.api.management.dcpscope.DcpScopeApiV5Extension

Name: “DcpScope 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.iam.decentralizedclaims.spi.scope.DcpScopeRegistry (required)
  • org.eclipse.edc.spi.monitor.Monitor (required)

Module decentralized-claims-cel

Artifact: org.eclipse.edc:decentralized-claims-cel:1.0.0-RC7

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)
  • org.eclipse.edc.policy.cel.function.CelFunctionRegistry (required)
  • java.time.Clock (required)

Module decentralized-claims-core

Artifact: org.eclipse.edc:decentralized-claims-core:1.0.0-RC7

Categories: iam, transform, jsonld, iam, transform, jsonld

Extension points

None

Extensions

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.decentralizedclaims.spi.verification.SignatureSuiteRegistry
  • org.eclipse.edc.protocol.spi.DefaultParticipantIdExtractionFunction
  • org.eclipse.edc.iam.decentralizedclaims.spi.scope.ScopeExtractorRegistry
  • org.eclipse.edc.controlplane.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.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.transaction.spi.TransactionContext (required)
  • org.eclipse.edc.iam.decentralizedclaims.spi.scope.store.DcpScopeStore (required)
  • org.eclipse.edc.iam.decentralizedclaims.spi.scope.ScopeExtractorRegistry (required)

Class: org.eclipse.edc.iam.decentralizedclaims.core.DcpCoreExtension

Name: “DCP Core Extension”

Overview: No overview provided.

Configuration

KeyRequiredTypeDefaultPatternMinMaxDescription
edc.participant.didstring``DID of the participant, only needed if different from the value in edc.participant.id
edc.sql.store.jti.cleanup.period*string60The period of the JTI entry reaper thread in seconds
edc.iam.accesstoken.jti.validation*stringtrueActivate or deactivate JTI validation
edc.iam.presentation.binding.required*stringfalseRejects Verifiable Presentations that are not bound to an audience and an expiry: JWT presentations without ’exp’ and VCDM 2.0 presentations without ‘aud’, Linked-Data presentations without a proof ‘domain’ and ’expires’. If disabled, these are only checked when present.
edc.iam.vc.validation.schema.subject-only*stringfalseWhen set to true, the JSON schema referenced in a VC will be validated only against the credential subjects instead of the credential itself.

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.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.participantcontext.spi.config.validation.ParticipantContextConfigValidatorRegistry (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.DcpScopeExtractorExtension

Name: “DCP scope extractor extension”

Overview: No overview provided.

Configuration_None_

Provided services

None

Referenced (injected) services

  • org.eclipse.edc.iam.decentralizedclaims.spi.scope.ScopeExtractorRegistry (required)
  • org.eclipse.edc.policy.context.request.spi.RequestScopeExtractorRegistry (required)
  • org.eclipse.edc.iam.decentralizedclaims.spi.scope.DcpScopeRegistry (required)

Class: org.eclipse.edc.iam.decentralizedclaims.core.DynamicDcpScopeConfigurationExtension

Name: “DCP Dynamic Scope Configuration Extension”

Overview: No overview provided.

Configuration

KeyRequiredTypeDefaultPatternMinMaxDescription
edc.iam.dcp.scopes.<alias>.id*string``ID of the scope.
edc.iam.dcp.scopes.<alias>.type*string``The type of the scope. Supported values are ‘DEFAULT’ and ‘POLICY’.
edc.iam.dcp.scopes.<alias>.value*string``The value of the scope.
edc.iam.dcp.scopes.<alias>.prefix.mappingstring``The prefix mapping for the left operand for applying the scope. Required if type is ‘POLICY
edc.iam.dcp.scopes.<alias>.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)

Module decentralized-claims-store-sql

Artifact: org.eclipse.edc:decentralized-claims-store-sql:1.0.0-RC7

Categories: None

Extension points

None

Extensions

Class: org.eclipse.edc.iam.decentralizedclaims.store.sql.SqlDcpScopeStoreExtension

Name: “Sql DCP Scope Store”

Overview: Provides an SQL-backed implementation of {@link DcpScopeStore}.

Configuration

KeyRequiredTypeDefaultPatternMinMaxDescription
edc.sql.store.dcpscope.datasource*stringdefaultThe datasource to be used

Provided services

  • org.eclipse.edc.iam.decentralizedclaims.spi.scope.store.DcpScopeStore

Referenced (injected) services

  • org.eclipse.edc.transaction.datasource.spi.DataSourceRegistry (required)
  • org.eclipse.edc.transaction.spi.TransactionContext (required)
  • org.eclipse.edc.iam.decentralizedclaims.store.sql.schema.DcpScopeStatements (optional)
  • org.eclipse.edc.spi.types.TypeManager (required)
  • org.eclipse.edc.sql.QueryExecutor (required)
  • org.eclipse.edc.sql.bootstrapper.SqlSchemaBootstrapper (required)

Module decentralized-claims-sts-registry

Artifact: org.eclipse.edc:decentralized-claims-sts-registry:1.0.0-RC7

Categories: None

Extension points

None

Extensions

Class: org.eclipse.edc.iam.decentralizedclaims.sts.registry.SecureTokenServiceRegistryExtension

Name: “Secure Token Service Registry Extension”

Overview: Provides a {@link SecureTokenServiceRegistry} and a dispatching {@link SecureTokenService} that resolves the concrete implementation to use per participant context from the registry, based on the {@code edc.iam.sts} property.

Configuration

KeyRequiredTypeDefaultPatternMinMaxDescription
edc.iam.sts.default.type*stringoauthDefault STS type to use when the ’edc.iam.sts’ property is not set on the participant context

Provided services

  • org.eclipse.edc.iam.decentralizedclaims.spi.SecureTokenServiceRegistry
  • org.eclipse.edc.iam.decentralizedclaims.spi.SecureTokenService

Referenced (injected) services

  • org.eclipse.edc.participantcontext.spi.config.ParticipantContextConfig (required)
  • org.eclipse.edc.participantcontext.spi.config.validation.ParticipantContextConfigValidatorRegistry (required)

Module decentralized-claims-sts-remote-client

Artifact: org.eclipse.edc:decentralized-claims-sts-remote-client:1.0.0-RC7

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

KeyRequiredTypeDefaultPatternMinMaxDescription
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 decentralized-claims-sts-remote-registrar

Artifact: org.eclipse.edc:decentralized-claims-sts-remote-registrar:1.0.0-RC7

Categories: None

Extension points

None

Extensions

Class: org.eclipse.edc.iam.decentralizedclaims.sts.remote.registrar.StsRemoteRegistrarExtension

Name: “Sts remote registrar extension”

Overview: Registers the remote (OAuth2) {@link RemoteSecureTokenService} into the {@link SecureTokenServiceRegistry} bound to the {@code “oauth”} type, so it can be selected dynamically per participant context.

Configuration

KeyRequiredTypeDefaultPatternMinMaxDescription
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

None

Referenced (injected) services

  • org.eclipse.edc.iam.decentralizedclaims.spi.SecureTokenServiceRegistry (required)
  • org.eclipse.edc.iam.oauth2.spi.client.Oauth2Client (required)
  • org.eclipse.edc.participantcontext.spi.config.ParticipantContextConfig (required)
  • org.eclipse.edc.spi.security.Vault (required)
  • org.eclipse.edc.participantcontext.spi.config.validation.ParticipantContextConfigValidatorRegistry (required)

Module decentralized-claims-sts-signature-registrar

Artifact: org.eclipse.edc:decentralized-claims-sts-signature-registrar:1.0.0-RC7

Categories: None

Extension points

None

Extensions

Class: org.eclipse.edc.iam.decentralizedclaims.sts.signature.StsSignatureRegistrarExtension

Name: “Sts signature registrar extension”

Overview: Registers a {@link SignatureSecureTokenService} into the {@link SecureTokenServiceRegistry} bound to the {@code “signature”} type. The {@link SignatureSecureTokenService} signs Self-Issued tokens using a {@link SignatureService} (the key never leaves the signing service), via a {@link SignatureServiceJwsSignerProvider}.

Configuration

KeyRequiredTypeDefaultPatternMinMaxDescription
edc.iam.sts.signature.token.expiration*string600Validity (in seconds) of the Self-Issued tokens generated by the signature-backed STS

Provided services

None

Referenced (injected) services

  • org.eclipse.edc.iam.decentralizedclaims.spi.SecureTokenServiceRegistry (required)
  • org.eclipse.edc.spi.security.SignatureService (optional)
  • org.eclipse.edc.participantcontext.spi.config.ParticipantContextConfig (required)
  • java.time.Clock (required)
  • org.eclipse.edc.participantcontext.spi.config.validation.ParticipantContextConfigValidatorRegistry (required)

Module discovery-api-v5

Artifact: org.eclipse.edc:discovery-api-v5:1.0.0-RC7

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 document-cache-api

Artifact: org.eclipse.edc:document-cache-api:1.0.0-RC7

Categories: None

Extension points

None

Extensions

Class: org.eclipse.edc.document.cache.api.CachedDocumentApiExtension

Name: “Management API: Document Cache”

Overview: No overview provided.

Configuration_None_

Provided services

None

Referenced (injected) services

  • org.eclipse.edc.web.spi.WebService (required)
  • org.eclipse.edc.document.cache.spi.CachedDocumentService (required)
  • org.eclipse.edc.transform.spi.TypeTransformerRegistry (required)
  • org.eclipse.edc.jsonld.spi.JsonLd (required)
  • org.eclipse.edc.spi.types.TypeManager (required)
  • org.eclipse.edc.validator.spi.JsonObjectValidatorRegistry (required)

Module document-cache-core

Artifact: org.eclipse.edc:document-cache-core:1.0.0-RC7

Categories: None

Extension points

None

Extensions

Class: org.eclipse.edc.document.cache.DocumentCacheExtension

Name: “Document Cache”

Overview: Provides the {@link CachedDocumentService}, synchronizes the persisted cache into the {@link JsonLd} service at boot, and periodically refreshes refreshable entries.

Configuration

KeyRequiredTypeDefaultPatternMinMaxDescription
edc.document.cache.refresh.enabled*stringtrueEnables the background refresh of cached documents
edc.document.cache.refresh.interval.ms*string3600000Interval (in milliseconds) between background refreshes of cached documents with pull strategy ‘always’.

Provided services

  • org.eclipse.edc.document.cache.spi.CachedDocumentService

Referenced (injected) services

  • org.eclipse.edc.jsonld.spi.JsonLd (required)
  • org.eclipse.edc.document.cache.spi.store.CachedDocumentStore (required)
  • org.eclipse.edc.document.cache.spi.resolver.DocumentResolver (required)
  • org.eclipse.edc.transaction.spi.TransactionContext (required)
  • org.eclipse.edc.spi.system.ExecutorInstrumentation (required)
  • java.time.Clock (required)

Class: org.eclipse.edc.document.cache.DocumentCacheDefaultServicesExtension

Name: “Document Cache Default Services”

Overview: Provides the {@link CachedDocumentService}, synchronizes the persisted cache into the {@link JsonLd} service at boot, and periodically refreshes refreshable entries.

Configuration_None_

Provided services

  • org.eclipse.edc.document.cache.spi.store.CachedDocumentStore
  • org.eclipse.edc.document.cache.spi.resolver.DocumentResolver

Referenced (injected) services

  • org.eclipse.edc.spi.query.CriterionOperatorRegistry (required)
  • org.eclipse.edc.http.spi.EdcHttpClient (required)

Module document-cache-store-sql

Artifact: org.eclipse.edc:document-cache-store-sql:1.0.0-RC7

Categories: None

Extension points

  • org.eclipse.edc.document.cache.store.sql.schema.CachedDocumentStoreStatements

Extensions

Class: org.eclipse.edc.document.cache.store.sql.SqlCachedDocumentStoreExtension

Name: “SQL cached document store”

Overview: No overview provided.

Configuration

KeyRequiredTypeDefaultPatternMinMaxDescription
edc.sql.store.documentcache.datasource*stringdefaultThe datasource to be used

Provided services

  • org.eclipse.edc.document.cache.spi.store.CachedDocumentStore

Referenced (injected) services

  • org.eclipse.edc.transaction.datasource.spi.DataSourceRegistry (required)
  • org.eclipse.edc.transaction.spi.TransactionContext (required)
  • org.eclipse.edc.document.cache.store.sql.schema.CachedDocumentStoreStatements (optional)
  • org.eclipse.edc.spi.types.TypeManager (required)
  • org.eclipse.edc.sql.QueryExecutor (required)
  • org.eclipse.edc.sql.bootstrapper.SqlSchemaBootstrapper (required)

Module dps-tck-connector-under-test

Artifact: org.eclipse.edc:dps-tck-connector-under-test:1.0.0-RC7

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

KeyRequiredTypeDefaultPatternMinMaxDescription
web.http.tck.port*string8687Port for tck api context
web.http.tck.path*string/tckPath for tck api context
edc.participant.context.id*stringparticipantContextIdConfigures 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.controlplane.dataplane.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 dps-tck-virtual-connector-under-test

Artifact: org.eclipse.edc:dps-tck-virtual-connector-under-test:1.0.0-RC7

Categories: None

Extension points

None

Extensions

Class: org.eclipse.edc.tck.dps.virtual.VirtualDpsTckExtension

Name: “Virtual DPS TCK Setup”

Overview: Sets up the virtual runtime for the DPS TCK: creates the participant context, registers the TCK as data plane, seeds the asset and the contract agreement used by the TCK, and registers the webhook the TCK uses to trigger transfers.

Configuration

KeyRequiredTypeDefaultPatternMinMaxDescription
web.http.tck.port*string8687Port for tck api context
web.http.tck.path*string/tckPath for tck api context
edc.participant.context.id*stringparticipantContextIdConfigures 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.controlplane.dataplane.spi.DataPlaneSelectorService (required)
  • org.eclipse.edc.participantcontext.spi.service.ParticipantContextService (required)
  • org.eclipse.edc.participantcontext.spi.config.service.ParticipantContextConfigService (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:1.0.0-RC7

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:1.0.0-RC7

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:1.0.0-RC7

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:1.0.0-RC7

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:1.0.0-RC7

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

KeyRequiredTypeDefaultPatternMinMaxDescription
web.http.protocol.port*string8282Port for protocol api context
web.http.protocol.path*string/api/protocolPath for protocol api context
web.http.protocol.virtual*stringfalseFill the participant context param in the protocol path in case the callback address is not configured
edc.dsp.callback.addressstring``Configures endpoint for reaching the Protocol API in the form “hostname:protocol.port/protocol.path”

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)
  • org.eclipse.edc.jsonld.spi.JsonLd (required)

Module dsp-http-api-configuration-2025

Artifact: org.eclipse.edc:dsp-http-api-configuration-2025:1.0.0-RC7

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

KeyRequiredTypeDefaultPatternMinMaxDescription
edc.iam.trustedissuer.<alias>.id*string``ID of the issuer.
edc.iam.trustedissuer.<alias>.supportedtypes*string["*"]Supported credential types for this issuer, as a JSON serialized list.

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:1.0.0-RC7

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

KeyRequiredTypeDefaultPatternMinMaxDescription
edc.iam.trustedissuer.<alias>.id*string``ID of the issuer.
edc.iam.trustedissuer.<alias>.supportedtypes*string["*"]Supported credential types for this issuer, as a JSON serialized list.

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:1.0.0-RC7

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.context.request.spi.RequestScopeExtractorRegistry (required)
  • org.eclipse.edc.controlplane.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:1.0.0-RC7

Categories: None

Extension points

None

Extensions

Class: org.eclipse.edc.protocol.dsp.http.profile.DataspaceProfileConfigurationExtension

Name: “Dataspace Profile Configuration Extension”

Overview: No overview provided.

Configuration

KeyRequiredTypeDefaultPatternMinMaxDescription
edc.dataspace.profiles.<alias>.name*string``The name of the dataspace profile.
edc.dataspace.profiles.<alias>.protocol.version*string``The version of the DSP protocol this profile binds to.
edc.dataspace.profiles.<alias>.protocol.binding*string``The protocol binding (e.g. ‘http’) of the DSP protocol this profile binds to.
edc.dataspace.profiles.<alias>.protocol.namespace*string``The JSON-LD namespace of the dataspace profile.
edc.dataspace.profiles.<alias>.jsonld.context.urls*string``The JSON-LD context URLs of the dataspace profile.

Provided services

  • org.eclipse.edc.protocol.spi.service.DataspaceProfileService

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)
  • org.eclipse.edc.protocol.spi.store.DataspaceProfileStore (required)
  • org.eclipse.edc.transaction.spi.TransactionContext (required)

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)
  • org.eclipse.edc.participantcontext.spi.service.ParticipantContextService (required)

Module dsp-metadata-http-api-virtual

Artifact: org.eclipse.edc:dsp-metadata-http-api-virtual:1.0.0-RC7

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:1.0.0-RC7

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:1.0.0-RC7

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:1.0.0-RC7

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:1.0.0-RC7

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:1.0.0-RC7

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:1.0.0-RC7

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:1.0.0-RC7

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:1.0.0-RC7

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:1.0.0-RC7

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 events-cloud-http

Artifact: org.eclipse.edc:events-cloud-http:1.0.0-RC7

Categories: None

Extension points

None

Extensions

Class: org.eclipse.edc.event.cloud.http.CloudEventsHttpExtension

Name: “Cloud events HTTP”

Overview: No overview provided.

Configuration

KeyRequiredTypeDefaultPatternMinMaxDescription
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:1.0.0-RC7

Categories: None

Extension points

None

Extensions

Class: org.eclipse.edc.event.nats.NatsPublishingExtension

Name: “NATS Event Publishing Extension”

Overview: No overview provided.

Configuration

KeyRequiredTypeDefaultPatternMinMaxDescription
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.createstringtrueIf the stream should be attempted to be created. May fail if the stream exists.’
edc.events.nats.stream.create.forcestringfalseIf 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:1.0.0-RC7

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)
  • org.eclipse.edc.participantcontext.single.spi.SingleParticipantContextSupplier (optional)
  • org.eclipse.edc.api.auth.spi.AuthorizationService (optional)

Module federated-catalog-cache-sql

Artifact: org.eclipse.edc:federated-catalog-cache-sql:1.0.0-RC7

Categories: None

Extension points

None

Extensions

Class: org.eclipse.edc.catalog.cache.sql.SqlFederatedCatalogCacheExtension

Name: “SQL federated catalog cache”

Overview: No overview provided.

Configuration

KeyRequiredTypeDefaultPatternMinMaxDescription
edc.sql.store.federatedcatalog.datasource*stringdefaultThe 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 iam-mock

Artifact: org.eclipse.edc:iam-mock:1.0.0-RC7

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

KeyRequiredTypeDefaultPatternMinMaxDescription
edc.participant.id*string``Configures the participant id this runtime is operating on behalf of
edc.mock.faulty_client_id*stringfaultyClientIdConfigures 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.controlplane.iam.AudienceResolver

Referenced (injected) services

  • org.eclipse.edc.spi.types.TypeManager (required)
  • org.eclipse.edc.participantcontext.spi.config.ParticipantContextConfig (required)
  • org.eclipse.edc.participantcontext.spi.config.validation.ParticipantContextConfigValidatorRegistry (required)

Module identity-did-core

Artifact: org.eclipse.edc:identity-did-core:1.0.0-RC7

Categories: None

Extension points

None

Extensions

Class: org.eclipse.edc.iam.did.IdentityDidCoreExtension

Name: “Identity Did Core”

Overview: No overview provided.

Configuration

KeyRequiredTypeDefaultPatternMinMaxDescription
edc.did.resolver.cache.expiry*string300000Expiry time for caching DID Documents in milliseconds
edc.did.resolver.cache.size*string50The maximum number of cached DID Documents. 0 deactivates the cache

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-web

Artifact: org.eclipse.edc:identity-did-web:1.0.0-RC7

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

KeyRequiredTypeDefaultPatternMinMaxDescription
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:1.0.0-RC7

Categories: None

Extension points

None

Extensions

Class: org.eclipse.edc.web.jersey.JerseyExtension

Name: “JerseyExtension”

Configuration

KeyRequiredTypeDefaultPatternMinMaxDescription
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:1.0.0-RC7

Categories: None

Extension points

None

Extensions

Class: org.eclipse.edc.web.jersey.micrometer.JerseyMicrometerExtension

Name: “JerseyMicrometerExtension”

Configuration

KeyRequiredTypeDefaultPatternMinMaxDescription
edc.metrics.enabled*string``
edc.metrics.jersey.enabled*string``
edc.metrics.jersey.contexts*stringdefaultComma-separated aliases of the API contexts whose requests are measured, e.g. ‘default,management,protocol’, or ‘*’ for all of them

Provided services

None

Referenced (injected) services

  • org.eclipse.edc.web.spi.WebService (required)
  • io.micrometer.core.instrument.MeterRegistry (required)
  • org.eclipse.edc.web.spi.configuration.PortMappingRegistry (required)

Module jetty-core

Artifact: org.eclipse.edc:jetty-core:1.0.0-RC7

Categories: None

Extension points

None

Extensions

Class: org.eclipse.edc.web.jetty.JettyExtension

Name: “JettyExtension”

Configuration

KeyRequiredTypeDefaultPatternMinMaxDescription
edc.web.https.keystore.password*stringpasswordKeystore password
edc.web.https.keymanager.password*stringpasswordKeymanager password
web.http.port*string8181Port for default api context
web.http.path*string/apiPath for default api context
edc.web.https.keystore.pathstring``Keystore path
edc.web.https.keystore.type*stringPKCS12Keystore 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:1.0.0-RC7

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

KeyRequiredTypeDefaultPatternMinMaxDescription
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:1.0.0-RC7

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

KeyRequiredTypeDefaultPatternMinMaxDescription
edc.jsonld.document.<alias>.path*string``Path of the JSON-LD document to cache
edc.jsonld.document.<alias>.url*string``URL of the JSON-LD document to cache
edc.jsonld.http.enabled*stringfalseIf set enable http json-ld document resolution
edc.jsonld.https.enabled*stringfalseIf set enable https json-ld document resolution
edc.jsonld.vocab.disable*stringfalseIf true disable the @vocab context definition. This could be used to avoid api breaking changes
edc.jsonld.prefixes.check*stringtrueIf true a validation on expended object will be made against configured prefixes

Provided services

  • org.eclipse.edc.jsonld.spi.JsonLd

Referenced (injected) services

None

Module jti-validation-store-sql

Artifact: org.eclipse.edc:jti-validation-store-sql:1.0.0-RC7

Categories: None

Extension points

None

Extensions

Class: org.eclipse.edc.jtivalidation.store.sql.SqlJtiValidationStoreExtension

Name: “SQL JTI Validation store”

Overview: No overview provided.

Configuration

KeyRequiredTypeDefaultPatternMinMaxDescription
edc.sql.store.jti.datasource*stringdefaultThe 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:1.0.0-RC7

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:1.0.0-RC7

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

KeyRequiredTypeDefaultPatternMinMaxDescription
web.http.management.port*string8181Port for management api context
web.http.management.path*string/api/managementPath for management api context
edc.management.endpointstring``Configures endpoint for reaching the Management API, in the format “hostname:management.port/management.path”

Provided services

None

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)
  • org.eclipse.edc.validator.spi.JsonObjectValidatorRegistry (required)

Module management-api-oauth2-authentication

Artifact: org.eclipse.edc:management-api-oauth2-authentication:1.0.0-RC7

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

KeyRequiredTypeDefaultPatternMinMaxDescription
edc.iam.oauth2.issuerstring``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*string300000Time (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:1.0.0-RC7

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

KeyRequiredTypeDefaultPatternMinMaxDescription
edc.mgmt.api.schema.<groupAlias>.version*string``Namespace prefix used when registering custom validators on JsonObjectValidatorRegistry, e.g. ‘v4’.
edc.mgmt.api.schema.<groupAlias>.mapping.fromstring``Optional schema URL prefix to remap to a local location (paired with ‘mapping.to’).
edc.mgmt.api.schema.<groupAlias>.mapping.tostring``Optional local URI the schema prefix is remapped to, e.g. ‘file:///path’ or ‘classpath:/path’ (paired with ‘mapping.from’).
edc.mgmt.api.schema.<groupAlias>.validator.<entryAlias>.type*string``JSON-LD @type term the schema is registered against.
edc.mgmt.api.schema.<groupAlias>.validator.<entryAlias>.schema*string``Absolute schema URL (resolved through ‘mapping.from’/‘mapping.to’ when configured).
edc.mgmt.api.schema.<groupAlias>.validator.<entryAlias>.profilesstring``Optional profile to associate with the validator in order to be activated

Provided services

  • org.eclipse.edc.validator.registration.spi.SchemaValidatorFactory

Referenced (injected) services

  • org.eclipse.edc.spi.types.TypeManager (required)
  • org.eclipse.edc.validator.spi.JsonObjectValidatorRegistry (required)
  • org.eclipse.edc.document.cache.spi.store.CachedDocumentStore (optional)

Module micrometer-core

Artifact: org.eclipse.edc:micrometer-core:1.0.0-RC7

Categories: None

Extension points

None

Extensions

Class: org.eclipse.edc.metrics.micrometer.MicrometerExtension

Name: “Micrometer Metrics”

Overview: No overview provided.

Configuration

KeyRequiredTypeDefaultPatternMinMaxDescription
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 nats-auth-nkey

Artifact: org.eclipse.edc:nats-auth-nkey:1.0.0-RC7

Categories: None

Extension points

None

Extensions

Class: org.eclipse.edc.nats.auth.nkey.NatsNkeyAuthExtension

Name: “NATS NKey Authentication Extension”

Overview: Contributes NKey-based authentication to every NATS-connecting extension. The seed (the NKey private key) is read from a file — typically projected into the container by the deployment (e.g. a Vault-agent init container) — and used to answer the server’s challenge: the client signs the server nonce with the seed, the server verifies the signature against the user’s public key in its {@code authorization} block. The seed itself never leaves the process.

The resulting {@link Options} are registered as a service and picked up by the NATS event publisher and the task publisher/subscriber extensions, which copy them via {@link Options.Builder#Builder(Options)} and set their own server URL. When no seed is configured, no service is registered and connections are made without credentials.

Configuration

KeyRequiredTypeDefaultPatternMinMaxDescription
edc.nats.auth.nkey.seed.pathstring``Path to a file containing the NKey seed used to authenticate NATS connections. When not set, connections are made without credentials.

Provided services

  • io.nats.client.Options

Referenced (injected) services

  • org.eclipse.edc.spi.monitor.Monitor (required)

Module negotiation-tasks-publisher-nats

Artifact: org.eclipse.edc:negotiation-tasks-publisher-nats:1.0.0-RC7

Categories: None

Extension points

None

Extensions

Class: org.eclipse.edc.controlplane.tasks.publisher.nats.NegotiationTaskNatsPublisherExtension

Name: “NegotiationTaskNatsPublisherExtension”

Configuration

KeyRequiredTypeDefaultPatternMinMaxDescription
edc.nats.cn.publisher.url*stringnats://localhost:4222The URL of the NATS server to connect to for publishing contract negotiation tasks.
edc.nats.cn.publisher.subject-prefix*stringnegotiationsThe 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)
  • io.nats.client.Options (optional)

Module negotiation-tasks-subscriber-nats

Artifact: org.eclipse.edc:negotiation-tasks-subscriber-nats:1.0.0-RC7

Categories: None

Extension points

None

Extensions

Class: org.eclipse.edc.virtual.controlplane.contract.negotiation.subscriber.NatsContractNegotiationSubscriberExtension

Name: “NatsContractNegotiationSubscriberExtension”

Configuration

KeyRequiredTypeDefaultPatternMinMaxDescription
edc.nats.cn.subscriber.url*stringnats://localhost:4222The URL of the NATS server to connect to for contract negotiation events.
edc.nats.cn.subscriber.name*stringcn-subscriberThe name of the consumer for contract negotiation events
edc.nats.cn.subscriber.autocreate*stringfalseConvenience flag: when true, it will automatically create both the stream and the consumer if not present
edc.nats.cn.subscriber.stream.autocreate*stringfalseWhen true, it will automatically create the stream if not present
edc.nats.cn.subscriber.consumer.autocreate*stringfalseWhen true, it will automatically create the consumer if not present
edc.nats.cn.subscriber.stream*stringcn-streamThe stream name where to attach the consumer
edc.nats.cn.subscriber.subject*stringnegotiations.>The subject of the consumer for contract negotiation events
edc.nats.cn.subscriber.batch-size*string100The maximum number of messages per fetch
edc.nats.cn.subscriber.workers*string1The number of messages handled concurrently
edc.nats.cn.subscriber.prefetch*string10The number of messages fetched ahead of the workers
edc.nats.cn.subscriber.max-wait*string100The max waiting time for messages (ms)
edc.nats.cn.subscriber.max-retries*string3Max 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.negotiation.send.retry.limit.
edc.negotiation.send.retry.base-delay.ms*string1000The base delay (ms) before a contract negotiation task that failed with a retryable error is delivered again; it doubles at every delivery. Shared with the polling state machine.
edc.negotiation.send.retry.limit*string7The number of deliveries after which a contract negotiation 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)
  • 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)
  • org.eclipse.edc.spi.system.health.HealthCheckService (required)
  • java.time.Clock (required)
  • io.nats.client.Options (optional)

Module oauth2-client

Artifact: org.eclipse.edc:oauth2-client:1.0.0-RC7

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 otel-monitor

Artifact: org.eclipse.edc:otel-monitor:1.0.0-RC7

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:1.0.0-RC7

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:1.0.0-RC7

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:1.0.0-RC7

Categories: None

Extension points

None

Extensions

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

Class: org.eclipse.edc.participantcontext.config.ParticipantContextConfigServicesExtension

Name: “Participant Context Config Services Extension”

Overview: No overview provided.

Configuration

KeyRequiredTypeDefaultPatternMinMaxDescription
edc.participants.config.encryption.algorithmstring``The encryption algorithm used for encrypting and decrypting sensitive config.
edc.participants.config.validation.strict*stringfalseWhether participant context configuration keys that are not registered by any extension are rejected.

Provided services

  • org.eclipse.edc.participantcontext.spi.config.service.ParticipantContextConfigService
  • org.eclipse.edc.participantcontext.spi.config.validation.ParticipantContextConfigValidatorRegistry
  • org.eclipse.edc.participantcontext.spi.config.ParticipantContextConfig

Referenced (injected) services

  • org.eclipse.edc.participantcontext.spi.config.store.ParticipantContextConfigStore (required)
  • org.eclipse.edc.participantcontext.spi.store.ParticipantContextStore (required)
  • org.eclipse.edc.transaction.spi.TransactionContext (required)
  • org.eclipse.edc.encryption.EncryptionAlgorithmRegistry (required)
  • org.eclipse.edc.spi.monitor.Monitor (required)
  • java.time.Clock (required)

Module participant-context-connector-classic-core

Artifact: org.eclipse.edc:participant-context-connector-classic-core:1.0.0-RC7

Categories: None

Extension points

None

Extensions

Class: org.eclipse.edc.participantcontext.connector.ClassicParticipantContextServicesExtension

Name: “Classic Participant Context Services Extension”

Overview: No overview provided.

Configuration

KeyRequiredTypeDefaultPatternMinMaxDescription
edc.participant.id*stringanonymousConfigures the participant id this runtime is operating on behalf of
edc.participant.context.idstring``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)

Class: org.eclipse.edc.participantcontext.connector.ClassicParticipantContextDefaultServicesExtension

Name: “Single Participant Context Default Services Extension”

Overview: No overview provided.

Configuration

KeyRequiredTypeDefaultPatternMinMaxDescription
edc.participant.id*stringanonymousConfigures the participant id this runtime is operating on behalf of
edc.participant.context.idstring``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)
  • org.eclipse.edc.api.auth.spi.AuthorizationService (optional)

Module participant-context-connector-core

Artifact: org.eclipse.edc:participant-context-connector-core:1.0.0-RC7

Categories: None

Extension points

None

Extensions

Class: org.eclipse.edc.participantcontext.connector.ConnectorParticipantContextExtension

Name: “Connector Participant Context Extension”

Overview: No overview provided.

Configuration

KeyRequiredTypeDefaultPatternMinMaxDescription
edc.dataspace.enable.profiles.all*stringfalseWhen 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)
  • org.eclipse.edc.participantcontext.spi.config.validation.ParticipantContextConfigValidatorRegistry (required)

Module participant-context-core

Artifact: org.eclipse.edc:participant-context-core:1.0.0-RC7

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:1.0.0-RC7

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

KeyRequiredTypeDefaultPatternMinMaxDescription
edc.sql.store.participantcontextconfig.datasource*stringdefaultThe 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:1.0.0-RC7

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

KeyRequiredTypeDefaultPatternMinMaxDescription
edc.sql.store.participantcontext.datasource*stringdefaultThe 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 partner-api-v5

Artifact: org.eclipse.edc:partner-api-v5:1.0.0-RC7

Categories: None

Extension points

None

Extensions

Class: org.eclipse.edc.connector.controlplane.api.management.partner.PartnerApiV5Extension

Name: “Management API: Partners and Partner Groups”

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.partner.PartnerService (required)
  • org.eclipse.edc.connector.controlplane.services.spi.partner.PartnerGroupService (required)
  • org.eclipse.edc.jsonld.spi.JsonLd (required)
  • org.eclipse.edc.spi.types.TypeManager (required)
  • org.eclipse.edc.api.auth.spi.AuthorizationService (required)

Module partner-cel

Artifact: org.eclipse.edc:partner-cel:1.0.0-RC7

Categories: None

Extension points

None

Extensions

Class: org.eclipse.edc.connector.controlplane.partner.cel.PartnerCelExtension

Name: “Partner Common Expression Language Extension”

Overview: Registers the partner helper functions with the CEL engine, so policies can be written as {@code ctx.partners.byIdentity(ctx.agent.id).inGroup(‘gold’)}. When CEL is not part of the runtime the extension does nothing.

Configuration_None_

Provided services

None

Referenced (injected) services

  • org.eclipse.edc.connector.controlplane.services.spi.partner.PartnerService (required)
  • org.eclipse.edc.policy.cel.function.CelFunctionRegistry (optional)

Module partner-store-sql

Artifact: org.eclipse.edc:partner-store-sql:1.0.0-RC7

Categories: None

Extension points

None

Extensions

Class: org.eclipse.edc.connector.controlplane.store.sql.partner.SqlPartnerStoreExtension

Name: “Partner and Partner Group SQL Store Extension”

Overview: No overview provided.

Configuration

KeyRequiredTypeDefaultPatternMinMaxDescription
edc.sql.store.partner.datasource*stringdefaultThe datasource to be used

Provided services

  • org.eclipse.edc.connector.controlplane.partner.spi.store.PartnerStore
  • org.eclipse.edc.connector.controlplane.partner.spi.store.PartnerGroupStore

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.sql.bootstrapper.SqlSchemaBootstrapper (required)
  • org.eclipse.edc.connector.controlplane.store.sql.partner.PartnerStoreStatements (optional)
  • org.eclipse.edc.connector.controlplane.store.sql.partner.PartnerGroupStoreStatements (optional)

Module policy-definition-api

Artifact: org.eclipse.edc:policy-definition-api:1.0.0-RC7

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:1.0.0-RC7

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:1.0.0-RC7

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

KeyRequiredTypeDefaultPatternMinMaxDescription
edc.sql.store.policy.datasource*stringdefaultThe 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-monitor-core

Artifact: org.eclipse.edc:policy-monitor-core:1.0.0-RC7

Categories: None

Extension points

None

Extensions

Class: org.eclipse.edc.connector.policy.monitor.PolicyMonitorExtension

Name: “Policy Monitor”

Overview: No overview provided.

Configuration

KeyRequiredTypeDefaultPatternMinMaxDescription
edc.policy.monitor.batch-size*string20The number of policy monitor entries to be evaluated on every watchdog run.
edc.policy.monitor.period*stringPT1HTime 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.transaction.spi.TransactionContext (required)

Class: org.eclipse.edc.connector.policy.monitor.PolicyMonitorDefaultServicesExtension

Name: “PolicyMonitor Default Services”

Overview: No overview provided.

Configuration

KeyRequiredTypeDefaultPatternMinMaxDescription
edc.policy.monitor.lease-duration*stringPT60SHow long a runtime keeps the lease on a policy monitor entry while processing it, in ISO-8601 duration format. It must be longer than the slowest processing step, e.g. a protocol message dispatch including HTTP timeouts and retries, otherwise the policy monitor entry can be processed again, by another runtime or by the same one

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:1.0.0-RC7

Categories: None

Extension points

None

Extensions

Class: org.eclipse.edc.connector.policy.monitor.store.sql.SqlPolicyMonitorStoreExtension

Name: “SqlPolicyMonitorStoreExtension”

Configuration

KeyRequiredTypeDefaultPatternMinMaxDescription
edc.sql.store.policy-monitor.datasource*stringdefaultThe datasource to be used
edc.policy.monitor.lease-duration*stringPT60SHow long a runtime keeps the lease on a policy monitor entry while processing it, in ISO-8601 duration format. It must be longer than the slowest processing step, e.g. a protocol message dispatch including HTTP timeouts and retries, otherwise the policy monitor entry can be processed again, by another runtime or by the same one

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)

Module runtime-core

Artifact: org.eclipse.edc:runtime-core:1.0.0-RC7

Categories: None

Extension points

None

Extensions

Class: org.eclipse.edc.runtime.core.RuntimeDefaultCoreServicesExtension

Name: “Runtime Default Core Services”

Overview: No overview provided.

Configuration

KeyRequiredTypeDefaultPatternMinMaxDescription
edc.core.retry.retries.max*string5RetryPolicy: Maximum retries before a failure is propagated
edc.core.retry.backoff.min*string500RetryPolicy: Minimum number of milliseconds for exponential backoff
edc.core.retry.backoff.max*string10000RetryPolicy: Maximum number of milliseconds for exponential backoff
edc.core.retry.log.on.retry*stringfalseRetryPolicy: Log onRetry events
edc.core.retry.log.on.retry.scheduled*stringfalseRetryPolicy: Log onRetryScheduled events
edc.core.retry.log.on.retries.exceeded*stringfalseRetryPolicy: Log onRetriesExceeded events
edc.core.retry.log.on.failed.attempt*stringfalseRetryPolicy: Log onFailedAttempt events
edc.core.retry.log.on.abort*stringfalseRetryPolicy: Log onAbort events
edc.http.client.https.enforce*stringfalseOkHttpClient: If true, enable HTTPS call enforcement
edc.http.client.timeout.connect*string30OkHttpClient: connect timeout, in seconds
edc.http.client.timeout.read*string30OkHttpClient: read timeout, in seconds
edc.http.client.send.buffer.size*string0OkHttpClient: send buffer size, in bytes
edc.http.client.receive.buffer.size*string0OkHttpClient: receive buffer size, in bytes
edc.http.client.max.requests*string64OkHttpClient: maximum number of asynchronous requests executed concurrently. Further requests are queued
edc.http.client.max.requests.per.host*string5OkHttpClient: maximum number of asynchronous requests executed concurrently against the same host. Further requests are queued. Every participant hosted by the same counter-party runtime shares the same host

Provided services

  • org.eclipse.edc.transaction.spi.TransactionContext
  • org.eclipse.edc.transaction.datasource.spi.DataSourceRegistry
  • dev.failsafe.RetryPolicy<T>
  • 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

KeyRequiredTypeDefaultPatternMinMaxDescription
edc.hostname*stringlocalhostRuntime 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<okhttp3.Response> (required)
  • java.time.Clock (required)
  • org.eclipse.edc.spi.types.TypeManager (required)

Module schema-validation-api

Artifact: org.eclipse.edc:schema-validation-api:1.0.0-RC7

Categories: None

Extension points

None

Extensions

Class: org.eclipse.edc.validator.registration.api.SchemaValidationApiExtension

Name: “Management API: Schema Validator Registration”

Overview: No overview provided.

Configuration_None_

Provided services

None

Referenced (injected) services

  • org.eclipse.edc.web.spi.WebService (required)
  • org.eclipse.edc.validator.registration.spi.SchemaValidatorRegistrationService (required)
  • org.eclipse.edc.transform.spi.TypeTransformerRegistry (required)
  • org.eclipse.edc.jsonld.spi.JsonLd (required)
  • org.eclipse.edc.spi.types.TypeManager (required)
  • org.eclipse.edc.validator.spi.JsonObjectValidatorRegistry (required)

Module schema-validation-core

Artifact: org.eclipse.edc:schema-validation-core:1.0.0-RC7

Categories: None

Extension points

None

Extensions

Class: org.eclipse.edc.validator.registration.SchemaValidationCoreExtension

Name: “Schema Validator Registration”

Overview: No overview provided.

Configuration_None_

Provided services

  • org.eclipse.edc.validator.registration.spi.SchemaValidatorRegistrationService

Referenced (injected) services

  • org.eclipse.edc.validator.registration.spi.store.SchemaValidatorRegistrationStore (required)
  • org.eclipse.edc.validator.registration.spi.SchemaValidatorFactory (required)
  • org.eclipse.edc.validator.spi.JsonObjectValidatorRegistry (required)
  • org.eclipse.edc.document.cache.spi.store.CachedDocumentStore (required)
  • org.eclipse.edc.transaction.spi.TransactionContext (required)

Class: org.eclipse.edc.validator.registration.SchemaValidationDefaultServicesExtension

Name: “Schema Validator Registration Default Services”

Overview: No overview provided.

Configuration_None_

Provided services

  • org.eclipse.edc.validator.registration.spi.store.SchemaValidatorRegistrationStore

Referenced (injected) services

  • org.eclipse.edc.spi.query.CriterionOperatorRegistry (required)

Module schema-validation-store-sql

Artifact: org.eclipse.edc:schema-validation-store-sql:1.0.0-RC7

Categories: None

Extension points

  • org.eclipse.edc.validator.registration.store.sql.schema.SchemaValidatorRegistrationStoreStatements

Extensions

Class: org.eclipse.edc.validator.registration.store.sql.SqlSchemaValidatorRegistrationStoreExtension

Name: “SQL schema validator registration store”

Overview: No overview provided.

Configuration

KeyRequiredTypeDefaultPatternMinMaxDescription
edc.sql.store.schemavalidation.datasource*stringdefaultThe datasource to be used

Provided services

  • org.eclipse.edc.validator.registration.spi.store.SchemaValidatorRegistrationStore

Referenced (injected) services

  • org.eclipse.edc.transaction.datasource.spi.DataSourceRegistry (required)
  • org.eclipse.edc.transaction.spi.TransactionContext (required)
  • org.eclipse.edc.validator.registration.store.sql.schema.SchemaValidatorRegistrationStoreStatements (optional)
  • org.eclipse.edc.spi.types.TypeManager (required)
  • org.eclipse.edc.sql.QueryExecutor (required)
  • org.eclipse.edc.sql.bootstrapper.SqlSchemaBootstrapper (required)

Module secrets-api

Artifact: org.eclipse.edc:secrets-api:1.0.0-RC7

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 security-core

Artifact: org.eclipse.edc:security-core:1.0.0-RC7

Categories: None

Extension points

None

Extensions

Class: org.eclipse.edc.security.LocalPublicKeyDefaultExtension

Name: “Security Default Services Extension”

Overview: No overview provided.

Configuration

KeyRequiredTypeDefaultPatternMinMaxDescription
edc.iam.publickeys.<alias>.id*string``ID of the public key.
edc.iam.publickeys.<alias>.valuestring``Value of the public key. Multiple formats are supported, depending on the KeyParsers registered in the runtime
edc.iam.publickeys.<alias>.pathstring``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.security.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)

Module signaling-data-plane

Artifact: org.eclipse.edc:signaling-data-plane:1.0.0-RC7

Categories: None

Extension points

None

Extensions

Class: org.eclipse.edc.test.runtime.signaling.SignalingDataPlaneRuntimeExtension

Name: “SignalingDataPlaneRuntimeExtension”

Configuration

KeyRequiredTypeDefaultPatternMinMaxDescription
web.http.path*string``
web.http.port*string``
dataplane.id*string``
dataplane.authorization*stringoauth2_client_credentials
dataplane.authorization.jwks.uristring``

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:1.0.0-RC7

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

KeyRequiredTypeDefaultPatternMinMaxDescription
edc.sql.schema.autocreatestringfalseWhen 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:1.0.0-RC7

Categories: None

Extension points

None

Extensions

Class: org.eclipse.edc.sql.SqlCoreExtension

Name: “SQL Core”

Overview: No overview provided.

Configuration

KeyRequiredTypeDefaultPatternMinMaxDescription
edc.sql.fetch.size*string5000Fetch 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:1.0.0-RC7

Categories: None

Extension points

None

Extensions

Class: org.eclipse.edc.sql.lease.SqlLeaseStatementsExtension

Name: “SQL Lease Statements”

Overview: Provides the default {@link LeaseStatements}.

@deprecated the lease is now stored on the entity row (see {@code org.eclipse.edc.sql.lease.StatefulEntityStatements}), this will be removed in a future release.

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: Provides the default {@link LeaseStatements}.

@deprecated the lease is now stored on the entity row (see {@code org.eclipse.edc.sql.lease.StatefulEntityStatements}), this will be removed in a future release.

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:1.0.0-RC7

Categories: None

Extension points

None

Extensions

Class: org.eclipse.edc.sql.pool.commons.CommonsConnectionPoolServiceExtension

Name: “Commons Connection Pool”

Overview: No overview provided.

Configuration

KeyRequiredTypeDefaultPatternMinMaxDescription
edc.datasource.<alias>.urlstring``JDBC url
edc.datasource.<alias>.userstring``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.<alias>.passwordstring``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.<alias>.pool.connections.max-idlestring``Pool max idle connections
edc.datasource.<alias>.pool.connections.max-totalstring``Pool max total connections
edc.datasource.<alias>.pool.connections.min-idlestring``Pool min idle connections
edc.datasource.<alias>.pool.connection.test.on-borrowstring``Pool test on borrow
edc.datasource.<alias>.pool.connection.test.on-createstring``Pool test on create
edc.datasource.<alias>.pool.connection.test.on-returnstring``Pool test on return
edc.datasource.<alias>.pool.connection.test.while-idlestring``Pool test while idle
edc.datasource.<alias>.pool.connection.test.querystring``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:1.0.0-RC7

Categories: None

Extension points

None

Extensions

Class: org.eclipse.edc.catalog.directory.sql.SqlTargetNodeDirectoryExtension

Name: “SQL target node directory”

Overview: No overview provided.

Configuration

KeyRequiredTypeDefaultPatternMinMaxDescription
edc.sql.store.targetnodedirectory.datasource*stringdefaultThe 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:1.0.0-RC7

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:1.0.0-RC7

Categories: None

Extension points

None

Extensions

Class: org.eclipse.edc.controlplane.tasks.sql.SqlTaskStoreExtension

Name: “Tasks SQL Store Extension”

Overview: No overview provided.

Configuration

KeyRequiredTypeDefaultPatternMinMaxDescription
edc.sql.store.tasks.datasource*stringdefaultThe 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:1.0.0-RC7

Categories: None

Extension points

None

Extensions

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

Class: org.eclipse.edc.tasks.tck.dsp.controller.TckControllerExtension

Name: “TckControllerExtension”

Overview: Loads customizations and seed data for the TCK.

Configuration

KeyRequiredTypeDefaultPatternMinMaxDescription
web.http.tck.port*string8687Port for tck api context
web.http.tck.path*string/tckPath 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.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.setup.TckSetupExtension

Name: “DSP TCK Setup”

Overview: Loads customizations and seed data for the TCK.

Configuration

KeyRequiredTypeDefaultPatternMinMaxDescription
edc.participant.context.id*stringparticipantContextIdConfigures 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)

Module tck-extension

Artifact: org.eclipse.edc:tck-extension:1.0.0-RC7

Categories: None

Extension points

None

Extensions

Class: org.eclipse.edc.tck.dsp.controller.TckControllerExtension

Name: “TckControllerExtension”

Overview: Loads customizations and seed data for the TCK.

Configuration

KeyRequiredTypeDefaultPatternMinMaxDescription
web.http.tck.port*string8687Port for tck api context
web.http.tck.path*string/tckPath 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.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.controlplane.iam.AudienceResolver

Referenced (injected) services

None

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.setup.TckSetupExtension

Name: “DSP TCK Setup”

Overview: Loads customizations and seed data for the TCK.

Configuration

KeyRequiredTypeDefaultPatternMinMaxDescription
edc.participant.context.id*stringparticipantContextIdConfigures 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:1.0.0-RC7

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 transaction-local

Artifact: org.eclipse.edc:transaction-local:1.0.0-RC7

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 transfer-process-api

Artifact: org.eclipse.edc:transfer-process-api:1.0.0-RC7

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:1.0.0-RC7

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:1.0.0-RC7

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

KeyRequiredTypeDefaultPatternMinMaxDescription
edc.sql.store.transferprocess.datasource*stringdefaultThe datasource to be used
edc.transfer.state-machine.lease-duration*stringPT60SHow long a runtime keeps the lease on a transfer process while processing it, in ISO-8601 duration format. It must be longer than the slowest processing step, e.g. a protocol message dispatch including HTTP timeouts and retries, otherwise the transfer process can be processed again, by another runtime or by the same one

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)

Module transfer-tasks-publisher-nats

Artifact: org.eclipse.edc:transfer-tasks-publisher-nats:1.0.0-RC7

Categories: None

Extension points

None

Extensions

Class: org.eclipse.edc.controlplane.tasks.publisher.nats.TransferTaskNatsPublisherExtension

Name: “TransferTaskNatsPublisherExtension”

Configuration

KeyRequiredTypeDefaultPatternMinMaxDescription
edc.nats.tp.publisher.url*stringnats://localhost:4222The URL of the NATS server to connect to for publishing transfer process tasks.
edc.nats.tp.publisher.subject-prefix*stringtransfersThe 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)
  • io.nats.client.Options (optional)

Module transfer-tasks-subscriber-nats

Artifact: org.eclipse.edc:transfer-tasks-subscriber-nats:1.0.0-RC7

Categories: None

Extension points

None

Extensions

Class: org.eclipse.edc.virtual.controlplane.transfer.subscriber.nats.NatsTransferProcessTaskSubscriberExtension

Name: “NatsTransferProcessTaskSubscriberExtension”

Configuration

KeyRequiredTypeDefaultPatternMinMaxDescription
edc.nats.tp.subscriber.url*stringnats://localhost:4222The URL of the NATS server to connect to for transfer process events.
edc.nats.tp.subscriber.name*stringtp-subscriberThe name of the consumer for transfer process events
edc.nats.tp.subscriber.autocreate*stringfalseConvenience flag: when true, it will automatically create both the stream and the consumer if not present
edc.nats.tp.subscriber.stream.autocreate*stringfalseWhen true, it will automatically create the stream if not present
edc.nats.tp.subscriber.consumer.autocreate*stringfalseWhen true, it will automatically create the consumer if not present
edc.nats.tp.subscriber.stream*stringtp-streamThe stream name where to attach the consumer
edc.nats.tp.subscriber.subject*stringtransfers.>The subject of the consumer for transfer process events
edc.nats.tp.subscriber.batch-size*string100The maximum number of messages per fetch
edc.nats.tp.subscriber.workers*string1The number of messages handled concurrently
edc.nats.tp.subscriber.prefetch*string10The number of messages fetched ahead of the workers
edc.nats.tp.subscriber.max-wait*string100The max waiting time for messages (ms)
edc.nats.tp.subscriber.max-retries*string3Max 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*string1000The 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*string7The 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)
  • 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.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 vault-hashicorp

Artifact: org.eclipse.edc:vault-hashicorp:1.0.0-RC7

Categories: None

Extension points

None

Extensions

Class: org.eclipse.edc.vault.hashicorp.auth.HashicorpVaultAuthenticationExtension

Name: “Hashicorp Vault Authentication”

Overview: No overview provided.

Configuration

KeyRequiredTypeDefaultPatternMinMaxDescription
edc.vault.hashicorp.tokenstring``The token used to access the Hashicorp Vault. Only required if static token authentication is used.
edc.vault.hashicorp.urlstring``The URL of the Hashicorp Vault. Required if token-exchange authentication is used.
edc.vault.hashicorp.auth.tokenexchange.urlstring``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.subjecttokenpathstring``Path to the file holding the projected workload (ServiceAccount) token used as the subject token in the exchange
edc.vault.hashicorp.auth.tokenexchange.audience*stringedcvThe audience requested for the exchanged token. Must match the token-exchange service’s configured audience.
edc.vault.hashicorp.auth.tokenexchange.scope*stringreadThe abstract scope (tier) requested for the exchanged token
edc.vault.hashicorp.auth.tokenexchange.resourcestring``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*stringparticipantThe 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)

Class: org.eclipse.edc.vault.hashicorp.health.HashicorpVaultHealthExtension

Name: “Hashicorp Vault Health”

Overview: No overview provided.

Configuration

KeyRequiredTypeDefaultPatternMinMaxDescription
edc.vault.hashicorp.url*string``The URL of the Hashicorp Vault
edc.vault.hashicorp.health.check.enabled*stringtrueWhether or not the vault health check is enabled
edc.vault.hashicorp.api.health.check.path*string/v1/sys/healthThe URL path of the vault’s /health endpoint
edc.vault.hashicorp.health.check.standby.ok*stringfalseSpecifies if being a standby should still return the active status code instead of the standby status code
edc.vault.hashicorp.token.scheduledrenew.enabled*stringtrueWhether the automatic token renewal process will be triggered or not. Should be disabled only for development and testing purposes
edc.vault.hashicorp.token.ttl*string300The time-to-live (ttl) value of the Hashicorp Vault token in seconds
edc.vault.hashicorp.token.renew-buffer*string30The renew buffer of the Hashicorp Vault token in seconds
edc.vault.hashicorp.api.secret.path*string/v1/secretThe URL path of the vault’s /secret endpoint
edc.vault.hashicorp.folderstring``The path of the folder that the secret is stored in, relative to VAULT_FOLDER_PATH
edc.vault.hashicorp.allowfallback*stringtrueAllow 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

KeyRequiredTypeDefaultPatternMinMaxDescription
edc.vault.hashicorp.url*string``The URL of the Hashicorp Vault
edc.vault.hashicorp.health.check.enabled*stringtrueWhether or not the vault health check is enabled
edc.vault.hashicorp.api.health.check.path*string/v1/sys/healthThe URL path of the vault’s /health endpoint
edc.vault.hashicorp.health.check.standby.ok*stringfalseSpecifies if being a standby should still return the active status code instead of the standby status code
edc.vault.hashicorp.token.scheduledrenew.enabled*stringtrueWhether the automatic token renewal process will be triggered or not. Should be disabled only for development and testing purposes
edc.vault.hashicorp.token.ttl*string300The time-to-live (ttl) value of the Hashicorp Vault token in seconds
edc.vault.hashicorp.token.renew-buffer*string30The renew buffer of the Hashicorp Vault token in seconds
edc.vault.hashicorp.api.secret.path*string/v1/secretThe URL path of the vault’s /secret endpoint
edc.vault.hashicorp.folderstring``The path of the folder that the secret is stored in, relative to VAULT_FOLDER_PATH
edc.vault.hashicorp.allowfallback*stringtrueAllow 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)
  • org.eclipse.edc.participantcontext.spi.config.validation.ParticipantContextConfigValidatorRegistry (required)

Module verifiable-credentials

Artifact: org.eclipse.edc:verifiable-credentials:1.0.0-RC7

Categories: None

Extension points

None

Extensions

Class: org.eclipse.edc.iam.verifiablecredentials.RevocationServiceRegistryExtension

Name: “Revocation Service Registry”

Overview: No overview provided.

Configuration

KeyRequiredTypeDefaultPatternMinMaxDescription
edc.iam.credential.revocation.cache.validity*string900000Validity 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:1.0.0-RC7

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)

2 - Identity-Hub

Module attestation-api

Artifact: org.eclipse.edc:attestation-api:1.0.0-RC7

Categories: None

Extension points

None

Extensions

Class: org.eclipse.edc.issuerservice.api.admin.credentials.IssuerAttestationAdminApiExtension

Name: “Issuer Service Credentials Admin API Extension”

Overview: No overview provided.

Configuration_None_

Provided services

None

Referenced (injected) services

  • org.eclipse.edc.web.spi.WebService (required)
  • org.eclipse.edc.issuerservice.spi.issuance.attestation.AttestationDefinitionService (required)
  • org.eclipse.edc.api.auth.spi.AuthorizationService (required)

Module common-core

Artifact: org.eclipse.edc:common-core:1.0.0-RC7

Categories: None

Extension points

None

Extensions

Class: org.eclipse.edc.identityhub.DiscriminatorMappingExtension

Name: “Discriminator Mapping Extension”

Overview: No overview provided.

Configuration

KeyRequiredTypeDefaultPatternMinMaxDescription
edc.identityhub.discriminator.<alias>.value*string``the full value for the discriminator
edc.identityhub.discriminator.<alias>.alias*string``the discriminator alias

Provided services

  • org.eclipse.edc.identityhub.spi.transformation.DiscriminatorMappingRegistry

Referenced (injected) services

  • org.eclipse.edc.spi.event.EventRouter (required)

Class: org.eclipse.edc.identityhub.ScopeMappingExtension

Name: “Scope Mapping Extension”

Overview: No overview provided.

Configuration

KeyRequiredTypeDefaultPatternMinMaxDescription
edc.identityhub.scope.<alias>.pattern*string``The regular expression the scope string is matched against.
edc.identityhub.scope.<alias>.leftoperand*string``The left operand of the resulting criterion, may reference regex capture groups (e.g. $1)
edc.identityhub.scope.<alias>.operator*string``The operator of the resulting criterion, e.g. ‘contains’
edc.identityhub.scope.<alias>.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

Class: org.eclipse.edc.identityhub.DefaultServicesExtension

Name: “IdentityHub Default Services Extension”

Overview: No overview provided.

Configuration

KeyRequiredTypeDefaultPatternMinMaxDescription
edc.iam.accesstoken.jti.validation*stringfalseActivates the JTI check: access tokens can only be used once to guard against replay attacks
edc.sql.store.jti.cleanup.period*string60The period in seconds, in which expired JTI entries are deleted while the JTI check is activated

Provided services

  • org.eclipse.edc.identityhub.spi.verifiablecredentials.store.CredentialStore
  • org.eclipse.edc.identityhub.spi.keypair.store.KeyPairResourceStore
  • org.eclipse.edc.identityhub.spi.transformation.ScopeToCriterionTransformer
  • org.eclipse.edc.iam.decentralizedclaims.spi.verification.SignatureSuiteRegistry
  • org.eclipse.edc.jwt.spi.signer.JwsSignerProvider
  • org.eclipse.edc.identityhub.spi.credential.request.store.HolderCredentialRequestStore
  • org.eclipse.edc.identityhub.spi.verifiablecredentials.store.CredentialOfferStore

Referenced (injected) services

  • org.eclipse.edc.token.spi.TokenValidationRulesRegistry (required)
  • org.eclipse.edc.keys.spi.PrivateKeyResolver (required)
  • java.time.Clock (required)
  • org.eclipse.edc.spi.query.CriterionOperatorRegistry (required)
  • 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)
  • org.eclipse.edc.spi.system.ExecutorInstrumentation (required)

Module credential-definition-api

Artifact: org.eclipse.edc:credential-definition-api:1.0.0-RC7

Categories: None

Extension points

None

Extensions

Class: org.eclipse.edc.issuerservice.api.admin.credentialdefinition.IssuerCredentialDefinitionAdminApiExtension

Name: “Issuer Service Credential Definition Admin API Extension”

Overview: No overview provided.

Configuration_None_

Provided services

None

Referenced (injected) services

  • org.eclipse.edc.web.spi.WebService (required)
  • org.eclipse.edc.issuerservice.spi.issuance.credentialdefinition.CredentialDefinitionService (required)
  • org.eclipse.edc.api.auth.spi.AuthorizationService (required)
  • org.eclipse.edc.identityhub.protocols.dcp.issuer.spi.DcpIssuerProfile (required)

Module credential-offer-api

Artifact: org.eclipse.edc:credential-offer-api:1.0.0-RC7

Categories: None

Extension points

None

Extensions

Class: org.eclipse.edc.identityhub.api.CredentialOfferApiExtension

Name: “Storage API Extension”

Overview: No overview provided.

Configuration

KeyRequiredTypeDefaultPatternMinMaxDescription
edc.iam.issuer.endpoint.restrict*stringfalseWhether requests to an Issuer’s IssuerService endpoint, which is taken from the Issuer’s DID document, must use HTTPS and may only be sent to hosts that resolve to public addresses, and whether redirects are not followed. Should be enabled if participants or Issuers are not trusted to only publish endpoints of legitimate Issuers in their DID documents.
edc.iam.issuer.endpoint.allowed.hostsstring``Comma-separated list of hosts (host names or IP addresses) that requests to an Issuer’s IssuerService endpoint may be sent to, although they use plain HTTP or resolve to loopback, link-local or private addresses, e.g. an Issuer running in the same cluster. Only has an effect if ’edc.iam.issuer.endpoint.restrict’ is enabled.

Provided services

None

Referenced (injected) services

  • org.eclipse.edc.transform.spi.TypeTransformerRegistry (required)
  • org.eclipse.edc.validator.spi.JsonObjectValidatorRegistry (required)
  • org.eclipse.edc.web.spi.WebService (required)
  • org.eclipse.edc.jsonld.spi.JsonLd (required)
  • org.eclipse.edc.spi.types.TypeManager (required)
  • org.eclipse.edc.identityhub.protocols.dcp.spi.DcpIssuerTokenVerifier (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)
  • okhttp3.OkHttpClient (required)
  • dev.failsafe.RetryPolicy<okhttp3.Response> (required)

Module credential-offer-handler

Artifact: org.eclipse.edc:credential-offer-handler:1.0.0-RC7

Categories: None

Extension points

None

Extensions

Class: org.eclipse.edc.identityhub.credential.offer.handler.CredentialOfferHandlerExtension

Name: “CredentialOfferHandlerExtension”

Overview: No overview provided.

Configuration

KeyRequiredTypeDefaultPatternMinMaxDescription
edc.iam.credential.offer.trusted.issuersstring``Comma-separated list of issuer DIDs whose credential offers automatically trigger a credential request. Offers of issuers the participant already holds credentials from do so as well. Offers of other issuers are only stored. If not set, offers of any issuer trigger a credential request.

Provided services

None

Referenced (injected) services

  • org.eclipse.edc.spi.event.EventRouter (required)
  • org.eclipse.edc.identityhub.protocols.dcp.spi.DcpProfileRegistry (required)
  • org.eclipse.edc.identityhub.spi.verifiablecredentials.CredentialRequestManager (required)
  • org.eclipse.edc.identityhub.spi.verifiablecredentials.store.CredentialOfferStore (required)
  • org.eclipse.edc.identityhub.spi.credential.request.store.HolderCredentialRequestStore (required)
  • org.eclipse.edc.transaction.spi.TransactionContext (required)
  • org.eclipse.edc.identityhub.spi.verifiablecredentials.store.CredentialStore (required)

Module credential-watchdog

Artifact: org.eclipse.edc:credential-watchdog:1.0.0-RC7

Categories: None

Extension points

None

Extensions

Class: org.eclipse.edc.identityhub.common.credentialwatchdog.CredentialWatchdogExtension

Name: “VerifiableCredential Watchdog Extension”

Overview: No overview provided.

Configuration

KeyRequiredTypeDefaultPatternMinMaxDescription
edc.iam.credential.status.check.period*string60Period (in seconds) at which the Watchdog thread checks all stored credentials for their status. Configuring a number <=0 disables the Watchdog.
edc.iam.credential.status.check.delaystring``Initial delay (in seconds) before the Watchdog thread begins its work.
edc.iam.credential.renewal.graceperiod*string604800Grace period (in seconds) before credential expiry at which automatic renewal is triggered

Provided services

None

Referenced (injected) services

  • org.eclipse.edc.spi.system.ExecutorInstrumentation (required)
  • org.eclipse.edc.identityhub.spi.verifiablecredentials.CredentialStatusCheckService (required)
  • org.eclipse.edc.identityhub.spi.verifiablecredentials.store.CredentialStore (required)
  • org.eclipse.edc.transaction.spi.TransactionContext (required)
  • org.eclipse.edc.identityhub.spi.verifiablecredentials.CredentialRequestManager (required)
  • java.time.Clock (required)

Module credentials-api

Artifact: org.eclipse.edc:credentials-api:1.0.0-RC7

Categories: None

Extension points

None

Extensions

Class: org.eclipse.edc.issuerservice.api.admin.credentials.IssuerCredentialsAdminApiExtension

Name: “Issuer Service Credentials Admin API Extension”

Overview: No overview provided.

Configuration_None_

Provided services

None

Referenced (injected) services

  • org.eclipse.edc.web.spi.WebService (required)
  • org.eclipse.edc.issuerservice.spi.credentials.CredentialStatusService (required)
  • org.eclipse.edc.api.auth.spi.AuthorizationService (required)
  • org.eclipse.edc.issuerservice.spi.credentials.IssuerCredentialOfferService (required)
  • org.eclipse.edc.transform.spi.TypeTransformerRegistry (required)

Module credentials-api-configuration

Artifact: org.eclipse.edc:credentials-api-configuration:1.0.0-RC7

Categories: None

Extension points

None

Extensions

Class: org.eclipse.edc.identityhub.api.CredentialsApiConfigurationExtension

Name: “Storage API Extension”

Overview: No overview provided.

Configuration

KeyRequiredTypeDefaultPatternMinMaxDescription
web.http.credentials.port*string13131Port for credentials api context
web.http.credentials.path*string/api/credentialsPath for credentials api context
web.http.credentials.maxbodysize*string5242880Maximum size in bytes of request bodies accepted by the credentials api context. Larger requests are rejected with 413.

Provided services

None

Referenced (injected) services

  • org.eclipse.edc.jsonld.spi.JsonLd (required)
  • org.eclipse.edc.spi.types.TypeManager (required)
  • org.eclipse.edc.spi.system.apiversion.ApiVersionService (required)
  • org.eclipse.edc.web.spi.configuration.PortMappingRegistry (required)
  • org.eclipse.edc.web.spi.WebService (required)

Module dcp-core

Artifact: org.eclipse.edc:dcp-core:1.0.0-RC7

Categories: None

Extension points

None

Extensions

Class: org.eclipse.edc.identityhub.protocols.dcp.DcpCoreExtension

Name: “DCP Core Extension”

Overview: No overview provided.

Configuration_None_

Provided services

  • org.eclipse.edc.identityhub.protocols.dcp.spi.DcpProfileRegistry

Referenced (injected) services

None

Module dcp-identityhub-core

Artifact: org.eclipse.edc:dcp-identityhub-core:1.0.0-RC7

Categories: None

Extension points

None

Extensions

Class: org.eclipse.edc.identityhub.protocols.dcp.issuer.DcpHolderCoreExtension

Name: “DCP Holder Core Extension”

Overview: No overview provided.

Configuration

KeyRequiredTypeDefaultPatternMinMaxDescription
edc.iam.accesstoken.jti.validation*stringfalseActivates the JTI check: access tokens can only be used once to guard against replay attacks

Provided services

  • org.eclipse.edc.identityhub.protocols.dcp.spi.DcpIssuerTokenVerifier

Referenced (injected) services

  • java.time.Clock (required)
  • org.eclipse.edc.token.spi.TokenValidationService (required)
  • org.eclipse.edc.iam.did.spi.resolution.DidPublicKeyResolver (required)
  • org.eclipse.edc.jwt.validation.jti.JtiValidationStore (optional)

Module dcp-issuer-api

Artifact: org.eclipse.edc:dcp-issuer-api:1.0.0-RC7

Categories: None

Extension points

None

Extensions

Class: org.eclipse.edc.identityhub.protocols.dcp.issuer.IssuerApiExtension

Name: “Issuer API extension”

Overview: No overview provided.

Configuration

KeyRequiredTypeDefaultPatternMinMaxDescription
web.http.issuance.port*string13132Port for issuance api context
web.http.issuance.path*string/api/issuancePath for issuance api context
web.http.issuance.maxbodysize*string5242880Maximum size in bytes of request bodies accepted by the issuance api context. Larger requests are rejected with 413.

Provided services

None

Referenced (injected) services

  • org.eclipse.edc.spi.types.TypeManager (required)
  • org.eclipse.edc.spi.system.apiversion.ApiVersionService (required)
  • org.eclipse.edc.web.spi.WebService (required)
  • org.eclipse.edc.web.spi.configuration.PortMappingRegistry (required)
  • org.eclipse.edc.transform.spi.TypeTransformerRegistry (required)
  • org.eclipse.edc.jsonld.spi.JsonLd (required)
  • org.eclipse.edc.identityhub.protocols.dcp.issuer.spi.DcpIssuerService (required)
  • org.eclipse.edc.identityhub.protocols.dcp.spi.DcpHolderTokenVerifier (required)
  • org.eclipse.edc.validator.spi.JsonObjectValidatorRegistry (required)
  • org.eclipse.edc.identityhub.spi.participantcontext.IdentityHubParticipantContextService (required)
  • org.eclipse.edc.issuerservice.spi.issuance.process.IssuanceProcessService (required)
  • org.eclipse.edc.identityhub.protocols.dcp.issuer.spi.DcpIssuerMetadataService (required)

Module dcp-issuer-core

Artifact: org.eclipse.edc:dcp-issuer-core:1.0.0-RC7

Categories: None

Extension points

None

Extensions

Class: org.eclipse.edc.identityhub.protocols.dcp.issuer.DcpIssuerCoreExtension

Name: “DCP Issuer Core Extension”

Overview: No overview provided.

Configuration

KeyRequiredTypeDefaultPatternMinMaxDescription
edc.issuer.issuance.state-machine.iteration-wait-millis*string1000The iteration wait time in milliseconds in the state machine.
edc.issuer.issuance.state-machine.batch-size*string10The number of entities to be processed on every iteration. They are leased together, so the lease must outlast the processing of all of them.
edc.issuer.issuance.state-machine.lease-duration-millis*string300000How long the entities of a batch are leased, in milliseconds. It must be longer than the processing of a whole batch, i.e. longer than the batch size times the call timeout, otherwise another runtime may process the same entities.
edc.issuer.issuance.send.retry.limit*string80How many times a failed operation is retried before it fails with an error. With the default delays, the retries take about six hours.
edc.issuer.issuance.send.retry.base-delay.ms*string1000The base delay of retries in milliseconds. The n-th retry waits the base delay times 2 to the power of n, but at most the maximum delay.
edc.issuer.issuance.send.retry.max-delay.ms*string300000The maximum delay between two retries in milliseconds.
edc.issuer.issuance.send.connect-timeout.ms*string5000How long it may take to connect to the counterparty when a message is sent, in milliseconds.
edc.issuer.issuance.send.call-timeout.ms*string15000How long it may take to send a message and receive the response, in milliseconds. A message that times out is not retried right away, but by the state machine, like any other failure.
edc.issuer.dcp.profile*stringvc20-bssl/jwtThe DCP profile of the issuer, e.g. ‘vc20-bssl/jwt’ (VCDM 2.0 Bitstring Status List) or ‘vc11-sl2021/jwt’ (VCDM 1.1 StatusList2021). It determines the kind of status list that holds the status of the issued credentials, whatever their format.
edc.iam.accesstoken.jti.validation*stringfalseActivates the JTI check: access tokens can only be used once to guard against replay attacks
edc.issuance.anonymous.allowed*stringfalseAllow anonymous onboarding

Provided services

  • org.eclipse.edc.identityhub.protocols.dcp.issuer.spi.DcpIssuerProfile
  • org.eclipse.edc.identityhub.protocols.dcp.issuer.spi.DcpIssuerService
  • org.eclipse.edc.identityhub.protocols.dcp.spi.DcpHolderTokenVerifier
  • org.eclipse.edc.issuerservice.spi.issuance.delivery.CredentialStorageClient
  • org.eclipse.edc.identityhub.protocols.dcp.issuer.spi.DcpIssuerMetadataService
  • org.eclipse.edc.iam.decentralizedclaims.spi.CredentialServiceUrlResolver

Referenced (injected) services

  • org.eclipse.edc.token.spi.TokenValidationRulesRegistry (required)
  • org.eclipse.edc.token.spi.TokenValidationService (required)
  • org.eclipse.edc.participantcontext.spi.store.ParticipantContextStore (required)
  • org.eclipse.edc.issuerservice.spi.holder.store.HolderStore (required)
  • org.eclipse.edc.iam.did.spi.resolution.DidPublicKeyResolver (required)
  • org.eclipse.edc.issuerservice.spi.issuance.credentialdefinition.CredentialDefinitionService (required)
  • org.eclipse.edc.issuerservice.spi.issuance.process.store.IssuanceProcessStore (required)
  • org.eclipse.edc.issuerservice.spi.issuance.attestation.AttestationPipeline (required)
  • org.eclipse.edc.issuerservice.spi.issuance.rule.CredentialRuleDefinitionEvaluator (required)
  • org.eclipse.edc.transaction.spi.TransactionContext (required)
  • java.time.Clock (required)
  • okhttp3.OkHttpClient (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)
  • org.eclipse.edc.identityhub.protocols.dcp.spi.DcpProfileRegistry (required)
  • org.eclipse.edc.issuerservice.spi.issuance.generator.CredentialGeneratorRegistry (required)
  • org.eclipse.edc.jwt.validation.jti.JtiValidationStore (optional)
  • org.eclipse.edc.spi.telemetry.Telemetry (required)
  • org.eclipse.edc.issuerservice.spi.issuance.events.IssuanceObservable (required)

Module did-api

Artifact: org.eclipse.edc:did-api:1.0.0-RC7

Categories: None

Extension points

None

Extensions

Class: org.eclipse.edc.identityhub.api.didmanagement.DidManagementApiExtension

Name: “DID management Identity API Extension”

Overview: No overview provided.

Configuration_None_

Provided services

None

Referenced (injected) services

  • org.eclipse.edc.web.spi.WebService (required)
  • org.eclipse.edc.identityhub.spi.did.DidDocumentService (required)
  • org.eclipse.edc.api.auth.spi.AuthorizationService (required)

Module did-spi

Name: Identity Hub DID services Artifact: org.eclipse.edc:did-spi:1.0.0-RC7

Categories: None

Extension points

  • org.eclipse.edc.identityhub.spi.did.DidDocumentPublisher
  • org.eclipse.edc.identityhub.spi.did.store.DidResourceStore
  • org.eclipse.edc.identityhub.spi.did.DidWebParser

Extensions

Module holder-api

Artifact: org.eclipse.edc:holder-api:1.0.0-RC7

Categories: None

Extension points

None

Extensions

Class: org.eclipse.edc.issuerservice.api.admin.holder.IssuerHolderAdminApiExtension

Name: “Issuer Service Participant Admin API Extension”

Overview: No overview provided.

Configuration_None_

Provided services

None

Referenced (injected) services

  • org.eclipse.edc.web.spi.WebService (required)
  • org.eclipse.edc.issuerservice.spi.holder.HolderService (required)
  • org.eclipse.edc.api.auth.spi.AuthorizationService (required)

Module holder-credential-offer-store-sql

Artifact: org.eclipse.edc:holder-credential-offer-store-sql:1.0.0-RC7

Categories: None

Extension points

None

Extensions

Class: org.eclipse.edc.identityhub.store.sql.credentialoffer.schema.SqlCredentialOfferStoreExtension

Name: “Holder Credential Offer SQL Store Extension”

Overview: No overview provided.

Configuration

KeyRequiredTypeDefaultPatternMinMaxDescription
edc.sql.store.credentialoffer.datasource*stringdefaultThe datasource to be used

Provided services

  • org.eclipse.edc.identityhub.spi.verifiablecredentials.store.CredentialOfferStore

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.identityhub.store.sql.credentialoffer.schema.CredentialOfferStoreStatements (optional)
  • org.eclipse.edc.sql.bootstrapper.SqlSchemaBootstrapper (required)
  • java.time.Clock (required)

Module holder-credential-request-store-sql

Artifact: org.eclipse.edc:holder-credential-request-store-sql:1.0.0-RC7

Categories: None

Extension points

None

Extensions

Class: org.eclipse.edc.identityhub.store.sql.credentialrequest.schema.SqlHolderCredentialRequestStoreExtension

Name: “Holder Credential Request SQL Store Extension”

Overview: No overview provided.

Configuration

KeyRequiredTypeDefaultPatternMinMaxDescription
edc.iam.credential.request.state-machine.iteration-wait-millis*string1000The iteration wait time in milliseconds in the state machine.
edc.iam.credential.request.state-machine.batch-size*string10The number of entities to be processed on every iteration. They are leased together, so the lease must outlast the processing of all of them.
edc.iam.credential.request.state-machine.lease-duration-millis*string300000How long the entities of a batch are leased, in milliseconds. It must be longer than the processing of a whole batch, i.e. longer than the batch size times the call timeout, otherwise another runtime may process the same entities.
edc.iam.credential.request.send.retry.limit*string80How many times a failed operation is retried before it fails with an error. With the default delays, the retries take about six hours.
edc.iam.credential.request.send.retry.base-delay.ms*string1000The base delay of retries in milliseconds. The n-th retry waits the base delay times 2 to the power of n, but at most the maximum delay.
edc.iam.credential.request.send.retry.max-delay.ms*string300000The maximum delay between two retries in milliseconds.
edc.iam.credential.request.send.connect-timeout.ms*string5000How long it may take to connect to the counterparty when a message is sent, in milliseconds.
edc.iam.credential.request.send.call-timeout.ms*string15000How long it may take to send a message and receive the response, in milliseconds. A message that times out is not retried right away, but by the state machine, like any other failure.
edc.sql.store.credentialrequest.datasource*stringdefaultThe datasource to be used

Provided services

  • org.eclipse.edc.identityhub.spi.credential.request.store.HolderCredentialRequestStore

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.identityhub.store.sql.credentialrequest.schema.HolderCredentialRequestStoreStatements (optional)
  • org.eclipse.edc.sql.bootstrapper.SqlSchemaBootstrapper (required)
  • java.time.Clock (required)

Module identity-api-authentication-oauth2

Artifact: org.eclipse.edc:identity-api-authentication-oauth2:1.0.0-RC7

Categories: None

Extension points

None

Extensions

Class: org.eclipse.edc.identityhub.api.Oauth2JwtAuthenticationExtension

Name: “Identity API OAuth2/JWT Authentication Extension”

Overview: No overview provided.

Configuration

KeyRequiredTypeDefaultPatternMinMaxDescription
edc.iam.oauth2.issuerstring``Expected value for the ‘iss’ claim for tokens coming from the OAuth2 server. If this is omitted, the ‘iss’ claim is not validated
edc.iam.oauth2.audiencestring``Audience that the ‘aud’ claim of tokens coming from the OAuth2 server must contain. If this is omitted, the ‘aud’ claim is not validated
edc.iam.oauth2.jwks.url*string``Absolute URL where the JWKS of the OAuth2 server is hosted
edc.iam.oauth2.jwks.cache.validity*string300000Time (in ms) that cached JWKS are cached
edc.iam.oauth2.validity.leeway*string5Leeway (in sec) to allow when validating token time-based claims

Provided services

None

Referenced (injected) services

  • org.eclipse.edc.web.spi.WebService (required)
  • org.eclipse.edc.participantcontext.spi.service.ParticipantContextService (required)
  • java.time.Clock (required)
  • org.eclipse.edc.token.spi.TokenValidationService (required)
  • org.eclipse.edc.keys.spi.KeyParserRegistry (required)
  • org.eclipse.edc.spi.monitor.Monitor (required)

Module identity-api-authorization-oauth2

Artifact: org.eclipse.edc:identity-api-authorization-oauth2:1.0.0-RC7

Categories: None

Extension points

None

Extensions

Class: org.eclipse.edc.identityhub.api.Oauth2AuthorizationExtension

Name: “Identity API OAuth2 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 identity-api-configuration

Artifact: org.eclipse.edc:identity-api-configuration:1.0.0-RC7

Categories: None

Extension points

None

Extensions

Class: org.eclipse.edc.identityhub.api.configuration.IdentityApiConfigurationExtension

Name: “Identity API Extension”

Overview: No overview provided.

Configuration

KeyRequiredTypeDefaultPatternMinMaxDescription
web.http.identity.port*string15151Port for identity api context
web.http.identity.path*string/api/identityPath for identity api context

Provided services

  • org.eclipse.edc.api.auth.spi.AuthorizationService

Referenced (injected) services

  • org.eclipse.edc.spi.types.TypeManager (required)
  • org.eclipse.edc.web.spi.configuration.PortMappingRegistry (required)
  • org.eclipse.edc.spi.system.apiversion.ApiVersionService (required)
  • org.eclipse.edc.web.spi.WebService (required)

Module identity-hub-core

Artifact: org.eclipse.edc:identity-hub-core:1.0.0-RC7

Categories: None

Extension points

None

Extensions

Class: org.eclipse.edc.identityhub.core.CoreServicesExtension

Name: “IdentityHub Core Services Extension”

Overview: This extension provides core services for the IdentityHub that are not intended to be user-replaceable.

Configuration

KeyRequiredTypeDefaultPatternMinMaxDescription
edc.iam.credential.request.status.poll.interval*string30000Interval in milliseconds at which the Issuer is asked about the status of credential requests that are still awaiting their credentials. Each run is delayed by up to a fifth of it at random, so that runtimes do not poll in lockstep. Configuring a number <= 0 disables polling, and with it the timeouts of requests awaiting their credentials.
edc.iam.credential.request.status.poll.min.age*string30000Time in milliseconds a credential request waits for its credentials before the Issuer is first asked about its status, as most Issuers deliver them within that time
edc.iam.credential.request.status.poll.max.interval*string900000Maximum time in milliseconds between two status queries for the same credential request. A request is asked about less often the longer it waits for its credentials, up to this interval.
edc.iam.credential.request.bearer.access.scopestring``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.
edc.iam.credential.request.untracked.timeout*string21600Time in seconds after which a credential request is considered failed if its credentials have not arrived, and its status cannot be queried, because the Issuer did not report its issuance process ID
edc.iam.credential.request.tracked.timeout*string86400Time in seconds after which a credential request is considered failed if its credentials have not arrived, although the Issuer keeps reporting it as pending
edc.iam.credential.request.state-machine.iteration-wait-millis*string1000The iteration wait time in milliseconds in the state machine.
edc.iam.credential.request.state-machine.batch-size*string10The number of entities to be processed on every iteration. They are leased together, so the lease must outlast the processing of all of them.
edc.iam.credential.request.state-machine.lease-duration-millis*string300000How long the entities of a batch are leased, in milliseconds. It must be longer than the processing of a whole batch, i.e. longer than the batch size times the call timeout, otherwise another runtime may process the same entities.
edc.iam.credential.request.send.retry.limit*string80How many times a failed operation is retried before it fails with an error. With the default delays, the retries take about six hours.
edc.iam.credential.request.send.retry.base-delay.ms*string1000The base delay of retries in milliseconds. The n-th retry waits the base delay times 2 to the power of n, but at most the maximum delay.
edc.iam.credential.request.send.retry.max-delay.ms*string300000The maximum delay between two retries in milliseconds.
edc.iam.credential.request.send.connect-timeout.ms*string5000How long it may take to connect to the counterparty when a message is sent, in milliseconds.
edc.iam.credential.request.send.call-timeout.ms*string15000How long it may take to send a message and receive the response, in milliseconds. A message that times out is not retried right away, but by the state machine, like any other failure.
edc.iam.presentation.validity*string60How long a Verifiable Presentation is valid after it was created, in seconds. Determines the ’exp’ claim of JWT presentations and the proof ’expires’ of Linked-Data presentations.
edc.iam.presentation.vcdm20.plain.enabled*stringfalseReturns VCDM 2.0 presentations as the VP JWT itself, as defined by VC-JOSE-COSE, instead of wrapping it in an ‘EnvelopedVerifiablePresentation’ that is signed again as a JWT. Only enable this if all verifiers accept plain VP JWTs.
edc.iam.accesstoken.publickey.fallback.enabled*stringfalseVerifies access tokens with keys from the vault or ’edc.iam.publickeys’ if the participant context has no matching key pair. That lookup is not scoped to the participant context, so this should only be enabled for keys that are not managed as key pairs.
edc.iam.credential.delivery.reject.unverified*stringfalseRejects delivered credentials in formats whose proof cannot be verified, such as credentials with an embedded Linked-Data proof. If disabled, they are stored with a warning.
edc.iam.issuer.endpoint.restrict*stringfalseWhether requests to an Issuer’s IssuerService endpoint, which is taken from the Issuer’s DID document, must use HTTPS and may only be sent to hosts that resolve to public addresses, and whether redirects are not followed. Should be enabled if participants or Issuers are not trusted to only publish endpoints of legitimate Issuers in their DID documents.
edc.iam.issuer.endpoint.allowed.hostsstring``Comma-separated list of hosts (host names or IP addresses) that requests to an Issuer’s IssuerService endpoint may be sent to, although they use plain HTTP or resolve to loopback, link-local or private addresses, e.g. an Issuer running in the same cluster. Only has an effect if ’edc.iam.issuer.endpoint.restrict’ is enabled.

Provided services

  • org.eclipse.edc.identityhub.spi.verification.SelfIssuedTokenVerifier
  • org.eclipse.edc.identityhub.spi.verifiablecredentials.resolution.CredentialQueryResolver
  • org.eclipse.edc.identityhub.spi.verifiablecredentials.generator.PresentationCreatorRegistry
  • org.eclipse.edc.identityhub.spi.verifiablecredentials.generator.VerifiablePresentationService
  • org.eclipse.edc.identityhub.spi.verifiablecredentials.generator.CredentialWriter
  • org.eclipse.edc.identityhub.spi.verifiablecredentials.CredentialStatusCheckService
  • org.eclipse.edc.identityhub.spi.verifiablecredentials.CredentialRequestManager
  • org.eclipse.edc.identityhub.spi.verifiablecredentials.offer.CredentialOfferService
  • org.eclipse.edc.identityhub.spi.verifiablecredentials.events.CredentialOfferObservable

Referenced (injected) services

  • org.eclipse.edc.iam.did.spi.resolution.DidPublicKeyResolver (required)
  • org.eclipse.edc.jsonld.spi.JsonLd (required)
  • org.eclipse.edc.identityhub.spi.verifiablecredentials.store.CredentialStore (required)
  • org.eclipse.edc.identityhub.spi.transformation.ScopeToCriterionTransformer (required)
  • org.eclipse.edc.keys.spi.PrivateKeyResolver (required)
  • java.time.Clock (required)
  • org.eclipse.edc.iam.decentralizedclaims.spi.verification.SignatureSuiteRegistry (required)
  • org.eclipse.edc.spi.types.TypeManager (required)
  • org.eclipse.edc.token.spi.TokenValidationService (required)
  • org.eclipse.edc.token.spi.TokenValidationRulesRegistry (required)
  • org.eclipse.edc.keys.spi.KeyParserRegistry (required)
  • org.eclipse.edc.iam.decentralizedclaims.spi.verification.SignatureSuiteRegistry (required)
  • org.eclipse.edc.identityhub.spi.keypair.KeyPairService (required)
  • org.eclipse.edc.iam.verifiablecredentials.spi.model.RevocationServiceRegistry (required)
  • org.eclipse.edc.identityhub.spi.keypair.store.KeyPairResourceStore (required)
  • org.eclipse.edc.keys.spi.LocalPublicKeyService (required)
  • org.eclipse.edc.identityhub.spi.participantcontext.IdentityHubParticipantContextService (required)
  • org.eclipse.edc.jwt.spi.signer.JwsSignerProvider (required)
  • org.eclipse.edc.transaction.spi.TransactionContext (required)
  • org.eclipse.edc.transform.spi.TypeTransformerRegistry (required)
  • org.eclipse.edc.iam.did.spi.resolution.DidResolverRegistry (required)
  • org.eclipse.edc.identityhub.spi.credential.request.store.HolderCredentialRequestStore (required)
  • org.eclipse.edc.identityhub.spi.authentication.ParticipantSecureTokenService (required)
  • okhttp3.OkHttpClient (required)
  • org.eclipse.edc.identityhub.spi.credential.request.store.HolderCredentialRequestStore (required)
  • org.eclipse.edc.identityhub.spi.verifiablecredentials.store.CredentialOfferStore (required)
  • org.eclipse.edc.spi.event.EventRouter (required)
  • org.eclipse.edc.spi.system.ExecutorInstrumentation (required)

Module identity-hub-credentials-store-sql

Artifact: org.eclipse.edc:identity-hub-credentials-store-sql:1.0.0-RC7

Categories: None

Extension points

None

Extensions

Class: org.eclipse.edc.identityhub.store.sql.credentials.SqlCredentialStoreExtension

Name: “CredentialResource SQL Store Extension”

Overview: No overview provided.

Configuration

KeyRequiredTypeDefaultPatternMinMaxDescription
edc.sql.store.credentials.datasource*stringdefaultThe datasource to be used

Provided services

  • org.eclipse.edc.identityhub.spi.verifiablecredentials.store.CredentialStore

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.identityhub.store.sql.credentials.CredentialStoreStatements (optional)
  • org.eclipse.edc.sql.bootstrapper.SqlSchemaBootstrapper (required)

Module identity-hub-did

Artifact: org.eclipse.edc:identity-hub-did:1.0.0-RC7

Categories: None

Extension points

None

Extensions

Class: org.eclipse.edc.identityhub.did.DidServicesExtension

Name: “DID Service Extension”

Overview: No overview provided.

Configuration_None_

Provided services

  • org.eclipse.edc.identityhub.spi.did.DidDocumentPublisherRegistry
  • org.eclipse.edc.identityhub.spi.did.DidDocumentService

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)

Class: org.eclipse.edc.identityhub.did.defaults.DidDefaultServicesExtension

Name: “DID Default Services Extension”

Overview: No overview provided.

Configuration_None_

Provided services

  • org.eclipse.edc.identityhub.spi.did.store.DidResourceStore

Referenced (injected) services

  • org.eclipse.edc.spi.query.CriterionOperatorRegistry (required)

Module identity-hub-did-store-sql

Artifact: org.eclipse.edc:identity-hub-did-store-sql:1.0.0-RC7

Categories: None

Extension points

None

Extensions

Class: org.eclipse.edc.identityhub.did.store.sql.SqlDidResourceStoreExtension

Name: “DID Resource SQL Store Extension”

Overview: No overview provided.

Configuration

KeyRequiredTypeDefaultPatternMinMaxDescription
edc.sql.store.didresource.datasource*stringdefaultThe datasource to be used

Provided services

  • org.eclipse.edc.identityhub.spi.did.store.DidResourceStore

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.identityhub.did.store.sql.DidResourceStatements (optional)
  • org.eclipse.edc.sql.bootstrapper.SqlSchemaBootstrapper (required)

Module identity-hub-keypair-store-sql

Artifact: org.eclipse.edc:identity-hub-keypair-store-sql:1.0.0-RC7

Categories: None

Extension points

None

Extensions

Class: org.eclipse.edc.identityhub.store.sql.keypair.SqlKeyPairResourceStoreExtension

Name: “KeyPair Resource SQL Store Extension”

Overview: No overview provided.

Configuration

KeyRequiredTypeDefaultPatternMinMaxDescription
edc.sql.store.keypair.datasource*stringdefaultThe datasource to be used

Provided services

  • org.eclipse.edc.identityhub.spi.keypair.store.KeyPairResourceStore

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.identityhub.store.sql.keypair.KeyPairResourceStoreStatements (optional)
  • org.eclipse.edc.sql.bootstrapper.SqlSchemaBootstrapper (required)

Module identity-hub-keypairs

Artifact: org.eclipse.edc:identity-hub-keypairs:1.0.0-RC7

Categories: None

Extension points

None

Extensions

Class: org.eclipse.edc.identityhub.keypairs.KeyPairServiceExtension

Name: “KeyPair Service Extension”

Overview: No overview provided.

Configuration_None_

Provided services

  • org.eclipse.edc.identityhub.spi.keypair.KeyPairService
  • org.eclipse.edc.identityhub.spi.keypair.events.KeyPairObservable

Referenced (injected) services

  • org.eclipse.edc.spi.security.Vault (required)
  • org.eclipse.edc.identityhub.spi.keypair.store.KeyPairResourceStore (required)
  • org.eclipse.edc.spi.event.EventRouter (required)
  • java.time.Clock (required)
  • org.eclipse.edc.transaction.spi.TransactionContext (required)
  • org.eclipse.edc.participantcontext.spi.store.ParticipantContextStore (required)

Module identity-hub-keypairs-transit

Artifact: org.eclipse.edc:identity-hub-keypairs-transit:1.0.0-RC7

Categories: None

Extension points

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)
  • java.time.Clock (required)

Class: org.eclipse.edc.identityhub.TransitSecurityExtension

Name: “Hashicorp Transit Security Extension”

Overview: No overview provided.

Configuration

KeyRequiredTypeDefaultPatternMinMaxDescription
edc.vault.hashicorp.url*string``The URL of the Hashicorp Vault

Provided services

  • org.eclipse.edc.jwt.spi.signer.JwsSignerProvider
  • org.eclipse.edc.identityhub.transit.TransitEngine

Referenced (injected) services

  • org.eclipse.edc.vault.hashicorp.spi.auth.HashicorpVaultTokenProviderFactory (required)
  • org.eclipse.edc.http.spi.EdcHttpClient (required)
  • org.eclipse.edc.spi.types.TypeManager (required)

Module identity-hub-participants

Artifact: org.eclipse.edc:identity-hub-participants:1.0.0-RC7

Categories: None

Extension points

None

Extensions

Class: org.eclipse.edc.identityhub.participantcontext.ParticipantContextCoordinatorExtension

Name: “ParticipantContext Extension”

Overview: No overview provided.

Configuration_None_

Provided services

None

Referenced (injected) services

  • org.eclipse.edc.identityhub.spi.did.DidDocumentService (required)
  • org.eclipse.edc.identityhub.spi.keypair.KeyPairService (required)
  • java.time.Clock (required)
  • org.eclipse.edc.spi.event.EventRouter (required)
  • org.eclipse.edc.identityhub.spi.participantcontext.IdentityHubParticipantContextService (required)
  • org.eclipse.edc.spi.telemetry.Telemetry (required)

Class: org.eclipse.edc.identityhub.participantcontext.ParticipantContextExtension

Name: “ParticipantContext Extension”

Overview: No overview provided.

Configuration_None_

Provided services

  • org.eclipse.edc.identityhub.spi.participantcontext.IdentityHubParticipantContextService
  • org.eclipse.edc.identityhub.spi.participantcontext.events.ParticipantContextObservable

Referenced (injected) services

  • org.eclipse.edc.participantcontext.spi.store.ParticipantContextStore (required)
  • org.eclipse.edc.spi.security.Vault (required)
  • org.eclipse.edc.transaction.spi.TransactionContext (required)
  • java.time.Clock (required)
  • org.eclipse.edc.spi.event.EventRouter (required)
  • org.eclipse.edc.identityhub.spi.did.store.DidResourceStore (required)
  • org.eclipse.edc.identityhub.spi.participantcontext.StsAccountProvisioner (required)
  • org.eclipse.edc.participantcontext.spi.config.service.ParticipantContextConfigService (required)
  • org.eclipse.edc.spi.telemetry.Telemetry (required)
  • org.eclipse.edc.spi.monitor.Monitor (required)

Module identityhub-api-authentication

Artifact: org.eclipse.edc:identityhub-api-authentication:1.0.0-RC7

Categories: None

Extension points

None

Extensions

Class: org.eclipse.edc.identityhub.api.ApiAuthenticationExtension

Name: “Identity API Authentication Extension”

Overview: No overview provided.

Configuration_None_

Provided services

None

Referenced (injected) services

  • org.eclipse.edc.web.spi.WebService (required)
  • org.eclipse.edc.identityhub.spi.participantcontext.IdentityHubParticipantContextService (required)
  • org.eclipse.edc.spi.security.Vault (required)

Module identityhub-api-authorization

Artifact: org.eclipse.edc:identityhub-api-authorization:1.0.0-RC7

Categories: None

Extension points

None

Extensions

Class: org.eclipse.edc.identityhub.api.ApiAuthorizationExtension

Name: “Identity API Authorization Extension”

Overview: No overview provided.

Configuration_None_

Provided services

  • org.eclipse.edc.api.auth.spi.AuthorizationService

Referenced (injected) services

None

Module issuance-process-api

Artifact: org.eclipse.edc:issuance-process-api:1.0.0-RC7

Categories: None

Extension points

None

Extensions

Class: org.eclipse.edc.issuerservice.api.admin.issuance.IssuanceProcessAdminApiExtension

Name: “Issuer Service Issuance Process Admin API Extension”

Overview: No overview provided.

Configuration_None_

Provided services

None

Referenced (injected) services

  • org.eclipse.edc.web.spi.WebService (required)
  • org.eclipse.edc.issuerservice.spi.issuance.process.IssuanceProcessService (required)
  • org.eclipse.edc.api.auth.spi.AuthorizationService (required)

Module issuance-process-store-sql

Artifact: org.eclipse.edc:issuance-process-store-sql:1.0.0-RC7

Categories: None

Extension points

None

Extensions

Class: org.eclipse.edc.issuerservice.store.sql.issuanceprocess.SqlIssuanceProcessStoreExtension

Name: “Issuance Process SQL Store Extension”

Overview: No overview provided.

Configuration

KeyRequiredTypeDefaultPatternMinMaxDescription
edc.issuer.issuance.state-machine.iteration-wait-millis*string1000The iteration wait time in milliseconds in the state machine.
edc.issuer.issuance.state-machine.batch-size*string10The number of entities to be processed on every iteration. They are leased together, so the lease must outlast the processing of all of them.
edc.issuer.issuance.state-machine.lease-duration-millis*string300000How long the entities of a batch are leased, in milliseconds. It must be longer than the processing of a whole batch, i.e. longer than the batch size times the call timeout, otherwise another runtime may process the same entities.
edc.issuer.issuance.send.retry.limit*string80How many times a failed operation is retried before it fails with an error. With the default delays, the retries take about six hours.
edc.issuer.issuance.send.retry.base-delay.ms*string1000The base delay of retries in milliseconds. The n-th retry waits the base delay times 2 to the power of n, but at most the maximum delay.
edc.issuer.issuance.send.retry.max-delay.ms*string300000The maximum delay between two retries in milliseconds.
edc.issuer.issuance.send.connect-timeout.ms*string5000How long it may take to connect to the counterparty when a message is sent, in milliseconds.
edc.issuer.issuance.send.call-timeout.ms*string15000How long it may take to send a message and receive the response, in milliseconds. A message that times out is not retried right away, but by the state machine, like any other failure.
edc.sql.store.issuanceprocess.datasource*stringdefaultThe datasource to be used

Provided services

  • org.eclipse.edc.issuerservice.spi.issuance.process.store.IssuanceProcessStore

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.issuerservice.store.sql.issuanceprocess.IssuanceProcessStoreStatements (optional)
  • org.eclipse.edc.sql.bootstrapper.SqlSchemaBootstrapper (required)
  • java.time.Clock (required)

Module issuer-admin-api-authentication

Artifact: org.eclipse.edc:issuer-admin-api-authentication:1.0.0-RC7

Categories: None

Extension points

None

Extensions

Class: org.eclipse.edc.identityhub.api.IssuerAdminApiAuthenticationExtension

Name: “Issuer Admin API Authentication Extension”

Overview: No overview provided.

Configuration_None_

Provided services

None

Referenced (injected) services

  • org.eclipse.edc.web.spi.WebService (required)
  • org.eclipse.edc.identityhub.spi.participantcontext.IdentityHubParticipantContextService (required)
  • org.eclipse.edc.spi.security.Vault (required)

Module issuer-admin-api-authentication-oauth2

Artifact: org.eclipse.edc:issuer-admin-api-authentication-oauth2:1.0.0-RC7

Categories: None

Extension points

None

Extensions

Class: org.eclipse.edc.issuerservice.api.Oauth2JwtAuthenticationExtension

Name: “Issuer Admin API OAuth2/JWT Authentication Extension”

Overview: No overview provided.

Configuration

KeyRequiredTypeDefaultPatternMinMaxDescription
edc.iam.oauth2.issuerstring``Expected value for the ‘iss’ claim for tokens coming from the OAuth2 server. If this is omitted, the ‘iss’ claim is not validated
edc.iam.oauth2.audiencestring``Audience that the ‘aud’ claim of tokens coming from the OAuth2 server must contain. If this is omitted, the ‘aud’ claim is not validated
edc.iam.oauth2.jwks.url*string``Absolute URL where the JWKS of the OAuth2 server is hosted
edc.iam.oauth2.jwks.cache.validity*string300000Time (in ms) that cached JWKS are cached
edc.iam.oauth2.validity.leeway*string5Leeway (in sec) to allow when validating token time-based claims

Provided services

None

Referenced (injected) services

  • org.eclipse.edc.web.spi.WebService (required)
  • org.eclipse.edc.participantcontext.spi.service.ParticipantContextService (required)
  • java.time.Clock (required)
  • org.eclipse.edc.token.spi.TokenValidationService (required)
  • org.eclipse.edc.keys.spi.KeyParserRegistry (required)
  • org.eclipse.edc.spi.monitor.Monitor (required)

Module issuer-admin-api-authorization-oauth2

Artifact: org.eclipse.edc:issuer-admin-api-authorization-oauth2:1.0.0-RC7

Categories: None

Extension points

None

Extensions

Class: org.eclipse.edc.issuerservice.api.Oauth2AuthorizationExtension

Name: “Issuer Admin API OAuth2 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 issuer-admin-api-configuration

Artifact: org.eclipse.edc:issuer-admin-api-configuration:1.0.0-RC7

Categories: None

Extension points

None

Extensions

Class: org.eclipse.edc.identityhub.api.configuration.IssuerAdminApiConfigurationExtension

Name: “Issuer Admin API Configuration Extension”

Overview: No overview provided.

Configuration

KeyRequiredTypeDefaultPatternMinMaxDescription
web.http.issueradmin.port*string15152Port for issueradmin api context
web.http.issueradmin.path*string/api/issuerPath for issueradmin api context

Provided services

  • org.eclipse.edc.api.auth.spi.AuthorizationService

Referenced (injected) services

  • org.eclipse.edc.spi.types.TypeManager (required)
  • org.eclipse.edc.web.spi.configuration.PortMappingRegistry (required)
  • org.eclipse.edc.spi.system.apiversion.ApiVersionService (required)
  • org.eclipse.edc.web.spi.WebService (required)

Module issuerservice-attestation-definition-store-sql

Artifact: org.eclipse.edc:issuerservice-attestation-definition-store-sql:1.0.0-RC7

Categories: None

Extension points

None

Extensions

Class: org.eclipse.edc.issuerservice.store.sql.attestationdefinition.SqlAttestationDefinitionStoreExtension

Name: “IssuerService Attestation Definition SQL Store Extension”

Overview: No overview provided.

Configuration

KeyRequiredTypeDefaultPatternMinMaxDescription
edc.sql.store.attestationdefinitions.datasource*stringdefaultThe datasource to be used

Provided services

  • org.eclipse.edc.issuerservice.spi.issuance.attestation.AttestationDefinitionStore

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.issuerservice.store.sql.attestationdefinition.AttestationDefinitionStoreStatements (optional)
  • org.eclipse.edc.sql.bootstrapper.SqlSchemaBootstrapper (required)

Module issuerservice-core

Artifact: org.eclipse.edc:issuerservice-core:1.0.0-RC7

Categories: None

Extension points

None

Extensions

Class: org.eclipse.edc.issuerservice.defaults.DefaultServiceExtension

Name: “IssuerService Default Services Extension”

Overview: No overview provided.

Configuration_None_

Provided services

  • org.eclipse.edc.issuerservice.spi.holder.store.HolderStore
  • org.eclipse.edc.issuerservice.spi.issuance.attestation.AttestationDefinitionStore
  • org.eclipse.edc.issuerservice.spi.issuance.credentialdefinition.store.CredentialDefinitionStore
  • org.eclipse.edc.issuerservice.spi.issuance.process.store.IssuanceProcessStore

Referenced (injected) services

  • java.time.Clock (required)
  • org.eclipse.edc.spi.query.CriterionOperatorRegistry (required)

Module issuerservice-credential-definition-store-sql

Artifact: org.eclipse.edc:issuerservice-credential-definition-store-sql:1.0.0-RC7

Categories: None

Extension points

None

Extensions

Class: org.eclipse.edc.issuerservice.store.sql.credentialdefinition.SqlCredentialDefinitionStoreExtension

Name: “IssuerService Credential definition SQL Store Extension”

Overview: No overview provided.

Configuration

KeyRequiredTypeDefaultPatternMinMaxDescription
edc.sql.store.credentialdefinitions.datasource*stringdefaultThe datasource to be used

Provided services

  • org.eclipse.edc.issuerservice.spi.issuance.credentialdefinition.store.CredentialDefinitionStore

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.issuerservice.store.sql.credentialdefinition.CredentialDefinitionStoreStatements (optional)
  • org.eclipse.edc.sql.bootstrapper.SqlSchemaBootstrapper (required)
  • java.time.Clock (required)

Module issuerservice-credentials

Artifact: org.eclipse.edc:issuerservice-credentials:1.0.0-RC7

Categories: None

Extension points

None

Extensions

Class: org.eclipse.edc.issuerservice.credentials.CredentialDefaultServiceExtension

Name: “Issuer Service Credential Default Services”

Overview: No overview provided.

Configuration

KeyRequiredTypeDefaultPatternMinMaxDescription
edc.issuer.statuslist.bitstring.size*string131072The number of entries of a status list. A lower value than the minimum of the W3C Bitstring Status List, 131072, is raised to it
edc.issuer.statuslist.validity*string31536000How long a status list credential is valid after it was signed, in seconds
edc.issuer.statuslist.renewal.period*string86400How often status list credentials that are about to expire are renewed, in seconds. 0 or less deactivates the renewal
edc.issuer.statuslist.renewal.threshold*string2592000How long before it expires a status list credential is renewed, in seconds

Provided services

  • org.eclipse.edc.issuerservice.spi.credentials.statuslist.StatusListInfoFactoryRegistry
  • org.eclipse.edc.issuerservice.spi.credentials.statuslist.StatusListManager

Referenced (injected) services

  • org.eclipse.edc.issuerservice.spi.credentials.statuslist.StatusListCredentialPublisher (required)
  • org.eclipse.edc.transaction.spi.TransactionContext (required)
  • org.eclipse.edc.identityhub.spi.verifiablecredentials.store.CredentialStore (required)
  • org.eclipse.edc.issuerservice.spi.issuance.generator.CredentialGeneratorRegistry (required)
  • org.eclipse.edc.identityhub.spi.participantcontext.IdentityHubParticipantContextService (required)
  • java.time.Clock (required)
  • org.eclipse.edc.spi.system.ExecutorInstrumentation (required)
  • org.eclipse.edc.spi.monitor.Monitor (required)
  • org.eclipse.edc.identityhub.protocols.dcp.issuer.spi.DcpIssuerProfile (required)

Class: org.eclipse.edc.issuerservice.credentials.CredentialServiceExtension

Name: “Issuer Service Credential Service”

Overview: No overview provided.

Configuration_None_

Provided services

  • org.eclipse.edc.issuerservice.spi.credentials.CredentialStatusService
  • org.eclipse.edc.issuerservice.spi.credentials.IssuerCredentialOfferService

Referenced (injected) services

  • org.eclipse.edc.transaction.spi.TransactionContext (required)
  • org.eclipse.edc.identityhub.spi.verifiablecredentials.store.CredentialStore (required)
  • org.eclipse.edc.issuerservice.spi.holder.store.HolderStore (required)
  • org.eclipse.edc.iam.decentralizedclaims.spi.CredentialServiceUrlResolver (required)
  • org.eclipse.edc.identityhub.spi.authentication.ParticipantSecureTokenService (required)
  • org.eclipse.edc.identityhub.spi.participantcontext.IdentityHubParticipantContextService (required)
  • org.eclipse.edc.http.spi.EdcHttpClient (required)
  • org.eclipse.edc.transform.spi.TypeTransformerRegistry (required)
  • 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.issuerservice.spi.credentials.statuslist.StatusListCredentialPublisher (required)
  • org.eclipse.edc.jsonld.spi.JsonLd (required)
  • java.time.Clock (required)

Module issuerservice-database-attestations

Artifact: org.eclipse.edc:issuerservice-database-attestations:1.0.0-RC7

Categories: None

Extension points

None

Extensions

Class: org.eclipse.edc.issuerservice.issuance.DatabaseAttestationExtension

Name: “Database Attestations Extension”

Overview: No overview provided.

Configuration_None_

Provided services

None

Referenced (injected) services

  • org.eclipse.edc.issuerservice.spi.issuance.attestation.AttestationSourceFactoryRegistry (required)
  • org.eclipse.edc.issuerservice.spi.issuance.attestation.AttestationDefinitionValidatorRegistry (required)
  • 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.types.TypeManager (required)

Module issuerservice-holder-attestations

Artifact: org.eclipse.edc:issuerservice-holder-attestations:1.0.0-RC7

Categories: None

Extension points

None

Extensions

Class: org.eclipse.edc.issuerservice.issuance.attestation.holder.HolderAttestationExtension

Name: “Holder Attestation”

Overview: No overview provided.

Configuration_None_

Provided services

None

Referenced (injected) services

  • org.eclipse.edc.issuerservice.spi.issuance.attestation.AttestationSourceFactoryRegistry (required)
  • org.eclipse.edc.issuerservice.spi.issuance.attestation.AttestationDefinitionValidatorRegistry (required)

Module issuerservice-holder-store-sql

Artifact: org.eclipse.edc:issuerservice-holder-store-sql:1.0.0-RC7

Categories: None

Extension points

None

Extensions

Class: org.eclipse.edc.issuerservice.store.sql.holder.SqlHolderStoreExtension

Name: “IssuerService Holder SQL Store Extension”

Overview: No overview provided.

Configuration

KeyRequiredTypeDefaultPatternMinMaxDescription
edc.sql.store.holder.datasource*stringdefaultThe datasource to be used

Provided services

  • org.eclipse.edc.issuerservice.spi.holder.store.HolderStore

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.issuerservice.store.sql.holder.HolderStoreStatements (optional)
  • org.eclipse.edc.sql.bootstrapper.SqlSchemaBootstrapper (required)

Module issuerservice-holders

Artifact: org.eclipse.edc:issuerservice-holders:1.0.0-RC7

Categories: None

Extension points

None

Extensions

Class: org.eclipse.edc.issuerservice.holder.HolderServiceExtension

Name: “IssuerService Holder Service Extension”

Overview: No overview provided.

Configuration_None_

Provided services

  • org.eclipse.edc.issuerservice.spi.holder.HolderService

Referenced (injected) services

  • org.eclipse.edc.transaction.spi.TransactionContext (required)
  • org.eclipse.edc.issuerservice.spi.holder.store.HolderStore (required)

Module issuerservice-issuance

Artifact: org.eclipse.edc:issuerservice-issuance:1.0.0-RC7

Categories: None

Extension points

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”

Overview: No overview provided.

Configuration

KeyRequiredTypeDefaultPatternMinMaxDescription
edc.issuer.issuance.state-machine.iteration-wait-millis*string1000The iteration wait time in milliseconds in the state machine.
edc.issuer.issuance.state-machine.batch-size*string10The number of entities to be processed on every iteration. They are leased together, so the lease must outlast the processing of all of them.
edc.issuer.issuance.state-machine.lease-duration-millis*string300000How long the entities of a batch are leased, in milliseconds. It must be longer than the processing of a whole batch, i.e. longer than the batch size times the call timeout, otherwise another runtime may process the same entities.
edc.issuer.issuance.send.retry.limit*string80How many times a failed operation is retried before it fails with an error. With the default delays, the retries take about six hours.
edc.issuer.issuance.send.retry.base-delay.ms*string1000The base delay of retries in milliseconds. The n-th retry waits the base delay times 2 to the power of n, but at most the maximum delay.
edc.issuer.issuance.send.retry.max-delay.ms*string300000The maximum delay between two retries in milliseconds.
edc.issuer.issuance.send.connect-timeout.ms*string5000How long it may take to connect to the counterparty when a message is sent, in milliseconds.
edc.issuer.issuance.send.call-timeout.ms*string15000How long it may take to send a message and receive the response, in milliseconds. A message that times out is not retried right away, but by the state machine, like any other failure.

Provided services

  • org.eclipse.edc.issuerservice.spi.issuance.process.IssuanceProcessManager
  • org.eclipse.edc.issuerservice.spi.issuance.process.IssuanceProcessService

Referenced (injected) services

  • org.eclipse.edc.issuerservice.spi.issuance.process.store.IssuanceProcessStore (required)
  • 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)
  • org.eclipse.edc.issuerservice.spi.issuance.process.retry.IssuanceProcessRetryStrategy (optional)
  • org.eclipse.edc.issuerservice.spi.issuance.delivery.CredentialStorageClient (required)
  • java.time.Clock (required)
  • org.eclipse.edc.transaction.spi.TransactionContext (required)
  • org.eclipse.edc.issuerservice.spi.credentials.CredentialStatusService (required)
  • org.eclipse.edc.issuerservice.spi.issuance.events.IssuanceObservable (required)

Module issuerservice-issuance-rules

Artifact: org.eclipse.edc:issuerservice-issuance-rules:1.0.0-RC7

Categories: None

Extension points

None

Extensions

Class: org.eclipse.edc.issuerservice.issuance.rules.IssuanceRulesExtension

Name: “Issuance Rules Extension”

Overview: No overview provided.

Configuration_None_

Provided services

None

Referenced (injected) services

  • org.eclipse.edc.issuerservice.spi.issuance.rule.CredentialRuleFactoryRegistry (required)
  • org.eclipse.edc.issuerservice.spi.issuance.rule.CredentialRuleDefinitionValidatorRegistry (required)

Module keypair-api

Artifact: org.eclipse.edc:keypair-api:1.0.0-RC7

Categories: None

Extension points

None

Extensions

Class: org.eclipse.edc.identityhub.api.keypair.KeyPairResourceManagementApiExtension

Name: “KeyPairResource management Identity API Extension”

Overview: No overview provided.

Configuration_None_

Provided services

None

Referenced (injected) services

  • org.eclipse.edc.web.spi.WebService (required)
  • org.eclipse.edc.identityhub.spi.keypair.KeyPairService (required)
  • org.eclipse.edc.api.auth.spi.AuthorizationService (required)
  • org.eclipse.edc.spi.monitor.Monitor (required)

Module local-did-publisher

Artifact: org.eclipse.edc:local-did-publisher:1.0.0-RC7

Categories: None

Extension points

None

Extensions

Class: org.eclipse.edc.identityhub.publisher.did.local.LocalDidPublisherExtension

Name: “Local DID publisher extension”

Overview: No overview provided.

Configuration

KeyRequiredTypeDefaultPatternMinMaxDescription
web.http.did.port*string10100Port for did api context
web.http.did.path*string/Path for did api context

Provided services

  • org.eclipse.edc.identityhub.spi.did.events.DidDocumentObservable

Referenced (injected) services

  • org.eclipse.edc.identityhub.spi.did.DidDocumentPublisherRegistry (required)
  • org.eclipse.edc.identityhub.spi.did.store.DidResourceStore (required)
  • org.eclipse.edc.web.spi.WebService (required)
  • org.eclipse.edc.web.spi.configuration.PortMappingRegistry (required)
  • org.eclipse.edc.identityhub.spi.did.DidWebParser (optional)
  • java.time.Clock (required)
  • org.eclipse.edc.spi.event.EventRouter (required)

Module local-statuslist-publisher

Artifact: org.eclipse.edc:local-statuslist-publisher:1.0.0-RC7

Categories: None

Extension points

None

Extensions

Class: org.eclipse.edc.issuerservice.publisher.LocalStatusListCredentialPublisherExtension

Name: “IssuerService Default Services Extension”

Overview: No overview provided.

Configuration

KeyRequiredTypeDefaultPatternMinMaxDescription
web.http.statuslist.port*string9999Port of the status list credential web endpoint
web.http.statuslist.path*string/statuslistPort of the status list credential web endpoint
edc.statuslist.callback.addressstring``Configures endpoint for reaching the StatusList API.

Provided services

  • org.eclipse.edc.issuerservice.spi.credentials.statuslist.StatusListCredentialPublisher

Referenced (injected) services

  • org.eclipse.edc.identityhub.spi.verifiablecredentials.store.CredentialStore (required)
  • org.eclipse.edc.web.spi.configuration.PortMappingRegistry (required)
  • org.eclipse.edc.spi.system.Hostname (required)
  • org.eclipse.edc.web.spi.WebService (required)
  • org.eclipse.edc.spi.monitor.Monitor (required)
  • org.eclipse.edc.spi.types.TypeManager (required)

Module participant-context-api

Artifact: org.eclipse.edc:participant-context-api:1.0.0-RC7

Categories: None

Extension points

None

Extensions

Class: org.eclipse.edc.identityhub.api.verifiablecredential.ParticipantContextManagementApiExtension

Name: “ParticipantContext management Identity API Extension”

Overview: No overview provided.

Configuration_None_

Provided services

None

Referenced (injected) services

  • org.eclipse.edc.web.spi.WebService (required)
  • org.eclipse.edc.identityhub.spi.participantcontext.IdentityHubParticipantContextService (required)
  • org.eclipse.edc.api.auth.spi.AuthorizationService (required)
  • org.eclipse.edc.spi.monitor.Monitor (required)

Module presentation-api

Artifact: org.eclipse.edc:presentation-api:1.0.0-RC7

Categories: None

Extension points

None

Extensions

Class: org.eclipse.edc.identityhub.api.PresentationApiExtension

Name: “Presentation API Extension”

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.web.spi.WebService (required)
  • org.eclipse.edc.identityhub.spi.verification.SelfIssuedTokenVerifier (required)
  • org.eclipse.edc.identityhub.spi.verifiablecredentials.resolution.CredentialQueryResolver (required)
  • org.eclipse.edc.identityhub.spi.verifiablecredentials.generator.VerifiablePresentationService (required)
  • org.eclipse.edc.jsonld.spi.JsonLd (required)
  • org.eclipse.edc.spi.types.TypeManager (required)

Module storage-api

Artifact: org.eclipse.edc:storage-api:1.0.0-RC7

Categories: None

Extension points

None

Extensions

Class: org.eclipse.edc.identityhub.api.StorageApiExtension

Name: “Storage API Extension”

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.web.spi.WebService (required)
  • org.eclipse.edc.jsonld.spi.JsonLd (required)
  • org.eclipse.edc.spi.types.TypeManager (required)
  • org.eclipse.edc.identityhub.spi.verifiablecredentials.generator.CredentialWriter (required)
  • org.eclipse.edc.identityhub.protocols.dcp.spi.DcpIssuerTokenVerifier (required)
  • org.eclipse.edc.spi.monitor.Monitor (required)
  • org.eclipse.edc.identityhub.spi.participantcontext.IdentityHubParticipantContextService (required)

Module sts-account-provisioner

Artifact: org.eclipse.edc:sts-account-provisioner:1.0.0-RC7

Categories: None

Extension points

None

Extensions

Class: org.eclipse.edc.identityhub.common.provisioner.StsAccountProvisionerExtension

Name: “STS Account Provisioner Extension”

Overview: No overview provided.

Configuration_None_

Provided services

  • org.eclipse.edc.identityhub.spi.participantcontext.StsAccountProvisioner

Referenced (injected) services

  • org.eclipse.edc.spi.event.EventRouter (required)
  • org.eclipse.edc.spi.security.Vault (required)
  • org.eclipse.edc.iam.decentralizedclaims.sts.spi.service.StsClientSecretGenerator (optional)
  • org.eclipse.edc.iam.decentralizedclaims.sts.spi.service.StsAccountService (required)
  • org.eclipse.edc.spi.telemetry.Telemetry (required)

Module sts-account-service-local

Artifact: org.eclipse.edc:sts-account-service-local:1.0.0-RC7

Categories: None

Extension points

None

Extensions

Class: org.eclipse.edc.identityhub.sts.accountservice.StsAccountServiceExtension

Name: “Local (embedded) STS Account Service Extension”

Overview: No overview provided.

Configuration_None_

Provided services

  • org.eclipse.edc.iam.decentralizedclaims.sts.spi.service.StsAccountService

Referenced (injected) services

  • org.eclipse.edc.iam.decentralizedclaims.sts.spi.store.StsAccountStore (required)
  • org.eclipse.edc.transaction.spi.TransactionContext (required)
  • org.eclipse.edc.spi.security.Vault (required)
  • org.eclipse.edc.iam.decentralizedclaims.sts.spi.service.StsClientSecretGenerator (optional)

Module sts-api

Artifact: org.eclipse.edc:sts-api:1.0.0-RC7

Categories: None

Extension points

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”

Overview: No overview provided.

Configuration

KeyRequiredTypeDefaultPatternMinMaxDescription
web.http.sts.port*string9292Port for sts api context
web.http.sts.path*string/api/stsPath for sts api context
web.http.sts.hoststring``Host name or IP address of the network interface the sts api context listens on. Listens on all interfaces if not set.

Provided services

None

Referenced (injected) services

  • org.eclipse.edc.web.spi.configuration.PortMappingRegistry (required)
  • org.eclipse.edc.spi.types.TypeManager (required)
  • org.eclipse.edc.spi.system.apiversion.ApiVersionService (required)
  • org.eclipse.edc.web.jetty.JettyService (optional)

Module sts-client-store-sql

Artifact: org.eclipse.edc:sts-client-store-sql:1.0.0-RC7

Categories: None

Extension points

None

Extensions

Class: org.eclipse.edc.iam.decentralizedclaims.sts.store.SqlStsClientStoreExtension

Name: “SQL sts accounts store”

Overview: No overview provided.

Configuration

KeyRequiredTypeDefaultPatternMinMaxDescription
edc.sql.store.stsclient.datasource*stringdefaultThe datasource to be used

Provided services

  • org.eclipse.edc.iam.decentralizedclaims.sts.spi.store.StsAccountStore

Referenced (injected) services

  • org.eclipse.edc.transaction.datasource.spi.DataSourceRegistry (required)
  • org.eclipse.edc.transaction.spi.TransactionContext (required)
  • org.eclipse.edc.iam.decentralizedclaims.sts.store.schema.StsClientStatements (optional)
  • org.eclipse.edc.sql.QueryExecutor (required)
  • org.eclipse.edc.spi.types.TypeManager (required)
  • org.eclipse.edc.sql.bootstrapper.SqlSchemaBootstrapper (required)

Module sts-core

Artifact: org.eclipse.edc:sts-core:1.0.0-RC7

Categories: None

Extension points

None

Extensions

Class: org.eclipse.edc.iam.decentralizedclaims.sts.defaults.StsDefaultServicesExtension

Name: “Secure Token Service Default Services”

Overview: No overview provided.

Configuration_None_

Provided services

  • org.eclipse.edc.iam.decentralizedclaims.sts.spi.store.StsAccountStore

Referenced (injected) services

  • org.eclipse.edc.spi.query.CriterionOperatorRegistry (required)

Class: org.eclipse.edc.iam.decentralizedclaims.sts.EmbeddedStsServiceExtension

Name: “Local (embedded) STS Account Service Extension”

Overview: No overview provided.

Configuration

KeyRequiredTypeDefaultPatternMinMaxDescription
edc.iam.sts.token.expiration*string5Self-issued ID Token expiration in minutes. By default is 5 minutes

Provided services

  • org.eclipse.edc.identityhub.spi.authentication.ParticipantSecureTokenService

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.identityhub.spi.keypair.KeyPairService (required)
  • org.eclipse.edc.identityhub.spi.participantcontext.IdentityHubParticipantContextService (required)

Class: org.eclipse.edc.iam.decentralizedclaims.sts.StsClientTokenGeneratorExtension

Name: “STS Client Token Generator Extension”

Overview: No overview provided.

Configuration

KeyRequiredTypeDefaultPatternMinMaxDescription
edc.iam.sts.token.expiration*string5Self-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:1.0.0-RC7

Categories: None

Extension points

None

Extensions

Class: org.eclipse.edc.test.e2e.tck.attestation.TckTestAttestationsExtension

Name: “TCK Test Attestations Extension”

Overview: No overview provided.

Configuration_None_

Provided services

None

Referenced (injected) services

  • org.eclipse.edc.issuerservice.spi.issuance.attestation.AttestationSourceFactoryRegistry (required)
  • org.eclipse.edc.issuerservice.spi.issuance.attestation.AttestationDefinitionValidatorRegistry (required)

Module verifiable-credentials-api

Artifact: org.eclipse.edc:verifiable-credentials-api:1.0.0-RC7

Categories: None

Extension points

None

Extensions

Class: org.eclipse.edc.identityhub.api.verifiablecredentials.VerifiableCredentialApiExtension

Name: “VerifiableCredentials API Extension”

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.identityhub.spi.verifiablecredentials.store.CredentialStore (required)
  • org.eclipse.edc.api.auth.spi.AuthorizationService (required)
  • org.eclipse.edc.identityhub.spi.verifiablecredentials.CredentialRequestManager (required)
  • org.eclipse.edc.identityhub.spi.transformation.DiscriminatorMappingRegistry (required)