Deprecated API

Contents

• For Removal
• Interfaces
• Classes
• Enums
• Exceptions
• Annotation Types
• Fields
• Methods
• Enum Constants
• Annotation Type Elements

For Removal

Element	Description
org.sonar.api.batch.rule.LoadedActiveRule	since 10.13. Internal implementation
org.sonar.api.config.PropertyDefinition.Builder.onlyOnQualifiers(String, String...)	since 10.13. Use PropertyDefinition.Builder.onlyOnConfigScopes(ConfigScope, ConfigScope...) instead.
org.sonar.api.config.PropertyDefinition.Builder.onQualifiers(String, String...)	since 10.13. Use PropertyDefinition.Builder.onConfigScopes(ConfigScope, ConfigScope...) instead.
org.sonar.api.config.PropertyDefinition.ConfigScope.MODULE	since 10.13. No more modules on the server side.
org.sonar.api.config.PropertyDefinition.qualifiers()	since 10.13. Use PropertyDefinition.configScopes() instead.
org.sonar.api.issue.DefaultTransitions	since 11.4 not used by any extension point anymore
org.sonar.api.Property.module()	since 10.13. Modules are not used anymore.
org.sonar.api.resources.Qualifiers	since 10.13. Qualifiers are not used when developing plugins. This is exposed in some web APIs, but it doesn't make sense to make it part of the plugin API.
org.sonar.api.resources.ResourceType	since 10.13. We don't support custom resource types contributed by plugins anymore.
org.sonar.api.resources.ResourceTypes	since 10.13. We don't support custom resource types contributed by plugins anymore.
org.sonar.api.resources.ResourceTypeTree	since 10.13. We don't support custom resource types contributed by plugins anymore.
org.sonar.api.resources.Scopes	since 10.13. Scopes are not used when developing plugins. This is exposed in some web APIs, but it doesn't make sense to make it part of the plugin API.
org.sonar.api.rules.Rule
org.sonar.api.rules.RuleFinder	since 11.4 as ProfileExporter/ProfileImporter got removed
org.sonar.api.rules.RuleParam
org.sonar.api.rules.RuleQuery	since 11.4 as ProfileExporter/ProfileImporter got removed
org.sonar.api.server.rule.internal.DefaultRule.markdownDescription()	since 9.6 markdown support fur rule descriptions will be dropped
org.sonar.api.server.rule.RulesDefinition.NewRule.setMarkdownDescription(String)	since 9.6. Use RulesDefinition.NewRule.addDescriptionSection(RuleDescriptionSection) instead
org.sonar.api.server.rule.RulesDefinition.Rule.markdownDescription()	since 9.6. Use html format instead
org.sonar.api.web.page.Page.Qualifier.fromKey(String)	since 10.13. Should not be exposed in the plugin API.
org.sonar.api.web.page.Page.Qualifier.getKey()	since 10.13. Should not be exposed in the plugin API.
org.sonar.api.web.page.Page.Qualifier.MODULE	since 10.13. No more modules on the server side
org.sonar.api.web.UserRole	since 11.4 not used by any extension point anymore

Interfaces

Interface	Description
org.sonar.api.batch.bootstrap.ProjectBuilder.Context
org.sonar.api.batch.fs.InputDir	since 6.6 Ability to report issues or measures on directories will soon be dropped. Report issues on project if needed.
org.sonar.api.batch.fs.InputModule	since 7.6 modules are deprecated. Use InputProject instead.
org.sonar.api.issue.DefaultTransitions	since 11.4 not used by any extension point anymore
org.sonar.api.rules.RuleFinder	since 11.4 as ProfileExporter/ProfileImporter got removed
org.sonar.api.scan.issue.filter.FilterableIssue	since 7.6
org.sonar.api.scan.issue.filter.IssueFilter	since 7.6
org.sonar.api.utils.log.Logger	since 9.15 in favor of Logger

Classes

