com.sun.enterprise.build.AbstractGlassfishMojo Maven / Gradle / Ivy

Go to download
/*
 * 
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
 * 
 * Copyright 2008 Sun Microsystems, Inc. All rights reserved.
 * 
 * The contents of this file are subject to the terms of either the GNU
 * General Public License Version 2 only ("GPL") or the Common Development
 * and Distribution License("CDDL") (collectively, the "License").  You
 * may not use this file except in compliance with the License. You can obtain
 * a copy of the License at https://glassfish.dev.java.net/public/CDDL+GPL.html
 * or glassfish/bootstrap/legal/LICENSE.txt.  See the License for the specific
 * language governing permissions and limitations under the License.
 * 
 * When distributing the software, include this License Header Notice in each
 * file and include the License file at glassfish/bootstrap/legal/LICENSE.txt.
 * Sun designates this particular file as subject to the "Classpath" exception
 * as provided by Sun in the GPL Version 2 section of the License file that
 * accompanied this code.  If applicable, add the following below the License
 * Header, with the fields enclosed by brackets [] replaced by your own
 * identifying information: "Portions Copyrighted [year]
 * [name of copyright owner]"
 * 
 * Contributor(s):
 * 
 * If you wish your version of this file to be governed by only the CDDL or
 * only the GPL Version 2, indicate your decision by adding "[Contributor]
 * elects to include this software in this distribution under the [CDDL or GPL
 * Version 2] license."  If you don't indicate a single choice of license, a
 * recipient has the option to distribute your version of this file under
 * either the CDDL, the GPL Version 2 or to extend the choice of license to
 * its licensees as provided above.  However, if you add GPL Version 2 code
 * and therefore, elected the GPL Version 2 license, then the option applies
 * only if the new code is made subject to such option by the copyright
 * holder.
 */
package com.sun.enterprise.build;

import org.apache.maven.plugin.AbstractMojo;
import org.apache.maven.plugin.MojoExecutionException;
import org.apache.maven.project.MavenProject;
import org.apache.maven.project.ProjectBuildingException;
import org.apache.maven.project.MavenProjectBuilder;
import org.apache.maven.artifact.Artifact;
import com.sun.enterprise.module.common_impl.Jar;
import com.sun.enterprise.module.ManifestConstants;

import java.util.jar.Attributes;
import java.util.Set;
import java.util.HashSet;
import java.io.IOException;

/**
 * @author Kohsuke Kawaguchi
 */
abstract class AbstractGlassfishMojo extends AbstractMojo {
    /**
     * The maven project.
     *
     * @parameter expression="${project}"
     * @required
     * @readonly
     */
    protected MavenProject project;

    /**
     * @component
     */
    protected MavenProjectBuilder projectBuilder;

    protected boolean isModule(Artifact a) throws MojoExecutionException {
        try {
            Jar jar = Jar.create(a.getFile());
            if (jar.getManifest()==null) {
                return false;
            }
            Attributes attributes = jar.getManifest().getMainAttributes();
            String name = attributes.getValue(ManifestConstants.BUNDLE_NAME);
            return name!=null;
        } catch (IOException e) {
            throw new MojoExecutionException("Failed to open "+a.getFile(),e);
        }
    }

    /**
     * Resolves the POM of the given artifact and parses it into {@link MavenProject}.
     */
    protected MavenProject loadPom(Artifact artifact) throws ProjectBuildingException {
        return projectBuilder.buildFromRepository(artifact, project.getRemoteArtifactRepositories(), artifact.getRepository());
    }

    protected interface ArtifactFilter {
        boolean find(Artifact a);
    }

    /**
     * Finds artifacts that match the given filter.
     */
    protected Set findArtifacts(Set artifacts, ArtifactFilter filter) {
        Set r = new HashSet();

        for(Artifact a : artifacts) {
            if(filter.find(a)) {
                if (getLog().isDebugEnabled()) {
                    getLog().debug("Including " + a.getGroupId() + ":" + a.getArtifactId() + ":"+ a.getVersion());
                    getLog().debug("From dependency trail : ");
                    for (int i=a.getDependencyTrail().size()-1;i>=0;i--) {
                        getLog().debug(" " + a.getDependencyTrail().get(i).toString());
                    }
                    getLog().debug("");
                }
                r.add(a);
            }
        }

        return r;
    }

    /**
     * Returns a set of {@link Artifact}s that have the given type.
     */
    protected Set findArtifactsOfType(Set artifacts, final String type) {
        return findArtifacts(artifacts,new ArtifactFilter() {
            public boolean find(Artifact a) {
                String t = a.getType();
                if(t==null)  t="jar"; // see http://maven.apache.org/pom.html
                return t.equals(type);
            }
        });
    }

    protected Set findArtifactsOfScope(Set artifacts, final String scope) {
        return findArtifacts(artifacts,new ArtifactFilter() {
            public boolean find(Artifact a) {
                String s = a.getScope();
                return s.equals(scope);
            }
        });
    }
}