org.apache.brooklyn.util.maven.MavenRetriever Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of brooklyn-utils-common Show documentation
Utility classes and methods developed for Brooklyn but not dependendent on Brooklyn or much else
There is a newer version: 1.1.0
Show newest version
/*
 * Licensed to the Apache Software Foundation (ASF) under one
 * or more contributor license agreements.  See the NOTICE file
 * distributed with this work for additional information
 * regarding copyright ownership.  The ASF licenses this file
 * to you under the Apache License, Version 2.0 (the
 * "License"); you may not use this file except in compliance
 * with the License.  You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing,
 * software distributed under the License is distributed on an
 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
 * KIND, either express or implied.  See the License for the
 * specific language governing permissions and limitations
 * under the License.
 */
package org.apache.brooklyn.util.maven;

import java.io.File;

import org.apache.brooklyn.util.net.Urls;
import org.apache.brooklyn.util.text.Strings;

import com.google.common.base.Function;

/** returns the URL for accessing the artifact, assuming sonatype for snapshots and maven.org for releases by default,
 * with some methods checking local file system, and allowing the generators for each to be specified */
public class MavenRetriever {

    public static final Function CONDITIONAL_SNAPSHOT_URL_GENERATOR = new Function() {
        @Override
        public String apply(MavenArtifact artifact) {
            if (artifact.groupId.startsWith("org.apache")) {
                return APACHE_SNAPSHOT_URL_GENERATOR.apply(artifact);
            } else {
                return SONATYPE_SNAPSHOT_URL_GENERATOR.apply(artifact);
            }
        }
    };

    public static final Function SONATYPE_SNAPSHOT_URL_GENERATOR = 
            nexusSnapshotUrlGenerator("https://oss.sonatype.org");

    public static final Function APACHE_SNAPSHOT_URL_GENERATOR = 
            nexusSnapshotUrlGenerator("https://repository.apache.org");

    public static Function nexusSnapshotUrlGenerator(final String baseUrl) {
        return new Function() {
            @Override
            public String apply(MavenArtifact artifact) {
                return baseUrl+"/service/local/artifact/maven/redirect?" +
                        "r=snapshots&" +
                        "v="+Urls.encode(artifact.version)+"&" +
                        "g="+Urls.encode(artifact.groupId)+"&" +
                        "a="+Urls.encode(artifact.artifactId)+"&" +
                        (artifact.classifier!=null ? "c="+Urls.encode(artifact.classifier)+"&" : "")+
                        "e="+Urls.encode(artifact.packaging);
            }
        };
    }

    public static final Function MAVEN_CENTRAL_URL_GENERATOR = new Function() {
        @Override
        public String apply(MavenArtifact artifact) {
            return "http://search.maven.org/remotecontent?filepath="+
                    Urls.encode(Strings.replaceAllNonRegex(artifact.groupId, ".", "/")+"/"+
                            artifact.artifactId+"/"+artifact.version+"/"+
                            artifact.getFilename());
        }
    };

    public static final Function LOCAL_REPO_PATH_GENERATOR = new Function() {
        @Override
        public String apply(MavenArtifact artifact) {
            return System.getProperty("user.home")+"/.m2/repository/"+
                    Strings.replaceAllNonRegex(artifact.groupId, ".", "/")+"/"+
                            artifact.artifactId+"/"+artifact.version+"/"+
                            artifact.getFilename();
        }
    };

    protected Function snapshotUrlGenerator = CONDITIONAL_SNAPSHOT_URL_GENERATOR;
    protected Function releaseUrlGenerator = MAVEN_CENTRAL_URL_GENERATOR;
    
    public void setSnapshotUrlGenerator(Function snapshotUrlGenerator) {
        this.snapshotUrlGenerator = snapshotUrlGenerator;
    }
    
    public void setReleaseUrlGenerator(Function releaseUrlGenerator) {
        this.releaseUrlGenerator = releaseUrlGenerator;
    }
    
    public String getHostedUrl(MavenArtifact artifact) {
        if (artifact.isSnapshot()) return snapshotUrlGenerator.apply(artifact);
        else return releaseUrlGenerator.apply(artifact);
    }
    
    public String getLocalPath(MavenArtifact artifact) {
        return LOCAL_REPO_PATH_GENERATOR.apply(artifact);
    }
    
    public boolean isInstalledLocally(MavenArtifact artifact) {
        return new File(getLocalPath(artifact)).exists();
    }

    /** returns a URL for accessing the given artifact, preferring a local file if available,
     * else generating a hosted URL (but not checking) */
    public String getLocalUrl(MavenArtifact artifact) {
        if (isInstalledLocally(artifact)) return new File(getLocalPath(artifact)).toURI().toString();
        if (artifact.isSnapshot()) return snapshotUrlGenerator.apply(artifact);
        else return releaseUrlGenerator.apply(artifact);
    }
    
    /** returns a URL for accessing the artifact from the local machine (ie preferring a local repo),
     * using the default remote sits (sonatype for snapshots and maven.org for releases) */
    public static String localUrl(MavenArtifact artifact) {
        return new MavenRetriever().getLocalUrl(artifact);
    }

    /** returns a URL for accessing the artifact from any machine (ie not allowing a local repo),
     * using the default remote sits (sonatype for snapshots and maven.org for releases) */
    public static String hostedUrl(MavenArtifact artifact) {
        return new MavenRetriever().getHostedUrl(artifact);
    }


}