Class	Description
org.sonar.api.batch.bootstrap.internal.ProjectBuilderContext	since 6.5
org.sonar.api.batch.bootstrap.ProjectBuilder	since 6.5. It won't be possible to manipulate the project's structure.
org.sonar.api.batch.bootstrap.ProjectDefinition	since 7.6 use InputProject
org.sonar.api.batch.bootstrap.ProjectReactor	since 6.5 plugins should no longer modify the project's structure
org.sonar.api.batch.rule.LoadedActiveRule	since 10.13. Internal implementation
org.sonar.api.config.Settings	since 6.5 use Configuration. Implementation moved out of the API in 8.3. Only remains minimal interface to make some outdated plugins happy.
org.sonar.api.resources.Qualifiers	since 10.13. Qualifiers are not used when developing plugins. This is exposed in some web APIs, but it doesn't make sense to make it part of the plugin API.
org.sonar.api.resources.ResourceType	since 10.13. We don't support custom resource types contributed by plugins anymore.
org.sonar.api.resources.ResourceTypes	since 10.13. We don't support custom resource types contributed by plugins anymore.
org.sonar.api.resources.ResourceTypeTree	since 10.13. We don't support custom resource types contributed by plugins anymore.
org.sonar.api.resources.Scopes	since 10.13. Scopes are not used when developing plugins. This is exposed in some web APIs, but it doesn't make sense to make it part of the plugin API.
org.sonar.api.rules.Rule
org.sonar.api.rules.RuleParam
org.sonar.api.rules.RuleQuery	since 11.4 as ProfileExporter/ProfileImporter got removed
org.sonar.api.scan.filesystem.FileExclusions	since 7.6
org.sonar.api.server.rule.RulesDefinitionXmlLoader	since 9.0. Use the sonar-check-api to annotate rule classes instead of loading the metadata from XML files. See Rule.
org.sonar.api.utils.log.Loggers	since 9.15 in favor of LoggerFactory
org.sonar.api.utils.text.JsonWriter	since 8.3 this utility class will be moved out of the API. Use your own JSON dependency if you need to write JSON from your plugin

Enums

Enum	Description
org.sonar.api.rules.RulePriority	since 4.2
org.sonar.api.server.rule.RulesDefinition.CweVersion	in 9.15
org.sonar.api.utils.log.LoggerLevel	since 9.15 in favor of Level

Exceptions

Exceptions	Description
org.sonar.api.utils.SonarException	in 4.4. Use standard exceptions like IllegalArgumentException or IllegalStateException. Use MessageException for raising errors to end-users without displaying stackstrace.

Annotation Types

Annotation Type	Description
org.sonar.api.batch.InstantiationStrategy	since 7.6 removal of modules and tasks is planned. All extensions should progressively move to the project scope, using ScannerSide
org.sonar.api.batch.ScannerSide	since 7.6 use ScannerSide that will move the component to the project container
org.sonar.api.web.UserRole	since 11.4 not used by any extension point anymore

Fields

