CodeArtifactClient.java

package com.contrastsecurity.sdk.scan;

/*-
 * #%L
 * Contrast Java SDK
 * %%
 * Copyright (C) 2021 Contrast Security, Inc.
 * %%
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *      http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 * #L%
 */

import com.contrastsecurity.exceptions.HttpResponseException;
import com.contrastsecurity.exceptions.ResourceNotFoundException;
import com.contrastsecurity.exceptions.ServerResponseException;
import com.contrastsecurity.exceptions.UnauthorizedException;
import java.io.IOException;
import java.nio.file.Path;

/**
 * Internal, low-level client for making requests for code artifact resources.
 *
 * @apiNote every request to the Contrast API requires an organization ID. The organization ID
 *     parameter has been left off of the method signatures in this class, because providing it for
 *     every request is tedious. Instead, it is expected that implementations will provide an
 *     organization ID.
 */
interface CodeArtifactClient {

  /**
   * Transfers an artifact from the file system to Contrast Scan to create a new code artifact for
   * analysis.
   *
   * @param projectId ID of the project to which the code artifact belongs
   * @param file the file to upload
   * @return new {@link CodeArtifactInner} from Contrast API
   * @throws IOException when an IO error occurs while making the request to the Contrast API
   * @throws UnauthorizedException when Contrast rejects the credentials used to send the request
   * @throws ResourceNotFoundException when the requested resource does not exist
   * @throws HttpResponseException when Contrast rejects this request with an error code
   * @throws ServerResponseException when Contrast API returns a response that cannot be understood
   */
  CodeArtifactInner upload(String projectId, Path file) throws IOException;

  /**
   * Transfers artifact and prescan metadata from the file system to Contrast Scan to create a new
   * code artifact for analysis.
   *
   * <p>Prescan metadata will allow the scanner to produce more detailed finding reports.
   *
   * @param projectId ID of the project to which the code artifact belongs
   * @param file the file to upload
   * @param metadata the prescan metadata to upload with the file artifact.
   * @return new {@link CodeArtifactInner} from Contrast API
   * @throws IOException when an IO error occurs while making the request to the Contrast API
   * @throws UnauthorizedException when Contrast rejects the credentials used to send the request
   * @throws ResourceNotFoundException when the requested resource does not exist
   * @throws HttpResponseException when Contrast rejects this request with an error code
   * @throws ServerResponseException when Contrast API returns a response that cannot be understood
   */
  CodeArtifactInner upload(String projectId, Path file, Path metadata) throws IOException;
}