Package hudson.tasks

Class Shell

java.lang.Object

hudson.tasks.BuildStepCompatibilityLayer

hudson.tasks.Builder

hudson.tasks.CommandInterpreter

hudson.tasks.Shell

All Implemented Interfaces:

ExtensionPoint, Describable<Builder>, BuildStep, EnvVarsFilterableBuilder

public class Shell
extends CommandInterpreter

Executes a series of commands by using a shell.

Author:

Kohsuke Kawaguchi

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	Shell.DescriptorImpl

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

BuildStep.PublisherList

Nested classes/interfaces inherited from interface hudson.ExtensionPoint

ExtensionPoint.LegacyInstancesAreScopedToHudson

Field Summary

Fields inherited from class hudson.tasks.CommandInterpreter

command, configuredLocalRules

Fields inherited from interface hudson.tasks.BuildStep

BUILDERS, PUBLISHERS

Constructor Summary

Constructors

Constructor	Description
Shell(String command)

Method Summary

Modifier and Type	Method	Description
String[]	buildCommandLine(FilePath script)
protected String	getContents()
Shell.DescriptorImpl	getDescriptor()	Gets the descriptor for this instance.
protected String	getFileExtension()
final Integer	getUnstableReturn()
protected boolean	isErrorlevelForUnstableBuild(int exitCode)	Determines whether a non-zero exit code from the process should change the build status to Result.UNSTABLE instead of default Result.FAILURE.
void	setConfiguredLocalRules(List<EnvVarsFilterLocalRule> configuredLocalRules)	Set local environment variable filter rules
void	setUnstableReturn(Integer unstableReturn)

Methods inherited from class hudson.tasks.CommandInterpreter

buildEnvVarsFilterRules, createScriptFile, getCommand, getConfiguredLocalRules, join, perform, perform

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

Constructor Details

Shell

@DataBoundConstructor
public Shell(String command)

Method Details

setConfiguredLocalRules

@Restricted(org.kohsuke.accmod.restrictions.Beta.class)
@DataBoundSetter
public void setConfiguredLocalRules(List<EnvVarsFilterLocalRule> configuredLocalRules)

Set local environment variable filter rules

Parameters:

configuredLocalRules - list of local environment filter rules

Since:

2.246

buildCommandLine

public String[] buildCommandLine(FilePath script)

Specified by:

buildCommandLine in class CommandInterpreter

getContents

protected String getContents()

Specified by:

getContents in class CommandInterpreter

getFileExtension

protected String getFileExtension()

Specified by:

getFileExtension in class CommandInterpreter

getUnstableReturn

@CheckForNull
public final Integer getUnstableReturn()

setUnstableReturn

@DataBoundSetter
public void setUnstableReturn(Integer unstableReturn)

isErrorlevelForUnstableBuild

protected boolean isErrorlevelForUnstableBuild(int exitCode)

Description copied from class: CommandInterpreter

Determines whether a non-zero exit code from the process should change the build status to Result.UNSTABLE instead of default Result.FAILURE. Changing to Result.UNSTABLE does not abort the build, next steps are continued.

Overrides:

isErrorlevelForUnstableBuild in class CommandInterpreter

getDescriptor

public Shell.DescriptorImpl getDescriptor()

Description copied from interface: Describable

Gets the descriptor for this instance.

Descriptor is a singleton for every concrete Describable implementation, so if a.getClass() == b.getClass() then by default a.getDescriptor() == b.getDescriptor() as well. (In rare cases a single implementation class may be used for instances with distinct descriptors.)

By default looks for a nested class (conventionally named DescriptorImpl) implementing Descriptor and marked with Extension.

Specified by:

getDescriptor in interface Describable<Builder>

Overrides:

getDescriptor in class Builder