Package com.hello2morrow.sonargraph.build.api

Interface ISonargraphBuild

public interface ISonargraphBuild

Service interface for SonargraphBuild application.

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static class	ISonargraphBuild.Version

Method Summary

Modifier and Type	Method	Description
ServiceResponse	checkQualityGates()	Returns the summary of quality gate results as output of the ServiceResponse.
ServiceResponse	close()	Closes an open software system.
ServiceResponseWithOutcome<java.io.File>	createDynamicSystem(SystemInfo system, java.io.File qualityModelFile)	Creates a new software system
ServiceResponse	createReport(ReportRequest reportRequest)	Create a report for the opened and refreshed software system.
ServiceResponse	createSnapshot(java.io.File snapshotDir, java.lang.String snapshotFileName)	Create a snapshot for the opened and refreshed software system.
ServiceResponse	failIfExists(FailSet failSet)	Checks if the specified FailSet matches any issues in the opened and refreshed software system.
ServiceResponse	getInitializationStatus()
ServiceResponse	getScriptRunnerStatus()
default ISonargraphBuild.Version	getVersion()	Return version of Sonargraph Build
ServiceResponse	open(java.io.File systemDirectory)	Open the specified software system.
ServiceResponse	open(java.io.File systemDirectory, SystemInfo systemInfo, java.lang.String workspaceProfile, java.io.File qualityModelFile)	Open the specified software system.
ServiceResponse	open(java.io.File systemDirectory, SystemInfo systemInfo, java.lang.String workspaceProfile, java.io.File qualityModelFile, java.util.Map<java.lang.String,java.lang.String> instSpecificParameterMap)	Open the specified software system.
ServiceResponse	open(java.io.File systemDirectory, java.lang.String workspaceProfile)	Deprecated. use open(File, String, File) instead.
ServiceResponse	open(java.io.File systemDirectory, java.lang.String workspaceProfile, java.io.File qualityModelFile)	Deprecated.
ServiceResponse	refresh()	Refresh the opened software system.
ServiceResponse	resendFaildUploads(ResendFailedUploadsRequest request)	Try to re-send all failed report uploads.
ServiceResponse	setVirtualModel(java.lang.String virtualModelName)	Sets the specified virtual model

Method Detail

open

ServiceResponse open(java.io.File systemDirectory)

Open the specified software system.

Parameters:

systemDirectory - the directory of the software system.

Returns:

ServiceResponse containing status info.

open

@Deprecated
ServiceResponse open(java.io.File systemDirectory,
                     java.lang.String workspaceProfile)

Deprecated.

use open(File, String, File) instead.

Open the specified software system.

Parameters:

systemDirectory - the directory of the software system.

workspaceProfile - the workspace profile to be used.

Returns:

ServiceResponse containing status info.

open

@Deprecated
ServiceResponse open(java.io.File systemDirectory,
                     java.lang.String workspaceProfile,
                     java.io.File qualityModelFile)

Deprecated.

Open the specified software system. Only one of 'systemInfo' or 'workspaceProfile' may be specified (or both might be 'null').

Parameters:

systemDirectory - the directory of the software system.

workspaceProfile - the workspace profile to be used - might be 'null'.

qualityModelFile - the quality model file to be used - might be 'null'.

Returns:

ServiceResponse containing status info.

open

ServiceResponse open(java.io.File systemDirectory,
                     SystemInfo systemInfo,
                     java.lang.String workspaceProfile,
                     java.io.File qualityModelFile)

Open the specified software system. Only one of 'systemInfo' or 'workspaceProfile' may be specified (or both might be 'null').

Parameters:

systemDirectory - the directory of the software system.

systemInfo - the system info - might be 'null'.

workspaceProfile - the workspace profile to be used - might be 'null'.

qualityModelFile - the quality model file to be used - might be 'null'.

Returns:

ServiceResponse containing status info.

open

ServiceResponse open(java.io.File systemDirectory,
                     SystemInfo systemInfo,
                     java.lang.String workspaceProfile,
                     java.io.File qualityModelFile,
                     java.util.Map<java.lang.String,java.lang.String> instSpecificParameterMap)

Open the specified software system. Only one of 'systemInfo' or 'workspaceProfile' may be specified (or both might be 'null').

Parameters:

systemDirectory - the directory of the software system.

systemInfo - the system info - might be 'null'.

workspaceProfile - the workspace profile to be used - might be 'null'.

qualityModelFile - the quality model file to be used - might be 'null'.

instSpecificParameterMap - a map containing installation specific parameters (e.g. the active C/C++ compiler definition to be used).

Returns:

ServiceResponse containing status info.

getInitializationStatus

ServiceResponse getInitializationStatus()

getVersion

default ISonargraphBuild.Version getVersion()

Return version of Sonargraph Build

Returns:

the version

refresh

ServiceResponse refresh()

Refresh the opened software system.

Returns:

ServiceResponse containing status info.

createReport

ServiceResponse createReport(ReportRequest reportRequest)

Create a report for the opened and refreshed software system.

Returns:

ServiceResponse containing status info.

createSnapshot

ServiceResponse createSnapshot(java.io.File snapshotDir,
                               java.lang.String snapshotFileName)

Create a snapshot for the opened and refreshed software system.

Parameters:

snapshotDir - the target directory for the snapshot.

snapshotFileName - the filename of the snapshot (optional). If omitted, the system name + a timestamp is used.

Returns:

ServiceResponse containing status info.

resendFaildUploads

ServiceResponse resendFaildUploads(ResendFailedUploadsRequest request)

Try to re-send all failed report uploads.

Parameters:

request - the request

Returns:

ServiceResponse containing status info.

failIfExists

ServiceResponse failIfExists(FailSet failSet)

Checks if the specified FailSet matches any issues in the opened and refreshed software system.

Parameters:

failSet - FailSet containing include / exclude IssueFilters.

Returns:

ServiceResponse with StatusCode.OK if no issues match, StatusCode.FAILED if issues match. ServiceResponse.getStatusMessage() provides info about the number of issues matched by individual filters.

checkQualityGates

ServiceResponse checkQualityGates()

Returns the summary of quality gate results as output of the ServiceResponse.

Returns:

ServiceResponse with StatusCode.OK if all checked quality gates are passed, StatusCode.FAILED if any of the quality gates is failed.

close

ServiceResponse close()

Closes an open software system.

Returns:

ServiceResponse containing status info.

setVirtualModel

ServiceResponse setVirtualModel(java.lang.String virtualModelName)

Sets the specified virtual model

Parameters:

virtualModelName - the name of the virtual model

Returns:

ServiceResponse containing status info.

getScriptRunnerStatus

ServiceResponse getScriptRunnerStatus()

Returns:

ServiceResponse containing status info.

createDynamicSystem

ServiceResponseWithOutcome<java.io.File> createDynamicSystem(SystemInfo system,
                                                             java.io.File qualityModelFile)

Creates a new software system

Parameters:

system - the system

qualityModelFile - optional, if specified the content of the quality model is copied into the system's file structure

Returns:

response object containing the system directory as outcome