View Javadoc
1   /*
2    * Copyright (C) 2011, Ketan Padegaonkar <KetanPadegaonkar@gmail.com>
3    * and other copyright owners as documented in the project's IP log.
4    *
5    * This program and the accompanying materials are made available
6    * under the terms of the Eclipse Distribution License v1.0 which
7    * accompanies this distribution, is reproduced below, and is
8    * available at http://www.eclipse.org/org/documents/edl-v10.php
9    *
10   * All rights reserved.
11   *
12   * Redistribution and use in source and binary forms, with or
13   * without modification, are permitted provided that the following
14   * conditions are met:
15   *
16   * - Redistributions of source code must retain the above copyright
17   *   notice, this list of conditions and the following disclaimer.
18   *
19   * - Redistributions in binary form must reproduce the above
20   *   copyright notice, this list of conditions and the following
21   *   disclaimer in the documentation and/or other materials provided
22   *   with the distribution.
23   *
24   * - Neither the name of the Eclipse Foundation, Inc. nor the
25   *   names of its contributors may be used to endorse or promote
26   *   products derived from this software without specific prior
27   *   written permission.
28   *
29   * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND
30   * CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES,
31   * INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
32   * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
33   * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR
34   * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
35   * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
36   * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
37   * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
38   * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
39   * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
40   * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
41   * ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
42   */
43  package org.eclipse.jgit.ant.tasks;
44  
45  import java.io.File;
46  
47  import org.apache.tools.ant.BuildException;
48  import org.apache.tools.ant.Project;
49  import org.apache.tools.ant.Task;
50  import org.eclipse.jgit.api.CloneCommand;
51  import org.eclipse.jgit.api.Git;
52  import org.eclipse.jgit.api.errors.GitAPIException;
53  import org.eclipse.jgit.api.errors.JGitInternalException;
54  import org.eclipse.jgit.lib.Constants;
55  import org.eclipse.jgit.transport.URIish;
56  
57  /**
58   * Clone a repository into a new directory.
59   *
60   * @see <a href="http://www.kernel.org/pub/software/scm/git/docs/git-clone.html"
61   *      >git-clone(1)</a>
62   */
63  public class GitCloneTask extends Task {
64  
65  	private String uri;
66  	private File destination;
67  	private boolean bare;
68  	private String branch = Constants.HEAD;
69  
70  	/**
71  	 * @param uri
72  	 *            the uri to clone from
73  	 */
74  	public void setUri(String uri) {
75  		this.uri = uri;
76  	}
77  
78  	/**
79  	 * The optional directory associated with the clone operation. If the
80  	 * directory isn't set, a name associated with the source uri will be used.
81  	 *
82  	 * @see URIish#getHumanishName()
83  	 *
84  	 * @param destination
85  	 *            the directory to clone to
86  	 */
87  	public void setDest(File destination) {
88  		this.destination = destination;
89  	}
90  
91  	/**
92  	 * @param bare
93  	 *            whether the cloned repository is bare or not
94  	 */
95  	public void setBare(boolean bare) {
96  		this.bare = bare;
97  	}
98  
99  	/**
100 	 * @param branch
101 	 *            the initial branch to check out when cloning the repository
102 	 */
103 	public void setBranch(String branch) {
104 		this.branch = branch;
105 	}
106 
107 	@Override
108 	public void execute() throws BuildException {
109 		log("Cloning repository " + uri);
110 
111 		CloneCommand clone = Git.cloneRepository();
112 		try {
113 			clone.setURI(uri).setDirectory(destination).setBranch(branch).setBare(bare);
114 			clone.call().getRepository().close();
115 		} catch (GitAPIException | JGitInternalException e) {
116 			log("Could not clone repository: " + e, e, Project.MSG_ERR);
117 			throw new BuildException("Could not clone repository: " + e.getMessage(), e);
118 		}
119 	}
120 }