Package com.contrastsecurity.sdk.scan

Contrast SDK package for integrating with Contrast Scan (SAST) service.

See: Description

Interface Summary

Interface	Description
CodeArtifact	Describes the Contrast Scan code artifact resource.
CodeArtifacts	Code artifact resource collection.
CodeArtifacts.Factory	Factory for CodeArtifacts
Project	Describes the Contrast Scan project resource.
Project.Definition	Builder for defining a new project resource.
Projects	Project resource collection.
Projects.Factory	Factory for Projects
Scan	Describes a scan resource.
Scan.Definition	Builder for defining a new scan.
ScanManager	Manager for Contrast Scan resource collections.
Scans	Scan resource collection API.
Scans.Factory	Factory for Scans
ScanSummary	Summary of a Scan and its results.

Class Summary

Class	Description
ScanManagerImpl	Implementation of ScanManager.

Enum Summary

Enum	Description
ScanStatus	Describes the possible states that a scan can have

Exception Summary

Exception	Description
ScanException	Indicates a condition that prevents Contrast Scan from completing an analysis

Package com.contrastsecurity.sdk.scan Description

Contrast SDK package for integrating with Contrast Scan (SAST) service. Users should obtain an entrypoint to the Contrast Scan manager using ContrastSDK.scan(java.lang.String).

Sample:

ContrastSDK contrast =
    new ContrastSDK.Builder("username", "my-service-key", "my-api-key").build();
ScanManager scanManager = contrast.scan("organization-id");

Projects projects = scanManager.projects();
Project project =
    projects
        .findByName("spring-test-application")
        .orElseGet(
            () -> {
              try {
                return projects
                    .define()
                    .withName("spring-test-application")
                    .withLanguage("JAVA")
                    .create();
              } catch (IOException e) {
                throw new UncheckedIOException(e);
              }
            });
Path file = Paths.get("./target/spring-test-application.jar");
CodeArtifact codeArtifact = project.codeArtifacts().upload(file);
Scan scan = project.scans().define().withExistingCodeArtifact(codeArtifact).create();
ScheduledExecutorService scheduler = Executors.newSingleThreadScheduledExecutor();
try {
  scan.await(scheduler)
      .thenAccept(
          s -> {
            try {
              s.saveSarif(Paths.get("./contrast-scan-results.sarif.json"));
              ScanSummary summary = s.summary();
              System.out.printf("Found %d total results%n", summary.totalResults());
            } catch (IOException e) {
              throw new UncheckedIOException(e);
            }
          })
      .toCompletableFuture()
      .join();
} finally {
  scheduler.shutdown();
}

Since:

3.2