net.praqma.jenkins

Class FirstRecorder

java.lang.Object

hudson.tasks.BuildStepCompatibilityLayer

hudson.tasks.Publisher

hudson.tasks.Recorder

net.praqma.jenkins.FirstRecorder

All Implemented Interfaces:

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

public class FirstRecorder
extends hudson.tasks.Recorder

This is a Recorder, which is a Publisher. Publisher are BuildSteps performed in the post build phase. They are designed for reporting. The build phase usually involves building or compiling, and maybe some rudimentary smoke test of your software. Then in the post build phase you're more likely to perform static analysis of your source code, check for coverage and maybe compiler warnings. Our example demonstrates in a very simple way how the post build step can be used to set the overall result of a given build. Our example recorder requires the user to enter a string, that must be contained as a part build steps in order to be considered stable.

Author:

Praqma

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	FirstRecorder.DescriptorImpl Required class with a concrete implementation of the descriptor.

Nested classes/interfaces inherited from class hudson.tasks.Publisher

hudson.tasks.Publisher.DescriptorExtensionListImpl

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

BUILDERS, PUBLISHERS

Constructor Summary

Constructors

Constructor and Description
FirstRecorder() Required constructor.

Method Summary

Methods

Modifier and Type	Method and Description
hudson.model.Action	getProjectAction(hudson.model.AbstractProject<?,?> project) This method returns a project action you wish to have displayed on the front page
hudson.tasks.BuildStepMonitor	getRequiredMonitorService()
boolean	perform(hudson.model.Build<?,?> build, hudson.Launcher launcher, hudson.model.BuildListener listener) Performs the required operations for this build step.

Methods inherited from class hudson.tasks.Recorder

getDescriptor

Methods inherited from class hudson.tasks.Publisher

all, getProjectAction, needsToRunAfterFinalized, prebuild

Methods inherited from class hudson.tasks.BuildStepCompatibilityLayer

getProjectActions, perform, prebuild

Methods inherited from class java.lang.Object

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

Constructor Detail

FirstRecorder

@DataBoundConstructor
public FirstRecorder()

Required constructor. Our Recorder, which extends Publisher, which implements Describable must have specified a DataBoundConstuctor. The DataBoundConstructor is invoked whenever the job cofiguration is saved, and is used to bind form input variables to constructor parameters.

Method Detail

perform

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

Performs the required operations for this build step. The method should generally return true. If some critical error arises such as not being able to open a required file, it is much better to abort the pipeline by throwing an AbortException. This very simple reference implementation contains code that checks if the action contains items with the text, you specify when configuring the FirstRecorder project.

Overrides:

perform in class hudson.tasks.BuildStepCompatibilityLayer

Parameters:

build -

launcher -

listener -

Returns:

a boolean value indicating proper execution, if true, the next item in build step is picked up for execution

Throws:

InterruptedException

IOException

getRequiredMonitorService

public hudson.tasks.BuildStepMonitor getRequiredMonitorService()

getProjectAction

public hudson.model.Action getProjectAction(hudson.model.AbstractProject<?,?> project)

This method returns a project action you wish to have displayed on the front page

Specified by:

getProjectAction in interface hudson.tasks.BuildStep

Overrides:

getProjectAction in class hudson.tasks.BuildStepCompatibilityLayer

Parameters:

project -

Returns:

the project action to be displayed