. Default: `${project.issueManagement.url}` |
| `pluginTermsConditionsUrl` | Plugin-TermsConditionsUrl | Users must read this document when installing the plugin from Marketplace. Default: `${sonar.pluginTermsConditionsUrl}` |
| `useChildFirstClassLoader` | Plugin-ChildFirstClassLoader | Each plugin is executed in an isolated classloader, which inherits a shared classloader that contains API and some other classes. By default the loading strategy of classes is parent-first (look up in shared classloader then in plugin classloader). If the property is true, then the strategy is child-first. This property is mainly used when building plugin against API < 5.2, as the shared classloader contained many 3rd party libraries (guava 10, commons-lang, …) false. |
| `basePlugin` | Plugin-Base | If specified, then the plugin is executed in the same classloader as `basePlugin`. |
| `pluginSourcesUrl` | Plugin-SourcesUrl | URL of SCM repository for open-source plugins. Displayed on page "Marketplace". Default: `${project.scm.url}` |
| `pluginOrganizationName` | Plugin-Organization | The organization which develops the plugin is displayed on the page "Marketplace". Default: `${project.organization.name}` |
| `pluginOrganizationUrl` | Plugin-OrganizationUrl | URL of the organization, displayed on the page "Marketplace". Default: `${project.organization.url}` |
| `sonarLintSupported` | SonarQube for IDE-Supported | Whether the language plugin supports SonarQube for IDE or not. Only SonarSource analyzers and custom rules plugins for SonarSource analyzers should set this to true. |
| `pluginDisplayVersion` | Plugin-Display-Version | The version is displayed in SonarQube Server administration console. By default it’s the raw version, for example, "1.2", but can be overridden to "1.2 (build 12345)" for instance. Supported in sonar-packaging-maven-plugin 1.18.0.372. Default: `${project.version}` |
| `requiredForLanguages` | Plugin-RequiredForLanguages | Languages for which this plugin should be downloaded. Use to make sure dependency errors are avoided when improving-performance. This property must be added to the \ section of the plugin’s pom.xml file.
For an example, see the Custom Rules section of the java page.
|
The Maven `sonar-packaging-maven-plugin` supports also these properties:
| | | |
| --------------------------- | ------------------------------------------------------------------ | --------------------------------------------------------- |
| **Maven property** | **Manifest key** | **Notes** |
| `addMavenDescriptor` | Copy pom file inside the directory META-INF of generated jar file? | Boolean. Default: `${sonar.addMavenDescriptor}` / `true`. |
| `skipDependenciesPackaging` | Do not copy Maven dependencies into jar file. | Default: `${sonar.skipDependenciesPackaging} /`false\`. |
Other Manifest fields:
* `Implementation-Build`: Identifier of build or commit, for example, the Git SHA1. `94638028f0099de59f769cdca776e506684235d6`. It is displayed for debugging purposes in logs when SonarQube Server starts.
## API basics
### Extension points
SonarQube Server provides extension points for its three technical stacks:
* Scanner, which runs the source code analysis.
* Compute Engine, which consolidates the output of scanners, for example by:
* computing 2nd-level measures such as ratings.
* aggregating measures (for example number of lines of code of project = sum of lines of code of all files).
* assigning new issues to developers.
* persisting everything in data stores.
* Web application.
Extension points are not designed to add new features but to complete existing features. Technically they are contracts defined by a Java interface or an abstract class annotated with `@ExtensionPoint`. The exhaustive list of extension points is available in the Javadoc.
The implementations of extension points (named *extensions*) provided by a plugin must be declared in its entry point class, which implements `org.sonar.api.Plugin`and which is referenced in the `pom.xml`:
**ExamplePlugin.java**
```css-79elbk
package org.sonarqube.plugins.example;
import org.sonar.api.Plugin;
public class ExamplePlugin implements Plugin {
@Override
public void define(Context context) {
// implementations of extension points
context.addExtensions(FooLanguage.class, ExampleProperties.class);
}
}
```
**pom.xml**
```css-79elbk
...
org.sonarsource.sonar-packaging-maven-plugin
sonar-packaging-maven-plugin
true
org.sonarqube.plugins.example.ExamplePlugin
```
### Lifecycle
A plugin extension exists only in its associated technical stacks. A scanner sensor is for example instantiated and executed only in a scanner runtime, but not in the web server nor in Compute Engine. The stack is defined by the annotations [@ScannerSide](https://javadocs.sonarsource.org/latest/org/sonar/api/batch/ScannerSide.html), [@ServerSide](https://javadocs.sonarsource.org/latest/org/sonar/api/server/ServerSide.html) (for a web server), and [@ComputeEngineSide](https://javadocs.sonarsource.org/latest/org/sonar/api/ce/ComputeEngineSide.html).
An extension can call core components or another extension of the same stack. These dependencies are defined by constructor injection:
```css-79elbk
@ScannerSide
public class Foo {
public void call() {}
}
// Sensor is a scanner extension point
public class MySensor implements Sensor {
private final Foo foo;
private final Languages languages;
// Languages is core component which lists all the supported programming languages.
public MySensor(Foo foo, Languages languages) {
this.foo = foo;
this.languages = languages;
}
@Override
public void execute(SensorContext context) {
System.out.println(this.languages.all());
foo.call();
}
}
public class ExamplePlugin implements Plugin {
@Override
public void define(Context context) {
// Languages is a core component. It must not be declared by plugins.
context.addExtensions(Foo.class, MySensor.class);
}
}
```
It is recommended not to call other components in constructors. Indeed, they may not be initialized at that time. Constructors should only be used for dependency injection.
A compilation will not fail if incorrect dependencies are defined, such as a scanner extension trying to call a web server extension. Still, it will fail at runtime when a plugin is loaded.
### Third-party libraries
Plugins are executed in their own isolated classloaders. That allows the packaging and use of 3rd-party libraries without runtime conflicts with core internal libraries or other plugins. Note that since version 5.2, SonarQube Server API does not bring transitive dependencies, except SLF4J. The libraries just have to be declared in the `pom.xml` with the default scope "compile":
**pom.xml**
```css-79elbk
...
...
commons-codec
commons-codec
1.10
```
Technically, the libraries are packaged in the directory META-INF/lib of the generated jar file. An alternative is to shade libraries, for example with `maven-shade-plugin`. That minimizes the size of the plugin jar file by copying only the effective used classes.
The command `mvn dependency:tree` gives the list of all dependencies, including transitive ones.
### Configuration
The core component [`org.sonar.api.config.Configuration`](http://javadocs.sonarsource.org/latest/org/sonar/api/config/Configuration.html) provides access to configuration. It deals with default values and the decryption of values. It is available in all stacks (scanner, web server, Compute Engine). As recommended earlier, it must not be called from constructors.
**MyExtension.java**
```css-79elbk
public class MyRules implements RulesDefinition {
private final Configuration config;
public MyRules(Configuration config) {
this.config = config;
}
@Override
public void define(Context context) {
int value = config.getInt("sonar.property").orElse(0);
}
}
```
Scanner sensors can get config directly from SensorContext, without using constructor injection:
**MySensor.java**
```css-79elbk
public class MySensor extends Sensor {
@Override
public void execute(SensorContext context) {
int value = context.config().getInt("sonar.property").orElse(0);
}
}
```
In the scanner stack, properties are checked in the following order, and the first non-blank value is the one that is used:
1. System property.
2. Scanner command-line (-Dsonar.property=foo for instance).
3. Scanner tool ( of scanner for Maven for instance).
4. Project configuration defined in the web UI.
5. Global configuration defined in the web UI.
6. Default value.
Plugins can define their own properties so that they can be configured from the web administration console. The extension point `org.sonar.api.config.PropertyDefinition` must be used:
```css-79elbk
public class ExamplePlugin implements Plugin {
@Override
public void define(Context context) {
context.addExtension(
PropertyDefinition.builder("sonar.my.property")
.name("My Property")
.description("This is the description displayed in web admin console")
.defaultValue("42")
.build()
);
}
}
```
{% hint style="info" %}
Values of the properties suffixed with `.secured` are not available to be read by any users. The `.secured` suffix is needed for passwords, for instance.
{% endhint %}
The annotation `org.sonar.api.config.PropertyDefinition` can be used on an extension to declare a property.
```css-79elbk
@Properties(
@Property(key="sonar.my.property", name="My Property", defaultValue="42")
)
public class MySensor implements Sensor {
// ...
}
public class ExamplePlugin implements Plugin {
@Override
public void define(Context context) {
context.addExtension(MySensor.class);
}
}
```
### Logging
[SLF4J](https://www.slf4j.org/) is used to log messages to scanner output, web server logs/sonar.log, or Compute Engine logs (available from the administration web console). It’s convenient for unit testing (see class [LogTesterJUnit5](https://github.com/SonarSource/sonar-plugin-api/blob/master/test-fixtures/src/main/java/org/sonar/api/testfixtures/log/LogTesterJUnit5.java)).
```css-79elbk
import org.slf4j.*;
public class MyClass {
private static final Logger LOGGER = LoggerFactory.getLogger(MyClass.class);
public void doSomething() {
LOGGER.info("foo");
}
}
```
SLF4J is used as a facade of various logging frameworks (`log4j`, `commons-log`, `logback`, `java.util.logging`). That allows all these frameworks to work at runtime, such as when they are required for a 3rd party library. Read the [SLF4J manual](https://www.slf4j.org/manual.html) for more details.
As an exception, plugins must not package logging libraries. Dependencies like SLF4J or `log4j` must be declared with the scope "provided" (Maven) or "compileOnly" (Gradle).
### Exposing APIs to other plugins
The common use case is to write a language plugin that will allow some other plugins to contribute additional rules (see for example how it is done for [Java](https://github.com/SonarSource/sonar-java) analysis). The main plugin will expose some APIs that will be implemented/used by the "rule" plugins.
Plugins are loaded in isolated classloaders. It means a plugin can’t access another plugin’s classes. There is an exception for package names following pattern `org.sonar.plugins..api`. For example, all classes in a plugin with the key `myplugin` that are located in `org.sonar.plugins.myplugin.api` are visible to other plugins.
### Serving static resources
If you need to serve static resources from your plugin such as images or JavaScript files, place them in a directory under `resources` named `static` (`myplugin/src/main/resources/static`). At runtime, they’ll be available from `https://{server}/static/{pluginKey}/{file}`.
## Configuring plugins for analyzer loading optimization
By default, SonarQube Server downloads Sonar analyzers and third-party plugins only when they are really required by the scanner (see [improving-performance](https://docs.sonarsource.com/sonarqube-server/server-update-and-maintenance/maintenance/improving-performance "mention")). To make this feature work, each analyzer or third-party plugin should declare the list of languages on which they expect to raise issues through a MANIFEST property called `Plugin-RequiredForLanguages`.
### Optimization behavior
At the Scanner level, the behavior is as follows:
* **Case 1**: When the property is not set by the plugin, the plugin is downloaded whatever the contents of the project.
* **Case 2**: When the property is defined and there are files corresponding to the language declared by the plugin, the plugin is downloaded.
* **Case 3**: When the property is defined and there are no files corresponding to the language declared by the plugin, the plugin is not downloaded.
This helps save network bandwidth and speed up the bootstrap of the scans. As a side effect, the logs are also cleaner, with fewer "nothing to do" logs for plugins that really have nothing to perform on the repository content.
### Avoiding dependency errors
For plugins that have a dependency on a base analyzer provided by default with SonarQube Server (for example, a plugin to add rules or reports to an existing language), it is mandatory to add to the MANIFEST the property `Plugin-RequiredForLanguages` to avoid a hard failure.
Take, for example, plugin sonar-xyz which provides additional rules for Java:
1. A user scans a repository that only contains Python code.
2. sonar-xyz is downloaded because it doesn’t declare the property. So it is downloaded from the server at each scan (case 1 above).
3. sonar-java is not downloaded because there are no .java files in the repository to scan (case 3 above).
4. Analysis errors-out because a `NoClassDefFoundError` is thrown since sonar-xyz has an unsatisfied dependency on sonar-java, which wasn’t downloaded.
### Configuration steps
To avoid dependency errors, you’ll need to:
1. Upgrade sonar-packaging-maven-plugin to version [1.22.0.705 1](https://github.com/SonarSource/sonar-packaging-maven-plugin/releases/tag/1.22.0.705).
2. Add java to the configuration of sonar-packaging-maven-plugin where "java" is replaced by the language your plugin is dealing with.
3. Add the property `` to the configuration of sonar-packaging-maven-plugin, so that `Plugin-RequiredForLanguages` is added to the MANIFEST. The property accepts several values such as `js`,`ts`,`css`,`web`, `yaml`, etc.
Example configurations are available on the language pages (see the **Custom rules** section of the [java](https://docs.sonarsource.com/sonarqube-server/analyzing-source-code/languages/java "mention") page for example).
## API deprecation
See [deprecation-policy](https://docs.sonarsource.com/sonarqube-server/server-update-and-maintenance/maintenance/deprecations/deprecation-policy "mention").
## API Changes
{% hint style="info" %}
Starting with v9.5, the API is released independently of SonarQube Server. You can find the changes for newer releases in its [code repository](https://github.com/SonarSource/sonar-plugin-api/releases).
{% endhint %}
### Release 2025.3
The following deprecated classes have been removed: `MutableModuleSettings` and `MutableProjectSettings`.
### Release 9.3
Added
* `sonar-plugin-api.src.main.java.org.sonar.api.resources.Language#publishAllFiles` to define whether the files identified with the language should be automatically published to SonarQube Server.
* `org.sonar.api.batch.sensor.SensorDescriptor#processesFilesIndependently`
### Release 9.0
Deprecated:
* `org.sonar.api.server.rule.RulesDefinitionXmlLoader` is deprecated. Use the `sonar-check-api` to annotate rule classes instead of loading the metadata from XML files.
Removed:
* `org.sonar.api.ExtensionProvider` Use `org.sonar.api.Plugin.Context#addExtensions()` to add objects to the container.
* `org.sonar.api.batch.sensor.SensorDescriptor#requireProperty()`. Use `#onlyWhenConfiguration()` instead.
* All API related to preview/issues analysis mode.
* Coverage types (unit, IT, overall) was removed.
* Resource perspectives. Use methods in `SensorContext`.
* `org.sonar.api.platform.Server#getRootDir()`. Use `ServerFileSystem#getHomeDir()`.
* `org.sonar.api.profiles.ProfileDefinition.java`. Define quality profiles with `BuiltInQualityProfilesDefinition`.
* `org.sonar.api.rules.XMLRuleParser`. Use the `sonar-check-api` to annotate rule classes.
### Release 8.4
Added:
* `org.sonar.api.batch.scm.ScmProvider#forkDate`
Deprecated:
* `org.sonar.api.rules.Rule#getId()` is deprecated and will always throw UnsupportedOperationException.
### Release 8.3
Deprecated:
* `org.sonar.api.utils.text.JsonWriter`
### Release 7.8
Added:
* `org.sonar.api.web.WebAnalytics`
Deprecated:
* `org.sonar.api.i18n.I18`
* `org.sonar.api.SonarQubeVersion` use `org.sonar.api.SonarRuntime` instead.
* `org.sonar.api.profiles.XMLProfileParser`
* `org.sonar.api.notifications.NotificationChannel`
Removed:
* Pico components relying on reflection to have their `start` or `stop` method called. Make your component implements `org.sonar.api.Startable` instead.
### Release 7.7
Added:
* `org.sonar.api.batch.scm.ScmProvider#ignoreCommand`
Deprecated:
* `org.sonar.api.batch.fs.InputFile::status`
* `org.sonar.api.resources.Qualifiers#BRC`
Removed:
* The preview/issues mode of the scanner has been removed.
### Release 7.6
Changed:
* `PostJob` moved to project level IoC container.
* `InputFileFilter` moved to project level IoC container.
Added:
* New annotation `org.sonar.api.scanner.ScannerSide` to mark (project level) scanner components.
* `org.sonar.api.batch.fs.InputProject` to create issues on projects.
* `org.sonar.api.scanner.ProjectSensor` to declare Sensors that only run at the project level.
Deprecated:
* `org.sonar.scanner.issue.IssueFilter` is deprecated.
* `org.sonar.api.batch.InstantiationStrategy` is deprecated.
* `org.sonar.api.batch.ScannerSide` is deprecated.
* `org.sonar.api.batch.fs.InputModule` is deprecated.
* The concept of global Sensor is deprecated (use `ProjectSensor` instead).
Removed:
* Support of scanner tasks was removed.
* `RulesProfile` is no longer available for scanner side components (use `ActiveRules` instead).
### Release 7.4
Changed:
* Allow identity provider to not provide login.
Added:
* Allow sensors to report adhoc rules metadata.
Removed:
* `org.sonar.api.rules.RuleFinder` removed from scanner side.
* `sonar-channel` removed from plugin classloader.
* stop support of plugins compiled with API < 5.2.
### Release 7.3
Added:
* `RulesDefinitions` supports HotSpots and security standards.
Deprecated:
* `org.sonar.api.batch.AnalysisMode` and `org.sonar.api.issue.ProjectIssues` since preview mode is already deprecated for a while.
### Release 7.2
Added:
* `org.sonar.api.batch.sensor.SensorContext#newExternalIssue` to report external issues.
* `org.sonar.api.batch.sensor.SensorContext#newSignificantCode` to report part of the source file that should be used for issue tracking.
* `org.sonar.api.scan.issue.filter.FilterableIssue#textRange`
Deprecated:
* `org.sonar.api.scan.issue.filter.FilterableIssue#line`
### Release 7.1
Added:
* `org.sonar.api.Plugin.Context#getBootConfiguration`
* `org.sonar.api.server.rule.RulesDefinition.NewRule#addDeprecatedRuleKey` to support deprecated rule keys.
### Release 7.0
Added:
* `org.sonar.api.batch.scm.ScmProvider#relativePathFromScmRoot`, `org.sonar.api.batch.scm.ScmProvider#branchChangedFiles` and `org.sonar.api.batch.scm.ScmProvider#revisionId` to improve branch and PR support.