1 /*
2 * Copyright (C) 2015, Kaloyan Raev <kaloyan.r@zend.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.api;
44
45 import java.io.IOException;
46 import java.net.URISyntaxException;
47
48 import org.eclipse.jgit.api.errors.GitAPIException;
49 import org.eclipse.jgit.api.errors.JGitInternalException;
50 import org.eclipse.jgit.lib.Constants;
51 import org.eclipse.jgit.lib.Repository;
52 import org.eclipse.jgit.lib.StoredConfig;
53 import org.eclipse.jgit.transport.RefSpec;
54 import org.eclipse.jgit.transport.RemoteConfig;
55 import org.eclipse.jgit.transport.URIish;
56
57 /**
58 * Used to add a new remote.
59 *
60 * This class has setters for all supported options and arguments of this
61 * command and a {@link #call()} method to finally execute the command.
62 *
63 * @see <a href=
64 * "http://www.kernel.org/pub/software/scm/git/docs/git-remote.html" > Git
65 * documentation about Remote</a>
66 * @since 4.2
67 */
68 public class RemoteAddCommand extends GitCommand<RemoteConfig> {
69
70 private String name;
71
72 private URIish uri;
73
74 /**
75 * Constructor for RemoteAddCommand.
76 *
77 * @param repo
78 * the {@link org.eclipse.jgit.lib.Repository}
79 */
80 protected RemoteAddCommand(Repository repo) {
81 super(repo);
82 }
83
84 /**
85 * The name of the remote to add.
86 *
87 * @param name
88 * a remote name
89 * @return this instance
90 * @since 5.0
91 */
92 public RemoteAddCommand setName(String name) {
93 this.name = name;
94 return this;
95 }
96
97 /**
98 * The URL of the repository for the new remote.
99 *
100 * @param uri
101 * an URL for the remote
102 * @return this instance
103 * @since 5.0
104 */
105 public RemoteAddCommand setUri(URIish uri) {
106 this.uri = uri;
107 return this;
108 }
109
110 /**
111 * {@inheritDoc}
112 * <p>
113 * Executes the {@code remote add} command with all the options and
114 * parameters collected by the setter methods of this class.
115 */
116 @Override
117 public RemoteConfig call() throws GitAPIException {
118 checkCallable();
119
120 try {
121 StoredConfig config = repo.getConfig();
122 RemoteConfig remote = new RemoteConfig(config, name);
123
124 RefSpec refSpec = new RefSpec();
125 refSpec = refSpec.setForceUpdate(true);
126 refSpec = refSpec.setSourceDestination(Constants.R_HEADS + "*", //$NON-NLS-1$
127 Constants.R_REMOTES + name + "/*"); //$NON-NLS-1$
128 remote.addFetchRefSpec(refSpec);
129
130 remote.addURI(uri);
131
132 remote.update(config);
133 config.save();
134 return remote;
135 } catch (IOException | URISyntaxException e) {
136 throw new JGitInternalException(e.getMessage(), e);
137 }
138
139 }
140
141 }