Code Architecture Overview

Monorepo Structure

MockServer is organized as a monorepo containing the Java server, client libraries, UI, plugins, and infrastructure.

mockserver-monorepo/
├── mockserver/                     # Java server (multi-module Maven project)
│   ├── mockserver-core/            # Core domain model, matching, serialisation (internal)
│   ├── mockserver-testing/         # Shared test utilities (internal, scope=test)
│   ├── mockserver-client-java/     # Java client library
│   ├── mockserver-client-java-no-dependencies/        # ↑ shaded, zero transitive deps
│   ├── mockserver-netty/           # Netty-based HTTP server (main artifact)
│   ├── mockserver-netty-no-dependencies/              # ↑ shaded, zero transitive deps
│   ├── mockserver-netty-docker/                       # ↑ with JNA unrelocated: the Docker images' jar (not published)
│   ├── mockserver-war/             # WAR-packaged mock server
│   ├── mockserver-proxy-war/       # WAR-packaged proxy
│   ├── mockserver-junit-rule/      # JUnit 4 integration
│   ├── mockserver-junit-rule-no-dependencies/         # ↑ shaded, zero transitive deps
│   ├── mockserver-junit-jupiter/   # JUnit 5 integration
│   ├── mockserver-junit-jupiter-no-dependencies/      # ↑ shaded, zero transitive deps
│   ├── mockserver-spring-test-listener/               # Spring test integration
│   ├── mockserver-spring-test-listener-no-dependencies/ # ↑ shaded, zero transitive deps
│   ├── mockserver-testcontainers/                     # Testcontainers integration (depends on mockserver-client-java)
│   ├── mockserver-integration-testing/                # Integration-test helpers
│   ├── mockserver-integration-testing-no-dependencies/# ↑ shaded, zero transitive deps
│   ├── mockserver-async/                              # AsyncAPI broker mocking (Kafka, MQTT)
│   ├── mockserver-k8s-webhook/                        # K8s MutatingAdmissionWebhook for sidecar injection
│   ├── mockserver-state-infinispan/                   # Infinispan-backed StateBackend (optional, clustered state)
│   ├── mockserver-blob-s3/                            # S3-backed BlobStore (optional, cloud blob storage)
│   ├── mockserver-blob-gcs/                           # GCS-backed BlobStore (optional, cloud blob storage)
│   ├── mockserver-blob-azure/                         # Azure-backed BlobStore (optional, cloud blob storage)
│   └── mockserver-benchmark/                          # JMH benchmarks (not part of default reactor build)
├── examples/                       # Runnable usage examples — java/node/python/ruby/curl/json/docker-compose/wasm/chaos
├── mockserver-ui/                  # React dashboard UI (Vite + TypeScript)
├── mockserver-node/                # Node.js MockServer launcher (npm)
├── mockserver-client-node/         # Node.js/browser client library (npm)
├── mockserver-client-python/       # Python client library (PyPI)
├── mockserver-client-ruby/         # Ruby client library (RubyGems)
├── mockserver-performance-test/    # k6-based performance tests
├── container_integration_tests/    # Docker & Helm integration tests
├── jekyll-www.mock-server.com/     # Jekyll documentation website
├── helm/                           # Helm charts (mockserver + mockserver-config)
├── docker/                         # Production Docker images (5 variants)
├── docker_build/                   # CI build Docker images
├── terraform/                      # Terraform IaC (Buildkite agents + pipelines)
├── scripts/                        # Build, deploy, and utility scripts
└── docs/                           # Internal documentation

Directory	Tech Stack	Build Tool
`mockserver/`	Java 17+, Netty 4.2	Maven (`./mvnw`)
`mockserver-ui/`	React, TypeScript	Vite (`npm`)
`mockserver-node/`	Node.js	Grunt (`npm`)
`mockserver-client-node/`	TypeScript	npm
`mockserver-client-python/`	Python 3.9+	pip/pytest
`mockserver-client-ruby/`	Ruby 3.0+	Bundler/RSpec
`mockserver/mockserver-maven-plugin/`	Java 17+	Maven
`mockserver-performance-test/`	JavaScript (k6)	k6

The rest of this document focuses on the Java server architecture within mockserver/.

Published Maven Artifacts

Everything published to Maven Central under org.mock-server is produced by a module under mockserver/, including the mockserver-maven-plugin/ sibling. Each "shaded" module is a real sibling Maven module that depends on its source module and applies the maven-shade-plugin to produce a zero-transitive-deps jar.

