com.inedo.buildmaster.api

Class BuildMasterApi

java.lang.Object

com.inedo.buildmaster.api.BuildMasterApi

public class BuildMasterApi
extends java.lang.Object

BuildMaster json api interface Unless otherwise specified the api calls are specified in http://<buildmaster>/reference/api

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	BuildMasterApi.BuildNumber

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	LATEST_RELEASE

Constructor Summary

Constructors

Constructor and Description
BuildMasterApi(BuildMasterConfig config, JenkinsLogWriter logWriter)
BuildMasterApi(JenkinsLogWriter listener)

Method Summary

Modifier and Type	Method and Description
void	checkConnection() Ensure can call the BuildMaster api.
ApiReleaseBuild	createBuild(int applicationId, java.lang.String releaseNumber, java.util.Map<java.lang.String,java.lang.String> variablesList) Creates a new build for an application.
ApiDeployment[]	deployBuildToStage(int applicationId, java.lang.String releaseNumber, java.lang.String buildNumber, java.util.Map<java.lang.String,java.lang.String> variablesList, java.lang.String stage, boolean forceDeployment)
ApiDeployment[]	getActiveDeployments(int applicationId, java.lang.String releaseNumber, java.lang.String buildNumber)
ApiRelease[]	getActiveReleases(int applicationId) Gets list of number of active releases
Application	getApplication(int applicationId) Get Application from or id.
Application	getApplication(java.lang.String identifier) Get Application from application name or id.
java.lang.Integer	getApplicationId(java.lang.String identifier) Get applicationId from identifier (name or id).
Application[]	getApplications() Gets a list of all applications in the system.
ApiReleaseBuild	getBuild(int applicationId, java.lang.String releaseNumber, java.lang.String buildNumber) Gets the details for a specified build.
ApiDeployment	getDeployment(int applicationId, java.lang.String releaseNumber, java.lang.String buildNumber, java.lang.Integer deploymentId)
java.lang.String	getExecutionLog(int deploymentId)
java.lang.String	getJsonString()
java.lang.String	getLatestActiveReleaseNumber(java.lang.Integer applicationId) Gets release number of newest active release, if no active releases will return an empty string
ApiDeployment	getLatestDeployment(int applicationId, java.lang.String releaseNumber, java.lang.String buildNumber) Gets the latest build executions for the specified build
java.util.List<java.lang.String>	getPipelinesStages(int pipelineId) Gets the applications pipelines
ApiRelease	getRelease(int applicationId, java.lang.String releaseNumber) Gets the release details
BuildMasterApi.BuildNumber	getReleaseBuildNumber(int applicationId, java.lang.String releaseNumber) Gets the most recent build number for the given release, if no builds have been performed will return null
java.lang.String	getReleaseNumber(Application application, java.lang.String releaseNumber) If releaseNumber is LATEST, returns latest active release number, else returns releaseNumber.
void	printExecutionLog(int deploymentId) Prints the build log for the execution id.
BuildMasterApi	setRecordJson(boolean record)
boolean	waitForActiveDeploymentsToComplete(int applicationId, java.lang.String releaseNumber) Checks to see deployments are running for a release, if so will wait for them to complete.
boolean	waitForDeploymentToComplete(ApiDeployment[] deployments, boolean printLogOnFailure) Wait for the build deployment, and any automatic promotions, to complete.

Methods inherited from class java.lang.Object

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

Field Detail

LATEST_RELEASE

public static final java.lang.String LATEST_RELEASE

See Also:

Constant Field Values

Constructor Detail

BuildMasterApi

public BuildMasterApi(JenkinsLogWriter listener)

BuildMasterApi

public BuildMasterApi(@Nonnull
                      BuildMasterConfig config,
                      JenkinsLogWriter logWriter)

Method Detail

setRecordJson

public BuildMasterApi setRecordJson(boolean record)

getJsonString

public java.lang.String getJsonString()

checkConnection

public void checkConnection()
                     throws java.io.IOException

Ensure can call the BuildMaster api. An exception will be thrown if cannot.

Throws:

java.io.IOException - Http request exception

getApplications

public Application[] getApplications()
                              throws java.io.IOException

Gets a list of all applications in the system.

Throws:

java.io.IOException - Http request exception

getApplicationId

public java.lang.Integer getApplicationId(java.lang.String identifier)
                                   throws java.io.IOException

Get applicationId from identifier (name or id).

Parameters:

identifier - Name or Id of application

Returns:

applicationId or null if not found

Throws:

java.io.IOException - Http request exception

getApplication

public Application getApplication(java.lang.String identifier)
                           throws java.io.IOException

Get Application from application name or id.

Parameters:

identifier - Application Name or Id.

Returns:

Application or null if not found

Throws:

java.io.IOException - Http request exception

getApplication

public Application getApplication(int applicationId)
                           throws java.io.IOException

Get Application from or id.

Parameters:

applicationId - Application id

Returns:

Application or null if not found

Throws:

java.io.IOException - Http request exception

getPipelinesStages

