flexagon.fd.services.groovy.functions

Class BitbucketFunctions

java.lang.Object

flexagon.fd.services.groovy.functions.BaseFunctions

flexagon.fd.services.groovy.functions.GitProviderFunctions

flexagon.fd.services.groovy.functions.BitbucketFunctions

public class BitbucketFunctions
extends GitProviderFunctions

Utility functions used to get information from a Bitbucket payload

Since:

5.3

Field Summary

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

mExecute, mFLOG, mScriptRef

Constructor Summary

Constructors

Constructor and Description
BitbucketFunctions(boolean isExecute, LogFunctions pFLOG)

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 pBitbucketUser, java.lang.String pBitbucketPassword) Build Packages using the given projectId and/or packageName in the query parameters or finding packages 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 pBitbucketUser, java.lang.String pBitbucketPassword) 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 pBitbucketUser, java.lang.String pBitbucketPassword) Finds FlexDeploy change logs from a Bitbucket payload.
PollingResult	getChangeLogs(java.lang.Object pPayload, java.lang.String pBitbucketUser, java.lang.String pBitbucketPassword, boolean pIgnoreTargetBranchMerge) Finds FlexDeploy change logs from a Bitbucket 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

BitbucketFunctions

public BitbucketFunctions(boolean isExecute,
                          LogFunctions pFLOG)

Method Detail

getChangeLogs

public PollingResult getChangeLogs(java.lang.Object pPayload,
                                   java.lang.String pBitbucketUser,
                                   java.lang.String pBitbucketPassword)
                            throws FlexCheckedException

Finds FlexDeploy change logs from a Bitbucket payload. Return object can be passed to other FlexDeploy functions to improve performance. Bitbucket does not send changed files in the push event, but that information is available via the diffstat api. This function will use that api and as such requires a valid user/password to make the api call.

Parameters:

pPayload - JSON payload from a Bitbucket push event. This MUST be the push event payload

pBitbucketUser - Valid Bitbucket user to make api calls with

pBitbucketPassword - Bitbucket password

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 pBitbucketUser,
                                   java.lang.String pBitbucketPassword,
                                   boolean pIgnoreTargetBranchMerge)
                            throws FlexCheckedException

Finds FlexDeploy change logs from a Bitbucket payload. Return object can be passed to other FlexDeploy functions to improve performance. Bitbucket does not send changed files in the push event, but that information is available via the diffstat api. This function will use that api and as such requires a valid user/password to make the api call.

Parameters:

pPayload - JSON payload from a Bitbucket push event. This MUST be the push event payload

pBitbucketUser - Valid Bitbucket user to make api calls with

pBitbucketPassword - Bitbucket password

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 pBitbucketUser,
                          java.lang.String pBitbucketPassword)
                   throws FlexCheckedException

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

Parameters:

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

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

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

pBitbucketUser - Valid Bitbucket user to make api calls with

pBitbucketPassword - Bitbucket password

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 pBitbucketUser,
                          java.lang.String pBitbucketPassword)
                   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 Bitbucket push event. This MUST be the push event payload

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

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

pBitbucketUser - Valid Bitbucket user to make api calls with

pBitbucketPassword - Bitbucket password

Throws:

FlexCheckedException

getGroovyKey

public java.lang.String getGroovyKey()

Specified by:

getGroovyKey in class BaseFunctions