flexagon.fd.services.groovy.functions

Class TopologyFunctions

java.lang.Object

flexagon.fd.services.groovy.functions.BaseFunctions

flexagon.fd.services.groovy.functions.TopologyFunctions

Direct Known Subclasses:

EnvironmentTopologyFunctions

public class TopologyFunctions
extends BaseFunctions

Field Summary

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

mExecute, mFLOG, mScriptRef

Constructor Summary

Constructors

Constructor and Description
TopologyFunctions()
TopologyFunctions(boolean isExecute)
TopologyFunctions(boolean isExecute, LogFunctions pLogFunctions)

Method Summary

Modifier and Type	Method and Description
void	cleanup() Cleanup.
EnvironmentDetails	getEnvironmentByCode(java.lang.String pEnvironmentCode) Returns Environment information for a given environment code.
EnvironmentDetails	getEnvironmentById(java.lang.Long pEnvironmentId) Returns Environment information for a given environment Id.
java.lang.String	getGroovyKey() Gets the groovy key.
java.util.Map<java.lang.String,java.lang.Object>	getInstanceProperties(java.lang.String pTargetGroupCode) Deprecated.
TargetGroup	getTargetGroupByCode(java.lang.String pTargetGroupCode) Get the TargetGroup based on TargetGroup code passed.
TargetGroup	getTargetGroupById(java.lang.Long pTargetGroupId) Get the TargetGroup based on TargetGroup id passed.
java.util.Map<java.lang.String,java.lang.Object>	getTargetGroupProperties(java.lang.String pTargetGroupCode) returns a Map containing all the properties for the integration account matching the passed target group code. Key of map is a property code and value is the primitive value for that property. e.g.

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

captureSecureValuesForLogFunction, decryptIntegrationInstance, doSimpleGet, findIntegrationInstanceByCode, getBinding, getLogFunctions, getServerBaseUrl, setBinding, setScriptRef

Methods inherited from class java.lang.Object

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

Constructor Detail

TopologyFunctions

public TopologyFunctions()

TopologyFunctions

public TopologyFunctions(boolean isExecute)

TopologyFunctions

public TopologyFunctions(boolean isExecute,
                         LogFunctions pLogFunctions)

Method Detail

getInstanceProperties

@Deprecated
public java.util.Map<java.lang.String,java.lang.Object> getInstanceProperties(java.lang.String pTargetGroupCode)

Deprecated.

getTargetGroupProperties

public java.util.Map<java.lang.String,java.lang.Object> getTargetGroupProperties(java.lang.String pTargetGroupCode)

returns a Map containing all the properties for the integration account matching the passed target group code.
Key of map is a property code and value is the primitive value for that property.
e.g. Git SCM Account [FDGIT_URL: https://github.com/flexagon9/flextest.git, FDGIT_USER: flexagon9, FDGIT_PASSWORD: password123, FDGIT_TIMEOUT: null]

Parameters:

pTargetGroupCode - InstanceCode of the instance properties you want

Returns:

Map of instance properties. Key is code, Value is property value.

getTargetGroupById

public TargetGroup getTargetGroupById(java.lang.Long pTargetGroupId)

Get the TargetGroup based on TargetGroup id passed.

Parameters:

pTargetGroupId - the target group id

Returns:

TargetGroupDataObject

Throws:

FlexDeployRowNotFoundException - If TargetGroup not found for given pTargetGroupId

getTargetGroupByCode

public TargetGroup getTargetGroupByCode(java.lang.String pTargetGroupCode)

Get the TargetGroup based on TargetGroup code passed.

Parameters:

pTargetGroupCode - the target group code

Returns:

TargetGroupDataObject

Throws:

FlexDeployRowNotFoundException - If TargetGroup not found for given pTargetGroupCode

getEnvironmentById

public EnvironmentDetails getEnvironmentById(java.lang.Long pEnvironmentId)

Returns Environment information for a given environment Id.

Parameters:

pEnvironmentId - Environment id of the Environment to retrieve

Returns:

Object containing metadata about the given Environment

Throws:

FlexDeployRowNotFoundException - If Environment not found for given pEnvironmentId

getEnvironmentByCode

public EnvironmentDetails getEnvironmentByCode(java.lang.String pEnvironmentCode)

Returns Environment information for a given environment code.

Parameters:

pEnvironmentCode - Environment code of the Environment to retrieve

Returns:

Object containing metadata about the given Environment

Throws:

FlexDeployRowNotFoundException - If Environment not found for given pEnvironmentCode

getGroovyKey

public java.lang.String getGroovyKey()

Gets the groovy key.

Specified by:

getGroovyKey in class BaseFunctions

Returns:

the groovy key

cleanup

public void cleanup()

Cleanup.

Specified by:

cleanup in class BaseFunctions