How naiksoftware/stompprotocolandroid works
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: MainActivity.java Demo controls · StompClient.java STOMP session · AbstractConnectionProvider.java Provider base · Stomp.java Client factory
Components 22
Example app
- Demo controls
example-client/src/main/java/ua/naiksoftware/stompclientexample/MainActivity.java - Message list
example-client/src/main/java/ua/naiksoftware/stompclientexample/SimpleAdapter.java - Echo model
example-client/src/main/java/ua/naiksoftware/stompclientexample/EchoModel.java - REST client
example-client/src/main/java/ua/naiksoftware/stompclientexample/RestClient.java - Echo API
example-client/src/main/java/ua/naiksoftware/stompclientexample/ExampleRepository.java
STOMP client
- Client factory
lib/src/main/java/ua/naiksoftware/stomp/Stomp.java - STOMP session
lib/src/main/java/ua/naiksoftware/stomp/StompClient.java - Heartbeat task
lib/src/main/java/ua/naiksoftware/stomp/HeartBeatTask.java - Path matching
lib/src/main/java/ua/naiksoftware/stomp/pathmatcher/PathMatcher.java - Exact matcher
lib/src/main/java/ua/naiksoftware/stomp/pathmatcher/SimplePathMatcher.java - Rabbit matcher
lib/src/main/java/ua/naiksoftware/stomp/pathmatcher/RabbitPathMatcher.java - Subscription matcher
lib/src/main/java/ua/naiksoftware/stomp/pathmatcher/SubscriptionPathMatcher.java
WebSocket transport
- Provider interface
lib/src/main/java/ua/naiksoftware/stomp/provider/ConnectionProvider.java - Provider base
lib/src/main/java/ua/naiksoftware/stomp/provider/AbstractConnectionProvider.java - OkHttp provider
lib/src/main/java/ua/naiksoftware/stomp/provider/OkHttpConnectionProvider.java - Java-WebSocket provider
lib/src/main/java/ua/naiksoftware/stomp/provider/WebSocketsConnectionProvider.java
Protocol support
- STOMP frame
lib/src/main/java/ua/naiksoftware/stomp/dto/StompMessage.java - STOMP headers
lib/src/main/java/ua/naiksoftware/stomp/dto/StompHeader.java - STOMP commands
lib/src/main/java/ua/naiksoftware/stomp/dto/StompCommand.java - Lifecycle event
lib/src/main/java/ua/naiksoftware/stomp/dto/LifecycleEvent.java
Other components
- App user
- STOMP backend
Connections 29
- App user → Demo controls: uses
example-client/src/main/java/ua/naiksoftware/stompclientexample/MainActivity.java - Demo controls → Client factory: creates session
example-client/src/main/java/ua/naiksoftware/stompclientexample/MainActivity.java - Client factory → STOMP session: creates
lib/src/main/java/ua/naiksoftware/stomp/Stomp.java - Client factory → OkHttp provider: selects
lib/src/main/java/ua/naiksoftware/stomp/Stomp.java - Client factory → Java-WebSocket provider: selects
lib/src/main/java/ua/naiksoftware/stomp/Stomp.java - Demo controls → STOMP session: connects, sends, subscribes
example-client/src/main/java/ua/naiksoftware/stompclientexample/MainActivity.java - STOMP session → Provider interface: uses
lib/src/main/java/ua/naiksoftware/stomp/StompClient.java - STOMP session → Heartbeat task: configures
lib/src/main/java/ua/naiksoftware/stomp/StompClient.java - STOMP session → Path matching: matches messages
lib/src/main/java/ua/naiksoftware/stomp/StompClient.java - STOMP session → Exact matcher: defaults to
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
lib/src/main/java/ua/naiksoftware/stomp/pathmatcher/SimplePathMatcher.java - Rabbit matcher → Path matching: implements
lib/src/main/java/ua/naiksoftware/stomp/pathmatcher/RabbitPathMatcher.java - Subscription matcher → Path matching: implements
lib/src/main/java/ua/naiksoftware/stomp/pathmatcher/SubscriptionPathMatcher.java - Provider base → Provider interface: implements
lib/src/main/java/ua/naiksoftware/stomp/provider/AbstractConnectionProvider.java - OkHttp provider → Provider base: extends
lib/src/main/java/ua/naiksoftware/stomp/provider/OkHttpConnectionProvider.java - Java-WebSocket provider → Provider base: extends
lib/src/main/java/ua/naiksoftware/stomp/provider/WebSocketsConnectionProvider.java - Provider base → STOMP backend: exchanges frames
- Provider base → Lifecycle event: emits events
lib/src/main/java/ua/naiksoftware/stomp/provider/AbstractConnectionProvider.java - STOMP session → STOMP frame: parses, compiles
lib/src/main/java/ua/naiksoftware/stomp/StompClient.java - STOMP frame → STOMP headers: uses
lib/src/main/java/ua/naiksoftware/stomp/dto/StompMessage.java - STOMP frame → STOMP commands: uses
lib/src/main/java/ua/naiksoftware/stomp/dto/StompMessage.java - Demo controls → Message list: updates
example-client/src/main/java/ua/naiksoftware/stompclientexample/MainActivity.java - Demo controls → Echo model: decodes payload
example-client/src/main/java/ua/naiksoftware/stompclientexample/MainActivity.java - Demo controls → REST client: requests REST echo
example-client/src/main/java/ua/naiksoftware/stompclientexample/MainActivity.java - REST client → Echo API: creates
example-client/src/main/java/ua/naiksoftware/stompclientexample/RestClient.java - Demo controls → Echo API: calls
example-client/src/main/java/ua/naiksoftware/stompclientexample/MainActivity.java - STOMP backend → STOMP session: returns messages