# naiksoftware/stompprotocolandroid architecture

> Architecture diagram of the GitHub repository naiksoftware/stompprotocolandroid, 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/naiksoftware/stompprotocolandroid
- Repository: https://github.com/naiksoftware/stompprotocolandroid

## Overview

This repository is an Android STOMP-over-WebSocket client library, with an example app that connects to a backend, subscribes to greetings, sends STOMP or REST echoes, and displays returned messages. The library creates a selected WebSocket provider, manages STOMP connection and subscription lifecycle, frames messages, and matches incoming destinations. Documented optional capabilities include custom providers, lifecycle events, heartbeat configuration, and RabbitMQ-style path matching. Edges reflect the README and shown excerpts or SOURCE INDEX references; unsampled implementation details are not assumed.

Main entry points: [`example-client/src/main/java/ua/naiksoftware/stompclientexample/MainActivity.java`](https://github.com/naiksoftware/stompprotocolandroid/blob/master/example-client/src/main/java/ua/naiksoftware/stompclientexample/MainActivity.java) (Demo controls), [`lib/src/main/java/ua/naiksoftware/stomp/StompClient.java`](https://github.com/naiksoftware/stompprotocolandroid/blob/master/lib/src/main/java/ua/naiksoftware/stomp/StompClient.java) (STOMP session), [`lib/src/main/java/ua/naiksoftware/stomp/provider/AbstractConnectionProvider.java`](https://github.com/naiksoftware/stompprotocolandroid/blob/master/lib/src/main/java/ua/naiksoftware/stomp/provider/AbstractConnectionProvider.java) (Provider base), [`lib/src/main/java/ua/naiksoftware/stomp/Stomp.java`](https://github.com/naiksoftware/stompprotocolandroid/blob/master/lib/src/main/java/ua/naiksoftware/stomp/Stomp.java) (Client factory)

## Diagram (Mermaid)

```mermaid
flowchart TD

subgraph group_example["Example app"]
  node_activity["Demo controls<br/>[MainActivity.java]"]
  node_adapter["Message list<br/>[SimpleAdapter.java]"]
  node_echo_model["Echo model<br/>[EchoModel.java]"]
  node_rest_client["REST client<br/>[RestClient.java]"]
  node_repository["Echo API"]
end

subgraph group_client["STOMP client"]
  node_stomp_api["Client factory<br/>[Stomp.java]"]
  node_stomp_client["STOMP session<br/>[StompClient.java]"]
  node_heartbeat["Heartbeat task<br/>[HeartBeatTask.java]"]
  node_matcher["Path matching<br/>[PathMatcher.java]"]
  node_simple_matcher["Exact matcher"]
  node_rabbit_matcher["Rabbit matcher"]
  node_subscription_matcher["Subscription matcher"]
end

subgraph group_transport["WebSocket transport"]
  node_provider_api["Provider interface"]
  node_provider_base["Provider base"]
  node_okhttp["OkHttp provider"]
  node_jws["Java-WebSocket provider"]
end

subgraph group_protocol["Protocol support"]
  node_message["STOMP frame<br/>[StompMessage.java]"]
  node_header["STOMP headers<br/>[StompHeader.java]"]
  node_command["STOMP commands<br/>[StompCommand.java]"]
  node_lifecycle["Lifecycle event"]
end

node_user(("App user"))
node_backend(("STOMP backend"))

node_user -->|"uses"| node_activity
node_activity -->|"creates session"| node_stomp_api
node_stomp_api -->|"creates"| node_stomp_client
node_stomp_api -->|"selects"| node_okhttp
node_stomp_api -->|"selects"| node_jws
node_activity -->|"connects, sends, subscribes"| node_stomp_client
node_stomp_client -->|"uses"| node_provider_api
node_stomp_client -->|"configures"| node_heartbeat
node_stomp_client -->|"matches messages"| node_matcher
node_stomp_client -->|"defaults to"| node_simple_matcher
node_activity -.->|"may configure"| node_rabbit_matcher
node_activity -.->|"may configure"| node_subscription_matcher
node_simple_matcher -->|"implements"| node_matcher
node_rabbit_matcher -->|"implements"| node_matcher
node_subscription_matcher -->|"implements"| node_matcher
node_provider_base -->|"implements"| node_provider_api
node_okhttp -->|"extends"| node_provider_base
node_jws -->|"extends"| node_provider_base
node_provider_base -.->|"exchanges frames"| node_backend
node_provider_base -->|"emits events"| node_lifecycle
node_stomp_client -->|"parses, compiles"| node_message
node_message -->|"uses"| node_header
node_message -->|"uses"| node_command
node_activity -->|"updates"| node_adapter
node_activity -->|"decodes payload"| node_echo_model
node_activity -->|"requests REST echo"| node_rest_client
node_rest_client -->|"creates"| node_repository
node_activity -->|"calls"| node_repository
node_backend -.->|"returns messages"| node_stomp_client

click node_activity "https://github.com/naiksoftware/stompprotocolandroid/blob/master/example-client/src/main/java/ua/naiksoftware/stompclientexample/MainActivity.java"
click node_adapter "https://github.com/naiksoftware/stompprotocolandroid/blob/master/example-client/src/main/java/ua/naiksoftware/stompclientexample/SimpleAdapter.java"
click node_echo_model "https://github.com/naiksoftware/stompprotocolandroid/blob/master/example-client/src/main/java/ua/naiksoftware/stompclientexample/EchoModel.java"
click node_rest_client "https://github.com/naiksoftware/stompprotocolandroid/blob/master/example-client/src/main/java/ua/naiksoftware/stompclientexample/RestClient.java"
click node_repository "https://github.com/naiksoftware/stompprotocolandroid/blob/master/example-client/src/main/java/ua/naiksoftware/stompclientexample/ExampleRepository.java"
click node_stomp_api "https://github.com/naiksoftware/stompprotocolandroid/blob/master/lib/src/main/java/ua/naiksoftware/stomp/Stomp.java"
click node_stomp_client "https://github.com/naiksoftware/stompprotocolandroid/blob/master/lib/src/main/java/ua/naiksoftware/stomp/StompClient.java"
click node_heartbeat "https://github.com/naiksoftware/stompprotocolandroid/blob/master/lib/src/main/java/ua/naiksoftware/stomp/HeartBeatTask.java"
click node_matcher "https://github.com/naiksoftware/stompprotocolandroid/blob/master/lib/src/main/java/ua/naiksoftware/stomp/pathmatcher/PathMatcher.java"
click node_simple_matcher "https://github.com/naiksoftware/stompprotocolandroid/blob/master/lib/src/main/java/ua/naiksoftware/stomp/pathmatcher/SimplePathMatcher.java"
click node_rabbit_matcher "https://github.com/naiksoftware/stompprotocolandroid/blob/master/lib/src/main/java/ua/naiksoftware/stomp/pathmatcher/RabbitPathMatcher.java"
click node_subscription_matcher "https://github.com/naiksoftware/stompprotocolandroid/blob/master/lib/src/main/java/ua/naiksoftware/stomp/pathmatcher/SubscriptionPathMatcher.java"
click node_provider_api "https://github.com/naiksoftware/stompprotocolandroid/blob/master/lib/src/main/java/ua/naiksoftware/stomp/provider/ConnectionProvider.java"
click node_provider_base "https://github.com/naiksoftware/stompprotocolandroid/blob/master/lib/src/main/java/ua/naiksoftware/stomp/provider/AbstractConnectionProvider.java"
click node_okhttp "https://github.com/naiksoftware/stompprotocolandroid/blob/master/lib/src/main/java/ua/naiksoftware/stomp/provider/OkHttpConnectionProvider.java"
click node_jws "https://github.com/naiksoftware/stompprotocolandroid/blob/master/lib/src/main/java/ua/naiksoftware/stomp/provider/WebSocketsConnectionProvider.java"
click node_message "https://github.com/naiksoftware/stompprotocolandroid/blob/master/lib/src/main/java/ua/naiksoftware/stomp/dto/StompMessage.java"
click node_header "https://github.com/naiksoftware/stompprotocolandroid/blob/master/lib/src/main/java/ua/naiksoftware/stomp/dto/StompHeader.java"
click node_command "https://github.com/naiksoftware/stompprotocolandroid/blob/master/lib/src/main/java/ua/naiksoftware/stomp/dto/StompCommand.java"
click node_lifecycle "https://github.com/naiksoftware/stompprotocolandroid/blob/master/lib/src/main/java/ua/naiksoftware/stomp/dto/LifecycleEvent.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_activity,node_adapter,node_echo_model,node_rest_client,node_repository,node_user toneBlue
class node_stomp_api,node_stomp_client,node_heartbeat,node_matcher,node_simple_matcher,node_rabbit_matcher,node_subscription_matcher toneAmber
class node_provider_api,node_provider_base,node_okhttp,node_jws toneMint
class node_message,node_header,node_command,node_lifecycle toneRose
class node_backend toneIndigo
```

## Components

### Example app

- [Demo controls](https://github.com/naiksoftware/stompprotocolandroid/blob/master/example-client/src/main/java/ua/naiksoftware/stompclientexample/MainActivity.java): `example-client/src/main/java/ua/naiksoftware/stompclientexample/MainActivity.java`
- [Message list](https://github.com/naiksoftware/stompprotocolandroid/blob/master/example-client/src/main/java/ua/naiksoftware/stompclientexample/SimpleAdapter.java): `example-client/src/main/java/ua/naiksoftware/stompclientexample/SimpleAdapter.java`
- [Echo model](https://github.com/naiksoftware/stompprotocolandroid/blob/master/example-client/src/main/java/ua/naiksoftware/stompclientexample/EchoModel.java): `example-client/src/main/java/ua/naiksoftware/stompclientexample/EchoModel.java`
- [REST client](https://github.com/naiksoftware/stompprotocolandroid/blob/master/example-client/src/main/java/ua/naiksoftware/stompclientexample/RestClient.java): `example-client/src/main/java/ua/naiksoftware/stompclientexample/RestClient.java`
- [Echo API](https://github.com/naiksoftware/stompprotocolandroid/blob/master/example-client/src/main/java/ua/naiksoftware/stompclientexample/ExampleRepository.java): `example-client/src/main/java/ua/naiksoftware/stompclientexample/ExampleRepository.java`

### STOMP client

- [Client factory](https://github.com/naiksoftware/stompprotocolandroid/blob/master/lib/src/main/java/ua/naiksoftware/stomp/Stomp.java): `lib/src/main/java/ua/naiksoftware/stomp/Stomp.java`
- [STOMP session](https://github.com/naiksoftware/stompprotocolandroid/blob/master/lib/src/main/java/ua/naiksoftware/stomp/StompClient.java): `lib/src/main/java/ua/naiksoftware/stomp/StompClient.java`
- [Heartbeat task](https://github.com/naiksoftware/stompprotocolandroid/blob/master/lib/src/main/java/ua/naiksoftware/stomp/HeartBeatTask.java): `lib/src/main/java/ua/naiksoftware/stomp/HeartBeatTask.java`
- [Path matching](https://github.com/naiksoftware/stompprotocolandroid/blob/master/lib/src/main/java/ua/naiksoftware/stomp/pathmatcher/PathMatcher.java): `lib/src/main/java/ua/naiksoftware/stomp/pathmatcher/PathMatcher.java`
- [Exact matcher](https://github.com/naiksoftware/stompprotocolandroid/blob/master/lib/src/main/java/ua/naiksoftware/stomp/pathmatcher/SimplePathMatcher.java): `lib/src/main/java/ua/naiksoftware/stomp/pathmatcher/SimplePathMatcher.java`
- [Rabbit matcher](https://github.com/naiksoftware/stompprotocolandroid/blob/master/lib/src/main/java/ua/naiksoftware/stomp/pathmatcher/RabbitPathMatcher.java): `lib/src/main/java/ua/naiksoftware/stomp/pathmatcher/RabbitPathMatcher.java`
- [Subscription matcher](https://github.com/naiksoftware/stompprotocolandroid/blob/master/lib/src/main/java/ua/naiksoftware/stomp/pathmatcher/SubscriptionPathMatcher.java): `lib/src/main/java/ua/naiksoftware/stomp/pathmatcher/SubscriptionPathMatcher.java`

### WebSocket transport

- [Provider interface](https://github.com/naiksoftware/stompprotocolandroid/blob/master/lib/src/main/java/ua/naiksoftware/stomp/provider/ConnectionProvider.java): `lib/src/main/java/ua/naiksoftware/stomp/provider/ConnectionProvider.java`
- [Provider base](https://github.com/naiksoftware/stompprotocolandroid/blob/master/lib/src/main/java/ua/naiksoftware/stomp/provider/AbstractConnectionProvider.java): `lib/src/main/java/ua/naiksoftware/stomp/provider/AbstractConnectionProvider.java`
- [OkHttp provider](https://github.com/naiksoftware/stompprotocolandroid/blob/master/lib/src/main/java/ua/naiksoftware/stomp/provider/OkHttpConnectionProvider.java): `lib/src/main/java/ua/naiksoftware/stomp/provider/OkHttpConnectionProvider.java`
- [Java-WebSocket provider](https://github.com/naiksoftware/stompprotocolandroid/blob/master/lib/src/main/java/ua/naiksoftware/stomp/provider/WebSocketsConnectionProvider.java): `lib/src/main/java/ua/naiksoftware/stomp/provider/WebSocketsConnectionProvider.java`

### Protocol support

- [STOMP frame](https://github.com/naiksoftware/stompprotocolandroid/blob/master/lib/src/main/java/ua/naiksoftware/stomp/dto/StompMessage.java): `lib/src/main/java/ua/naiksoftware/stomp/dto/StompMessage.java`
- [STOMP headers](https://github.com/naiksoftware/stompprotocolandroid/blob/master/lib/src/main/java/ua/naiksoftware/stomp/dto/StompHeader.java): `lib/src/main/java/ua/naiksoftware/stomp/dto/StompHeader.java`
- [STOMP commands](https://github.com/naiksoftware/stompprotocolandroid/blob/master/lib/src/main/java/ua/naiksoftware/stomp/dto/StompCommand.java): `lib/src/main/java/ua/naiksoftware/stomp/dto/StompCommand.java`
- [Lifecycle event](https://github.com/naiksoftware/stompprotocolandroid/blob/master/lib/src/main/java/ua/naiksoftware/stomp/dto/LifecycleEvent.java): `lib/src/main/java/ua/naiksoftware/stomp/dto/LifecycleEvent.java`

### Other components

- **App user**
- **STOMP backend**

## Connections

- App user → Demo controls: uses (evidence: `example-client/src/main/java/ua/naiksoftware/stompclientexample/MainActivity.java`)
- Demo controls → Client factory: creates session (evidence: `example-client/src/main/java/ua/naiksoftware/stompclientexample/MainActivity.java`)
- Client factory → STOMP session: creates (evidence: `lib/src/main/java/ua/naiksoftware/stomp/Stomp.java`)
- Client factory → OkHttp provider: selects (evidence: `lib/src/main/java/ua/naiksoftware/stomp/Stomp.java`)
- Client factory → Java-WebSocket provider: selects (evidence: `lib/src/main/java/ua/naiksoftware/stomp/Stomp.java`)
- Demo controls → STOMP session: connects, sends, subscribes (evidence: `example-client/src/main/java/ua/naiksoftware/stompclientexample/MainActivity.java`)
- STOMP session → Provider interface: uses (evidence: `lib/src/main/java/ua/naiksoftware/stomp/StompClient.java`)
- STOMP session → Heartbeat task: configures (evidence: `lib/src/main/java/ua/naiksoftware/stomp/StompClient.java`)
- STOMP session → Path matching: matches messages (evidence: `lib/src/main/java/ua/naiksoftware/stomp/StompClient.java`)
- STOMP session → Exact matcher: defaults to (evidence: `lib/src/main/java/ua/naiksoftware/stomp/StompClient.java`)
- Demo controls → Rabbit matcher: may configure
- Demo controls → Subscription matcher: may configure
- Exact matcher → Path matching: implements (evidence: `lib/src/main/java/ua/naiksoftware/stomp/pathmatcher/SimplePathMatcher.java`)
- Rabbit matcher → Path matching: implements (evidence: `lib/src/main/java/ua/naiksoftware/stomp/pathmatcher/RabbitPathMatcher.java`)
- Subscription matcher → Path matching: implements (evidence: `lib/src/main/java/ua/naiksoftware/stomp/pathmatcher/SubscriptionPathMatcher.java`)
- Provider base → Provider interface: implements (evidence: `lib/src/main/java/ua/naiksoftware/stomp/provider/AbstractConnectionProvider.java`)
- OkHttp provider → Provider base: extends (evidence: `lib/src/main/java/ua/naiksoftware/stomp/provider/OkHttpConnectionProvider.java`)
- Java-WebSocket provider → Provider base: extends (evidence: `lib/src/main/java/ua/naiksoftware/stomp/provider/WebSocketsConnectionProvider.java`)
- Provider base → STOMP backend: exchanges frames
- Provider base → Lifecycle event: emits events (evidence: `lib/src/main/java/ua/naiksoftware/stomp/provider/AbstractConnectionProvider.java`)
- STOMP session → STOMP frame: parses, compiles (evidence: `lib/src/main/java/ua/naiksoftware/stomp/StompClient.java`)
- STOMP frame → STOMP headers: uses (evidence: `lib/src/main/java/ua/naiksoftware/stomp/dto/StompMessage.java`)
- STOMP frame → STOMP commands: uses (evidence: `lib/src/main/java/ua/naiksoftware/stomp/dto/StompMessage.java`)
- Demo controls → Message list: updates (evidence: `example-client/src/main/java/ua/naiksoftware/stompclientexample/MainActivity.java`)
- Demo controls → Echo model: decodes payload (evidence: `example-client/src/main/java/ua/naiksoftware/stompclientexample/MainActivity.java`)
- Demo controls → REST client: requests REST echo (evidence: `example-client/src/main/java/ua/naiksoftware/stompclientexample/MainActivity.java`)
- REST client → Echo API: creates (evidence: `example-client/src/main/java/ua/naiksoftware/stompclientexample/RestClient.java`)
- Demo controls → Echo API: calls (evidence: `example-client/src/main/java/ua/naiksoftware/stompclientexample/MainActivity.java`)
- STOMP backend → STOMP session: returns messages
