View Javadoc

1   /**
2    * Copyright 2008-2012 The Kuali Foundation
3    *
4    * Licensed under the Educational Community License, Version 2.0 (the "License");
5    * you may not use this file except in compliance with the License.
6    * You may obtain a copy of the License at
7    *
8    * http://www.opensource.org/licenses/ecl2.php
9    *
10   * Unless required by applicable law or agreed to in writing, software
11   * distributed under the License is distributed on an "AS IS" BASIS,
12   * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13   * See the License for the specific language governing permissions and
14   * limitations under the License.
15   */
16  package org.codehaus.mojo.wagon;
17  
18  /**
19   * Licensed to the Apache Software Foundation (ASF) under one or more contributor license
20   * agreements. See the NOTICE file distributed with this work for additional information regarding
21   * copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the
22   * "License"); you may not use this file except in compliance with the License. You may obtain a
23   * copy of the License at
24   * 
25   * http://www.apache.org/licenses/LICENSE-2.0
26   * 
27   * Unless required by applicable law or agreed to in writing, software distributed under the License
28   * is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express
29   * or implied. See the License for the specific language governing permissions and limitations under
30   * the License.
31   */
32  
33  import java.io.File;
34  
35  import org.apache.maven.wagon.Wagon;
36  import org.apache.maven.wagon.WagonException;
37  import org.codehaus.mojo.wagon.shared.WagonFileSet;
38  
39  /**
40   * Transfers a set of files from a remote URL to a specified local directory.
41   * 
42   * @goal download
43   * @requiresProject false
44   */
45  public class DownloadMojo
46      extends AbstractWagonListMojo
47  {
48      
49      /**
50       * Local directory to download the remote resource ( tree ) to.
51       * 
52       * @parameter expression="${wagon.toDir}" default-value="${project.build.directory}/wagon-plugin"
53       */
54      private File toDir;
55      
56      
57      protected void execute( Wagon wagon )
58          throws WagonException
59      {
60          WagonFileSet fileSet = this.getWagonFileSet();
61          fileSet.setDownloadDirectory( this.toDir );
62          
63          this.wagonDownload.download( wagon, fileSet, this.getLog() );
64      }
65  
66  }