flexagon.fd.services.groovy.functions

Class FlexDeployFunctions

java.lang.Object

flexagon.fd.services.groovy.functions.BaseFunctions

flexagon.fd.services.groovy.functions.FlexDeploy2Functions

flexagon.fd.services.groovy.functions.FlexDeployFunctions

All Implemented Interfaces:

IFlexDeployFunctions

public class FlexDeployFunctions
extends FlexDeploy2Functions

Functions to perform actions in FlexDeploy, like building a project or starting a release.

Since:

5.3

Constructor Summary

Constructors

Constructor and Description
FlexDeployFunctions(boolean isExecute, LogFunctions pFLOG)

Method Summary

Modifier and Type	Method and Description
void	addProjectsToRelease(java.lang.String pReleaseName, java.util.List<ReleaseProjectsPojo> pReleaseProjects) Add FlexDeploy projects to a given release.
void	approveTask(java.lang.String pUsername, java.lang.String pTaskIdentifier, java.lang.String pNotes) Approve a FlexDeploy Task.
void	cleanup()
void	completeManualStepBySnapshotId(java.lang.String pUsername, java.lang.Long pSnapshotId) Completes a manual step Human task.
void	completeManualStepByTaskId(java.lang.String pUsername, java.lang.Long pTaskId) Completes a manual step Human task.
java.lang.Long	createRelease(java.lang.String pReleaseName, java.lang.String pPipelineName, java.lang.String pDescription) Create an empty FlexDeploy Release that defaults to 'Not Started' status.
java.lang.Long	createRelease(java.lang.String pReleaseName, java.lang.String pPipelineName, java.lang.String pDescription, java.lang.String pCronSchedule) Create an empty scheduled FlexDeploy Release that defaults to 'Not Started' status.
java.lang.Long	createSnapshot(java.lang.Long pReleaseId) Create a Snapshot for a given Release.
void	downloadSnapshotCommitDetails(java.lang.Long pSnapshotId, java.lang.String pDestinationPath) Gets the commit details of a snapshot and downloads a csv file to the destination path.
void	endRelease(java.lang.Long pReleaseId) End a FlexDeploy Release.
void	endRelease(java.lang.String pReleaseName) End a FlexDeploy Release.
java.util.List<ReleasePojo>	findReleases(java.lang.String pName) Finds Releases matching the specified name.
StageExecutionInformationPOJO	getPipelineStageExecutionInfo(java.lang.Long pStageExecId) Gets pipeline stage execution info based on the stage exec Id given.
StepProjectsRequestPojo	getPipelineStepProjectsExecution(java.lang.Long pStageExecId, java.lang.Long pStepId) Get the project request and execution statuses for a given pipeline step execution
StepProjectsRequestPojo	getPipelineStepProjectsExecution(java.lang.Long pStageExecId, java.lang.String pStepName) Get the project request and execution statuses for a given pipeline step execution
ReleasePojo	getRelease(java.lang.Long pId) Gets a release by a specific id.
java.util.List<ReleaseProjectDetailsPojo>	getReleaseProjectInfo(java.lang.Long pReleaseDefId) Gets release project info based on the release definition Id.
java.io.InputStream	getSnapshotCommitDetailInputStreams(java.lang.Long pSnapshotId) Gets the commit details of a snapshot and returns an input stream of the data.
java.util.List<ReleaseSnapshotCommitDetailsPojo>	getSnapshotCommitDetails(java.lang.Long pSnapshotId) Gets the commit details of a snapshot and returns an object with the data.
java.util.List<FDUser>	getUsersFromRoleId(java.lang.Long pRoleId) Gets a list of the users that are members of the pipeline role with the specified role Id.
void	pauseRelease(java.lang.Long pReleaseId) Pause a FlexDeploy Release.
void	pauseRelease(java.lang.String pReleaseName) Pause a FlexDeploy Release.
void	rejectTask(java.lang.String pUsername, java.lang.String pTaskIdentifier, java.lang.String pNotes) Reject a FlexDeploy Task.
void	removeProjectsFromRelease(java.lang.String pReleaseName, java.util.List<ReleaseProjectsPojo> pReleaseProjects) Remove FlexDeploy projects from a given release.
void	startRelease(java.lang.Long pReleaseId) Start a FlexDeploy Release.
void	startRelease(java.lang.String pReleaseName) Start a FlexDeploy Release.
java.lang.Long	updateReleaseProperty(java.lang.Long pReleaseDefId, java.lang.String pPropertyKeyCode, java.io.Serializable pNewValue) Updates a release's property with the provided property key code.
java.lang.Long	updateSnapshotVariable(java.lang.Long pSnapshotId, java.lang.String pVariableCode, java.io.Serializable pNewValue) Updates a snapshot's variable with the provided variable code.

