io.cloudslang.score.lang

Class ExecutionRuntimeServices

java.lang.Object

io.cloudslang.score.lang.ExecutionRuntimeServices

All Implemented Interfaces:

Serializable

Direct Known Subclasses:

SystemContext

public class ExecutionRuntimeServices
extends Object
implements Serializable

User: Date: 11/06/2014

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected Map<String,Serializable>	contextMap
static String	ENTERPRISE_MODE
static String	EXECUTION_ID_CONTEXT
protected static String	EXECUTION_PAUSED
static String	LANGUAGE_TYPE
static String	LIC_SWITCH_MODE
protected static String	NO_WORKERS_IN_GROUP
static String	SC_NESTED_FOR_PARALLELISM_LEVEL
protected static String	SCORE_EVENTS_QUEUE

Constructor Summary

Constructors

Constructor and Description
ExecutionRuntimeServices()
ExecutionRuntimeServices(ExecutionRuntimeServices executionRuntimeServices) copy constructor that clean the NEW_SPLIT_ID & BRANCH_ID keys

Method Summary

Modifier and Type	Method and Description
protected void	addBranch(Long startPosition, Long executionPlanId, Map<String,Serializable> context, ExecutionRuntimeServices executionRuntimeServices)
void	addBranch(Long startPosition, String flowUuid, Map<String,Serializable> context) add brunch - means you want to split your execution
void	addBranchForParallelLoop(Long startPosition, String flowUuid, Map<String,Serializable> context)
void	addEvent(String eventType, Serializable eventData) add event - for score to fire
void	addRoiValue(Double roiValue)
boolean	equals(Object o)
String	extractParentNameFromRunId(Long parentRunId)
String	getBranchId()
ArrayDeque<ScoreEvent>	getEvents()
Long	getExecutionId()
List<EndBranchDataContainer>	getFinishedChildBranchesData()
ExecutionStatus	getFlowTerminationType()
protected <T> T	getFromMap(String key)
String	getLanguageName()
Serializable	getLevelParallelism()
String	getLicSwitchMode()
boolean	getMergeUserInputs()
Map<String,? extends Serializable>	getMetaData()
String	getNodeName()
String	getNodeNameWithDepth()
String	getNoWorkerInGroupName()
Long	getParentRunningId()
boolean	getPreconditionNotFulfilled()
String	getRobotGroupName()
Double	getRoiValue()
String	getSplitId()
String	getStepErrorKey()
String	getStepPersistId()
Long	getSubFlowBeginStep(String subFlowUuid)
Long	getSubFlowRunningExecutionPlan(String subFlowUuid)
String	getWorkerGroupName()
int	hashCode()
boolean	hasStepErrorKey()
boolean	isEnterpriseMode()
boolean	isPaused()
boolean	isStepPersist()
void	pause() used for asking score to pause your run
Long	pullRequestForChangingExecutionPlan() This method should be used by score engine once it finishes executing a step, and checks if the running execution plan should be changed
void	putMetaData(Map<String,? extends Serializable> metadata)
List<StartBranchDataContainer>	removeBranchesData() Removes the branches data and returns it
String	removeConsumerWorkerId()
void	removePreconditionNotFulfilled()
String	removeProducerWorkerId()
String	removeRobotGroupName()
String	removeRobotId()
void	removeShouldCheckGroup()
String	removeStepErrorKey() clean step error key
void	removeStepPersist()
void	removeStepPersistID()
Double	removeTotalRoiValue()
void	requestToChangeExecutionPlan(Long runningExecutionPlanId) Request the engine to change the running execution plan to a new one The engine will deal with the request after finishing to execute the curretn step
void	setBranchId(String branchId) setter for the brunch id of the current Execution
void	setConsumerWorkerId(String consumerWorkerId)
void	setExecutionId(Long executionId) set the execution id - should be called only once in score triggering!
void	setFinishedChildBranchesData(ArrayList<EndBranchDataContainer> data) setter for the finished child brunches data
void	setFlowTerminationType(ExecutionStatus flowTerminationType) set the flow termination type
void	setLanguageName(String languageName)
void	setLevelParallelism(int level)
void	setMergeUserInputs(boolean mergeUserInputs)
void	setNodeName(String nodeName)
void	setNodeNameWithDepth(String nodeNameWithDepth)
void	setNoWorkerInGroup(String groupName) means we dont have worker with the required group
void	setParentRunningId(Long parentRunningId)
void	setPreconditionNotFulfilled()
void	setProducerWorkerId(String producerWorkerId)
void	setRobotGroupName(String robotGroupName)
void	setRobotId(String robotId)
void	setShouldCheckGroup() This flag is set if the current execution step needs to go through group resolving
void	setSplitId(String splitId) set teh split id
void	setStepErrorKey(String stepErrorKey) set the step error key
void	setStepPersist(boolean stepPersist)
void	setStepPersistId(String stepPersistId)
void	setSubFlowsData(Map<String,Long> runningPlansIds, Map<String,Long> beginStepsIds) put all the data relevant for sub flows: map of runningPlanIds and list of BeginStepIds
void	setWorkerGroupName(String workerGroupName)
boolean	shouldCheckGroup()

