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 import org.apache.maven.shared.utils.StringUtils;
25
26 /**
27 * Abstract base class for staging mojos.
28 *
29 * @author hboutemy
30 * @since 3.3
31 */
32 public abstract class AbstractStagingMojo extends AbstractDeployMojo {
33 /**
34 * Top distribution management site url, for manual configuration when auto-calculated value
35 * doesn't match expectations. Relative module directory will be calculated from this url.
36 *
37 * @since 3.3
38 */
39 @Parameter(property = "topSiteURL")
40 protected String topSiteURL;
41
42 /**
43 * The String "staging/".
44 */
45 protected static final String DEFAULT_STAGING_DIRECTORY = "staging/";
46
47 /**
48 * By default, staging mojos will get their top distribution management site url by getting top parent
49 * with the same site, which is a good heuristics. But in case the default value doesn't match
50 * expectations, <code>topSiteURL</code> can be configured: it will be used instead.
51 */
52 @Override
53 protected String determineTopDistributionManagementSiteUrl() throws MojoExecutionException {
54 if (StringUtils.isEmpty(topSiteURL)) {
55 MavenProject topProject = getTopLevelProject(project);
56 String url = getSite(topProject).getUrl();
57
58 getLog().debug("staging top distributionManagement.site.url found in " + topProject.getId()
59 + " with value: " + url);
60
61 return url;
62 }
63
64 getLog().debug("staging top distributionManagement.site.url configured with topSiteURL parameter: "
65 + topSiteURL);
66 return topSiteURL;
67 }
68 }