Methods inherited from class flexagon.fd.services.groovy.functions.FlexDeploy2Functions

activateBranch, activateStream, addFilesToPackage, addWorkItemComment, assignGroupToUser, assignGroupToUser, buildPackage, buildPackage, buildPackage, buildPackage, buildProject, buildProject, buildProject, buildProject, createBranch, createBranch, createBranch, createCredential, createDynamicPackage, createEndpoint, createEnvironment, createFlxWorkItemField, createFlxWorkItemFieldGroup, createFolder, createGroup, createIncidentByWorkflowType, createIncidentForWorklowRequest, createPackage, createPackage, createProject, createProjectTrigger, createPropertyKeyDefinition, createSCMInstance, createSCMInstance, createStream, createStream, createStream, createTargetGroup, createUser, createWorkItem, deleteCredential, deleteEndpoint, deleteEnvironment, deleteFlxWorkItem, deleteFlxWorkItemField, deleteFlxWorkItemFieldGroup, deleteFolder, deletePackage, deleteProjectTrigger, deleteTargetGroup, deployPackage, deployProject, discoverFiles, downloadLogs, executeUtility, executeUtility, findBranchId, findCMSInstance, findEnvironment, findFolderId, findFoldersWithName, findFolderWithId, findIntegrationInstance, findLocalChangeLogs, findLocalChangeLogs, findLocalChangeLogs, findLocalChangeLogs, findPackagesForChange, findPackagesForChange, findProjectId, findProjectsForChange, findProjectsForChange, findProjectsForNewBranch, findProjectsForNewBranch, findProjectsWithName, findProjectWithId, findStreamId, findWorkItemByNumber, getActiveBuildFlexfieldMetadata, getActiveDeployUtilityFlexfieldMetadata, getApprovedPipelineStageGateTasks, getChangeManagementSystemByInstanceCode, getChangeManagementSystemByInstanceId, getChangeManagementSystemByInstanceName, getCMSInstance, getCredentialById, getCredentialByName, getCurrentlyDeployedVersionId, getCurrentlyDeployedVersionId, getEndpointById, getEndpointByName, getEnvironment, getEnvironmentByCode, getEnvironmentById, getEnvironmentByName, getFlexDeployBaseUrl, getFlxWorkItemFieldGroupWithCode, getFlxWorkItemFieldWithId, getFlxWorkItemStatusWithId, getFlxWorkItemTypeWithCode, getGroovyKey, getGroupById, getGroupByName, getIntegrationInstance, getIssueTrackingSystemByInstanceCode, getIssueTrackingSystemByInstanceId, getIssueTrackingSystemByInstanceName, getMatchingProjectObjectId, getPackage, getPipelineStageGateTasks, getPluginLogInputStreams, getPluginLogInputStreams, getPluginLogs, getPreviouslyDeployedVersionId, getPreviouslyDeployedVersionId, getProject, getProjectBranchById, getProjectTriggerById, getProjectVersionById, getPropertyKeyDefinition, getPropertyKeyDefinition, getPropertySet, getReportDataByWorkflowExecutionReportId, getReportsByWorkflowExecutionId, getScanResultForSonarqube, getSnapshotDetails, getTargetGroupByCode, getTargetGroupById, getTargetGroupByName, getUser, getUserById, getUsersFromGroupId, getUsersFromGroupName, getWorkflowExecutionById, getWorkflowExecutionByWorkflowRequestId, getWorkflowExecutionCommits, getWorkflowExecutionFlexfields, getWorkflowExecutionInputs, getWorkflowExecutionOutputs, getWorkflowExecutionVariables, getWorkflowExecutionWorkItems, getWorkflowRequestTasks, getWorkItemFieldData, getWorkItemsForAllExecutions, getWorkItemsForFailedExecutions, getWorkItemsForSnapshotVersions, getWorkItemsForSuccessfulExecutions, getWorkItemStatus, getWorkItemStatuses, getWorkItemTypes, inactivateBranch, inactivateStream, isBotUsername, parseWorkItemRichText, patchBranch, patchCredential, patchEndpoint, patchEnvironment, patchFlxWorkItemField, patchFlxWorkItemFieldGroup, patchFolder, patchGroup, patchProject, patchProjectProperties, patchProjectTrigger, patchPropertyKeyDefinition, patchStream, patchTargetGroup, patchUser, patchWorkItem, patchWorkItemComment, populateFiles, saveFlxWorkItemFields, saveWorkItemFieldData, searchBranches, searchCredentials, searchEndpoints, searchEnvironments, searchFlxWorkItemFieldGroups, searchFlxWorkItemFields, searchFlxWorkItems, searchFlxWorkItemStatuses, searchFlxWorkItemTypes, searchFolders, searchGroups, searchProjectPackages, searchProjects, searchProjectTriggers, searchProjectVersions, searchPropertyKeyDefinitions, searchPropertySets, searchTargetGroups, searchUsers, unassignGroupFromUser, unassignGroupFromUser, updateBranch, updateCredential, updateEndpoint, updateEnvironment, updateFlxWorkItemField, updateFlxWorkItemFieldGroup, updateFolder, updateGroup, updatePackage, updatePackage, updatePackageStatus, updateProject, updateProjectProperties, updateProjectTrigger, updatePropertyKeyDefinition, updateScanResult, updateSCMInstance, updateSCMInstance, updateStream, updateTargetGroup, updateUser, updateWorkflowPropertySet, updateWorkItem, updateWorkItemAssignee, updateWorkItemStatus, updateWorkItemType

