View Javadoc
1   /*
2    * Licensed to the Apache Software Foundation (ASF) under one
3    * or more contributor license agreements.  See the NOTICE file
4    * distributed with this work for additional information
5    * regarding copyright ownership.  The ASF licenses this file
6    * to you under the Apache License, Version 2.0 (the
7    * "License"); you may not use this file except in compliance
8    * with the License.  You may obtain a copy of the License at
9    *
10   *   http://www.apache.org/licenses/LICENSE-2.0
11   *
12   * Unless required by applicable law or agreed to in writing,
13   * software distributed under the License is distributed on an
14   * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
15   * KIND, either express or implied.  See the License for the
16   * specific language governing permissions and limitations
17   * under the License.
18   */
19  package org.apache.maven.plugins.site.deploy;
20  
21  import org.apache.maven.plugin.MojoExecutionException;
22  import org.apache.maven.plugins.annotations.Parameter;
23  import org.apache.maven.project.MavenProject;
24  
25  /**
26   * Abstract base class for staging mojos.
27   *
28   * @author hboutemy
29   * @since 3.3
30   */
31  public abstract class AbstractStagingMojo extends AbstractDeployMojo {
32      /**
33       * Top distribution management site url, for manual configuration when auto-calculated value
34       * doesn't match expectations. Relative module directory will be calculated from this url.
35       *
36       * @since 3.3
37       */
38      @Parameter(property = "topSiteURL")
39      protected String topSiteURL;
40  
41      /**
42       * The String "staging/".
43       */
44      protected static final String DEFAULT_STAGING_DIRECTORY = "staging/";
45  
46      /**
47       * By default, staging mojos will get their top distribution management site url by getting top parent
48       * with the same site, which is a good heuristics. But in case the default value doesn't match
49       * expectations, <code>topSiteURL</code> can be configured: it will be used instead.
50       */
51      @Override
52      protected String determineTopDistributionManagementSiteUrl() throws MojoExecutionException {
53          if (topSiteURL == null || topSiteURL.isEmpty()) {
54              MavenProject topProject = getTopLevelProject(project);
55              String url = getSite(topProject).getUrl();
56  
57              getLog().debug("staging top distributionManagement.site.url found in " + topProject.getId()
58                      + " with value: " + url);
59  
60              return url;
61          }
62  
63          getLog().debug("staging top distributionManagement.site.url configured with topSiteURL parameter: "
64                  + topSiteURL);
65          return topSiteURL;
66      }
67  }