How jsainsburyplc/consul-client works
This is a Java client library for Consul’s HTTP API. A caller builds a Consul client, obtains domain-specific clients, and uses them to register services and checks, discover healthy instances, or read and write key/value data. The library also exposes sessions, events, prepared queries, ACL, catalog, coordinate, operator, and status APIs, plus caches for watching changes. The sampled source shows health and agent requests using the shared HTTP helpers, and HTTP response metadata wrapping; unsampled client relationships are omitted or marked unverified.
Main entry points: HealthClient.java Health discovery · Http.java HTTP handling · Consul.java Consul factory · AgentClient.java Agent operations
Components 19
Client entry
- Consul factory
src/main/java/com/orbitz/consul/Consul.java
Consul API clients
- Agent operations
src/main/java/com/orbitz/consul/AgentClient.java - Health discovery
src/main/java/com/orbitz/consul/HealthClient.java - Key-value store
src/main/java/com/orbitz/consul/KeyValueClient.java - Catalog queries
src/main/java/com/orbitz/consul/CatalogClient.java - Sessions
src/main/java/com/orbitz/consul/SessionClient.java - Prepared queries
src/main/java/com/orbitz/consul/PreparedQueryClient.java - Other API clients
src/main/java/com/orbitz/consul - KV value model
src/main/java/com/orbitz/consul/model/kv/Value.java - Health models
src/main/java/com/orbitz/consul/model/health - Agent check model
src/main/java/com/orbitz/consul/model/agent/Check.java
Watch and async
- Health cache
src/main/java/com/orbitz/consul/cache/ServiceHealthCache.java - Async callback
src/main/java/com/orbitz/consul/async/ConsulResponseCallback.java
Shared runtime
- Query options
src/main/java/com/orbitz/consul/option/QueryOptions.java - HTTP handling
src/main/java/com/orbitz/consul/util/Http.java - Consul response
src/main/java/com/orbitz/consul/model/ConsulResponse.java - Error handling
src/main/java/com/orbitz/consul/ConsulException.java
Other components
- Application caller
- Consul server
Connections 22
- Application caller → Consul factory: builds client
- Consul factory → Agent operations: provides client
src/main/java/com/orbitz/consul/Consul.java - Consul factory → Health discovery: provides client
src/main/java/com/orbitz/consul/Consul.java - Consul factory → Key-value store: provides client
src/main/java/com/orbitz/consul/Consul.java - Application caller → Agent operations: registers service
- Application caller → Health discovery: discovers services
- Application caller → Key-value store: reads and writes
- Application caller → Health cache: subscribes
- Agent operations → HTTP handling: executes requests
src/main/java/com/orbitz/consul/AgentClient.java - Health discovery → HTTP handling: extracts responses
src/main/java/com/orbitz/consul/HealthClient.java - Key-value store → HTTP handling: uses transport
src/main/java/com/orbitz/consul/KeyValueClient.java - HTTP handling → Consul server: sends HTTP
src/main/java/com/orbitz/consul/util/Http.java - HTTP handling → Consul response: wraps metadata
src/main/java/com/orbitz/consul/util/Http.java - Health discovery → Health models: returns health data
src/main/java/com/orbitz/consul/HealthClient.java - Agent operations → Agent check model: registers checks
src/main/java/com/orbitz/consul/AgentClient.java - Key-value store → KV value model: reads values
src/main/java/com/orbitz/consul/KeyValueClient.java - Health cache → Health discovery: watches service health
src/main/java/com/orbitz/consul/cache/ServiceHealthCache.java - Health discovery → Query options: applies query options
src/main/java/com/orbitz/consul/HealthClient.java - Prepared queries → Consul server: queries Consul
src/main/java/com/orbitz/consul/PreparedQueryClient.java - Sessions → Consul server: manages sessions
- Catalog queries → Consul server: queries catalog
- Other API clients → Consul server: exposes API calls