Methods inherited from class java.lang.Object

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

Field Detail

EXECUTION_PAUSED

protected static final String EXECUTION_PAUSED

See Also:

Constant Field Values

SCORE_EVENTS_QUEUE

protected static final String SCORE_EVENTS_QUEUE

See Also:

Constant Field Values

NO_WORKERS_IN_GROUP

protected static final String NO_WORKERS_IN_GROUP

See Also:

Constant Field Values

EXECUTION_ID_CONTEXT

public static final String EXECUTION_ID_CONTEXT

See Also:

Constant Field Values

LANGUAGE_TYPE

public static final String LANGUAGE_TYPE

See Also:

Constant Field Values

ENTERPRISE_MODE

public static final String ENTERPRISE_MODE

See Also:

Constant Field Values

SC_NESTED_FOR_PARALLELISM_LEVEL

public static final String SC_NESTED_FOR_PARALLELISM_LEVEL

See Also:

Constant Field Values

LIC_SWITCH_MODE

public static final String LIC_SWITCH_MODE

See Also:

Constant Field Values

contextMap

protected Map<String,Serializable> contextMap

Constructor Detail

ExecutionRuntimeServices

public ExecutionRuntimeServices()

ExecutionRuntimeServices

public ExecutionRuntimeServices(ExecutionRuntimeServices executionRuntimeServices)

copy constructor that clean the NEW_SPLIT_ID & BRANCH_ID keys

Method Detail

setFinishedChildBranchesData

public void setFinishedChildBranchesData(ArrayList<EndBranchDataContainer> data)

setter for the finished child brunches data

Parameters:

data - - list of EndBranchDataContainer

setSubFlowsData

public void setSubFlowsData(Map<String,Long> runningPlansIds,
                            Map<String,Long> beginStepsIds)

put all the data relevant for sub flows: map of runningPlanIds and list of BeginStepIds

Parameters:

runningPlansIds - - map of flowUUID to runningPlanId

beginStepsIds - - map of flowUUID to beginStepId

getSubFlowRunningExecutionPlan

public Long getSubFlowRunningExecutionPlan(String subFlowUuid)

Parameters:

subFlowUuid - - the required sub flow UUID

Returns:

the id of the runningPlan of the given flow

getSubFlowBeginStep

public Long getSubFlowBeginStep(String subFlowUuid)

Parameters:

subFlowUuid - - the required sub flow UUID

Returns:

the begin step of the given flow

getLanguageName

public String getLanguageName()

setLanguageName

public void setLanguageName(String languageName)

getBranchId

public String getBranchId()

Returns:

the brunchId of the current execution

setBranchId

public void setBranchId(String branchId)

setter for the brunch id of the current Execution

getFlowTerminationType

public ExecutionStatus getFlowTerminationType()

Returns:

the flow termination type : one of ExecutionStatus values

setFlowTerminationType

public void setFlowTerminationType(ExecutionStatus flowTerminationType)

set the flow termination type

Parameters:

flowTerminationType - - from ExecutionStatus

requestToChangeExecutionPlan

public void requestToChangeExecutionPlan(Long runningExecutionPlanId)

Request the engine to change the running execution plan to a new one The engine will deal with the request after finishing to execute the curretn step

Parameters:

runningExecutionPlanId - the new running execution plan id

pullRequestForChangingExecutionPlan

public Long pullRequestForChangingExecutionPlan()

This method should be used by score engine once it finishes executing a step, and checks if the running execution plan should be changed

Returns:

the id of the requested running execution plan

getStepErrorKey

public String getStepErrorKey()

Returns:

the error key of the step

setStepErrorKey

public void setStepErrorKey(String stepErrorKey)

set the step error key

hasStepErrorKey

public boolean hasStepErrorKey()

Returns:

true if there is step error

removeStepErrorKey

public String removeStepErrorKey()

clean step error key

Returns:

the values cleaned

setStepPersist

public void setStepPersist(boolean stepPersist)

