{ "componentChunkName": "component---src-templates-doc-tsx", "path": "/docs/3.9.x/en/development/architecture-overview/", "result": {"data":{"navigation":{"nodes":[{"section":"Getting started","entries":[{"frontmatter":{"title":"Installation","subtitle":"Installation of scm-manager","partiallyActive":true},"fields":{"slug":"/docs/3.9.x/en/installation/"}},{"frontmatter":{"title":"First Startup","subtitle":"Administration User Creation","partiallyActive":null},"fields":{"slug":"/docs/3.9.x/en/first-startup/"}},{"frontmatter":{"title":"Migrate from v1 to v3","subtitle":"How to use the Migration-Wizard","partiallyActive":null},"fields":{"slug":"/docs/3.9.x/en/migrate-scm-manager-from-v1/"}},{"frontmatter":{"title":"Migrate from v2 to v3","subtitle":"Changes in the configuration","partiallyActive":null},"fields":{"slug":"/docs/3.9.x/en/migrate-scm-manager-from-v2/"}},{"frontmatter":{"title":"Import existing repositories","subtitle":"How to import existing repositories into SCM-Manager","partiallyActive":null},"fields":{"slug":"/docs/3.9.x/en/import/"}},{"frontmatter":{"title":"Frequently Asked Questions","subtitle":null,"partiallyActive":null},"fields":{"slug":"/docs/3.9.x/en/faq/"}},{"frontmatter":{"title":"Known Issues","subtitle":null,"partiallyActive":null},"fields":{"slug":"/docs/3.9.x/en/known-issues/"}}]},{"section":"User-oriented","entries":[{"frontmatter":{"title":"Repository","subtitle":null,"partiallyActive":true},"fields":{"slug":"/docs/3.9.x/en/user/repo/"}},{"frontmatter":{"title":"User","subtitle":null,"partiallyActive":true},"fields":{"slug":"/docs/3.9.x/en/user/user/"}},{"frontmatter":{"title":"Groups","subtitle":null,"partiallyActive":true},"fields":{"slug":"/docs/3.9.x/en/user/group/"}},{"frontmatter":{"title":"Administration","subtitle":null,"partiallyActive":true},"fields":{"slug":"/docs/3.9.x/en/user/admin/"}},{"frontmatter":{"title":"Profile","subtitle":null,"partiallyActive":true},"fields":{"slug":"/docs/3.9.x/en/user/profile/"}},{"frontmatter":{"title":"Notifications","subtitle":null,"partiallyActive":true},"fields":{"slug":"/docs/3.9.x/en/user/notification/"}},{"frontmatter":{"title":"CLI Client","subtitle":null,"partiallyActive":true},"fields":{"slug":"/docs/3.9.x/en/user/cli/"}},{"frontmatter":{"title":"Shortcuts","subtitle":null,"partiallyActive":null},"fields":{"slug":"/docs/3.9.x/en/user/shortcuts/"}}]},{"section":"Administration","entries":[{"frontmatter":{"title":"Base Directory","subtitle":null,"partiallyActive":null},"fields":{"slug":"/docs/3.9.x/en/administration/basedirectory/"}},{"frontmatter":{"title":"Logging","subtitle":"Configuration and locations of SCM-Manager logging","partiallyActive":null},"fields":{"slug":"/docs/3.9.x/en/administration/logging/"}},{"frontmatter":{"title":"SCM-Server Configuration","subtitle":"Various configuration options for the SCM-Server","partiallyActive":null},"fields":{"slug":"/docs/3.9.x/en/administration/scm-server/"}},{"frontmatter":{"title":"Reverse Proxy","subtitle":"How to use SCM-Manager with common reverse proxies","partiallyActive":null},"fields":{"slug":"/docs/3.9.x/en/administration/reverse-proxies/"}},{"frontmatter":{"title":"Caching for Working Directories","subtitle":null,"partiallyActive":null},"fields":{"slug":"/docs/3.9.x/en/administration/workdir_caching/"}}]},{"section":"Development","entries":[{"frontmatter":{"title":"Intellij IDEA Configuration","subtitle":null,"partiallyActive":null},"fields":{"slug":"/docs/3.9.x/en/development/intellij-idea-configuration/"}},{"frontmatter":{"title":"Building SCM-Manager from Source","subtitle":null,"partiallyActive":null},"fields":{"slug":"/docs/3.9.x/en/development/build-from-source/"}},{"frontmatter":{"title":"Architecture overview","subtitle":null,"partiallyActive":null},"fields":{"slug":"/docs/3.9.x/en/development/architecture-overview/"}},{"frontmatter":{"title":"Common pitfall occurred while developing the SCM V2","subtitle":null,"partiallyActive":null},"fields":{"slug":"/docs/3.9.x/en/development/ui-common-pitfall/"}},{"frontmatter":{"title":"Permission Concept","subtitle":"Fine-grained permission for SCM-Manager v2","partiallyActive":null},"fields":{"slug":"/docs/3.9.x/en/development/permission-concept/"}},{"frontmatter":{"title":"Decision Table","subtitle":null,"partiallyActive":null},"fields":{"slug":"/docs/3.9.x/en/development/decision-table/"}},{"frontmatter":{"title":"Error Handling","subtitle":null,"partiallyActive":null},"fields":{"slug":"/docs/3.9.x/en/development/error-handling/"}},{"frontmatter":{"title":"Styleguide","subtitle":null,"partiallyActive":null},"fields":{"slug":"/docs/3.9.x/en/development/styleguide/"}},{"frontmatter":{"title":"Testing Guide","subtitle":"Howto write tests for SCM-Manager","partiallyActive":null},"fields":{"slug":"/docs/3.9.x/en/development/testing-guide/"}},{"frontmatter":{"title":"Integration Tests","subtitle":"How to run integration tests","partiallyActive":null},"fields":{"slug":"/docs/3.9.x/en/development/integration-tests/"}},{"frontmatter":{"title":"UI-Extensions","subtitle":"How to extend the SCM-Manager UI with plugins","partiallyActive":null},"fields":{"slug":"/docs/3.9.x/en/development/ui-extensions/"}},{"frontmatter":{"title":"I18n","subtitle":"Howto do internationalization","partiallyActive":null},"fields":{"slug":"/docs/3.9.x/en/development/i18n/"}},{"frontmatter":{"title":"Building Forms","subtitle":"Howto build forms for SCM-Manager","partiallyActive":null},"fields":{"slug":"/docs/3.9.x/en/development/building-forms/"}},{"frontmatter":{"title":"Javadoc","subtitle":null,"partiallyActive":null},"fields":{"slug":"/docs/3.9.x/en/development/javadoc/"}},{"frontmatter":{"title":"CLI Guidelines","subtitle":null,"partiallyActive":null},"fields":{"slug":"/docs/3.9.x/en/development/cli-guideline/"}},{"frontmatter":{"title":"Definition of Done","subtitle":null,"partiallyActive":null},"fields":{"slug":"/docs/3.9.x/en/development/definition-of-done/"}},{"frontmatter":{"title":"DOD for UI development","subtitle":null,"partiallyActive":null},"fields":{"slug":"/docs/3.9.x/en/development/ui-dod/"}}]},{"section":"Plugin Development","entries":[{"frontmatter":{"title":"Create a plugin","subtitle":"Create a new SCM-Manager plugin","partiallyActive":null},"fields":{"slug":"/docs/3.9.x/en/development/plugins/create/"}},{"frontmatter":{"title":"Migrate a v1 plugin","subtitle":null,"partiallyActive":null},"fields":{"slug":"/docs/3.9.x/en/development/plugins/migrate-plugin-from-v1/"}},{"frontmatter":{"title":"Extension Points","subtitle":null,"partiallyActive":null},"fields":{"slug":"/docs/3.9.x/en/development/plugins/extension-points/"}},{"frontmatter":{"title":"i18n for Plugins","subtitle":null,"partiallyActive":null},"fields":{"slug":"/docs/3.9.x/en/development/plugins/i18n-for-plugins/"}},{"frontmatter":{"title":"Plugin Descriptor","subtitle":null,"partiallyActive":null},"fields":{"slug":"/docs/3.9.x/en/development/plugins/plugin-descriptor/"}},{"frontmatter":{"title":"SCM-Manager v2 Plugin Development","subtitle":null,"partiallyActive":null},"fields":{"slug":"/docs/3.9.x/en/development/plugins/plugin-development/"}},{"frontmatter":{"title":"Publish","subtitle":"Publish your Plugin","partiallyActive":null},"fields":{"slug":"/docs/3.9.x/en/development/plugins/publish/"}}]}]},"versions":{"group":[{"fieldValue":"1.0.x"},{"fieldValue":"1.x"},{"fieldValue":"2.0.x"},{"fieldValue":"2.1.x"},{"fieldValue":"2.10.x"},{"fieldValue":"2.11.x"},{"fieldValue":"2.12.x"},{"fieldValue":"2.13.x"},{"fieldValue":"2.14.x"},{"fieldValue":"2.15.x"},{"fieldValue":"2.16.x"},{"fieldValue":"2.17.x"},{"fieldValue":"2.18.x"},{"fieldValue":"2.19.x"},{"fieldValue":"2.2.x"},{"fieldValue":"2.20.x"},{"fieldValue":"2.21.x"},{"fieldValue":"2.22.x"},{"fieldValue":"2.23.x"},{"fieldValue":"2.24.x"},{"fieldValue":"2.25.x"},{"fieldValue":"2.26.x"},{"fieldValue":"2.27.x"},{"fieldValue":"2.28.x"},{"fieldValue":"2.29.x"},{"fieldValue":"2.3.x"},{"fieldValue":"2.30.x"},{"fieldValue":"2.31.x"},{"fieldValue":"2.32.x"},{"fieldValue":"2.33.x"},{"fieldValue":"2.34.x"},{"fieldValue":"2.35.x"},{"fieldValue":"2.36.x"},{"fieldValue":"2.37.x"},{"fieldValue":"2.38.x"},{"fieldValue":"2.39.x"},{"fieldValue":"2.4.x"},{"fieldValue":"2.40.x"},{"fieldValue":"2.41.x"},{"fieldValue":"2.42.x"},{"fieldValue":"2.43.x"},{"fieldValue":"2.44.x"},{"fieldValue":"2.45.x"},{"fieldValue":"2.46.x"},{"fieldValue":"2.47.x"},{"fieldValue":"2.48.x"},{"fieldValue":"2.5.x"},{"fieldValue":"2.6.x"},{"fieldValue":"2.7.x"},{"fieldValue":"2.8.x"},{"fieldValue":"2.9.x"},{"fieldValue":"3.0.x"},{"fieldValue":"3.1.x"},{"fieldValue":"3.10.x"},{"fieldValue":"3.11.x"},{"fieldValue":"3.2.x"},{"fieldValue":"3.3.x"},{"fieldValue":"3.4.x"},{"fieldValue":"3.5.x"},{"fieldValue":"3.6.x"},{"fieldValue":"3.7.x"},{"fieldValue":"3.8.x"},{"fieldValue":"3.9.x"}]},"languages":{"group":[{"fieldValue":"de"},{"fieldValue":"en"}]},"markdownRemark":{"html":"

Introduction

\n

This document does not describe the modules of SCM-Manager nor does it explain the technologies that are used.\nIt simply shows which application layers exist in the SCM-Manager and how they are connected.

\n

Technology stack

\n

Overview

\n

SCM-Manager is mainly written in Java and Typescript. In the chart below the core technologies are listed.\nSelf-written libraries like \"spotter\", our annotation processor or ui-components are not included in this overview.\nThey are kinda part of the product instead of own technologies/libraries.

\n

\"PlantUML\"

\n

\"PlantUML\"

\n

Integrations

\n

Internal and external integrations

\n

Integration is one main feature of SCM-Manager as we support different kinds of integrations to optimize workflows.\nThe important point is that integration should not be built directly to SCM-Manager core but most parts are outsourced to plugins.

\n

CI Integration Example

\n

As you can see besides the SCM-Manager core we have several plugins which manage the communication between each other and the external systems.\nTo prevent confusion it should be clarified that we actually have two different Jenkins plugins.\nThe first one which runs on the SCM-Manager server, and the second one named Jenkins-SCM-Manager-Plugin which is a Jenkins plugin.

\n

The following shows the general flow, where a Jenkins build is triggered by a change of a pull request and the result of\nthe build is sent back to the SCM-Manager:

\n
    \n
  1. The Review plugin notifies the Jenkins plugin as a new pull request was created.
    2. \n
  2. The Jenkins plugin sends a build notification to the Jenkins-SCM-Manager-Plugin which is installed on the Jenkins Server.
    3. \n
  3. The Jenkins-SCM-Manager-Plugin processes the build notification and creates a new build job for our pull request.
    4. \n
  4. As soon as the build is finished, the Jenkins-SCM-Manager-Plugin checks for the build result.
    5. \n
  5. The build result is reported to the CI plugin. This is required to show the CI status on the pull request in SCM-Manager.
    6. \n
  6. During the Jenkins build an external Sonar analysis was triggered.
    7. \n
  7. After the analysis is done, Sonar reports the results to the Sonar plugin.
    8. \n
  8. Finally, the Sonar plugin processes the analysis results and creates a related CI status via the CI plugin.
    9. \n
\n

\"PlantUML\"

\n

Front to Back

\n

Frontend

\n

SCM-Manager has a modern UI which is built with React.\nThe frontend is detached from the server and communicates mainly over REST requests with the SCM server.

\n

REST Layer

\n

The REST layer of SCM-Manager is built with maturity level 3\nand also uses HATEOAS. This means the data output can be enriched with links and embedded data.\nThe links are enriched based on the permissions the user has, and the functionality which is available.\nSCM-Manager uses this pattern to show the ui elements in the frontend based on which links exist on the data object.

\n

Service Layer

\n

The service layer is the middle part in the backend, so to speak.\nAfter the server receives a request, the REST layer invokes some kind of service.\nThe service layer consists largely of the business logic.

\n

Repository Command Layer

\n

One of the main services is the repository service. Underneath this special service the repository command api layer is located.\nThis service provides an abstract api that version control systems like Git, Mercurial and Subversion can implement.\nThe repository service gets initialized for a specific repository and uses the concrete command implementation for the repository type.\nA typical repository command can be given a specific request object if needed, which is built beforehand using the builder pattern.

\n

DAO Layer

\n

SCM-Manager provides a DAO (data access object) layer to persist data like users or the repository metadata.

\n

Store Layer

\n

For data persistence beneath the DAO layer, the store layer should be used.\nDifferent types of stores can persist data globally or repository specific.

\n

SQLite Persistence Layer

\n

SCM-Manager has introduced a dedicated SQLite persistence layer for specific metadata, including repository-specific data like pull requests\nand global or cross-repository data such as metadata used by plugins (e.g., the landing page plugin).\nThis new persistence approach addresses performance challenges inherent to XML storage, particularly for frequently changing or extensive data.\nSQLite was selected due to its performance benefits, cross-platform compatibility, and embedded usage without requiring a separate database server.

\n

The SQLite persistence layer maintains compatibility with existing SCM-Manager functionalities like data export/import,\nautomatic cleanup, and querying across multiple entries and repositories.\nIt also preserves simplicity in installation, usage, and plugin integration.

\n

Further details about the SQLite-based persistence layer and its architecture can be found in the SQLite Documentation.

\n

Examples

\n

Fetch all repositories

\n

One of the main pages in SCM-Manager is the repository overview.\nTo show all available repositories the following actions in frontend and backend are executed.

\n

\"PlantUML\"

\n

Create new branch

\n

Another core function of SCM-Manager is to create new branches using the Web UI.\nCreating a new branch over the SCM-Manager UI would lead to the following actions.\nThe SCM-Manager Subversion API does not support the branch and branches commands, so this feature is not available for Subversion repositories.

\n

\"PlantUML\"

","description":"Introduction This document does not describe the modules of SCM-Manager nor does it explain the technologies that are used.\nIt simply shows which application…","tableOfContents":"","frontmatter":{"title":"Architecture overview","subtitle":null,"displayToc":null,"description":null,"keywords":null,"image":null}}},"pageContext":{"slug":"/docs/3.9.x/en/development/architecture-overview/","version":"3.9.x","latestVersion":"3.11.x","latestPageVersion":"3.11.x","language":"en","relativePath":"/development/architecture-overview/","canonicalPath":"/docs/latest/en/development/architecture-overview/","latestRootPath":"/docs/3.11.x/en/"}}, "staticQueryHashes": ["1973669194","2742214048","2956773653","2957019495","698804963"]}