# bertilmuth/requirementsascode architecture

> Architecture diagram of the GitHub repository bertilmuth/requirementsascode, generated by GitDiagram from its file tree, README and a sample of source files (last updated 2026-11-17). It is an AI-made overview: check details against the source.

- Interactive diagram: https://gitdiagram.com/bertilmuth/requirementsascode
- Repository: https://github.com/bertilmuth/requirementsascode

## Overview

Requirements as Code is a Java library for expressing message-handling behavior as models, then running that behavior either statelessly or as stateful actor use cases. The main workflow is to build a model of use cases, flows, and steps; dispatch incoming messages to eligible system reactions; and optionally publish results or route messages to another behavior. The repository also includes a FreeMarker model-to-text extractor and illustrative integrations. Edges reflect README statements or shown source/index references; unsampled subsystems are represented without speculative internal links.

Main entry points: [`requirementsascodecore/src/main/java/org/requirementsascode/Model.java`](https://github.com/bertilmuth/requirementsascode/blob/master/requirementsascodecore/src/main/java/org/requirementsascode/Model.java) (Model), [`requirementsascodecore/src/main/java/org/requirementsascode/ModelRunner.java`](https://github.com/bertilmuth/requirementsascode/blob/master/requirementsascodecore/src/main/java/org/requirementsascode/ModelRunner.java) (Model runner), [`requirementsascodeextract/src/main/java/org/requirementsascode/extract/freemarker/FreeMarkerEngine.java`](https://github.com/bertilmuth/requirementsascode/blob/master/requirementsascodeextract/src/main/java/org/requirementsascode/extract/freemarker/FreeMarkerEngine.java) (FreeMarker engine), [`requirementsascodecore/src/main/java/org/requirementsascode/Flow.java`](https://github.com/bertilmuth/requirementsascode/blob/master/requirementsascodecore/src/main/java/org/requirementsascode/Flow.java) (Flows)

## Diagram (Mermaid)

```mermaid
flowchart TD

subgraph group_modeling["Behavior modeling"]
  node_behavior_model["Behavior model<br/>[BehaviorModel.java]"]
  node_model["Model<br/>[Model.java]"]
  node_builder["Model builder<br/>[ModelBuilder.java]"]
  node_step_builder["Step builder<br/>[StepPart.java]"]
  node_use_case["Use cases<br/>[UseCase.java]"]
  node_flows["Flows<br/>[Flow.java]"]
  node_steps["Steps<br/>[Step.java]"]
  node_conditions["Conditions<br/>[Condition.java]"]
  node_flow_positions["Flow positions<br/>[FlowPosition.java]"]
end

subgraph group_runtime["Execution runtime"]
  node_behavior["Behavior port<br/>[Behavior.java]"]
  node_stateless["Stateless behavior"]
  node_actor["Actor<br/>[AbstractActor.java]"]
  node_runner["Model runner<br/>[ModelRunner.java]"]
  node_queue["Event queue<br/>[EventQueue.java]"]
end

subgraph group_examples["Application examples"]
  node_pizza_example["Pizza calculator"]
  node_hello_example["Hello World actor<br/>[HelloWorld06.java]"]
  node_credit_controller["Credit card controller"]
  node_aggregate["Card aggregate"]
  node_event_store[("Event store<br/>[EventStore.java]")]
end

subgraph group_extract["Model extraction"]
  node_extractor["FreeMarker engine"]
  node_template_methods["Template methods<br/>[FlowCondition.java]"]
  node_output["Text output"]
end

node_caller(("Calling code"))

node_caller -->|"sends messages"| node_behavior
node_behavior_model -->|"provides model"| node_model
node_builder -->|"builds model"| node_model
node_step_builder -->|"configures steps"| node_model
node_model -->|"contains"| node_use_case
node_use_case -->|"creates flows"| node_flows
node_flows -->|"selects steps"| node_steps
node_steps -->|"evaluates"| node_conditions
node_flows -->|"positions flow"| node_flow_positions
node_stateless -->|"runs model"| node_behavior_model
node_actor -->|"dispatches messages"| node_runner
node_actor -->|"loads model"| node_behavior_model
node_runner -->|"runs model"| node_model
node_runner -->|"selects reaction"| node_steps
node_runner -->|"routes message"| node_actor
node_pizza_example -->|"builds model"| node_model
node_hello_example -->|"builds model"| node_model
node_credit_controller -->|"invokes aggregate"| node_aggregate
node_credit_controller -->|"uses event store"| node_event_store
node_aggregate -->|"loads events"| node_event_store
node_extractor -->|"extracts model"| node_model
node_extractor -->|"registers methods"| node_template_methods
node_extractor -->|"writes text"| node_output

click node_behavior "https://github.com/bertilmuth/requirementsascode/blob/master/requirementsascodecore/src/main/java/org/requirementsascode/Behavior.java"
click node_stateless "https://github.com/bertilmuth/requirementsascode/blob/master/requirementsascodecore/src/main/java/org/requirementsascode/StatelessBehavior.java"
click node_behavior_model "https://github.com/bertilmuth/requirementsascode/blob/master/requirementsascodecore/src/main/java/org/requirementsascode/BehaviorModel.java"
click node_model "https://github.com/bertilmuth/requirementsascode/blob/master/requirementsascodecore/src/main/java/org/requirementsascode/Model.java"
click node_builder "https://github.com/bertilmuth/requirementsascode/blob/master/requirementsascodecore/src/main/java/org/requirementsascode/builder/ModelBuilder.java"
click node_step_builder "https://github.com/bertilmuth/requirementsascode/blob/master/requirementsascodecore/src/main/java/org/requirementsascode/builder/StepPart.java"
click node_use_case "https://github.com/bertilmuth/requirementsascode/blob/master/requirementsascodecore/src/main/java/org/requirementsascode/UseCase.java"
click node_flows "https://github.com/bertilmuth/requirementsascode/blob/master/requirementsascodecore/src/main/java/org/requirementsascode/Flow.java"
click node_steps "https://github.com/bertilmuth/requirementsascode/blob/master/requirementsascodecore/src/main/java/org/requirementsascode/Step.java"
click node_conditions "https://github.com/bertilmuth/requirementsascode/blob/master/requirementsascodecore/src/main/java/org/requirementsascode/Condition.java"
click node_flow_positions "https://github.com/bertilmuth/requirementsascode/blob/master/requirementsascodecore/src/main/java/org/requirementsascode/flowposition/FlowPosition.java"
click node_actor "https://github.com/bertilmuth/requirementsascode/blob/master/requirementsascodecore/src/main/java/org/requirementsascode/AbstractActor.java"
click node_runner "https://github.com/bertilmuth/requirementsascode/blob/master/requirementsascodecore/src/main/java/org/requirementsascode/ModelRunner.java"
click node_queue "https://github.com/bertilmuth/requirementsascode/blob/master/requirementsascodecore/src/main/java/org/requirementsascode/queue/EventQueue.java"
click node_pizza_example "https://github.com/bertilmuth/requirementsascode/blob/master/requirementsascodeexamples/pizzavolumecalculator/src/main/java/pizzavolumecalculator/actor/PizzaVolumeCalculator.java"
click node_hello_example "https://github.com/bertilmuth/requirementsascode/blob/master/requirementsascodeexamples/helloworld/src/main/java/helloworld/HelloWorld06.java"
click node_credit_controller "https://github.com/bertilmuth/requirementsascode/blob/master/requirementsascodeexamples/creditcard_eventsourcing/src/main/java/creditcard_eventsourcing/controller/CreditCardController.java"
click node_aggregate "https://github.com/bertilmuth/requirementsascode/blob/master/requirementsascodeexamples/creditcard_eventsourcing/src/main/java/creditcard_eventsourcing/model/CreditCardAggregateRoot.java"
click node_event_store "https://github.com/bertilmuth/requirementsascode/blob/master/requirementsascodeexamples/creditcard_eventsourcing/src/main/java/creditcard_eventsourcing/persistence/EventStore.java"
click node_extractor "https://github.com/bertilmuth/requirementsascode/blob/master/requirementsascodeextract/src/main/java/org/requirementsascode/extract/freemarker/FreeMarkerEngine.java"
click node_template_methods "https://github.com/bertilmuth/requirementsascode/blob/master/requirementsascodeextract/src/main/java/org/requirementsascode/extract/freemarker/methodmodel/FlowCondition.java"

classDef toneNeutral fill:#f8fafc,stroke:#334155,stroke-width:1.5px,color:#0f172a
classDef toneBlue fill:#dbeafe,stroke:#2563eb,stroke-width:1.5px,color:#172554
classDef toneAmber fill:#fef3c7,stroke:#d97706,stroke-width:1.5px,color:#78350f
classDef toneMint fill:#dcfce7,stroke:#16a34a,stroke-width:1.5px,color:#14532d
classDef toneRose fill:#ffe4e6,stroke:#e11d48,stroke-width:1.5px,color:#881337
classDef toneIndigo fill:#e0e7ff,stroke:#4f46e5,stroke-width:1.5px,color:#312e81
classDef toneTeal fill:#ccfbf1,stroke:#0f766e,stroke-width:1.5px,color:#134e4a
class node_behavior_model,node_model,node_builder,node_step_builder,node_use_case,node_flows,node_steps,node_conditions,node_flow_positions toneBlue
class node_behavior,node_stateless,node_actor,node_runner,node_queue toneAmber
class node_pizza_example,node_hello_example,node_credit_controller,node_aggregate,node_event_store toneMint
class node_extractor,node_template_methods,node_output toneRose
class node_caller toneIndigo
```

## Components

### Behavior modeling

- [Behavior model](https://github.com/bertilmuth/requirementsascode/blob/master/requirementsascodecore/src/main/java/org/requirementsascode/BehaviorModel.java): `requirementsascodecore/src/main/java/org/requirementsascode/BehaviorModel.java`
- [Model](https://github.com/bertilmuth/requirementsascode/blob/master/requirementsascodecore/src/main/java/org/requirementsascode/Model.java): `requirementsascodecore/src/main/java/org/requirementsascode/Model.java`
- [Model builder](https://github.com/bertilmuth/requirementsascode/blob/master/requirementsascodecore/src/main/java/org/requirementsascode/builder/ModelBuilder.java): `requirementsascodecore/src/main/java/org/requirementsascode/builder/ModelBuilder.java`
- [Step builder](https://github.com/bertilmuth/requirementsascode/blob/master/requirementsascodecore/src/main/java/org/requirementsascode/builder/StepPart.java): `requirementsascodecore/src/main/java/org/requirementsascode/builder/StepPart.java`
- [Use cases](https://github.com/bertilmuth/requirementsascode/blob/master/requirementsascodecore/src/main/java/org/requirementsascode/UseCase.java): `requirementsascodecore/src/main/java/org/requirementsascode/UseCase.java`
- [Flows](https://github.com/bertilmuth/requirementsascode/blob/master/requirementsascodecore/src/main/java/org/requirementsascode/Flow.java): `requirementsascodecore/src/main/java/org/requirementsascode/Flow.java`
- [Steps](https://github.com/bertilmuth/requirementsascode/blob/master/requirementsascodecore/src/main/java/org/requirementsascode/Step.java): `requirementsascodecore/src/main/java/org/requirementsascode/Step.java`
- [Conditions](https://github.com/bertilmuth/requirementsascode/blob/master/requirementsascodecore/src/main/java/org/requirementsascode/Condition.java): `requirementsascodecore/src/main/java/org/requirementsascode/Condition.java`
- [Flow positions](https://github.com/bertilmuth/requirementsascode/blob/master/requirementsascodecore/src/main/java/org/requirementsascode/flowposition/FlowPosition.java): `requirementsascodecore/src/main/java/org/requirementsascode/flowposition/FlowPosition.java`

### Execution runtime

- [Behavior port](https://github.com/bertilmuth/requirementsascode/blob/master/requirementsascodecore/src/main/java/org/requirementsascode/Behavior.java): `requirementsascodecore/src/main/java/org/requirementsascode/Behavior.java`
- [Stateless behavior](https://github.com/bertilmuth/requirementsascode/blob/master/requirementsascodecore/src/main/java/org/requirementsascode/StatelessBehavior.java): `requirementsascodecore/src/main/java/org/requirementsascode/StatelessBehavior.java`
- [Actor](https://github.com/bertilmuth/requirementsascode/blob/master/requirementsascodecore/src/main/java/org/requirementsascode/AbstractActor.java): `requirementsascodecore/src/main/java/org/requirementsascode/AbstractActor.java`
- [Model runner](https://github.com/bertilmuth/requirementsascode/blob/master/requirementsascodecore/src/main/java/org/requirementsascode/ModelRunner.java): `requirementsascodecore/src/main/java/org/requirementsascode/ModelRunner.java`
- [Event queue](https://github.com/bertilmuth/requirementsascode/blob/master/requirementsascodecore/src/main/java/org/requirementsascode/queue/EventQueue.java): `requirementsascodecore/src/main/java/org/requirementsascode/queue/EventQueue.java`

### Application examples

- [Pizza calculator](https://github.com/bertilmuth/requirementsascode/blob/master/requirementsascodeexamples/pizzavolumecalculator/src/main/java/pizzavolumecalculator/actor/PizzaVolumeCalculator.java): `requirementsascodeexamples/pizzavolumecalculator/src/main/java/pizzavolumecalculator/actor/PizzaVolumeCalculator.java`
- [Hello World actor](https://github.com/bertilmuth/requirementsascode/blob/master/requirementsascodeexamples/helloworld/src/main/java/helloworld/HelloWorld06.java): `requirementsascodeexamples/helloworld/src/main/java/helloworld/HelloWorld06.java`
- [Credit card controller](https://github.com/bertilmuth/requirementsascode/blob/master/requirementsascodeexamples/creditcard_eventsourcing/src/main/java/creditcard_eventsourcing/controller/CreditCardController.java): `requirementsascodeexamples/creditcard_eventsourcing/src/main/java/creditcard_eventsourcing/controller/CreditCardController.java`
- [Card aggregate](https://github.com/bertilmuth/requirementsascode/blob/master/requirementsascodeexamples/creditcard_eventsourcing/src/main/java/creditcard_eventsourcing/model/CreditCardAggregateRoot.java): `requirementsascodeexamples/creditcard_eventsourcing/src/main/java/creditcard_eventsourcing/model/CreditCardAggregateRoot.java`
- [Event store](https://github.com/bertilmuth/requirementsascode/blob/master/requirementsascodeexamples/creditcard_eventsourcing/src/main/java/creditcard_eventsourcing/persistence/EventStore.java): `requirementsascodeexamples/creditcard_eventsourcing/src/main/java/creditcard_eventsourcing/persistence/EventStore.java`

### Model extraction

- [FreeMarker engine](https://github.com/bertilmuth/requirementsascode/blob/master/requirementsascodeextract/src/main/java/org/requirementsascode/extract/freemarker/FreeMarkerEngine.java): `requirementsascodeextract/src/main/java/org/requirementsascode/extract/freemarker/FreeMarkerEngine.java`
- [Template methods](https://github.com/bertilmuth/requirementsascode/blob/master/requirementsascodeextract/src/main/java/org/requirementsascode/extract/freemarker/methodmodel/FlowCondition.java): `requirementsascodeextract/src/main/java/org/requirementsascode/extract/freemarker/methodmodel/FlowCondition.java`
- **Text output**

### Other components

- **Calling code**

## Connections

- Calling code → Behavior port: sends messages
- Behavior model → Model: provides model
- Model builder → Model: builds model (evidence: `requirementsascodecore/src/main/java/org/requirementsascode/Model.java`)
- Step builder → Model: configures steps (evidence: `requirementsascodecore/src/main/java/org/requirementsascode/builder/StepPart.java`)
- Model → Use cases: contains (evidence: `requirementsascodecore/src/main/java/org/requirementsascode/Model.java`)
- Use cases → Flows: creates flows (evidence: `requirementsascodecore/src/main/java/org/requirementsascode/UseCase.java`)
- Flows → Steps: selects steps (evidence: `requirementsascodecore/src/main/java/org/requirementsascode/Flow.java`)
- Steps → Conditions: evaluates (evidence: `requirementsascodecore/src/main/java/org/requirementsascode/Step.java`)
- Flows → Flow positions: positions flow (evidence: `requirementsascodecore/src/main/java/org/requirementsascode/Flow.java`)
- Stateless behavior → Behavior model: runs model
- Actor → Model runner: dispatches messages (evidence: `requirementsascodecore/src/main/java/org/requirementsascode/AbstractActor.java`)
- Actor → Behavior model: loads model (evidence: `requirementsascodecore/src/main/java/org/requirementsascode/AbstractActor.java`)
- Model runner → Model: runs model (evidence: `requirementsascodecore/src/main/java/org/requirementsascode/ModelRunner.java`)
- Model runner → Steps: selects reaction (evidence: `requirementsascodecore/src/main/java/org/requirementsascode/ModelRunner.java`)
- Model runner → Actor: routes message (evidence: `requirementsascodecore/src/main/java/org/requirementsascode/ModelRunner.java`)
- Pizza calculator → Model: builds model (evidence: `requirementsascodeexamples/pizzavolumecalculator/src/main/java/pizzavolumecalculator/actor/PizzaVolumeCalculator.java`)
- Hello World actor → Model: builds model (evidence: `requirementsascodeexamples/helloworld/src/main/java/helloworld/HelloWorld06.java`)
- Credit card controller → Card aggregate: invokes aggregate (evidence: `requirementsascodeexamples/creditcard_eventsourcing/src/main/java/creditcard_eventsourcing/controller/CreditCardController.java`)
- Credit card controller → Event store: uses event store (evidence: `requirementsascodeexamples/creditcard_eventsourcing/src/main/java/creditcard_eventsourcing/controller/CreditCardController.java`)
- Card aggregate → Event store: loads events (evidence: `requirementsascodeexamples/creditcard_eventsourcing/src/main/java/creditcard_eventsourcing/model/CreditCardAggregateRoot.java`)
- FreeMarker engine → Model: extracts model (evidence: `requirementsascodeextract/src/main/java/org/requirementsascode/extract/freemarker/FreeMarkerEngine.java`)
- FreeMarker engine → Template methods: registers methods (evidence: `requirementsascodeextract/src/main/java/org/requirementsascode/extract/freemarker/FreeMarkerEngine.java`)
- FreeMarker engine → Text output: writes text (evidence: `requirementsascodeextract/src/main/java/org/requirementsascode/extract/freemarker/FreeMarkerEngine.java`)
