# event-based-banking-application/arya-banking-user-service architecture

> Architecture diagram of the GitHub repository event-based-banking-application/arya-banking-user-service, generated by GitDiagram from its file tree, README and a sample of source files (last updated 2026-10-03). It is an AI-made overview: check details against the source.

- Interactive diagram: https://gitdiagram.com/event-based-banking-application/arya-banking-user-service
- Repository: https://github.com/event-based-banking-application/arya-banking-user-service

## Overview

Arya Banking User Service is a user-domain microservice for multi-step registration, profile updates, security tracking, and Keycloak identity synchronization. The main flow accepts registration or profile requests through controllers, applies user-service logic, persists user and registration state, and provisions an identity with the auth service. Security updates have separate HTTP and event-listener entry points. Registration progress and user-update events are represented through an outbox. The excerpts show service and repository interactions, but not the full event publication mechanism or all configuration wiring.

Main entry points: [`src/main/java/org/arya/banking/user/service/impl/UserServiceImpl.java`](https://github.com/event-based-banking-application/arya-banking-user-service/blob/master/src/main/java/org/arya/banking/user/service/impl/UserServiceImpl.java) (User service), [`src/main/java/org/arya/banking/user/util/UserValidator.java`](https://github.com/event-based-banking-application/arya-banking-user-service/blob/master/src/main/java/org/arya/banking/user/util/UserValidator.java) (Registration validator), [`src/main/java/org/arya/banking/user/service/impl/SecurityDetailsServiceImpl.java`](https://github.com/event-based-banking-application/arya-banking-user-service/blob/master/src/main/java/org/arya/banking/user/service/impl/SecurityDetailsServiceImpl.java) (Security service), [`src/main/java/org/arya/banking/user/controller/UserController.java`](https://github.com/event-based-banking-application/arya-banking-user-service/blob/master/src/main/java/org/arya/banking/user/controller/UserController.java) (User controller)

## Diagram (Mermaid)

```mermaid
flowchart TD

subgraph group_api["API entry points"]
  node_user_controller["User controller"]
  node_security_controller["Security controller"]
  node_internal_security_controller["Internal security API"]
  node_registration_input["Registration input<br/>[RegisterDto.java]"]
  node_profile_inputs["Profile inputs<br/>[UserUpdateDto.java]"]
  node_security_input["Security input"]
end

subgraph group_domain["User domain"]
  node_user_service["User service"]
  node_security_service["Security service"]
  node_validator["Registration validator<br/>[UserValidator.java]"]
  node_mapper["User mapper<br/>[UserMapper.java]"]
end

subgraph group_state["Persistence and events"]
  node_user_store[("User records")]
  node_progress_store[("Registration progress")]
  node_security_store[("Security details")]
  node_outbox_repo[("Outbox repository")]
  node_outbox_event["Outbox event"]
  node_event_type["Outbox event types"]
end

subgraph group_integrations["External integrations"]
  node_event_listener["Security event listener"]
  node_keycloak_client["Keycloak client"]
  node_auth_service{{"Auth service"}}
end

node_client(("API client"))
node_kafka["Kafka"]

node_client -->|"submits requests"| node_user_controller
node_client -->|"updates credentials"| node_security_controller
node_client -->|"updates internally"| node_internal_security_controller
node_user_controller -->|"delegates"| node_user_service
node_security_controller -->|"delegates"| node_security_service
node_internal_security_controller -->|"delegates"| node_security_service
node_user_controller -->|"accepts"| node_registration_input
node_user_controller -->|"accepts"| node_profile_inputs
node_security_controller -->|"accepts"| node_security_input
node_internal_security_controller -->|"accepts"| node_security_input
node_user_service -->|"reads and saves"| node_user_store
node_user_service -->|"maps registration"| node_mapper
node_user_service -->|"provisions identity"| node_keycloak_client
node_keycloak_client -->|"registers identity"| node_auth_service
node_user_service -->|"saves progress"| node_progress_store
node_user_service -->|"accesses security"| node_security_store
node_user_service -->|"updates registration"| node_validator
node_user_service -->|"records updates"| node_outbox_repo
node_security_service -->|"reads and saves"| node_security_store
node_security_service -->|"checks progress"| node_validator
node_validator -->|"reads and saves"| node_progress_store
node_validator -->|"stores event"| node_outbox_repo
node_outbox_repo -->|"persists"| node_outbox_event
node_validator -->|"sets event type"| node_event_type
node_kafka -.->|"delivers events"| node_event_listener
node_event_listener -->|"delegates updates"| node_security_service

click node_user_controller "https://github.com/event-based-banking-application/arya-banking-user-service/blob/master/src/main/java/org/arya/banking/user/controller/UserController.java"
click node_security_controller "https://github.com/event-based-banking-application/arya-banking-user-service/blob/master/src/main/java/org/arya/banking/user/controller/SecurityDetailsController.java"
click node_internal_security_controller "https://github.com/event-based-banking-application/arya-banking-user-service/blob/master/src/main/java/org/arya/banking/user/controller/InternalSecurityDetailsController.java"
click node_registration_input "https://github.com/event-based-banking-application/arya-banking-user-service/blob/master/src/main/java/org/arya/banking/user/dto/RegisterDto.java"
click node_profile_inputs "https://github.com/event-based-banking-application/arya-banking-user-service/blob/master/src/main/java/org/arya/banking/user/dto/UserUpdateDto.java"
click node_security_input "https://github.com/event-based-banking-application/arya-banking-user-service/blob/master/src/main/java/org/arya/banking/user/dto/UpdateSecurityDetailsDto.java"
click node_user_service "https://github.com/event-based-banking-application/arya-banking-user-service/blob/master/src/main/java/org/arya/banking/user/service/impl/UserServiceImpl.java"
click node_security_service "https://github.com/event-based-banking-application/arya-banking-user-service/blob/master/src/main/java/org/arya/banking/user/service/impl/SecurityDetailsServiceImpl.java"
click node_validator "https://github.com/event-based-banking-application/arya-banking-user-service/blob/master/src/main/java/org/arya/banking/user/util/UserValidator.java"
click node_mapper "https://github.com/event-based-banking-application/arya-banking-user-service/blob/master/src/main/java/org/arya/banking/user/mapper/UserMapper.java"
click node_user_store "https://github.com/event-based-banking-application/arya-banking-user-service/blob/master/src/main/java/org/arya/banking/user/repository/UserRepository.java"
click node_progress_store "https://github.com/event-based-banking-application/arya-banking-user-service/blob/master/src/main/java/org/arya/banking/user/repository/RegistrationProgressRepository.java"
click node_security_store "https://github.com/event-based-banking-application/arya-banking-user-service/blob/master/src/main/java/org/arya/banking/user/repository/SecurityDetailsRepository.java"
click node_outbox_repo "https://github.com/event-based-banking-application/arya-banking-user-service/blob/master/src/main/java/org/arya/banking/user/repository/UserOutboxEventRepository.java"
click node_outbox_event "https://github.com/event-based-banking-application/arya-banking-user-service/blob/master/src/main/java/org/arya/banking/user/outbox/UserOutboxEvent.java"
click node_event_type "https://github.com/event-based-banking-application/arya-banking-user-service/blob/master/src/main/java/org/arya/banking/user/constants/UserOutboxEventType.java"
click node_event_listener "https://github.com/event-based-banking-application/arya-banking-user-service/blob/master/src/main/java/org/arya/banking/user/kafka/UserEventListeners.java"
click node_keycloak_client "https://github.com/event-based-banking-application/arya-banking-user-service/blob/master/src/main/java/org/arya/banking/user/external/KeyCloakService.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_user_controller,node_security_controller,node_internal_security_controller,node_registration_input,node_profile_inputs,node_security_input,node_client toneBlue
class node_user_service,node_security_service,node_validator,node_mapper toneAmber
class node_user_store,node_progress_store,node_security_store,node_outbox_repo,node_outbox_event,node_event_type toneMint
class node_event_listener,node_keycloak_client,node_auth_service toneRose
class node_kafka toneIndigo
```

## Components

### API entry points

- [User controller](https://github.com/event-based-banking-application/arya-banking-user-service/blob/master/src/main/java/org/arya/banking/user/controller/UserController.java): `src/main/java/org/arya/banking/user/controller/UserController.java`
- [Security controller](https://github.com/event-based-banking-application/arya-banking-user-service/blob/master/src/main/java/org/arya/banking/user/controller/SecurityDetailsController.java): `src/main/java/org/arya/banking/user/controller/SecurityDetailsController.java`
- [Internal security API](https://github.com/event-based-banking-application/arya-banking-user-service/blob/master/src/main/java/org/arya/banking/user/controller/InternalSecurityDetailsController.java): `src/main/java/org/arya/banking/user/controller/InternalSecurityDetailsController.java`
- [Registration input](https://github.com/event-based-banking-application/arya-banking-user-service/blob/master/src/main/java/org/arya/banking/user/dto/RegisterDto.java): `src/main/java/org/arya/banking/user/dto/RegisterDto.java`
- [Profile inputs](https://github.com/event-based-banking-application/arya-banking-user-service/blob/master/src/main/java/org/arya/banking/user/dto/UserUpdateDto.java): `src/main/java/org/arya/banking/user/dto/UserUpdateDto.java`
- [Security input](https://github.com/event-based-banking-application/arya-banking-user-service/blob/master/src/main/java/org/arya/banking/user/dto/UpdateSecurityDetailsDto.java): `src/main/java/org/arya/banking/user/dto/UpdateSecurityDetailsDto.java`

### User domain

- [User service](https://github.com/event-based-banking-application/arya-banking-user-service/blob/master/src/main/java/org/arya/banking/user/service/impl/UserServiceImpl.java): `src/main/java/org/arya/banking/user/service/impl/UserServiceImpl.java`
- [Security service](https://github.com/event-based-banking-application/arya-banking-user-service/blob/master/src/main/java/org/arya/banking/user/service/impl/SecurityDetailsServiceImpl.java): `src/main/java/org/arya/banking/user/service/impl/SecurityDetailsServiceImpl.java`
- [Registration validator](https://github.com/event-based-banking-application/arya-banking-user-service/blob/master/src/main/java/org/arya/banking/user/util/UserValidator.java): `src/main/java/org/arya/banking/user/util/UserValidator.java`
- [User mapper](https://github.com/event-based-banking-application/arya-banking-user-service/blob/master/src/main/java/org/arya/banking/user/mapper/UserMapper.java): `src/main/java/org/arya/banking/user/mapper/UserMapper.java`

### Persistence and events

- [User records](https://github.com/event-based-banking-application/arya-banking-user-service/blob/master/src/main/java/org/arya/banking/user/repository/UserRepository.java): `src/main/java/org/arya/banking/user/repository/UserRepository.java`
- [Registration progress](https://github.com/event-based-banking-application/arya-banking-user-service/blob/master/src/main/java/org/arya/banking/user/repository/RegistrationProgressRepository.java): `src/main/java/org/arya/banking/user/repository/RegistrationProgressRepository.java`
- [Security details](https://github.com/event-based-banking-application/arya-banking-user-service/blob/master/src/main/java/org/arya/banking/user/repository/SecurityDetailsRepository.java): `src/main/java/org/arya/banking/user/repository/SecurityDetailsRepository.java`
- [Outbox repository](https://github.com/event-based-banking-application/arya-banking-user-service/blob/master/src/main/java/org/arya/banking/user/repository/UserOutboxEventRepository.java): `src/main/java/org/arya/banking/user/repository/UserOutboxEventRepository.java`
- [Outbox event](https://github.com/event-based-banking-application/arya-banking-user-service/blob/master/src/main/java/org/arya/banking/user/outbox/UserOutboxEvent.java): `src/main/java/org/arya/banking/user/outbox/UserOutboxEvent.java`
- [Outbox event types](https://github.com/event-based-banking-application/arya-banking-user-service/blob/master/src/main/java/org/arya/banking/user/constants/UserOutboxEventType.java): `src/main/java/org/arya/banking/user/constants/UserOutboxEventType.java`

### External integrations

- [Security event listener](https://github.com/event-based-banking-application/arya-banking-user-service/blob/master/src/main/java/org/arya/banking/user/kafka/UserEventListeners.java): `src/main/java/org/arya/banking/user/kafka/UserEventListeners.java`
- [Keycloak client](https://github.com/event-based-banking-application/arya-banking-user-service/blob/master/src/main/java/org/arya/banking/user/external/KeyCloakService.java): `src/main/java/org/arya/banking/user/external/KeyCloakService.java`
- **Auth service**

### Other components

- **API client**
- **Kafka**

## Connections

- API client → User controller: submits requests (evidence: `src/main/java/org/arya/banking/user/controller/UserController.java`)
- API client → Security controller: updates credentials (evidence: `src/main/java/org/arya/banking/user/controller/SecurityDetailsController.java`)
- API client → Internal security API: updates internally (evidence: `src/main/java/org/arya/banking/user/controller/InternalSecurityDetailsController.java`)
- User controller → User service: delegates (evidence: `src/main/java/org/arya/banking/user/controller/UserController.java`)
- Security controller → Security service: delegates (evidence: `src/main/java/org/arya/banking/user/controller/SecurityDetailsController.java`)
- Internal security API → Security service: delegates (evidence: `src/main/java/org/arya/banking/user/controller/InternalSecurityDetailsController.java`)
- User controller → Registration input: accepts (evidence: `src/main/java/org/arya/banking/user/controller/UserController.java`)
- User controller → Profile inputs: accepts (evidence: `src/main/java/org/arya/banking/user/controller/UserController.java`)
- Security controller → Security input: accepts (evidence: `src/main/java/org/arya/banking/user/controller/SecurityDetailsController.java`)
- Internal security API → Security input: accepts (evidence: `src/main/java/org/arya/banking/user/controller/InternalSecurityDetailsController.java`)
- User service → User records: reads and saves (evidence: `src/main/java/org/arya/banking/user/service/impl/UserServiceImpl.java`)
- User service → User mapper: maps registration (evidence: `src/main/java/org/arya/banking/user/service/impl/UserServiceImpl.java`)
- User service → Keycloak client: provisions identity (evidence: `src/main/java/org/arya/banking/user/service/impl/UserServiceImpl.java`)
- Keycloak client → Auth service: registers identity (evidence: `src/main/java/org/arya/banking/user/external/KeyCloakService.java`)
- User service → Registration progress: saves progress (evidence: `src/main/java/org/arya/banking/user/service/impl/UserServiceImpl.java`)
- User service → Security details: accesses security (evidence: `src/main/java/org/arya/banking/user/service/impl/UserServiceImpl.java`)
- User service → Registration validator: updates registration (evidence: `src/main/java/org/arya/banking/user/service/impl/UserServiceImpl.java`)
- User service → Outbox repository: records updates (evidence: `src/main/java/org/arya/banking/user/service/impl/UserServiceImpl.java`)
- Security service → Security details: reads and saves (evidence: `src/main/java/org/arya/banking/user/service/impl/SecurityDetailsServiceImpl.java`)
- Security service → Registration validator: checks progress (evidence: `src/main/java/org/arya/banking/user/service/impl/SecurityDetailsServiceImpl.java`)
- Registration validator → Registration progress: reads and saves (evidence: `src/main/java/org/arya/banking/user/util/UserValidator.java`)
- Registration validator → Outbox repository: stores event (evidence: `src/main/java/org/arya/banking/user/util/UserValidator.java`)
- Outbox repository → Outbox event: persists (evidence: `src/main/java/org/arya/banking/user/repository/UserOutboxEventRepository.java`)
- Registration validator → Outbox event types: sets event type (evidence: `src/main/java/org/arya/banking/user/util/UserValidator.java`)
- Kafka → Security event listener: delivers events (evidence: `src/main/java/org/arya/banking/user/kafka/UserEventListeners.java`)
- Security event listener → Security service: delegates updates (evidence: `src/main/java/org/arya/banking/user/kafka/UserEventListeners.java`)