Source module	Published artifactId(s)	Notes
`mockserver-core/`	`mockserver-core`	Transitive dependency of every other Java module; not consumed directly.
`mockserver-testing/`	`mockserver-testing`	Internal test scope; transitive only.
`mockserver-client-java/`	`mockserver-client-java` + `mockserver-client-java-no-dependencies`	Java client for the REST API.
`mockserver-netty/`	`mockserver-netty` + `mockserver-netty-no-dependencies` + `mockserver-netty:jar-with-dependencies`	Main HTTP server. The `jar-with-dependencies` classifier is the executable uber-jar (assembly plugin, not shade).
`mockserver-war/`	`mockserver-war`	Servlet WAR (mock mode).
`mockserver-proxy-war/`	`mockserver-proxy-war`	Servlet WAR (proxy mode).
`mockserver-junit-rule/`	`mockserver-junit-rule` + `mockserver-junit-rule-no-dependencies`	JUnit 4 `@Rule`.
`mockserver-junit-jupiter/`	`mockserver-junit-jupiter` + `mockserver-junit-jupiter-no-dependencies`	JUnit 5 extension.
`mockserver-spring-test-listener/`	`mockserver-spring-test-listener` + `mockserver-spring-test-listener-no-dependencies`	Spring `TestExecutionListener`.
`mockserver-testcontainers/`	`mockserver-testcontainers`	Canonical, MockServer-maintained Testcontainers module (`MockServerContainer`). Supersedes the thin upstream `org.testcontainers:mockserver`. Depends on `mockserver-client-java`.
`mockserver-integration-testing/`	`mockserver-integration-testing` + `mockserver-integration-testing-no-dependencies`	Integration-test helpers.
`examples/java/` (repo root)	`mockserver-examples`	Sample code that documents usage rather than being a consumer dependency. No longer published as of this release — it was GPG-signed and deployed to Maven Central every release until now, but is no longer a module of the release reactor (which is what stops `mvn deploy -P release` reaching it; `skipPublishing=true` guards a future re-add) (previously published versions stay on Central forever; see the `### Removed` changelog entry). Relocated from `mockserver/mockserver-examples/`. Not a reactor module — it was removed from `mockserver/pom.xml` so `/mockserver` is a self-contained directory for Dependabot (a `../examples/java` module path broke grouped Maven updates). Its parent is `../../mockserver/pom.xml`, and CI builds + tests it standalone right after the reactor `install` (`scripts/buildkite_quick_build.sh`).
`mockserver-async/`	`mockserver-async`	AsyncAPI broker mocking: spec parsing, Kafka/MQTT publisher adapters, and `AsyncApiMockOrchestrator`.
`mockserver-k8s-webhook/`	`mockserver-k8s-webhook`	Kubernetes MutatingAdmissionWebhook HTTPS server for automatic sidecar injection. Standalone: depends only on jackson-databind, slf4j-api, and slf4j-jdk14.
`mockserver-state-infinispan/`	`mockserver-state-infinispan`	Optional Infinispan-backed `StateBackend`. Only required when `stateBackend=infinispan` is configured. Not needed for standard deployments.
`mockserver-blob-s3/`	`mockserver-blob-s3`	Optional S3-backed `BlobStore`. Implements the `BlobStore` SPI against AWS SDK v2 `S3Client`. Supports S3-compatible stores (MinIO) via endpoint override. Only required when `blobStoreType=s3`.
`mockserver-blob-gcs/`	`mockserver-blob-gcs`	Optional GCS-backed `BlobStore`. Implements the `BlobStore` SPI against `google-cloud-storage`. Supports fake-gcs-server for testing. Only required when `blobStoreType=gcs`.
`mockserver-blob-azure/`	`mockserver-blob-azure`	Optional Azure-backed `BlobStore`. Implements the `BlobStore` SPI against `azure-storage-blob`. Supports Azurite emulator for testing. Only required when `blobStoreType=azure`.
`mockserver-benchmark/`	(not published)	JMH benchmarks. Deliberately excluded from the default reactor build (not listed in `mockserver/pom.xml` `<modules>`); run manually via `mvn package -pl mockserver-benchmark`.
`mockserver/mockserver-maven-plugin/`	`mockserver-maven-plugin`	Maven plugin (`pre-integration-test` / `post-integration-test` hooks). Inherits its version from `mockserver/pom.xml` and uses `${project.version}` for internal mockserver-* dependency refs, but is NOT a child module of `mockserver/pom.xml` — built and deployed by the dedicated `:java: Maven Plugin` step in `.buildkite/release-pipeline.yml`, separately from the main reactor.

