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.plugin.MojoExecutionException;
36 import org.apache.maven.wagon.Wagon;
37 import org.apache.maven.wagon.WagonException;
38
39 /**
40 * Download a single file.
41 *
42 * @goal download-single
43 * @requiresProject false
44 */
45 public class DownloadSingleMojo
46 extends AbstractSingleWagonMojo
47 {
48 /**
49 * Relative path to the URL.
50 * @parameter expression="${wagon.fromFile}"
51 * @required
52 */
53 private String fromFile;
54
55 /**
56 * Directory to download the remote file to
57 * @parameter expression="${wagon.toDir}"
58 */
59 private File toDir;
60
61 /**
62 * File to download the remote file to. Use this option to rename the file after download.
63 * When toDir is present, this argument is ignored
64 * @parameter expression="${wagon.toFile}"
65 */
66 private File toFile;
67
68
69 protected void execute( Wagon wagon )
70 throws MojoExecutionException, WagonException
71 {
72
73 if ( this.skip )
74 {
75 this.getLog().info( "Skip execution." );
76 return;
77 }
78
79 if ( toDir != null )
80 {
81 toFile = new File( toDir, new File( fromFile ).getName() );
82 }
83
84 if ( toFile == null )
85 {
86 throw new MojoExecutionException( "Either toDir or toFile is required" );
87 }
88
89 this.getLog().info( "Downloading: " + wagon.getRepository().getUrl() + "/" + fromFile + " to " + toFile );
90
91 wagon.get( fromFile, toFile );
92
93 }
94
95 }