com.offbytwo.jenkins

Class JenkinsTriggerHelper

java.lang.Object

com.offbytwo.jenkins.JenkinsTriggerHelper

public class JenkinsTriggerHelper
extends Object

collection of convenient methods which use methods from JenkinsServer etc.

Author:

Karl Heinz Marbaise

Constructor Summary

Constructors

Constructor and Description
JenkinsTriggerHelper(JenkinsServer server)

Method Summary

Modifier and Type	Method and Description
BuildWithDetails	triggerJobAndWaitUntilFinished(String jobName) This method will trigger a build of the given job and will wait until the builds is ended or if the build has been cancelled.
BuildWithDetails	triggerJobAndWaitUntilFinished(String jobName, boolean crumbFlag) This method will trigger a build of the given job and will wait until the builds is ended or if the build has been cancelled.
BuildWithDetails	triggerJobAndWaitUntilFinished(String jobName, Map<String,String> params) This method will trigger a build of the given job and will wait until the builds is ended or if the build has been cancelled.
BuildWithDetails	triggerJobAndWaitUntilFinished(String jobName, Map<String,String> params, boolean crumbFlag) This method will trigger a build of the given job and will wait until the builds is ended or if the build has been cancelled.

Methods inherited from class java.lang.Object

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

Constructor Detail

JenkinsTriggerHelper

public JenkinsTriggerHelper(JenkinsServer server)

Method Detail

triggerJobAndWaitUntilFinished

public BuildWithDetails triggerJobAndWaitUntilFinished(String jobName)
                                                throws IOException,
                                                       InterruptedException

This method will trigger a build of the given job and will wait until the builds is ended or if the build has been cancelled.

Parameters:

jobName - The name of the job which should be triggered.

Returns:

In case of an cancelled job you will get BuildWithDetails.getResult() BuildResult.CANCELLED. So you have to check first if the build result is CANCELLED.

Throws:

IOException - in case of errors.

InterruptedException - In case of interrupts.

triggerJobAndWaitUntilFinished

public BuildWithDetails triggerJobAndWaitUntilFinished(String jobName,
                                                       Map<String,String> params)
                                                throws IOException,
                                                       InterruptedException

This method will trigger a build of the given job and will wait until the builds is ended or if the build has been cancelled.

Parameters:

jobName - The name of the job which should be triggered.

params - the job parameters

Returns:

In case of an cancelled job you will get BuildWithDetails.getResult() BuildResult.CANCELLED. So you have to check first if the build result is CANCELLED.

Throws:

IOException - in case of errors.

InterruptedException - In case of interrupts.

triggerJobAndWaitUntilFinished

public BuildWithDetails triggerJobAndWaitUntilFinished(String jobName,
                                                       Map<String,String> params,
                                                       boolean crumbFlag)
                                                throws IOException,
                                                       InterruptedException

This method will trigger a build of the given job and will wait until the builds is ended or if the build has been cancelled.

Parameters:

jobName - The name of the job which should be triggered.

params - the job parameters

crumbFlag - set to true or false.

Returns:

In case of an cancelled job you will get BuildWithDetails.getResult() BuildResult.CANCELLED. So you have to check first if the build result is CANCELLED.

Throws:

IOException - in case of errors.

InterruptedException - In case of interrupts.

triggerJobAndWaitUntilFinished

public BuildWithDetails triggerJobAndWaitUntilFinished(String jobName,
                                                       boolean crumbFlag)
                                                throws IOException,
                                                       InterruptedException

This method will trigger a build of the given job and will wait until the builds is ended or if the build has been cancelled.

Parameters:

jobName - The name of the job which should be triggered.

crumbFlag - set to true or false.

Returns:

In case of an cancelled job you will get BuildWithDetails.getResult() BuildResult.CANCELLED. So you have to check first if the build result is CANCELLED.

Throws:

IOException - in case of errors.

InterruptedException - In case of interrupts.