brooklyn.entity.drivers.downloads.BasicDownloadsManager Maven / Gradle / Ivy

Go to download
package brooklyn.entity.drivers.downloads;

import static com.google.common.base.Preconditions.checkNotNull;

import java.util.List;
import java.util.Map;
import java.util.Set;

import brooklyn.config.StringConfigMap;
import brooklyn.entity.drivers.EntityDriver;
import brooklyn.util.text.Strings;

import com.google.common.base.Function;
import com.google.common.collect.ImmutableMap;
import com.google.common.collect.Lists;
import com.google.common.collect.Sets;

public class BasicDownloadsManager implements DownloadResolverManager {

    private final List> producers = Lists.newCopyOnWriteArrayList();

    private final List> filenameProducers = Lists.newCopyOnWriteArrayList();

    /**
     * The default is (in-order) to:
     * 
     *   Use the local repo, if any (defaulting to $HOME/.brooklyn/repository)
     *   
Use brooklyn properties for any download overrides defined there (see {@link DownloadProducerFromProperties}
     *   
Use the entity's Attributes.DOWNLOAD_URL
     *   
Use the cloudsoft fallback repo
     * 
     * @param config
     */
    public static BasicDownloadsManager newDefault(StringConfigMap config) {
        BasicDownloadsManager result = new BasicDownloadsManager();
        
        // In-order, will look up: local repo, overrides defined in the properties, and then 
        // the entity's attribute to get the download URL
        DownloadProducerFromLocalRepo localRepoProducer = new DownloadProducerFromLocalRepo(config);
        DownloadProducerFromProperties propertiesProducer = new DownloadProducerFromProperties(config);
        DownloadProducerFromUrlAttribute attributeProducer = new DownloadProducerFromUrlAttribute();
        DownloadProducerFromCloudsoftRepo cloudsoftRepoProducer = new DownloadProducerFromCloudsoftRepo(config);
        
        result.registerProducer(localRepoProducer);
        result.registerProducer(propertiesProducer);
        result.registerProducer(attributeProducer);
        result.registerProducer(cloudsoftRepoProducer);
        
        result.registerFilenameProducer(FilenameProducers.fromFilenameProperty());
        result.registerFilenameProducer(FilenameProducers.firstPrimaryTargetOf(propertiesProducer));
        result.registerFilenameProducer(FilenameProducers.firstPrimaryTargetOf(attributeProducer));
        
        return result;
    }
    
    public static BasicDownloadsManager newEmpty() {
        return new BasicDownloadsManager();
    }
    
    @Override
    public void registerPrimaryProducer(Function producer) {
        producers.add(0, checkNotNull(producer, "resolver"));
    }

    @Override
    public void registerProducer(Function producer) {
        producers.add(checkNotNull(producer, "resolver"));
    }

    @Override
    public void registerFilenameProducer(Function producer) {
        filenameProducers.add(checkNotNull(producer, "producer"));
    }

    @Override
    public DownloadResolver newDownloader(EntityDriver driver) {
        return newDownloader(new BasicDownloadRequirement(driver));
    }

    @Override
    public DownloadResolver newDownloader(EntityDriver driver, Map properties) {
        return newDownloader(new BasicDownloadRequirement(driver, properties));
    }

    @Override
    public DownloadResolver newDownloader(EntityDriver driver, String addonName, Map addonProperties) {
        return newDownloader(new BasicDownloadRequirement(driver, addonName, addonProperties));
    }

    private DownloadResolver newDownloader(DownloadRequirement req) {
        // Infer filename
        String filename = null;
        for (Function filenameProducer : filenameProducers) {
            filename = filenameProducer.apply(req);
            if (!Strings.isBlank(filename)) break;
        }
        
        // If a filename-producer has given us the filename, then augment the DownloadRequirement with that
        // (so that local-repo substitutions etc can use that explicit filename)
        DownloadRequirement wrappedReq;
        if (filename == null) {
            wrappedReq = req;
        } else {
            wrappedReq = BasicDownloadRequirement.copy(req, ImmutableMap.of("filename", filename));
        }
        
        // Get ordered download targets to be tried
        List primaries = Lists.newArrayList();
        List fallbacks = Lists.newArrayList();
        for (Function producer : producers) {
            DownloadTargets vals = producer.apply(wrappedReq);
            primaries.addAll(vals.getPrimaryLocations());
            fallbacks.addAll(vals.getFallbackLocations());
            if (!vals.canContinueResolving()) {
                break;
            }
        }

        Set result = Sets.newLinkedHashSet();
        result.addAll(primaries);
        result.addAll(fallbacks);

        if (result.isEmpty()) {
            throw new IllegalArgumentException("No downloads matched for "+req);
        }
        
        // If filename-producers didn't give any explicit filename, then infer from download results
        if (filename == null) {
            for (String target : result) {
                filename = FilenameProducers.inferFilename(target);
                if (!Strings.isBlank(filename)) break;
            }
        }
        if (Strings.isBlank(filename)) {
            throw new IllegalArgumentException("No filenames matched for "+req+" (targets "+result+")");
        }
        
        // And return the result
        return new BasicDownloadResolver(result, filename);
    }
}