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.
|
AnnotationUtils |
A utility class for annotations
|
Authenticator |
|
Authenticator.Context |
|
BaseIdentityProvider |
|
BaseIdentityProvider.Context |
|
Beta |
This annotations marks API as experimental.
|
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.
|
CleanCodeAttribute |
|
CleanCodeAttributeCategory |
|
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 |
|
Context |
|
Cookie |
Framework-agnostic definition of a cookie.
|
CoreMetrics |
|
CoreProperties |
Non-exhaustive list of constants of core properties.
|
CsvWriter |
|
CyclicDependenciesException |
|
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.
|
FilterChain |
Filters use the FilterChain to invoke the next filter in the chain, or if the calling filter
is the last filter in the chain, to invoke the resource at the end of the chain.
|
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 |
|
HttpFilter |
A filter is an object that performs filtering tasks on either the
request to a resource (a servlet or static content), or on the response
from a resource, or both.
|
HttpRequest |
Framework-agnostic definition of an HTTP request.
|
HttpResponse |
Framework-agnostic definition of an HTTP response.
|
IdentityProvider |
Entry-point to define a new Identity provider.
|
IgnoreCommand |
|
IIssue |
|
ImpactMapper |
Deprecated.
|
IndexedFile |
|
InputComponent |
Common interface for all input components.
|
InputDir |
Deprecated.
|
InputFile |
This layer over File adds information for code analyzers.
|
InputFile.Status |
Status regarding previous analysis
|
InputFile.Type |
|
InputFileEdit |
|
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 |
|
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.
|
IssueStatus |
|
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
|
LoadedActiveRule |
|
LocalConnector |
This class allows a web service to call another web service through the sonar-ws library.
|
LocalConnector.LocalRequest |
|
LocalConnector.LocalResponse |
|
LocalizedMessages |
|
Logger |
Deprecated.
|
LoggerLevel |
Deprecated.
|
Loggers |
Deprecated.
|
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.
|
MessageFormatting |
Represents the data of the formatted part of the text in the issue message
|
MessageFormatting.Type |
|
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.
|
NewInputFileEdit |
|
NewIssue |
Represents an issue detected by a Sensor .
|
NewIssue.FlowType |
The type of the flow reported for a given issue.
|
NewIssueLocation |
Represents one issue location.
|
NewMeasure<G extends java.io.Serializable> |
Builder to create new Measure.
|
NewMessageFormatting |
Builder to create new MessageFormatting.
|
NewQuickFix |
|
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.
|
NewTextEdit |
|
NewUserHandler |
|
NewUserHandler.Context |
|
NewUserHandler.Context.Builder |
|
Node |
|
NoSonarFilter |
Issue filter used to ignore issues created on lines commented with the tag "NOSONAR".
|
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
|
PartImpl |
|
PathResolver |
|
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 |
|
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 |
|
Preconditions |
|
ProfileExporter |
Deprecated.
|
ProfileImporter |
Deprecated.
|
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 |
|
QuickFix |
Represents a quick fix for an Issue , with a description and a collection of InputFileEdit .
|
RangeDistributionBuilder |
Utility to build a distribution based on defined ranges
|
ReadCache |
|
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 |
|
RuleDescriptionSection |
Represents a sub-section of a rule description (What's the risk, Assess the risk, etc.)
|
RuleDescriptionSection.RuleDescriptionSectionKeys |
This class is a placeholder for the supported rule description section key constants.
|
RuleDescriptionSectionBuilder |
This builder allows to build the right implementation of RuleDescriptionSection , depending on the provided arguments
|
RuleFinder |
|
RuleKey |
Key of a rule.
|
RuleParam |
|
RuleParam |
|
RuleParamType |
|
RulePriority |
Deprecated.
|
RuleQuery |
|
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.CweVersion |
Deprecated.
|
RulesDefinition.DebtRemediationFunctions |
|
RulesDefinition.ExtendedRepository |
|
RulesDefinition.NewExtendedRepository |
|
RulesDefinition.NewParam |
|
RulesDefinition.NewRepository |
|
RulesDefinition.NewRule |
|
RulesDefinition.OwaspAsvsVersion |
|
RulesDefinition.OwaspTop10 |
|
RulesDefinition.OwaspTop10Version |
|
RulesDefinition.Param |
|
RulesDefinition.PciDssVersion |
|
RulesDefinition.Repository |
|
RulesDefinition.Rule |
|
RulesDefinitionAnnotationLoader |
Read definitions of rules based on the annotations provided by sonar-check-api.
|
RulesDefinitionContext |
|
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 |
Deprecated.
|
RuleType |
Deprecated.
|
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 |
Deprecated, for removal: This API element is subject to removal in a future version.
|
ServletFilter.UrlPattern |
|
ServletFilter.UrlPattern.Builder |
|
Settings |
|
Settings |
Deprecated.
|
Severity |
Deprecated.
|
Severity |
|
Severity |
Deprecated.
|
Slf4jLogger |
Implements Sonar logging facade on top of slf4j
|
SoftwareQuality |
|
SonarEdition |
|
SonarException |
Deprecated.
|
SonarLintSide |
Marker annotation for all the components available in container of sonarlint.
|
SonarProduct |
List of different products/runtimes.
|
SonarQubeSide |
Runtime stack in SonarQube product.
|
SonarRuntime |
Information about runtime environment.
|
Startable |
|
StreamConsumer |
|
StringPatternValidator |
Validates strings based on the defined regex.
|
StringStreamConsumer |
|
SubCategory |
|
System2 |
Proxy over System .
|
TempFolder |
Use this component to deal with temp files/folders.
|
TextEdit |
Represents a text edit, composed of a replacement text and the text range to replace
|
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 |
|
UrlPattern |
|
UrlPattern.Builder |
|
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 |
|
ValidatingRequest |
|
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.
|
WriteCache |
|
WriterException |
|
XmlWriter |
TODO document that output is UTF-8
|
ZipUtils |
Utility to zip directories and unzip files.
|