org.reviewboard.rbjenkins.steps

Class ReviewBoardNotifier

java.lang.Object

hudson.tasks.BuildStepCompatibilityLayer

hudson.tasks.Publisher

hudson.tasks.Notifier

org.reviewboard.rbjenkins.steps.ReviewBoardNotifier

All Implemented Interfaces:

ExtensionPoint, Describable<Publisher>, BuildStep, SimpleBuildStep

public class ReviewBoardNotifier
extends Notifier
implements SimpleBuildStep

Creates a post-build step in Jenkins for notifying Review Board of the status of the triggered build.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ReviewBoardNotifier.DescriptorImpl Provides the description of the notification build step and validation functions for fields in its configuration form.

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

Publisher.DescriptorExtensionListImpl

Nested classes/interfaces inherited from interface jenkins.tasks.SimpleBuildStep

SimpleBuildStep.LastBuildAction, SimpleBuildStep.LastBuildActionFactory

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 and Description
ReviewBoardNotifier() Constructs the notifier.

Method Summary

Modifier and Type	Method and Description
BuildStepMonitor	getRequiredMonitorService() Declares the synchronization required for this step, for which we require none.
void	perform(Run<?,?> run, FilePath filePath, Launcher launcher, TaskListener listener) This function will be called as part of the post-build step.
void	updateStatusUpdate(ReviewRequest reviewRequest, ReviewRequest.StatusUpdateState state, String description)

Methods inherited from class hudson.tasks.Notifier

getDescriptor

Methods inherited from class hudson.tasks.Publisher

all, getProjectAction, needsToRunAfterFinalized, prebuild

Methods inherited from class hudson.tasks.BuildStepCompatibilityLayer

getProjectAction, getProjectActions, perform, perform, prebuild

Methods inherited from class java.lang.Object

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

Methods inherited from interface jenkins.tasks.SimpleBuildStep

perform, perform, requiresWorkspace

Methods inherited from interface hudson.tasks.BuildStep

getProjectAction, getProjectActions, perform, prebuild

Constructor Detail

ReviewBoardNotifier

@DataBoundConstructor
public ReviewBoardNotifier()

Constructs the notifier.

Method Detail

perform

public void perform(@Nonnull
                    Run<?,?> run,
                    @Nonnull
                    FilePath filePath,
                    @Nonnull
                    Launcher launcher,
                    @Nonnull
                    TaskListener listener)
             throws InterruptedException,
                    IOException

This function will be called as part of the post-build step. It will notify Review Board of the status of the build and update the status update resource.

Specified by:

perform in interface SimpleBuildStep

Parameters:

run - The active Jenkins build

filePath - The path to the build file

launcher - Process launcher

listener - Logger

Throws:

InterruptedException

IOException

updateStatusUpdate

public void updateStatusUpdate(ReviewRequest reviewRequest,
                               ReviewRequest.StatusUpdateState state,
                               String description)
                        throws IOException,
                               ReviewBoardException

Throws:

IOException

ReviewBoardException

getRequiredMonitorService

public BuildStepMonitor getRequiredMonitorService()

Declares the synchronization required for this step, for which we require none.

Specified by:

getRequiredMonitorService in interface BuildStep

Returns:

BuildStepMonitor.NONE