org.jfrog.build.util.DependenciesDownloader Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of build-info-client Show documentation
There is a newer version: 2.41.24
package org.jfrog.build.util;

import org.jfrog.build.api.Dependency;
import org.jfrog.build.api.dependency.DownloadableArtifact;
import org.jfrog.build.client.ArtifactoryDependenciesClient;

import java.io.IOException;
import java.io.InputStream;
import java.util.List;
import java.util.Map;
import java.util.Set;

/**
 * Actual download performer, should hold an actual client and implement
 * it's own specific logic upon dependencies downloading
 *
 * @author Shay Yaakov
 */
public interface DependenciesDownloader {

    ArtifactoryDependenciesClient getClient();

    List download(Set downloadableArtifacts) throws IOException;

    /**
     * Returns the full target dir of where the artifact is saved
     * Usually that can be a full absolute path under the file system or the full relative
     * path to the user workspace.
     */
    String getTargetDir(String targetDir, String relativeDir) throws IOException;

    /**
     * Parse the given input stream, save it to an actual file to the given path and return
     * the calculated checksums for the saved file.
     * Implementers must close the given input stream when finished.
     */
    Map saveDownloadedFile(InputStream is, String filePath) throws IOException;

    /**
     * Checks if the file path exists locally with the same MD5 and SHA-1 checksums.
     *
     * @param filePath The local file path to check
     * @param md5      The MD5 checksum to compare with
     * @param sha1     The SHA-1 checksum to compare with
     */
    boolean isFileExistsLocally(String filePath, String md5, String sha1) throws IOException;

    /**
     * Receives a set of the resolved files (Those who got downloaded from Artifactory and those who were already existed
     * locally with the same checksums) And a set of resolved files from patterns with mark for deletion (=!>)
     * For each file, lists the files in the same directory and removes the old ones
     * (meaning those who did not participate in the build resolution and doesn't exist in all resolved files set).
     *
     * @param allResolvesFiles A set of all resolved files (to search in)
     * @param forDeletionFiles A set of resolved files from patterns with mark for deletion (=!>)
     */
    void removeUnusedArtifactsFromLocal(Set allResolvesFiles, Set forDeletionFiles) throws IOException;
}