# oktadev/okta-java-kafka-example architecture

> Architecture diagram of the GitHub repository oktadev/okta-java-kafka-example, generated by GitDiagram from its file tree, README and a sample of source files (last updated 2025-09-22). It is an AI-made overview: check details against the source.

- Interactive diagram: https://gitdiagram.com/oktadev/okta-java-kafka-example
- Repository: https://github.com/oktadev/okta-java-kafka-example

## Overview

##### Project type and purpose
- This is a single-service, Spring Boot Java application that demonstrates how to secure an Apache Kafka–backed messaging flow with Okta OAuth2 authentication.
- It includes a REST controller (KafkaController) that produces messages to a Kafka topic and a consumer (MyTopicConsumer) that reads from that topic.

##### File structure
- Top-level files:
- pom.xml (Maven build)
- mvnw / mvnw.cmd / .mvn/wrapper (wrapper scripts)
- README.md, HELP.md, LICENSE
- src/main/java/com/okta/javakafka:
- JavaKafkaApplication.java – Spring Boot entry point
- configuration/ConsumerConfiguration.java & ProducerConfiguration.java – beans for KafkaTemplate and consumer factory
- controller/KafkaController.java – REST endpoints that call the Kafka producer
- consumer/MyTopicConsumer.java – @KafkaListener that handles incoming messages
- src/main/resources/application.properties – holds Okta and Kafka configuration
- src/test – contains a basic Spring Boot integration test

##### Key README insights
- The app uses Okta’s OAuth2 (via okta-spring-boot-starter) to secure endpoints.
- Produces and consumes messages on a local Kafka cluster.
- No separate frontend code; users interact via a browser against the REST endpoint.

##### Main components to capture
a. Browser (Client)
b. Okta Authorization Server (External Service)
c. Spring Boot Application
– Security Layer (OAuth2 filter)
– REST API (KafkaController)
– Kafka Producer (in KafkaController or via ProducerConfiguration)
– Kafka Consumer (MyTopicConsumer via ConsumerConfiguration)
d. Apache Kafka Cluster (Topic: e.g., “my-topic”)

##### Relationships & data flow
1. Browser → (OAuth2 login request) → Okta
2. Okta → (redirect + tokens) → Browser
3. Browser → (HTTP POST with Bearer token) → Spring Boot REST API
4. Spring Boot Producer → (message) → Kafka Topic
5. Kafka Topic → (message) → Spring Boot Consumer
6. Consumer → (process/log) → internal application

##### Architectural patterns & principles
- Event‐driven, asynchronous messaging with Kafka
- Spring Boot auto‐configuration + dependency injection for producer/consumer beans
- OAuth2 Resource Server pattern for securing REST endpoints
- Separation of concerns: Controller vs. Configuration vs. Consumer

##### Technologies & frameworks
- Java 8+
- Spring Boot
- Spring for Apache Kafka
- Okta Spring Boot Starter (OAuth2 client & resource server)
- Maven for build

## Diagram (Mermaid)

```mermaid
flowchart TD
    classDef external fill:#e0e0e0,stroke:#333,stroke-width:1px;
    classDef app fill:#cce5ff,stroke:#333,stroke-width:1px;
    classDef broker fill:#ffeb99,stroke:#333,stroke-width:1px;
    classDef build fill:#d5cbe8,stroke:#333,stroke-width:1px;

    Browser["Browser (Client)"]:::external
    Okta["Okta Authorization Server"]:::external

    subgraph "Spring Boot Application"
        Entry["JavaKafkaApplication"]:::app
        Sec["Security Layer\n(OAuth2 Filter)"]:::app
        API["REST API\n(KafkaController)"]:::app
        ProdConf["ProducerConfiguration"]:::app
        ConsConf["ConsumerConfiguration"]:::app
        Consumer["MyTopicConsumer"]:::app
    end

    Kafka["Apache Kafka Cluster\ntopic: my-topic"]:::broker
    pom["pom.xml"]:::build

    Browser -->|"OAuth2 login request"| Okta
    Okta -->|"redirect + tokens"| Browser
    Browser -->|"HTTP POST with Bearer token"| API
    API -->|"produce message"| ProdConf
    ProdConf -->|"KafkaTemplate sends message"| Kafka
    Kafka -->|"message on my-topic"| Consumer
    Consumer -->|"process/log"| Entry
    pom -->|"build config"| Entry

    click Entry "https://github.com/oktadev/okta-java-kafka-example/blob/master/src/main/java/com/okta/javakafka/JavaKafkaApplication.java"
    click Sec "https://github.com/oktadev/okta-java-kafka-example/blob/master/src/main/resources/application.properties"
    click API "https://github.com/oktadev/okta-java-kafka-example/blob/master/src/main/java/com/okta/javakafka/controller/KafkaController.java"
    click ProdConf "https://github.com/oktadev/okta-java-kafka-example/blob/master/src/main/java/com/okta/javakafka/configuration/ProducerConfiguration.java"
    click ConsConf "https://github.com/oktadev/okta-java-kafka-example/blob/master/src/main/java/com/okta/javakafka/configuration/ConsumerConfiguration.java"
    click Consumer "https://github.com/oktadev/okta-java-kafka-example/blob/master/src/main/java/com/okta/javakafka/consumer/MyTopicConsumer.java"
    click pom "https://github.com/oktadev/okta-java-kafka-example/blob/master/pom.xml"
```
