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

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.
ApiReleasePackage	createPackage(int applicationId, java.lang.String releaseNumber, java.util.Map<java.lang.String,java.lang.String> variablesList) Creates a new build of an application and promote it to the first environment.
ApiReleasePackage	createPackage(int applicationId, java.lang.String releaseNumber, java.lang.String packageNumber, java.util.Map<java.lang.String,java.lang.String> variablesList) Creates a new build for an application requesting it use a specific build number and returns the build number of the new build.
ApiDeployment[]	deployPackageToStage(int applicationId, java.lang.String releaseNumber, java.lang.String packageNumber, java.util.Map<java.lang.String,java.lang.String> variablesList, java.lang.String stage)
void	enableReleaseDeployable(int applicationId, java.lang.String releaseNumber, int deployableId) Enables deployable on an existing release if it is not currently enabled
ApiDeployment[]	getActiveDeployments(int applicationId, java.lang.String releaseNumber, java.lang.String packageNumber)
ApiRelease[]	getActiveReleases(int applicationId) Gets list of number of active releases
Application	getApplication(int applicationId)
Deployable[]	getApplicationDeployables(int applicationId) Gets the deployables for a specific application
Application[]	getApplications() Gets a list of all applications in the system.
Deployable	getDeployable(int deployableId) Gets the specified deployable
ApiDeployment	getDeployment(int applicationId, java.lang.String releaseNumber, java.lang.String packageNumber, 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 packageNumber) Gets the latest build executions for the specified build
ApiReleasePackage	getPackage(int applicationId, java.lang.String releaseNumber, java.lang.String packageNumber) Gets the details for a specified build.
ApiVariable[]	getPackageVariables(java.lang.String applicationName, java.lang.String releaseNumber, java.lang.String packageNumber) Gets the variable values for the build scope.
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
java.lang.String	getReleaseCurrentPackageNumber(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
Deployable[]	getReleaseDeployables(int applicationId, java.lang.String releaseNumber) Gets release number of newest active release
java.lang.String	getReleaseNextPackageNumber(int applicationId, java.lang.String releaseNumber) Gets the next available build number for the given release, if no builds have been performed will return 1
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 package 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

Constructor Detail

BuildMasterApi

public BuildMasterApi(JenkinsLogWriter listener)

BuildMasterApi

public BuildMasterApi(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

getApplications

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

Gets a list of all applications in the system.

Throws:

java.io.IOException

getApplication

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

Throws:

java.io.IOException

getApplicationDeployables

public Deployable[] getApplicationDeployables(int applicationId)
                                       throws java.io.IOException

Gets the deployables for a specific application

Throws:

java.io.IOException

getPipelinesStages

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

Gets the applications pipelines

Throws:

java.io.IOException

getDeployable

public Deployable getDeployable(int deployableId)
                         throws java.io.IOException

Gets the specified deployable

Throws:

java.io.IOException

getRelease

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

Gets the release details

Throws:

java.io.IOException

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

See Also:

Endpoint Specification

getReleaseNextPackageNumber

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

Gets the next available build number for the given release, if no builds have been performed will return 1

Throws:

java.io.IOException

getReleaseCurrentPackageNumber

public java.lang.String getReleaseCurrentPackageNumber(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

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

getReleaseDeployables

public Deployable[] getReleaseDeployables(int applicationId,
                                          java.lang.String releaseNumber)
                                   throws java.io.IOException

Gets release number of newest active release

Throws:

java.io.IOException

enableReleaseDeployable

public void enableReleaseDeployable(int applicationId,
                                    java.lang.String releaseNumber,
                                    int deployableId)
                             throws java.io.IOException

Enables deployable on an existing release if it is not currently enabled

Throws:

java.io.IOException

getPackage

public ApiReleasePackage getPackage(int applicationId,
                                    java.lang.String releaseNumber,
                                    java.lang.String packageNumber)
                             throws java.io.IOException

Gets the details for a specified build.

Throws:

java.io.IOException

See Also:

Endpoint Specification

createPackage

public ApiReleasePackage createPackage(int applicationId,
                                       java.lang.String releaseNumber,
                                       java.util.Map<java.lang.String,java.lang.String> variablesList)
                                throws java.io.IOException,
                                       java.lang.InterruptedException

Creates a new build of an application and promote it to the first environment. Error thrown on failure.

Returns:

ApiPackageDeployment

Throws:

java.io.IOException

java.lang.InterruptedException

createPackage

public ApiReleasePackage createPackage(int applicationId,
                                       java.lang.String releaseNumber,
                                       java.lang.String packageNumber,
                                       java.util.Map<java.lang.String,java.lang.String> variablesList)
                                throws java.io.IOException,
                                       java.lang.InterruptedException

Creates a new build for an application requesting it use a specific build number and returns the build number of the new build. Error thrown on failure.

Returns:

ApiPackageDeployment

Throws:

java.io.IOException

java.lang.InterruptedException

See Also:

Endpoint Specification

deployPackageToStage

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

Parameters:

applicationId - Required

releaseNumber - Required

packageNumber - Required

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

Returns:

ApiDeployment[]

Throws:

java.io.IOException

java.lang.InterruptedException

See Also:

Endpoint Specification

getLatestDeployment

public ApiDeployment getLatestDeployment(int applicationId,
                                         java.lang.String releaseNumber,
                                         java.lang.String packageNumber)
                                  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

See Also:

Endpoint Specification

getDeployment

public ApiDeployment getDeployment(int applicationId,
                                   java.lang.String releaseNumber,
                                   java.lang.String packageNumber,
                                   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 packageNumber)
                                     throws java.io.IOException

Throws:

java.io.IOException

getPackageVariables

public ApiVariable[] getPackageVariables(java.lang.String applicationName,
                                         java.lang.String releaseNumber,
                                         java.lang.String packageNumber)
                                  throws java.io.IOException

Gets the variable values for the build scope.

Throws:

java.io.IOException

See Also:

Variables Management

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

java.lang.InterruptedException

waitForDeploymentToComplete

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

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

Parameters:

deployments -

printLogOnFailure -

Returns:

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.