public class WorkflowExecutionContext extends BasePOJO implements java.lang.Cloneable
Constructor and Description |
---|
WorkflowExecutionContext()
INTERNAL USE ONLY
|
WorkflowExecutionContext(Project pProject,
Environment pEnvironment,
Instance pInstance,
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
|
Modifier and Type | Method and Description |
---|---|
void |
addProperty(java.lang.String pKey,
java.lang.Object pValue,
DataTypeEnum pDataType,
boolean pIsEncrypted)
INTERNAL USE ONLY
|
void |
addProperty(java.lang.String pInstanceCode,
java.lang.String pKey,
java.lang.Object pValue,
DataTypeEnum pDataType,
boolean pIsEncrypted)
INTERNAL USE ONLY
|
java.lang.Object |
clone()
INTERNAL USE ONLY
|
void |
copyState(WorkflowExecutionContext pFrom) |
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 |
getBackupsDirectory()
Returns the backups directory of the target endpoint, which is used to store backup 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.
|
java.util.List<ScmCommit> |
getCommits()
Returns commits included in current execution.
|
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.util.List<ITSIssue> |
getIssues()
Returns all Issues included in the current execution.
|
java.lang.Long |
getLastEndPoint()
INTERNAL USE ONLY
|
Instance |
getMainInstance()
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<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 Target 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
|
Properties |
getProperties()
Returns the properties for the current workflow execution
|
java.util.Map<java.lang.String,PropertyDefinition> |
getPropertyDefinitions() |
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 Target property value.
|
java.lang.String |
getReportsDirectory()
Returns the reports directory of the target endpoint.
|
java.lang.String |
getScanResultsDirectory()
Returns the scan results directory of the target endpoint, which is used to store test results
produced by scan plugin operations.
|
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
|
WorkflowExecutionState |
getWorkflowExecutionState()
INTERNAL USE ONLY - this method will return null on Plugins
|
java.lang.Long |
getWorkflowRequestId()
Returns the workflow request id of the current execution.
|
java.lang.String |
getWorkflowType()
Returns the workflow type name
|
java.lang.String |
getWorkingDirectory()
Returns the working directory of the target endpoint.
|
boolean |
isBuildWorkflow() |
boolean |
isConsumesArtifacts() |
boolean |
isDeployOrPreDeployWorkflow() |
boolean |
isDeployOrUtilityWorkflow() |
boolean |
isDeployWorkflow() |
boolean |
isForceDeploy()
Returns whether "force deploy" was selected on the submit build/deploy request.
|
boolean |
isPostRefresh() |
boolean |
isPreDeployWorkflow() |
boolean |
isProducesArtifacts() |
boolean |
isSyncStateWorkflow() |
boolean |
isTestWorkflow() |
boolean |
isUtilityWorkflow() |
boolean |
isWindows() |
void |
setBaseInstallDirectory(java.lang.String pDirectory)
INTERNAL USE ONLY
|
void |
setCommits(java.util.List<ScmCommit> pCommits)
INTERNAL USE ONLY
|
void |
setConsumesArtifacts(boolean pConsumesArtifacts) |
void |
setEnvironment(Environment pEnvironment)
INTERNAL USE ONLY
|
void |
setForceDeploy(boolean pForceDeploy)
INTERNAL USE ONLY
|
void |
setInstance(Instance pInstance)
INTERNAL USE ONLY
|
void |
setIssues(java.util.List<ITSIssue> pIssues)
INTERNAL USE ONLY
|
void |
setLastEndPoint(java.lang.Long pLastEndPoint)
INTERNAL USE ONLY
|
void |
setMainInstance(Instance pMainInstance)
INTERNAL USE ONLY
|
void |
setOrginatingWorkflowExecutionId(java.lang.Long pOrginatingWorkflowExecutionId)
INTERNAL USE ONLY
|
void |
setOutput(java.lang.String pName,
java.lang.Object pValue,
DataTypeEnum pDataType)
INTERNAL USE ONLY
|
void |
setPackageObjects(java.util.List<PackageObject> pPackageObjects)
INTERNAL USE ONLY
|
void |
setPluginExecutionId(java.lang.Long pPluginExecutionId)
INTERNAL USE ONLY
|
void |
setPostRefresh(boolean pPostRefresh) |
void |
setProducesArtifacts(boolean pProducesArtifacts) |
void |
setProject(Project pProject)
INTERNAL USE ONLY
|
void |
setProperties(Properties pProperties)
INTERNAL USE ONLY
|
void |
setPropertyDefinitions(java.util.Map<java.lang.String,PropertyDefinition> pPropertyDefinitions)
INTERNAL USE ONLY
|
void |
setWorkflowExecutionId(java.lang.Long pWorkflowExecutionId)
INTERNAL USE ONLY
|
void |
setWorkflowRequestId(java.lang.Long pWorkflowRequestId)
INTERNAL USE ONLY
|
void |
setWorkflowType(java.lang.String pWorkflowType)
Sets the workflow type name
|
java.lang.String |
toString()
Returns custom String representation implemented by walking complete object structure.
|
public WorkflowExecutionContext(Project pProject, Environment pEnvironment, Instance pInstance, java.lang.Long pWorkflowRequestId, java.util.Map<java.lang.String,PropertyValue> pInputs)
public WorkflowExecutionContext()
public WorkflowExecutionContext(Project pProject, Environment pEnvironment, Instance pInstance, java.lang.Long pWorkflowRequestId, Properties pProperties)
public void copyState(WorkflowExecutionContext pFrom)
public java.lang.Object clone() throws java.lang.CloneNotSupportedException
clone
in class java.lang.Object
java.lang.CloneNotSupportedException
public WorkflowExecutionState getWorkflowExecutionState()
public void setWorkflowRequestId(java.lang.Long pWorkflowRequestId)
public java.lang.Long getWorkflowRequestId()
public void setOrginatingWorkflowExecutionId(java.lang.Long pOrginatingWorkflowExecutionId)
public java.lang.Long getOrginatingWorkflowExecutionId()
public void setPluginExecutionId(java.lang.Long pPluginExecutionId)
public java.lang.Long getPluginExecutionId()
public void setWorkflowType(java.lang.String pWorkflowType)
pWorkflowType
- public java.lang.String getWorkflowType()
public java.lang.Long getWorkflowExecutionId()
public void setWorkflowExecutionId(java.lang.Long pWorkflowExecutionId)
public void setProject(Project pProject)
public Project getProject()
public Environment getEnvironment()
public void setEnvironment(Environment pEnvironment)
public Instance getInstance()
public void setInstance(Instance pInstance)
public void setMainInstance(Instance pMainInstance)
public Instance getMainInstance()
public Properties getProperties()
public java.lang.Object getInput(java.lang.String pName)
pName
- the name of the inputpublic java.util.Map<java.lang.String,PropertyValue> getInputMap()
public void setProperties(Properties pProperties)
public java.lang.Object getPrintablePropertyValue(java.lang.String pKey)
pKey
- the key of the property to findpublic java.lang.Object getPropertyValue(java.lang.String pKey)
pKey
- the key of the property to findpublic java.lang.Object getPropertyValueOrDefault(java.lang.String pKey, java.lang.Object pDefault)
pKey
- the key of the property to findpDefault
- the default valuepublic java.lang.Object getPrintablePropertyValue(java.lang.String pInstanceCode, java.lang.String pKey)
pInstanceCode
- the instance codepKey
- the key of the property to findpublic java.lang.Object getPropertyValue(java.lang.String pInstanceCode, java.lang.String pKey)
pInstanceCode
- the instance codepKey
- the key of the property to findpublic java.lang.Object getPropertyValueOrDefault(java.lang.String pInstanceCode, java.lang.String pKey, java.lang.Object pDefault)
pInstanceCode
- the instance codepKey
- the key of the property to findpDefault
- the default valuepublic void addProperty(java.lang.String pKey, java.lang.Object pValue, DataTypeEnum pDataType, boolean pIsEncrypted)
public void addProperty(java.lang.String pInstanceCode, java.lang.String pKey, java.lang.Object pValue, DataTypeEnum pDataType, boolean pIsEncrypted)
public void setOutput(java.lang.String pName, java.lang.Object pValue, DataTypeEnum pDataType)
public java.util.Map<java.lang.String,PropertyValue> getOutputMap()
public java.lang.String getBaseWorkingDirectory()
public java.lang.String getWorkingDirectory()
[base working directory]/[project id]/[workflow execution id]
(e.g. /u01/flexdeploy/work/10009/12801)
public java.lang.String getInternalDirectory()
public java.lang.String getTempDirectory()
public java.lang.String getArtifactsDirectory()
public java.lang.String getBackupsDirectory()
public java.lang.String getTransferDirectory()
public java.lang.String getReportsDirectory()
public java.lang.String getTestResultsDirectory()
public java.lang.String getScanResultsDirectory()
public java.lang.String getObjectResultsDirectory()
public java.lang.String getProjectSourcesDirectory()
public java.lang.String getBaseInstallDirectory()
public void setBaseInstallDirectory(java.lang.String pDirectory)
public java.lang.String getInstallPluginsDirectory()
public java.lang.String getInstallPluginsDirectory(java.lang.String pluginName, java.lang.String pluginVersion)
[plugin installation directory]/[plugin name]/[plugin version]
pluginName
- the name of the pluginpluginVersion
- the plugin versionpublic void setLastEndPoint(java.lang.Long pLastEndPoint)
public java.lang.Long getLastEndPoint()
public void setForceDeploy(boolean pForceDeploy)
public boolean isForceDeploy()
public void setPackageObjects(java.util.List<PackageObject> pPackageObjects)
public java.util.List<PackageObject> getPackageObjects()
public java.lang.String toString()
BasePOJO
public boolean isWindows()
public void setPostRefresh(boolean pPostRefresh)
public boolean isPostRefresh()
public void setProducesArtifacts(boolean pProducesArtifacts)
public boolean isProducesArtifacts()
public void setConsumesArtifacts(boolean pConsumesArtifacts)
public boolean isConsumesArtifacts()
public boolean isBuildWorkflow()
public boolean isDeployWorkflow()
public boolean isSyncStateWorkflow()
public boolean isPreDeployWorkflow()
public boolean isUtilityWorkflow()
public boolean isTestWorkflow()
public boolean isDeployOrUtilityWorkflow()
public boolean isDeployOrPreDeployWorkflow()
public void setPropertyDefinitions(java.util.Map<java.lang.String,PropertyDefinition> pPropertyDefinitions)
public java.util.Map<java.lang.String,PropertyDefinition> getPropertyDefinitions()
public void setIssues(java.util.List<ITSIssue> pIssues)
public java.util.List<ITSIssue> getIssues()
public void setCommits(java.util.List<ScmCommit> pCommits)
public java.util.List<ScmCommit> getCommits()