Package hudson.plugins.xshell

Class XShellBuilder

java.lang.Object

hudson.tasks.BuildStepCompatibilityLayer

hudson.tasks.Builder

hudson.plugins.xshell.XShellBuilder

All Implemented Interfaces:

ExtensionPoint, Describable<Builder>, BuildStep

public final class XShellBuilder
extends Builder

XShell Builder Plugin.

Author:

Marco Ambu

Nested Class Summary

Nested classes/interfaces inherited from interface hudson.tasks.BuildStep

BuildStep.PublisherList

Nested classes/interfaces inherited from interface hudson.ExtensionPoint

ExtensionPoint.LegacyInstancesAreScopedToHudson

Field Summary

Fields

Modifier and Type	Field	Description
static final XShellDescriptor	DESCRIPTOR
static final String	UNIX_SEP
static final String	WINDOWS_SEP

Fields inherited from interface hudson.tasks.BuildStep

BUILDERS, PUBLISHERS

Constructor Summary

Constructors

Constructor	Description
XShellBuilder(String commandLine, String workingDir, Boolean executeFromWorkingDir, String regexToKill, String timeAllocated)

Method Summary

Modifier and Type	Method	Description
static String	convertEnvVarsToUnix(String cmdLine)	Convert Windows-style environment variables to UNIX-style.
static String	convertEnvVarsToWindows(String cmdLine)	Convert UNIX-style environment variables to Windows-style.
static String	convertSeparator(String cmdLine, String newSeparator)
String	getCommandLine()
Descriptor<Builder>	getDescriptor()
Boolean	getExecuteFromWorkingDir()
String	getRegexToKill()
String	getTimeAllocated()
String	getWorkingDir()
boolean	perform(AbstractBuild<?,?> build, Launcher launcher, BuildListener listener)

Methods inherited from class hudson.tasks.Builder

all, getRequiredMonitorService, prebuild

Methods inherited from class hudson.tasks.BuildStepCompatibilityLayer

getProjectAction, getProjectAction, getProjectActions, perform, prebuild

Methods inherited from class java.lang.Object

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

Field Details

UNIX_SEP

public static final String UNIX_SEP

See Also:

• Constant Field Values

WINDOWS_SEP

public static final String WINDOWS_SEP

See Also:

• Constant Field Values

DESCRIPTOR

@Extension
public static final XShellDescriptor DESCRIPTOR

Constructor Details

XShellBuilder

@DataBoundConstructor
public XShellBuilder(String commandLine,
 String workingDir,
 Boolean executeFromWorkingDir,
 String regexToKill,
 String timeAllocated)

Method Details

getCommandLine

public String getCommandLine()

getWorkingDir

public String getWorkingDir()

getExecuteFromWorkingDir

public Boolean getExecuteFromWorkingDir()

getRegexToKill

public String getRegexToKill()

getTimeAllocated

public String getTimeAllocated()

getDescriptor

public Descriptor<Builder> getDescriptor()

Specified by:

getDescriptor in interface Describable<Builder>

Overrides:

getDescriptor in class Builder

perform

public boolean perform(AbstractBuild<?,?> build,
 Launcher launcher,
 BuildListener listener)
                throws InterruptedException,
IOException

Specified by:

perform in interface BuildStep

Overrides:

perform in class BuildStepCompatibilityLayer

Throws:

InterruptedException

IOException

convertSeparator

public static String convertSeparator(String cmdLine,
 String newSeparator)

convertEnvVarsToUnix

public static String convertEnvVarsToUnix(String cmdLine)

Convert Windows-style environment variables to UNIX-style. E.g. "script --opt=%OPT%" to "script --opt=$OPT"

Parameters:

cmdLine - The command line with Windows-style env vars to convert.

Returns:

The command line with UNIX-style env vars.

convertEnvVarsToWindows

public static String convertEnvVarsToWindows(String cmdLine)

Convert UNIX-style environment variables to Windows-style. E.g. "script --opt=$OPT" to "script --opt=%OPT%"

Parameters:

cmdLine - The command line with Windows-style env vars to convert.

Returns:

The command line with UNIX-style env vars.