hudson.plugins.mercurial

Class HgExe

java.lang.Object

hudson.plugins.mercurial.HgExe

All Implemented Interfaces:

AutoCloseable

public class HgExe
extends Object
implements AutoCloseable

Encapsulates the invocation of the Mercurial command.

Field Summary

Fields

Modifier and Type	Field and Description
Launcher	launcher
TaskListener	listener
Node	node

Constructor Summary

Constructors

Constructor and Description
HgExe(MercurialInstallation inst, com.cloudbees.plugins.credentials.common.StandardUsernameCredentials credentials, Launcher launcher, Node node, TaskListener listener, EnvVars env) Creates a new launcher.
HgExe(MercurialSCM scm, Launcher launcher, AbstractBuild build, TaskListener listener) Deprecated.
HgExe(MercurialSCM scm, Launcher launcher, Node node, TaskListener listener, EnvVars env) Deprecated.

Method Summary

Modifier and Type	Method and Description
String	branch(FilePath repository, String rev) Gets the branch name of given revision number or of the current workspace.
Launcher.ProcStarter	bundle(Collection<String> bases, String file)
Launcher.ProcStarter	bundleAll(String file)
Launcher.ProcStarter	cleanAll()
Launcher.ProcStarter	clone(String... args) Deprecated. Unused, since we need more control over the argument list in order to support credentials.
void	close()
String	config(FilePath repository, String name) Gets the current value of a specified config item.
Set<String>	heads(FilePath repo, boolean useTimeout) Obtains the heads of the repository.
Launcher.ProcStarter	init(FilePath path)
static int	joinWithPossibleTimeout(Launcher.ProcStarter proc, boolean useTimeout, TaskListener listener) For use with launch(hudson.util.ArgumentListBuilder) (or similar) when running commands not inside a build and which therefore might not be easily killed.
Launcher.ProcStarter	launch(ArgumentListBuilder args) Prepares to start the Mercurial command.
String	popen(FilePath repository, TaskListener listener, boolean useTimeout, ArgumentListBuilder args) Runs the command and captures the output.
Launcher.ProcStarter	pull() Deprecated. Unused, since we need more control over the argument list in order to support credentials.
Launcher.ProcStarter	run(ArgumentListBuilder args) Deprecated. Use seed(boolean) and launch(hudson.util.ArgumentListBuilder) instead.
Launcher.ProcStarter	run(String... args) Runs arbitrary command.
ArgumentListBuilder	seed(boolean allowDebug) Starts creating an argument list.
String	tip(FilePath repository, String rev) Gets the revision ID or node of the tip of the workspace.
String	tipNumber(FilePath repository, String rev) Gets the revision number of the tip of the workspace.
Launcher.ProcStarter	unbundle(String bundleFile)
String	version() Gets the version of used Mercurial installation.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

launcher

public final Launcher launcher

node

public final Node node

listener

public final TaskListener listener

Constructor Detail

HgExe

@Deprecated
public HgExe(MercurialSCM scm,
                         Launcher launcher,
                         AbstractBuild build,
                         TaskListener listener)
                  throws IOException,
                         InterruptedException

Deprecated.

Throws:

IOException

InterruptedException

HgExe

@Deprecated
public HgExe(MercurialSCM scm,
                         Launcher launcher,
                         Node node,
                         TaskListener listener,
                         EnvVars env)
                  throws IOException,
                         InterruptedException

Deprecated.

Throws:

IOException

InterruptedException

HgExe

public HgExe(@CheckForNull
             MercurialInstallation inst,
             @CheckForNull
             com.cloudbees.plugins.credentials.common.StandardUsernameCredentials credentials,
             Launcher launcher,
             Node node,
             TaskListener listener,
             EnvVars env)
      throws IOException,
             InterruptedException

Creates a new launcher. You must call close() in a finally block or use try-with-resources.

Parameters:

inst - a particular Mercurial installation to use (optional)

credentials - username/password or SSH private key credentials (optional)

