flexagon.fd.services.groovy.functions

Class AzureFunctions

java.lang.Object

flexagon.fd.services.groovy.functions.BaseFunctions

flexagon.fd.services.groovy.functions.GitProviderFunctions

flexagon.fd.services.groovy.functions.AzureFunctions

public class AzureFunctions
extends GitProviderFunctions

Utility functions used to get information from an Azure Git payload

Since:

5.4.0.4

Field Summary

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

mExecute, mFLOG, mScriptRef

Constructor Summary

Constructors

Constructor and Description
AzureFunctions(boolean isExecute, LogFunctions pLogFunctions)

Method Summary

Modifier and Type	Method and Description
void	buildPackages(java.lang.Object pPayload, java.util.Map<java.lang.String,java.lang.String> pQueryParameters, java.lang.Boolean pCreateStreams, java.lang.String pAzureUser, java.lang.String pAzureToken) Build Packages using the given projectId and/or packageName in the query parameters or finding projects to build from the payload.
void	buildProjects(java.lang.Object pPayload, java.util.Map<java.lang.String,java.lang.String> pQueryParameters, java.lang.Boolean pCreateStreams, java.lang.String pAzureUser, java.lang.String pAzureToken) Build Projects using the given projectId in the query parameters or finding projects to build from the payload.
PollingResult	getChangeLogs(java.lang.Object pPayload, java.lang.String pUser, java.lang.String pToken) Finds FlexDeploy change logs from an Azure Git payload.
PollingResult	getChangeLogs(java.lang.Object pPayload, java.lang.String pUser, java.lang.String pToken, boolean pIgnoreTargetBranchMerge) Finds FlexDeploy change logs from an Azure Git payload.
java.lang.String	getGroovyKey()

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

buildPackages, buildProjects, cleanup, getFlexDeployFunctions, getJsonObjectFromPayload, getOrCreateBranchId

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

captureSecureValuesForLogFunction, 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

AzureFunctions

public AzureFunctions(boolean isExecute,
                      LogFunctions pLogFunctions)

Method Detail

getChangeLogs

public PollingResult getChangeLogs(java.lang.Object pPayload,
                                   java.lang.String pUser,
                                   java.lang.String pToken)
                            throws FlexCheckedException

Finds FlexDeploy change logs from an Azure Git payload. Return object can be passed to other FlexDeploy functions to improve performance. Azure does not send changed files in the push event, but that information is available via their commits api. This function will use that api and as such requires a valid user and personal access token to make the api call.

Parameters:

pPayload - JSON payload from an Azure Git push event. This MUST be the push event payload

pUser - Azure user to make api calls with

pToken - Azure access token to make api calls with

Returns:

A PollingResult object containing information such as change logs, revisions and committer

Throws:

FlexCheckedException

getChangeLogs

public PollingResult getChangeLogs(java.lang.Object pPayload,
                                   java.lang.String pUser,
                                   java.lang.String pToken,
                                   boolean pIgnoreTargetBranchMerge)
                            throws FlexCheckedException

Finds FlexDeploy change logs from an Azure Git payload. Return object can be passed to other FlexDeploy functions to improve performance. Azure does not send changed files in the push event, but that information is available via their commits api. This function will use that api and as such requires a valid user and personal access token to make the api call.

Parameters:

pPayload - JSON payload from an Azure Git push event. This MUST be the push event payload

pUser - Azure user to make api calls with

pToken - Azure access token to make api calls with

pIgnoreTargetBranchMerge - Exclude commits that were merged from the target branch into this branch. When using git flow this will ignore merges done from the target branch 'develop' into your feature branch. Default value is true

Returns:

A PollingResult object containing information such as change logs, revisions and committer

Throws:

FlexCheckedException

buildPackages

public void buildPackages(java.lang.Object pPayload,
                          java.util.Map<java.lang.String,java.lang.String> pQueryParameters,
                          java.lang.Boolean pCreateStreams,
                          java.lang.String pAzureUser,
                          java.lang.String pAzureToken)
                   throws FlexCheckedException

Build Packages using the given projectId and/or packageName in the query parameters or finding projects to build from the payload.

Parameters:

pPayload - Json payload from Azure push event. This MUST be the push event payload

pQueryParameters - Query Parameters from Azure push event. This must be the push event payload.

pCreateStreams - Should streams be created if not found on the projects?

pAzureUser - Azure username

pAzureToken - Azure token

Throws:

FlexCheckedException

buildProjects

public void buildProjects(java.lang.Object pPayload,
                          java.util.Map<java.lang.String,java.lang.String> pQueryParameters,
                          java.lang.Boolean pCreateStreams,
                          java.lang.String pAzureUser,
                          java.lang.String pAzureToken)
                   throws FlexCheckedException

Build Projects using the given projectId in the query parameters or finding projects to build from the payload.

Parameters:

pPayload - Json payload from Azure push event. This MUST be the push event payload

pQueryParameters - Query Parameters from Azure push event. This must be the push event payload.

pCreateStreams - Should streams be created if not found on the projects?

pAzureUser - Azure username

pAzureToken - Azure token

Throws:

FlexCheckedException

getGroovyKey

public java.lang.String getGroovyKey()

Specified by:

getGroovyKey in class BaseFunctions