Methods inherited from class flexagon.fd.services.groovy.functions.BaseFunctions

decryptIntegrationInstance, doSimpleGet, findIntegrationInstanceByCode, getLogFunctions, getServerBaseUrl, setScriptRef

Methods inherited from class java.lang.Object

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

Constructor Detail

FlexDeployFunctions

public FlexDeployFunctions(boolean isExecute,
                           LogFunctions pFLOG)

Method Detail

getRelease

public ReleasePojo getRelease(java.lang.Long pId)

Gets a release by a specific id.

Parameters:

pId - Release Id

Returns:

Object containing Release metadata

Throws:

FlexDeployRowNotFoundException - if no Release is found for the given pId

Since:

5.3.0.1

findReleases

public java.util.List<ReleasePojo> findReleases(java.lang.String pName)
                                         throws FlexDeployRowNotFoundException

Finds Releases matching the specified name. Search uses an ignore case and contains on the Release Name. Unlike getRelease this method returns a list of Releases.

Parameters:

pName - Name to search by

Returns:

A List of Release objects containing Release information.

Throws:

FlexDeployRowNotFoundException - if no releases match the naming criteria pName

Since:

5.3.0.1

createRelease

public java.lang.Long createRelease(java.lang.String pReleaseName,
                                    java.lang.String pPipelineName,
                                    java.lang.String pDescription)
                             throws FlexCheckedException

