de.codecentric.jenkins.dashboard

Class EnvironmentTagBuilder

java.lang.Object

hudson.tasks.BuildStepCompatibilityLayer

hudson.tasks.Builder

de.codecentric.jenkins.dashboard.EnvironmentTagBuilder

All Implemented Interfaces:

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

public class EnvironmentTagBuilder
extends hudson.tasks.Builder

This Builder tags the specified environment with a given version number.

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

When a build is performed, the BuildStepCompatibilityLayer.perform(Build, Launcher, BuildListener) method will be invoked.

Author:

marcel.birkner

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	EnvironmentTagBuilder.DescriptorImpl Descriptor for EnvironmentTagBuilder.

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
EnvironmentTagBuilder(String credentials, String region) This annotation tells Hudson to call this constructor, with values from the configuration form page with matching parameter names.

Method Summary

Modifier and Type	Method and Description
String	getCredentials()
EnvironmentTagBuilder.DescriptorImpl	getDescriptor() Hudson defines a method Builder.getDescriptor(), which returns the corresponding Descriptor object.
String	getRegion()
boolean	perform(hudson.model.AbstractBuild build, hudson.Launcher launcher, hudson.model.BuildListener listener) We'll use this from the config.jelly.
void	setCredentials(String credentials)
void	setRegion(String region)

Methods inherited from class hudson.tasks.Builder

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

Constructor Detail

EnvironmentTagBuilder

@DataBoundConstructor
public EnvironmentTagBuilder(String credentials,
                                                   String region)

This annotation tells Hudson to call this constructor, with values from the configuration form page with matching parameter names.

Parameters:

credentials - reference to Jenkins AWS credentials

region - reference to AWS region

Method Detail

getCredentials

public String getCredentials()

setCredentials

public void setCredentials(String credentials)

getRegion

public String getRegion()

setRegion

public void setRegion(String region)

perform

public boolean perform(hudson.model.AbstractBuild build,
                       hudson.Launcher launcher,
                       hudson.model.BuildListener listener)

We'll use this from the config.jelly.

Specified by:

perform in interface hudson.tasks.BuildStep

Overrides:

perform in class hudson.tasks.BuildStepCompatibilityLayer

getDescriptor

public EnvironmentTagBuilder.DescriptorImpl getDescriptor()

Hudson defines a method Builder.getDescriptor(), which returns the corresponding Descriptor object. Since we know that it's actually EnvironmentTagBuilder.DescriptorImpl, override the method and give a better return type, so that we can access EnvironmentTagBuilder.DescriptorImpl methods more easily. This is not necessary, but just a coding style preference.

Specified by:

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

Overrides:

getDescriptor in class hudson.tasks.Builder