com.contrastsecurity.sdk.scan

Interface CodeArtifacts

public interface CodeArtifacts

Code artifact resource collection.

This resource API entry point does not use the define() pattern for creating new code artifact resources, because in practice users always want to "upload" a file as a new code artifact; therefore, this type exposes "upload" methods for transferring local files to Contrast Scan as code artifacts.

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method and Description
CodeArtifact	upload(java.nio.file.Path file) Transfers a file from the file system to Contrast Scan to create a new code artifact for static analysis.
CodeArtifact	upload(java.nio.file.Path file, java.lang.String name) Transfers a file from the file system to Contrast Scan to create a new code artifact for static analysis.

Method Detail

upload

CodeArtifact upload(java.nio.file.Path file,
                    java.lang.String name)
             throws java.io.IOException

Transfers a file from the file system to Contrast Scan to create a new code artifact for static analysis.

Parameters:

file - the code artifact to upload

name - the name of the code artifact

Returns:

new CodeArtifact from Contrast

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

upload

CodeArtifact upload(java.nio.file.Path file)
             throws java.io.IOException

Transfers a file from the file system to Contrast Scan to create a new code artifact for static analysis.

Parameters:

file - the code artifact to upload

Returns:

new CodeArtifact from Contrast

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