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   * @since 2.2
40   */
41  //CHECKSTYLE_OFF: LineLength
42  @Mojo( name = "properties", requiresDependencyResolution = ResolutionScope.TEST, defaultPhase = LifecyclePhase.INITIALIZE, threadSafe = true )
43  //CHECKSTYLE_ON: LineLength
44  public class PropertiesMojo
45      extends AbstractMojo
46  {
47  
48      /**
49       * The current Maven project
50       */
51      @Parameter( defaultValue = "${project}", readonly = true, required = true )
52      private MavenProject project;
53  
54      /**
55       * Skip plugin execution completely.
56       *
57       * @since 2.7
58       */
59      @Parameter( property = "mdep.skip", defaultValue = "false" )
60      private boolean skip;
61  
62      /**
63       * Main entry into mojo. Gets the list of dependencies and iterates through setting a property for each artifact.
64       *
65       * @throws MojoExecutionException with a message if an error occurs.
66       */
67      @Override
68      public void execute()
69          throws MojoExecutionException
70      {
71          if ( isSkip() )
72          {
73              getLog().info( "Skipping plugin execution" );
74              return;
75          }
76  
77          Set<Artifact> artifacts = project.getArtifacts();
78  
79          for ( Artifact artifact : artifacts )
80          {
81              project.getProperties().setProperty( artifact.getDependencyConflictId(),
82                                                   artifact.getFile().getAbsolutePath() );
83          }
84      }
85  
86      /**
87       * @return {@link #skip}
88       */
89      public boolean isSkip()
90      {
91          return skip;
92      }
93  }