pnoker
372d75b0c9
sweep every module to satisfy the new method-name rule, renaming about 40 methods together with their interface, implementation, test and cli call sites: store find() lookups become get(), analytics queryLatest/queryHistory become getLatest/getHistory, sql helper query() becomes spec()/sql(), jwks fetch() becomes load(), and the cursor record component queryDigest becomes requestDigest no behavior changes; full unit suite (5278 tests) and both quality gates stay green
DC3 Common Public
Overview
dc3-common-public is the foundational public contracts and utilities module of the IoT DC3 platform. It provides the
shared BaseService, request/pagination/tree entities, tenant markers, and HTTP client
configuration, HMAC signing, and framework-neutral utility functions.
Java public visibility does not determine module ownership. Framework- or capability-specific public APIs and helpers
remain in the narrowest owning module; platform-wide constants and shared top-level enums belong to
dc3-common-constant.
Module Information
- Group ID: io.github.pnoker
- Artifact ID: dc3-common-public
Key Components
HTTP Responses
REST controllers return typed payloads directly. Errors use RFC 9457 application/problem+json problem details;
there is no application-level success/error envelope.
Common Entities
| Class | Purpose |
|---|---|
Pages |
Pagination request params (current, size) |
RequestHeader.PrincipalHeader |
Tenant/user identity propagated from gateway headers |
Keys |
JWT signing key holder |
TreeNode |
Generic hierarchical data structure |
Utilities
| Utility | Purpose |
|---|---|
JsonUtil |
Jackson JSON serialization/deserialization helpers |
HostUtil |
Resolves host/IP information |
PageUtil |
Converts and normalizes pagination objects |
HmacAuthSigner |
Signs and verifies trusted gateway principal headers |
WebFlux-specific BaseController, PrincipalHeaderUtil, and ResponseUtil belong to dc3-common-web.
HTTP Client
OkHttpConfig — Pre-configured OkHttpClient bean with timeout and retry settings. Applications can override it by
declaring their own OkHttpClient bean.
Common properties:
| Property | Default |
|---|---|
dc3.http.client.retry-on-connection-failure |
true |
dc3.http.client.max-idle-connections |
16 |
dc3.http.client.keep-alive-duration |
5s |
dc3.http.client.call-timeout |
15s |
dc3.http.client.connect-timeout |
15s |
dc3.http.client.read-timeout |
15s |
dc3.http.client.write-timeout |
15s |
HMAC Auth
HmacAuthConfig — Auto-configures the shared HmacAuthSigner bean for trusted gateway-to-backend user headers.
Applications can override it by declaring their own HmacAuthSigner bean.
Secret lookup order:
dc3.auth.hmac.secretAUTH_HMAC_SECRET
Build Instructions
mvn -s .mvn/settings.xml -pl dc3-common/dc3-common-public -am package
Testing
Run the module tests from the repository root:
mvn -s .mvn/settings.xml -pl dc3-common/dc3-common-public -am test
Related Modules
Foundation for all dc3-common-*, dc3-center-*, and dc3-driver-* modules.