# cafanasyev/java-sapient-sdk architecture

> Architecture diagram of the GitHub repository cafanasyev/java-sapient-sdk, generated by GitDiagram from its file tree, README and a sample of source files (last updated 2026-10-03). It is an AI-made overview: check details against the source.

- Interactive diagram: https://gitdiagram.com/cafanasyev/java-sapient-sdk
- Repository: https://github.com/cafanasyev/java-sapient-sdk

## Overview

The Java SAPIENT SDK connects an application’s node implementations to a fusion node over TCP. Its main workflow is node registration, acknowledgement handling, periodic status reporting, and routing inbound tasks/acks; callers can also publish typed reports and alerts. NodeWrapper owns each node’s lifecycle, while NodeDispatcher coordinates wrappers and the transport client. The README documents TLS configuration and optional connection-state monitoring. Some implementation details are unsampled, so uncertain links are omitted or marked unverified.

Main entry points: [`src/main/java/io/sapient/transmission/NodeDispatcher.java`](https://github.com/cafanasyev/java-sapient-sdk/blob/master/src/main/java/io/sapient/transmission/NodeDispatcher.java) (Node Dispatcher), [`src/main/java/io/sapient/transport/SocketClient.java`](https://github.com/cafanasyev/java-sapient-sdk/blob/master/src/main/java/io/sapient/transport/SocketClient.java) (Socket Client), [`src/main/java/io/sapient/transmission/NodeWrapper.java`](https://github.com/cafanasyev/java-sapient-sdk/blob/master/src/main/java/io/sapient/transmission/NodeWrapper.java) (Node Wrapper), [`src/main/java/io/sapient/transmission/INode.java`](https://github.com/cafanasyev/java-sapient-sdk/blob/master/src/main/java/io/sapient/transmission/INode.java) (Node Implementation)

## Diagram (Mermaid)

```mermaid
flowchart TD

subgraph group_node_api["Node API"]
  node_node_impl["Node Implementation<br/>[INode.java]"]
  node_dispatcher_api["Dispatcher API"]
end

subgraph group_lifecycle["Node Lifecycle"]
  node_dispatcher["Node Dispatcher"]
  node_node_wrapper["Node Wrapper<br/>[NodeWrapper.java]"]
  node_dispatcher_config["Dispatcher Config"]
  node_jitter["Lifecycle Jitter<br/>[Jitter.java]"]
end

subgraph group_transport["TCP Transport"]
  node_client_api["Client API<br/>[IClient.java]"]
  node_socket_client["Socket Client<br/>[SocketClient.java]"]
  node_socket_provider["Socket Provider"]
  node_connection_state["Connection State"]
  node_thread_safe["Thread Safety Marker<br/>[ThreadSafe.java]"]
end

subgraph group_security["TLS Support"]
  node_tls_factory["SSL Context Factory"]
end

node_application(("SDK Integrator"))
node_fusion_node(("Fusion Node"))

node_application -->|"implements"| node_node_impl
node_application -->|"configures"| node_dispatcher
node_application -->|"implements"| node_socket_provider
node_dispatcher_api -->|"manages"| node_node_impl
node_dispatcher -->|"creates"| node_node_wrapper
node_dispatcher -->|"uses"| node_dispatcher_config
node_dispatcher -->|"publishes through"| node_client_api
node_dispatcher -->|"routes callbacks"| node_node_impl
node_node_wrapper -->|"polls and reports"| node_node_impl
node_node_wrapper -->|"publishes reports"| node_dispatcher
node_node_wrapper -->|"uses timing"| node_jitter
node_dispatcher_config -->|"sets window"| node_jitter
node_client_api -->|"exposes"| node_connection_state
node_socket_client -->|"implements"| node_client_api
node_socket_client -->|"opens sockets via"| node_socket_provider
node_socket_client -->|"reports"| node_connection_state
node_socket_client -->|"uses annotation"| node_thread_safe
node_socket_client -->|"exchanges messages"| node_fusion_node
node_tls_factory -.->|"can supply TLS"| node_socket_provider

click node_node_impl "https://github.com/cafanasyev/java-sapient-sdk/blob/master/src/main/java/io/sapient/transmission/INode.java"
click node_dispatcher_api "https://github.com/cafanasyev/java-sapient-sdk/blob/master/src/main/java/io/sapient/transmission/INodeDispatcher.java"
click node_dispatcher "https://github.com/cafanasyev/java-sapient-sdk/blob/master/src/main/java/io/sapient/transmission/NodeDispatcher.java"
click node_node_wrapper "https://github.com/cafanasyev/java-sapient-sdk/blob/master/src/main/java/io/sapient/transmission/NodeWrapper.java"
click node_dispatcher_config "https://github.com/cafanasyev/java-sapient-sdk/blob/master/src/main/java/io/sapient/transmission/NodeDispatcherConfig.java"
click node_jitter "https://github.com/cafanasyev/java-sapient-sdk/blob/master/src/main/java/io/sapient/transmission/Jitter.java"
click node_client_api "https://github.com/cafanasyev/java-sapient-sdk/blob/master/src/main/java/io/sapient/transport/IClient.java"
click node_socket_client "https://github.com/cafanasyev/java-sapient-sdk/blob/master/src/main/java/io/sapient/transport/SocketClient.java"
click node_socket_provider "https://github.com/cafanasyev/java-sapient-sdk/blob/master/src/main/java/io/sapient/transport/ISocketProvider.java"
click node_connection_state "https://github.com/cafanasyev/java-sapient-sdk/blob/master/src/main/java/io/sapient/transport/ConnectionState.java"
click node_thread_safe "https://github.com/cafanasyev/java-sapient-sdk/blob/master/src/main/java/io/sapient/transport/ThreadSafe.java"
click node_tls_factory "https://github.com/cafanasyev/java-sapient-sdk/blob/master/src/main/java/io/sapient/transport/SslContextFactory.java"

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_node_impl,node_dispatcher_api toneBlue
class node_dispatcher,node_node_wrapper,node_dispatcher_config,node_jitter toneAmber
class node_client_api,node_socket_client,node_socket_provider,node_connection_state,node_thread_safe toneMint
class node_tls_factory toneRose
class node_application,node_fusion_node toneIndigo
```

## Components

### Node API

- [Node Implementation](https://github.com/cafanasyev/java-sapient-sdk/blob/master/src/main/java/io/sapient/transmission/INode.java): `src/main/java/io/sapient/transmission/INode.java`
- [Dispatcher API](https://github.com/cafanasyev/java-sapient-sdk/blob/master/src/main/java/io/sapient/transmission/INodeDispatcher.java): `src/main/java/io/sapient/transmission/INodeDispatcher.java`

### Node Lifecycle

- [Node Dispatcher](https://github.com/cafanasyev/java-sapient-sdk/blob/master/src/main/java/io/sapient/transmission/NodeDispatcher.java): `src/main/java/io/sapient/transmission/NodeDispatcher.java`
- [Node Wrapper](https://github.com/cafanasyev/java-sapient-sdk/blob/master/src/main/java/io/sapient/transmission/NodeWrapper.java): `src/main/java/io/sapient/transmission/NodeWrapper.java`
- [Dispatcher Config](https://github.com/cafanasyev/java-sapient-sdk/blob/master/src/main/java/io/sapient/transmission/NodeDispatcherConfig.java): `src/main/java/io/sapient/transmission/NodeDispatcherConfig.java`
- [Lifecycle Jitter](https://github.com/cafanasyev/java-sapient-sdk/blob/master/src/main/java/io/sapient/transmission/Jitter.java): `src/main/java/io/sapient/transmission/Jitter.java`

### TCP Transport

- [Client API](https://github.com/cafanasyev/java-sapient-sdk/blob/master/src/main/java/io/sapient/transport/IClient.java): `src/main/java/io/sapient/transport/IClient.java`
- [Socket Client](https://github.com/cafanasyev/java-sapient-sdk/blob/master/src/main/java/io/sapient/transport/SocketClient.java): `src/main/java/io/sapient/transport/SocketClient.java`
- [Socket Provider](https://github.com/cafanasyev/java-sapient-sdk/blob/master/src/main/java/io/sapient/transport/ISocketProvider.java): `src/main/java/io/sapient/transport/ISocketProvider.java`
- [Connection State](https://github.com/cafanasyev/java-sapient-sdk/blob/master/src/main/java/io/sapient/transport/ConnectionState.java): `src/main/java/io/sapient/transport/ConnectionState.java`
- [Thread Safety Marker](https://github.com/cafanasyev/java-sapient-sdk/blob/master/src/main/java/io/sapient/transport/ThreadSafe.java): `src/main/java/io/sapient/transport/ThreadSafe.java`

### TLS Support

- [SSL Context Factory](https://github.com/cafanasyev/java-sapient-sdk/blob/master/src/main/java/io/sapient/transport/SslContextFactory.java): `src/main/java/io/sapient/transport/SslContextFactory.java`

### Other components

- **SDK Integrator**
- **Fusion Node**

## Connections

- SDK Integrator → Node Implementation: implements (evidence: `README.md`)
- SDK Integrator → Node Dispatcher: configures (evidence: `README.md`)
- SDK Integrator → Socket Provider: implements (evidence: `README.md`)
- Dispatcher API → Node Implementation: manages (evidence: `src/main/java/io/sapient/transmission/INodeDispatcher.java`)
- Node Dispatcher → Node Wrapper: creates (evidence: `src/main/java/io/sapient/transmission/NodeDispatcher.java`)
- Node Dispatcher → Dispatcher Config: uses (evidence: `src/main/java/io/sapient/transmission/NodeDispatcher.java`)
- Node Dispatcher → Client API: publishes through (evidence: `src/main/java/io/sapient/transmission/NodeDispatcher.java`)
- Node Dispatcher → Node Implementation: routes callbacks (evidence: `src/main/java/io/sapient/transmission/NodeDispatcher.java`)
- Node Wrapper → Node Implementation: polls and reports (evidence: `src/main/java/io/sapient/transmission/NodeWrapper.java`)
- Node Wrapper → Node Dispatcher: publishes reports (evidence: `src/main/java/io/sapient/transmission/NodeWrapper.java`)
- Node Wrapper → Lifecycle Jitter: uses timing (evidence: `src/main/java/io/sapient/transmission/NodeWrapper.java`)
- Dispatcher Config → Lifecycle Jitter: sets window (evidence: `src/main/java/io/sapient/transmission/NodeDispatcherConfig.java`)
- Client API → Connection State: exposes (evidence: `src/main/java/io/sapient/transport/IClient.java`)
- Socket Client → Client API: implements (evidence: `src/main/java/io/sapient/transport/SocketClient.java`)
- Socket Client → Socket Provider: opens sockets via (evidence: `src/main/java/io/sapient/transport/SocketClient.java`)
- Socket Client → Connection State: reports (evidence: `src/main/java/io/sapient/transport/SocketClient.java`)
- Socket Client → Thread Safety Marker: uses annotation (evidence: `src/main/java/io/sapient/transport/SocketClient.java`)
- Socket Client → Fusion Node: exchanges messages (evidence: `README.md`)
- SSL Context Factory → Socket Provider: can supply TLS (evidence: `README.md`)
