com.contrastsecurity.sdk.scan

Interface Scans

public interface Scans

Scan resource collection API.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	Scans.Factory Factory for Scans

Method Summary

Modifier and Type	Method and Description
Scan.Definition	define() Starts the definition for a new scan resource.
Scan	get(java.lang.String id) Retrieves a scan by ID.
ScanSummary	summary(java.lang.String id) Retrieves a scan's summary by scan ID.

Method Detail

define

Scan.Definition define()

Starts the definition for a new scan resource.

Returns:

new definition builder

get

Scan get(java.lang.String id)
  throws java.io.IOException

Retrieves a scan by ID.

Parameters:

id - scan ID

Returns:

scan resource

Throws:

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(java.lang.String id)
             throws java.io.IOException

Retrieves a scan's summary by scan ID.

Parameters:

id - scan ID

Returns:

summary of the scan identified by the given ID

Throws:

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