public interface ISonargraphBuild
Modifier and Type | Interface and Description |
---|---|
static class |
ISonargraphBuild.ReportFormat |
static class |
ISonargraphBuild.ReportType |
static class |
ISonargraphBuild.Version |
Modifier and Type | Method and Description |
---|---|
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(java.io.File reportDirectory,
java.lang.String fileName,
ISonargraphBuild.ReportType type,
java.util.Set<ISonargraphBuild.ReportFormat> formats)
Deprecated.
|
ServiceResponse |
createReport(ReportRequest reportRequest) |
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,
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 |
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 |
refresh()
Refresh the opened software system.
|
ServiceResponse |
resendFaildUploads(ResendFailedUploadsRequest request)
Try to re-send all failed report uploads.
|
ServiceResponse |
setVirtualModel(java.lang.String virtualModelName) |
ServiceResponse open(java.io.File systemDirectory)
systemDirectory
- the directory of the software system.ServiceResponse
containing status info.@Deprecated ServiceResponse open(java.io.File systemDirectory, java.lang.String workspaceProfile)
open(File, String, File)
instead.systemDirectory
- the directory of the software system.workspaceProfile
- the workspace profile to be used.ServiceResponse
containing status info.@Deprecated ServiceResponse open(java.io.File systemDirectory, java.lang.String workspaceProfile, java.io.File qualityModelFile)
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'.ServiceResponse
containing status info.ServiceResponse open(java.io.File systemDirectory, SystemInfo systemInfo, java.lang.String workspaceProfile, java.io.File qualityModelFile)
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'.ServiceResponse
containing status info.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)
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).ServiceResponse
containing status info.ServiceResponse getInitializationStatus()
default ISonargraphBuild.Version getVersion()
ServiceResponse refresh()
ServiceResponse
containing status info.@Deprecated ServiceResponse createReport(java.io.File reportDirectory, java.lang.String fileName, ISonargraphBuild.ReportType type, java.util.Set<ISonargraphBuild.ReportFormat> formats)
reportDirectory
- the target directory for the report.fileName
- the fileName of the report (optional). If omitted the system name + a timestamp is used.type
- ISonargraphBuild.ReportType
to be be generated.type
- set of output ISonargraphBuild.ReportFormat
to be generated.ServiceResponse
containing status info.ServiceResponse createReport(ReportRequest reportRequest)
ServiceResponse createSnapshot(java.io.File snapshotDir, java.lang.String snapshotFileName)
snapshotDir
- the target directory for the snapshot.snapshotFileName
- the filename of the snapshot (optional). If omitted, the system name + a timestamp is used.ServiceResponse
containing status info.ServiceResponse resendFaildUploads(ResendFailedUploadsRequest request)
request
- ServiceResponse failIfExists(FailSet failSet)
FailSet
matches any issues in the opened and refreshed software system. The check is done for the default
virtual model.failSet
- FailSet
containing include / exclude IssueFilter
s.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.ServiceResponse close()
ServiceResponse
containing status info.ServiceResponse setVirtualModel(java.lang.String virtualModelName)
ServiceResponse getScriptRunnerStatus()
ServiceResponseWithOutcome<java.io.File> createDynamicSystem(SystemInfo system, java.io.File qualityModelFile)
system
- targetDir
- qualityModelFile
- optional, if specified the content of the quality model is copied into the system's file structure