flexagon.fd.model2.pipeline.execution.variables

Class PipelineStageExecutionInfo

java.lang.Object

flexagon.fd.model2.pipeline.execution.variables.PipelineStageExecutionInfo

public class PipelineStageExecutionInfo
extends java.lang.Object

This pojo is passed in to pipeline groovy script as stgexecinfo variable. This can be used to read details as entered by user on Stage Execution Info screen.

Constructor Summary

Constructors

Constructor and Description
PipelineStageExecutionInfo(ExecutionData pStageExecData, java.util.List<ReleaseProjectVersion> pReleaseProjectVersionList) Do not store AM on instance variables, just use it to get details we need.

Method Summary

Modifier and Type	Method and Description
ExecutionData	getExecutionData() Gets the execution data.
java.util.Map<java.lang.String,java.util.List<java.io.Serializable>>	getFlexFieldMap(java.lang.Long pProjectId) returns a map of flex field values for the given project id.
java.util.Map<java.lang.String,java.util.List<java.io.Serializable>>	getFlexFieldMap(java.lang.Long pProjectId, java.lang.String pPackageName) returns a map of flex field values for the given project id and package name.
java.util.Map<java.lang.String,java.util.List<java.io.Serializable>>	getFlexFieldMap(java.lang.String pProjectName) returns a map of flex field values for the given project name.
java.util.Map<java.lang.String,java.util.List<java.io.Serializable>>	getFlexFieldMap(java.lang.String pProjectName, java.lang.String pPackageName) returns a map of flex field values for the given project name and package name.
java.util.List<java.io.Serializable>	getFlexFields(java.lang.String pCode) returns list of flex field values for code irrespective of project.
java.util.List<java.lang.String>	getInstanceOverride(java.lang.Long pProjectId) Returns List of target group codes configured as overrides based on Project Id.
java.util.List<java.lang.String>	getInstanceOverride(java.lang.Long pProjectId, java.lang.String pPackageName) Returns List of target group codes configured as overrides based on Project Id and Package Name.
java.lang.String	getRelatedTicket() returns related ticket associated to the stage.
java.lang.String	getRelatedTicket(java.lang.Long pProjectId) returns related ticket associated to snapshot project or the stage.
java.lang.String	getRelatedTicket(java.lang.Long pProjectId, java.lang.String pPackageName) returns related ticket associated to the snapshot project and package.
java.util.Map<java.lang.String,java.util.List<java.io.Serializable>>	getWorkflowInputMap(java.lang.Long pProjectId) returns a map of deploy workflow input values for the given project id.
java.util.Map<java.lang.String,java.util.List<java.io.Serializable>>	getWorkflowInputMap(java.lang.Long pProjectId, java.lang.String pPackageName) returns a map of deploy workflow input values for the given project id and package name.
java.util.Map<java.lang.String,java.util.List<java.io.Serializable>>	getWorkflowInputMap(java.lang.String pProjectName) returns a map of deploy workflow input values for the given project name.
java.util.Map<java.lang.String,java.util.List<java.io.Serializable>>	getWorkflowInputMap(java.lang.String pProjectName, java.lang.String pPackageName) returns a map of deploy workflow input values for the given project name and package name.
java.util.List<java.io.Serializable>	getWorkflowInputs(java.lang.String pName) returns list of workflow deploy workflow inputs for input name irrespective of project.
boolean	isExecDataValid() Checks if is exec data valid.
boolean	isExternaApprovalGateCompleted() Checks if is externa approval gate completed.
boolean	isModified() Checks if is modified.
boolean	isStageExecReleaseProjectsValid() Checks if is stage exec release projects valid.
boolean	isTicketExistForAllProjects() Checks if is ticket exist for all projects.
boolean	isUserForceDeploy(java.lang.Long pProjectId) returns true if the deploy override option is Force for the snapshot project on the stage.
boolean	isUserForceDeploy(java.lang.Long pProjectId, java.lang.String pPackageName) returns true if the deploy override option is Force for the snapshot project and package on the stage.
boolean	isUserNoOverride(java.lang.Long pProjectId) returns true if the deploy override option is No Override for the snapshot project on the stage.
boolean	isUserNoOverride(java.lang.Long pProjectId, java.lang.String pPackageName) returns true if the deploy override option is No Override for the snapshot project and package on the stage.
boolean	isUserSkipDeploy(java.lang.Long pProjectId) returns true if the deploy override option is Skip for the snapshot project on the stage.
boolean	isUserSkipDeploy(java.lang.Long pProjectId, java.lang.String pPackageName) returns true if the deploy override option is Skip for the snapshot project and package on the stage.
java.util.List<CMSObject>	prepareCMSObjectListFromExecutionData(java.lang.String pRelatedTicket) Prepare CMS object list from execution data.
void	setDeployOverride(java.lang.Long pProjectId, java.lang.String pOverrideName) Sets the deploy override.
void	setExternaApprovalGateCompleted(boolean pExternaApprovalGateCompleted) Sets the externa approval gate completed.
void	setFlexField(java.lang.Long pProjectId, java.lang.String pCode, java.io.Serializable pValue) Set the value of the flex field for the snapshot project on the stage.
void	setFlexField(java.lang.Long pProjectId, java.lang.String pPackageName, java.lang.String pCode, java.io.Serializable pValue) Set the value of the flex field for the snapshot project and package on the stage.
void	setInstanceOverride(java.lang.Long pProjectId, java.util.List<java.lang.String> pInstanceCodeList) Set target group overrides (deploy or utility) for specified project id.
void	setInstanceOverride(java.lang.Long pProjectId, java.lang.String pInstanceCode) Set target group override (deploy or utility) for specified project id. If specified target group is not mapped to current environment then execution will be skipped. This method is to be used for Full Deployment project of All Files Partial Deployment project.
void	setInstanceOverride(java.lang.Long pProjectId, java.lang.String pPackageName, java.util.List<java.lang.String> pInstanceCodeList) Set target group overrides (deploy or utility) for specified project id and package name.
void	setInstanceOverride(java.lang.Long pProjectId, java.lang.String pPackageName, java.lang.String pInstanceCode) Set target group overrides (deploy or utility) for specified project id and package name. If specified target group is not mapped to current environment then execution will be skipped. This method is to be used for Partial Deployment project where Package is used in release.
void	setRelatedTicket(java.lang.Long pProjectId, java.lang.String pRelatedTicket) sets the related ticket field for the snapshot project on the stage.
void	setRelatedTicket(java.lang.Long pProjectId, java.lang.String pPackageName, java.lang.String pRelatedTicket) sets the related ticket field for the snapshot project and package on the stage.
void	setRelatedTicket(java.lang.String pRelatedTicket) sets the related ticket field on stage.
void	setUserForceDeploy(java.lang.Long pProjectId) force deploy the snapshot project on the stage.
void	setUserForceDeploy(java.lang.Long pProjectId, java.lang.String pPackageName) force deploy the snapshot project and package on the stage.
void	setUserNoOverride(java.lang.Long pProjectId) removes any previously set deploy option override for the snapshot project on the stage.
void	setUserNoOverride(java.lang.Long pProjectId, java.lang.String pPackageName) removes any previously set deploy option override for the snapshot project and package on the stage.
void	setUserSkipDeploy(java.lang.Long pProjectId) skip the deployment for the snapshot project on the stage.
void	setUserSkipDeploy(java.lang.Long pProjectId, java.lang.String pPackageName) skip the deployment for the snapshot project and package on the stage.
void	setWorkflowInput(java.lang.Long pProjectId, java.lang.String pCode, java.io.Serializable pValue) Set the value of the workflow inputs for the snapshot project on the stage.
void	setWorkflowInput(java.lang.Long pProjectId, java.lang.String pPackageName, java.lang.String pCode, java.io.Serializable pValue) Set the value of the workflow inputs for the snapshot project and package on the stage.
void	setWorkflowInputInternal(java.lang.Long pProjectId, java.lang.String pPackageName, java.lang.String pCode, java.io.Serializable pValue) This method is used from stage execution to set workflow input from predeploy output, don't expose this to Groovy Function.

