Package org.jenkinsci.plugins.managedscripts

Class PowerShellBuildStep

java.lang.Object

hudson.tasks.BuildStepCompatibilityLayer

hudson.tasks.Builder

hudson.tasks.CommandInterpreter

org.jenkinsci.plugins.managedscripts.PowerShellBuildStep

All Implemented Interfaces:

ExtensionPoint, Describable<Builder>, BuildStep, EnvVarsFilterableBuilder

public class PowerShellBuildStep
extends CommandInterpreter

A project that uses this builder can choose a build step from a list of predefined powershell files that are used as command line scripts.

Author:

Arnaud Tamaillon (Greybird)

See Also:

• BatchFile

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	PowerShellBuildStep.ArgValue
static final class	PowerShellBuildStep.DescriptorImpl	Descriptor for PowerShellBuildStep.

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
PowerShellBuildStep(String buildStepId, boolean defineArgs, PowerShellBuildStep.ArgValue[] buildStepArgs)	The constructor used at form submission
PowerShellBuildStep(String buildStepId, String[] buildStepArgs)	The constructor

Method Summary

Modifier and Type	Method	Description
String[]	buildCommandLine(FilePath script)
String[]	getBuildStepArgs()
String	getBuildStepId()
protected String	getContents()
PowerShellBuildStep.DescriptorImpl	getDescriptor()
protected String	getFileExtension()

Methods inherited from class hudson.tasks.CommandInterpreter

buildEnvVarsFilterRules, createScriptFile, getCommand, getConfiguredLocalRules, isErrorlevelForUnstableBuild, 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

PowerShellBuildStep

@DataBoundConstructor
public PowerShellBuildStep(String buildStepId,
 boolean defineArgs,
 PowerShellBuildStep.ArgValue[] buildStepArgs)

The constructor used at form submission

Parameters:

buildStepId - the Id of the config file

defineArgs - required because of html form submission, which also sends hidden values

buildStepArgs - arg values

PowerShellBuildStep

public PowerShellBuildStep(String buildStepId,
 String[] buildStepArgs)

The constructor

Parameters:

buildStepId - the Id of the config file

buildStepArgs - list of arguments specified as buildStepargs

Method Details

getBuildStepId

public String getBuildStepId()

getBuildStepArgs

public String[] getBuildStepArgs()

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

getDescriptor

public PowerShellBuildStep.DescriptorImpl getDescriptor()

Specified by:

getDescriptor in interface Describable<Builder>

Overrides:

getDescriptor in class Builder