maven-plugins/xdoc/src/main/org/apache/maven/DependencyDescriberBean.java

package org.apache.maven;
/* ====================================================================
 * The Apache Software License, Version 1.1
 *
 * Copyright (c) 2003 The Apache Software Foundation.  All rights
 * reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 *
 * 1. Redistributions of source code must retain the above copyright
 *    notice, this list of conditions and the following disclaimer.
 *
 * 2. Redistributions in binary form must reproduce the above copyright
 *    notice, this list of conditions and the following disclaimer in
 *    the documentation and/or other materials provided with the
 *    distribution.
 *
 * 3. The end-user documentation included with the redistribution,
 *    if any, must include the following acknowledgment:
 *       "This product includes software developed by the
 *        Apache Software Foundation (http://www.apache.org/)."
 *    Alternately, this acknowledgment may appear in the software itself,
 *    if and wherever such third-party acknowledgments normally appear.
 *
 * 4. The names "Apache" and "Apache Software Foundation" and
 *    "Apache Maven" must not be used to endorse or promote products
 *    derived from this software without prior written permission. For
 *    written permission, please contact apache@apache.org.
 *
 * 5. Products derived from this software may not be called "Apache",
 *    "Apache Maven", nor may "Apache" appear in their name, without
 *    prior written permission of the Apache Software Foundation.
 *
 * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
 * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
 * DISCLAIMED.  IN NO EVENT SHALL THE APACHE SOFTWARE FOUNDATION OR
 * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
 * USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
 * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
 * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
 * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
 * SUCH DAMAGE.
 * ====================================================================
 *
 * This software consists of voluntary contributions made by many
 * individuals on behalf of the Apache Software Foundation.  For more
 * information on the Apache Software Foundation, please see
 * <http://www.apache.org/>.
 *
 * ====================================================================
 */
import java.io.File;
import java.util.ArrayList;
import java.util.Collections;
import java.util.Iterator;
import java.util.List;

import org.apache.commons.logging.Log;
import org.apache.commons.logging.LogFactory;
import org.apache.maven.project.Dependency;
import org.apache.maven.project.Project;

/**
 * @author <a href="michal.maczka@dimatics.com">Michal Maczka</a>
 * @version $Id: DependencyDescriberBean.java,v 1.2 2003/08/19 04:45:06 dion Exp $
 */
public class DependencyDescriberBean
{
    /** for debug output */
    private Log log = LogFactory.getLog(DependencyDescriberBean.class);
    
    /** */
    private List dependencies = new ArrayList();
    private Project project;

    /**
     * @return
     */
    public List getDependencies()
    {
        return dependencies;
    }

    /**
     * Project provides context/session related information.
     * e.g where maven repo local is  
     * @param project
     */
    public void build(Project project)
    {
        this.project = project;
        for (Iterator iter = project.getDependencies().iterator();
            iter.hasNext();
            )
        {
            Dependency dependency = (Dependency) iter.next();
            DescribedDependency describedDependency =
                new DescribedDependency(dependency);
            dependencies.add(describedDependency);
            Project resolvedProject = resolveProject(dependency);
            if (resolvedProject != null)
            {
                log.debug("POM URL:" + resolvedProject.getUrl());
                describedDependency.setUrl(resolvedProject.getUrl());
                describedDependency.setDescription(
                    resolvedProject.getDescription());
            }
        }
        Collections.sort(dependencies);
    }
    /**
     * @param dependency
     * @return
     * @throws Exception
     */
    private Project resolveProject(Dependency dependency)
    {

        File projectFile = null;
        if ("pom".equals(dependency.getType()))
        {
            projectFile =
                new File(
                    project.getContext().getMavenRepoLocal(),
                    dependency.getArtifact());
        }
        else
        {
            projectFile =
                new File(
                    project.getContext().getMavenRepoLocal(),
                    dependency.getArtifactDirectory()
                        + "/poms/"
                        + dependency.getArtifactId()
                        + "-"
                        + dependency.getVersion()
                        + ".pom");
        }
        try
        {
            if (projectFile.exists() && projectFile.canRead())
            {

                return MavenUtils.getProject(projectFile, null, false);
            }
            else
            {
                log.debug("Failed to read POM:" + projectFile);
                return null;
            }
        }
        catch (Exception e)
        {
            log.debug("Failed to read POM:" + projectFile);
            return null;
        }
    }
}