io.bdeploy.bhive.remote.RemoteBHive Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of api Show documentation
Public API including dependencies, ready to be used for integrations and plugins.
There is a newer version: 7.3.6
package io.bdeploy.bhive.remote;

import java.io.InputStream;
import java.nio.file.Path;
import java.util.Set;
import java.util.SortedMap;

import io.bdeploy.bhive.BHive;
import io.bdeploy.bhive.model.Manifest;
import io.bdeploy.bhive.model.Manifest.Key;
import io.bdeploy.bhive.model.ObjectId;
import io.bdeploy.bhive.model.Tree;
import io.bdeploy.bhive.op.remote.TransferStatistics;
import io.bdeploy.bhive.remote.jersey.JerseyRemoteBHive;
import io.bdeploy.common.ActivityReporter;
import io.bdeploy.common.security.RemoteService;

/**
 * Represents a possibly remote (might also be "remote" in the sense of another
 * directory on disc) BHive. This interface is *not* ment to be used for direct remote interface implementation, but rather is a
 * logical representation of a {@link BHive} which is not the currently operated-on {@link BHive}.
 *
 * @see LocalBHiveAdapter
 * @see JerseyRemoteBHive
 */
public interface RemoteBHive extends AutoCloseable {

    /**
     * From the given set, filter all remotely known {@link ObjectId}s and return only {@link ObjectId} which are not yet present
     * on the remote.
     */
    public Set getMissingObjects(Set all);

    /**
     * Retrieve all {@link Key}s along with the root tree {@link ObjectId} available
     * to the remote repository.
     *
     * @param names a possibly empty list of named to restrict to. Each can be any number of full (!) name segments
     *            (/-separated).
     */
    public SortedMap getManifestInventory(String... names);

    /**
     * @param key the manifest to delete
     */
    public void removeManifest(Manifest.Key key);

    /**
     * Perform a prune operation on the remote {@link BHive}, removing any unreferenced objects.
     */
    public void prune();

    /**
     * Retrieve the {@link ObjectId}s required to satisfy a given tree.
     */
    public Set getRequiredObjects(Set trees, Set excludeTrees);

    /**
     * Retrieve the {@link ObjectId}s of all required {@link Tree} objects recursively in the given tree. The returned set is
     * ordered so that child-trees are first followed by their parents.
     */
    public Set getRequiredTrees(ObjectId tree);

    /**
     * Transfer the ZIPed {@link BHive} to the remote and apply all top-level
     * {@link Manifest}s referenced within.
     */
    public void push(Path zipedHive);

    /**
     * Streams objects directly into the given remote hive.
     */
    public TransferStatistics pushAsStream(InputStream in);

    /**
     * Fetch manifests from the remote as ZIPed {@link BHive}. Only objects in the given requiredObjects are included.
     */
    public Path fetch(Set objects, Set manifests);

    /**
     * Streams the given objects one after each other to the given output stream.
     */
    public InputStream fetchAsStream(Set objects, Set manifests);

    /**
     * Figures out the type of {@link RemoteBHive} required for the given
     * {@link RemoteService} and returns an instance.
     * 
     * The returned {@link RemoteBHive} is not guaranteed to be remote in the sense
     * of network. It might be an adapter to another local {@link BHive} in the
     * filesystem.
     * 
     * In case the hive is remote, the name is used to identify the hive on the
     * server, as the server might serve multiple hives.
     */
    public static RemoteBHive forService(RemoteService svc, String name, ActivityReporter reporter) {
        switch (svc.getUri().getScheme().toLowerCase()) {
            case "file":
            case "jar":
                return new LocalBHiveAdapter(new BHive(svc.getUri(), null, reporter), reporter);
            case "https":
                return new JerseyRemoteBHive(svc, name, reporter);
            default:
                throw new UnsupportedOperationException("scheme " + svc.getUri().getScheme() + " not supported");
        }
    }

    @Override
    public void close();
}