org.apache.maven.project.DefaultMavenProjectHelper Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of maven-project Show documentation
This library is used to not only read Maven project object model files, but to assemble inheritence and to retrieve remote models as required.
The newest version!
package org.apache.maven.project;

/*
 * 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.
 */

import org.apache.maven.artifact.Artifact;
import org.apache.maven.artifact.DefaultArtifact;
import org.apache.maven.artifact.InvalidArtifactRTException;
import org.apache.maven.artifact.handler.ArtifactHandler;
import org.apache.maven.artifact.handler.manager.ArtifactHandlerManager;
import org.apache.maven.artifact.metadata.ArtifactMetadata;
import org.apache.maven.artifact.repository.ArtifactRepository;
import org.apache.maven.artifact.versioning.VersionRange;
import org.apache.maven.model.Resource;
import org.codehaus.plexus.component.annotations.Component;
import org.codehaus.plexus.component.annotations.Requirement;
import org.codehaus.plexus.logging.AbstractLogEnabled;

import java.io.File;
import java.util.Collection;
import java.util.Collections;
import java.util.List;

@Component(role = MavenProjectHelper.class)
public class DefaultMavenProjectHelper
    extends AbstractLogEnabled
    implements MavenProjectHelper
{
    @Requirement
    private ArtifactHandlerManager artifactHandlerManager;

    public void attachArtifact( MavenProject project, String artifactType, String artifactClassifier,
                                File artifactFile )
    {
        String type = artifactType;

        ArtifactHandler handler = null;

        if ( type != null )
        {
            handler = artifactHandlerManager.getArtifactHandler( artifactType );
        }

        if ( handler == null )
        {
            handler = artifactHandlerManager.getArtifactHandler( "jar" );
        }

        Artifact artifact = new AttachedArtifact( project.getArtifact(), artifactType, artifactClassifier, handler );

        artifact.setFile( artifactFile );
        artifact.setResolved( true );

        attachArtifact( project, artifact );
    }

    public void attachArtifact( MavenProject project, String artifactType, File artifactFile )
    {
        ArtifactHandler handler = artifactHandlerManager.getArtifactHandler( artifactType );

        Artifact artifact = new AttachedArtifact( project.getArtifact(), artifactType, handler );

        artifact.setFile( artifactFile );
        artifact.setResolved( true );

        attachArtifact( project, artifact );
    }

    public void attachArtifact( MavenProject project, File artifactFile, String artifactClassifier )
    {
        Artifact projectArtifact = project.getArtifact();

        Artifact artifact = new AttachedArtifact( projectArtifact, projectArtifact.getType(), artifactClassifier,
                                                  projectArtifact.getArtifactHandler() );

        artifact.setFile( artifactFile );
        artifact.setResolved( true );

        attachArtifact( project, artifact );
    }

    public void attachArtifact( MavenProject project, Artifact artifact )
    {
        try
        {
            project.addAttachedArtifact( artifact );
        }
        catch ( DuplicateArtifactAttachmentException dae )
        {
            getLogger().warn( dae.getMessage() );

            // We can throw this because it's unchecked, and won't change the MavenProjectHelper API, which would break backward compat if it did.
            throw dae;
        }
    }

    public void addResource( MavenProject project, String resourceDirectory, List includes, List excludes )
    {
        Resource resource = new Resource();
        resource.setDirectory( resourceDirectory );
        resource.setIncludes( includes );
        resource.setExcludes( excludes );

        project.addResource( resource );
    }

    public void addTestResource( MavenProject project, String resourceDirectory, List includes, List excludes )
    {
        Resource resource = new Resource();
        resource.setDirectory( resourceDirectory );
        resource.setIncludes( includes );
        resource.setExcludes( excludes );

        project.addTestResource( resource );
    }

    private static class AttachedArtifact
        extends DefaultArtifact
    {

        private final Artifact parent;

        public AttachedArtifact( Artifact parent, String type, String classifier, ArtifactHandler artifactHandler )
        {
            super( parent.getGroupId(), parent.getArtifactId(), parent.getVersionRange(), parent.getScope(), type,
                   classifier, artifactHandler, parent.isOptional() );

            setDependencyTrail( Collections.singletonList( parent.getId() ) );

            this.parent = parent;

            if ( getId().equals( parent.getId() ) )
            {
                throw new InvalidArtifactRTException( parent.getGroupId(), parent.getArtifactId(), parent.getVersion(),
                                                      parent.getType(),
                                                      "An attached artifact must have a different ID than its corresponding main artifact." );
            }
        }

        public AttachedArtifact( Artifact parent, String type, ArtifactHandler artifactHandler )
        {
            this( parent, type, null, artifactHandler );
        }

        public void setArtifactId( String artifactId )
        {
            // ignore this. We should ALWAYS use the information from the parent artifact.
        }

        public List getAvailableVersions()
        {
            return parent.getAvailableVersions();
        }

        public void setAvailableVersions( List availableVersions )
        {
            // ignore this. We should ALWAYS use the information from the parent artifact.
        }

        public String getBaseVersion()
        {
            return parent.getBaseVersion();
        }

        public void setBaseVersion( String baseVersion )
        {
            // ignore this. We should ALWAYS use the information from the parent artifact.
        }

        public String getDownloadUrl()
        {
            return parent.getDownloadUrl();
        }

        public void setDownloadUrl( String downloadUrl )
        {
            // ignore this. We should ALWAYS use the information from the parent artifact.
        }

        public void setGroupId( String groupId )
        {
            // ignore this. We should ALWAYS use the information from the parent artifact.
        }

        public ArtifactRepository getRepository()
        {
            return parent.getRepository();
        }

        public void setRepository( ArtifactRepository repository )
        {
            // ignore this. We should ALWAYS use the information from the parent artifact.
        }

        public String getScope()
        {
            return parent.getScope();
        }

        public void setScope( String scope )
        {
            // ignore this. We should ALWAYS use the information from the parent artifact.
        }

        public String getVersion()
        {
            return parent.getVersion();
        }

        public void setVersion( String version )
        {
            // ignore this. We should ALWAYS use the information from the parent artifact.
        }

        public VersionRange getVersionRange()
        {
            return parent.getVersionRange();
        }

        public void setVersionRange( VersionRange range )
        {
            // ignore this. We should ALWAYS use the information from the parent artifact.
        }

        public boolean isRelease()
        {
            return parent.isRelease();
        }

        public void setRelease( boolean release )
        {
            // ignore this. We should ALWAYS use the information from the parent artifact.
        }

        public boolean isSnapshot()
        {
            return parent.isSnapshot();
        }

        public void addMetadata( ArtifactMetadata metadata )
        {
            // ignore. The parent artifact will handle metadata.
            // we must fail silently here to avoid problems with the artifact transformers.
        }

        public Collection getMetadataList()
        {
            return Collections.EMPTY_LIST;
        }

    }

}