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.ConfigConstants;
51 import org.eclipse.jgit.lib.Repository;
52 import org.eclipse.jgit.lib.StoredConfig;
53 import org.eclipse.jgit.transport.RemoteConfig;
54
55 /**
56 * Used to remove an existing remote.
57 *
58 * This class has setters for all supported options and arguments of this
59 * command and a {@link #call()} method to finally execute the command.
60 *
61 * @see <a href=
62 * "http://www.kernel.org/pub/software/scm/git/docs/git-remote.html" > Git
63 * documentation about Remote</a>
64 * @since 4.2
65 */
66 public class RemoteRemoveCommand extends GitCommand<RemoteConfig> {
67
68 private String name;
69
70 /**
71 * <p>
72 * Constructor for RemoteRemoveCommand.
73 * </p>
74 *
75 * @param repo
76 * the {@link org.eclipse.jgit.lib.Repository}
77 */
78 protected RemoteRemoveCommand(Repository repo) {
79 super(repo);
80 }
81
82 /**
83 * The name of the remote to remove.
84 *
85 * @param name
86 * a remote name
87 */
88 public void setName(String name) {
89 this.name = name;
90 }
91
92 /**
93 * {@inheritDoc}
94 * <p>
95 * Executes the {@code remote} command with all the options and parameters
96 * collected by the setter methods of this class.
97 */
98 @Override
99 public RemoteConfig call() throws GitAPIException {
100 checkCallable();
101
102 try {
103 StoredConfig config = repo.getConfig();
104 RemoteConfig remote = new RemoteConfig(config, name);
105 config.unsetSection(ConfigConstants.CONFIG_KEY_REMOTE, name);
106 config.save();
107 return remote;
108 } catch (IOException | URISyntaxException e) {
109 throw new JGitInternalException(e.getMessage(), e);
110 }
111
112 }
113
114 }