isStepPersist

public boolean isStepPersist()

removeStepPersist

public void removeStepPersist()

setStepPersistId

public void setStepPersistId(String stepPersistId)

getStepPersistId

public String getStepPersistId()

removeStepPersistID

public void removeStepPersistID()

getExecutionId

public Long getExecutionId()

Returns:

the execution id

setExecutionId

public void setExecutionId(Long executionId)

set the execution id - should be called only once in score triggering!

getSplitId

public String getSplitId()

Returns:

the split id

setSplitId

public void setSplitId(String splitId)

set teh split id

getWorkerGroupName

public String getWorkerGroupName()

setWorkerGroupName

public void setWorkerGroupName(String workerGroupName)

getLevelParallelism

public Serializable getLevelParallelism()

setLevelParallelism

public void setLevelParallelism(int level)

getRobotGroupName

public String getRobotGroupName()

setShouldCheckGroup

public void setShouldCheckGroup()

This flag is set if the current execution step needs to go through group resolving

removeShouldCheckGroup

public void removeShouldCheckGroup()

shouldCheckGroup

public boolean shouldCheckGroup()

getNodeName

public String getNodeName()

getNodeNameWithDepth

public String getNodeNameWithDepth()

setNodeName

public void setNodeName(String nodeName)

setNodeNameWithDepth

public void setNodeNameWithDepth(String nodeNameWithDepth)

getParentRunningId

public Long getParentRunningId()

setParentRunningId

public void setParentRunningId(Long parentRunningId)

pause

public void pause()

used for asking score to pause your run

isPaused

public boolean isPaused()

Returns:

true if the execution should be paused

addEvent

public void addEvent(String eventType,
                     Serializable eventData)

add event - for score to fire

Parameters:

eventType - - string which is the key you can listen to

eventData - - the event data

getEvents

public ArrayDeque<ScoreEvent> getEvents()

Returns:

all the added events

setNoWorkerInGroup

public void setNoWorkerInGroup(String groupName)

means we dont have worker with the required group

Parameters:

groupName - - the name of the missing group

getNoWorkerInGroupName

public String getNoWorkerInGroupName()

Returns:

the missing group name

getFromMap

protected <T> T getFromMap(String key)

addBranch

public void addBranch(Long startPosition,
                      String flowUuid,
                      Map<String,Serializable> context)

add brunch - means you want to split your execution

Parameters:

startPosition - - the position in the execution plan the new brunch will point to

flowUuid - - the flow uuid

context - - the context of the created brunch

addBranch

protected void addBranch(Long startPosition,
                         Long executionPlanId,
                         Map<String,Serializable> context,
                         ExecutionRuntimeServices executionRuntimeServices)

addBranchForParallelLoop

public void addBranchForParallelLoop(Long startPosition,
                                     String flowUuid,
                                     Map<String,Serializable> context)

removeBranchesData

public List<StartBranchDataContainer> removeBranchesData()

Removes the branches data and returns it

getFinishedChildBranchesData

public List<EndBranchDataContainer> getFinishedChildBranchesData()

Returns:

a list of all branches ended.

putMetaData

public void putMetaData(Map<String,? extends Serializable> metadata)

getMetaData

public Map<String,? extends Serializable> getMetaData()

setConsumerWorkerId

public void setConsumerWorkerId(String consumerWorkerId)

removeConsumerWorkerId

public String removeConsumerWorkerId()

setProducerWorkerId

public void setProducerWorkerId(String producerWorkerId)

removeProducerWorkerId

public String removeProducerWorkerId()

setRobotId

public void setRobotId(String robotId)

removeRobotId

public String removeRobotId()

setRobotGroupName

public void setRobotGroupName(String robotGroupName)

removeRobotGroupName

public String removeRobotGroupName()

getLicSwitchMode

public String getLicSwitchMode()

setPreconditionNotFulfilled

public void setPreconditionNotFulfilled()

removePreconditionNotFulfilled

public void removePreconditionNotFulfilled()

getPreconditionNotFulfilled

public boolean getPreconditionNotFulfilled()

setMergeUserInputs

public void setMergeUserInputs(boolean mergeUserInputs)

extractParentNameFromRunId

public String extractParentNameFromRunId(Long parentRunId)

getMergeUserInputs

public boolean getMergeUserInputs()

isEnterpriseMode

public boolean isEnterpriseMode()

removeTotalRoiValue

public Double removeTotalRoiValue()

getRoiValue

public Double getRoiValue()

addRoiValue

public void addRoiValue(Double roiValue)

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object