Package flexagon.fd.core.utils

Class ContextObjectPropertyUtil

java.lang.Object
flexagon.fd.core.utils.ContextObjectPropertyUtil
public class ContextObjectPropertyUtil extends Object
A utility class to retrieve FlexDeploy properties as objects of their defined type from the WorkflowExecutionContext.
See Also:

  • Constructor Details

    • ContextObjectPropertyUtil

      public ContextObjectPropertyUtil(WorkflowExecutionContext pContext)
      Creates this utility for the give execution context.
      Parameters:
      pContext - the workflow execution context

  • Method Details

    • getWorkflowExecutionContext

      public WorkflowExecutionContext getWorkflowExecutionContext()
      Returns the workflow execution context for this utility instance.
      Returns:
      the workflow execution context

    • getProjectProperties

      public List<PropertyObjectValue> getProjectProperties()
      Returns the list of project-scoped properties from within the workflow execution context.
      Returns:
      a list of project-scoped properties

    • getInstanceProperties

      public List<PropertyObjectValue> getInstanceProperties(String pInstance, boolean pPrefixInstanceOnKey)

    • getCurrentInstanceProperties

      public List<PropertyObjectValue> getCurrentInstanceProperties(boolean pPrefixInstanceOnKey)
      Returns the list of properties defined within the current instance of the workflow execution context.
      Parameters:
      pPrefixInstanceOnKey - whether to return the instance name as a prefix on the property key
      Returns:
      the list of current instance-scoped properties

    • getAllInstanceProperties

      public List<PropertyObjectValue> getAllInstanceProperties()
      Returns the list of all FlexDeploy instance-scoped properties from the workflow execution context.
      Returns:
      the list instance-scoped properties

    • getMetaDataProperties

      public List<PropertyObjectValue> getMetaDataProperties()
      Returns a list of FlexDeploy defined properties containing information related to the workflow execution context. The properties returned include:

      • FD_BASE_WORKING_DIR
      • FD_WORKING_DIR
      • FD_ARTIFACTS_DIR
      • FD_TEMP_DIR
      • FD_REPORTS_DIR
      • FD_TEST_RESULTS_DIR
      • FD_OBJECT_RESULTS_DIR
      • FD_TRANSFER_DIR
      • FD_ENVIRONMENT_CODE
      • FD_ENVIRONMENT_NAME
      • FD_INSTANCE_CODE
      • FD_INSTANCE_NAME
      • FD_PROJECT_NAME


      Returns:
      the list of FlexDeploy defined properties

    • getInputs

      public List<PropertyObjectValue> getInputs()
      Returns the list of inputs within the workflow execution context for the current plugin execution.
      Returns:
      the list of inputs

    • getAllProperties

      public List<PropertyObjectValue> getAllProperties()
      Returns the list of FlexDeploy properties defined within the FlexDeploy context. Properties include:

      • Project-scoped properties for the current project
      • target properties for the current environment
      • Inputs for for the current plugin execution
      • FlexDeploy metadata properties (e.g. FD_PROJECT_NAME)


      Returns:
      List PropertyObjectValue all available properties