flexagon.fd.core.plugin

Class BasePluginExecutionContext

java.lang.Object

flexagon.fd.core.plugin.BasePluginExecutionContext

public abstract class BasePluginExecutionContext
extends java.lang.Object

Constructor Summary

Constructors

Constructor and Description
BasePluginExecutionContext()
BasePluginExecutionContext(WorkflowExecutionContext pWorkFlowExecutionContext)

Method Summary

Modifier and Type	Method and Description
java.lang.String	getArtifactsDirectory()
java.lang.Boolean	getBooleanCurrentInstancePropertyValue(java.lang.String pKey)
java.lang.Boolean	getBooleanCurrentInstancePropertyValueOrDefault(java.lang.String pKey, java.lang.Boolean pDefault)
java.lang.Boolean	getBooleanInput(java.lang.String pInputName) inputs are always expected to be filled in, so default anyway here.
boolean	getBooleanInputOrDefault(java.lang.String pInputName, java.lang.Boolean pDefault) if input not provided, which most likely won't happen then use default.
java.lang.Boolean	getBooleanInstancePropertyValue(java.lang.String pInstanceCode, java.lang.String pKey)
java.lang.Boolean	getBooleanInstancePropertyValueOrDefault(java.lang.String pInstanceCode, java.lang.String pKey, java.lang.Boolean pDefault)
java.lang.Boolean	getBooleanProjectPropertyValue(java.lang.String pKey)
java.lang.Boolean	getBooleanProjectPropertyValueOrDefault(java.lang.String pKey, java.lang.Boolean pDefault)
java.lang.String	getCurrentInstance()
java.lang.Object	getCurrentInstancePropertyValue(java.lang.String pKey) current target property value
java.lang.Object	getCurrentInstancePropertyValueOrDefault(java.lang.String pKey, java.lang.Object pDefault) current target property value or default if null
java.lang.Double	getDoubleCurrentInstancePropertyValue(java.lang.String pKey)
java.lang.Double	getDoubleCurrentInstancePropertyValueOrDefault(java.lang.String pKey, java.lang.Double pDefault)
java.lang.Double	getDoubleInput(java.lang.String pInputName)
java.lang.Double	getDoubleInputOrDefault(java.lang.String pInputName, java.lang.Double pDefault)
java.lang.Double	getDoubleInstancePropertyValue(java.lang.String pInstanceCode, java.lang.String pKey)
java.lang.Double	getDoubleInstancePropertyValueOrDefault(java.lang.String pInstanceCode, java.lang.String pKey, java.lang.Double pDefault)
java.lang.Double	getDoubleProjectPropertyValue(java.lang.String pKey)
java.lang.Double	getDoubleProjectPropertyValueOrDefault(java.lang.String pKey, java.lang.Double pDefault)
java.lang.Object	getInstancePropertyValue(java.lang.String pInstanceCode, java.lang.String pKey) instance property value
java.lang.Object	getInstancePropertyValueOrDefault(java.lang.String pInstanceCode, java.lang.String pKey, java.lang.Object pDefault) instance property value or default if null
java.lang.Integer	getIntegerCurrentInstancePropertyValue(java.lang.String pKey)
java.lang.Integer	getIntegerCurrentInstancePropertyValueOrDefault(java.lang.String pKey, java.lang.Integer pDefault)
java.lang.Integer	getIntegerInput(java.lang.String pInputName)
java.lang.Integer	getIntegerInputOrDefault(java.lang.String pInputName, java.lang.Integer pDefault)
java.lang.Integer	getIntegerInstancePropertyValue(java.lang.String pInstanceCode, java.lang.String pKey)
java.lang.Integer	getIntegerInstancePropertyValueOrDefault(java.lang.String pInstanceCode, java.lang.String pKey, java.lang.Integer pDefault)
java.lang.Integer	getIntegerProjectPropertyValue(java.lang.String pKey)
java.lang.Integer	getIntegerProjectPropertyValueOrDefault(java.lang.String pKey, java.lang.Integer pDefault)
java.lang.String	getInternalDirectory()
java.lang.Long	getLongCurrentInstancePropertyValue(java.lang.String pKey)
java.lang.Long	getLongCurrentInstancePropertyValueOrDefault(java.lang.String pKey, java.lang.Long pDefault)
java.lang.Long	getLongInput(java.lang.String pInputName)
java.lang.Long	getLongInputOrDefault(java.lang.String pInputName, java.lang.Long pDefault)
java.lang.Long	getLongInstancePropertyValue(java.lang.String pInstanceCode, java.lang.String pKey)
java.lang.Long	getLongInstancePropertyValueOrDefault(java.lang.String pInstanceCode, java.lang.String pKey, java.lang.Long pDefault)
java.lang.Long	getLongProjectPropertyValue(java.lang.String pKey)
java.lang.Long	getLongProjectPropertyValueOrDefault(java.lang.String pKey, java.lang.Long pDefault)
java.lang.Object	getProjectPropertyValue(java.lang.String pKey) project or project version property value.
java.lang.Object	getProjectPropertyValueOrDefault(java.lang.String pKey, java.lang.Object pDefault) project or project version property value or default if null
java.lang.String	getReportsDirectory()
java.lang.String	getScanResultsDirectory()
java.lang.String	getStringCurrentInstancePropertyValue(java.lang.String pKey)
java.lang.String	getStringCurrentInstancePropertyValueOrDefault(java.lang.String pKey, java.lang.String pDefault)
java.lang.String	getStringInput(java.lang.String pInputName)
java.lang.String	getStringInputOrDefault(java.lang.String pInputName, java.lang.String pDefault)
java.lang.String	getStringInstancePropertyValue(java.lang.String pInstanceCode, java.lang.String pKey)
java.lang.String	getStringInstancePropertyValueOrDefault(java.lang.String pInstanceCode, java.lang.String pKey, java.lang.String pDefault)
java.lang.String	getStringProjectPropertyValue(java.lang.String pKey)
java.lang.String	getStringProjectPropertyValueOrDefault(java.lang.String pKey, java.lang.String pDefault)
java.lang.String	getTempDirectory()
java.lang.String	getTestResultsDirectory()
java.lang.String	getTransferDirectory()
WorkflowExecutionContext	getWorkflowExecutionContext()
long	getWorkflowExecutionId()
java.lang.String	getWorkingDirectory()
boolean	isForceDeploy()
void	setOutputs(java.lang.String pName, java.lang.Object pValue, PropertyValue.PropertyTypeEnum pDataType)
void	validateContext(java.util.List<java.lang.String> pRequiredProperties, java.util.List<java.lang.String> pRequiredInputs)
void	validateContext(java.util.List<java.lang.String> pRequiredProperties, java.util.List<java.lang.String> pRequiredInputs, java.lang.String pValidateInstance)
void	validateRequiredInputs(java.util.List<java.lang.String> pRequiredInputs)
void	validateRequiredPropertiesForCurrentInstance(java.util.List<java.lang.String> pRequiredProperties)
void	validateRequiredPropertiesForInstance(java.util.List<java.lang.String> pRequiredProperties, java.lang.String pValidateInstance)

