# navikt/common-java-modules architecture

> Architecture diagram of the GitHub repository navikt/common-java-modules, generated by GitDiagram from its file tree, README and a sample of source files (last updated 2024-12-28). It is an AI-made overview: check details against the source.

- Interactive diagram: https://gitdiagram.com/navikt/common-java-modules
- Repository: https://github.com/navikt/common-java-modules

## Overview

##### Main Components

a. Core Module Groups:
- Authentication & Security (auth, sts, token-client)
- Messaging & Integration (kafka, rest)
- Logging & Monitoring (audit-log, log, metrics)
- Utility Modules (util, types, yaml, json)

b. Key Relationships:
- Dependencies between modules
- Integration points with external systems
- Authentication flows

**[External Systems Layer]**

- Azure AD
- TokenX
- Kafka Clusters
- Monitoring Systems (InfluxDB/Sensu)

**[Common Modules Layer]**

- Security & Auth Group
- auth (OIDC, filters)
- sts (token providers)
- token-client (Azure AD, TokenX)

- Integration Group
- kafka (producers, consumers)
- rest (clients, filters)
- cxf (SOAP services)

- Observability Group
- audit-log
- metrics
- log

- Core Utilities Group
- types
- util
- json
- yaml

**[Client Applications Layer]**

- NAIS Applications

##### Important Details

a. Version compatibility:
- Version 2 components
- Deprecated Version 1 components

b. Configuration points:
- Maven/Gradle integration
- Environment variables
- NAIS platform specifics

##### Implementation Notes

- Maintain hierarchy and grouping
- Keep related components close
- Use consistent spacing and alignment
- Clear labels and annotations

## Diagram (Mermaid)

```mermaid
graph TB
    %% External Systems Layer
    subgraph ExternalSystems
        AzureAD[Azure AD]:::external
        TokenX[TokenX]:::external
        Kafka[Kafka Clusters]:::external
        Monitoring[Monitoring Systems]:::external
    end

    %% Common Modules Layer
    subgraph CommonModules
        %% Security & Auth Group
        subgraph SecurityAuth
            Auth["OIDC & Filters"]:::security
            STS["Token Providers"]:::security
            TokenClient["Token Clients"]:::security
        end

        %% Integration Group
        subgraph Integration
            KafkaInt["Kafka Integration"]:::integration
            RestInt["REST Integration"]:::integration
            CXF["SOAP/CXF Services"]:::integration
        end

        %% Observability Group
        subgraph Observability
            AuditLog["Audit Logging"]:::observability
            Metrics["Metrics System"]:::observability
            Log["Logging Framework"]:::observability
        end

        %% Core Utilities Group
        subgraph CoreUtils
            Types["Type Definitions"]:::utility
            Util["Utility Functions"]:::utility
            Json["JSON Handling"]:::utility
            Yaml["YAML Processing"]:::utility
        end
    end

    %% Client Applications Layer
    subgraph ClientApps
        NAIS["NAIS Applications"]:::client
    end

    %% Relationships
    AzureAD --> Auth
    TokenX --> TokenClient
    Kafka --> KafkaInt
    Monitoring --> Metrics

    Auth --> STS
    STS --> TokenClient
    KafkaInt --> Log
    RestInt --> Log
    CXF --> Log

    AuditLog --> Log
    Metrics --> Log

    %% Core Utils Dependencies
    Json --> Types
    Yaml --> Types
    Util --> Types

    %% Client Integration
    NAIS --> Auth
    NAIS --> KafkaInt
    NAIS --> RestInt
    NAIS --> CXF

    %% Click Events
    click Auth "https://github.com/navikt/common-java-modules/tree/main/auth/src/main/java/no/nav/common/auth/oidc"
    click STS "https://github.com/navikt/common-java-modules/tree/main/sts/src/main/java/no/nav/common/sts"
    click TokenClient "https://github.com/navikt/common-java-modules/tree/main/token-client/src/main/java/no/nav/common/token_client"
    click KafkaInt "https://github.com/navikt/common-java-modules/tree/main/kafka/src/main/java/no/nav/common/kafka"
    click RestInt "https://github.com/navikt/common-java-modules/tree/main/rest/src/main/java/no/nav/common/rest"
    click CXF "https://github.com/navikt/common-java-modules/tree/main/cxf/src/main/java/no/nav/common/cxf"
    click AuditLog "https://github.com/navikt/common-java-modules/tree/main/audit-log/src/main/java/no/nav/common/audit_log"
    click Metrics "https://github.com/navikt/common-java-modules/tree/main/metrics/src/main/java/no/nav/common/metrics"
    click Log "https://github.com/navikt/common-java-modules/tree/main/log/src/main/java/no/nav/common/log"
    click Types "https://github.com/navikt/common-java-modules/tree/main/types/src/main/java/no/nav/common/types"
    click Util "https://github.com/navikt/common-java-modules/tree/main/util/src/main/java/no/nav/common/utils"
    click Json "https://github.com/navikt/common-java-modules/tree/main/json/src/main/java/no/nav/common/json"
    click Yaml "https://github.com/navikt/common-java-modules/tree/main/yaml/src/main/java/no/nav/common/yaml"

    %% Styling
    classDef external fill:#9370DB,stroke:#333,stroke-width:2px
    classDef security fill:#4682B4,stroke:#333,stroke-width:2px
    classDef integration fill:#3CB371,stroke:#333,stroke-width:2px
    classDef observability fill:#FFA500,stroke:#333,stroke-width:2px
    classDef utility fill:#A9A9A9,stroke:#333,stroke-width:2px
    classDef client fill:#4169E1,stroke:#333,stroke-width:2px

    %% Legend
    subgraph Legend
        L1[External Systems]:::external
        L2[Security & Auth]:::security
        L3[Integration]:::integration
        L4[Observability]:::observability
        L5[Utilities]:::utility
        L6[Client Apps]:::client
    end
```
