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:

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

public class ReviewBoardNotifier
extends hudson.tasks.Notifier

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

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

Method Summary

Modifier and Type	Method and Description
hudson.tasks.BuildStepMonitor	getRequiredMonitorService() Declares the synchronization required for this step, for which we require none.
boolean	perform(hudson.model.AbstractBuild<?,?> build, hudson.Launcher launcher, hudson.model.BuildListener 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, prebuild

Methods inherited from class java.lang.Object

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

Constructor Detail

ReviewBoardNotifier

@DataBoundConstructor
public ReviewBoardNotifier()

Constructs the notifier.

Method Detail

perform

public boolean perform(hudson.model.AbstractBuild<?,?> build,
                       hudson.Launcher launcher,
                       hudson.model.BuildListener listener)
                throws 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 hudson.tasks.BuildStep

Overrides:

perform in class hudson.tasks.BuildStepCompatibilityLayer

Parameters:

build - The active Jenkins build

launcher - Process launcher

listener - Logger

Returns:

True if build can continue

Throws:

IOException

updateStatusUpdate

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

Throws:

IOException

ReviewBoardException

getRequiredMonitorService

public hudson.tasks.BuildStepMonitor getRequiredMonitorService()

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

Returns:

BuildStepMonitor.NONE