All Classes and Interfaces

Class
Description
AppRole login: POST auth/<mount>/login {role_id, secret_id} (default mount approle).
Builder of AppRoleOptions.
Logins, token self-service and token renewal: client.auth().
Missing or invalid credentials (HTTP 401).
The auth block of a login, token creation or renewal.
Implements SecretsProvider on top of five primitives a service provides (SPEC section 3).
Counters of a SecretCache.
The caller cancelled the operation (future cancelled, thread interrupted, client closed).
A stored certificate (Pki.readCertificate(String)).
A transit ciphertext.
Invalid or missing configuration.
Conflicting write or check-and-set mismatch (HTTP 409, 412).
The operations of one scenario category (core, secrets, logging, tracing) for the ConformanceRunner.
Results of a conformance run.
Result of one scenario.
Outcome of a scenario or step.
Result of one step.
Runs the shared conformance scenarios (conformance/scenarios/*.json, SPEC section 6) against targets supplied by a service's integration test.
Builder for ConformanceRunner.
Builder of ConnectionConfig.
A database connection (without its password).
Conformance operations of the core category: health, ping, serverVersion, close.
A target of the core conformance category that is not the service client: a fake for unit tests of the runner, or an adapter for a client whose core methods differ.
Builder of CreateKeyOptions.
Builder of CreateTokenOptions.
Database secrets engine on one mount: client.database() (mount database).
Dynamic database credentials (GET database/creds/<role>).
A data key generated by transit (transit/datakey/<plaintext|wrapped>/<name>).
Options of delete: path, specific versions, permanent destruction.
Builder for DeleteOptions.
Builder of EnableOptions.
Implements loadEnv (SPEC section 3).
Where variables are written.
Reads configuration from environment variables (SPEC section 2.2).
Canonical error codes shared by every Grow Codes SDK (SPEC section 2.1).
Service hook that replaces the error HttpTransport derived from a failed response, for vendor-specific mapping (for example a 403 that means bad credentials, or a 500 whose body says the request will never succeed).
Evaluates the expect object of a scenario step (SPEC section 6).
Options of read operations: a specific version and/or path.
Builder for GetOptions.
Implements the health() contract (SPEC section 2.4): never throws for an unhealthy or unreachable service, only for CancelledException and ConfigException.
Node health (GET sys/health).
Result of health() (SPEC section 2.4).
Callbacks invoked for every HTTP attempt (SPEC section 2.5).
The HTTP engine shared by every client of the SDK (SPEC section 2.3), built on HttpClient.
Thread-safe in-memory SecretsProvider with versions ("1", "2", ...), check-and-set, tags and soft/permanent deletes.
A certificate and private key issued by the PKI engine (Pki.issueCertificate(java.lang.String, java.lang.String)).
Builder of IssueOptions.
Shared Jackson configuration of the SDK.
JUnit 5 adapter: one dynamic test per scenario.
JWT/OIDC login with a JWT: POST auth/<mount>/login {role, jwt}.
Settings of Transit.updateKeyConfig(String, KeyConfig); unset fields stay unchanged.
Builder of KeyConfig.
Kubernetes login: POST auth/<mount>/login {role, jwt} with the service account token read from jwtPath (default "/var/run/secrets/kubernetes.io/serviceaccount/token") at login time.
Operations of a KV secrets engine mount (KvV1, KvV2 or the auto-detecting KvMount).
Metadata of a KV v2 secret (GET <mount>/metadata/<path>).
Builder of KvMetadataOptions.
A KV mount whose version is detected on first use (GET sys/internal/ui/mounts/<mount>) or taken from OpenBaoConfig.kvVersion(), then delegates to KvV1 or KvV2.
A KV secret: its data map (any JSON values) and, on KV v2, the version metadata.
KV version 1 (unversioned) mount.
KV version 2 (versioned) mount.
Metadata of one KV v2 version.
Leader status (GET sys/leader).
A secret with a lease (for example dynamic database credentials).
Lease details (PUT sys/leases/lookup).
Lease operations and automatic renewal: client.leases().
Options of loadEnv: overwrite existing variables and a name prefix.
Builder for LoadEnvOptions.
Minimal logger used by the transport (SPEC section 2.5).
What an AuthMethod can do during a login (no client token is sent).
Builder of LoginOptions.
Handle of a lease kept alive by LeaseManager.manage(Lease, RenewalOptions).
A secrets engine or auth method mount.
The record does not exist (HTTP 404).
Client for OpenBao.
Builder that configures and creates a client in one chain.
Immutable configuration of a OpenBaoClient (SPEC section 2.2).
Builder of the configuration.
Base class of every error raised by the OpenBao SDK (SPEC section 2.1).
SecretsProvider over an OpenBao KV mount (v1 or v2, auto-detected): client.secrets().
OpenBao server lifecycle helpers for tests and bootstrap scripts: init, unseal, seal and waiting for an active node.
Executes one scenario step and returns its result (or an OpResult).
A step result with optional extra views for the expectations count and tree.
The credentials lack a permission (HTTP 403).
PKI engine on one mount: client.pki() (mount pki).
An ACL policy.
Generic polling helper (pollUntil): used by waitForLog, waitForTrace and service waiters.
The service rate-limited the call (HTTP 429); see OpenBaoException.retryAfter().
Redaction helpers for headers, URLs, structured fields and free text (SPEC section 2.6).
Outcome of one successful renewal (or re-login) reported to RenewalOptions.Builder.onRenew.
Options of TokenRenewer and LeaseManager.manage(codes.grow.packages.openbao.Lease<?>, codes.grow.packages.openbao.RenewalOptions): renew at renewFraction of the TTL (default 2/3) until the maximum TTL is reached, then call onExpire once at expiry (or log in again for a token renewer with a re-login method).
Builder of RenewalOptions.
Retry settings with full-jitter exponential backoff (SPEC section 2.3).
Builder for RetryPolicy.
Builder of RoleConfig.
A database role.
A parsed conformance scenario (conformance/scenarios/*.json).
One step of a scenario.
Clock and timer used by TokenRenewer and LeaseManager.
Wall clock + one shared daemon thread.
Package identity used in the User-Agent header.
Seal status (GET sys/seal-status, also returned by unseal).
A credential held in a char[] that never prints itself.
LRU cache in front of a SecretsProvider (SPEC section 3).
Options of SecretCache.
Builder for SecretCache.Options.
A generated AppRole secret id.
Builder of SecretIdOptions.
Metadata of a secret (never its value).
Builder for SecretMetadata.
Conformance operations of the secrets category.
Builder of SecretsOptions.
Uniform secrets API shared by every secrets service (SPEC section 3).
A secret value that never prints itself (SPEC section 3).
Options of set: path, check-and-set version, tags and description.
Builder for SetOptions.
A transit signature.
A certificate signed by the PKI engine (Pki.signCsr(java.lang.String, java.lang.String)).
Everything an OpHandler needs for one step.
System backend: client.sys() (health, seal status, leader, policies, mounts, auth methods, AppRole admin).
Creates the object a scenario runs against (client, provider, log client, tracing handle).
Builder of TidyOptions.
Progress of a PKI tidy run (GET <mount>/tidy-status).
A connect, request or total deadline was exceeded (or HTTP 408, 504).
TLS settings: custom CA, client certificate (mutual TLS) and the test-only insecureSkipVerify.
Builder for TlsOptions.
Uses an existing token (X-Vault-Token); login checks it with lookup-self.
Properties of a token (auth/token/lookup-self).
Renews the client token in the background (auth/token/renew-self at 2/3 of the TTL).
Transit engine on one mount: client.transit() (mount transit).
A transit key (GET transit/keys/<name>).
Optional parameters of transit operations.
Builder of TransitOptions.
Settings of one HttpTransport.
Builder for TransportConfig.
One logical HTTP call executed by HttpTransport (with retries).
Builder for TransportRequest.
A response returned by HttpTransport (2xx or an accepted status).
Network error or HTTP 500, 502, 503.
The service or deployment does not offer this capability (HTTP 501).
The unwrapped response.
Username/password login: POST auth/<mount>/login/<username> {password}.
The request or a value is invalid (HTTP 400, 413, 422, other 4xx).
Polls secrets for changes on one daemon thread (created on the first watch).
Handle of a running watch.
Receives secret changes from watch.
Options of watch.
Builder for WatchOptions.
A response-wrapping token (wrap_info).
Response wrapping: client.wrapping().
Properties of a wrapping token (Wrapping.lookupWrapping(codes.grow.packages.openbao.core.Secret)); the token stays usable.