/* * Copyright (C) 2015, Kaloyan Raev and others * * This program and the accompanying materials are made available under the * terms of the Eclipse Distribution License v. 1.0 which is available at * https://www.eclipse.org/org/documents/edl-v10.php. * * SPDX-License-Identifier: BSD-3-Clause */ package org.eclipse.jgit.api; import java.io.IOException; import java.net.URISyntaxException; import java.util.List; import org.eclipse.jgit.api.errors.GitAPIException; import org.eclipse.jgit.api.errors.JGitInternalException; import org.eclipse.jgit.lib.Repository; import org.eclipse.jgit.lib.StoredConfig; import org.eclipse.jgit.transport.RemoteConfig; import org.eclipse.jgit.transport.URIish; /** * Used to change the URL of a remote. * * This class has setters for all supported options and arguments of this * command and a {@link #call()} method to finally execute the command. * * @see Git * documentation about Remote * @since 4.2 */ public class RemoteSetUrlCommand extends GitCommand { /** * The available URI types for the remote. * * @since 5.3 */ public enum UriType { /** * Fetch URL for the remote. */ FETCH, /** * Push URL for the remote. */ PUSH } private String remoteName; private URIish remoteUri; private UriType type; /** *

* Constructor for RemoteSetUrlCommand. *

* * @param repo * the {@link org.eclipse.jgit.lib.Repository} */ protected RemoteSetUrlCommand(Repository repo) { super(repo); } /** * The name of the remote to change the URL for. * * @param name * a remote name * @deprecated use {@link #setRemoteName} instead */ @Deprecated public void setName(String name) { this.remoteName = name; } /** * The name of the remote to change the URL for. * * @param remoteName * a remote remoteName * @return {@code this} * @since 5.3 */ public RemoteSetUrlCommand setRemoteName(String remoteName) { this.remoteName = remoteName; return this; } /** * The new URL for the remote. * * @param uri * an URL for the remote * @deprecated use {@link #setRemoteUri} instead */ @Deprecated public void setUri(URIish uri) { this.remoteUri = uri; } /** * The new URL for the remote. * * @param remoteUri * an URL for the remote * @return {@code this} * @since 5.3 */ public RemoteSetUrlCommand setRemoteUri(URIish remoteUri) { this.remoteUri = remoteUri; return this; } /** * Whether to change the push URL of the remote instead of the fetch URL. * * @param push * true to set the push url, false to * set the fetch url * @deprecated use {@link #setUriType} instead */ @Deprecated public void setPush(boolean push) { if (push) { setUriType(UriType.PUSH); } else { setUriType(UriType.FETCH); } } /** * Whether to change the push URL of the remote instead of the fetch URL. * * @param type * the UriType value to set * @return {@code this} * @since 5.3 */ public RemoteSetUrlCommand setUriType(UriType type) { this.type = type; return this; } /** * {@inheritDoc} *

* Executes the {@code remote} command with all the options and parameters * collected by the setter methods of this class. */ @Override public RemoteConfig call() throws GitAPIException { checkCallable(); try { StoredConfig config = repo.getConfig(); RemoteConfig remote = new RemoteConfig(config, remoteName); if (type == UriType.PUSH) { List uris = remote.getPushURIs(); if (uris.size() > 1) { throw new JGitInternalException( "remote.newtest.pushurl has multiple values"); //$NON-NLS-1$ } else if (uris.size() == 1) { remote.removePushURI(uris.get(0)); } remote.addPushURI(remoteUri); } else { List uris = remote.getURIs(); if (uris.size() > 1) { throw new JGitInternalException( "remote.newtest.url has multiple values"); //$NON-NLS-1$ } else if (uris.size() == 1) { remote.removeURI(uris.get(0)); } remote.addURI(remoteUri); } remote.update(config); config.save(); return remote; } catch (IOException | URISyntaxException e) { throw new JGitInternalException(e.getMessage(), e); } } }