flexagon.fd.core.workflow

Class WorkflowExecutionContext

java.lang.Object

flexagon.ff.common.core.pojos.BasePOJO

flexagon.fd.core.workflow.WorkflowExecutionContext

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable

Direct Known Subclasses:

MockWorkflowExecutionContext

public class WorkflowExecutionContext
extends BasePOJO
implements java.lang.Cloneable

Represents context information related to the current plugin execution, such as the target environment and instance, properties, inputs, output, etc.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
WorkflowExecutionContext() INTERNAL USE ONLY
WorkflowExecutionContext(Project pProject, Environment pEnvironment, Instance pInstance, Instance pEndPointInstance, java.lang.Long pWorkflowRequestId, java.util.Map<java.lang.String,PropertyValue> pInputs) INTERNAL USE ONLY
WorkflowExecutionContext(Project pProject, Environment pEnvironment, Instance pInstance, java.lang.Long pWorkflowRequestId, Properties pProperties) INTERNAL USE ONLY

Method Summary

Methods

Modifier and Type	Method and Description
void	addProperty(java.lang.String pKey, java.lang.Object pValue, PropertyValue.PropertyTypeEnum pDataType, boolean pIsEncrypted) INTERNAL USE ONLY
void	addProperty(java.lang.String pInstanceCode, java.lang.String pKey, java.lang.Object pValue, PropertyValue.PropertyTypeEnum pDataType, boolean pIsEncrypted) INTERNAL USE ONLY
java.lang.Object	clone() INTERNAL USE ONLY
java.lang.String	getArtifactsDirectory() Returns the artifacts directory of the target endpoint, which is used to store artifacts produced or consumed by plugin operations.
java.lang.String	getBaseInstallDirectory() The base install directory is the directory defined by the "Base Working Directory" on the target endpoint.
java.lang.String	getBaseWorkingDirectory() Returns the base working directory of the target endpoint.
Environment	getEnvironment() Returns the target environment which the current workflow is executing in
java.lang.Object	getInput(java.lang.String pName) Returns the input with the given name as an Object.
java.util.Map<java.lang.String,PropertyValue>	getInputMap() Returns the inputs for the current workflow execution
java.lang.String	getInstallPluginsDirectory() Returns the plugin installation directory on the target endpoint.
java.lang.String	getInstallPluginsDirectory(java.lang.String pluginName, java.lang.String pluginVersion) Returns the plugin installation sub-directory for the given plugin name and plugin version.
Instance	getInstance() Returns the target instance which the current workflow is executing on
java.lang.String	getInternalDirectory() Returns the internal directory of the target endpoint, which is used to store temporary files generated by the plugin execution lifecycle and its plugins.
java.lang.Long	getLastEndPoint() INTERNAL USE ONLY
java.lang.String	getObjectResultsDirectory() Returns the object results directory of the target endpoint, which is used to store results produced by partial deployment plugin operations.
java.lang.Long	getOrginatingWorkflowExecutionId() Returns the workflow execution id of the current execution.
java.util.Map<java.lang.String,PropertyValue>	getOutputMap() Returns the map of Outputs.
java.util.List<flexagon.fd.core.partial.pojo.PackageObject>	getPackageObjects() INTERNAL USE ONLY
java.lang.Long	getPluginExecutionId() Returns the plugin execution id
java.lang.Object	getPrintablePropertyValue(java.lang.String pKey) Returns a project property value suitable for printing, in that encrypted values are masked.
java.lang.Object	getPrintablePropertyValue(java.lang.String pInstanceCode, java.lang.String pKey) Returns an environment instance property value for the given instance which is suitable for printing, in that encrypted values are masked.
Project	getProject() Returns the project which the current workflow execution is for
java.lang.String	getProjectSourcesDirectory() INTERNAL USE ONLY
Project.ProjectWFTypeEnum	getProjectWorkflowType() Returns the workflow type of the currently executing workflow
Properties	getProperties() Returns the properties for the current workflow execution
java.lang.Object	getPropertyValue(java.lang.String pKey) Returns a project property value.
java.lang.Object	getPropertyValue(java.lang.String pInstanceCode, java.lang.String pKey) Returns an environment property value for the given instance.
java.lang.Object	getPropertyValueOrDefault(java.lang.String pKey, java.lang.Object pDefault) Returns a project property value.
java.lang.Object	getPropertyValueOrDefault(java.lang.String pInstanceCode, java.lang.String pKey, java.lang.Object pDefault) Returns an environment instance property value.
java.lang.String	getReportsDirectory() Returns the reports directory of the target endpoint.
java.lang.String	getTempDirectory() Returns the temp directory of the target endpoint, which is used to store temporary files generated by the plugin executions.
java.lang.String	getTestResultsDirectory() Returns the test results directory of the target endpoint, which is used to store test results produced by test plugin operations.
java.lang.String	getTransferDirectory() Returns the transfer directory of the target endpoint, which used for sharing files between plugin operations within a single workflow.
java.lang.Long	getWorkflowExecutionId() Returns the id of the current workflow execution
java.lang.Long	getWorkflowRequestId() Returns the workflow request id of the current execution.
java.lang.String	getWorkingDirectory() Returns the working directory of the target endpoint.
boolean	isForceDeploy() Returns whether "force deploy" was selected on the submit build/deploy request.
boolean	isPostRefresh()
boolean	isWindows()
void	setBaseInstallDirectory(java.lang.String pDirectory) INTERNAL USE ONLY
void	setEnvironment(Environment pEnvironment) INTERNAL USE ONLY
void	setForceDeploy(boolean pForceDeploy) INTERNAL USE ONLY
void	setInstance(Instance pInstance) INTERNAL USE ONLY
void	setLastEndPoint(java.lang.Long pLastEndPoint) INTERNAL USE ONLY
void	setOrginatingWorkflowExecutionId(java.lang.Long pOrginatingWorkflowExecutionId) INTERNAL USE ONLY
void	setOutput(java.lang.String pName, java.lang.Object pValue, PropertyValue.PropertyTypeEnum pDataType) INTERNAL USE ONLY
void	setPackageObjects(java.util.List<flexagon.fd.core.partial.pojo.PackageObject> pPackageObjects) INTERNAL USE ONLY
void	setPluginExecutionId(java.lang.Long pPluginExecutionId) INTERNAL USE ONLY
void	setPostRefresh(boolean pPostRefresh)
void	setProject(Project pProject) INTERNAL USE ONLY
void	setProjectWorkflowType(Project.ProjectWFTypeEnum pProjectWorkflowType) INTERNAL USE ONLY
void	setProperties(Properties pProperties) INTERNAL USE ONLY
void	setWorkflowExecutionId(java.lang.Long pWorkflowExecutionId) INTERNAL USE ONLY
void	setWorkflowRequestId(java.lang.Long pWorkflowRequestId) INTERNAL USE ONLY
java.lang.String	toString() Returns custom String representation implemented by walking complete object structure.