The *-no-dependencies form is a real sibling module (e.g. mockserver/mockserver-netty-no-dependencies/pom.xml) — not a classifier on the source artifactId. Each sibling module is a thin pom that pulls in the source module as its single compile dependency, then runs maven-shade-plugin with <shadedArtifactAttached>false</shadedArtifactAttached> so the shaded jar IS the module's main artifact. This structure lets central-publishing-maven-plugin upload everything to Maven Central via the standard bundle flow under each artifact's natural coordinates. Before 6.0.0, the shaded jars were renamed at deploy time via gpg:sign-and-deploy-file and published under both <classifier>shaded</classifier> and the -no-dependencies artifactId; that dual-publish path was removed when the deploy mechanism switched to Sonatype Central Portal in 6.0.0.

mockserver-netty-docker/ is build-internal and never published: it re-shades the mockserver-netty-no-dependencies jar with JNA moved back to com.sun.jna so that JNA's native loads, and the published Docker images are built from it (see docker.md).

High-Level Architecture

MockServer is a multi-module Maven project providing an HTTP(S) mock server and proxy. Every incoming connection -- regardless of protocol -- enters through a single Netty port and is dynamically routed by a port unification handler.

graph TB
    subgraph "Incoming Connections"
        HTTP[HTTP/1.1]
        HTTPS[HTTPS/TLS]
        H2[HTTP/2]
        S4[SOCKS4]
        S5[SOCKS5]
        BIN[Binary]
    end

    PU["Port Unification Handler
Protocol detection on first bytes"]

    HTTP --> PU
    HTTPS --> PU
    H2 --> PU
    S4 --> PU
    S5 --> PU
    BIN --> PU

    PU --> PIPELINE["Netty Channel Pipeline
Dynamically assembled per-protocol"]

    PIPELINE --> MCP_CHK{"MCP request?\n/mockserver/mcp"}
    MCP_CHK -->|Yes| MCP_HANDLER["McpStreamableHttpHandler\nJSON-RPC 2.0 over HTTP"]
    MCP_CHK -->|No| CODEC["MockServerHttpServerCodec\nNetty HTTP ↔ MockServer model"]
    CODEC --> HANDLER[HttpRequestHandler]

    HANDLER --> CP{Control Plane?}
    CP -->|Yes| STATE["HttpState
REST API handler"]
    CP -->|No| ACTION[HttpActionHandler]

    ACTION --> MATCH{"Expectation
matched?"}
    MATCH -->|Yes| DISPATCH["Action Dispatcher
19 action types"]
    MATCH -->|No, proxy mode| FWD["Forward to
original destination"]
    MATCH -->|No, mock mode| NF[404 Not Found]

    DISPATCH --> RESP[Response]
    DISPATCH --> TEMPLATE[Template Response]
    DISPATCH --> FORWARD[Forward]
    DISPATCH --> CALLBACK[Callback]
    DISPATCH --> SSE[SSE / WebSocket]
    DISPATCH --> ERROR[Error]

    STATE --> LOG["MockServerEventLog
LMAX Disruptor ring buffer"]
    ACTION --> LOG

    LOG --> VERIFY[Verification Engine]
    LOG --> DASH["Dashboard WebSocket
Real-time UI push"]
    LOG --> PERSIST[File Persistence]

Module Dependency Hierarchy

graph TB
    subgraph "Client Layer"
        JC["mockserver-client-java
Java client API"]
    end

    subgraph "Server Layer"
        MN["mockserver-netty
Netty server + CLI"]
        MW["mockserver-war
Servlet WAR"]
        MPW["mockserver-proxy-war
Proxy WAR"]
    end

    subgraph "Integration Layer"
        CAS["ClientAndServer
Embedded server+client"]
        JR["mockserver-junit-rule
JUnit 4 Rule"]
        JJ["mockserver-junit-jupiter
JUnit 5 Extension"]
        STL["mockserver-spring-test-listener
Spring TestListener"]
    end

    subgraph "Core Layer"
        MC["mockserver-core
Domain model, matching,
TLS, templates, codecs,
event log, action handlers"]
    end

    subgraph "Test & Example Infrastructure"
        MT["mockserver-testing
Shared test utilities"]
        MIT["mockserver-integration-testing
Integration test base classes"]
        MEX["mockserver-examples
Usage examples"]
    end

    JC --> MC
    MN --> MC
    MW --> MC
    MPW --> MC
    CAS --> MN
    CAS --> JC
    JR --> CAS
    JJ --> CAS
    STL --> CAS
    MT --> MC
    MIT --> MC
    MIT --> JC
    MEX --> MN
    MEX --> JC

Java Compatibility

MockServer targets Java 17 as the minimum supported version.

The Maven compiler source and target are set to 17 in mockserver/pom.xml. The javax→jakarta namespace migration is complete: the codebase now uses the jakarta namespace for all EE APIs (servlet, annotation, validation, xml.bind, ws.rs). JDK-namespace javax.* classes (javax.net.ssl, javax.xml.*, javax.script.*, javax.security.*) are unchanged — those remain part of the JDK.

Current dependency baseline:

Dependency	Version
Spring Framework	7.0.x
Jakarta EE	10
Tomcat Embed	11.x
Jetty	12.x
Servlet API	`jakarta.servlet`

See docs/operations/migration-java17-jakarta.md for migration details and docs/operations/security.md for the current dependency policy.

Key Architectural Principles

1. Port Unification (Single-Port Multi-Protocol)

All protocols are served on a single port. The PortUnificationHandler inspects the first bytes of each connection and dynamically assembles the correct Netty pipeline. This is recursive -- when TLS is detected, decryption handlers are added and the detector runs again on the decrypted bytes, enabling nested protocols (e.g., SOCKS5 wrapping TLS wrapping HTTP/2).

See: Netty Pipeline & Protocol Handling

2. Self-Loopback Relay Pattern

For HTTPS CONNECT and SOCKS tunneling, MockServer does not connect directly to the target server. Instead, RelayConnectHandler opens a new connection back to MockServer itself, sending a PROXIED_SECURE_host:port message. This allows MockServer to intercept, log, and mock even tunneled traffic.

See: Netty Pipeline & Protocol Handling

3. LMAX Disruptor Single-Writer Event Log

All event logging (request received, expectation matched, forwarded, etc.) flows through an LMAX Disruptor ring buffer. A single consumer thread processes all writes and reads, eliminating the need for locks on the event log. Verification and UI retrieval are serialized through the same ring buffer as RUNNABLE entries.

See: Event System, Logging & Verification

4. Observer Pattern for Real-Time Updates

Both the dashboard UI and file persistence are driven by observer interfaces (MockServerLogListener, MockServerMatcherListener). When expectations or log entries change, listeners are notified and push updates to WebSocket clients or write to disk.

See: Dashboard UI

5. Action Dispatch Pattern

Matched expectations produce one of 19 action types across two categories (response vs forward), each with a dedicated handler class. This pattern cleanly separates matching from action execution.

See: Request Processing, Mocking & Proxying

6. MCP Integration (Model Context Protocol)

MockServer exposes its control-plane capabilities via the Model Context Protocol, enabling AI agents and LLM-based tools to interact with MockServer programmatically. The MCP server uses Streamable HTTP transport on the /mockserver/mcp endpoint and provides tools (e.g., create expectations, verify requests) and resources (e.g., active expectations, recorded requests) that map to existing HttpState operations. MCP is enabled by default and can be disabled via mcpEnabled=false.

See: Client & Integrations — MCP

Package Map

Package	Module	Purpose	Doc Reference
`org.mockserver.cli`	netty	CLI entry point	Netty Pipeline
`org.mockserver.netty`	netty	Server bootstrap, request handler	Netty Pipeline
`org.mockserver.netty.unification`	netty	Port unification, protocol detection	Netty Pipeline
`org.mockserver.netty.proxy`	netty	CONNECT, SOCKS, binary proxying	Netty Pipeline
`org.mockserver.netty.responsewriter`	netty	Netty response writing	Request Processing
`org.mockserver.lifecycle`	netty	Server lifecycle management	Netty Pipeline
`org.mockserver.dashboard`	netty	Dashboard UI handlers & serializers	Dashboard UI
`org.mockserver.netty.mcp`	netty	MCP (Model Context Protocol) server handler	Client & Integrations
`org.mockserver.integration`	netty	`ClientAndServer` combined class	Client & Integrations
`org.mockserver.mock`	core	Expectation management, HttpState	Request Processing
`org.mockserver.mock.action.http`	core	Action handlers (16 types)	Request Processing
`org.mockserver.matchers`	core	Request matching (15+ matcher types)	Domain Model
`org.mockserver.model`	core	Domain objects (HttpRequest, etc.)	Domain Model
`org.mockserver.serialization`	core	JSON/Java serialization	Domain Model
`org.mockserver.codec`	core	Netty ↔ MockServer codecs	Domain Model
`org.mockserver.socket.tls`	core	TLS certificate generation	TLS & Security
`org.mockserver.templates`	core	Velocity/Mustache/JS templates	Request Processing
`org.mockserver.log`	core	LMAX Disruptor event log	Event System
`org.mockserver.verify`	core	Verification engine	Event System
`org.mockserver.configuration`	core	Configuration properties	Domain Model
`org.mockserver.openapi`	core	OpenAPI spec parsing	Domain Model
`org.mockserver.closurecallback`	core	WebSocket callback system	Client & Integrations
`org.mockserver.persistence`	core	File persistence & watching	Event System
`org.mockserver.metrics`	core	Prometheus metrics collection	Metrics & Monitoring
`org.mockserver.memory`	core	Memory usage monitoring/CSV export	Metrics & Monitoring
`org.mockserver.grpc`	core	gRPC proto descriptor store, frame codec, JSON conversion	AI & RPC Protocol Mocking
`org.mockserver.netty.grpc`	netty	gRPC↔HTTP pipeline handlers	AI & RPC Protocol Mocking
`org.mockserver.client`	client-java	MockServerClient API	Client & Integrations
`org.mockserver.junit`	junit-rule	JUnit 4 Rule	Client & Integrations
`org.mockserver.junit.jupiter`	junit-jupiter	JUnit 5 Extension	Client & Integrations
`org.mockserver.springtest`	spring-test-listener	Spring integration	Client & Integrations

Code Documentation Index

Level	Document	Scope
High	This document	System-wide architecture, module map, design principles
High	Netty Pipeline & Protocol Handling	Server bootstrap, port unification, all protocol pipelines, proxy relay
Medium	Request Processing, Mocking & Proxying	HttpState, expectation matching, action dispatch, proxy forwarding
Medium	Event System, Logging & Verification	LMAX Disruptor, event log, verification, persistence
Medium	Dashboard UI	WebSocket handler, React SPA, real-time data push
Low	Domain Model, Matchers & Serialization	Model classes, matcher hierarchy, codec layer, OpenAPI, configuration
Low	TLS, Certificates & Security	BouncyCastle CA, SNI, mTLS, JWT, control plane auth
Low	Client API & Test Integrations	MockServerClient, JUnit 4/5, Spring, WebSocket callbacks
Medium	AI & RPC Protocol Mocking	SSE streaming, JSON-RPC, MCP, A2A, gRPC mocking
Medium	LLM Mocking	LLM response builder, provider codecs, conversation matchers, MCP tools, dashboard
Low	LLM Codec Golden-File Testing	Codec-generated golden fixtures, normalization, drift-detection test
Low	LLM Mocking Security Audit	Security review of the LLM mocking feature (M0–M4)
Low	Metrics & Monitoring	Prometheus metrics, memory monitoring

Navigation Menu

Repository navigation

overview.md

overview.md

Code Architecture Overview

Monorepo Structure

Published Maven Artifacts

High-Level Architecture

Module Dependency Hierarchy

Java Compatibility

Key Architectural Principles

1. Port Unification (Single-Port Multi-Protocol)

2. Self-Loopback Relay Pattern

3. LMAX Disruptor Single-Writer Event Log

4. Observer Pattern for Real-Time Updates

5. Action Dispatch Pattern

6. MCP Integration (Model Context Protocol)

Package Map

Code Documentation Index

FilesExpand file tree

overview.md

Latest commit

History

overview.md

File metadata and controls

Code Architecture Overview

Monorepo Structure

Published Maven Artifacts

High-Level Architecture

Module Dependency Hierarchy

Java Compatibility

Key Architectural Principles

1. Port Unification (Single-Port Multi-Protocol)

2. Self-Loopback Relay Pattern

3. LMAX Disruptor Single-Writer Event Log

4. Observer Pattern for Real-Time Updates

5. Action Dispatch Pattern

6. MCP Integration (Model Context Protocol)

Package Map

Code Documentation Index