org.aerogear.digger.client.services

Class BuildService

java.lang.Object

org.aerogear.digger.client.services.BuildService

public class BuildService
extends Object

Provides functionality to trigger a build.

Field Summary

Fields

Modifier and Type	Field and Description
static long	DEFAULT_FIRST_CHECK_DELAY Default value of firstCheckDelay
static long	DEFAULT_POLL_PERIOD Default value of pollPeriod

Constructor Summary

Constructors

Constructor and Description
BuildService(long firstCheckDelay, long pollPeriod)

Method Summary

Modifier and Type	Method and Description
BuildTriggerStatus	build(com.offbytwo.jenkins.JenkinsServer jenkinsServer, String jobName, long timeout) See the documentation in DiggerClient.build(String, long)
com.offbytwo.jenkins.model.BuildWithDetails	cancelBuild(com.offbytwo.jenkins.JenkinsServer jenkins, String jobName, int buildNumber) Cancel a build
com.offbytwo.jenkins.model.Build	getBuild(com.offbytwo.jenkins.JenkinsServer jenkins, String jobName, int buildNumber) Retrieve a build from a specific job
com.offbytwo.jenkins.model.BuildWithDetails	getBuildDetails(com.offbytwo.jenkins.JenkinsServer jenkins, String jobName, int buildNumber) Get the build details of a job
List<com.offbytwo.jenkins.model.BuildWithDetails>	getBuildHistory(com.offbytwo.jenkins.JenkinsServer jenkins, String jobName) Returns the build history for a job.
String	getBuildLogs(com.offbytwo.jenkins.JenkinsServer jenkins, String jobName, int buildNumber) Get build logs for specific job and build number
BuildTriggerStatus	pollBuild(com.offbytwo.jenkins.JenkinsServer jenkinsServer, String jobName, com.offbytwo.jenkins.model.QueueReference queueReference, long timeout, Map<String,String> params) See the documentation in DiggerClient.build(String, long, Map)
void	streamBuildLogs(com.offbytwo.jenkins.JenkinsServer jenkins, String jobName, int buildNumber, LogStreamingOptions options) Start streaming the logs of the given build.
BuildTriggerStatus	triggerBuild(com.offbytwo.jenkins.JenkinsServer jenkinsServer, String jobName, Map<String,String> params)

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_FIRST_CHECK_DELAY

public static final long DEFAULT_FIRST_CHECK_DELAY

Default value of firstCheckDelay

See Also:

Constant Field Values

DEFAULT_POLL_PERIOD

public static final long DEFAULT_POLL_PERIOD

Default value of pollPeriod

See Also:

Constant Field Values

Constructor Detail

BuildService

public BuildService(long firstCheckDelay,
                    long pollPeriod)

Parameters:

firstCheckDelay - how long should we wait (in milliseconds) before we start checking the queue item status

pollPeriod - how long should we wait (in milliseconds) before checking the queue item status for next time

Method Detail

getBuildLogs

public String getBuildLogs(com.offbytwo.jenkins.JenkinsServer jenkins,
                           String jobName,
                           int buildNumber)
                    throws DiggerClientException,
                           IOException

Get build logs for specific job and build number

Parameters:

jobName - name of the job

buildNumber - job build number

Returns:

String with file contents that can be saved or piped to socket

Throws:

DiggerClientException - when problem with fetching artifacts from jenkins

IOException

getBuildHistory

public List<com.offbytwo.jenkins.model.BuildWithDetails> getBuildHistory(com.offbytwo.jenkins.JenkinsServer jenkins,
                                                                         String jobName)
                                                                  throws DiggerClientException

Returns the build history for a job. As reported by JobWithDetails.getBuilds() it will return max 100 most-recent builds.

Please note that this approach will take some time since we first fetch the builds in 1 call, then fetch build details in 1 call per build.

Parameters:

jenkins - Jenkins server client

jobName - name of the job

Returns:

the build history

Throws:

DiggerClientException - if connection problems occur

triggerBuild

public BuildTriggerStatus triggerBuild(com.offbytwo.jenkins.JenkinsServer jenkinsServer,
                                       String jobName,
                                       Map<String,String> params)
                                throws IOException,
                                       InterruptedException

Parameters:

jenkinsServer - Jenkins server client

jobName - name of the job

params - build parameters to override defaults in the job

Returns:

The QueueReference

Throws:

IOException - if connection problems occur during connecting to Jenkins

InterruptedException - if a problem occurs during sleeping between checks

pollBuild

public BuildTriggerStatus pollBuild(com.offbytwo.jenkins.JenkinsServer jenkinsServer,
                                    String jobName,
                                    com.offbytwo.jenkins.model.QueueReference queueReference,
                                    long timeout,
                                    Map<String,String> params)
                             throws IOException,
                                    InterruptedException

See the documentation in DiggerClient.build(String, long, Map)

Parameters:

jenkinsServer - Jenkins server client

jobName - name of the job

timeout - timeout

params - build parameters to override defaults in the job

Returns:

the build status

Throws:

IOException - if connection problems occur during connecting to Jenkins

InterruptedException - if a problem occurs during sleeping between checks

See Also:

DiggerClient.build(String, long, Map)

build

public BuildTriggerStatus build(com.offbytwo.jenkins.JenkinsServer jenkinsServer,
                                String jobName,
                                long timeout)
                         throws IOException,
                                InterruptedException

See the documentation in DiggerClient.build(String, long)

Parameters:

jenkinsServer - Jenkins server client

jobName - name of the job

timeout - timeout

Returns:

the build status

Throws:

IOException - if connection problems occur during connecting to Jenkins

InterruptedException - if a problem occurs during sleeping between checks

See Also:

DiggerClient.build(String, long)

getBuild

public com.offbytwo.jenkins.model.Build getBuild(com.offbytwo.jenkins.JenkinsServer jenkins,
                                                 String jobName,
                                                 int buildNumber)
                                          throws DiggerClientException

Retrieve a build from a specific job

Parameters:

jenkins - the jenkins instance

jobName - the name of the job

buildNumber - the build number

Returns:

Build

Throws:

DiggerClientException

getBuildDetails

public com.offbytwo.jenkins.model.BuildWithDetails getBuildDetails(com.offbytwo.jenkins.JenkinsServer jenkins,
                                                                   String jobName,
                                                                   int buildNumber)
                                                            throws DiggerClientException,
                                                                   IOException

Get the build details of a job

Parameters:

jenkins - the jenkins instance

jobName - the name of the job

buildNumber - the build number

Returns:

BuildWithDetails

Throws:

DiggerClientException

IOException

cancelBuild

public com.offbytwo.jenkins.model.BuildWithDetails cancelBuild(com.offbytwo.jenkins.JenkinsServer jenkins,
                                                               String jobName,
                                                               int buildNumber)
                                                        throws DiggerClientException,
                                                               IOException

Cancel a build

Parameters:

jenkins - the jenkins instance

jobName - the name of the job

buildNumber - the build number

Returns:

BuildWithDetails

Throws:

DiggerClientException

IOException

streamBuildLogs

public void streamBuildLogs(com.offbytwo.jenkins.JenkinsServer jenkins,
                            String jobName,
                            int buildNumber,
                            LogStreamingOptions options)
                     throws DiggerClientException,
                            IOException,
                            InterruptedException

Start streaming the logs of the given build. See DiggerClient.streamLogs(String, int, LogStreamingOptions)

Throws:

DiggerClientException

IOException

InterruptedException