SwiftMQ Documentation (AI-generated)

This documentation was automatically generated from the SwiftMQ source code using code-to-doc, an LLM-powered documentation generator.

How This Documentation Was Generated

The generation pipeline works in three phases:

1. Collect (deterministic, zero LLM) — The source code of each SwiftMQ repository is scanned. Swiftlet configurations (config.xml), Java source files, CLI commands, scheduler jobs, and dependency graphs are extracted and structured automatically.

2. Extract (LLM-assisted) — The collected source bundles are sent to a large language model which produces structured JSON facts: an overview, feature descriptions, configuration scenarios, and internal queue patterns for each Swiftlet. Results are cached so subsequent runs are instant.

3. Render (deterministic, zero LLM) — Handlebars templates combine the extracted facts with the parsed configuration schemas to produce the final Markdown pages. Configuration reference tables, CLI command docs, and transformer API references are generated entirely from the source code without any LLM involvement.

Release notes are generated by analyzing git diff between version tags. Each commit's changed files are classified by Swiftlet/component, and the actual code diff is parsed to detect the nature of the change (boundary fixes, null checks, new methods, dependency migrations, etc.) — no commit messages are used.

The dark blue theme with the SwiftMQ logo, the site structure, and the MkDocs configuration are all generated automatically as part of the pipeline.

Client APIs

• JNDI Client — Connect to a SwiftMQ router and look up administered objects.
• JMS Client — Build messaging applications using JMS 1.1.
• AMQP 1.0 Client — Build messaging applications using the AMQP 1.0 protocol.
• CLI — Manage SwiftMQ routers from the command line.

Community Edition (CE)

• Getting Started — Directory structure, starting the router, connecting with the CLI.
• Preconfig System — Configuration evolution and upgrade patches.
• Management Tree — The complete configuration hierarchy and CLI navigation guide.
• Router Lifecycle — Startup, shutdown, and boot order.
• System Queues — Internal queues used by the router.
• System Properties — JVM system properties for tuning SwiftMQ.

Swiftlets

• AMQP Swiftlet — AMQP Swiftlet
• Authentication Swiftlet — Authentication Swiftlet
• Deploy Swiftlet — Deploy Swiftlet
• JMS Swiftlet — JMS Swiftlet
• JNDI Swiftlet — JNDI Swiftlet
• Log Swiftlet — Central Logging Facility
• Management Swiftlet — Management Swiftlet
• MQTT Swiftlet — MQTT Swiftlet
• Network Swiftlet — Network Swiftlet
• Queue Manager Swiftlet — Queue Manager
• Routing Swiftlet — Routing Swiftlet
• Scheduler Swiftlet — Scheduler Swiftlet
• Store Swiftlet — Store Swiftlet
• Streams Swiftlet — SwiftMQ Streams Microservice Engine
• Threadpool Swiftlet — Threadpool Swiftlet
• Timer Swiftlet — Timer Swiftlet
• Topic Manager Swiftlet — Topic Manager
• Trace Swiftlet — Trace Swiftlet
• XA Resource Manager Swiftlet — XA Resource Manager Swiftlet

Universal Router (UR)

• Overview — What UR adds to the Community Edition.

Swiftlets

• FileCache Swiftlet — FileCache Swiftlet
• JMS Application Container Swiftlet — JMS Application Container
• AMQP Bridge Extension Swiftlet — AMQP Bridge Extension Swiftlet
• JavaMail Bridge Extension Swiftlet — JavaMail Bridge Extension Swiftlet
• JMS Bridge Extension Swiftlet — JMS Bridge Extension Swiftlet
• Replicator Extension Swiftlet — Replicator Extension Swiftlet

Optional Kernel

• JDBC Authentication Swiftlet — JDBC Authentication Swiftlet
• JDBC Store Swiftlet — JDBC Store Swiftlet

HA Router

• Overview — What HA adds for high availability.

Swiftlets

• High Availability Controller Swiftlet — High Availability Controller Swiftlet
• Queue Manager Swiftlet (HA) — High Availability Queue Manager
• Store Swiftlet (HA) — High Availability Store Swiftlet

Release Notes

See the Release Notes for changes in each version.