net.praqma.jenkins

Class FirstBuilder

java.lang.Object

hudson.tasks.BuildStepCompatibilityLayer

hudson.tasks.Builder

net.praqma.jenkins.FirstBuilder

All Implemented Interfaces:

hudson.ExtensionPoint, hudson.model.Describable<hudson.tasks.Builder>, hudson.tasks.BuildStep

public class FirstBuilder
extends hudson.tasks.Builder

The Builder for our project. We extend from Builder which implements BuildStep, which has a perform method we will use. Additionally all BuildSteps have a prebuild method to override, which runs before the build step. The main purpose of this example builder is to extract environment information from the executing slaves, and make this data available for the view we wish to present it in. During execution we re-use already added actions, and add the discovered data to the already existing build action.

Author:

Praqma

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	FirstBuilder.FirstBuilderImpl Required static constructor.

Nested classes/interfaces inherited from interface hudson.ExtensionPoint

hudson.ExtensionPoint.LegacyInstancesAreScopedToHudson

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

hudson.tasks.BuildStep.PublisherList

Field Summary

Fields

Modifier and Type	Field and Description
boolean	runOnSlaves

Fields inherited from interface hudson.tasks.BuildStep

BUILDERS, PUBLISHERS

Constructor Summary

Constructors

Constructor and Description
FirstBuilder(boolean runOnSlaves)

Method Summary

Methods

Modifier and Type	Method and Description
boolean	perform(hudson.model.AbstractBuild<?,?> build, hudson.Launcher launcher, hudson.model.BuildListener listener) Override this method to get your operation done in the build step.

Methods inherited from class hudson.tasks.Builder

all, getDescriptor, 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 Detail

runOnSlaves

public final boolean runOnSlaves

Constructor Detail

FirstBuilder

@DataBoundConstructor
public FirstBuilder(boolean runOnSlaves)

Method Detail

perform

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

Override this method to get your operation done in the build step. When invoked, it is up to you, as a plugin developer to add your actions, and/or perform the operations required by your plugin in this build step. Equally, it is up to the developer to make the code run on the slave(master or an actual remote). This must be done given the builds workspace, as in build.getWorkspace(). The workspace is the link to the slave, as it is the representation of the remotes file system. Build steps as you add them to your job configuration are executed sequentially, and the return value for your builder should indicate whether to execute the next build step in the list.

Specified by:

perform in interface hudson.tasks.BuildStep

Overrides:

perform in class hudson.tasks.BuildStepCompatibilityLayer

Parameters:

build - the current build

launcher - the current launcher

listener - the build listener

Returns:

a boolean indicating wheather to proceed with the next buildstep

Throws:

InterruptedException

IOException