com.contrastsecurity.sdk.scan

Interface Scan

All Superinterfaces:

Refreshable<Scan>

public interface Scan
extends Refreshable<Scan>

Describes a scan resource.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	Scan.Definition Builder for defining a new scan.

Method Summary

Modifier and Type	Method and Description
java.util.concurrent.CompletionStage<Scan>	await(java.util.concurrent.ScheduledExecutorService scheduler)
java.lang.String	errorMessage()
java.lang.String	id()
boolean	isFinished()
java.lang.String	organizationId()
java.lang.String	projectId()
java.io.InputStream	sarif() Retrieves a scan's results in SARIF.
void	saveSarif(java.nio.file.Path file) Retrieves and saves the scan's results (in SARIF) to the specified file.
ScanStatus	status()
ScanSummary	summary() Retrieves a summary of the scan results.

Methods inherited from interface com.contrastsecurity.sdk.internal.Refreshable

refresh

Method Detail

id

java.lang.String id()

Returns:

ID of this scan

projectId

java.lang.String projectId()

Returns:

ID of the project to which this scan belongs

organizationId

java.lang.String organizationId()

Returns:

ID of the organization to which this scan belongs

status

ScanStatus status()

Returns:

scan status

errorMessage

java.lang.String errorMessage()

Returns:

error message for failed scan, or null if the scan has not failed

isFinished

boolean isFinished()

Returns:

true when the scan has completed, failed, or been canceled

await

java.util.concurrent.CompletionStage<Scan> await(java.util.concurrent.ScheduledExecutorService scheduler)

Parameters:

scheduler - for scheduling requests when polling for the latest scan resource

Returns:

CompletionStage that resolves successfully with a Scan record when the scan has completed, or resolves exceptionally with a ScanException when the scan has failed or there was a problem communicating with the Contrast Scan API.

sarif

java.io.InputStream sarif()
                   throws java.io.IOException

Retrieves a scan's results in SARIF.

Returns:

InputStream for reading the SARIF file. The caller is expected to close the InputStream

Throws:

java.lang.IllegalStateException - when called on a scan that is not yet finished

java.io.IOException - when an IO error occurs while making the request to the Contrast API

UnauthorizedException - when Contrast rejects the credentials used to send the request

ResourceNotFoundException - when the requested resource does not exist

HttpResponseException - when Contrast rejects this request with an error code

ServerResponseException - when Contrast API returns a response that cannot be understood

saveSarif

void saveSarif(java.nio.file.Path file)
        throws java.io.IOException

Retrieves and saves the scan's results (in SARIF) to the specified file.

Parameters:

file - the file to which to save the results

Throws:

java.lang.IllegalStateException - when called on a scan that is not yet finished

java.io.IOException - when an IO error occurs while making the request to the Contrast API

UnauthorizedException - when Contrast rejects the credentials used to send the request

ResourceNotFoundException - when the requested resource does not exist

HttpResponseException - when Contrast rejects this request with an error code

ServerResponseException - when Contrast API returns a response that cannot be understood

summary

ScanSummary summary()
             throws java.io.IOException

Retrieves a summary of the scan results.

Returns:

CompletionStage that completes successfully when the scan has completed and the summary has been retrieved

Throws:

java.lang.IllegalStateException - when called on a scan that is not yet finished

java.io.IOException - when an IO error occurs while making the request to the Contrast API

UnauthorizedException - when Contrast rejects the credentials used to send the request

ResourceNotFoundException - when the requested resource does not exist

HttpResponseException - when Contrast rejects this request with an error code

ServerResponseException - when Contrast API returns a response that cannot be understood