com.logmein.jenkins.plugins.pipeline.bamboo

Class BuildBambooStep

java.lang.Object

hudson.model.AbstractDescribableImpl<org.jenkinsci.plugins.workflow.steps.Step>

org.jenkinsci.plugins.workflow.steps.Step

com.logmein.jenkins.plugins.pipeline.bamboo.BuildBambooStep

All Implemented Interfaces:

hudson.ExtensionPoint, hudson.model.Describable<org.jenkinsci.plugins.workflow.steps.Step>

public class BuildBambooStep
extends org.jenkinsci.plugins.workflow.steps.Step

A Bamboo pipeline step plugin. Start a Bamboo job from with your Jenkinsfile. See BuildBambooStep.Execution.run() method.

Author:

Kyle Flavin

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	BuildBambooStep.DescriptorImpl Holds class metadata, including step name.
static class	BuildBambooStep.Execution The execution to run.

Nested classes/interfaces inherited from interface hudson.ExtensionPoint

hudson.ExtensionPoint.LegacyInstancesAreScopedToHudson

Constructor Summary

Constructors

Constructor and Description
BuildBambooStep(String projectKey, String planKey, String serverAddress, String username, String password) DataBoundConstructor will set propagate to "true" by default.

Method Summary

Modifier and Type	Method and Description
int	getCheckInterval() checkInterval getter
Map<String,Object>	getParams() Params getter
String	getPassword() Password getter
String	getPlanKey() Plan name getter
String	getProjectKey() Project name getter
boolean	getPropagate() Propagate getter
String	getServerAddress() Server address getter
String	getUsername() Username getter
void	setCheckInterval(int checkInterval) The time to wait between HTTP checks, while polling the target server.
void	setParams(Map<String,Object> params) The params passed by the user (optional)
void	setPropagate(boolean propagate) Set error propagation.
org.jenkinsci.plugins.workflow.steps.StepExecution	start(org.jenkinsci.plugins.workflow.steps.StepContext stepContext) Starts execution of Execution.

Methods inherited from class org.jenkinsci.plugins.workflow.steps.Step

getDescriptor

Methods inherited from class java.lang.Object

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

Constructor Detail

BuildBambooStep

@DataBoundConstructor
public BuildBambooStep(String projectKey,
                                              String planKey,
                                              String serverAddress,
                                              String username,
                                              String password)

DataBoundConstructor will set propagate to "true" by default. Parameters given in the constructor, with no setters, are required.

Parameters:

projectKey: - Bamboo project key. used to construct the job: "projectKey-planKey"

planKey: - Bamboo plan key. used to construct the job: "planKey-planKey"

serverAddress: - Server address, prefix with protocol. Example: https://bamboo-server.example.org

username: - Bamboo API user

password: - Bamboo API password

Method Detail

getProjectKey

public String getProjectKey()

Project name getter

Returns:

String that is the project key. Combined with plan to form the job name.

getPlanKey

public String getPlanKey()

Plan name getter

Returns:

String that is the plan key. Combined with project to form the job name.

getServerAddress

public String getServerAddress()

Server address getter

Returns:

String that is the Bamboo server address

getUsername

public String getUsername()

Username getter

Returns:

String that is the username

getPassword

public String getPassword()

Password getter

Returns:

String that is the password

getPropagate

public boolean getPropagate()

Propagate getter

Returns:

true if propagation is on (default), else false

setPropagate

@DataBoundSetter
public void setPropagate(boolean propagate)

Set error propagation.

Parameters:

propagate: - true (default) to propagate errors, or false to not propagate. By default, if there is an error with the Bamboo build, it will fail the entire pipeline.

setCheckInterval

@DataBoundSetter
public void setCheckInterval(int checkInterval)

The time to wait between HTTP checks, while polling the target server.

Parameters:

checkInterval: - set time in seconds.

getParams

public Map<String,Object> getParams()

Params getter

Returns:

return Map of params

setParams

@DataBoundSetter
public void setParams(Map<String,Object> params)

The params passed by the user (optional)

Parameters:

params: - set time in seconds.

getCheckInterval

public int getCheckInterval()

checkInterval getter

Returns:

return checkInterval time in seconds

start

public org.jenkinsci.plugins.workflow.steps.StepExecution start(org.jenkinsci.plugins.workflow.steps.StepContext stepContext)
                                                         throws Exception

Starts execution of Execution.

Specified by:

start in class org.jenkinsci.plugins.workflow.steps.Step

Parameters:

stepContext - Step Context

Returns:

StepExecution

Throws:

Exception - Throws Exception