How tiwarikrishna14/notifyhub works
NotifyHub is a multi-tenant notification API: tenants obtain API keys, register recipient devices, and submit idempotent notification requests. The request is durably recorded with an outbox event, then processed asynchronously into per-channel delivery work and sent through providers. PostgreSQL is the durable store; Kafka carries work and Redis supports rate limiting and cross-instance WebSocket presence. The README documents publisher, listener, retry, and realtime behavior that the sampled source does not fully expose, so those relationships are cited to the README.
Main entry points: NotificationOrchestrator.java Delivery orchestration · NotificationService.java Notification intake and status · OutboxRepository.java Outbox records · TenantAdminController.java Tenant administration
Components 30
Tenant access
- Tenant administration
src/main/java/com/notifyhub/tenant/TenantAdminController.java - Tenant records
src/main/java/com/notifyhub/tenant/TenantRepository.java - API key service
src/main/java/com/notifyhub/auth/ApiKeyService.java - API key records
src/main/java/com/notifyhub/auth/ApiKeyRepository.java - API key authentication
src/main/java/com/notifyhub/security/ApiKeyAuthenticationFilter.java - Tenant rate limiting
src/main/java/com/notifyhub/security/TenantRateLimitFilter.java
Request and state
- Device API
src/main/java/com/notifyhub/device/DeviceController.java - Device management
src/main/java/com/notifyhub/device/DeviceService.java - Device records
src/main/java/com/notifyhub/device/DeviceRepository.java - Notification API
src/main/java/com/notifyhub/notification/NotificationController.java - Notification intake and status
src/main/java/com/notifyhub/notification/NotificationService.java - Notification records
src/main/java/com/notifyhub/notification/NotificationRepository.java - Delivery records
src/main/java/com/notifyhub/delivery/DeliveryRepository.java - Outbox records
src/main/java/com/notifyhub/outbox/OutboxRepository.java - PostgreSQL
Async delivery
- Outbox publisher
src/main/java/com/notifyhub/outbox/OutboxPublisher.java - Kafka
- Notification listeners
src/main/java/com/notifyhub/messaging/NotificationListeners.java - Delivery orchestration
src/main/java/com/notifyhub/delivery/NotificationOrchestrator.java - Processed event records
src/main/java/com/notifyhub/messaging/ProcessedEventRepository.java - Delivery processing and retries
src/main/java/com/notifyhub/delivery/DeliveryProcessor.java
Providers and realtime
- Provider registry
src/main/java/com/notifyhub/provider/ProviderRegistry.java - Push provider
src/main/java/com/notifyhub/provider/push/MockPushProvider.java - WebSocket provider
src/main/java/com/notifyhub/provider/websocket/WebSocketNotificationProvider.java - Realtime broker
src/main/java/com/notifyhub/realtime/RealtimeBroker.java - WebSocket sessions
src/main/java/com/notifyhub/realtime/RealtimeWebSocketHandler.java - Connection and presence registry
src/main/java/com/notifyhub/realtime/ConnectionRegistry.java
Platform services
- Redis
Other components
- API client
- Tenant administrator
Connections 37
- Tenant administrator → Tenant administration: creates tenant
- Tenant administration → Tenant records: stores tenant
src/main/java/com/notifyhub/tenant/TenantAdminController.java - Tenant administration → API key service: creates key
src/main/java/com/notifyhub/tenant/TenantAdminController.java - API key service → API key records: stores and verifies
src/main/java/com/notifyhub/auth/ApiKeyService.java - API client → API key authentication: presents API key
- API key authentication → API key service: authenticates
src/main/java/com/notifyhub/security/ApiKeyAuthenticationFilter.java - API key authentication → Tenant rate limiting: passes tenant identity
- API client → Device API: registers device
- Device API → Device management: manages devices
src/main/java/com/notifyhub/device/DeviceController.java - Device management → Device records: reads and writes
src/main/java/com/notifyhub/device/DeviceService.java - API client → Notification API: submits request
- Notification API → Notification intake and status: accepts and queries
src/main/java/com/notifyhub/notification/NotificationController.java - Notification intake and status → Notification records: checks and saves
src/main/java/com/notifyhub/notification/NotificationService.java - Notification intake and status → Outbox records: records request event
src/main/java/com/notifyhub/notification/NotificationService.java - Notification intake and status → Delivery records: loads delivery status
src/main/java/com/notifyhub/notification/NotificationService.java - Notification records → PostgreSQL: persists
- Delivery records → PostgreSQL: persists
- Outbox records → PostgreSQL: persists
- Outbox publisher → Outbox records: claims pending events
- Outbox publisher → Kafka: publishes after acknowledgement
- Kafka → Notification listeners: dispatches work
- Notification listeners → Delivery orchestration: delegates request
- Delivery orchestration → Processed event records: deduplicates events
src/main/java/com/notifyhub/delivery/NotificationOrchestrator.java - Delivery orchestration → Notification records: locks notification
src/main/java/com/notifyhub/delivery/NotificationOrchestrator.java - Delivery orchestration → Device management: finds active devices
src/main/java/com/notifyhub/delivery/NotificationOrchestrator.java - Delivery orchestration → Delivery records: creates work items
src/main/java/com/notifyhub/delivery/NotificationOrchestrator.java - Delivery orchestration → Outbox records: records delivery events
src/main/java/com/notifyhub/delivery/NotificationOrchestrator.java - Kafka → Delivery processing and retries: dispatches delivery work
- Delivery processing and retries → Provider registry: selects provider
- Provider registry → Push provider: routes push
- Provider registry → WebSocket provider: routes realtime
- WebSocket provider → Realtime broker: sends realtime
src/main/java/com/notifyhub/provider/websocket/WebSocketNotificationProvider.java - Realtime broker → Connection and presence registry: routes to session
src/main/java/com/notifyhub/realtime/RealtimeBroker.java - WebSocket sessions → Connection and presence registry: registers sessions
src/main/java/com/notifyhub/realtime/RealtimeWebSocketHandler.java - Connection and presence registry → Redis: tracks distributed presence
- Realtime broker → Redis: broadcasts pub/sub
- Tenant rate limiting → Redis: counts tenant requests