Package com.redhat.parodos.workflow.task

Class BaseWorkFlowTask

java.lang.Object

com.redhat.parodos.workflow.task.BaseWorkFlowTask

All Implemented Interfaces:

WorkFlowTask, Work, org.springframework.beans.factory.Aware, org.springframework.beans.factory.BeanNameAware

Direct Known Subclasses:

BaseAssessmentTask, BaseInfrastructureWorkFlowTask, BaseWorkFlowCheckerTask, ShellRunnerTask

public abstract class BaseWorkFlowTask
extends Object
implements WorkFlowTask, org.springframework.beans.factory.BeanNameAware

Base Class for a WorkFlowTask.

This includes logic for getting Parameter values from the WorkContext. The bean name is used when Reading from the WorkContextDelegate as more than one WorkflowTask might have the same ParameterName

Author:

Luke Shannon (Github: lshannon), Richard Wang (Github: richardW98)

Field Summary

Fields

Modifier and Type	Field	Description
protected WorkFlowTaskLogger	taskLogger

Constructor Summary

Constructors

Constructor	Description
BaseWorkFlowTask()

Method Summary

Modifier and Type	Method	Description
void	addAdditionInfo(String key, String value)
void	addParameter(String key, String value)
Map<String,String>	getAllParameters(WorkContext workContext)
UUID	getMainExecutionId()
String	getOptionalParameterValue(String parameterName, String defaultValue)	Gets an optional parameter.
String	getOptionalParameterValue(String parameterName, String defaultValue, Boolean isNullable)	Gets an optional parameter and nullable or not.
UUID	getProjectId(WorkContext workContext)
String	getRequiredParameterValue(String parameterName)	Get Parameters specific to this WorkFlowTask, this is a required parameter
List<WorkFlow>	getWorkFlowCheckers()
void	preExecute(WorkContext workContext)	method runs before @see execute()
void	setBeanName(String name)
void	setWorkFlowCheckers(List<WorkFlow> workFlowCheckers)
boolean	validateWorkflowParameters(WorkContext workContext)

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.redhat.parodos.workflows.work.Work

execute, getName

Methods inherited from interface com.redhat.parodos.workflow.task.WorkFlowTask

getAsJsonSchema, getWorkFlowTaskOutputs, getWorkFlowTaskParameters

Field Details

taskLogger

protected WorkFlowTaskLogger taskLogger

Constructor Details

BaseWorkFlowTask

public BaseWorkFlowTask()

Method Details

setBeanName

public void setBeanName(String name)

Specified by:

setBeanName in interface org.springframework.beans.factory.BeanNameAware

preExecute

public void preExecute(WorkContext workContext)

Description copied from interface: WorkFlowTask

method runs before @see execute()

Specified by:

preExecute in interface WorkFlowTask

getWorkFlowCheckers

public List<WorkFlow> getWorkFlowCheckers()

setWorkFlowCheckers

public void setWorkFlowCheckers(List<WorkFlow> workFlowCheckers)

getProjectId

public UUID getProjectId(WorkContext workContext)

getMainExecutionId

public UUID getMainExecutionId()

addParameter

public void addParameter(String key,
 String value)

getAllParameters

public Map<String,String> getAllParameters(WorkContext workContext)

addAdditionInfo

public void addAdditionInfo(String key,
 String value)

getRequiredParameterValue

public String getRequiredParameterValue(String parameterName)
                                 throws MissingParameterException

Get Parameters specific to this WorkFlowTask, this is a required parameter

Parameters:

parameterName -

Returns:

String value for the Parameter name

Throws:

MissingParameterException

validateWorkflowParameters

public boolean validateWorkflowParameters(WorkContext workContext)

getOptionalParameterValue

public String getOptionalParameterValue(String parameterName,
 String defaultValue)

Gets an optional parameter. Returns the defaultValue if not found

Parameters:

parameterName -

defaultValue -

Returns:

Throws:

MissingParameterException

getOptionalParameterValue

public String getOptionalParameterValue(String parameterName,
 String defaultValue,
 Boolean isNullable)

Gets an optional parameter and nullable or not. Returns the defaultValue if not found

Parameters:

parameterName - parameter name

defaultValue - default value

isNullable - is nullable

Returns:

parameter value

Throws:

MissingParameterException - exception