# openepcis/epcis-repository-ce architecture

> Architecture diagram of the GitHub repository openepcis/epcis-repository-ce, generated by GitDiagram from its file tree, README and a sample of source files (last updated 2026-11-22). It is an AI-made overview: check details against the source.

- Interactive diagram: https://gitdiagram.com/openepcis/epcis-repository-ce
- Repository: https://github.com/openepcis/epcis-repository-ce

## Overview

OpenEPCIS is a modular EPCIS 2.0 repository. A caller submits JSON-LD events through the REST capture API; the documented Kafka capture pipeline processes captured events, which are indexed for OpenSearch-backed querying through the events and query APIs. The common API module also describes capture jobs and vocabulary/top-level resources; the repository includes a REST/WebSocket client and a synthetic-event generator. Several implementation modules are unsampled, so those subsystem links are based on README statements rather than inspected call sites.

Main entry points: [`modules/quarkus-rest-application-ce`](https://github.com/openepcis/epcis-repository-ce/tree/main/modules/quarkus-rest-application-ce) (REST application), [`modules/quarkus-capture-topology-ce/src/main/java/io/openepcis/capture/kafka/CaptureContextTopology.java`](https://github.com/openepcis/epcis-repository-ce/blob/main/modules/quarkus-capture-topology-ce/src/main/java/io/openepcis/capture/kafka/CaptureContextTopology.java) (Capture topology), [`modules/openepcis-rest-api-common/src/main/java/io/openepcis/rest/api/common/CaptureApi.java`](https://github.com/openepcis/epcis-repository-ce/blob/main/modules/openepcis-rest-api-common/src/main/java/io/openepcis/rest/api/common/CaptureApi.java) (Capture endpoint), [`modules/openepcis-client/runtime/src/main/java/io/openepcis/client/rest/LowLevelEPCISClient.java`](https://github.com/openepcis/epcis-repository-ce/blob/main/modules/openepcis-client/runtime/src/main/java/io/openepcis/client/rest/LowLevelEPCISClient.java) (REST client)

## Diagram (Mermaid)

```mermaid
flowchart TD

subgraph group_api["REST API"]
  node_rest["REST application"]
  node_capture_api["Capture endpoint<br/>[CaptureApi.java]"]
  node_capture_jobs["Capture jobs<br/>[CaptureJobApi.java]"]
  node_events_capture["Events capture"]
  node_events_api["Events API<br/>[EventsApi.java]"]
  node_query_api["Query API<br/>[QueryApi.java]"]
  node_vocabulary["Vocabulary APIs"]
  node_extensions["Extension schemas"]
end

subgraph group_capture["Capture Pipeline"]
  node_topology["Capture topology"]
  node_kafka["Kafka streams"]
end

subgraph group_query["Query and Clients"]
  node_search[("OpenSearch")]
  node_client_rest["REST client"]
  node_client_reactive["Reactive client"]
  node_client_ws["WebSocket client"]
end

subgraph group_tools["Supporting Tools"]
  node_generator["Event generator"]
end

node_caller(("API caller"))

node_caller -->|"sends requests"| node_rest
node_rest -.->|"serves capture"| node_capture_api
node_rest -.->|"serves events"| node_events_api
node_rest -.->|"serves queries"| node_query_api
node_capture_api -.->|"enters pipeline"| node_topology
node_events_capture -.->|"captures events"| node_topology
node_topology -->|"uses streams"| node_kafka
node_topology -.->|"indexes events"| node_search
node_events_api -.->|"queries events"| node_search
node_query_api -.->|"queries events"| node_search
node_client_rest -->|"submits events"| node_capture_api
node_client_rest -->|"requests events"| node_events_api
node_client_reactive -->|"delegates to"| node_client_rest
node_client_ws -->|"subscribes"| node_query_api
node_generator -.->|"sends events"| node_capture_api
node_caller -.->|"registers schemas"| node_extensions
node_rest -.->|"serves jobs"| node_capture_jobs
node_rest -.->|"serves capture"| node_events_capture
node_rest -.->|"serves resources"| node_vocabulary

click node_rest "https://github.com/openepcis/epcis-repository-ce/tree/main/modules/quarkus-rest-application-ce"
click node_capture_api "https://github.com/openepcis/epcis-repository-ce/blob/main/modules/openepcis-rest-api-common/src/main/java/io/openepcis/rest/api/common/CaptureApi.java"
click node_capture_jobs "https://github.com/openepcis/epcis-repository-ce/blob/main/modules/openepcis-rest-api-common/src/main/java/io/openepcis/rest/api/common/CaptureJobApi.java"
click node_events_capture "https://github.com/openepcis/epcis-repository-ce/blob/main/modules/openepcis-rest-api-common/src/main/java/io/openepcis/rest/api/common/EventsCaptureApi.java"
click node_events_api "https://github.com/openepcis/epcis-repository-ce/blob/main/modules/openepcis-rest-api-common/src/main/java/io/openepcis/rest/api/common/EventsApi.java"
click node_query_api "https://github.com/openepcis/epcis-repository-ce/blob/main/modules/openepcis-rest-api-common/src/main/java/io/openepcis/rest/api/common/QueryApi.java"
click node_vocabulary "https://github.com/openepcis/epcis-repository-ce/tree/main/modules/openepcis-rest-api-common"
click node_topology "https://github.com/openepcis/epcis-repository-ce/blob/main/modules/quarkus-capture-topology-ce/src/main/java/io/openepcis/capture/kafka/CaptureContextTopology.java"
click node_client_rest "https://github.com/openepcis/epcis-repository-ce/blob/main/modules/openepcis-client/runtime/src/main/java/io/openepcis/client/rest/LowLevelEPCISClient.java"
click node_client_reactive "https://github.com/openepcis/epcis-repository-ce/blob/main/modules/openepcis-client/runtime/src/main/java/io/openepcis/client/rest/ReactiveEPCISClient.java"
click node_client_ws "https://github.com/openepcis/epcis-repository-ce/blob/main/modules/openepcis-client/runtime/src/main/java/io/openepcis/client/websocket/WebSocketClient.java"
click node_generator "https://github.com/openepcis/epcis-repository-ce/blob/main/modules/openepcis-generated-events-capture/src/main/java/io/openepcis/generated/capture/CaptureGenerated.java"
click node_extensions "https://github.com/openepcis/epcis-repository-ce/tree/main/modules/openepcis-rest-api-common"

classDef toneNeutral fill:#f8fafc,stroke:#334155,stroke-width:1.5px,color:#0f172a
classDef toneBlue fill:#dbeafe,stroke:#2563eb,stroke-width:1.5px,color:#172554
classDef toneAmber fill:#fef3c7,stroke:#d97706,stroke-width:1.5px,color:#78350f
classDef toneMint fill:#dcfce7,stroke:#16a34a,stroke-width:1.5px,color:#14532d
classDef toneRose fill:#ffe4e6,stroke:#e11d48,stroke-width:1.5px,color:#881337
classDef toneIndigo fill:#e0e7ff,stroke:#4f46e5,stroke-width:1.5px,color:#312e81
classDef toneTeal fill:#ccfbf1,stroke:#0f766e,stroke-width:1.5px,color:#134e4a
class node_rest,node_capture_api,node_capture_jobs,node_events_capture,node_events_api,node_query_api,node_vocabulary,node_extensions toneBlue
class node_topology,node_kafka toneAmber
class node_search,node_client_rest,node_client_reactive,node_client_ws,node_caller toneMint
class node_generator toneRose
```

## Components

### REST API

- [REST application](https://github.com/openepcis/epcis-repository-ce/tree/main/modules/quarkus-rest-application-ce): `modules/quarkus-rest-application-ce`
- [Capture endpoint](https://github.com/openepcis/epcis-repository-ce/blob/main/modules/openepcis-rest-api-common/src/main/java/io/openepcis/rest/api/common/CaptureApi.java): `modules/openepcis-rest-api-common/src/main/java/io/openepcis/rest/api/common/CaptureApi.java`
- [Capture jobs](https://github.com/openepcis/epcis-repository-ce/blob/main/modules/openepcis-rest-api-common/src/main/java/io/openepcis/rest/api/common/CaptureJobApi.java): `modules/openepcis-rest-api-common/src/main/java/io/openepcis/rest/api/common/CaptureJobApi.java`
- [Events capture](https://github.com/openepcis/epcis-repository-ce/blob/main/modules/openepcis-rest-api-common/src/main/java/io/openepcis/rest/api/common/EventsCaptureApi.java): `modules/openepcis-rest-api-common/src/main/java/io/openepcis/rest/api/common/EventsCaptureApi.java`
- [Events API](https://github.com/openepcis/epcis-repository-ce/blob/main/modules/openepcis-rest-api-common/src/main/java/io/openepcis/rest/api/common/EventsApi.java): `modules/openepcis-rest-api-common/src/main/java/io/openepcis/rest/api/common/EventsApi.java`
- [Query API](https://github.com/openepcis/epcis-repository-ce/blob/main/modules/openepcis-rest-api-common/src/main/java/io/openepcis/rest/api/common/QueryApi.java): `modules/openepcis-rest-api-common/src/main/java/io/openepcis/rest/api/common/QueryApi.java`
- [Vocabulary APIs](https://github.com/openepcis/epcis-repository-ce/tree/main/modules/openepcis-rest-api-common): `modules/openepcis-rest-api-common`
- [Extension schemas](https://github.com/openepcis/epcis-repository-ce/tree/main/modules/openepcis-rest-api-common): `modules/openepcis-rest-api-common`

### Capture Pipeline

- [Capture topology](https://github.com/openepcis/epcis-repository-ce/blob/main/modules/quarkus-capture-topology-ce/src/main/java/io/openepcis/capture/kafka/CaptureContextTopology.java): `modules/quarkus-capture-topology-ce/src/main/java/io/openepcis/capture/kafka/CaptureContextTopology.java`
- **Kafka streams**

### Query and Clients

- **OpenSearch**
- [REST client](https://github.com/openepcis/epcis-repository-ce/blob/main/modules/openepcis-client/runtime/src/main/java/io/openepcis/client/rest/LowLevelEPCISClient.java): `modules/openepcis-client/runtime/src/main/java/io/openepcis/client/rest/LowLevelEPCISClient.java`
- [Reactive client](https://github.com/openepcis/epcis-repository-ce/blob/main/modules/openepcis-client/runtime/src/main/java/io/openepcis/client/rest/ReactiveEPCISClient.java): `modules/openepcis-client/runtime/src/main/java/io/openepcis/client/rest/ReactiveEPCISClient.java`
- [WebSocket client](https://github.com/openepcis/epcis-repository-ce/blob/main/modules/openepcis-client/runtime/src/main/java/io/openepcis/client/websocket/WebSocketClient.java): `modules/openepcis-client/runtime/src/main/java/io/openepcis/client/websocket/WebSocketClient.java`

### Supporting Tools

- [Event generator](https://github.com/openepcis/epcis-repository-ce/blob/main/modules/openepcis-generated-events-capture/src/main/java/io/openepcis/generated/capture/CaptureGenerated.java): `modules/openepcis-generated-events-capture/src/main/java/io/openepcis/generated/capture/CaptureGenerated.java`

### Other components

- **API caller**

## Connections

- API caller → REST application: sends requests (evidence: `README.md`)
- REST application → Capture endpoint: serves capture
- REST application → Events API: serves events
- REST application → Query API: serves queries
- Capture endpoint → Capture topology: enters pipeline (evidence: `README.md`)
- Events capture → Capture topology: captures events (evidence: `README.md`)
- Capture topology → Kafka streams: uses streams (evidence: `README.md`)
- Capture topology → OpenSearch: indexes events (evidence: `README.md`)
- Events API → OpenSearch: queries events (evidence: `README.md`)
- Query API → OpenSearch: queries events (evidence: `README.md`)
- REST client → Capture endpoint: submits events (evidence: `modules/openepcis-client/runtime/src/main/java/io/openepcis/client/rest/LowLevelEPCISClient.java`)
- REST client → Events API: requests events (evidence: `modules/openepcis-client/runtime/src/main/java/io/openepcis/client/rest/LowLevelEPCISClient.java`)
- Reactive client → REST client: delegates to (evidence: `modules/openepcis-client/runtime/src/main/java/io/openepcis/client/rest/ReactiveEPCISClient.java`)
- WebSocket client → Query API: subscribes (evidence: `modules/openepcis-client/runtime/src/main/java/io/openepcis/client/websocket/WebSocketClient.java`)
- Event generator → Capture endpoint: sends events (evidence: `README.md`)
- API caller → Extension schemas: registers schemas (evidence: `README.md`)
- REST application → Capture jobs: serves jobs
- REST application → Events capture: serves capture
- REST application → Vocabulary APIs: serves resources
