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

Constructor Summary

Constructors

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

Method Summary

Methods

Modifier and Type	Method and Description
void	checkConnection() Ensure can call BuildMaster api.
ApiPackage	createPackage(java.lang.String 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.
ApiPackage	createPackage(java.lang.String applicationId, java.lang.String releaseNumber, java.lang.String buildNumber, 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(java.lang.String applicationId, java.lang.String releaseNumber, java.lang.String packageNumber, java.lang.String toStage)
void	enableReleaseDeployable(java.lang.String applicationId, java.lang.String releaseNumber, int deployableId) Enables deployable on an existing release if it is not currently enabled
Release[]	getActiveReleases(java.lang.String applicationId) Gets list of number of active releases
Application	getApplication(java.lang.String applicationId)
Application[]	getApplications() Gets a list of all applications in the system.
Build	getBuild(java.lang.String applicationId, java.lang.String releaseNumber, java.lang.String buildNumber) Gets the details for a specified build.
Deployable	getDeployable(int deployableId) Gets the specified deployable
Deployable[]	getDeployables(java.lang.String applicationId) Gets the deployables for a specific application
java.lang.String	getExecutionsInProgress(java.lang.String applicationId) Gets all executions in the executing state.
java.lang.String	getLastResult()
java.lang.String	getLatestActiveReleaseNumber(java.lang.String applicationId) Gets release number of newest active release, if no active releases will return an empty string
BuildExecution	getLatestExecution(java.lang.String applicationId, java.lang.String releaseNumber, java.lang.String buildNumber) Gets the latest build executions for the specified build
java.lang.String	getNextPackageNumber(java.lang.String applicationId, java.lang.String releaseNumber) Gets the next available build number for the given release, if no builds have been performed will return 1
ApiVariable[]	getPackageVariables(java.lang.String applicationId, java.lang.String releaseNumber, java.lang.String packageNumber) Gets the variable values for the build scope.
java.lang.String	getPreviousPackageNumber(java.lang.String applicationId, java.lang.String releaseNumber)
ReleaseDetails	getRelease(java.lang.String applicationId, java.lang.String releaseNumber) Gets release number of newest active release
void	printExecutionLog(int executionId) Prints the build log for the execution id.
BuildMasterApi	setRecordResult()
boolean	waitForBuildCompletion(java.lang.String applicationId, java.lang.String releaseNumber, java.lang.String buildNumber, boolean printLogOnFailure) Wait for the build to complete
void	waitForExistingBuildStepToComplete(java.lang.String applicationId, java.lang.String releaseNumber) Checks to see if any existing builds are running a build step, if so will wait for it 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

setRecordResult

public BuildMasterApi setRecordResult()

getLastResult

public java.lang.String getLastResult()

checkConnection

public void checkConnection()
                     throws java.io.IOException

Ensure can call 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(java.lang.String applicationId)
                           throws java.io.IOException

Throws:

java.io.IOException

getDeployables

public Deployable[] getDeployables(java.lang.String applicationId)
                            throws java.io.IOException

Gets the deployables for a specific application

Throws:

java.io.IOException

getDeployable

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

Gets the specified deployable

Throws:

java.io.IOException

getRelease

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

Gets release number of newest active release

Throws:

java.io.IOException

getActiveReleases

public Release[] getActiveReleases(java.lang.String applicationId)
                            throws java.io.IOException

Gets list of number of active releases

Throws:

java.io.IOException

getLatestActiveReleaseNumber

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

enableReleaseDeployable

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

getNextPackageNumber

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

getPreviousPackageNumber

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

Throws:

java.io.IOException

createPackage

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

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

Returns:

BuildNumber

Throws:

java.io.IOException

createPackage

public ApiPackage createPackage(java.lang.String applicationId,
                       java.lang.String releaseNumber,
                       java.lang.String buildNumber,
                       java.util.Map<java.lang.String,java.lang.String> variablesList)
                         throws java.io.IOException

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:

BuildNumber

Throws:

java.io.IOException

deployPackageToStage

public ApiDeployment[] deployPackageToStage(java.lang.String applicationId,
                                   java.lang.String releaseNumber,
                                   java.lang.String packageNumber,
                                   java.lang.String toStage)
                                     throws java.io.IOException

Parameters:

applicationId - Required

releaseNumber - Required

packageNumber - Required

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

Returns:

ApiDeployment[]

Throws:

java.io.IOException

getBuild

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

Gets the details for a specified build.

Throws:

java.io.IOException

getExecutionsInProgress

public java.lang.String getExecutionsInProgress(java.lang.String applicationId)
                                         throws java.io.IOException

Gets all executions in the executing state.

Throws:

java.io.IOException

getLatestExecution

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

getPackageVariables

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

Gets the variable values for the build scope.

Throws:

java.io.IOException

waitForExistingBuildStepToComplete

public void waitForExistingBuildStepToComplete(java.lang.String applicationId,
                                      java.lang.String releaseNumber)
                                        throws java.io.IOException,
                                               java.lang.InterruptedException

Checks to see if any existing builds are running a build step, if so will wait for it to complete

Throws:

java.io.IOException

java.lang.InterruptedException

waitForBuildCompletion

public boolean waitForBuildCompletion(java.lang.String applicationId,
                             java.lang.String releaseNumber,
                             java.lang.String buildNumber,
                             boolean printLogOnFailure)
                               throws java.io.IOException,
                                      java.lang.InterruptedException

Wait for the build to complete

Parameters:

printLogOnFailure -

Throws:

java.io.IOException

java.lang.InterruptedException

printExecutionLog

public void printExecutionLog(int executionId)
                       throws java.io.IOException

Prints the build log for the execution id.

Throws:

java.io.IOException