Methods inherited from class java.lang.Object

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

Constructor Detail

PipelineStageExecutionInfo

public PipelineStageExecutionInfo(ExecutionData pStageExecData,
                                  java.util.List<ReleaseProjectVersion> pReleaseProjectVersionList)

Do not store AM on instance variables, just use it to get details we need.

Parameters:

pStageExecData - the stage exec data

pReleaseProjectVersionList - the release project version list

Method Detail

isExecDataValid

public boolean isExecDataValid()

Checks if is exec data valid.

Returns:

true, if is exec data valid

isStageExecReleaseProjectsValid

public boolean isStageExecReleaseProjectsValid()

Checks if is stage exec release projects valid.

Returns:

true, if is stage exec release projects valid

isModified

public boolean isModified()

Checks if is modified.

Returns:

true, if is modified

getExecutionData

public ExecutionData getExecutionData()

Gets the execution data.

Returns:

the execution data

getRelatedTicket

public java.lang.String getRelatedTicket()

returns related ticket associated to the stage.

Returns:

the related ticket

getRelatedTicket

public java.lang.String getRelatedTicket(java.lang.Long pProjectId)

returns related ticket associated to snapshot project or the stage. If not found, related ticket is returned from the stage.

Parameters:

pProjectId - the project id

Returns:

