com.artipie.composer.Repository Maven / Gradle / Ivy

Go to download
/*
 * The MIT License (MIT) Copyright (c) 2020-2023 artipie.com
 * https://github.com/artipie/artipie/blob/master/LICENSE.txt
 */
package com.artipie.composer;

import com.artipie.asto.Content;
import com.artipie.asto.Key;
import com.artipie.asto.Storage;
import com.artipie.composer.http.Archive;
import java.util.Optional;
import java.util.concurrent.CompletableFuture;
import java.util.concurrent.CompletionStage;
import java.util.function.Function;

/**
 * PHP Composer repository.
 *
 * @since 0.3
 */
@SuppressWarnings("PMD.TooManyMethods")
public interface Repository {

    /**
     * Reads packages description from storage.
     *
     * @return Packages found by name, might be empty.
     */
    CompletionStage> packages();

    /**
     * Reads packages description from storage.
     *
     * @param name Package name.
     * @return Packages found by name, might be empty.
     */
    CompletionStage> packages(Name name);

    /**
     * Adds package described in JSON format from storage.
     *
     * @param content Package content.
     * @param version Version in case of absence version in content with package. If package
     *  does not contain version, this value should be passed as a parameter.
     * @return Completion of adding package to repository.
     */
    CompletableFuture addJson(Content content, Optional version);

    /**
     * Adds package described in archive with ZIP or TAR.GZ
     * format from storage.
     *
     * @param archive Archive with package content.
     * @param content Package content.
     * @return Completion of adding package to repository.
     */
    CompletableFuture addArchive(Archive archive, Content content);

    /**
     * Obtain bytes by key.
     * @param key The key
     * @return Bytes.
     */
    CompletableFuture value(Key key);

    /**
     * Obtains storage for repository. It can be useful for implementation cache
     * or in other places where {@link Storage} instance is required for
     * using classes which are created in asto module.
     * @return Storage instance
     */
    Storage storage();

    /**
     * This file exists?
     *
     * @param key The key (file name)
     * @return TRUE if exists, FALSE otherwise
     */
    CompletableFuture exists(Key key);

    /**
     * Saves the bytes to the specified key.
     * @param key The key
     * @param content Bytes to save
     * @return Completion or error signal.
     */
    CompletableFuture save(Key key, Content content);

    /**
     * Moves value from one location to another.
     * @param source Source key.
     * @param destination Destination key.
     * @return Completion or error signal.
     */
    CompletableFuture move(Key source, Key destination);

    /**
     * Removes value from storage. Fails if value does not exist.
     * @param key Key for value to be deleted.
     * @return Completion or error signal.
     */
    CompletableFuture delete(Key key);

    /**
     * Runs operation exclusively for specified key.
     * @param key Key which is scope of operation.
     * @param operation Operation to be performed exclusively.
     * @param  Operation result type.
     * @return Result of operation.
     */
     CompletionStage exclusively(
        Key key,
        Function> operation
    );
}