Methods inherited from class java.lang.Object

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

Constructor Detail

BasePluginExecutionContext

public BasePluginExecutionContext()

BasePluginExecutionContext

public BasePluginExecutionContext(WorkflowExecutionContext pWorkFlowExecutionContext)

Method Detail

validateContext

public void validateContext(java.util.List<java.lang.String> pRequiredProperties,
                            java.util.List<java.lang.String> pRequiredInputs)
                     throws FlexCheckedException

Throws:

FlexCheckedException

validateContext

public void validateContext(java.util.List<java.lang.String> pRequiredProperties,
                            java.util.List<java.lang.String> pRequiredInputs,
                            java.lang.String pValidateInstance)
                     throws FlexCheckedException

Throws:

FlexCheckedException

validateRequiredInputs

public void validateRequiredInputs(java.util.List<java.lang.String> pRequiredInputs)
                            throws FlexCheckedException

Throws:

FlexCheckedException

validateRequiredPropertiesForInstance

public void validateRequiredPropertiesForInstance(java.util.List<java.lang.String> pRequiredProperties,
                                                  java.lang.String pValidateInstance)
                                           throws FlexCheckedException

Throws:

FlexCheckedException

validateRequiredPropertiesForCurrentInstance

public void validateRequiredPropertiesForCurrentInstance(java.util.List<java.lang.String> pRequiredProperties)
                                                  throws FlexCheckedException

Throws:

FlexCheckedException

getCurrentInstance

public java.lang.String getCurrentInstance()

getWorkflowExecutionContext

public WorkflowExecutionContext getWorkflowExecutionContext()

getWorkingDirectory

public java.lang.String getWorkingDirectory()

getArtifactsDirectory

public java.lang.String getArtifactsDirectory()

getTempDirectory

public java.lang.String getTempDirectory()

getTestResultsDirectory

