View Javadoc

1   package org.apache.maven.plugin.dependency.fromConfiguration;
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 org.apache.maven.plugin.MojoExecutionException;
23  import org.apache.maven.plugin.MojoFailureException;
24  import org.apache.maven.plugin.dependency.utils.filters.ArtifactItemFilter;
25  import org.apache.maven.plugin.dependency.utils.filters.DestFileFilter;
26  import org.apache.maven.plugins.annotations.LifecyclePhase;
27  import org.apache.maven.plugins.annotations.Mojo;
28  import org.apache.maven.plugins.annotations.Parameter;
29  
30  import java.io.File;
31  import java.util.List;
32  
33  /**
34   * Goal that copies a list of artifacts from the repository to defined locations.
35   *
36   * @author <a href="mailto:brianf@apache.org">Brian Fox</a>
37   * @version $Id: CopyMojo.html 862013 2013-05-14 22:24:45Z hboutemy $
38   * @since 1.0
39   */
40  @Mojo( name = "copy", defaultPhase = LifecyclePhase.PROCESS_SOURCES, requiresProject = false, threadSafe = true  )
41  public class CopyMojo
42      extends AbstractFromConfigurationMojo
43  {
44  
45      /**
46       * Strip artifact version during copy
47       */
48      @Parameter( property = "mdep.stripVersion", defaultValue = "false" )
49      private boolean stripVersion = false;
50  
51      /**
52       * Strip artifact classifier during copy
53       */
54      @Parameter( property = "mdep.stripClassifier", defaultValue = "false" )
55      private boolean stripClassifier = false;
56      
57      /**
58       * Prepend artifact groupId during copy
59       * @since 2.7
60       */
61      @Parameter( property = "mdep.prependGroupId", defaultValue = "false" )
62      private boolean prependGroupId = false;
63  
64      /**
65       * Use artifact baseVersion during copy
66       * @since 2.7
67       */
68      @Parameter( property = "mdep.useBaseVersion", defaultValue = "false" )
69      private boolean useBaseVersion = false;
70  
71      /**
72       * The artifact to copy from commandLine.
73       * Use {@link #artifactItems} within the pom-configuration.
74       */
75      @SuppressWarnings( "unused" ) //marker-field, setArtifact(String) does the magic
76      @Parameter( property = "artifact" )
77      private String artifact;
78  
79      /**
80       * <i>not used in this goal</i>
81       */
82      @Parameter
83      protected boolean useJvmChmod = true;
84  
85      /**
86       * <i>not used in this goal</i>
87       */
88      @Parameter
89      protected boolean ignorePermissions;
90  
91      /**
92       * Main entry into mojo. This method gets the ArtifactItems and iterates through each one passing it to
93       * copyArtifact.
94       *
95       * @throws MojoExecutionException with a message if an error occurs.
96       * @see ArtifactItem
97       * @see #getArtifactItems
98       * @see #copyArtifact(ArtifactItem)
99       */
100     protected void doExecute()
101         throws MojoExecutionException, MojoFailureException
102     {
103         verifyRequirements();
104 
105         List<ArtifactItem> theArtifactItems = getProcessedArtifactItems(
106             new ProcessArtifactItemsRequest( this.stripVersion, this.prependGroupId, this.useBaseVersion, this.stripClassifier ) );
107         for ( ArtifactItem artifactItem : theArtifactItems )
108         {
109             if ( artifactItem.isNeedsProcessing() )
110             {
111                 copyArtifact( artifactItem );
112             }
113             else
114             {
115                 this.getLog().info( artifactItem + " already exists in " + artifactItem.getOutputDirectory() );
116             }
117         }
118     }
119 
120     /**
121      * Resolves the artifact from the repository and copies it to the specified location.
122      *
123      * @param artifactItem containing the information about the Artifact to copy.
124      * @throws MojoExecutionException with a message if an error occurs.
125      * @see DependencyUtil#copyFile(File, File, Log)
126      * @see DependencyUtil#getFormattedFileName(Artifact, boolean)
127      */
128     protected void copyArtifact( ArtifactItem artifactItem )
129         throws MojoExecutionException
130     {
131         File destFile = new File( artifactItem.getOutputDirectory(), artifactItem.getDestFileName() );
132 
133         copyFile( artifactItem.getArtifact().getFile(), destFile );
134     }
135 
136     protected ArtifactItemFilter getMarkedArtifactFilter( ArtifactItem item )
137     {
138         ArtifactItemFilter destinationNameOverrideFilter =
139             new DestFileFilter( this.isOverWriteReleases(), this.isOverWriteSnapshots(), this.isOverWriteIfNewer(),
140                                 false, false, false, false, this.stripVersion, item.getOutputDirectory() );
141         return destinationNameOverrideFilter;
142     }
143 
144     /**
145      * @return Returns the stripVersion.
146      */
147     public boolean isStripVersion()
148     {
149         return this.stripVersion;
150     }
151 
152     /**
153      * @param stripVersion The stripVersion to set.
154      */
155     public void setStripVersion( boolean stripVersion )
156     {
157         this.stripVersion = stripVersion;
158     }
159     
160     /**
161      * @return Returns the stripClassifier.
162      */
163     public boolean isStripClassifier()
164     {
165         return this.stripClassifier;
166     }
167 
168     /**
169      * @param stripClassifier The stripClassifier to set.
170      */
171     public void setStripClassifier( boolean stripClassifier )
172     {
173         this.stripClassifier = stripClassifier;
174     }
175 
176     /**
177      * @param useBaseVersion The useBaseVersion to set.
178      */
179     public void setUseBaseVersion( boolean useBaseVersion )
180     {
181         this.useBaseVersion = useBaseVersion;
182     }
183 }