hudson.plugins.mercurial

Class HgExe

java.lang.Object

hudson.plugins.mercurial.HgExe

public class HgExe
extends Object

Encapsulates the invocation of "hg".

This reduces the amount of code in the main logic. TODO: perhaps a subtype 'Repository' with a repository location field would be good.

Author:

Kohsuke Kawaguchi

Field Summary

Fields

Modifier and Type	Field and Description
hudson.Launcher	launcher
hudson.model.TaskListener	listener
hudson.model.Node	node

Constructor Summary

Constructors

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

Method Summary

Methods

Modifier and Type	Method and Description
hudson.Launcher.ProcStarter	bundle(Collection<String> bases, String file)
hudson.Launcher.ProcStarter	bundleAll(String file)
hudson.Launcher.ProcStarter	cleanAll()
hudson.Launcher.ProcStarter	clone(String... args) Deprecated.
String	config(hudson.FilePath repository, String name) Gets the current value of a specified config item.
Set<String>	heads(hudson.FilePath repo, boolean useTimeout) Obtains the heads of the repository.
hudson.Launcher.ProcStarter	init(hudson.FilePath path)
static int	joinWithPossibleTimeout(hudson.Launcher.ProcStarter proc, boolean useTimeout, hudson.model.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.
hudson.Launcher.ProcStarter	launch(hudson.util.ArgumentListBuilder args) Prepares to start the Mercurial command.
String	popen(hudson.FilePath repository, hudson.model.TaskListener listener, boolean useTimeout, hudson.util.ArgumentListBuilder args) Runs the command and captures the output.
hudson.Launcher.ProcStarter	pull() Deprecated.
hudson.Launcher.ProcStarter	run(hudson.util.ArgumentListBuilder args) Deprecated. Use seed(boolean) and launch(hudson.util.ArgumentListBuilder) instead.
hudson.Launcher.ProcStarter	run(String... args) Runs arbitrary command.
hudson.util.ArgumentListBuilder	seed(boolean allowDebug) Starts creating an argument list.
String	tip(hudson.FilePath repository, String rev) Gets the revision ID or node of the tip of the workspace.
String	tipNumber(hudson.FilePath repository, String rev) Gets the revision number of the tip of the workspace.
hudson.Launcher.ProcStarter	unbundle(String bundleFile)

Methods inherited from class java.lang.Object

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

Field Detail

launcher

public final hudson.Launcher launcher

node

public final hudson.model.Node node

listener

public final hudson.model.TaskListener listener

Constructor Detail

HgExe

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

Deprecated.

Throws:

IOException

InterruptedException

HgExe

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

Deprecated.

Throws:

IOException

InterruptedException

HgExe

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

Throws:

IOException

InterruptedException

Method Detail

launch

public hudson.Launcher.ProcStarter launch(hudson.util.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(hudson.Launcher.ProcStarter proc,
                          boolean useTimeout,
                          hudson.model.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 hudson.util.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 hudson.Launcher.ProcStarter pull()

Deprecated.

clone

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

Deprecated.

bundleAll

public hudson.Launcher.ProcStarter bundleAll(String file)

bundle

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

init

public hudson.Launcher.ProcStarter init(hudson.FilePath path)

unbundle

public hudson.Launcher.ProcStarter unbundle(String bundleFile)

cleanAll

public hudson.Launcher.ProcStarter cleanAll()

run

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

Runs arbitrary command.

run

@Deprecated
public hudson.Launcher.ProcStarter run(hudson.util.ArgumentListBuilder args)

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

heads

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

Obtains the heads of the repository.

Throws:

IOException

InterruptedException

tip

@CheckForNull
public String tip(hudson.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(hudson.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

config

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

Gets the current value of a specified config item.

Throws:

IOException

InterruptedException

popen

public String popen(hudson.FilePath repository,
           hudson.model.TaskListener listener,
           boolean useTimeout,
           hudson.util.ArgumentListBuilder args)
             throws IOException,
                    InterruptedException

Runs the command and captures the output.

Throws:

IOException

InterruptedException