public java.lang.String getTestResultsDirectory()

getScanResultsDirectory

public java.lang.String getScanResultsDirectory()

getInternalDirectory

public java.lang.String getInternalDirectory()

getReportsDirectory

public java.lang.String getReportsDirectory()

getTransferDirectory

public java.lang.String getTransferDirectory()

getWorkflowExecutionId

public long getWorkflowExecutionId()

isForceDeploy

public boolean isForceDeploy()

setOutputs

public void setOutputs(java.lang.String pName,
                       java.lang.Object pValue,
                       PropertyValue.PropertyTypeEnum pDataType)

getBooleanInput

public java.lang.Boolean getBooleanInput(java.lang.String pInputName)

inputs are always expected to be filled in, so default anyway here.

Parameters:

pInputName - to get a boolean value from

Returns:

Boolean value of the input, which can't be null.

getBooleanInputOrDefault

public boolean getBooleanInputOrDefault(java.lang.String pInputName,
                                        java.lang.Boolean pDefault)

if input not provided, which most likely won't happen then use default. This is possible if an input was added and workflow was not updated.

Parameters:

pInputName - the name of the input to check

pDefault - the default to use if the input isn't set

Returns:

boolean which may be defaulted to pDefault

getDoubleInput

public java.lang.Double getDoubleInput(java.lang.String pInputName)

getDoubleInputOrDefault

public java.lang.Double getDoubleInputOrDefault(java.lang.String pInputName,
                                                java.lang.Double pDefault)

getStringInput

public java.lang.String getStringInput(java.lang.String pInputName)

getStringInputOrDefault

public java.lang.String getStringInputOrDefault(java.lang.String pInputName,
                                                java.lang.String pDefault)

getIntegerInput

public java.lang.Integer getIntegerInput(java.lang.String pInputName)

getIntegerInputOrDefault

public java.lang.Integer getIntegerInputOrDefault(java.lang.String pInputName,
                                                  java.lang.Integer pDefault)

getProjectPropertyValue

public java.lang.Object getProjectPropertyValue(java.lang.String pKey)

project or project version property value.

Parameters:

pKey -

Returns:

getProjectPropertyValueOrDefault

public java.lang.Object getProjectPropertyValueOrDefault(java.lang.String pKey,
                                                         java.lang.Object pDefault)

project or project version property value or default if null

Parameters:

pKey -

pDefault -

Returns:

getInstancePropertyValue

public java.lang.Object getInstancePropertyValue(java.lang.String pInstanceCode,
                                                 java.lang.String pKey)

instance property value

Parameters:

pInstanceCode -

pKey -

Returns:

object the value of the instance property

getInstancePropertyValueOrDefault

public java.lang.Object getInstancePropertyValueOrDefault(java.lang.String pInstanceCode,
                                                          java.lang.String pKey,
                                                          java.lang.Object pDefault)

instance property value or default if null

Parameters:

pInstanceCode -

pKey -

pDefault -

Returns:

object the value of the instance property, or the default

getCurrentInstancePropertyValue

public java.lang.Object getCurrentInstancePropertyValue(java.lang.String pKey)

current target property value

Parameters:

pKey -

Returns:

object the value of the property on the current target

getCurrentInstancePropertyValueOrDefault

public java.lang.Object getCurrentInstancePropertyValueOrDefault(java.lang.String pKey,
                                                                 java.lang.Object pDefault)

current target property value or default if null

Parameters:

pKey -

pDefault -

Returns:

getStringProjectPropertyValue

public java.lang.String getStringProjectPropertyValue(java.lang.String pKey)

getStringProjectPropertyValueOrDefault

public java.lang.String getStringProjectPropertyValueOrDefault(java.lang.String pKey,
                                                               java.lang.String pDefault)

getStringInstancePropertyValue

public java.lang.String getStringInstancePropertyValue(java.lang.String pInstanceCode,
                                                       java.lang.String pKey)

getStringInstancePropertyValueOrDefault

public java.lang.String getStringInstancePropertyValueOrDefault(java.lang.String pInstanceCode,
                                                                java.lang.String pKey,
                                                                java.lang.String pDefault)

getStringCurrentInstancePropertyValue

public java.lang.String getStringCurrentInstancePropertyValue(java.lang.String pKey)

getStringCurrentInstancePropertyValueOrDefault

public java.lang.String getStringCurrentInstancePropertyValueOrDefault(java.lang.String pKey,
                                                                       java.lang.String pDefault)

getDoubleProjectPropertyValue

