This page provides high-level overview of External System sub-system.
Table of contents
There are multiple project management systems (maven, gradle, sbt etc) and it's good to support them at the ide. Luckily, they all provide a similar set of facilities from the integration point of view:
- build ide project from external system config (pom.xml, build.gradle etc);
- provide a list of available tasks;
- allow to execute particular task;
That means that we can separate external system-specific logic and general ide processing. 'External system' sub-system provides simple api for wrapping external system and extensible ide-specific processing logic.
Project data domain
External system wrapper is required to be able to build project info on the basis of the given external system config. That information is built using in terms of DataNode, Key and ProjectEntityData.
Here DataNode class is just a holder for the target data (data type is defined by the Key). Multiple DataNode objects might be organized in directed graph where every edge identifies parent-child relation.
For example, simple one-module project might look as below:
The ide provides a set of built-in Key_s and _ProjectEntityData_s but any external system integration or third-party plugin developer might enhance project data by defining her own _Key and ProjectEntityData and storing them at a child of appropriate DataNode.
Managing project data
We need to process project data is built on external system config basis. Here comes ProjectDataService. It is a strategy which knows how to manage particular ProjectEntityData. For example, when we want to import a project from external model, we can start by the top level DataNode which references project info and then import its data using corresponding service.
Custom services can be defined via 'externalProjectDataService' extension.
The good thing is that we can separate project parsing and management here. That means that a set of DataNode, Key and ProjectDataServices can be introduced for particular technology and then every external system integration can build corresponding data if necessary using it.
Importing from external model
IntelliJ platform provides standard api for that. Namely, ProjectImportBuilder and ProjectImportProvider. There are two classes built on template method pattern - AbstractExternalProjectImportBuilder and AbstractExternalProjectImportProvider. They might be sub-classes and that concrete implementations should be registered at IoC descriptor (plugin.xml).
Here is an example from the gradle integration plugin:
It's possible to configure external system integration to automatically refresh project structure when external project's config file is modified. Basically, end-user should check corresponding box at external system settings for that:
Built-in support covers only root config files of linked external projects. However, there is a possible situation that particular external project has another config files which affect resulting project structure as well (for example, it might be a multi-project where every sub-project has its own config file). That's why it's possible to enhance that processing by making target external system implementation (ExternalSystemManager) implement ExternalSystemAutoImportAware. That allows to provide custom logic for mapping file modification events to the target external project affected by that.
Note: ExternalSystemAutoImportAware.getAffectedExternalProjectPath() is called quite often, that's why it's expected to return control as soon as possible. Helper CachingExternalSystemAutoImportAware class might be used for caching, i.e. ExternalSystemManager which implements ExternalSystemAutoImportAware can have a field like 'new CachingExternalSystemAutoImportAware(new MyExternalSystemAutoImportAware())' and delegate ExternalSystemAutoImportAware.getAffectedExternalProjectPath() calls to it.
The general idea is that all external system settings controls are represented by implementations of ExternalSettingsControl interface. There are also external system project-local settings and global external system settings. So, basically particular external system settings UI looks as below:
It's recommended to extend from AbstractExternalProjectSettingsControl for implementing project-level settings control as it already handles some of them.
Similar approach is used for providing 'import from external system' UI - implementation is expected to extended AbstractImportFromExternalSystemControl and it has not linked external projects list but target external project path control:
Using with 12.1.x IJ branch
Though main development is performed at the 'master' branch, there is a special 12.1.x-compatible version. Here are instructions on how to use it:
- Download external-system.zip;
- Unpack it and define external-system.jar as a library dependency;
- Configure sources from external-system-src.jar if necessary;
- Add definitions from ExternalSystemExtensionPoints.xml and ExternalSystemExtensions.xml to your plugin.xml (that .xml files are bundled into external-system-src.jar). *Note: it's very important to use custom namespace there because there is a possible case that more than one external system integration uses this approach to be compatible with 12.1.x;