Methods inherited from class flexagon.ff.common.core.pojos.BasePOJO

areEqual

Methods inherited from class java.lang.Object

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

Constructor Detail

WorkflowExecutionContext

public WorkflowExecutionContext(Project pProject,
                        Environment pEnvironment,
                        Instance pInstance,
                        Instance pEndPointInstance,
                        java.lang.Long pWorkflowRequestId,
                        java.util.Map<java.lang.String,PropertyValue> pInputs)

INTERNAL USE ONLY

WorkflowExecutionContext

public WorkflowExecutionContext()

INTERNAL USE ONLY

WorkflowExecutionContext

public WorkflowExecutionContext(Project pProject,
                        Environment pEnvironment,
                        Instance pInstance,
                        java.lang.Long pWorkflowRequestId,
                        Properties pProperties)

INTERNAL USE ONLY

Method Detail

clone

public java.lang.Object clone()
                       throws java.lang.CloneNotSupportedException

INTERNAL USE ONLY

Overrides:

clone in class java.lang.Object

Throws:

java.lang.CloneNotSupportedException

setWorkflowRequestId

public void setWorkflowRequestId(java.lang.Long pWorkflowRequestId)

INTERNAL USE ONLY

getWorkflowRequestId

public java.lang.Long getWorkflowRequestId()

Returns the workflow request id of the current execution.

Returns:

the workflow request id

setOrginatingWorkflowExecutionId

public void setOrginatingWorkflowExecutionId(java.lang.Long pOrginatingWorkflowExecutionId)

INTERNAL USE ONLY

getOrginatingWorkflowExecutionId

public java.lang.Long getOrginatingWorkflowExecutionId()

Returns the workflow execution id of the current execution. If workflow is a child workflow, the execution id is that of the parent rather than the child.

