# igniterealtime/openfire architecture

> Architecture diagram of the GitHub repository igniterealtime/openfire, generated by GitDiagram from its file tree, README and a sample of source files (last updated 2025-05-12). It is an AI-made overview: check details against the source.

- Interactive diagram: https://gitdiagram.com/igniterealtime/openfire
- Repository: https://github.com/igniterealtime/openfire

## Overview

##### Project Type and Purpose
- Openfire is a Java‐based XMPP (Jabber) server implementing real‐time collaboration (RTC) services.
- Core functionality is in the `xmppserver` Maven module; other modules handle distribution, installers, internationalization, plugins, and startup wrappers.

##### High-Level Architectural Components
a. Clients & External Interfaces
- XMPP Clients (TCP port 5222, TLS 5223)
- Server-to-Server XMPP (S2S) connections (port 5269)
- HTTP-Bind (BOSH) endpoint (default port 7070)
- WebSocket endpoint (default port 7443)
- Admin Console (HTTP on 9090, HTTPS on 9091)
b. Transport & Connection Layer
- Netty‐based NIO (`xmppserver/src/main/java/.../nio`) for handling TCP, TLS, and WebSocket connections
- Traditional blocking I/O for older connectors (in `net` package)
c. XMPP Core
- Session management (ClientSession, ServerSession, ComponentSession)
- Packet routing: IQRouter, MessageRouter, PresenceRouter
- Handlers for stanzas (`handler`, `http`, `websocket`, `bosh` managers)
- Authentication/Authorization (pluggable providers in `auth`, `user`, `group`, `crowd`)
- Plugins system (dynamic loading via PluginManager in `container`)
d. Persistence & Database
- Database abstraction layer (`database` package) and upgrade scripts under `distribution/src/database`
- Offline message store, archiving, pubsub persistence providers
e. Supporting Services
- Clustering (`cluster` package) for multi-node deployments
- Audit and statistics (`audit`, `stats`)
- Security (keystore/truststore management under `keystore`)
- File transfer proxy, media proxy, message‐carbons, pubsub, MUC (chat rooms)

##### Data Flow & Interactions
1. XMPP Client opens a TCP/TLS or WebSocket/BOSH connection → Netty/HTTPBindManager
2. Connection goes to ConnectionManager → Session created (ClientSession or HttpSession)
3. Incoming stanzas (XML) parsed by XMPPParser (XMLLightweightParser/XMPPPacketReader)
4. Packet delivered to PacketRouter → directed to appropriate handler:
- IQ handlers (IQBindHandler, IQRegisterHandler, etc.)
- Presence handlers
- Message handlers → possible offline storage or direct deliver via PacketDeliverer
5. Authentication handled via AuthProvider → user credentials validated (JDBC, LDAP, native)
6. Authorization via AuthorizationManager (ACLs, group-based policies)
7. Messages routed to other sessions or remote servers via RemoteConnectionManager → S2S
8. Plugins may intercept or extend behavior via PacketInterceptor/InterceptorManager
9. All state changes and metrics persisted in DB via DbConnectionManager

##### Showing XMPP to “new URL” (HTTP/WebSocket) Connections
- HTTP/WebSocket endpoints feeding into the same ConnectionManager but via `HttpBindManager` and `WebSocketClientConnectionHandler` respectively.
- Conversion from HTTP payloads → XMPP stanzas, then follow the core packet routing path.

##### Architectural Patterns & Principles
- Modular Maven multi‐module layout (core, distribution, plugins, i18n, starter)
- SPI‐based extensibility for auth, user/group providers, persistence, cache strategies
- Event‐driven design: event listeners/dispatchers for clustering, session events, user events
- Pluggable protocol endpoints: raw TCP, BOSH (servlet), WebSocket (Netty)
- Dependency injection via provider mappers and factory classes

## Diagram (Mermaid)

