View Javadoc

1   package org.apache.maven.plugins.site;
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.io.File;
23  import java.io.IOException;
24  
25  import java.util.List;
26  import java.util.Locale;
27  
28  import org.apache.maven.plugin.MojoExecutionException;
29  import org.apache.maven.plugins.annotations.Component;
30  import org.apache.maven.plugins.annotations.LifecyclePhase;
31  import org.apache.maven.plugins.annotations.Mojo;
32  import org.apache.maven.plugins.annotations.Parameter;
33  import org.apache.maven.project.MavenProjectHelper;
34  
35  import org.codehaus.plexus.util.FileUtils;
36  
37  /**
38   * Adds the site descriptor (<code>site.xml</code>) to the list of files to be installed/deployed.<br/>
39   * For Maven-2.x this is enabled by default only when the project has <code>pom</code> packaging since it will be used by modules inheriting,
40   * but this can be enabled for other projects packaging if needed.<br/>
41   * This default execution has been removed from the built-in lifecycle of Maven 3.x for <code>pom</code>-projects.
42   * Users that actually use those projects to provide a common site descriptor for sub modules will need to explicitly define this goal execution to restore the intended behavior.  
43   *
44   * @author <a href="mailto:brett@apache.org">Brett Porter</a>
45   * @version $Id: SiteDescriptorAttachMojo.html 861484 2013-05-09 23:10:16Z hboutemy $
46   */
47  @Mojo( name = "attach-descriptor", defaultPhase = LifecyclePhase.PACKAGE, threadSafe = true)
48  public class SiteDescriptorAttachMojo
49      extends AbstractSiteMojo
50  {
51      /**
52       */
53      @Parameter( property = "basedir", required = true, readonly = true )
54      private File basedir;
55  
56      /**
57       * Maven ProjectHelper.
58       *
59       * @readonly
60       * @since 2.1.1
61       */
62      @Component
63      private MavenProjectHelper projectHelper;
64  
65      /**
66       * @parameter default-value="true"
67       */
68      @Parameter( defaultValue = "true" )
69      private boolean pomPackagingOnly;
70  
71      public void execute()
72          throws MojoExecutionException
73      {
74          if ( pomPackagingOnly && !"pom".equals( project.getPackaging() ) )
75          {
76              // http://jira.codehaus.org/browse/MSITE-597
77              return;
78          }
79  
80          List<Locale> localesList = siteTool.getAvailableLocales( locales );
81  
82          for ( Locale locale : localesList )
83          {
84              File descriptorFile = siteTool.getSiteDescriptorFromBasedir(
85                  siteTool.getRelativePath( siteDirectory.getAbsolutePath(), project.getBasedir().getAbsolutePath() ),
86                                                                           basedir, locale );
87  
88              if ( descriptorFile.exists() )
89              {
90                  // Calculate the classifier to use
91                  String classifier = getClassifier( descriptorFile );
92                  // Prepare a file for the interpolated site descriptor
93                  String filename = project.getArtifactId() + "-" + project.getVersion() + "-" + descriptorFile.getName();
94                  File targetDescriptorFile = new File( project.getBuild().getDirectory(), filename );
95  
96                  try
97                  {
98                      // Copy the site descriptor to a file
99                      FileUtils.copyFile( descriptorFile, targetDescriptorFile );
100                     // Attach the site descriptor
101                     getLog().debug( "Attaching the site descriptor '" + targetDescriptorFile.getAbsolutePath()
102                         + "' with classifier '" + classifier + "' to the project." );
103                     projectHelper.attachArtifact( project, "xml", classifier, targetDescriptorFile );
104                 }
105                 catch ( IOException e )
106                 {
107                     throw new MojoExecutionException( "Unable to copy site descriptor", e );
108                 }
109             }
110         }
111     }
112 
113     private static String getClassifier( final File descriptorFile )
114         throws MojoExecutionException
115     {
116         final int index = descriptorFile.getName().lastIndexOf( '.' );
117 
118         if ( index > 0 )
119         {
120             return descriptorFile.getName().substring( 0, index );
121         }
122         else
123         {
124             throw new MojoExecutionException( "Unable to determine the classifier to use" );
125         }
126     }
127 }