DSM Documentation

DSM is a runtime-first distributed coordination toolkit for enterprise Java services. This documentation set is organized so an integration developer can both finish initial integration and keep a precise reference open while implementing.

Start Here

Getting StartedFastest path from dependency to a running runtime with one replicated register collection.Standalone QuickstartManual Java wiring for services that own lifecycle, membership, and collection registration.Spring Boot GuideProperty-driven runtime assembly, required beans, collection registration, and bean injection patterns.Runtime API ReferenceLookup page for DsmRuntime, builder methods, lifecycle, tenant/application scoping, and diagnostics.Production ReadinessChecklist for identity, membership, repair, security, observability, testing, and rollout gates.Repair And Anti-EntropyHow digest, replay, snapshot, relay health, and adaptive repair close replication gaps.

Recommended Reading Order

1. Read What is DSM? if you need scope and terminology.
2. Read When Not To Use DSM if you are deciding whether DSM belongs in the workflow at all.
3. Read Getting Started for the smallest working runtime.
4. Choose Standalone Quickstart or Spring Boot based on your service bootstrap style.
5. Read Collection Types and Consistency And Repair Boundaries before committing to register, lease, or CRDT semantics.
6. Read Repair And Anti-Entropy before production rollout.
7. Keep the Reference section open while implementing. It documents runtime interfaces, collection builders, collection handles, Spring properties, error codes, and wire compatibility.

Documentation Layers

Task-Oriented Guides

• Getting Started
• When Not To Use DSM
• Standalone Quickstart
• Spring Boot
• Developer Guide
• Production Rollout

Use these pages when integrating DSM into a service for the first time.

Reference

• Runtime API
• Collection Specs
• Collection Handles
• Spring Properties
• Error Codes
• Wire Compatibility

These pages document exact methods, builder defaults, property names, validation rules, and bean naming conventions.

Scenario Cookbooks

• Service Discovery & Routing
• Shard Owner Election
• Distributed Counters
• Federation

Use these pages when you already know the business problem and want a recommended DSM modeling pattern, collection choice, registration approach, and operational checklist.

Supporting Material

• Core Concepts for data model and collection semantics
• Architecture for module boundaries, replication internals, repair, security, and federation
• Operations for diagnostics, observability, troubleshooting, and production readiness
• Examples for runnable repository entry points