io.bdeploy.bhive.op.ManifestRefScanOperation 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.op;

import java.util.SortedMap;
import java.util.TreeMap;

import io.bdeploy.bhive.BHive;
import io.bdeploy.bhive.ReadOnlyOperation;
import io.bdeploy.bhive.model.Manifest;
import io.bdeploy.bhive.model.ObjectId;
import io.bdeploy.bhive.objects.view.MissingObjectView;
import io.bdeploy.bhive.objects.view.TreeView;
import io.bdeploy.bhive.objects.view.scanner.TreeVisitor;
import io.bdeploy.common.ActivityReporter.Activity;
import io.bdeploy.common.util.RuntimeAssert;

/**
 * Scans for nested {@link Manifest}s referenced in the given {@link Manifest}.
 */
@ReadOnlyOperation
public class ManifestRefScanOperation extends BHive.Operation> {

    private Manifest.Key manifest;
    private boolean allowMissing = false;
    private int maxDepth = Integer.MAX_VALUE;

    @Override
    public SortedMap call() throws Exception {
        RuntimeAssert.assertNotNull(manifest, "Nothing to scan");

        Manifest mf = execute(new ManifestLoadOperation().setManifest(manifest));
        SortedMap cachedReferences = mf.getCachedReferences(this, maxDepth, allowMissing);
        if (cachedReferences != null) {
            return cachedReferences;
        }

        SortedMap referenced = new TreeMap<>();
        try (Activity activity = getActivityReporter().start("Finding Relations", -1)) {
            ObjectId root = mf.getRoot();
            if (allowMissing && execute(new ObjectExistsOperation().addObject(root)).isMissing(root)) {
                // root tree is not here, but this is OK if copying from a partial hive
                return referenced;
            }

            TreeView state = execute(new ScanOperation().setManifest(manifest).setMaxDepth(maxDepth));
            state.visit(new TreeVisitor.Builder().onMissing(this::missing)
                    .onManifestRef(m -> referenced.put(m.getPathString(), m.getReferenced())).build());

            return referenced;
        }
    }

    private void missing(MissingObjectView m) {
        if (!allowMissing) {
            throw new IllegalStateException("Missing object: " + m.getElementId() + " at " + m.getPath());
        }
    }

    public ManifestRefScanOperation setManifest(Manifest.Key manifest) {
        this.manifest = manifest;
        return this;
    }

    public ManifestRefScanOperation setAllowMissingObjects(boolean allow) {
        this.allowMissing = allow;
        return this;
    }

    public ManifestRefScanOperation setMaxDepth(int max) {
        this.maxDepth = max;
        return this;
    }

}