the related ticket

getRelatedTicket

public java.lang.String getRelatedTicket(java.lang.Long pProjectId,
                                         java.lang.String pPackageName)

returns related ticket associated to the snapshot project and package. If not found, related ticket is returned from the stage.

Parameters:

pProjectId - the project id

pPackageName - the package name

Returns:

the related ticket

setRelatedTicket

public void setRelatedTicket(java.lang.String pRelatedTicket)

sets the related ticket field on stage.

Parameters:

pRelatedTicket - the new related ticket

setRelatedTicket

public void setRelatedTicket(java.lang.Long pProjectId,
                             java.lang.String pRelatedTicket)

sets the related ticket field for the snapshot project on the stage.

Parameters:

pProjectId - the project id

pRelatedTicket - the related ticket

setRelatedTicket

public void setRelatedTicket(java.lang.Long pProjectId,
                             java.lang.String pPackageName,
                             java.lang.String pRelatedTicket)

sets the related ticket field for the snapshot project and package on the stage.

Parameters:

pProjectId - the project id

pPackageName - the package name

pRelatedTicket - the related ticket

getWorkflowInputMap

public java.util.Map<java.lang.String,java.util.List<java.io.Serializable>> getWorkflowInputMap(java.lang.Long pProjectId,
                                                                                                java.lang.String pPackageName)

returns a map of deploy workflow input values for the given project id and package name. Key of map is input name and value is list of input values.

Parameters:

pProjectId - the project id

pPackageName - the package name

Returns:

the workflow input map

getWorkflowInputMap

public java.util.Map<java.lang.String,java.util.List<java.io.Serializable>> getWorkflowInputMap(java.lang.String pProjectName,
                                                                                                java.lang.String pPackageName)

returns a map of deploy workflow input values for the given project name and package name. Key of map is input name and value is list of input values.

Parameters:

pProjectName - the project name

pPackageName - the package name

Returns:

the workflow input map

getWorkflowInputMap

public java.util.Map<java.lang.String,java.util.List<java.io.Serializable>> getWorkflowInputMap(java.lang.Long pProjectId)

returns a map of deploy workflow input values for the given project id. Key of map is input name and value is list of input values.

Parameters:

pProjectId - the project id

Returns:

the workflow input map

getWorkflowInputMap

public java.util.Map<java.lang.String,java.util.List<java.io.Serializable>> getWorkflowInputMap(java.lang.String pProjectName)

returns a map of deploy workflow input values for the given project name. Key of map is input name and value is list of input values.

Parameters:

pProjectName - the project name

Returns:

the workflow input map

getWorkflowInputs

public java.util.List<java.io.Serializable> getWorkflowInputs(java.lang.String pName)

returns list of workflow deploy workflow inputs for input name irrespective of project.

Parameters:

pName - the name

Returns:

the workflow inputs

getFlexFields

public java.util.List<java.io.Serializable> getFlexFields(java.lang.String pCode)

returns list of flex field values for code irrespective of project.

Parameters:

pCode - the code

Returns:

the flex fields

getFlexFieldMap

public java.util.Map<java.lang.String,java.util.List<java.io.Serializable>> getFlexFieldMap(java.lang.Long pProjectId,
                                                                                            java.lang.String pPackageName)

returns a map of flex field values for the given project id and package name. Key of map is flex field code and value is list of flex field values.

Parameters:

pProjectId - the project id

pPackageName - the package name

Returns:

the flex field map

getFlexFieldMap

public java.util.Map<java.lang.String,java.util.List<java.io.Serializable>> getFlexFieldMap(java.lang.String pProjectName,
                                                                                            java.lang.String pPackageName)

returns a map of flex field values for the given project name and package name. Key of map is flex field code and value is list of flex field values.

Parameters:

pProjectName - the project name

pPackageName - the package name

Returns:

the flex field map

getFlexFieldMap

public java.util.Map<java.lang.String,java.util.List<java.io.Serializable>> getFlexFieldMap(java.lang.String pProjectName)

returns a map of flex field values for the given project name. Key of map is flex field code and value is list of flex field values.

Parameters:

pProjectName - the project name

Returns:

the flex field map

getFlexFieldMap

public java.util.Map<java.lang.String,java.util.List<java.io.Serializable>> getFlexFieldMap(java.lang.Long pProjectId)