Create an empty FlexDeploy Release that defaults to 'Not Started' status.

Parameters:

pReleaseName - Name to give Release.

pPipelineName - Pipeline name to use for the Release.

pDescription - Optional description to give the Release.

Returns:

Release id

Throws:

FlexDeployValidationException - when creation of release gets failed.

FlexCheckedException

createRelease

public java.lang.Long createRelease(java.lang.String pReleaseName,
                                    java.lang.String pPipelineName,
                                    java.lang.String pDescription,
                                    java.lang.String pCronSchedule)
                             throws FlexCheckedException

Create an empty scheduled FlexDeploy Release that defaults to 'Not Started' status.

Parameters:

pReleaseName - Name to give Release.

pPipelineName - Pipeline name to use for the Release.

pDescription - Optional description to give the Release.

pCronSchedule - Cron schedule to give the Release.

Returns:

Release id

Throws:

FlexDeployValidationException - when creation of release gets failed.

FlexCheckedException

endRelease

public void endRelease(java.lang.String pReleaseName)
                throws FlexCheckedException,
                       FlexNotFoundException

End a FlexDeploy Release.

Parameters:

pReleaseName - Release name to end.

Throws:

FlexNotFoundException - if Release is not found

FlexCheckedException

endRelease

public void endRelease(java.lang.Long pReleaseId)
                throws FlexCheckedException,
                       FlexNotFoundException

End a FlexDeploy Release.

Parameters:

pReleaseId - Release id to end.

Throws:

FlexNotFoundException - if Release is not found

FlexCheckedException

pauseRelease

public void pauseRelease(java.lang.String pReleaseName)
                  throws FlexCheckedException,
                         FlexNotFoundException

Pause a FlexDeploy Release.

Parameters:

pReleaseName - Release name to pause.

Throws:

FlexNotFoundException - if Release is not found

FlexCheckedException

Since:

5.3.0.2

pauseRelease

public void pauseRelease(java.lang.Long pReleaseId)
                  throws FlexCheckedException,
                         FlexNotFoundException

Pause a FlexDeploy Release.

Parameters:

pReleaseId - Release id to pause.

Throws:

FlexNotFoundException - if Release is not found

FlexCheckedException

Since:

5.3.0.2

startRelease

public void startRelease(java.lang.String pReleaseName)
                  throws FlexCheckedException,
                         FlexNotFoundException

Start a FlexDeploy Release.

Parameters:

pReleaseName - Release name to start.

Throws:

FlexNotFoundException - if Release is not found

FlexCheckedException

startRelease

public void startRelease(java.lang.Long pReleaseId)
                  throws FlexCheckedException,
                         FlexNotFoundException

Start a FlexDeploy Release.

Parameters:

pReleaseId - Release id to start.

Throws:

FlexNotFoundException - if Release is not found

FlexCheckedException

addProjectsToRelease

public void addProjectsToRelease(java.lang.String pReleaseName,
                                 java.util.List<ReleaseProjectsPojo> pReleaseProjects)
                          throws FlexCheckedException,
                                 FlexDeployRowNotFoundException

Add FlexDeploy projects to a given release.

Parameters:

pReleaseName - Release name to add projects to.

pReleaseProjects - List of ReleaseProjects to add.

Throws:

FlexCheckedException

FlexNotFoundException - if Release is not found

FlexDeployRowNotFoundException

removeProjectsFromRelease

public void removeProjectsFromRelease(java.lang.String pReleaseName,
                                      java.util.List<ReleaseProjectsPojo> pReleaseProjects)
                               throws FlexCheckedException,
                                      FlexDeployRowNotFoundException

Remove FlexDeploy projects from a given release.

Parameters:

pReleaseName - Release name to remove projects from.

pReleaseProjects - List of ReleaseProjects to remove.

Throws:

FlexCheckedException