Field	Description
org.sonar.api.CoreProperties.CPD_CROSS_PROJECT	since 6.7
org.sonar.api.CoreProperties.SCAN_TASK	since 7.6
org.sonar.api.CoreProperties.SUBCATEGORY_DATABASE_CLEANER	since 8.1. Database cleaning now has a dedicated category CoreProperties.CATEGORY_HOUSEKEEPING.
org.sonar.api.CoreProperties.TASK	since 7.6
org.sonar.api.issue.DefaultTransitions.CONFIRM	since 10.4, use DefaultTransitions.ACCEPT instead
org.sonar.api.issue.DefaultTransitions.UNCONFIRM	since 10.4. There is no replacement as `org.sonar.api.issue.DefaultTransitions.CONFIRM` is subject to removal in the future.
org.sonar.api.issue.DefaultTransitions.WONT_FIX	since 10.3, use DefaultTransitions.ACCEPT instead
org.sonar.api.issue.Issue.RESOLUTION_FALSE_POSITIVE	since 10.4 in favor of IssueStatus
org.sonar.api.issue.Issue.RESOLUTION_REMOVED	since 10.4 in favor of IssueStatus
org.sonar.api.issue.Issue.RESOLUTION_WONT_FIX	since 10.4 in favor of IssueStatus
org.sonar.api.issue.Issue.RESOLUTIONS	since 10.4 in favor of IssueStatus
org.sonar.api.issue.Issue.STATUS_CLOSED	since 10.4 in favor of IssueStatus
org.sonar.api.issue.Issue.STATUS_CONFIRMED	since 10.4 in favor of IssueStatus
org.sonar.api.issue.Issue.STATUS_OPEN	since 10.4 in favor of IssueStatus
org.sonar.api.issue.Issue.STATUS_REOPENED	since 10.4 in favor of IssueStatus
org.sonar.api.issue.Issue.STATUS_RESOLVED	since 10.4 in favor of IssueStatus
org.sonar.api.issue.Issue.STATUSES	since 10.4 in favor of IssueStatus
org.sonar.api.measures.CoreMetrics.COMMENT_LINES_DATA	in 7.3. Measures are no longer sent within analysis reports, and by consequence no longer persisted nor available from web API.
org.sonar.api.measures.CoreMetrics.COMMENT_LINES_DATA_KEY	in 7.3. Measures are no longer sent within analysis reports, and by consequence no longer persisted nor available from web API.
org.sonar.api.measures.CoreMetrics.CONFIRMED_ISSUES	since 10.4 as status Issue.STATUS_CONFIRMED is deprecated. No replacement.
org.sonar.api.measures.CoreMetrics.CONFIRMED_ISSUES_KEY	since 10.4 as status Issue.STATUS_CONFIRMED is deprecated. No replacement.
org.sonar.api.measures.CoreMetrics.DOMAIN_DOCUMENTATION	since 6.2. Merged into CoreMetrics.DOMAIN_SIZE
org.sonar.api.measures.CoreMetrics.DUPLICATIONS_DATA	since 4.5. Internal storage of duplication is not an API.
org.sonar.api.measures.CoreMetrics.DUPLICATIONS_DATA_KEY	since 4.5. Internal storage of duplication is not an API.
org.sonar.api.measures.CoreMetrics.HIGH_IMPACT_ACCEPTED_ISSUES	since 10.6
org.sonar.api.measures.CoreMetrics.HIGH_IMPACT_ACCEPTED_ISSUES_KEY	since 10.6
org.sonar.api.measures.CoreMetrics.MAINTAINABILITY_ISSUES	since 10.13
org.sonar.api.measures.CoreMetrics.MAINTAINABILITY_ISSUES_KEY	since 10.13
org.sonar.api.measures.CoreMetrics.NEW_MAINTAINABILITY_ISSUES	since 10.13
org.sonar.api.measures.CoreMetrics.NEW_MAINTAINABILITY_ISSUES_KEY	since 10.13
org.sonar.api.measures.CoreMetrics.NEW_RELIABILITY_ISSUES	since 10.13
org.sonar.api.measures.CoreMetrics.NEW_RELIABILITY_ISSUES_KEY	since 10.13
org.sonar.api.measures.CoreMetrics.NEW_SECURITY_ISSUES	since 10.13
org.sonar.api.measures.CoreMetrics.NEW_SECURITY_ISSUES_KEY	since 10.13
org.sonar.api.measures.CoreMetrics.OPEN_ISSUES	since 10.4. Use CoreMetrics.VIOLATIONS instead.
org.sonar.api.measures.CoreMetrics.OPEN_ISSUES_KEY	since 10.4. Use CoreMetrics.VIOLATIONS_KEY instead.
org.sonar.api.measures.CoreMetrics.PUBLIC_API_KEY	since 6.2
org.sonar.api.measures.CoreMetrics.PUBLIC_DOCUMENTED_API_DENSITY_KEY	since 6.2
org.sonar.api.measures.CoreMetrics.PUBLIC_UNDOCUMENTED_API_KEY	since 6.2
org.sonar.api.measures.CoreMetrics.QUALITY_PROFILES	since 5.5
org.sonar.api.measures.CoreMetrics.QUALITY_PROFILES_KEY	since 5.5
org.sonar.api.measures.CoreMetrics.RELIABILITY_ISSUES	since 10.13
org.sonar.api.measures.CoreMetrics.RELIABILITY_ISSUES_KEY	since 10.13
org.sonar.api.measures.CoreMetrics.REOPENED_ISSUES	since 10.4. Use CoreMetrics.VIOLATIONS instead.
org.sonar.api.measures.CoreMetrics.REOPENED_ISSUES_KEY	since 10.4. Use CoreMetrics.VIOLATIONS_KEY instead.
org.sonar.api.measures.CoreMetrics.SECURITY_ISSUES	since 10.13
org.sonar.api.measures.CoreMetrics.SECURITY_ISSUES_KEY	since 10.13
org.sonar.api.measures.CoreMetrics.WONT_FIX_ISSUES	since 10.3. Use CoreMetrics.ACCEPTED_ISSUES instead.
org.sonar.api.measures.CoreMetrics.WONT_FIX_ISSUES_KEY	since 10.3. Use CoreMetrics.ACCEPTED_ISSUES_KEY instead.
org.sonar.api.resources.Qualifiers.MODULE	since 7.7 as modules doesn't exist anymore
org.sonarsource.api.sonarlint.SonarLintSide.MULTIPLE_ANALYSES	since 9.0 use SonarLintSide.INSTANCE as a direct replacement

