Deprecated API

Contents

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

For Removal

Element	Description
org.sonar.api.security.Authenticator.Context.getRequest()	since 9.16. Use Authenticator.Context.getHttpRequest() instead.
org.sonar.api.security.ExternalGroupsProvider.Context.getRequest()	since 9.16. Use ExternalGroupsProvider.Context.getHttpRequest() instead.
org.sonar.api.security.ExternalUsersProvider.Context.getRequest()	since 9.16. Use ExternalUsersProvider.Context.getHttpRequest() instead.
org.sonar.api.server.authentication.BaseIdentityProvider.Context.getRequest()	since 9.16. Use BaseIdentityProvider.Context.getHttpRequest() instead.
org.sonar.api.server.authentication.BaseIdentityProvider.Context.getResponse()	since 9.16. Use BaseIdentityProvider.Context.getHttpResponse() instead.
org.sonar.api.server.authentication.OAuth2IdentityProvider.OAuth2Context.getRequest()	since 9.16. Use OAuth2IdentityProvider.OAuth2Context.getHttpRequest() instead.
org.sonar.api.server.authentication.OAuth2IdentityProvider.OAuth2Context.getResponse()	since 9.16. Use OAuth2IdentityProvider.OAuth2Context.getHttpResponse() instead.
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.ServletFilter	since 9.16. Use HttpFilter instead.

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.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.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.profiles.ProfileExporter	since 9.1. Web services should be used instead.
org.sonar.api.profiles.ProfileImporter	since 9.1. Web services should be used instead.
org.sonar.api.rule.Severity	since 10.1, use impacts with Severity instead
org.sonar.api.scan.filesystem.FileExclusions	since 7.6
org.sonar.api.server.rule.internal.ImpactMapper	since 10.1 This is only used for mapping deprecated types and severities until they are removed
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.server.rule.RuleTagsToTypeConverter	since 10.1.
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
org.sonar.api.web.ServletFilter	since 9.16. Use HttpFilter instead.

Enums

