Federated-Catalog

EDC Autodoc Manifest

Module org.eclipse.edc:connector-runtime:0.9.1

Categories: None

Extension points

None

Extensions

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

Name: “DataplaneInstanceRegistrationExtension”

Configuration: None
Provided services:
  • org.eclipse.edc.connector.dataplane.selector.spi.client.DataPlaneClientFactory
Referenced (injected) services:
  • org.eclipse.edc.connector.dataplane.selector.spi.store.DataPlaneInstanceStore (required)

Module Crawler services:0.9.1

org.eclipse.edc:crawler-spi

Categories: None

Extension points

  • org.eclipse.edc.crawler.spi.TargetNodeFilter
  • org.eclipse.edc.crawler.spi.TargetNodeDirectory

Extensions

Module org.eclipse.edc:federated-catalog-api:0.9.1

Categories: None

Extension points

None

Extensions

Class: org.eclipse.edc.catalog.api.query.FederatedCatalogApiExtension

Name: “Cache Query API Extension”

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.spi.system.health.HealthCheckService (optional)
  • org.eclipse.edc.jsonld.spi.JsonLd (required)
  • org.eclipse.edc.spi.types.TypeManager (required)
  • org.eclipse.edc.transform.spi.TypeTransformerRegistry (required)
  • org.eclipse.edc.spi.system.apiversion.ApiVersionService (required)

Module org.eclipse.edc:federated-catalog-cache-sql:0.9.1

Categories: None

Extension points

None

Extensions

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

Name: “SQL federated catalog cache”

Overview: No overview provided.

Configuration:
KeyRequiredTypeDefaultPatternMinMaxDescription
edc.datasource.federatedcatalog.namestring``
edc.sql.store.federatedcatalog.datasourcestringdefaultThe 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.store.sql.FederatedCatalogCacheStatements (optional)
  • org.eclipse.edc.spi.types.TypeManager (required)
  • org.eclipse.edc.sql.QueryExecutor (required)
  • org.eclipse.edc.sql.bootstrapper.SqlSchemaBootstrapper (required)

Module org.eclipse.edc:federated-catalog-core:0.9.1

Categories: None

Extension points

None

Extensions

Class: org.eclipse.edc.catalog.cache.FederatedCatalogDefaultServicesExtension

Name: “FederatedCatalogDefaultServicesExtension”

Overview: No overview provided.

Configuration:
KeyRequiredTypeDefaultPatternMinMaxDescription
edc.catalog.cache.execution.period.secondsstring``The time to elapse between two crawl runs
edc.catalog.cache.partition.num.crawlersstring``The number of crawlers (execution threads) that should be used. The engine will re-use crawlers when necessary.
edc.catalog.cache.execution.delay.secondsstring``The initial delay for the cache crawler engine
Provided services:
  • org.eclipse.edc.catalog.spi.FederatedCatalogCache
  • org.eclipse.edc.crawler.spi.TargetNodeDirectory
  • org.eclipse.edc.catalog.spi.QueryService
  • org.eclipse.edc.crawler.spi.model.ExecutionPlan
Referenced (injected) services:
  • org.eclipse.edc.catalog.spi.FederatedCatalogCache (required)

Class: org.eclipse.edc.catalog.cache.FederatedCatalogCacheExtension

Name: “Federated Catalog Cache”

Overview: No overview provided.

Configuration:
KeyRequiredTypeDefaultPatternMinMaxDescription
edc.catalog.cache.execution.enabledstring``
Provided services:
  • org.eclipse.edc.crawler.spi.CrawlerActionRegistry
Referenced (injected) services:
  • org.eclipse.edc.catalog.spi.FederatedCatalogCache (required)
  • org.eclipse.edc.spi.system.health.HealthCheckService (optional)
  • org.eclipse.edc.spi.message.RemoteMessageDispatcherRegistry (required)
  • org.eclipse.edc.crawler.spi.TargetNodeDirectory (required)
  • org.eclipse.edc.crawler.spi.TargetNodeFilter (optional)
  • org.eclipse.edc.crawler.spi.model.ExecutionPlan (optional)
  • org.eclipse.edc.spi.types.TypeManager (required)
  • org.eclipse.edc.transform.spi.TypeTransformerRegistry (required)
  • org.eclipse.edc.jsonld.spi.JsonLd (required)
  • org.eclipse.edc.spi.monitor.Monitor (required)
  • org.eclipse.edc.transform.spi.TypeTransformerRegistry (required)

Module Catalog services:0.9.1

org.eclipse.edc:federated-catalog-spi

Categories: None

Extension points

  • org.eclipse.edc.catalog.spi.FederatedCatalogCache

Extensions

Module org.eclipse.edc:target-node-directory-sql:0.9.1

Categories: None

Extension points

None

Extensions

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

Name: “SQL target node directory”

Overview: No overview provided.

Configuration:
KeyRequiredTypeDefaultPatternMinMaxDescription
edc.sql.store.targetnodedirectory.datasourcestringdefaultThe 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.store.sql.TargetNodeStatements (optional)
  • org.eclipse.edc.spi.types.TypeManager (required)
  • org.eclipse.edc.sql.QueryExecutor (required)
  • org.eclipse.edc.sql.bootstrapper.SqlSchemaBootstrapper (required)

Last modified September 26, 2024: docs: update autodoc (#9) (ecf0b4d)