```mermaid
graph TB
    %% External Clients
    subgraph "External Clients" 
        direction TB
        XMPPClient["XMPP Client\n(TCP 5222 / TLS 5223)"]:::external
        S2SClient["Server-to-Server\nXMPP (S2S) 5269"]:::external
        Browser["Web Browser"]:::external
        HTTPClient["HTTP Client"]:::external
    end

    %% Transport Layer
    subgraph "Transport Layer" 
        direction TB
        Netty["Netty NIO"]:::transport
        Netty -->|"TCP/TLS/WebSocket"| ConnectionManager
        click Netty "https://github.com/igniterealtime/openfire/tree/main/xmppserver/src/main/java/org/jivesoftware/openfire/nio"
        BlockingIO["Blocking I/O"]:::transport
        click BlockingIO "https://github.com/igniterealtime/openfire/tree/main/xmppserver/src/main/java/org/jivesoftware/openfire/net"
        HTTPBindMgr["HTTP-Bind (BOSH)"]:::transport
        click HTTPBindMgr "https://github.com/igniterealtime/openfire/blob/main/xmppserver/src/main/java/org/jivesoftware/openfire/http/HttpBindManager.java"
        HTTPBindServlet["HttpBindServlet"]:::transport
        click HTTPBindServlet "https://github.com/igniterealtime/openfire/blob/main/xmppserver/src/main/java/org/jivesoftware/openfire/http/HttpBindServlet.java"
        WebSocketServlet["WebSocket Servlet"]:::transport
        click WebSocketServlet "https://github.com/igniterealtime/openfire/blob/main/xmppserver/src/main/java/org/jivesoftware/openfire/websocket/OpenfireWebSocketServlet.java"
        WSHandler["WebSocket Handler"]:::transport
        click WSHandler "https://github.com/igniterealtime/openfire/blob/main/xmppserver/src/main/java/org/jivesoftware/openfire/websocket/WebSocketClientConnectionHandler.java"
    end

    %% Connection & Session Management
    subgraph "Connection & Session Management"
        direction TB
        ConnectionManager["ConnectionManager"]:::core
        click ConnectionManager "https://github.com/igniterealtime/openfire/blob/main/xmppserver/src/main/java/org/jivesoftware/openfire/ConnectionManager.java"
        Session["Session\n(Client/Server/Component)"]:::core
        click Session "https://github.com/igniterealtime/openfire/tree/main/xmppserver/src/main/java/org/jivesoftware/openfire/session"
    end

    %% Parsing
    subgraph "XMPP Parsing"
        direction TB
        Parser["XMLLightweightParser"]:::core
        click Parser "https://github.com/igniterealtime/openfire/blob/main/xmppserver/src/main/java/org/jivesoftware/openfire/nio/XMLLightweightParser.java"
        PacketReader["XMPPPacketReader"]:::core
        click PacketReader "https://github.com/igniterealtime/openfire/blob/main/xmppserver/src/main/java/org/dom4j/io/XMPPPacketReader.java"
    end

    %% Core Services
    subgraph "Core XMPP Services"
        direction TB
        PacketRouter["PacketRouter"]:::core
        click PacketRouter "https://github.com/igniterealtime/openfire/blob/main/xmppserver/src/main/java/org/jivesoftware/openfire/PacketRouter.java"
        IQRouter["IQRouter"]:::core
        click IQRouter "https://github.com/igniterealtime/openfire/blob/main/xmppserver/src/main/java/org/jivesoftware/openfire/IQRouter.java"
        MessageRouter["MessageRouter"]:::core
        click MessageRouter "https://github.com/igniterealtime/openfire/blob/main/xmppserver/src/main/java/org/jivesoftware/openfire/MessageRouter.java"
        PresenceRouter["PresenceRouter"]:::core
        click PresenceRouter "https://github.com/igniterealtime/openfire/blob/main/xmppserver/src/main/java/org/jivesoftware/openfire/PresenceRouter.java"
        AuthProv["AuthProvider / Factory"]:::core
        click AuthProv "https://github.com/igniterealtime/openfire/blob/main/xmppserver/src/main/java/org/jivesoftware/openfire/auth/AuthProvider.java"
        click AuthProv "https://github.com/igniterealtime/openfire/blob/main/xmppserver/src/main/java/org/jivesoftware/openfire/auth/AuthFactory.java"
        Authz["AuthorizationManager"]:::core
        click Authz "https://github.com/igniterealtime/openfire/blob/main/xmppserver/src/main/java/org/jivesoftware/openfire/auth/AuthorizationManager.java"
    end

    %% Plugins & Extensions
    subgraph "Plugins & Interceptor"
        direction TB
        PluginMgr["PluginManager"]:::plugin
        click PluginMgr "https://github.com/igniterealtime/openfire/blob/main/xmppserver/src/main/java/org/jivesoftware/openfire/container/PluginManager.java"
        PacketInterceptor["InterceptorManager"]:::plugin
        click PacketInterceptor "https://github.com/igniterealtime/openfire/blob/main/xmppserver/src/main/java/org/jivesoftware/openfire/interceptor/InterceptorManager.java"
    end

    %% Persistence & Database
    subgraph "Persistence & Database"
        direction TB
        DB["Database"]:::database
        DbMgr["DbConnectionManager"]:::database
        click DbMgr "https://github.com/igniterealtime/openfire/blob/main/xmppserver/src/main/java/org/jivesoftware/database/DbConnectionManager.java"
        Scripts["DB Scripts"]:::database
        click Scripts "https://github.com/igniterealtime/openfire/tree/main/distribution/src/database"
    end

    %% Supporting Services
    subgraph "Supporting Services"
        direction TB
        Cluster["ClusterManager"]:::support
        click Cluster "https://github.com/igniterealtime/openfire/blob/main/xmppserver/src/main/java/org/jivesoftware/openfire/cluster/ClusterManager.java"
        Audit["AuditManager"]:::support
        click Audit "https://github.com/igniterealtime/openfire/blob/main/xmppserver/src/main/java/org/jivesoftware/openfire/audit/AuditManager.java"
        Stats["StatisticsManager"]:::support
        click Stats "https://github.com/igniterealtime/openfire/blob/main/xmppserver/src/main/java/org/jivesoftware/openfire/stats/StatisticsManager.java"
        Keystore["CertificateStoreManager"]:::support
        click Keystore "https://github.com/igniterealtime/openfire/blob/main/xmppserver/src/main/java/org/jivesoftware/openfire/keystore/CertificateStoreManager.java"
        FileProxy["FileTransfer Proxy"]:::support
        click FileProxy "https://github.com/igniterealtime/openfire/blob/main/xmppserver/src/main/java/org/jivesoftware/openfire/filetransfer/proxy/DefaultProxyTransfer.java"
        PubSub["PubSub Persistence"]:::support
        click PubSub "https://github.com/igniterealtime/openfire/blob/main/xmppserver/src/main/java/org/jivesoftware/openfire/pubsub/DefaultPubSubPersistenceProvider.java"
        MUC["MUC Room"]:::support
        click MUC "https://github.com/igniterealtime/openfire/blob/main/xmppserver/src/main/java/org/jivesoftware/openfire/muc/MUCRoom.java"
        click MUC "https://github.com/igniterealtime/openfire/blob/main/xmppserver/src/main/java/org/jivesoftware/openfire/muc/spi/MUCPersistenceManager.java"
    end

    %% Data Flow
    XMPPClient -->|5222/TLS| Netty
    Browser -->|7070| HTTPBindMgr --> HTTPBindServlet --> ConnectionManager
    HTTPClient -->|7443| WebSocketServlet --> WSHandler --> ConnectionManager
    S2SClient -->|5269| Netty

    ConnectionManager -->|create| Session
    Session --> Parser
    Parser --> PacketReader
    PacketReader --> PacketRouter
    PacketRouter --> IQRouter
    PacketRouter --> MessageRouter
    PacketRouter --> PresenceRouter

    IQRouter --> AuthProv
    MessageRouter --> AuthProv
    PresenceRouter --> AuthProv

    AuthProv --> Authz
    PacketRouter --> PacketInterceptor
    PacketInterceptor --> PacketRouter

    PacketRouter -->|persist/store| DbMgr --> DB
    DbMgr --> Scripts

    PacketRouter -->|deliver| S2SClient

    PluginMgr --> PacketRouter

    Cluster --> PacketRouter
    Audit --> PacketRouter
    Stats --> PacketRouter
    Keystore --> ConnectionManager

    FileProxy --> PacketRouter
    PubSub --> PacketRouter
    MUC --> PacketRouter

    %% Styles
    classDef external fill:#ADD8E6,stroke:#000,stroke-width:1px
    classDef transport fill:#B0E0E6,stroke:#000,stroke-width:1px
    classDef core fill:#98FB98,stroke:#000,stroke-width:1px
    classDef database fill:#F0E68C,stroke:#000,stroke-width:1px
    classDef plugin fill:#FFD700,stroke:#000,stroke-width:1px
    classDef support fill:#FFE4B5,stroke:#000,stroke-width:1px
```
