flexagon.fd.services.groovy.functions

Class RestFunctions

java.lang.Object

flexagon.fd.services.groovy.functions.BaseFunctions

flexagon.fd.services.groovy.functions.RestFunctions

public class RestFunctions
extends BaseFunctions

Utility functions used for making REST calls

Since:

5.4

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	GROOVY_KEY

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

mExecute, mFLOG, mScriptRef

Constructor Summary

Constructors

Constructor and Description
RestFunctions()
RestFunctions(boolean b)
RestFunctions(boolean b, LogFunctions pLogFunctions)

Method Summary

Modifier and Type	Method and Description
void	cleanup()
int	forward(java.lang.String pUrl, java.lang.Object pPayload) Forwards a FlexDeploy Event via a POST request to another url, essentially making it a webhook.
FlexRESTClient	getClient() Returns a FlexRESTClient object which can be configured to make REST calls.
java.lang.String	getGroovyKey()

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

Field Detail

GROOVY_KEY

public static final java.lang.String GROOVY_KEY

See Also:

Constant Field Values

Constructor Detail

RestFunctions

public RestFunctions(boolean b,
                     LogFunctions pLogFunctions)

RestFunctions

public RestFunctions(boolean b)

RestFunctions

public RestFunctions()

Method Detail

forward

public int forward(java.lang.String pUrl,
                   java.lang.Object pPayload)
            throws FlexCheckedException

Forwards a FlexDeploy Event via a POST request to another url, essentially making it a webhook. No authentication will be used as is normal for a webhook. If you need to forward with authentication or a different method you can use getClient().

Parameters:

pUrl - The url to forward the request to.

pPayload - The payload to forward, typically just the EVENT variable.

Returns:

the response code of the REST call

Throws:

FlexCheckedException - if the request fails

getClient

public FlexRESTClient getClient()

Returns a FlexRESTClient object which can be configured to make REST calls.

Returns:

FlexRESTClient

getGroovyKey

public java.lang.String getGroovyKey()

Specified by:

getGroovyKey in class BaseFunctions

cleanup

public void cleanup()

Specified by:

cleanup in class BaseFunctions