FlexNotFoundException - if Release is not found

FlexDeployRowNotFoundException

createSnapshot

public java.lang.Long createSnapshot(java.lang.Long pReleaseId)
                              throws FlexCheckedException

Create a Snapshot for a given Release. The Release must be in a 'Started' state before a snapshot can be created.

Parameters:

pReleaseId - Release to create the snapshot for.

Returns:

Snapshot id

Throws:

FlexDeployValidationException - when failing to submit snapshot.

FlexCheckedException

approveTask

public void approveTask(java.lang.String pUsername,
                        java.lang.String pTaskIdentifier,
                        java.lang.String pNotes)
                 throws FlexCheckedException,
                        FlexNotFoundException

Approve a FlexDeploy Task. Approval, scheduled or human tasks are all compatible. When using this function the execution will run as the username that is passed. Due to this, precaution should be taken to be sure that only relevant users have access to edit the use of this method and/or view webhook payloads which contain the task identifier.

Parameters:

pUsername - Username to approve the task as, the user passed here needs permission to approve otherwise an error will occur. User must be in local realm.

pTaskIdentifier - Task identifier to approve. This identifier is only available in the TaskCreated webhook payload and is not visible from the UI.

pNotes - Optional notes to assign to the approval.

Throws:

FlexNotFoundException - If no task found for pTaskIdentifier.

FlexCheckedException.

FlexCheckedException

rejectTask

public void rejectTask(java.lang.String pUsername,
                       java.lang.String pTaskIdentifier,
                       java.lang.String pNotes)
                throws FlexCheckedException,
                       FlexNotFoundException

Reject a FlexDeploy Task. Approval, scheduled or human tasks are all compatible. When using this function the execution will run as the username that is passed. Due to this, precaution should be taken to be sure that only relevant users have access to edit the use of this method.

Parameters:

pUsername - Username to reject the task as, the user passed here needs permission to reject otherwise an error will occur. User must be in local realm.

pTaskIdentifier - Task identifier to approve. This identifier is only available in the TaskCreated webhook payload and is not visible from the UI.

pNotes - Optional notes to assign to the rejected task.

Throws:

FlexNotFoundException - If no task found forpTaskIdentifier.

FlexCheckedException

getReleaseProjectInfo

public java.util.List<ReleaseProjectDetailsPojo> getReleaseProjectInfo(java.lang.Long pReleaseDefId)

Gets release project info based on the release definition Id. Returns basic project info for the release with given Id.

Parameters:

pReleaseDefId - Release Definition Id.

Returns:

All Projects associated to the release.

Since:

5.4

getPipelineStageExecutionInfo

public StageExecutionInformationPOJO getPipelineStageExecutionInfo(java.lang.Long pStageExecId)

Gets pipeline stage execution info based on the stage exec Id given.

Parameters:

pStageExecId - Pipeline Stage Execution Id.

Returns:

Stage Execution Info.

Since:

5.4

getPipelineStepProjectsExecution

public StepProjectsRequestPojo getPipelineStepProjectsExecution(java.lang.Long pStageExecId,
                                                                java.lang.Long pStepId)

Get the project request and execution statuses for a given pipeline step execution

Parameters:

pStageExecId - The pipeline stage execution id

pStepid - The pipeline stage step id to get results for.

Returns:

An object containing step execution information and project requests

Since:

5.5.0.2

getPipelineStepProjectsExecution

public StepProjectsRequestPojo getPipelineStepProjectsExecution(java.lang.Long pStageExecId,
                                                                java.lang.String pStepName)

Get the project request and execution statuses for a given pipeline step execution

Parameters:

pStageExecId - The pipeline stage execution id

pStepName - The pipeline stage step name to get results for.

Returns:

An object containing step execution information and project requests

Since:

5.5.0.2

getUsersFromRoleId

public java.util.List<FDUser> getUsersFromRoleId(java.lang.Long pRoleId)

