Class TransportCommand<C extends GitCommand,T>

java.lang.Object
org.eclipse.jgit.api.GitCommand<T>
org.eclipse.jgit.api.TransportCommand<C,T>
Type Parameters:
C -
T -
All Implemented Interfaces:
Callable<T>
Direct Known Subclasses:
CloneCommand, FetchCommand, LsRemoteCommand, PullCommand, PushCommand, SubmoduleAddCommand, SubmoduleUpdateCommand

public abstract class TransportCommand<C extends GitCommand,T> extends GitCommand<T>
Base class for commands that use a Transport during execution.

This class provides standard configuration of a transport for options such as a CredentialsProvider, a timeout, and a TransportConfigCallback.

  • Field Details

    • credentialsProvider

      protected CredentialsProvider credentialsProvider
      Configured credentials provider
    • timeout

      protected int timeout
      Configured transport timeout
    • transportConfigCallback

      protected TransportConfigCallback transportConfigCallback
      Configured callback for transport configuration
  • Constructor Details

    • TransportCommand

      protected TransportCommand(Repository repo)

      Constructor for TransportCommand.

      Parameters:
      repo - a Repository object.
  • Method Details

    • setCredentialsProvider

      public C setCredentialsProvider(CredentialsProvider credentialsProvider)
      Set the credentialsProvider.
      Parameters:
      credentialsProvider - the CredentialsProvider to use
      Returns:
      this
    • setTimeout

      public C setTimeout(int timeout)
      Set timeout.
      Parameters:
      timeout - the timeout (in seconds) used for the transport step
      Returns:
      this
    • setTransportConfigCallback

      public C setTransportConfigCallback(TransportConfigCallback transportConfigCallback)
      Set the TransportConfigCallback.
      Parameters:
      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.
      Returns:
      this
    • self

      protected final C self()
      Return this command cast to C
      Returns:
      this cast to C
    • configure

      protected C configure(Transport transport)
      Configure transport with credentials provider, timeout, and config callback
      Parameters:
      transport - a Transport object.
      Returns:
      this
    • configure

      protected C configure(TransportCommand childCommand)
      Configure a child command with the current configuration set in this command
      Parameters:
      childCommand - a TransportCommand object.
      Returns:
      this