Enum	Description
org.sonar.api.batch.rule.Severity	since 10.1, use impacts with Severity instead
org.sonar.api.rules.RulePriority	since 4.2
org.sonar.api.rules.RuleType	since 10.1, use impacts with SoftwareQuality instead
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

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.OPEN_AS_VULNERABILITY	since 8.1, security hotspots can no longer be converted to vulnerabilities
org.sonar.api.issue.DefaultTransitions.SET_AS_IN_REVIEW	since 8.1, transition has no effect
org.sonar.api.issue.DefaultTransitions.WONT_FIX	since 10.3, use DefaultTransitions.ACCEPT instead
org.sonar.api.issue.Issue.STATUS_IN_REVIEW	since 8.1, status has been mapped as `TO_REVIEW`
org.sonar.api.measures.CoreMetrics.CLASS_COMPLEXITY	since 6.7
org.sonar.api.measures.CoreMetrics.CLASS_COMPLEXITY_KEY	since 6.7
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.COMPLEXITY_IN_CLASSES	since 6.7
org.sonar.api.measures.CoreMetrics.COMPLEXITY_IN_CLASSES_KEY	since 6.7
org.sonar.api.measures.CoreMetrics.COMPLEXITY_IN_FUNCTIONS	since 6.7
org.sonar.api.measures.CoreMetrics.COMPLEXITY_IN_FUNCTIONS_KEY	since 6.7
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.FILE_COMPLEXITY	since 6.7
org.sonar.api.measures.CoreMetrics.FILE_COMPLEXITY_DISTRIBUTION	since 6.7
org.sonar.api.measures.CoreMetrics.FILE_COMPLEXITY_DISTRIBUTION_KEY	since 6.7
org.sonar.api.measures.CoreMetrics.FILE_COMPLEXITY_KEY	since 6.7
org.sonar.api.measures.CoreMetrics.FUNCTION_COMPLEXITY	since 6.7
org.sonar.api.measures.CoreMetrics.FUNCTION_COMPLEXITY_DISTRIBUTION	since 6.7
org.sonar.api.measures.CoreMetrics.FUNCTION_COMPLEXITY_DISTRIBUTION_KEY	since 6.7
org.sonar.api.measures.CoreMetrics.FUNCTION_COMPLEXITY_KEY	since 6.7
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.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.ExternalIssue.severity()	since 10.1, use ExternalIssue.impacts() instead
org.sonar.api.batch.sensor.issue.ExternalIssue.type()	since 10.1, use ExternalIssue.impacts() instead
org.sonar.api.batch.sensor.issue.Issue.overriddenSeverity()	since 10.1, use Issue.overridenImpacts() instead
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.issue.NewExternalIssue.severity(Severity)	since 10.1, use {@link #addImpact(SoftwareQuality softwareQuality, org.sonar.api.issue.impact.Severity severity)()} instead
org.sonar.api.batch.sensor.issue.NewExternalIssue.type(RuleType)	since 10.1, use {@link #addImpact(SoftwareQuality softwareQuality, org.sonar.api.issue.impact.Severity severity)()} instead
org.sonar.api.batch.sensor.issue.NewIssue.overrideSeverity(Severity)	since 10.1, use NewIssue.overrideImpact(SoftwareQuality, org.sonar.api.issue.impact.Severity) instead
org.sonar.api.batch.sensor.rule.AdHocRule.severity()	since 10.1, use AdHocRule.defaultImpacts() instead
org.sonar.api.batch.sensor.rule.AdHocRule.type()	since 10.1, use AdHocRule.defaultImpacts() instead
org.sonar.api.batch.sensor.rule.NewAdHocRule.severity(Severity)	since 10.1, use impacts with NewAdHocRule.addDefaultImpact(SoftwareQuality, org.sonar.api.issue.impact.Severity) instead
org.sonar.api.batch.sensor.rule.NewAdHocRule.type(RuleType)	since 10.1, use impacts with NewAdHocRule.addDefaultImpact(SoftwareQuality, org.sonar.api.issue.impact.Severity) instead
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.severity()	since 10.1, use Issue.impacts() instead
org.sonar.api.ce.measure.Issue.type()	since 10.1, use Issue.impacts() instead
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.issue.Issue.attribute(String)	since 9.4, attribute was already not returning any element since 5.2
org.sonar.api.issue.Issue.attributes()	since 9.4, attribute was already not returning any element since 5.2
org.sonar.api.issue.Issue.severity()	since 10.1
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.profiles.RulesProfile.getUsed()	profile versioning is dropped in 4.4. Always returns null.
org.sonar.api.profiles.RulesProfile.getVersion()	profile versioning is dropped in 4.4. Always returns -1.
org.sonar.api.profiles.RulesProfile.setUsed(Boolean)	profile versioning is dropped in 4.4. Always returns -1.
org.sonar.api.profiles.RulesProfile.setVersion(int)	profile versioning is dropped in 4.4. Always returns -1.
org.sonar.api.rules.ActiveRule.getOverriddenSeverity()	since 6.6, internal usage only
org.sonar.api.rules.ActiveRule.getPluginName()	since 2.3 use ActiveRule.getRepositoryKey() instead
org.sonar.api.rules.ActiveRule.setActiveRuleParams(List<ActiveRuleParam>)	use setParameter()
org.sonar.api.rules.ActiveRule.setId(Integer)	visibility should be decreased to protected or package
org.sonar.api.rules.ActiveRule.setRule(Rule)	visibility should be reduced to protected or package
org.sonar.api.rules.ActiveRule.setRulesProfile(RulesProfile)	visibility should be reduced to protected or package
org.sonar.api.rules.ActiveRuleParam.setActiveRule(ActiveRule)	visibility should be decreased to protected or package
org.sonar.api.rules.ActiveRuleParam.setRuleParam(RuleParam)	visibility should be decreased to protected or package
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.security.Authenticator.Context.getRequest()	since 9.16. Use Authenticator.Context.getHttpRequest() instead.
org.sonar.api.security.ExternalGroupsProvider.Context.getRequest()	since 9.16. Use ExternalGroupsProvider.Context.getHttpRequest() instead.
org.sonar.api.security.ExternalUsersProvider.Context.getRequest()	since 9.16. Use ExternalUsersProvider.Context.getHttpRequest() instead.
org.sonar.api.server.authentication.BaseIdentityProvider.Context.getRequest()	since 9.16. Use BaseIdentityProvider.Context.getHttpRequest() instead.
org.sonar.api.server.authentication.BaseIdentityProvider.Context.getResponse()	since 9.16. Use BaseIdentityProvider.Context.getHttpResponse() instead.
org.sonar.api.server.authentication.OAuth2IdentityProvider.OAuth2Context.getRequest()	since 9.16. Use OAuth2IdentityProvider.OAuth2Context.getHttpRequest() instead.
org.sonar.api.server.authentication.OAuth2IdentityProvider.OAuth2Context.getResponse()	since 9.16. Use OAuth2IdentityProvider.OAuth2Context.getHttpResponse() instead.
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.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.NewRule.setSeverity(String)	since 10.1. Use RulesDefinition.NewRule.addDefaultImpact(SoftwareQuality, Severity) instead
org.sonar.api.server.rule.RulesDefinition.NewRule.setType(RuleType)	since 10.1. Use RulesDefinition.NewRule.addDefaultImpact(SoftwareQuality, Severity) instead
org.sonar.api.server.rule.RulesDefinition.Rule.markdownDescription()	since 9.6. Use html format instead
org.sonar.api.server.rule.RulesDefinition.Rule.severity()	since 10.1, use RulesDefinition.Rule.defaultImpacts() instead
org.sonar.api.server.rule.RulesDefinition.Rule.type()	since 10.1, use RulesDefinition.Rule.defaultImpacts() 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

Constructors

Constructor	Description
org.sonar.api.profiles.RulesProfile()	use the factory method create()
org.sonar.api.rules.ActiveRule()	visibility should be reduced to protected or package
org.sonar.api.rules.ActiveRuleParam()	visibility should be decreased to protected or package

Annotation Type Elements

Annotation Type Element	Description
org.sonarsource.api.sonarlint.SonarLintSide.MULTIPLE_ANALYSES	since 9.0 use SonarLintSide.INSTANCE as a direct replacement