View Javadoc
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  import java.util.List;
48  
49  import org.eclipse.jgit.api.errors.GitAPIException;
50  import org.eclipse.jgit.api.errors.JGitInternalException;
51  import org.eclipse.jgit.lib.Repository;
52  import org.eclipse.jgit.lib.StoredConfig;
53  import org.eclipse.jgit.transport.RemoteConfig;
54  import org.eclipse.jgit.transport.URIish;
55  
56  /**
57   * Used to to change the URL of a remote.
58   *
59   * This class has setters for all supported options and arguments of this
60   * command and a {@link #call()} method to finally execute the command.
61   *
62   * @see <a href=
63   *      "http://www.kernel.org/pub/software/scm/git/docs/git-remote.html" > Git
64   *      documentation about Remote</a>
65   *
66   * @since 4.2
67   */
68  public class RemoteSetUrlCommand extends GitCommand<RemoteConfig> {
69  
70  	private String name;
71  
72  	private URIish uri;
73  
74  	private boolean push;
75  
76  	/**
77  	 * @param repo
78  	 */
79  	protected RemoteSetUrlCommand(Repository repo) {
80  		super(repo);
81  	}
82  
83  	/**
84  	 * The name of the remote to change the URL for.
85  	 *
86  	 * @param name
87  	 *            a remote name
88  	 */
89  	public void setName(String name) {
90  		this.name = name;
91  	}
92  
93  	/**
94  	 * The new URL for the remote.
95  	 *
96  	 * @param uri
97  	 *            an URL for the remote
98  	 */
99  	public void setUri(URIish uri) {
100 		this.uri = uri;
101 	}
102 
103 	/**
104 	 * Whether to change the push URL of the remote instead of the fetch URL.
105 	 *
106 	 * @param push
107 	 *            <code>true</code> to set the push url, <code>false</code> to
108 	 *            set the fetch url
109 	 */
110 	public void setPush(boolean push) {
111 		this.push = push;
112 	}
113 
114 	/**
115 	 * Executes the {@code remote} command with all the options and parameters
116 	 * collected by the setter methods of this class.
117 	 *
118 	 * @return the {@link RemoteConfig} object of the modified remote
119 	 */
120 	@Override
121 	public RemoteConfig call() throws GitAPIException {
122 		checkCallable();
123 
124 		try {
125 			StoredConfig config = repo.getConfig();
126 			RemoteConfig remote = new RemoteConfig(config, name);
127 			if (push) {
128 				List<URIish> uris = remote.getPushURIs();
129 				if (uris.size() > 1) {
130 					throw new JGitInternalException(
131 							"remote.newtest.pushurl has multiple values"); //$NON-NLS-1$
132 				} else if (uris.size() == 1) {
133 					remote.removePushURI(uris.get(0));
134 				}
135 				remote.addPushURI(uri);
136 			} else {
137 				List<URIish> uris = remote.getURIs();
138 				if (uris.size() > 1) {
139 					throw new JGitInternalException(
140 							"remote.newtest.url has multiple values"); //$NON-NLS-1$
141 				} else if (uris.size() == 1) {
142 					remote.removeURI(uris.get(0));
143 				}
144 				remote.addURI(uri);
145 			}
146 
147 			remote.update(config);
148 			config.save();
149 			return remote;
150 		} catch (IOException | URISyntaxException e) {
151 			throw new JGitInternalException(e.getMessage(), e);
152 		}
153 	}
154 
155 }