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