returns a map of flex field values for the given project id. Key of map is flex field code and value is list of flex field values.

Parameters:

pProjectId - the project id

Returns:

the flex field map

setExternaApprovalGateCompleted

public void setExternaApprovalGateCompleted(boolean pExternaApprovalGateCompleted)

Sets the externa approval gate completed.

Parameters:

pExternaApprovalGateCompleted - the new externa approval gate completed

isExternaApprovalGateCompleted

public boolean isExternaApprovalGateCompleted()

Checks if is externa approval gate completed.

Returns:

true, if is externa approval gate completed

prepareCMSObjectListFromExecutionData

public java.util.List<CMSObject> prepareCMSObjectListFromExecutionData(java.lang.String pRelatedTicket)

Prepare CMS object list from execution data.

Parameters:

pRelatedTicket - the related ticket

Returns:

the cms object list

isTicketExistForAllProjects

public boolean isTicketExistForAllProjects()

Checks if is ticket exist for all projects.

Returns:

true, if is ticket exist for all projects

setDeployOverride

public void setDeployOverride(java.lang.Long pProjectId,
                              java.lang.String pOverrideName)

Sets the deploy override.

Parameters:

pProjectId - the project id

pOverrideName - the override name

setUserNoOverride

public void setUserNoOverride(java.lang.Long pProjectId,
                              java.lang.String pPackageName)

removes any previously set deploy option override for the snapshot project and package on the stage.

Parameters:

pProjectId - the project id

pPackageName - the package name

setUserNoOverride

public void setUserNoOverride(java.lang.Long pProjectId)

removes any previously set deploy option override for the snapshot project on the stage.

Parameters:

pProjectId - the new user no override

setUserForceDeploy

public void setUserForceDeploy(java.lang.Long pProjectId)

force deploy the snapshot project on the stage.

Parameters:

pProjectId - the new user force deploy

setUserForceDeploy

public void setUserForceDeploy(java.lang.Long pProjectId,
                               java.lang.String pPackageName)

force deploy the snapshot project and package on the stage.

Parameters:

pProjectId - the project id

pPackageName - the package name

setUserSkipDeploy

public void setUserSkipDeploy(java.lang.Long pProjectId)

skip the deployment for the snapshot project on the stage.

Parameters:

pProjectId - the new user skip deploy

setUserSkipDeploy

public void setUserSkipDeploy(java.lang.Long pProjectId,
                              java.lang.String pPackageName)

skip the deployment for the snapshot project and package on the stage.

Parameters:

pProjectId - the project id

pPackageName - the package name

isUserNoOverride

public boolean isUserNoOverride(java.lang.Long pProjectId)

returns true if the deploy override option is No Override for the snapshot project on the stage.

Parameters:

pProjectId - the project id

Returns:

true, if is user no override

isUserNoOverride

public boolean isUserNoOverride(java.lang.Long pProjectId,
                                java.lang.String pPackageName)

returns true if the deploy override option is No Override for the snapshot project and package on the stage.

Parameters:

pProjectId - the project id

pPackageName - the package name

Returns:

true, if is user no override

isUserForceDeploy

public boolean isUserForceDeploy(java.lang.Long pProjectId)

returns true if the deploy override option is Force for the snapshot project on the stage.

Parameters:

pProjectId - the project id

Returns:

true, if is user force deploy

isUserForceDeploy

public boolean isUserForceDeploy(java.lang.Long pProjectId,
                                 java.lang.String pPackageName)

returns true if the deploy override option is Force for the snapshot project and package on the stage.

Parameters:

pProjectId - the project id

pPackageName - the package name

Returns:

true, if is user force deploy

isUserSkipDeploy

public boolean isUserSkipDeploy(java.lang.Long pProjectId)

returns true if the deploy override option is Skip for the snapshot project on the stage.

Parameters:

pProjectId - the project id

Returns:

true, if is user skip deploy

isUserSkipDeploy

public boolean isUserSkipDeploy(java.lang.Long pProjectId,
                                java.lang.String pPackageName)

returns true if the deploy override option is Skip for the snapshot project and package on the stage.

Parameters:

pProjectId - the project id

pPackageName - the package name

Returns:

true, if is user skip deploy

setFlexField

public void setFlexField(java.lang.Long pProjectId,
                         java.lang.String pCode,
                         java.io.Serializable pValue)

Set the value of the flex field for the snapshot project on the stage.

Parameters:

pProjectId - the project id

pCode - the code

pValue - the value

setFlexField

public void setFlexField(java.lang.Long pProjectId,
                         java.lang.String pPackageName,
                         java.lang.String pCode,
                         java.io.Serializable pValue)

