All Classes Interface Summary Class Summary Enum Summary Exception Summary Annotation Types Summary
Class |
Description |
AbstractLanguage |
Inherit this class to define a new language like PLSQL, PHP or C#
|
ActiveRule |
Configuration of a rule activated on a Quality profile
|
ActiveRule |
|
ActiveRuleParam |
|
ActiveRules |
The rules that are activated on the current project.
|
AdHocRule |
Represents a rule imported from an external rule engine by a Sensor .
|
Analysis |
|
AnalysisError |
Represents an analysis error, such as a parsing error, reported by a Sensor .
|
AnalysisWarnings |
Record user-friendly warnings that will be visible on SonarQube
to users with browse access to the project.
|
AnnotationRuleParser |
Deprecated.
|
AnnotationUtils |
A utility class for annotations
|
Authenticator |
|
Authenticator.Context |
|
BaseIdentifiable<G> |
Deprecated.
|
BaseIdentityProvider |
|
BaseIdentityProvider.Context |
|
BatchComponent |
Deprecated.
|
BlameCommand |
This class should be implemented by SCM providers.
|
BlameCommand.BlameInput |
Callback for the provider to report results of blame per file.
|
BlameCommand.BlameOutput |
Callback for the provider to report results of blame per file.
|
BlameLine |
|
Branch |
|
Branch.Type |
|
BuiltInQualityProfileAnnotationLoader |
Read definitions of quality profiles based on the annotation BelongsToProfile provided by sonar-check-api.
|
BuiltInQualityProfilesDefinition |
Define built-in quality profiles which are automatically registered during SonarQube startup.
|
BuiltInQualityProfilesDefinition.BuiltInActiveRule |
A rule activated on a built in quality profile.
|
BuiltInQualityProfilesDefinition.BuiltInQualityProfile |
|
BuiltInQualityProfilesDefinition.BuiltInQualityProfileImpl |
|
BuiltInQualityProfilesDefinition.Context |
Instantiated by core but not by plugins, except for their tests.
|
BuiltInQualityProfilesDefinition.NewBuiltInActiveRule |
|
BuiltInQualityProfilesDefinition.NewBuiltInQualityProfile |
|
BuiltInQualityProfilesDefinition.NewBuiltInQualityProfileImpl |
|
BuiltInQualityProfilesDefinition.NewOverriddenParam |
|
BuiltInQualityProfilesDefinition.OverriddenParam |
|
Category |
|
CeTask |
|
CeTask.Status |
|
Change |
Used to describe the changes that occurred on a web service action
|
CheckFactory |
|
Checks<C> |
Instantiates checks (objects that provide implementation of coding
rules) that use sonar-check-api annotations.
|
Command |
|
CommandException |
|
CommandExecutor |
Synchronously execute a native command line.
|
Component |
|
Component.FileAttributes |
|
Component.Type |
|
ComputeEngineSide |
Same as ScannerSide but for components for the Compute Engine Server.
|
Configuration |
Component to get effective configuration.
|
Context |
|
CoreMetrics |
|
CoreProperties |
Non-exhaustive list of constants of core properties.
|
CsvWriter |
|
CyclicDependenciesException |
|
DatabaseProperties |
Deprecated.
|
DateUtils |
|
DebtRemediationFunction |
Function used to calculate the remediation cost of an issue.
|
DebtRemediationFunction.Type |
|
DefaultDebtRemediationFunction |
|
DefaultGroups |
Name of the default user groups
|
DefaultNewParam |
|
DefaultNewRepository |
|
DefaultParam |
|
DefaultRepository |
|
DefaultRule |
|
DefaultTransitions |
|
Definable<T> |
|
DependedUpon |
|
DependsUpon |
|
DirectAcyclicGraph |
|
Display |
Display information provided by the Identity Provider to be displayed into the login form.
|
Display.Builder |
|
Duration |
|
Durations |
|
EmailSettings |
|
ExtensionPoint |
Marker annotation for all the interfaces that are extension point (ie can be implemented by plugins
and will be called at some point of time by the platform).
|
ExternalGroupsProvider |
Note that prefix "do" for names of methods is reserved for future enhancements, thus should not be used in subclasses.
|
ExternalGroupsProvider.Context |
|
ExternalIssue |
Represents an issue imported from an external rule engine by a Sensor .
|
ExternalUsersProvider |
Note that prefix "do" for names of methods is reserved for future enhancements, thus should not be used in subclasses.
|
ExternalUsersProvider.Context |
|
FieldUtils2 |
Add features missing in org.apache.commons.lang.reflect.FieldUtils .
|
FileExclusions |
Deprecated.
|
FileLinesContext |
Provides facility to store measures for the lines of file.
|
FileLinesContextFactory |
This interface is not intended to be implemented by clients.
|
FilePredicate |
Determines if a file must be kept in search results.
|
FilePredicates |
|
FileSystem |
The FileSystem manages all the source files to be analyzed.
|
FileSystem.Index |
Interface of the underlying file index.
|
FilterableIssue |
Deprecated.
|
GlobalPropertyChangeHandler |
Observe changes of global properties done from web application.
|
GlobalPropertyChangeHandler.PropertyChange |
|
HttpDownloader |
This component is available in IoC container, so it should be injected through
a constructor parameter.
|
HttpDownloader.HttpException |
|
I18n |
Deprecated.
|
IdentityProvider |
Entry-point to define a new Identity provider.
|
IgnoreCommand |
|
IIssue |
|
IndexedFile |
|
InputComponent |
Common interface for all input components.
|
InputDir |
Deprecated.
|
InputFile |
This layer over File adds information for code analyzers.
|
InputFile.Status |
Deprecated.
|
InputFile.Type |
|
InputFileFilter |
Extension point to exclude some files from inspection
|
InputModule |
Deprecated.
|
InputPath |
Layer over File for files or directories.
|
InputProject |
Used to create issues and measures on project.
|
InstantiationStrategy |
Deprecated.
|
Issue |
Represents an issue detected by a Sensor .
|
Issue |
|
Issue |
|
Issue.Flow |
|
IssueComment |
Deprecated.
|
IssueFilter |
Deprecated.
|
IssueFilterChain |
A filter chain is an object provided to issues filters for fine control over the filtering logic.
|
IssueLocation |
Represents an issue location.
|
JsonWriter |
Deprecated.
|
KeyValueFormat |
Formats and parses key/value pairs with the text representation : "key1=value1;key2=value2".
|
KeyValueFormat.Converter<T> |
|
KeyValueFormat.DateConverter |
|
KeyValueFormat.DoubleConverter |
|
KeyValueFormat.IntegerConverter |
|
KeyValueFormat.PriorityConverter |
|
KeyValueFormat.StringConverter |
|
KeyValueFormat.ToStringConverter |
|
Language |
The extension point to define a new language
|
Languages |
A class to store the list of languages
|
ListInterceptor |
|
LoadedActiveRule |
|
LocalConnector |
This class allows a web service to call another web service through the sonar-ws library.
|
LocalConnector.LocalRequest |
|
LocalConnector.LocalResponse |
|
LocalizedMessages |
|
LogAndArguments |
|
Logger |
SonarQube plugins are not coupled with external logging libraries like SLF4J or Logback.
|
LoggerFactory |
|
LoggerLevel |
|
Loggers |
|
LoginPasswordAuthenticator |
Deprecated.
|
LogTester |
For tests only
This JUnit rule allows to configure and access logs in tests.
|
LogTesterJUnit5 |
For tests only
This JUnit 5 extension allows to configure and access logs in tests.
|
ManifestUtils |
|
Measure<G extends java.io.Serializable> |
Measure on File, Directory or Project.
|
Measure |
|
MeasureComputer |
Define how to compute new measures on some metrics declared by Metrics .
|
MeasureComputer.MeasureComputerContext |
Context specific to the computation of the measure(s) of a given component
|
MeasureComputer.MeasureComputerDefinition |
|
MeasureComputer.MeasureComputerDefinition.Builder |
|
MeasureComputer.MeasureComputerDefinitionContext |
Context specific to the definition of the measure computer
|
MessageException |
Runtime exception for "functional" error.
|
Metric<G extends java.io.Serializable> |
|
Metric<G extends java.io.Serializable> |
Used to define a metric in a plugin.
|
Metric.Builder |
Metric.Builder is used to create metric definitions.
|
Metric.Level |
|
Metric.ValueType |
|
MetricFinder |
|
Metrics |
This is the extension point used by plugins to declare new metrics.
|
NewAdHocRule |
Builder for a rule imported from an external rule engine by a Sensor .
|
NewAnalysisError |
Represents an analysis error, such as a parsing error, that occurs during the execution of a Sensor .
|
NewCoverage |
This class is used to report code coverage on files.
|
NewCpdTokens |
This builder is used to define tokens used by CPD algorithm on files.
|
NewExternalIssue |
Builder for an issue imported from an external rule engine by a Sensor .
|
NewHighlighting |
This builder is used to define syntax highlighting (aka code coloration) on files.
|
NewIssue |
Represents an issue detected by a Sensor .
|
NewIssueLocation |
Represents one issue location.
|
NewMeasure<G extends java.io.Serializable> |
Builder to create new Measure.
|
NewSignificantCode |
This object is used to report ranges of a file which contain significant code.
|
NewSymbol |
This builder is used to define symbol references on files.
|
NewSymbolTable |
This builder is used to define symbol references on files.
|
NewUserHandler |
|
NewUserHandler.Context |
|
NewUserHandler.Context.Builder |
|
Node |
|
NoSonarFilter |
Issue filter used to ignore issues created on lines commented with the tag "NOSONAR".
|
Notification |
Deprecated.
|
NotificationChannel |
Deprecated.
|
OAuth2IdentityProvider |
|
OAuth2IdentityProvider.CallbackContext |
|
OAuth2IdentityProvider.InitContext |
|
OAuth2IdentityProvider.OAuth2Context |
|
Organization |
|
Page |
|
Page.Builder |
|
Page.Qualifier |
|
Page.Scope |
|
PageDefinition |
Defines the Javascript pages added to SonarQube.
|
Paging |
|
Paging.Builder |
|
ParsingUtils |
Utility to parse various inputs
|
PathResolver |
|
PathResolver.RelativePath |
Deprecated.
|
PathUtils |
|
Phase |
|
Phase.Name |
|
Plugin |
Entry-point for plugins to inject extensions into SonarQube.
|
Plugin.Context |
|
PostJob |
PostJobs are executed at the very end of scanner analysis.
|
PostJobContext |
|
PostJobDescriptor |
|
PostJobIssue |
Represents an issue state at the end of the scanner analysis in preview/issues mode.
|
PostProjectAnalysisTask |
Extension point of which any plugin can provide an implementation and will allow them to be notified whenever some
analysis report processing ends in the Compute Engine.
|
PostProjectAnalysisTask.Context |
|
PostProjectAnalysisTask.LogStatistics |
Each key-value paar will be added to the log describing the end of the
|
PostProjectAnalysisTask.ProjectAnalysis |
|
PostProjectAnalysisTaskTester |
|
PostProjectAnalysisTaskTester.AnalysisBuilder |
|
PostProjectAnalysisTaskTester.BranchBuilder |
|
PostProjectAnalysisTaskTester.CeTaskBuilder |
|
PostProjectAnalysisTaskTester.ConditionBuilder |
|
PostProjectAnalysisTaskTester.ProjectAnalysisBuilder |
|
PostProjectAnalysisTaskTester.ProjectBuilder |
|
PostProjectAnalysisTaskTester.QualityGateBuilder |
|
PostProjectAnalysisTaskTester.ScannerContextBuilder |
|
Preconditions |
|
ProfileExporter |
Export quality profile rules to a file
|
ProfileImporter |
Create a quality profile from an external rules file.
|
Profiler |
|
Project |
|
ProjectBuilder |
Deprecated.
|
ProjectBuilder.Context |
Deprecated. |
ProjectBuilderContext |
Deprecated.
|
ProjectDefinition |
Deprecated.
|
ProjectReactor |
Deprecated.
|
ProjectSensor |
A sensor is invoked once for each project analysis.
|
Properties |
Plugin properties.
|
Property |
Property value can be set in different ways :
System property
Batch command-line (-Dfoo=bar in Maven or sonar-runner)
Maven pom.xml (element <properties>)
Maven settings.xml
SonarQube web administration console
|
PropertyDefinition |
Declare a plugin property.
|
PropertyDefinition.Builder |
|
PropertyDefinition.Result |
|
PropertyDefinitions |
Metadata of all the properties declared by plugins
|
PropertyField |
Property field.
|
PropertyFieldDefinition |
|
PropertyFieldDefinition.Builder |
|
PropertyType |
|
Qualifiers |
The qualifier determines the exact type of a resource.
|
QualityGate |
|
QualityGate.Condition |
|
QualityGate.EvaluationStatus |
Quality gate condition evaluation status.
|
QualityGate.Operator |
Quality Gate condition operator.
|
QualityGate.Status |
|
RangeDistributionBuilder |
Utility to build a distribution based on defined ranges
|
Request |
|
Request.Param<T> |
Represents a Request parameter, provides information whether is was specified or not (check Request.Param.isPresent() )
and utility method to nicely handles cases where the parameter is not present.
|
Request.Part |
|
Request.StringParam |
Extends Request.Param with convenience methods specific to the type String .
|
RequestHandler |
Extension point to execute a HTTP request.
|
ResourceType |
Experimental extension to declare types of resources.
|
ResourceType.Builder |
|
ResourceTypes |
|
ResourceTypeTree |
|
ResourceTypeTree.Builder |
|
Response |
HTTP response
|
Response.Stream |
|
Rule |
|
Rule |
|
RuleAnnotationUtils |
|
RuleFinder |
|
RuleKey |
Key of a rule.
|
RuleParam |
|
RuleParam |
|
RuleParamType |
|
RulePriority |
Deprecated.
|
RuleQuery |
|
Rules |
Deprecated.
|
RuleScope |
|
RulesDefinition |
Defines some coding rules of the same repository.
|
RulesDefinition.AbstractContext |
Instantiated by core but not by plugins, except for their tests.
|
RulesDefinition.Context |
This implementation will be removed as soon as analyzers stop instantiating it.
|
RulesDefinition.DebtRemediationFunctions |
|
RulesDefinition.ExtendedRepository |
|
RulesDefinition.NewExtendedRepository |
|
RulesDefinition.NewParam |
|
RulesDefinition.NewRepository |
|
RulesDefinition.NewRule |
|
RulesDefinition.OwaspTop10 |
|
RulesDefinition.Param |
|
RulesDefinition.Repository |
|
RulesDefinition.Rule |
|
RulesDefinitionAnnotationLoader |
Read definitions of rules based on the annotations provided by sonar-check-api.
|
RulesDefinitionXmlLoader |
Deprecated.
|
RulesProfile |
This class is badly named.
|
RuleStatus |
|
RuleTagFormat |
The characters allowed in rule tags are the same as those on StackOverflow, basically lower-case
letters, digits, plus (+), sharp (#), dash (-) and dot (.)
See http://meta.stackoverflow.com/questions/22624/what-symbols-characters-are-not-allowed-in-tags
|
RuleTagsToTypeConverter |
|
RuleType |
|
ScannerContext |
|
ScannerSide |
Deprecated.
|
ScannerSide |
Marker annotation for all the components available in the container of the scanner (code analyzer).
|
ScmProvider |
|
Scopes |
Resource scopes are used to group some types of resources.
|
SecurityRealm |
|
Sensor |
A sensor is invoked once for each module of a project, starting from leaf modules.
|
SensorContext |
|
SensorDescriptor |
Describe what a Sensor is doing.
|
SensorStorage |
Interface for storing data computed by sensors.
|
Server |
Runtime information about server
|
ServerFileSystem |
|
ServerSide |
|
ServerStartHandler |
|
ServerStopHandler |
|
ServerUpgradeStatus |
|
ServletFilter |
|
ServletFilter.UrlPattern |
|
ServletFilter.UrlPattern.Builder |
|
Settings |
|
Settings |
Deprecated.
|
Severity |
|
Severity |
|
SonarEdition |
|
SonarException |
Deprecated.
|
SonarLintSide |
Marker annotation for all the components available in container of sonarlint.
|
SonarPlugin |
Deprecated.
|
SonarProduct |
List of different products/runtimes.
|
SonarQubeSide |
Runtime stack in SonarQube product.
|
SonarQubeVersion |
Deprecated.
|
SonarRuntime |
Information about runtime environment.
|
Startable |
|
StreamConsumer |
|
StringStreamConsumer |
|
SubCategory |
|
System2 |
Proxy over System .
|
Task |
Deprecated.
|
TaskDefinition |
Deprecated.
|
TaskDefinition.Builder |
|
TempFolder |
Use this component to deal with temp files/folders.
|
TestComponent |
|
TestComponent.FileAttributesImpl |
|
TestIssue |
|
TestIssue.Builder |
|
TestMeasure |
|
TestMeasureComputerContext |
|
TestMeasureComputerDefinition |
|
TestMeasureComputerDefinition.MeasureComputerDefinitionBuilderImpl |
|
TestMeasureComputerDefinitionContext |
|
TestSettings |
|
TextPointer |
Represents a position in a text file InputFile
|
TextRange |
|
TimeoutException |
Unchecked version of TimeoutException
|
TimeUtils |
|
TokensLine |
Immutable code fragment, which formed from tokens of one line.
|
TypeOfText |
Possible types for highlighting code.
|
UnauthorizedException |
This exception should be used when a functional error is generated by an Identity Provider plugin.
|
UriReader |
Reads different types of URI.
|
UriReader.SchemeProcessor |
|
User |
Deprecated.
|
User |
|
UserDetails |
This class is not intended to be subclassed by clients.
|
UserGroupValidation |
|
UserIdentity |
User information provided by the Identity Provider to be register into the platform.
|
UserIdentity.Builder |
|
UserQuery |
|
UserQuery.Builder |
|
UserRole |
|
ValidationMessages |
|
Version |
Version composed of maximum four fields (major, minor, patch and build ID numbers) and optionally a qualifier.
|
WebAnalytics |
Extension point to support a web analytics tool like Matomo or
Google Analytics in the webapp.
|
WebService |
Defines a web service.
|
WebService.Action |
|
WebService.Context |
|
WebService.Controller |
|
WebService.NewAction |
|
WebService.NewController |
|
WebService.NewParam |
|
WebService.Param |
|
WebService.SelectionMode |
|
WildcardPattern |
Implementation of Ant-style matching patterns.
|
WriterException |
|
XMLProfileParser |
Deprecated.
|
XMLProfileSerializer |
Deprecated.
|
XmlWriter |
TODO document that output is UTF-8
|
ZipUtils |
Utility to zip directories and unzip files.
|
ZipUtils.ZipEntryFilter |
Deprecated.
|