org.sonar.runner.api

Class EmbeddedRunner

java.lang.Object

org.sonar.runner.api.EmbeddedRunner

public class EmbeddedRunner
extends Object

Entry point to run SonarQube analysis programmatically.

Since:

2.2

Method Summary

Methods

Modifier and Type	Method and Description
EmbeddedRunner	addExtensions(Object... objs) Add extensions to the batch's object container.
EmbeddedRunner	addGlobalProperties(Properties p) Declare Sonar properties, for example sonar.projectKey=>foo.
String	app()
String	appVersion()
static EmbeddedRunner	create(LogOutput logOutput)
protected void	doExecute(Properties analysisProperties, IssueListener issueListener)
protected void	doStart(boolean preferCache)
protected void	doStop()
void	execute() Deprecated. since 2.5 use start(), runAnalysis(Properties) and then stop()
Properties	globalProperties()
String	globalProperty(String key, String defaultValue)
EmbeddedRunner	mask(String fqcnPrefix)
void	runAnalysis(Properties analysisProperties) Launch an analysis.
void	runAnalysis(Properties analysisProperties, IssueListener issueListener) Launch an analysis, providing optionally a issue listener.
String	serverVersion()
EmbeddedRunner	setApp(String app, String version) User-agent used in the HTTP requests to the SonarQube server
EmbeddedRunner	setGlobalProperty(String key, String value) Declare a SonarQube property.
void	start()
void	start(boolean preferCache)
void	stop() Stops the batch.
void	syncProject(String projectKey) Synchronizes the project's data in the local cache with the server, allowing analysis of the project to be done offline.
EmbeddedRunner	unmask(String fqcnPrefix)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

create

public static EmbeddedRunner create(LogOutput logOutput)

globalProperties

public Properties globalProperties()

unmask

public EmbeddedRunner unmask(String fqcnPrefix)

mask

public EmbeddedRunner mask(String fqcnPrefix)

addGlobalProperties

public EmbeddedRunner addGlobalProperties(Properties p)

Declare Sonar properties, for example sonar.projectKey=>foo. These might be used at different stages (on or #runAnalysis(Properties), depending on the property and SQ version.

See Also:

#setProperty(String, String)

setGlobalProperty

public EmbeddedRunner setGlobalProperty(String key,
                               String value)

Declare a SonarQube property. These might be used at different stages (on or #runAnalysis(Properties), depending on the property and SQ version.

See Also:

RunnerProperties, ScanProperties

globalProperty

public String globalProperty(String key,
                    @Nullable
                    String defaultValue)

setApp

public EmbeddedRunner setApp(String app,
                    String version)

User-agent used in the HTTP requests to the SonarQube server

app

public String app()

addExtensions

public EmbeddedRunner addExtensions(Object... objs)

Add extensions to the batch's object container. Only supported until SQ 5.1. For more recent versions, an exception is thrown

Parameters:

objs -

appVersion

public String appVersion()

runAnalysis

public void runAnalysis(Properties analysisProperties)

Launch an analysis. Runner must have been started - see start().

runAnalysis

public void runAnalysis(Properties analysisProperties,
               @Nullable
               IssueListener issueListener)

Launch an analysis, providing optionally a issue listener. Runner must have been started - see start(). Issue listener is supported starting in SQ 5.2. If a non-null listener is given for older versions, an exception is thrown

syncProject

public void syncProject(String projectKey)

Synchronizes the project's data in the local cache with the server, allowing analysis of the project to be done offline. Runner must have been started - see start(). Only supported starting in SQ 5.2. For older versions, an exception is thrown

start

public void start()

start

public void start(boolean preferCache)

stop

public void stop()

Stops the batch. Only supported starting in SQ 5.2. For older versions, this is a no-op.

serverVersion

public String serverVersion()

execute

@Deprecated
public final void execute()

Deprecated. since 2.5 use start(), runAnalysis(Properties) and then stop()

doStart

protected void doStart(boolean preferCache)

doStop

protected void doStop()

doExecute

protected void doExecute(Properties analysisProperties,
             @Nullable
             IssueListener issueListener)