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 org.apache.maven.model.Site;
23  import org.apache.maven.plugin.MojoExecutionException;
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>&lt;distributionManagement&gt;</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   * @version $Id: SiteDeployMojo.html 816561 2012-05-08 12:02:24Z hboutemy $
37   * @goal deploy
38   */
39  public class SiteDeployMojo
40      extends AbstractDeployMojo
41  {
42      private Site site;
43  
44      @Override
45      public String getDeployRepositoryID()
46          throws MojoExecutionException
47      {
48          if ( site == null )
49          {
50              site = getRootSite( project );
51          }
52  
53          return site.getId();
54      }
55  
56      @Override
57      public String getDeployRepositoryURL()
58          throws MojoExecutionException
59      {
60          if ( site == null )
61          {
62              site = getRootSite( project );
63          }
64  
65          return site.getUrl();
66      }
67  }