launcher - a way to run commands

node - the machine to run commands on

listener - a place to print errors

env - environment variables to pass to the command

Throws:

IOException - for various reasons

InterruptedException - for various reasons

Method Detail

close

public void close()
           throws IOException,
                  InterruptedException

Specified by:

close in interface AutoCloseable

Throws:

IOException

InterruptedException

launch

public Launcher.ProcStarter launch(ArgumentListBuilder args)

Prepares to start the Mercurial command.

Parameters:

args - some arguments as created by seed(boolean) and then appended to

Returns:

a process starter with the correct launcher, arguments, listener, and environment variables configured

joinWithPossibleTimeout

public static int joinWithPossibleTimeout(Launcher.ProcStarter proc,
                                          boolean useTimeout,
                                          TaskListener listener)
                                   throws IOException,
                                          InterruptedException

For use with launch(hudson.util.ArgumentListBuilder) (or similar) when running commands not inside a build and which therefore might not be easily killed.

Throws:

IOException

InterruptedException

seed

public ArgumentListBuilder seed(boolean allowDebug)

Starts creating an argument list. Initially adds only the Mercurial executable itself, possibly with a debug flag.

Parameters:

allowDebug - whether to add a debug flag if the configured installation requested it

Returns:

a builder

pull

@Deprecated
public Launcher.ProcStarter pull()

Deprecated. Unused, since we need more control over the argument list in order to support credentials.

clone

@Deprecated
public Launcher.ProcStarter clone(String... args)

Deprecated. Unused, since we need more control over the argument list in order to support credentials.

bundleAll

public Launcher.ProcStarter bundleAll(String file)

bundle

public Launcher.ProcStarter bundle(Collection<String> bases,
                                   String file)

init

public Launcher.ProcStarter init(FilePath path)

unbundle

public Launcher.ProcStarter unbundle(String bundleFile)

cleanAll

public Launcher.ProcStarter cleanAll()

run

public Launcher.ProcStarter run(String... args)

Runs arbitrary command.

run

@Deprecated
public Launcher.ProcStarter run(ArgumentListBuilder args)

Deprecated. Use seed(boolean) and launch(hudson.util.ArgumentListBuilder) instead.

heads

public Set<String> heads(FilePath repo,
                         boolean useTimeout)
                  throws IOException,
                         InterruptedException

Obtains the heads of the repository.

Throws:

IOException

InterruptedException

tip

@CheckForNull
public String tip(FilePath repository,
                                @Nullable
                                String rev)
                         throws IOException,
                                InterruptedException

Gets the revision ID or node of the tip of the workspace. A 40-character hexadecimal string

Parameters:

rev - the revision to identify; defaults to ., i.e. working copy

Throws:

IOException

InterruptedException

tipNumber

@CheckForNull
public String tipNumber(FilePath repository,
                                      @Nullable
                                      String rev)
                               throws IOException,
                                      InterruptedException

Gets the revision number of the tip of the workspace.

Parameters:

rev - the revision to identify; defaults to ., i.e. working copy

Throws:

IOException

InterruptedException

branch

@CheckForNull
public String branch(FilePath repository,
                                   @CheckForNull
                                   String rev)
                            throws IOException,
                                   InterruptedException

Gets the branch name of given revision number or of the current workspace.

Parameters:

rev - the revision to identify; defaults to current working copy

Throws:

IOException

InterruptedException

version

@CheckForNull
public String version()
                             throws IOException,
                                    InterruptedException

Gets the version of used Mercurial installation.

Throws:

IOException

InterruptedException

config

public String config(FilePath repository,
                     String name)
              throws IOException,
                     InterruptedException

Gets the current value of a specified config item.

Throws:

IOException

InterruptedException

popen

@NonNull
public String popen(FilePath repository,
                             TaskListener listener,
                             boolean useTimeout,
                             ArgumentListBuilder args)
                      throws IOException,
                             InterruptedException

Runs the command and captures the output.

Throws:

IOException

InterruptedException