Package flexagon.fd.core.plugin

Class BasePluginExecutionContext

java.lang.Object
flexagon.fd.core.plugin.BasePluginExecutionContext
public abstract class BasePluginExecutionContext extends Object

  • Constructor Details

    • BasePluginExecutionContext

      public BasePluginExecutionContext()

    • BasePluginExecutionContext

      public BasePluginExecutionContext(WorkflowExecutionContext pWorkFlowExecutionContext)

  • Method Details

    • validateContext

      public void validateContext(List<String> pRequiredProperties, List<String> pRequiredInputs) throws FlexCheckedException
      Throws:
      FlexCheckedException

    • validateContext

      public void validateContext(List<String> pRequiredProperties, List<String> pRequiredInputs, String pValidateInstance) throws FlexCheckedException
      Throws:
      FlexCheckedException

    • validateRequiredInputs

      public void validateRequiredInputs(List<String> pRequiredInputs) throws FlexCheckedException
      Throws:
      FlexCheckedException

    • validateRequiredPropertiesForInstance

      public void validateRequiredPropertiesForInstance(List<String> pRequiredProperties, String pValidateInstance) throws FlexCheckedException
      Throws:
      FlexCheckedException

    • validateRequiredPropertiesForCurrentInstance

      public void validateRequiredPropertiesForCurrentInstance(List<String> pRequiredProperties) throws FlexCheckedException
      Throws:
      FlexCheckedException

    • getCurrentInstance

      public String getCurrentInstance()

    • getWorkflowExecutionContext

      public WorkflowExecutionContext getWorkflowExecutionContext()

    • getWorkingDirectory

      public String getWorkingDirectory()

    • getArtifactsDirectory

      public String getArtifactsDirectory()

    • getTempDirectory

      public String getTempDirectory()

    • getTestResultsDirectory

      public String getTestResultsDirectory()

    • getScanResultsDirectory

      public String getScanResultsDirectory()

    • getInternalDirectory

      public String getInternalDirectory()

    • getReportsDirectory

      public String getReportsDirectory()

    • getTransferDirectory

      public String getTransferDirectory()

    • getWorkflowExecutionId

      public long getWorkflowExecutionId()

    • isForceDeploy

      public boolean isForceDeploy()

    • setOutputs

      public void setOutputs(String pName, Object pValue, DataTypeEnum pDataType)

    • getBooleanInput

      public boolean getBooleanInput(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(String pInputName, 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 Double getDoubleInput(String pInputName)

    • getDoubleInputOrDefault

      public Double getDoubleInputOrDefault(String pInputName, Double pDefault)

    • getStringInput

      public String getStringInput(String pInputName)

    • getStringInputOrDefault

      public String getStringInputOrDefault(String pInputName, String pDefault)

    • getIntegerInput

      public Integer getIntegerInput(String pInputName)

    • getIntegerInputOrDefault

      public Integer getIntegerInputOrDefault(String pInputName, Integer pDefault)

    • getProjectPropertyValue

      public Object getProjectPropertyValue(String pKey)
      project or project version property value.

    • getProjectPropertyValueOrDefault

      public Object getProjectPropertyValueOrDefault(String pKey, Object pDefault)
      project or project version property value or default if null

    • getInstancePropertyValue

      public Object getInstancePropertyValue(String pInstanceCode, String pKey)
      instance property value
      Returns:
      object the value of the instance property

    • getInstancePropertyValueOrDefault

      public Object getInstancePropertyValueOrDefault(String pInstanceCode, String pKey, Object pDefault)
      instance property value or default if null
      Returns:
      object the value of the instance property, or the default

    • getCurrentInstancePropertyValue

      public Object getCurrentInstancePropertyValue(String pKey)
      current target property value
      Returns:
      object the value of the property on the current target

    • getCurrentInstancePropertyValueOrDefault

      public Object getCurrentInstancePropertyValueOrDefault(String pKey, Object pDefault)
      current target property value or default if null

    • getStringProjectPropertyValue

      public String getStringProjectPropertyValue(String pKey)

    • getStringProjectPropertyValueOrDefault

      public String getStringProjectPropertyValueOrDefault(String pKey, String pDefault)

    • getStringInstancePropertyValue

      public String getStringInstancePropertyValue(String pInstanceCode, String pKey)

    • getStringInstancePropertyValueOrDefault

      public String getStringInstancePropertyValueOrDefault(String pInstanceCode, String pKey, String pDefault)

    • getStringCurrentInstancePropertyValue

      public String getStringCurrentInstancePropertyValue(String pKey)

    • getStringCurrentInstancePropertyValueOrDefault

      public String getStringCurrentInstancePropertyValueOrDefault(String pKey, String pDefault)

    • getDoubleProjectPropertyValue

      public Double getDoubleProjectPropertyValue(String pKey)

    • getDoubleProjectPropertyValueOrDefault

      public Double getDoubleProjectPropertyValueOrDefault(String pKey, Double pDefault)

    • getDoubleInstancePropertyValue

      public Double getDoubleInstancePropertyValue(String pInstanceCode, String pKey)

    • getDoubleInstancePropertyValueOrDefault

      public Double getDoubleInstancePropertyValueOrDefault(String pInstanceCode, String pKey, Double pDefault)

    • getDoubleCurrentInstancePropertyValue

      public Double getDoubleCurrentInstancePropertyValue(String pKey)

    • getDoubleCurrentInstancePropertyValueOrDefault

      public Double getDoubleCurrentInstancePropertyValueOrDefault(String pKey, Double pDefault)

    • getIntegerProjectPropertyValue

      public Integer getIntegerProjectPropertyValue(String pKey)

    • getIntegerProjectPropertyValueOrDefault

      public Integer getIntegerProjectPropertyValueOrDefault(String pKey, Integer pDefault)

    • getIntegerInstancePropertyValue

      public Integer getIntegerInstancePropertyValue(String pInstanceCode, String pKey)

    • getIntegerInstancePropertyValueOrDefault

      public Integer getIntegerInstancePropertyValueOrDefault(String pInstanceCode, String pKey, Integer pDefault)

    • getIntegerCurrentInstancePropertyValue

      public Integer getIntegerCurrentInstancePropertyValue(String pKey)

    • getIntegerCurrentInstancePropertyValueOrDefault

      public Integer getIntegerCurrentInstancePropertyValueOrDefault(String pKey, Integer pDefault)

    • getBooleanProjectPropertyValue

      public Boolean getBooleanProjectPropertyValue(String pKey)

    • getBooleanProjectPropertyValueOrDefault

      public Boolean getBooleanProjectPropertyValueOrDefault(String pKey, Boolean pDefault)

    • getBooleanInstancePropertyValue

      public Boolean getBooleanInstancePropertyValue(String pInstanceCode, String pKey)

    • getBooleanInstancePropertyValueOrDefault

      public Boolean getBooleanInstancePropertyValueOrDefault(String pInstanceCode, String pKey, Boolean pDefault)

    • getBooleanCurrentInstancePropertyValue

      public Boolean getBooleanCurrentInstancePropertyValue(String pKey)

    • getBooleanCurrentInstancePropertyValueOrDefault

      public Boolean getBooleanCurrentInstancePropertyValueOrDefault(String pKey, Boolean pDefault)

    • getLongInput

      public Long getLongInput(String pInputName)

    • getLongInputOrDefault

      public Long getLongInputOrDefault(String pInputName, Long pDefault)

    • getLongProjectPropertyValue

      public Long getLongProjectPropertyValue(String pKey)

    • getLongProjectPropertyValueOrDefault

      public Long getLongProjectPropertyValueOrDefault(String pKey, Long pDefault)

    • getLongInstancePropertyValue

      public Long getLongInstancePropertyValue(String pInstanceCode, String pKey)

    • getLongInstancePropertyValueOrDefault

      public Long getLongInstancePropertyValueOrDefault(String pInstanceCode, String pKey, Long pDefault)

    • getLongCurrentInstancePropertyValue

      public Long getLongCurrentInstancePropertyValue(String pKey)

    • getLongCurrentInstancePropertyValueOrDefault

      public Long getLongCurrentInstancePropertyValueOrDefault(String pKey, Long pDefault)