Returns:

the originating workflow execution id

setPluginExecutionId

public void setPluginExecutionId(java.lang.Long pPluginExecutionId)

INTERNAL USE ONLY

getPluginExecutionId

public java.lang.Long getPluginExecutionId()

Returns the plugin execution id

Returns:

the plugin execution id

setProjectWorkflowType

public void setProjectWorkflowType(Project.ProjectWFTypeEnum pProjectWorkflowType)

INTERNAL USE ONLY

getProjectWorkflowType

public Project.ProjectWFTypeEnum getProjectWorkflowType()

Returns the workflow type of the currently executing workflow

Returns:

the workflow type

getWorkflowExecutionId

public java.lang.Long getWorkflowExecutionId()

Returns the id of the current workflow execution

Returns:

the workflow execution id

setWorkflowExecutionId

public void setWorkflowExecutionId(java.lang.Long pWorkflowExecutionId)

INTERNAL USE ONLY

setProject

public void setProject(Project pProject)

INTERNAL USE ONLY

getProject

public Project getProject()

Returns the project which the current workflow execution is for

Returns:

the project

getEnvironment

public Environment getEnvironment()

Returns the target environment which the current workflow is executing in

Returns:

the environment

setEnvironment

public void setEnvironment(Environment pEnvironment)

INTERNAL USE ONLY

getInstance

public Instance getInstance()

Returns the target instance which the current workflow is executing on

Returns:

the instance

setInstance

public void setInstance(Instance pInstance)

INTERNAL USE ONLY

getProperties

public Properties getProperties()

Returns the properties for the current workflow execution

Returns:

the properties for the current workflow execution

getInput

public java.lang.Object getInput(java.lang.String pName)

Returns the input with the given name as an Object. Returns null if the input is not found.

Parameters:

pName - the name of the input

Returns:

the input object

getInputMap

public java.util.Map<java.lang.String,PropertyValue> getInputMap()

Returns the inputs for the current workflow execution

Returns:

a Map of all inputs for the current execution

setProperties

public void setProperties(Properties pProperties)

INTERNAL USE ONLY

getPrintablePropertyValue

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

Returns a project property value suitable for printing, in that encrypted values are masked.

Parameters:

pKey - the key of the property to find

Returns:

the project property value

getPropertyValue

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

Returns a project property value. WARNING: Values of encrypted properties are not masked.

Parameters:

pKey - the key of the property to find

Returns:

the project property value

getPropertyValueOrDefault

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

Returns a project property value. If value is not set, pDefault will be returned. WARNING: Values of encrypted properties are not masked.

Parameters:

pKey - the key of the property to find

pDefault - the default value

Returns:

the project property value

getPrintablePropertyValue

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

Returns an environment instance property value for the given instance which is suitable for printing, in that encrypted values are masked.

Parameters:

pInstanceCode - the instance code

pKey - the key of the property to find

Returns:

the environment instance property value

getPropertyValue

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

Returns an environment property value for the given instance. WARNING: Values of encrypted properties are not masked.

Parameters:

pInstanceCode - the instance code

pKey - the key of the property to find

Returns:

the environment instance property value

getPropertyValueOrDefault

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

Returns an environment instance property value. If value is not set, pDefault will be returned. WARNING: Values of encrypted properties are not masked.

Parameters:

pInstanceCode - the instance code

pKey - the key of the property to find

pDefault - the default value

Returns:

the environment instance property value

addProperty

public void addProperty(java.lang.String pKey,
               java.lang.Object pValue,
               PropertyValue.PropertyTypeEnum pDataType,
               boolean pIsEncrypted)

INTERNAL USE ONLY

addProperty

public void addProperty(java.lang.String pInstanceCode,
               java.lang.String pKey,
               java.lang.Object pValue,
               PropertyValue.PropertyTypeEnum pDataType,
               boolean pIsEncrypted)

INTERNAL USE ONLY

setOutput

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

INTERNAL USE ONLY

getOutputMap

public java.util.Map<java.lang.String,PropertyValue> getOutputMap()

Returns the map of Outputs.

Returns:

the outputs

getBaseWorkingDirectory

public java.lang.String getBaseWorkingDirectory()

Returns the base working directory of the target endpoint. The base working directory is located in the "work" subdirectory of the base install directory of the endpoint.

Returns:

the base working directory

getWorkingDirectory

public java.lang.String getWorkingDirectory()

