diff --git a/org.eclipse.jgit/src/org/eclipse/jgit/api/CloneCommand.java b/org.eclipse.jgit/src/org/eclipse/jgit/api/CloneCommand.java index 29dd6e90c..281704fad 100644 --- a/org.eclipse.jgit/src/org/eclipse/jgit/api/CloneCommand.java +++ b/org.eclipse.jgit/src/org/eclipse/jgit/api/CloneCommand.java @@ -104,6 +104,8 @@ public class CloneCommand implements Callable { private Collection branchesToClone; + private TransportConfigCallback transportConfigCallback; + /** * Executes the {@code Clone} command. * @@ -167,6 +169,7 @@ private FetchResult fetch(Repository repo, URIish u) command.setTimeout(timeout); if (credentialsProvider != null) command.setCredentialsProvider(credentialsProvider); + command.setTransportConfigCallback(transportConfigCallback); List specs = calculateRefSpecs(dst); command.setRefSpecs(specs); @@ -394,4 +397,17 @@ public CloneCommand setNoCheckout(boolean noCheckout) { return this; } + /** + * @param transportConfigCallback + * if set, the callback will be invoked after the Transport has + * created, but before the Transport is used. The callback can + * use this opportunity to set additional type-specific + * configuration on the Transport instance. + * @return {@code this} + */ + public CloneCommand setTransportConfigCallback( + TransportConfigCallback transportConfigCallback) { + this.transportConfigCallback = transportConfigCallback; + return this; + } } diff --git a/org.eclipse.jgit/src/org/eclipse/jgit/api/FetchCommand.java b/org.eclipse.jgit/src/org/eclipse/jgit/api/FetchCommand.java index 51dc5295f..8fe9d59a2 100644 --- a/org.eclipse.jgit/src/org/eclipse/jgit/api/FetchCommand.java +++ b/org.eclipse.jgit/src/org/eclipse/jgit/api/FetchCommand.java @@ -93,6 +93,8 @@ public class FetchCommand extends GitCommand { private TagOpt tagOption; + private TransportConfigCallback transportConfigCallback; + /** * @param repo */ @@ -132,6 +134,8 @@ public FetchResult call() throws JGitInternalException, transport.setFetchThin(thin); if (credentialsProvider != null) transport.setCredentialsProvider(credentialsProvider); + if (transportConfigCallback != null) + transportConfigCallback.configure(transport); FetchResult result = transport.fetch(monitor, refSpecs); return result; @@ -353,4 +357,19 @@ public FetchCommand setTagOpt(TagOpt tagOpt) { this.tagOption = tagOpt; return this; } + + /** + * @param transportConfigCallback + * if set, the callback will be invoked after the Transport has + * created, but before the Transport is used. The callback can + * use this opportunity to set additional type-specific + * configuration on the Transport instance. + * @return {@code this} + */ + public FetchCommand setTransportConfigCallback( + TransportConfigCallback transportConfigCallback) { + checkCallable(); + this.transportConfigCallback = transportConfigCallback; + return this; + } } diff --git a/org.eclipse.jgit/src/org/eclipse/jgit/api/PullCommand.java b/org.eclipse.jgit/src/org/eclipse/jgit/api/PullCommand.java index 25dd52822..3e42da567 100644 --- a/org.eclipse.jgit/src/org/eclipse/jgit/api/PullCommand.java +++ b/org.eclipse.jgit/src/org/eclipse/jgit/api/PullCommand.java @@ -88,6 +88,8 @@ public class PullCommand extends GitCommand { private CredentialsProvider credentialsProvider; + private TransportConfigCallback transportConfigCallback; + /** * @param repo */ @@ -127,6 +129,21 @@ public PullCommand setCredentialsProvider( return this; } + /** + * @param transportConfigCallback + * if set, the callback will be invoked after the Transport has + * created, but before the Transport is used. The callback can + * use this opportunity to set additional type-specific + * configuration on the Transport instance. + * @return {@code this} + */ + public PullCommand setTransportConfigCallback( + TransportConfigCallback transportConfigCallback) { + checkCallable(); + this.transportConfigCallback = transportConfigCallback; + return this; + } + /** * Executes the {@code Pull} command with all the options and parameters * collected by the setter methods (e.g. @@ -214,6 +231,7 @@ public PullResult call() throws WrongRepositoryStateException, fetch.setProgressMonitor(monitor); fetch.setTimeout(this.timeout); fetch.setCredentialsProvider(credentialsProvider); + fetch.setTransportConfigCallback(transportConfigCallback); fetchRes = fetch.call(); } else { diff --git a/org.eclipse.jgit/src/org/eclipse/jgit/api/PushCommand.java b/org.eclipse.jgit/src/org/eclipse/jgit/api/PushCommand.java index f843a0244..a89e131ba 100644 --- a/org.eclipse.jgit/src/org/eclipse/jgit/api/PushCommand.java +++ b/org.eclipse.jgit/src/org/eclipse/jgit/api/PushCommand.java @@ -95,6 +95,8 @@ public class PushCommand extends GitCommand> { private CredentialsProvider credentialsProvider; + private TransportConfigCallback transportConfigCallback; + /** * @param repo */ @@ -151,6 +153,8 @@ public Iterable call() throws JGitInternalException, transport.setDryRun(dryRun); if (credentialsProvider != null) transport.setCredentialsProvider(credentialsProvider); + if (transportConfigCallback != null) + transportConfigCallback.configure(transport); final Collection toPush = transport .findRemoteRefUpdatesFor(refSpecs); @@ -431,4 +435,19 @@ public PushCommand setCredentialsProvider( this.credentialsProvider = credentialsProvider; return this; } + + /** + * @param transportConfigCallback + * if set, the callback will be invoked after the Transport has + * created, but before the Transport is used. The callback can + * use this opportunity to set additional type-specific + * configuration on the Transport instance. + * @return {@code this} + */ + public PushCommand setTransportConfigCallback( + TransportConfigCallback transportConfigCallback) { + checkCallable(); + this.transportConfigCallback = transportConfigCallback; + return this; + } } diff --git a/org.eclipse.jgit/src/org/eclipse/jgit/api/TransportConfigCallback.java b/org.eclipse.jgit/src/org/eclipse/jgit/api/TransportConfigCallback.java new file mode 100644 index 000000000..4faadbadd --- /dev/null +++ b/org.eclipse.jgit/src/org/eclipse/jgit/api/TransportConfigCallback.java @@ -0,0 +1,70 @@ +/* + * Copyright (C) 2011, Roberto Tyley + * and other copyright owners as documented in the project's IP log. + * + * This program and the accompanying materials are made available + * under the terms of the Eclipse Distribution License v1.0 which + * accompanies this distribution, is reproduced below, and is + * available at http://www.eclipse.org/org/documents/edl-v10.php + * + * All rights reserved. + * + * Redistribution and use in source and binary forms, with or + * without modification, are permitted provided that the following + * conditions are met: + * + * - Redistributions of source code must retain the above copyright + * notice, this list of conditions and the following disclaimer. + * + * - Redistributions in binary form must reproduce the above + * copyright notice, this list of conditions and the following + * disclaimer in the documentation and/or other materials provided + * with the distribution. + * + * - Neither the name of the Eclipse Foundation, Inc. nor the + * names of its contributors may be used to endorse or promote + * products derived from this software without specific prior + * written permission. + * + * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND + * CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, + * INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES + * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE + * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR + * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, + * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT + * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; + * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER + * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, + * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) + * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF + * ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. + */ + +package org.eclipse.jgit.api; + +import org.eclipse.jgit.transport.Transport; + +/** + * Receives a callback allowing type-specific configuration to be set + * on the Transport instance after it's been created. + *

+ * This allows consumers of the JGit command API to perform custom + * configuration that would be difficult anticipate and expose on the + * API command builders. + *

+ * For instance, if a client needs to replace the SshSessionFactorys + * on any SSHTransport used (eg to control available SSH identities), + * they can set the TransportConfigCallback on the JGit API command - + * once the transport has been created by the command, the callback + * will be invoked and passed the transport instance, which the + * client can then inspect and configure as necessary. + */ +public interface TransportConfigCallback { + + /** + * Add any additional transport-specific configuration required. + * @param transport + */ + public void configure(Transport transport); +}