001package org.apache.maven.project;
002
003/*
004 * Licensed to the Apache Software Foundation (ASF) under one
005 * or more contributor license agreements.  See the NOTICE file
006 * distributed with this work for additional information
007 * regarding copyright ownership.  The ASF licenses this file
008 * to you under the Apache License, Version 2.0 (the
009 * "License"); you may not use this file except in compliance
010 * with the License.  You may obtain a copy of the License at
011 *
012 *   http://www.apache.org/licenses/LICENSE-2.0
013 *
014 * Unless required by applicable law or agreed to in writing,
015 * software distributed under the License is distributed on an
016 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
017 * KIND, either express or implied.  See the License for the
018 * specific language governing permissions and limitations
019 * under the License.
020 */
021
022import java.util.List;
023
024import org.apache.commons.lang3.Validate;
025import org.apache.maven.artifact.repository.ArtifactRepository;
026import org.apache.maven.model.Model;
027import org.apache.maven.model.building.AbstractModelBuildingListener;
028import org.apache.maven.model.building.ModelBuildingEvent;
029import org.apache.maven.model.building.ModelProblem.Severity;
030import org.apache.maven.model.building.ModelProblem.Version;
031import org.apache.maven.model.building.ModelProblemCollectorRequest;
032import org.apache.maven.plugin.PluginManagerException;
033import org.apache.maven.plugin.PluginResolutionException;
034import org.apache.maven.plugin.version.PluginVersionResolutionException;
035
036/**
037 * Processes events from the model builder while building the effective model for a {@link MavenProject} instance.
038 *
039 * @author Benjamin Bentmann
040 */
041public class DefaultModelBuildingListener
042    extends AbstractModelBuildingListener
043{
044
045    private MavenProject project;
046
047    private ProjectBuildingHelper projectBuildingHelper;
048
049    private ProjectBuildingRequest projectBuildingRequest;
050
051    private List<ArtifactRepository> remoteRepositories;
052
053    private List<ArtifactRepository> pluginRepositories;
054
055    public DefaultModelBuildingListener( MavenProject project, ProjectBuildingHelper projectBuildingHelper,
056                                         ProjectBuildingRequest projectBuildingRequest )
057    {
058        this.project = Validate.notNull( project, "project cannot be null" );
059        this.projectBuildingHelper = Validate.notNull( projectBuildingHelper, "projectBuildingHelper cannot be null" );
060        this.projectBuildingRequest =
061            Validate.notNull( projectBuildingRequest, "projectBuildingRequest cannot be null" );
062        this.remoteRepositories = projectBuildingRequest.getRemoteRepositories();
063        this.pluginRepositories = projectBuildingRequest.getPluginArtifactRepositories();
064    }
065
066    /**
067     * Gets the project whose model is being built.
068     *
069     * @return The project, never {@code null}.
070     */
071    public MavenProject getProject()
072    {
073        return project;
074    }
075
076    @Override
077    public void buildExtensionsAssembled( ModelBuildingEvent event )
078    {
079        Model model = event.getModel();
080
081        try
082        {
083            pluginRepositories =
084                projectBuildingHelper.createArtifactRepositories( model.getPluginRepositories(), pluginRepositories,
085                                                                  projectBuildingRequest );
086        }
087        catch ( Exception e )
088        {
089            event.getProblems().add( new ModelProblemCollectorRequest( Severity.ERROR, Version.BASE )
090                    .setMessage( "Invalid plugin repository: " + e.getMessage() )
091                    .setException( e ) );
092        }
093        project.setPluginArtifactRepositories( pluginRepositories );
094
095        if ( event.getRequest().isProcessPlugins() )
096        {
097            try
098            {
099                ProjectRealmCache.CacheRecord record =
100                    projectBuildingHelper.createProjectRealm( project, model, projectBuildingRequest );
101
102                project.setClassRealm( record.realm );
103                project.setExtensionDependencyFilter( record.extensionArtifactFilter );
104            }
105            catch ( PluginResolutionException | PluginManagerException | PluginVersionResolutionException e )
106            {
107                event.getProblems().add( new ModelProblemCollectorRequest( Severity.ERROR, Version.BASE )
108                        .setMessage( "Unresolveable build extension: " + e.getMessage() )
109                        .setException( e ) );
110            }
111
112            projectBuildingHelper.selectProjectRealm( project );
113        }
114
115        // build the regular repos after extensions are loaded to allow for custom layouts
116        try
117        {
118            remoteRepositories =
119                projectBuildingHelper.createArtifactRepositories( model.getRepositories(), remoteRepositories,
120                                                                  projectBuildingRequest );
121        }
122        catch ( Exception e )
123        {
124            event.getProblems().add( new ModelProblemCollectorRequest( Severity.ERROR, Version.BASE )
125                    .setMessage( "Invalid artifact repository: " + e.getMessage() )
126                    .setException( e ) );
127        }
128        project.setRemoteArtifactRepositories( remoteRepositories );
129    }
130
131}