Package org.jenkinsci.plugins.managedscripts

Class ScriptBuildStep

java.lang.Object

hudson.tasks.BuildStepCompatibilityLayer

hudson.tasks.Builder

org.jenkinsci.plugins.managedscripts.ScriptBuildStep

All Implemented Interfaces:

ExtensionPoint, Describable<Builder>, BuildStep

public class ScriptBuildStep
extends Builder

LibraryBuildStep Builder.

A project that uses this builder can choose a build step from a list of predefined config files that are uses as command line scripts. The hash-bang sequence at the beginning of each file is used to determine the interpreter.

Author:

Norman Baumann, Dominik Bartholdi (imod)

Nested Class Summary

Nested Classes

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

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 interface hudson.tasks.BuildStep

BUILDERS, PUBLISHERS

Constructor Summary

Constructors

Constructor	Description
ScriptBuildStep(String buildStepId, boolean defineArgs, ScriptBuildStep.ArgValue[] buildStepArgs, boolean tokenized)	The constructor used at form submission
ScriptBuildStep(String buildStepId, String[] buildStepArgs)

Method Summary

Modifier and Type	Method	Description
String[]	getBuildStepArgs()
String	getBuildStepId()
ScriptBuildStep.DescriptorImpl	getDescriptor()
boolean	isTokenized()
boolean	perform(AbstractBuild<?,?> build, Launcher launcher, BuildListener listener)	Perform the build step on the execution host.

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

ScriptBuildStep

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

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

tokenized -

ScriptBuildStep

public ScriptBuildStep(String buildStepId,
 String[] buildStepArgs)

Method Details

getBuildStepId

public String getBuildStepId()

getBuildStepArgs

public String[] getBuildStepArgs()

isTokenized

public boolean isTokenized()

perform

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

Perform the build step on the execution host.

Generates a temporary file and copies the content of the predefined config file (by using the buildStepId) into it. It then copies this file into the workspace directory of the execution host and executes it.

Specified by:

perform in interface BuildStep

Overrides:

perform in class BuildStepCompatibilityLayer

getDescriptor

public ScriptBuildStep.DescriptorImpl getDescriptor()

Specified by:

getDescriptor in interface Describable<Builder>

Overrides:

getDescriptor in class Builder