View Javadoc
1   package org.apache.maven.plugins.dependency;
2   
3   /*
4    * Licensed to the Apache Software Foundation (ASF) under one
5    * or more contributor license agreements.  See the NOTICE file
6    * distributed with this work for additional information
7    * regarding copyright ownership.  The ASF licenses this file
8    * to you under the Apache License, Version 2.0 (the
9    * "License"); you may not use this file except in compliance
10   * with the License.  You may obtain a copy of the License at
11   *
12   * http://www.apache.org/licenses/LICENSE-2.0
13   *
14   * Unless required by applicable law or agreed to in writing,
15   * software distributed under the License is distributed on an
16   * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
17   * KIND, either express or implied.  See the License for the
18   * specific language governing permissions and limitations
19   * under the License.
20   */
21  
22  import java.util.Set;
23  
24  import org.apache.maven.artifact.Artifact;
25  import org.apache.maven.plugin.AbstractMojo;
26  import org.apache.maven.plugin.MojoExecutionException;
27  import org.apache.maven.plugins.annotations.LifecyclePhase;
28  import org.apache.maven.plugins.annotations.Mojo;
29  import org.apache.maven.plugins.annotations.Parameter;
30  import org.apache.maven.plugins.annotations.ResolutionScope;
31  import org.apache.maven.project.MavenProject;
32  
33  /**
34   * Goal that sets a property pointing to the artifact file for each project dependency. For each dependency (direct and
35   * transitive) a project property will be set which follows the <code>groupId:artifactId:type:[classifier]</code> form
36   * and contains the path to the resolved artifact.
37   *
38   * @author Paul Gier
39   * @version $Id: PropertiesMojo.java 1807877 2017-09-09 10:35:59Z khmarbaise $
40   * @since 2.2
41   */
42  //CHECKSTYLE_OFF: LineLength
43  @Mojo( name = "properties", requiresDependencyResolution = ResolutionScope.TEST, defaultPhase = LifecyclePhase.INITIALIZE, threadSafe = true )
44  //CHECKSTYLE_ON: LineLength
45  public class PropertiesMojo
46      extends AbstractMojo
47  {
48  
49      /**
50       * The current Maven project
51       */
52      @Parameter( defaultValue = "${project}", readonly = true, required = true )
53      private MavenProject project;
54  
55      /**
56       * Skip plugin execution completely.
57       *
58       * @since 2.7
59       */
60      @Parameter( property = "mdep.skip", defaultValue = "false" )
61      private boolean skip;
62  
63      /**
64       * Main entry into mojo. Gets the list of dependencies and iterates through setting a property for each artifact.
65       *
66       * @throws MojoExecutionException with a message if an error occurs.
67       */
68      @Override
69      public void execute()
70          throws MojoExecutionException
71      {
72          if ( isSkip() )
73          {
74              getLog().info( "Skipping plugin execution" );
75              return;
76          }
77  
78          Set<Artifact> artifacts = project.getArtifacts();
79  
80          for ( Artifact artifact : artifacts )
81          {
82              project.getProperties().setProperty( artifact.getDependencyConflictId(),
83                                                   artifact.getFile().getAbsolutePath() );
84          }
85      }
86  
87      public boolean isSkip()
88      {
89          return skip;
90      }
91  }