public java.lang.Double getDoubleProjectPropertyValue(java.lang.String pKey)

getDoubleProjectPropertyValueOrDefault

public java.lang.Double getDoubleProjectPropertyValueOrDefault(java.lang.String pKey,
                                                               java.lang.Double pDefault)

getDoubleInstancePropertyValue

public java.lang.Double getDoubleInstancePropertyValue(java.lang.String pInstanceCode,
                                                       java.lang.String pKey)

getDoubleInstancePropertyValueOrDefault

public java.lang.Double getDoubleInstancePropertyValueOrDefault(java.lang.String pInstanceCode,
                                                                java.lang.String pKey,
                                                                java.lang.Double pDefault)

getDoubleCurrentInstancePropertyValue

public java.lang.Double getDoubleCurrentInstancePropertyValue(java.lang.String pKey)

getDoubleCurrentInstancePropertyValueOrDefault

public java.lang.Double getDoubleCurrentInstancePropertyValueOrDefault(java.lang.String pKey,
                                                                       java.lang.Double pDefault)

getIntegerProjectPropertyValue

public java.lang.Integer getIntegerProjectPropertyValue(java.lang.String pKey)

getIntegerProjectPropertyValueOrDefault

public java.lang.Integer getIntegerProjectPropertyValueOrDefault(java.lang.String pKey,
                                                                 java.lang.Integer pDefault)

getIntegerInstancePropertyValue

public java.lang.Integer getIntegerInstancePropertyValue(java.lang.String pInstanceCode,
                                                         java.lang.String pKey)

getIntegerInstancePropertyValueOrDefault

public java.lang.Integer getIntegerInstancePropertyValueOrDefault(java.lang.String pInstanceCode,
                                                                  java.lang.String pKey,
                                                                  java.lang.Integer pDefault)

getIntegerCurrentInstancePropertyValue

public java.lang.Integer getIntegerCurrentInstancePropertyValue(java.lang.String pKey)

getIntegerCurrentInstancePropertyValueOrDefault

public java.lang.Integer getIntegerCurrentInstancePropertyValueOrDefault(java.lang.String pKey,
                                                                         java.lang.Integer pDefault)

getBooleanProjectPropertyValue

public java.lang.Boolean getBooleanProjectPropertyValue(java.lang.String pKey)

getBooleanProjectPropertyValueOrDefault

public java.lang.Boolean getBooleanProjectPropertyValueOrDefault(java.lang.String pKey,
                                                                 java.lang.Boolean pDefault)

getBooleanInstancePropertyValue

public java.lang.Boolean getBooleanInstancePropertyValue(java.lang.String pInstanceCode,
                                                         java.lang.String pKey)

getBooleanInstancePropertyValueOrDefault

public java.lang.Boolean getBooleanInstancePropertyValueOrDefault(java.lang.String pInstanceCode,
                                                                  java.lang.String pKey,
                                                                  java.lang.Boolean pDefault)

getBooleanCurrentInstancePropertyValue

public java.lang.Boolean getBooleanCurrentInstancePropertyValue(java.lang.String pKey)

getBooleanCurrentInstancePropertyValueOrDefault

public java.lang.Boolean getBooleanCurrentInstancePropertyValueOrDefault(java.lang.String pKey,
                                                                         java.lang.Boolean pDefault)

getLongInput

public java.lang.Long getLongInput(java.lang.String pInputName)

getLongInputOrDefault

public java.lang.Long getLongInputOrDefault(java.lang.String pInputName,
                                            java.lang.Long pDefault)

getLongProjectPropertyValue

public java.lang.Long getLongProjectPropertyValue(java.lang.String pKey)

getLongProjectPropertyValueOrDefault

public java.lang.Long getLongProjectPropertyValueOrDefault(java.lang.String pKey,
                                                           java.lang.Long pDefault)

getLongInstancePropertyValue

public java.lang.Long getLongInstancePropertyValue(java.lang.String pInstanceCode,
                                                   java.lang.String pKey)

getLongInstancePropertyValueOrDefault

public java.lang.Long getLongInstancePropertyValueOrDefault(java.lang.String pInstanceCode,
                                                            java.lang.String pKey,
                                                            java.lang.Long pDefault)

getLongCurrentInstancePropertyValue

public java.lang.Long getLongCurrentInstancePropertyValue(java.lang.String pKey)

getLongCurrentInstancePropertyValueOrDefault

public java.lang.Long getLongCurrentInstancePropertyValueOrDefault(java.lang.String pKey,
                                                                   java.lang.Long pDefault)