Module api

Source
Expand description

Traceability API definitions.

This module defines the core API types for the trace2e traceability system, which provides comprehensive data lineage tracking and compliance enforcement across distributed systems.

The API is organized into three main communication patterns:

§Process-to-Middleware (P2M) API

Enables processes to register resources (files, network streams) and request I/O operations with traceability guarantees. Processes must first enroll their resources before performing tracked I/O operations.

§Middleware-to-Middleware (M2M) API

Facilitates communication between distributed middleware instances for cross-node compliance checking, flow coordination, and provenance synchronization.

§Operator-to-Middleware (O2M) API

Provides administrative interfaces for policy management, compliance configuration, and provenance querying by external operators and organizations.

§Internal Service APIs

Defines request/response types for internal services:

  • Sequencer: Resource management and flow control
  • Provenance: Data lineage tracking and ancestry management
  • Compliance: Policy enforcement and authorization decisions

Enums§

ComplianceRequest
Compliance service request types.
ComplianceResponse
Compliance service response types.
ConsentRequest
ConsentResponse
M2mRequest
Middleware-to-Middleware (M2M) request types.
M2mResponse
Middleware-to-Middleware (M2M) response types.
O2mRequest
Operator-to-Middleware (O2M) request types.
O2mResponse
Operator-to-Middleware (O2M) response types.
P2mRequest
Process-to-Middleware (P2M) request types.
P2mResponse
Process-to-Middleware (P2M) response types.
ProvenanceRequest
Provenance service request types.
ProvenanceResponse
Provenance service response types.
SequencerRequest
Sequencer service request types.
SequencerResponse
Sequencer service response types.