Set the value of the flex field for the snapshot project and package on the stage. If package name is null, all the release projects with the matching projectid will be updated with the same value.

Parameters:

pProjectId - the project id

pPackageName - the package name

pCode - the code

pValue - the value

setWorkflowInput

public void setWorkflowInput(java.lang.Long pProjectId,
                             java.lang.String pCode,
                             java.io.Serializable pValue)

Set the value of the workflow inputs for the snapshot project on the stage.

Parameters:

pProjectId - the project id

pCode - the code

pValue - the value

setWorkflowInput

public void setWorkflowInput(java.lang.Long pProjectId,
                             java.lang.String pPackageName,
                             java.lang.String pCode,
                             java.io.Serializable pValue)

Set the value of the workflow inputs for the snapshot project and package on the stage. If package name is null, all the release projects with the matching projectid will be updated with the same value.

Parameters:

pProjectId - the project id

pPackageName - the package name

pCode - the code

pValue - the value

setWorkflowInputInternal

public void setWorkflowInputInternal(java.lang.Long pProjectId,
                                     java.lang.String pPackageName,
                                     java.lang.String pCode,
                                     java.io.Serializable pValue)

This method is used from stage execution to set workflow input from predeploy output, don't expose this to Groovy Function.

Parameters:

pProjectId - the project id

pPackageName - the package name

pCode - the code

pValue - the value

setInstanceOverride

public void setInstanceOverride(java.lang.Long pProjectId,
                                java.lang.String pInstanceCode)

Set target group override (deploy or utility) for specified project id.
If specified target group is not mapped to current environment then execution will be skipped.
This method is to be used for Full Deployment project of All Files Partial Deployment project. If you are using stgexec.getSnapshotProjects(), then just use setInstanceOverride(projectId, packageName, instanceCode) as package name will be null for full project or all files in stgexec.getSnapshotProjects().

Parameters:

pProjectId - the project id

pInstanceCode - the instance code

setInstanceOverride

public void setInstanceOverride(java.lang.Long pProjectId,
                                java.util.List<java.lang.String> pInstanceCodeList)

Set target group overrides (deploy or utility) for specified project id. Execution will only happen against specified target groups (supply java.util.List of String target group codes) if it is mapped to current environment.
Target group codes that are not mapped to current environment will be skipped.
This method is to be used for Full Deployment project of All Files Partial Deployment project. If you are using stgexec.getSnapshotProjects(), then just use setInstanceOverride(projectId, packageName, instanceCode) as package name will be null for full project or all files in stgexec.getSnapshotProjects().

Parameters:

pProjectId - the project id

pInstanceCodeList - the instance code list

setInstanceOverride

public void setInstanceOverride(java.lang.Long pProjectId,
                                java.lang.String pPackageName,
                                java.lang.String pInstanceCode)

Set target group overrides (deploy or utility) for specified project id and package name.
If specified target group is not mapped to current environment then execution will be skipped.
This method is to be used for Partial Deployment project where Package is used in release. If you are using stgexec.getSnapshotProjects(), then just use setInstanceOverride(projectId, packageName, instanceCode) as package name will be null for full project or all files in stgexec.getSnapshotProjects().

Parameters:

pProjectId - the project id

pPackageName - the package name

pInstanceCode - the instance code

setInstanceOverride

public void setInstanceOverride(java.lang.Long pProjectId,
                                java.lang.String pPackageName,
                                java.util.List<java.lang.String> pInstanceCodeList)

Set target group overrides (deploy or utility) for specified project id and package name. Execution will only happen against specified target groups (supply java.util.List of String target group codes), if it is mapped to current environment.
Target group codes that are not mapped to current environment will be skipped.
This method is to be used for Partial Deployment project where Package is used in release. If you are using stgexec.getSnapshotProjects(), then just use setInstanceOverride(projectId, packageName, instanceCode) as package name will be null for full project or all files in stgexec.getSnapshotProjects().

Parameters:

pProjectId - the project id

pPackageName - the package name

pInstanceCodeList - the instance code list

getInstanceOverride

public java.util.List<java.lang.String> getInstanceOverride(java.lang.Long pProjectId)

Returns List of target group codes configured as overrides based on Project Id.

Parameters:

pProjectId - the project id

Returns:

the instance override

getInstanceOverride

public java.util.List<java.lang.String> getInstanceOverride(java.lang.Long pProjectId,
                                                            java.lang.String pPackageName)

Returns List of target group codes configured as overrides based on Project Id and Package Name.

Parameters:

pProjectId - the project id

pPackageName - the package name

Returns:

the instance override