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.model.Site;
22 import org.apache.maven.plugin.MojoExecutionException;
23 import org.apache.maven.plugins.annotations.Mojo;
24
25 /**
26 * Deploys the generated site using <a href="/wagon/">wagon supported
27 * protocols</a> to the site URL specified in the
28 * <code><distributionManagement></code> section of the POM.
29 * <p>
30 * For <code>scp</code> protocol, the website files are packaged by wagon into zip archive,
31 * then the archive is transfered to the remote host, next it is un-archived which is much faster
32 * than making a file by file copy.
33 * </p>
34 *
35 * @author <a href="mailto:michal@org.codehaus.org">Michal Maczka</a>
36 *
37 * @since 2.0
38 */
39 @Mojo(name = "deploy")
40 public class SiteDeployMojo extends AbstractDeployMojo {
41 @Override
42 protected boolean isDeploy() {
43 return true;
44 }
45
46 /**
47 * Deploy distribution site url is directly the current project value.
48 */
49 @Override
50 protected String determineTopDistributionManagementSiteUrl() throws MojoExecutionException {
51 return getDeploySite().getUrl();
52 }
53
54 /**
55 * Deploy directly to the current project's distribution management site.
56 */
57 @Override
58 protected Site determineDeploySite() throws MojoExecutionException {
59 return getSite(getTopLevelProject(project));
60 }
61 }