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	addGlobalProperties(Map<String,String> p) Declare SonarQube properties needed to download the scanner-engine from the server (sonar.host.url, credentials, proxy, ...).
String	app()
String	appVersion()
static EmbeddedScanner	create(String app, String version, LogOutput logOutput)
static EmbeddedScanner	create(String app, String version, LogOutput logOutput, System2 system2)
protected void	doExecute(Map<String,String> properties)
protected void	doStart()
void	execute(Map<String,String> taskProps)
Map<String,String>	globalProperties()
String	globalProperty(String key, String defaultValue)
EmbeddedScanner	mask(String fqcnPrefix)
String	serverVersion()
EmbeddedScanner	setGlobalProperty(String key, String value) Declare a SonarQube property needed to download the scanner-engine from the server (sonar.host.url, credentials, proxy, ...).
void	start() Download scanner-engine JAR and start bootstrapping classloader.
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(String app,
                                     String version,
                                     LogOutput logOutput,
                                     System2 system2)

create

public static EmbeddedScanner create(String app,
                                     String version,
                                     LogOutput logOutput)

globalProperties

public Map<String,String> globalProperties()

unmask

public EmbeddedScanner unmask(String fqcnPrefix)

mask

public EmbeddedScanner mask(String fqcnPrefix)

addGlobalProperties

public EmbeddedScanner addGlobalProperties(Map<String,String> p)

Declare SonarQube properties needed to download the scanner-engine from the server (sonar.host.url, credentials, proxy, ...).

setGlobalProperty

public EmbeddedScanner setGlobalProperty(String key,
                                         String value)

Declare a SonarQube property needed to download the scanner-engine from the server (sonar.host.url, credentials, proxy, ...).

globalProperty

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

app

public String app()

appVersion

public String appVersion()

start

public void start()

Download scanner-engine JAR and start bootstrapping classloader. After that it is possible to call serverVersion()

serverVersion

public String serverVersion()

execute

public void execute(Map<String,String> taskProps)

doStart

protected void doStart()

doExecute

protected void doExecute(Map<String,String> properties)