org.sonarsource.scanner.api

Class EmbeddedScanner

java.lang.Object

org.sonarsource.scanner.api.EmbeddedScanner

public class EmbeddedScanner
extends Object

Entry point to run SonarQube analysis programmatically.

Since:

2.2

Method Summary

Modifier and Type	Method and Description
EmbeddedScanner	addExtensions(Object... objs) Add extensions to the batch's object container.
EmbeddedScanner	addGlobalProperties(Properties p) Declare Sonar properties, for example sonar.projectKey=foo.
String	app()
String	appVersion()
static EmbeddedScanner	create(LogOutput logOutput)
protected void	doExecute(Properties analysisProperties)
protected void	doStart()
protected void	doStop()
void	execute() Deprecated. since 2.5 use start(), runAnalysis(Properties) and then stop()
Properties	globalProperties()
String	globalProperty(String key, String defaultValue)
EmbeddedScanner	mask(String fqcnPrefix)
void	runAnalysis(Properties analysisProperties) Launch an analysis.
String	serverVersion()
EmbeddedScanner	setApp(String app, String version) User-agent used in the HTTP requests to the SonarQube server
EmbeddedScanner	setGlobalProperty(String key, String value) Declare a SonarQube property.
void	start()
void	stop() Stops the batch.
EmbeddedScanner	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 EmbeddedScanner create(LogOutput logOutput)

globalProperties

public Properties globalProperties()

unmask

public EmbeddedScanner unmask(String fqcnPrefix)

mask

public EmbeddedScanner mask(String fqcnPrefix)

addGlobalProperties

public EmbeddedScanner 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.

setGlobalProperty

public EmbeddedScanner 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:

ScannerProperties, ScanProperties

globalProperty

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

setApp

public EmbeddedScanner setApp(String app,
                              String version)

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

app

public String app()

addExtensions

public EmbeddedScanner 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().

start

public void start()

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()

doStop

protected void doStop()

doExecute

protected void doExecute(Properties analysisProperties)