Core
Table of Contents
Classes
- AuthError
- Authentication failure: wrong credentials, expired session, MFA failure, or a 401
on refresh (CONTRACT.md §2). Always constructed via {@see ErrorMapper} so REST and
gRPC transports cannot drift on the error taxonomy.
- AuthzError
- Authorization failure: the caller is authenticated but lacks permission for the
requested operation (CONTRACT.md §2). Always constructed via {@see ErrorMapper} so
REST and gRPC transports cannot drift on the error taxonomy.
- AxiamException
- Base exception for all AXIAM SDK errors (CONTRACT.md §2, D-10).
- ConfigClampedEvent
- Emitted at construction, once per caller-supplied setting the SDK clamped
(CONTRACT.md §19.1, §19.2 rule 6).
- DecisionMemo
- Client-side decision memo — CONTRACT.md §17.
- ErrorMapper
- Central status→error mapper (CONTRACT.md §2, D-10). {@see self::fromStatus()} is the
single translation point from an HTTP status code to a typed {@see AxiamException}
subtype — no other class in the SDK is permitted to hand-roll this branching:
401 → {@see AuthError}; 403/409 → {@see AuthzError}; everything else
(400/408/429/5xx/transport) → {@see NetworkError}.
- NetworkError
- Transport-level failure: connection refused, timeout, TLS error, DNS failure, or a
server-side 5xx (CONTRACT.md §2).
- OAuthProtocolError
- An RFC 6749 protocol error returned by an `/oauth2/*` endpoint as an
`OAuth2ErrorResponse` body — `invalid_grant`, `invalid_client`, `invalid_request`,
`unsupported_grant_type`, … (CONTRACT.md §2, §12.3 rule 3).
- RefreshEvent
- Emitted around a §9 single-flight refresh (CONTRACT.md §19).
- RequestEndEvent
- Emitted after a call completes, success or failure (CONTRACT.md §19).
- RequestStartEvent
- Emitted before an outbound call leaves the SDK (CONTRACT.md §19).
- RetryEvent
- Emitted before each §16 retry wait (CONTRACT.md §19).
- RetryPolicy
- Bounded read-only retry policy — CONTRACT.md §16.
- Sensitive
- Wraps a token-carrying value so it can never be accidentally exposed via
`__toString()`, `var_export()`/`print_r()`, or JSON serialization
(CONTRACT.md §7, D-11).
- TelemetryDispatcher
- Internal §19 dispatcher. A null hook is the overwhelmingly common case and
costs one null check per request.
- TelemetryEvent
- A telemetry event (CONTRACT.md §19).