net.sleepymouse.jenkins.plugins.piborg.ledborg

Class LedBorgPublisher

java.lang.Object

hudson.tasks.BuildStepCompatibilityLayer

hudson.tasks.Publisher

hudson.tasks.Notifier

net.sleepymouse.jenkins.plugins.piborg.ledborg.LedBorgPublisher

All Implemented Interfaces:

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

public class LedBorgPublisher
extends hudson.tasks.Notifier
implements jenkins.tasks.SimpleBuildStep

Sample Builder.

When the user configures the project and enables this builder, Descriptor.newInstance(StaplerRequest) is invoked and a new LedBorgPublisher is created. The created instance is persisted to the project configuration XML by using XStream, so this allows you to use instance fields to remember the configuration.

When a build is performed, the perform(hudson.model.Run<?, ?>, hudson.FilePath, hudson.Launcher, hudson.model.TaskListener) method will be invoked.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	LedBorgPublisher.DescriptorImpl Add the descriptor class extension point

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

hudson.tasks.Publisher.DescriptorExtensionListImpl

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

jenkins.tasks.SimpleBuildStep.LastBuildAction, jenkins.tasks.SimpleBuildStep.LastBuildActionFactory

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

hudson.tasks.BuildStep.PublisherList

Nested classes/interfaces inherited from interface hudson.ExtensionPoint

hudson.ExtensionPoint.LegacyInstancesAreScopedToHudson

Field Summary

Fields inherited from interface hudson.tasks.BuildStep

BUILDERS, PUBLISHERS

Constructor Summary

Constructors

Constructor and Description
LedBorgPublisher(String failureState, String successState, String unstableState, String notBuiltState, String abortedState)

Method Summary

Modifier and Type	Method and Description
String	getAbortedState()
LedBorgPublisher.DescriptorImpl	getDescriptor() Get the associated descriptor object
String	getFailureState()
String	getNotBuiltState()
hudson.tasks.BuildStepMonitor	getRequiredMonitorService() Get the build step monitor.
String	getSuccessState()
String	getUnstableState()
void	perform(hudson.model.Run<?,?> build, hudson.FilePath workspace, hudson.Launcher launcher, hudson.model.TaskListener listener) Perform actions associated with the build step.

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

getProjectAction, getProjectActions, perform, prebuild

Constructor Detail

LedBorgPublisher

@DataBoundConstructor
public LedBorgPublisher(String failureState,
                                              String successState,
                                              String unstableState,
                                              String notBuiltState,
                                              String abortedState)

Method Detail

getFailureState

public String getFailureState()

Returns:

the failureState

getSuccessState

public String getSuccessState()

Returns:

the successState

getUnstableState

public String getUnstableState()

Returns:

the unstableState

getNotBuiltState

public String getNotBuiltState()

Returns:

the notBuiltState

getAbortedState

public String getAbortedState()

Returns:

the abortedState

getDescriptor

public LedBorgPublisher.DescriptorImpl getDescriptor()

Get the associated descriptor object

Specified by:

getDescriptor in interface hudson.model.Describable<hudson.tasks.Publisher>

Overrides:

getDescriptor in class hudson.tasks.Notifier

getRequiredMonitorService

public hudson.tasks.BuildStepMonitor getRequiredMonitorService()

Get the build step monitor. This build step is only executed after the same step in the previous build is completed. Don't want multiple build trying to update the LED's concurrently

Specified by:

getRequiredMonitorService in interface hudson.tasks.BuildStep

perform

public void perform(hudson.model.Run<?,?> build,
                    hudson.FilePath workspace,
                    hudson.Launcher launcher,
                    hudson.model.TaskListener listener)
             throws InterruptedException,
                    IOException

Perform actions associated with the build step. In this instance, setting the appropriate LED colour

Specified by:

perform in interface jenkins.tasks.SimpleBuildStep

Throws:

InterruptedException

IOException