public java.util.List<java.lang.String> getPipelinesStages(int pipelineId)
                                                    throws java.io.IOException

Gets the applications pipelines

Throws:

java.io.IOException - Http request exception

getRelease

public ApiRelease getRelease(int applicationId,
                             java.lang.String releaseNumber)
                      throws java.io.IOException

Gets the release details

Throws:

java.io.IOException - Http request exception

See Also:

Endpoint Specification

getActiveReleases

public ApiRelease[] getActiveReleases(int applicationId)
                               throws java.io.IOException

Gets list of number of active releases

Throws:

java.io.IOException - Http request exception

See Also:

Endpoint Specification

getReleaseNumber

public java.lang.String getReleaseNumber(Application application,
                                         java.lang.String releaseNumber)
                                  throws java.io.IOException

If releaseNumber is LATEST, returns latest active release number, else returns releaseNumber.

Parameters:

application - An application object for the requested application

releaseNumber - LATEST, anything else treated as valid release number

Returns:

releaseNumber

Throws:

java.io.IOException - Http request exception or not active release found

getLatestActiveReleaseNumber

public java.lang.String getLatestActiveReleaseNumber(java.lang.Integer applicationId)
                                              throws java.io.IOException

Gets release number of newest active release, if no active releases will return an empty string

Throws:

java.io.IOException - Http request exception

getReleaseBuildNumber

public BuildMasterApi.BuildNumber getReleaseBuildNumber(int applicationId,
                                                        java.lang.String releaseNumber)
                                                 throws java.io.IOException

Gets the most recent build number for the given release, if no builds have been performed will return null

Throws:

java.io.IOException - Http request exception

getBuild

public ApiReleaseBuild getBuild(int applicationId,
                                java.lang.String releaseNumber,
                                java.lang.String buildNumber)
                         throws java.io.IOException

Gets the details for a specified build.

Throws:

java.io.IOException - Http request exception

See Also:

Endpoint Specification

createBuild

public ApiReleaseBuild createBuild(int applicationId,
                                   java.lang.String releaseNumber,
                                   java.util.Map<java.lang.String,java.lang.String> variablesList)
                            throws java.io.IOException

Creates a new build for an application.

Returns:

ApiReleaseBuild

Throws:

java.io.IOException - Http request exception

See Also:

Endpoint Specification

deployBuildToStage

public ApiDeployment[] deployBuildToStage(int applicationId,
                                          java.lang.String releaseNumber,
                                          java.lang.String buildNumber,
                                          java.util.Map<java.lang.String,java.lang.String> variablesList,
                                          java.lang.String stage,
                                          boolean forceDeployment)
                                   throws java.io.IOException,
                                          java.lang.InterruptedException

Parameters:

applicationId - Required

releaseNumber - Required

buildNumber - Required

stage - Optional. If not supplied, the next stage in the pipeline will be used.

Returns:

ApiDeployment[]

Throws:

java.io.IOException - Http request exception

java.lang.InterruptedException - Failed while waiting for action

See Also:

Endpoint Specification

getLatestDeployment

public ApiDeployment getLatestDeployment(int applicationId,
                                         java.lang.String releaseNumber,
                                         java.lang.String buildNumber)
                                  throws java.io.IOException

Gets the latest build executions for the specified build

Returns:

Latest execution or empty object if no executions have occurred yet

Throws:

java.io.IOException - Http request exception

See Also:

Endpoint Specification

getDeployment

public ApiDeployment getDeployment(int applicationId,
                                   java.lang.String releaseNumber,
                                   java.lang.String buildNumber,
                                   java.lang.Integer deploymentId)
                            throws java.io.IOException

Throws:

java.io.IOException

getActiveDeployments

public ApiDeployment[] getActiveDeployments(int applicationId,
                                            java.lang.String releaseNumber,
                                            java.lang.String buildNumber)
                                     throws java.io.IOException

Throws:

java.io.IOException

waitForActiveDeploymentsToComplete

public boolean waitForActiveDeploymentsToComplete(int applicationId,
                                                  java.lang.String releaseNumber)
                                           throws java.io.IOException,
                                                  java.lang.InterruptedException

Checks to see deployments are running for a release, if so will wait for them to complete.

Throws:

java.io.IOException - Http request exception

java.lang.InterruptedException - Failed why waiting for action

waitForDeploymentToComplete

public boolean waitForDeploymentToComplete(ApiDeployment[] deployments,
                                           boolean printLogOnFailure)
                                    throws java.io.IOException,
                                           java.lang.InterruptedException

Wait for the build deployment, and any automatic promotions, to complete.

Parameters:

deployments - Previously requested deployment

printLogOnFailure - Retrieve and output log from BuildMaster on failure

Returns:

Deployment completed successfully or not

Throws:

java.io.IOException

java.lang.InterruptedException

getExecutionLog

public java.lang.String getExecutionLog(int deploymentId)
                                 throws java.io.IOException

Throws:

java.io.IOException

printExecutionLog

public void printExecutionLog(int deploymentId)

Prints the build log for the execution id.