org.eclipse.egit.core/src/org/eclipse/egit/core/op/FetchOperation.java

   1 /*******************************************************************************
   2  * Copyright (C) 2011, Mathias Kinzler <mathias.kinzler@sap.com>
   3  *
   4  * All rights reserved. This program and the accompanying materials
   5  * are made available under the terms of the Eclipse Public License 2.0
   6  * which accompanies this distribution, and is available at
   7  * https://www.eclipse.org/legal/epl-2.0/
   8  *
   9  * SPDX-License-Identifier: EPL-2.0
  10  *******************************************************************************/
  11 package org.eclipse.egit.core.op;
  12
  13 import java.lang.reflect.InvocationTargetException;
  14 import java.util.List;
  15
  16 import org.eclipse.core.runtime.IProgressMonitor;
  17 import org.eclipse.egit.core.EclipseGitProgressTransformer;
  18 import org.eclipse.egit.core.internal.CoreText;
  19 import org.eclipse.jgit.api.FetchCommand;
  20 import org.eclipse.jgit.api.Git;
  21 import org.eclipse.jgit.api.errors.JGitInternalException;
  22 import org.eclipse.jgit.lib.Repository;
  23 import org.eclipse.jgit.transport.CredentialsProvider;
  24 import org.eclipse.jgit.transport.FetchResult;
  25 import org.eclipse.jgit.transport.RefSpec;
  26 import org.eclipse.jgit.transport.RemoteConfig;
  27 import org.eclipse.jgit.transport.TagOpt;
  28 import org.eclipse.jgit.transport.URIish;
  29
  30 /**
  31  * Used to fetch from another Repository
  32  */
  33 public class FetchOperation {
  34         private final Repository repository;
  35
  36         private final RemoteConfig rc;
  37
  38         private final URIish uri;
  39
  40         private final int timeout;
  41
  42         private final List<RefSpec> specs;
  43
  44         private final boolean dryRun;
  45
  46         private FetchResult operationResult;
  47
  48         private CredentialsProvider credentialsProvider;
  49
  50         private TagOpt tagOpt;
  51
  52         /**
  53          * Constructs a FetchOperation based on URI and RefSpecs
  54          *
  55          * @param repository
  56          * @param uri
  57          * @param refSpecs
  58          * @param timeout
  59          * @param dryRun
  60          *
  61          */
  62         public FetchOperation(Repository repository, URIish uri,
  63                         List<RefSpec> refSpecs, int timeout, boolean dryRun) {
  64                 this.repository = repository;
  65                 this.timeout = timeout;
  66                 this.dryRun = dryRun;
  67                 this.uri = uri;
  68                 this.specs = refSpecs;
  69                 this.rc = null;
  70         }
  71
  72         /**
  73          * Constructs a FetchOperation based on a RemoteConfig
  74          *
  75          * @param repository
  76          * @param config
  77          * @param timeout
  78          * @param dryRun
  79          */
  80         public FetchOperation(Repository repository, RemoteConfig config,
  81                         int timeout, boolean dryRun) {
  82                 this.repository = repository;
  83                 this.timeout = timeout;
  84                 this.dryRun = dryRun;
  85                 this.uri = null;
  86                 this.specs = null;
  87                 this.rc = config;
  88         }
  89
  90         /**
  91          * @param credentialsProvider
  92          */
  93         public void setCredentialsProvider(CredentialsProvider credentialsProvider) {
  94                 this.credentialsProvider = credentialsProvider;
  95         }
  96
  97         /**
  98          * @return the operation's credentials provider
  99          */
 100         public CredentialsProvider getCredentialsProvider() {
 101                 return credentialsProvider;
 102         }
 103
 104         /**
 105          * @param tagOpt
 106          */
 107         public void setTagOpt(TagOpt tagOpt) {
 108                 this.tagOpt = tagOpt;
 109         }
 110
 111         /**
 112          * @param monitor
 113          * @throws InvocationTargetException
 114          */
 115         public void run(IProgressMonitor monitor) throws InvocationTargetException {
 116                 if (operationResult != null)
 117                         throw new IllegalStateException(CoreText.OperationAlreadyExecuted);
 118
 119                 EclipseGitProgressTransformer gitMonitor = new EclipseGitProgressTransformer(
 120                                 monitor);
 121                 try (Git git = new Git(repository)) {
 122                         FetchCommand command;
 123                         if (rc == null)
 124                                 command = git.fetch().setRemote(uri.toPrivateString())
 125                                                 .setRefSpecs(specs);
 126                         else
 127                                 command = git.fetch().setRemote(rc.getName());
 128                         command.setCredentialsProvider(credentialsProvider)
 129                                         .setTimeout(timeout).setDryRun(dryRun)
 130                                         .setProgressMonitor(gitMonitor);
 131                         if (tagOpt != null)
 132                                 command.setTagOpt(tagOpt);
 133                         try {
 134                                 operationResult = command.call();
 135                         } catch (JGitInternalException e) {
 136                                 throw new InvocationTargetException(
 137                                                 e.getCause() != null ? e.getCause() : e);
 138                         } catch (Exception e) {
 139                                 throw new InvocationTargetException(e);
 140                         }
 141                 }
 142         }
 143
 144         /**
 145          * @return the result, or <code>null</code> if the operation has not been
 146          *         executed
 147          */
 148         public FetchResult getOperationResult() {
 149                 return operationResult;
 150         }
 151 }