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 <code>scp</code> or <code>file</code>
27   * protocol 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 into zip archive,
31   * then the archive is transfered to the remote host, next it is un-archived.
32   * This method of deployment should normally be much faster
33   * than making a file by file copy.  For <code>file</code> protocol, the files are copied
34   * directly to the destination directory.
35   * </p>
36   *
37   * @author <a href="mailto:michal@org.codehaus.org">Michal Maczka</a>
38   * @version $Id: SiteDeployMojo.html 816568 2012-05-08 12:09:38Z hboutemy $
39   * @goal deploy
40   */
41  public class SiteDeployMojo
42      extends AbstractDeployMojo
43  {
44      private Site site;
45  
46      @Override
47      public String getDeployRepositoryID()
48          throws MojoExecutionException
49      {
50          if ( site == null )
51          {
52              site = getRootSite( project );
53          }
54  
55          return site.getId();
56      }
57  
58      @Override
59      public String getDeployRepositoryURL()
60          throws MojoExecutionException
61      {
62          if ( site == null )
63          {
64              site = getRootSite( project );
65          }
66  
67          return site.getUrl();
68      }
69  }