Returns the working directory of the target endpoint. The working directory is generated uniquely within the base working directory, and has the following structure:

     [base working directory]/[project id]/[workflow execution id] 

     (e.g. /u01/flexdeploy/work/10009/12801) 

Returns:

the working directory

getInternalDirectory

public java.lang.String getInternalDirectory()

Returns the internal directory of the target endpoint, which is used to store temporary files generated by the plugin execution lifecycle and its plugins. The internal directory is located in the "internal" sub-folder of the working directory.

Returns:

the internal directory

getTempDirectory

public java.lang.String getTempDirectory()

Returns the temp directory of the target endpoint, which is used to store temporary files generated by the plugin executions. The temp directory is located in the "temp" sub-folder of the working directory.

Returns:

the temp directory

getArtifactsDirectory

public java.lang.String getArtifactsDirectory()

Returns the artifacts directory of the target endpoint, which is used to store artifacts produced or consumed by plugin operations. The artifacts directory is located in the "artifacts" sub-folder of the working directory.

Returns:

the artifacts directory

getTransferDirectory

public java.lang.String getTransferDirectory()

Returns the transfer directory of the target endpoint, which used for sharing files between plugin operations within a single workflow. The transfer directory is located in the "transfer" sub-folder of the working directory.

Returns:

the artifacts directory

getReportsDirectory

public java.lang.String getReportsDirectory()

Returns the reports directory of the target endpoint. The reports directory is located in the "reports" sub-folder of the working directory. RESERVED FOR FUTURE USE.

Returns:

the reports directory

getTestResultsDirectory

public java.lang.String getTestResultsDirectory()

Returns the test results directory of the target endpoint, which is used to store test results produced by test plugin operations. The test results directory is located in the "test-results" sub-folder of the working directory.

Returns:

the test results directory

getObjectResultsDirectory

public java.lang.String getObjectResultsDirectory()

Returns the object results directory of the target endpoint, which is used to store results produced by partial deployment plugin operations. The object results directory is located in the "object-results" sub-folder of the working directory.

Returns:

the object results directory

getProjectSourcesDirectory

public java.lang.String getProjectSourcesDirectory()

INTERNAL USE ONLY

getBaseInstallDirectory

public java.lang.String getBaseInstallDirectory()

The base install directory is the directory defined by the "Base Working Directory" on the target endpoint.

setBaseInstallDirectory

public void setBaseInstallDirectory(java.lang.String pDirectory)

INTERNAL USE ONLY

getInstallPluginsDirectory

public java.lang.String getInstallPluginsDirectory()

Returns the plugin installation directory on the target endpoint. The plugin installation directory is located in the "plugins" subdirectory of the base install directory on the endpoint.

Returns:

the plugin installation directory

getInstallPluginsDirectory

public java.lang.String getInstallPluginsDirectory(java.lang.String pluginName,
                                          java.lang.String pluginVersion)

Returns the plugin installation sub-directory for the given plugin name and plugin version. This directory is located in the following path on the endpoint:

   [plugin installation directory]/[plugin name]/[plugin version] 

Parameters:

pluginName - the name of the plugin

pluginVersion - the plugin version

Returns:

the plugin installation directory for a specific plugin name and version

setLastEndPoint

public void setLastEndPoint(java.lang.Long pLastEndPoint)

INTERNAL USE ONLY

getLastEndPoint

public java.lang.Long getLastEndPoint()

INTERNAL USE ONLY

setForceDeploy

public void setForceDeploy(boolean pForceDeploy)

INTERNAL USE ONLY

isForceDeploy

public boolean isForceDeploy()

Returns whether "force deploy" was selected on the submit build/deploy request.

Returns:

whether force deploy was selected for this request

setPackageObjects

public void setPackageObjects(java.util.List<flexagon.fd.core.partial.pojo.PackageObject> pPackageObjects)

INTERNAL USE ONLY

getPackageObjects

public java.util.List<flexagon.fd.core.partial.pojo.PackageObject> getPackageObjects()

INTERNAL USE ONLY

toString

public java.lang.String toString()

Description copied from class: BasePOJO

Returns custom String representation implemented by walking complete object structure.

Overrides:

toString in class BasePOJO

Returns:

a String representation of this object

isWindows

public boolean isWindows()

setPostRefresh

public void setPostRefresh(boolean pPostRefresh)

isPostRefresh

public boolean isPostRefresh()