All Classes and Interfaces
Class
Description
Generic HTTP client for the CloudStub REST API.
Result of an API call: the HTTP status and the parsed JSON body (never null).
Handler for a single API route registered by a service module.
Describes a single parameter of an API route.
Resolves the port for the REST API server.
Inbound API HTTP request, stripped of HTTP-transport details.
Response produced by a module API handler.
Passed to
CloudStubApiService.registerRoutes(io.cloudstub.core.spi.restapi.CloudStubApiContext) so modules can declare API routes without
depending on any HTTP transport type.Persistent
StateStore that records each mutation as a single appended record in an
append-only log, rather than rewriting the whole document on every change.Resolves whether absent service module jars are auto-downloaded from Maven Central.
Manages the
aws.endpoint-url system property that redirects AWS SDK v2 traffic to the
embedded mock server.Decides whether a
cloudstub-local invocation runs the server or the CLI.Entry point for the CloudStub framework.
Passed to
CloudStubApiService.registerRoutes(io.cloudstub.core.spi.restapi.CloudStubApiContext) at API-server startup.Optional companion to
CloudStubService for modules that want to expose API routes under
/api/<serviceId>/….Entry point for the CloudStub CLI surface of
cloudstub-local.Passed to
CloudStubService.register(CloudStubContext) at startup.REST API surface for DynamoDB, mounted under
/api/dynamodb/….CloudStub service module for Amazon DynamoDB.
JUnit extension (JUnit 5 and 6) that manages the
CloudStub lifecycle around a test class
and applies fault injection annotations (SimulateThrottle, SimulateTimeout,
SimulateNetworkBrownout) to individual test methods.REST API surface for Lambda, mounted under
/api/lambda/….CloudStub service module for AWS Lambda.
The single global response transformer: it produces a matched stub's real response — running its
module-supplied
StubHandler against the shared StateStore when the stub is
stateful — and then applies any active fault for the stub's service as a decoration over that
response.REST API surface for S3, mounted under
/api/s3/….CloudStub service module for S3.
REST API surface for Secrets Manager, mounted under
/api/secretsmanager/….CloudStub service module for AWS Secrets Manager.
Entry point that every CloudStub service module must implement.
Mutable holder for all pre-start configuration of a
CloudStub instance.REST API surface for SNS, mounted under
/api/sns/….CloudStub service module for Amazon SNS.
REST API surface for SQS, mounted under
/api/sqs/….CloudStub service module for Amazon SQS.
REST API surface for SSM Parameter Store, mounted under
/api/ssm/….CloudStub service module for the Amazon SSM Parameter Store.
Thrown when the persistent state store cannot read or write its backing file.
Thrown when the CloudStub REST API cannot be reached (server down, wrong port, network error).
Helper for pointing AWS SDK v1 clients at a running CloudStub instance.
Connection settings for a running CloudStub instance.
Reports the running
cloudstub-core version from a build-stamped classpath resource.Checksum helpers for service modules (SQS message checksums, S3 ETags).
Records the active fault, if any, for each service.
Standalone JUnit 6 extension that applies fault injection annotations to test methods.
A single file produced by the generator: a path relative to the module root and its content.
The outcome of a single model generation run.
HTTP methods used to match REST-style stubs via
StubRegistrar.registerRestStub(io.cloudstub.core.spi.HttpMethod, java.lang.String, java.lang.String).Thread-safe in-memory
StateStore.Helpers for assembling JSON response bodies from plain JDK collections, to pass to
StubResponse.json(Map).Persistent
StateStore that serialises state to a JSON file on every mutation.Optional
.properties configuration file for standalone mode, located from
--config=<path>, then CLOUDSTUB_CONFIG, then ./cloudstub.properties.Signals an unusable standalone config file.
The cloudstub-local HTTP server for the secondary management port (REST API + web console).
Entry point for the CloudStub stub code generator.
Resolves the Maven repository base URL that auto-download fetches module jars from.
Resolves the cap on retained request-history entries for the long-lived local process.
WireMock extension that registers a
{{md5 value}} Handlebars helper.Provisions a CloudStub service module jar from Maven Central into a plugin directory: fetch,
checksum-verify, then store.
Thrown when a service module jar cannot be provisioned from Maven Central.
Generates a complete, compilable
cloudstub-* module skeleton from a Smithy service model.Discovers and registers all
CloudStubService modules against a running server.Resolves the directory from which module jars are loaded at startup.
Status snapshot for one loaded service module and its registered stubs.
Resolves the version of the module jars to auto-download.
Resolves the port the mock server binds.
Terminal output helpers.
Read/clear view over the WireMock request journal, translated into CloudStub's
RequestRecord domain model.Immutable snapshot of a single request served by the mock engine.
AWS SDK v2
ExecutionInterceptor that prepends the bucket to the request path when a
default-configured (virtual-hosted-style) S3Client talks to a CloudStub endpoint, so
CloudStub's path-style (/{bucket}/{key}) stubs match without
pathStyleAccessEnabled.Records which stubs each service module registered, so
CloudStubResponseTransformer can
look up a matched stub's protocol when decorating its response with a fault, without coupling to
the module's implementation.Resolves which services the local server should enable.
Causes approximately
rate fraction of requests to the named service to fail with a
connection reset; the remainder are served normally.Causes all stubs for the named service to return a
ThrottlingException (HTTP 400) for the
duration of the annotated test method.Causes all stubs for the named service to delay their response beyond the AWS SDK's call timeout,
triggering a timeout exception at the SDK level.
Selects the persistent
StateStore backend used when a store
directory is configured via CloudStub.withStoreDirectory(java.nio.file.Path).Shared key-value backend owned and lifecycle-managed by the core engine.
Chooses the
StateStore implementation for a CloudStub instance: a persistent store of the
requested StatePersistence backend when a directory is configured, otherwise a throwaway
in-memory store.Resolves the directory used for persistent state in local mode.
A request-time handler for a stateful stub.
Describes a single registered stub: its protocol and match key.
Facade through which service modules register HTTP stubs without any direct dependency on the
underlying networking driver (WireMock).
Read-only view of an incoming HTTP request, handed to a
StubHandler at request time.Immutable HTTP response returned by a
StubHandler.Loads Handlebars response templates bundled as classpath resources in a module's JAR.
Builds and starts the embedded WireMock server from
CloudStubSettings.Internal
StubRegistrar implementation that delegates to a live WireMock server.A builder for an XML element tree for AWS Query (XML) response bodies.