Methods

Method	Description
org.sonar.api.batch.bootstrap.ProjectBuilder.build(ProjectReactor)	since 3.7 override ProjectBuilder.build(Context) instead
org.sonar.api.batch.bootstrap.ProjectDefinition.getOriginalVersion()	since 7.7, use ProjectDefinition.getOriginalProjectVersion() instead
org.sonar.api.batch.bootstrap.ProjectDefinition.getVersion()	since 7.7, use ProjectDefinition.getProjectVersion() instead
org.sonar.api.batch.fs.FileSystem.files(FilePredicate)	since 6.6 Plugins should avoid working with File and prefer working with InputFile
org.sonar.api.batch.fs.FileSystem.inputDir(File)	since 6.6 Ability to report issues or measures on directories will soon be dropped. Report issues on project if needed.
org.sonar.api.batch.fs.IndexedFile.absolutePath()	since 6.6 use IndexedFile.inputStream(), IndexedFile.filename() or IndexedFile.uri()
org.sonar.api.batch.fs.IndexedFile.file()	since 6.6 use IndexedFile.inputStream(), IndexedFile.filename() or IndexedFile.uri()
org.sonar.api.batch.fs.IndexedFile.path()	since 6.6 use IndexedFile.inputStream(), IndexedFile.filename() or IndexedFile.uri()
org.sonar.api.batch.fs.IndexedFile.relativePath()	since 6.6 use IndexedFile.inputStream(), IndexedFile.filename() or IndexedFile.uri()
org.sonar.api.batch.fs.InputFile.absolutePath()	since 6.6 use InputFile.inputStream() for file content, IndexedFile.filename() for file name, IndexedFile.uri() for an unique identifier, and InputFile.toString() for logging
org.sonar.api.batch.fs.InputFile.file()	since 6.6 use InputFile.inputStream() for file content, IndexedFile.filename() for file name, IndexedFile.uri() for an unique identifier, and InputFile.toString() for logging
org.sonar.api.batch.fs.InputFile.path()	since 6.6 use InputFile.inputStream() for file content, IndexedFile.filename() for file name, IndexedFile.uri() for an unique identifier, and InputFile.toString() for logging
org.sonar.api.batch.fs.InputFile.relativePath()	since 6.6 use InputFile.inputStream() for file content, IndexedFile.filename() for file name, IndexedFile.uri() for an unique identifier, and InputFile.toString() for logging
org.sonar.api.batch.fs.InputPath.absolutePath()	since 6.5 use InputPath.uri()
org.sonar.api.batch.fs.InputPath.file()	since 6.5 use InputPath.uri()
org.sonar.api.batch.fs.InputPath.path()	since 6.5 use InputPath.uri()
org.sonar.api.batch.fs.InputPath.relativePath()	since 6.5 use InputPath.uri()
org.sonar.api.batch.scm.ScmProvider.forkDate(String, Path)	Not used anymore since 9.3
org.sonar.api.batch.sensor.issue.NewExternalIssue.forRule(RuleKey)	since 7.4. It is misleading, because of the "external_" prefix that is added on server side. Use NewExternalIssue.engineId(String) and NewExternalIssue.ruleId(String)
org.sonar.api.batch.sensor.SensorContext.getSonarQubeVersion()	since 10.0. The name is confusing: the API version is different from the SonarQube version since the extraction. Use the advised replacement
org.sonar.api.batch.sensor.SensorContext.module()	since 7.6 modules are deprecated. Use SensorContext.project() instead.
org.sonar.api.batch.sensor.SensorContext.settings()	since 6.5 use SensorContext.config()
org.sonar.api.batch.sensor.SensorDescriptor.global()	since 7.6 change your Sensor to a ProjectSensor instead
org.sonar.api.ce.measure.Issue.resolution()	since 10.4 in favor of Issue.issueStatus()
org.sonar.api.ce.measure.Issue.status()	since 10.4 in favor of Issue.issueStatus()
org.sonar.api.ce.posttask.PostProjectAnalysisTask.finished(PostProjectAnalysisTask.ProjectAnalysis)	in 8.0. Implement PostProjectAnalysisTask.finished(Context) instead
org.sonar.api.ce.posttask.PostProjectAnalysisTask.ProjectAnalysis.getScmRevisionId()	in 7.8, replaced by Analysis#getRevision()
org.sonar.api.config.PropertyDefinition.Builder.onlyOnQualifiers(String, String...)	since 10.13. Use PropertyDefinition.Builder.onlyOnConfigScopes(ConfigScope, ConfigScope...) instead.
org.sonar.api.config.PropertyDefinition.Builder.onQualifiers(String, String...)	since 10.13. Use PropertyDefinition.Builder.onConfigScopes(ConfigScope, ConfigScope...) instead.
org.sonar.api.config.PropertyDefinition.qualifiers()	since 10.13. Use PropertyDefinition.configScopes() instead.
org.sonar.api.issue.Issue.resolution()	since 10.4 in favor of IssueStatus. Not deprecated for hotspots
org.sonar.api.issue.Issue.status()	since 10.4 in favor of IssueStatus. Not deprecated for hotspots
org.sonar.api.measures.Metric.Builder.setUserManaged(boolean)	since 9.1. There is no replacement
org.sonar.api.measures.Metric.getUserManaged()	since 9.1. There is no replacement
org.sonar.api.measures.Metric.setUserManaged(Boolean)	since 9.1. There is no replacement
org.sonar.api.Plugin.Context.getSonarQubeVersion()	since 10.0. The name is confusing: the API version is different from the SonarQube version since the extraction. Use the advised replacement
org.sonar.api.Property.module()	since 10.13. Modules are not used anymore.
org.sonar.api.rules.Rule.getCardinality()	since 4.4, use Rule.isTemplate()
org.sonar.api.rules.Rule.getId()	since 8.4. Use Rule.ruleKey() instead
org.sonar.api.rules.Rule.getParent()	since 4.4, use Rule.getTemplate()
org.sonar.api.rules.Rule.setCardinality(Cardinality)	since 4.4, use Rule.setIsTemplate(boolean)
org.sonar.api.rules.Rule.setParent(Rule)	since 4.4, use Rule.setTemplate(Rule)}
org.sonar.api.scan.issue.filter.FilterableIssue.componentKey()	since 7.6 filtering issue should not depend on the key
org.sonar.api.scan.issue.filter.FilterableIssue.line()	since 7.2. Use FilterableIssue.textRange() instead.
org.sonar.api.scan.issue.filter.FilterableIssue.projectKey()	since 7.6 filtering issue should not depend on the key
org.sonar.api.server.authentication.UserIdentity.Builder.setLogin(String)	since 8.0, has no effect as it is internal managed field
org.sonar.api.server.authentication.UserIdentity.getLogin()	since 8.0, should not be used as it is internal managed field
org.sonar.api.server.rule.internal.DefaultRule.markdownDescription()	since 9.6 markdown support fur rule descriptions will be dropped
org.sonar.api.server.rule.internal.ImpactMapper.convertToDeprecatedSeverity(Severity)	since 10.14, use ImpactMapper.convertToRuleSeverity(Severity) instead.
org.sonar.api.server.rule.RulesDefinition.NewRule.addOwaspTop10(RulesDefinition.OwaspTop10...)	since 9.3 Supports only OWASP Top 10 2017 standard, use addOwaspTop10(OwaspTop10Version, OwaspTop10...) for 2017,2021...
org.sonar.api.server.rule.RulesDefinition.NewRule.setMarkdownDescription(String)	since 9.6. Use RulesDefinition.NewRule.addDescriptionSection(RuleDescriptionSection) instead
org.sonar.api.server.rule.RulesDefinition.Rule.markdownDescription()	since 9.6. Use html format instead
org.sonar.api.utils.log.Logger.setLevel(LoggerLevel)	since 9.15 will always return false
org.sonar.api.utils.ValidationMessages.log(Logger)	replaced by ValidationMessages.log(org.sonar.api.utils.log.Logger) since deprecation of slf4j in 5.1
org.sonar.api.web.page.Page.Qualifier.fromKey(String)	since 10.13. Should not be exposed in the plugin API.
org.sonar.api.web.page.Page.Qualifier.getKey()	since 10.13. Should not be exposed in the plugin API.

Enum Constants

Enum Constant	Description
org.sonar.api.config.PropertyDefinition.ConfigScope.MODULE	since 10.13. No more modules on the server side.
org.sonar.api.issue.IssueStatus.CONFIRMED
org.sonar.api.web.page.Page.Qualifier.MODULE	since 10.13. No more modules on the server side

Annotation Type Elements

Annotation Type Element	Description
org.sonar.api.Property.module()	since 10.13. Modules are not used anymore.
org.sonarsource.api.sonarlint.SonarLintSide.MULTIPLE_ANALYSES	since 9.0 use SonarLintSide.INSTANCE as a direct replacement