# opensourcebim/bimserver architecture

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

- Interactive diagram: https://gitdiagram.com/opensourcebim/bimserver
- Repository: https://github.com/opensourcebim/bimserver

## Overview

BIMserver is an IFC model database for construction projects, not a conventional file server. The principal workflow is to submit IFC data, store it as model objects and revisions, then query or merge it and generate IFC output; users can also receive update notifications. The graph retains documented versioning, project structure, model checking, and plugin-query capabilities. Source excerpts are limited, so several documented product-level relationships cite the README; unsampled internal wiring is not asserted.

Main entry points: [`PluginBase/src/org/bimserver/emf/IfcModelInterface.java`](https://github.com/opensourcebim/bimserver/blob/master/PluginBase/src/org/bimserver/emf/IfcModelInterface.java) (IFC object model), [`BimServer/src/org/bimserver/BimServer.java`](https://github.com/opensourcebim/bimserver/blob/master/BimServer/src/org/bimserver/BimServer.java) (BIMserver runtime), [`BimServer/src/org/bimserver/database/DatabaseSession.java`](https://github.com/opensourcebim/bimserver/blob/master/BimServer/src/org/bimserver/database/DatabaseSession.java) (Database sessions), [`BimServer/src/org/bimserver/database/actions/DownloadByNewJsonQueryDatabaseAction.java`](https://github.com/opensourcebim/bimserver/blob/master/BimServer/src/org/bimserver/database/actions/DownloadByNewJsonQueryDatabaseAction.java) (Query downloads)

## Diagram (Mermaid)

```mermaid
flowchart TD

subgraph group_access["Access and services"]
  node_server["BIMserver runtime<br/>[BimServer.java]"]
  node_service_api["Service interface"]
  node_client["Client library"]
end

subgraph group_models["IFC model lifecycle"]
  node_ifc_submission["IFC submission"]
  node_model["IFC object model"]
  node_revisions["Revisions and projects"]
  node_model_checking["Model checking"]
  node_merging["Model merging"]
  node_ifc_output["IFC output"]
end

subgraph group_data["Persistence and queries"]
  node_database_session["Database sessions"]
  node_database[("IFC database<br/>[BimDatabase.java]")]
  node_query_actions["Query downloads"]
end

subgraph group_extensions["Extensions and updates"]
  node_query_engine["Query engine plugin<br/>[QueryEngine.java]"]
  node_plugin_manager["Plugin management"]
  node_notifications["Update notifications"]
end

node_users(("Project users"))

node_users -->|"use"| node_server
node_client -.->|"accesses"| node_service_api
node_server -->|"accepts check-ins"| node_ifc_submission
node_ifc_submission -->|"creates IFC objects"| node_model
node_model -->|"supports versioning"| node_revisions
node_model -->|"supports checking"| node_model_checking
node_model -->|"supports merging"| node_merging
node_revisions -->|"generates IFC"| node_ifc_output
node_server -.->|"manages model data"| node_database_session
node_database_session -.->|"reads and writes"| node_database
node_query_actions -->|"queries through"| node_database_session
node_query_actions -->|"returns model data"| node_model
node_query_engine -->|"queries model"| node_model
node_plugin_manager -.->|"loads plugins"| node_query_engine
node_server -->|"publishes updates"| node_notifications
node_notifications -->|"notifies changes"| node_users

click node_server "https://github.com/opensourcebim/bimserver/blob/master/BimServer/src/org/bimserver/BimServer.java"
click node_service_api "https://github.com/opensourcebim/bimserver/blob/master/PluginBase/src/org/bimserver/shared/interfaces/ServiceInterface.java"
click node_client "https://github.com/opensourcebim/bimserver/blob/master/BimServerClientLib/src/org/bimserver/client/BimServerClient.java"
click node_ifc_submission "https://github.com/opensourcebim/bimserver/blob/master/BimServer/src/org/bimserver/database/actions/CheckinDatabaseAction.java"
click node_model "https://github.com/opensourcebim/bimserver/blob/master/PluginBase/src/org/bimserver/emf/IfcModelInterface.java"
click node_revisions "https://github.com/opensourcebim/bimserver/tree/master/BimServer/src/org/bimserver/database/actions"
click node_model_checking "https://github.com/opensourcebim/bimserver/tree/master/BimServer/src/org/bimserver/database/actions"
click node_merging "https://github.com/opensourcebim/bimserver/tree/master/BimServer/src/org/bimserver/database/actions"
click node_ifc_output "https://github.com/opensourcebim/bimserver/blob/master/BimServer/src/org/bimserver/database/actions/DownloadDatabaseAction.java"
click node_database_session "https://github.com/opensourcebim/bimserver/blob/master/BimServer/src/org/bimserver/database/DatabaseSession.java"
click node_database "https://github.com/opensourcebim/bimserver/blob/master/BimServer/src/org/bimserver/database/BimDatabase.java"
click node_query_actions "https://github.com/opensourcebim/bimserver/blob/master/BimServer/src/org/bimserver/database/actions/DownloadByNewJsonQueryDatabaseAction.java"
click node_query_engine "https://github.com/opensourcebim/bimserver/blob/master/PluginBase/src/org/bimserver/plugins/queryengine/QueryEngine.java"
click node_plugin_manager "https://github.com/opensourcebim/bimserver/blob/master/Shared/src/org/bimserver/plugins/PluginBundleManager.java"
click node_notifications "https://github.com/opensourcebim/bimserver/blob/master/BimServerClientLib/src/org/bimserver/client/notifications/NotificationsManager.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_server,node_service_api,node_client,node_users toneBlue
class node_ifc_submission,node_model,node_revisions,node_model_checking,node_merging,node_ifc_output toneAmber
class node_database_session,node_database,node_query_actions toneMint
class node_query_engine,node_plugin_manager,node_notifications toneRose
```

## Components

### Access and services

- [BIMserver runtime](https://github.com/opensourcebim/bimserver/blob/master/BimServer/src/org/bimserver/BimServer.java): `BimServer/src/org/bimserver/BimServer.java`
- [Service interface](https://github.com/opensourcebim/bimserver/blob/master/PluginBase/src/org/bimserver/shared/interfaces/ServiceInterface.java): `PluginBase/src/org/bimserver/shared/interfaces/ServiceInterface.java`
- [Client library](https://github.com/opensourcebim/bimserver/blob/master/BimServerClientLib/src/org/bimserver/client/BimServerClient.java): `BimServerClientLib/src/org/bimserver/client/BimServerClient.java`

### IFC model lifecycle

- [IFC submission](https://github.com/opensourcebim/bimserver/blob/master/BimServer/src/org/bimserver/database/actions/CheckinDatabaseAction.java): `BimServer/src/org/bimserver/database/actions/CheckinDatabaseAction.java`
- [IFC object model](https://github.com/opensourcebim/bimserver/blob/master/PluginBase/src/org/bimserver/emf/IfcModelInterface.java): `PluginBase/src/org/bimserver/emf/IfcModelInterface.java`
- [Revisions and projects](https://github.com/opensourcebim/bimserver/tree/master/BimServer/src/org/bimserver/database/actions): `BimServer/src/org/bimserver/database/actions`
- [Model checking](https://github.com/opensourcebim/bimserver/tree/master/BimServer/src/org/bimserver/database/actions): `BimServer/src/org/bimserver/database/actions`
- [Model merging](https://github.com/opensourcebim/bimserver/tree/master/BimServer/src/org/bimserver/database/actions): `BimServer/src/org/bimserver/database/actions`
- [IFC output](https://github.com/opensourcebim/bimserver/blob/master/BimServer/src/org/bimserver/database/actions/DownloadDatabaseAction.java): `BimServer/src/org/bimserver/database/actions/DownloadDatabaseAction.java`

### Persistence and queries

- [Database sessions](https://github.com/opensourcebim/bimserver/blob/master/BimServer/src/org/bimserver/database/DatabaseSession.java): `BimServer/src/org/bimserver/database/DatabaseSession.java`
- [IFC database](https://github.com/opensourcebim/bimserver/blob/master/BimServer/src/org/bimserver/database/BimDatabase.java): `BimServer/src/org/bimserver/database/BimDatabase.java`
- [Query downloads](https://github.com/opensourcebim/bimserver/blob/master/BimServer/src/org/bimserver/database/actions/DownloadByNewJsonQueryDatabaseAction.java): `BimServer/src/org/bimserver/database/actions/DownloadByNewJsonQueryDatabaseAction.java`

### Extensions and updates

- [Query engine plugin](https://github.com/opensourcebim/bimserver/blob/master/PluginBase/src/org/bimserver/plugins/queryengine/QueryEngine.java): `PluginBase/src/org/bimserver/plugins/queryengine/QueryEngine.java`
- [Plugin management](https://github.com/opensourcebim/bimserver/blob/master/Shared/src/org/bimserver/plugins/PluginBundleManager.java): `Shared/src/org/bimserver/plugins/PluginBundleManager.java`
- [Update notifications](https://github.com/opensourcebim/bimserver/blob/master/BimServerClientLib/src/org/bimserver/client/notifications/NotificationsManager.java): `BimServerClientLib/src/org/bimserver/client/notifications/NotificationsManager.java`

### Other components

- **Project users**

## Connections

- Project users → BIMserver runtime: use
- Client library → Service interface: accesses
- BIMserver runtime → IFC submission: accepts check-ins
- IFC submission → IFC object model: creates IFC objects
- IFC object model → Revisions and projects: supports versioning (evidence: `BimServer/src/org/bimserver/database/actions/DownloadByNewJsonQueryDatabaseAction.java`)
- IFC object model → Model checking: supports checking (evidence: `BimServer/src/org/bimserver/database/actions/DownloadByNewJsonQueryDatabaseAction.java`)
- IFC object model → Model merging: supports merging (evidence: `BimServer/src/org/bimserver/database/actions/DownloadByNewJsonQueryDatabaseAction.java`)
- Revisions and projects → IFC output: generates IFC (evidence: `BimServer/src/org/bimserver/database/actions/DownloadQueryDatabaseAction.java`)
- BIMserver runtime → Database sessions: manages model data (evidence: `BimServer/src/org/bimserver/BimServer.java`)
- Database sessions → IFC database: reads and writes
- Query downloads → Database sessions: queries through (evidence: `BimServer/src/org/bimserver/database/actions/DownloadByNewJsonQueryDatabaseAction.java`)
- Query downloads → IFC object model: returns model data (evidence: `BimServer/src/org/bimserver/database/actions/DownloadByNewJsonQueryDatabaseAction.java`)
- Query engine plugin → IFC object model: queries model (evidence: `PluginBase/src/org/bimserver/plugins/queryengine/QueryEngine.java`)
- Plugin management → Query engine plugin: loads plugins
- BIMserver runtime → Update notifications: publishes updates
- Update notifications → Project users: notifies changes