Gets a list of the users that are members of the pipeline role with the specified role Id.

Parameters:

pRoleId - Pipeline role id.

Returns:

List of FDUser objects.

Since:

5.4

getSnapshotCommitDetailInputStreams

public java.io.InputStream getSnapshotCommitDetailInputStreams(java.lang.Long pSnapshotId)

Gets the commit details of a snapshot and returns an input stream of the data.

Parameters:

pSnapshotId - - Id of the snapshot which details will be returned

Returns:

List of Input streams of the snapshot content details.

Since:

5.4.0.1

downloadSnapshotCommitDetails

public void downloadSnapshotCommitDetails(java.lang.Long pSnapshotId,
                                          java.lang.String pDestinationPath)

Gets the commit details of a snapshot and downloads a csv file to the destination path. File name will be SNAPSHOTID_SNAPSHOTNAME. SNAPSHOTNAME will have the time section removed in the file name.

Parameters:

pSnapshotId - - Id of the snapshot whose commit details will be returned.

pDestinationPath - - Path where the csv will be downloaded.

Throws:

FlexDeployValidationException - if pDestinationPath is not provided.

Since:

5.4.0.1

getSnapshotCommitDetails

public java.util.List<ReleaseSnapshotCommitDetailsPojo> getSnapshotCommitDetails(java.lang.Long pSnapshotId)

Gets the commit details of a snapshot and returns an object with the data.

Parameters:

pSnapshotId - - Id of the snapshot whose commit details will be returned.

Returns:

List of objects for each row of release snapshot content table for snapshot Id provided.

cleanup

public void cleanup()

Overrides:

cleanup in class FlexDeploy2Functions

updateReleaseProperty

public java.lang.Long updateReleaseProperty(java.lang.Long pReleaseDefId,
                                            java.lang.String pPropertyKeyCode,
                                            java.io.Serializable pNewValue)

Updates a release's property with the provided property key code.

Parameters:

pReleaseDefId - - Id of the release that has the property to be updated.

pPropertyKeyCode - - The code of the property that is to be updated.

pNewValue - - The value that the property will be updated to.

Returns:

- The Id of the release that has had it's property updated.

Since:

5.7.0.3

updateSnapshotVariable

public java.lang.Long updateSnapshotVariable(java.lang.Long pSnapshotId,
                                             java.lang.String pVariableCode,
                                             java.io.Serializable pNewValue)
                                      throws FlexCheckedException

Updates a snapshot's variable with the provided variable code.

Parameters:

pSnapshotId - - The id of the snapshot that has the variable to be updated.

pVariableCode - - The code of the variable that is to be updated.

pNewValue - - The value taht the property will be updated to.

Returns:

- The Id of the snapshot that has had it's property updated.

Throws:

FlexCheckedException

Since:

5.7.0.3

completeManualStepByTaskId

public void completeManualStepByTaskId(java.lang.String pUsername,
                                       java.lang.Long pTaskId)
                                throws FlexCheckedException,
                                       FlexNotFoundException

Completes a manual step Human task. When using the execution will run as the username that is passed.

Parameters:

pUsername - - Username to complete the task as.

pTaskId - - Task ID of the human task/manual step to complete.

Throws:

FlexNotFoundException - If no task is found for passed Id.

FlexCheckedException - All other exceptions.

Since:

5.7.0.4

completeManualStepBySnapshotId

public void completeManualStepBySnapshotId(java.lang.String pUsername,
                                           java.lang.Long pSnapshotId)
                                    throws FlexCheckedException,
                                           FlexNotFoundException

Completes a manual step Human task. When using the execution will run as the username that is passed.

Parameters:

pUsername - - Username to complete the task as.

pSnapshotId - - Snapshot Id which has a manual step waiting to be completed.

Throws:

FlexNotFoundException - If no task is found for passed Id.

FlexCheckedException - All other exceptions.

Since:

5.7.0.4