com.logmein.jenkins.plugins.pipeline.bamboo

Class BuildBambooStep.Execution

java.lang.Object

org.jenkinsci.plugins.workflow.steps.StepExecution

org.jenkinsci.plugins.workflow.steps.SynchronousNonBlockingStepExecution<Void>

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

All Implemented Interfaces:

Serializable

Enclosing class:

BuildBambooStep

public static class BuildBambooStep.Execution
extends org.jenkinsci.plugins.workflow.steps.SynchronousNonBlockingStepExecution<Void>

The execution to run. We use a SynchronousNonBlockingStepExecution, so as not to block the main thread. This will still block an executor on an agent, and should be run with agent set to "none" in your pipeline script.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
Execution(BuildBambooStep step, org.jenkinsci.plugins.workflow.steps.StepContext context, HttpClientFactory httpClientFactory) Constructor for the execution, invoked by BuildBambooStep.start(org.jenkinsci.plugins.workflow.steps.StepContext)

Method Summary

Modifier and Type	Method and Description
String	get(String url, String username, String password) GET data from the server.
int	getBuildNumber(String text) Get the build number after we start the job.
Map<String,String>	getBuildStatus(String text) Get the job state and lifecycle state of a Bamboo job.
HttpClientFactory	getHttpClientFactory() HttpClientFactory getter
PrintStream	getLogger() logger getter
BuildBambooStep	getStep() Step getter
boolean	getStopExecution() stopExecution getter.
String	post(String url, String username, String password, Map<String,Object> params) POST data to the server.
Void	run() Perform the actual work.
void	setLogger(PrintStream logger) logger setter
void	stop(Throwable throwable) Handles cleanup.

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

getStatus, onResume, start

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

applyAll, applyAll, getContext, getStatusBounded

Methods inherited from class java.lang.Object

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

Constructor Detail

Execution

public Execution(BuildBambooStep step,
                 @Nonnull
                 org.jenkinsci.plugins.workflow.steps.StepContext context,
                 HttpClientFactory httpClientFactory)
          throws InterruptedException,
                 IOException

Constructor for the execution, invoked by BuildBambooStep.start(org.jenkinsci.plugins.workflow.steps.StepContext)

Parameters:

step - BuildBambooStep object. "this" should be passed in BuildBambooStep.start(org.jenkinsci.plugins.workflow.steps.StepContext)

context - StepContext

httpClientFactory - Factory for creating HTTP clients.

Throws:

InterruptedException - Throws InterruptedException

IOException - Throws IOException

Method Detail

getStep

public BuildBambooStep getStep()

Step getter

Returns:

Returns a BuildBambooStep

getStopExecution

public boolean getStopExecution()

stopExecution getter. This is set by stop(java.lang.Throwable) to exit the polling loop.

Returns:

false to continue polling, true to halt execution.

getHttpClientFactory

public HttpClientFactory getHttpClientFactory()

HttpClientFactory getter

Returns:

An HttpClientFactory

getLogger

public PrintStream getLogger()

logger getter

Returns:

A PrintStream logger

setLogger

public void setLogger(PrintStream logger)

logger setter

Parameters:

logger - A PrintStream to log to.

post

public String post(String url,
                   String username,
                   String password,
                   Map<String,Object> params)

POST data to the server.

Parameters:

url - Bamboo target server URL. Example: http://bamboo-server.example.org

username - Bamboo API username

password - Bamboo API password

params - Currently unused

Returns:

String of the returned JSON

get

public String get(String url,
                  String username,
                  String password)

GET data from the server. Used to monitor build status.

Parameters:

url - Bamboo target server URL. Example: http://bamboo-server.example.org

username - Bamboo API username

password - Bamboo API password

Returns:

Returns JSON string from Bamboo server

getBuildNumber

public int getBuildNumber(String text)

Get the build number after we start the job.

Parameters:

text - POST data returned from Bamboo server after initiating build.

Returns:

The build number as an int.

getBuildStatus

public Map<String,String> getBuildStatus(String text)

Get the job state and lifecycle state of a Bamboo job.

Parameters:

text - JSON formatted text, returned by Bamboo.

Returns:

A map with the "state" and "lifeCycleState".

run

public Void run()
         throws Exception

Perform the actual work. Start the job on Bamboo server, and then poll it until complete.

Specified by:

run in class org.jenkinsci.plugins.workflow.steps.SynchronousNonBlockingStepExecution<Void>

Returns:

Returns null.

Throws:

Exception

stop

public void stop(@Nonnull
                 Throwable throwable)
          throws Exception

Handles cleanup. If interrupted by a timeout, or user abort, this method is called. Sets stopExecution to exit the poll loop in run()

Overrides:

stop in class org.jenkinsci.plugins.workflow.steps.SynchronousNonBlockingStepExecution<Void>

Parameters:

throwable - Contains the reason for stopping.

Throws:

Exception