com.whitestein.lsps.test

Class ModelInstance

java.lang.Object

com.whitestein.lsps.test.ModelInstance

public class ModelInstance
extends Object

Constructor Summary

Constructors

Constructor and Description
ModelInstance(LspsRemote remote, Module module, long id)

Method Summary

Modifier and Type	Method and Description
void	deactivateGoal(String goal)
boolean	equals(Object obj)
EvaluationResultValue	evaluateExpressionInEvaluationLevel(Long contextId, String expression, String evaluationLevel, boolean mergeEvaluation) Evaluates expression in the given context and the specified evaluation level.
EvaluationResultValue	evaluateExpressionInEvaluationLevel(String expression, String evaluationLevel, boolean mergeEvaluation) Evaluates expression in the specified evaluation level.
EvaluationResultValue	execute(String expression) Evaluates expression in base context.
EvaluationResultValue	execute(String expression, Long contextId) Evaluates expression in base evaluation level in the specified context.
List<Todo>	findAliveTodos() Finds alive Todos created by this model instance.
List<Todo>	findAliveTodos(String title) Finds alive Todos created by this model instance.
List<Todo>	findAliveTodosForPerson(Person person) Finds Todos created by this model instance in the given person todo list.
List<RollbackInfo>	findRollbackInfos() Returns a list of rollback informations (when model run encounters an exception, the DB transaction is rolled back and a instance is produced).
Todo	findSingleAliveTodo(String title) Finds an alive Todo with the given title.
Todo	findSingleAliveTodoForPerson(Person person, String title) Finds an alive Todo with the given title in the todo list of the current user belonging to this model instance.
List<Todo>	findTodos() Finds Todos created by this model instance.
List<Todo>	findTodos(TodoStatus status) Finds todos created by this model instance with the given status.
List<Todo>	findTodos(TodoStatus status, String title) Finds todos created by this model instance with the given status and a given title.
EvaluationResultValue	gc() Performs a GC.
List<ModelInstance>	getChildren() Returns the list of children model instances.
List<ModelInstance>	getChildren(ModelInstanceState state) Returns the list of children model instances that have the given lifecycle state.
List<ModelInstance>	getChildren(ModelInstanceState state, Module module) Returns the list of children model instances that have the given lifecycle state and are running on a given model.
List<ModelInstance>	getChildren(Module module) Returns the list of children model instances that are runnig on a given model.
List<RollbackInfo>	getErrors()
GoalState	getGoalState(String goal) Returns a state of the given goal.
long	getId() Returns the model instance id.
ModelInstanceInfo	getInfo()
ModelInstanceLogs	getLogs() Gets all log entries for this model instance.
long	getMainContextId()
long	getModelId() Returns the ID of the model instance model.
String	getModelName() Returns the name of the model instance model.
String	getModelVersion() Returns the version of the model instance model.
ModelInstance	getParent() Returns the parent model instance.
ProcessInstance	getProcessInstance(String name) Returns the single process instance with given name for this model instance.
List<ProcessInstance>	getProcessInstances(String name) Finds all process instances for this model instance, with given name.
ProcessInstanceState	getProcessInstanceState(String name) Returns the state of a process instance with given name.
List<ProcessLog>	getProcessLogs()
Map<String,String>	getProperties() Returns the model instance properties.
LspsRemote	getRemote() Returns the associated remote.
List<Signal>	getSignals() Returns a list of signals in the signal queue of this model instance.
ModelInstanceState	getState() Returns the model instance state
Object	getVariableValue(String name) Returns the value of module variable.
int	hashCode()
void	notifyModelInstance() Wakes up the model execution and continues the processing.
void	reactivateGoal(String goal)
void	removeSignal(long signalId)
void	resume() Resumes the model execution.
void	sendAsynchronousSignal(Object signal) Sends a signal to this model instance, with given signal value, or payload.
void	sendSignal(Object signal) Sends a signal to this model instance, with given signal value, or payload.
void	setVariableValue(String name, Object value) Sets the value of the module variable.
void	stop() Deprecated. Use terminate()
void	submitTodo(String title) Asserts that there is a single alive todo with a given title and submits it.
void	suspend() Suspends the model execution.
void	terminate() Terminates this model instance, if it is not already finished.
String	toString()
void	updateGoal(String goal, boolean reactivate)
long	updateModel(String migrationName, ByteData migrationConfig) Updates a model.
boolean	waitForExceptionPresent()
boolean	waitForExceptionPresent(long timeoutMillis)
void	waitForGoalState(String goalName, GoalState state) Awaits for given goal to enter given state, but at most for 60 seconds.
void	waitForGoalState(String goalName, GoalState state, long timeoutMillis) Awaits for given goal to enter given state, but at most for given time duration.
boolean	waitForLogPresent(String logMessage)
boolean	waitForLogPresent(String logMessage, long timeoutMillis)
void	waitForSignal(Object signal, long timeoutMillis)
Todo	waitForSingleAliveTodo(String title)
Todo	waitForSingleAliveTodo(String title, long timeoutMillis)
void	waitForState(ModelInstanceState state) Waits at most 60 seconds for the model instance to reach given state.
void	waitForState(ModelInstanceState state, long timeoutMillis) Waits for the model instance to reach given state.
void	waitForVariableNotNull(String variableName, long timeoutMillis) Awaits for given variable to become assigned with a not-null value.

Methods inherited from class java.lang.Object

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

Constructor Detail

ModelInstance

public ModelInstance(LspsRemote remote,
                     Module module,
                     long id)

Method Detail

getRemote

public LspsRemote getRemote()

Returns the associated remote.

Returns:

the associated remote

toString

public String toString()

Overrides:

toString in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

getId

public long getId()

Returns the model instance id.

Returns:

the model instance id

getModelId

public long getModelId()

Returns the ID of the model instance model.

Returns:

the model ID

getModelName

public String getModelName()

Returns the name of the model instance model.

Returns:

the model name

getModelVersion

public String getModelVersion()

Returns the version of the model instance model.

Returns:

the model version

getProperties

public Map<String,String> getProperties()

Returns the model instance properties.

Returns:

the map of model instance properties

getParent

public ModelInstance getParent()

Returns the parent model instance. May be null.

Returns:

the parent model instance, may be null

getChildren

public List<ModelInstance> getChildren()

Returns the list of children model instances.

Returns:

the list of children model instances

getChildren

public List<ModelInstance> getChildren(ModelInstanceState state)

Returns the list of children model instances that have the given lifecycle state.

Parameters:

state - a state

Returns:

the list of children model instances

getChildren

public List<ModelInstance> getChildren(Module module)

Returns the list of children model instances that are runnig on a given model.

Returns:

the list of children model instances

getChildren

public List<ModelInstance> getChildren(ModelInstanceState state,
                                       Module module)

Returns the list of children model instances that have the given lifecycle state and are running on a given model.

Parameters:

state - a state

module - a module

Returns:

the list of children model instances

execute

public EvaluationResultValue execute(String expression)
                              throws ErrorException,
                                     ValidationException

Evaluates expression in base context. Throws ErrorException if the code throws an error.

Parameters:

expression -

Returns:

expression return value

Throws:

ValidationException

ErrorException

execute

public EvaluationResultValue execute(String expression,
                                     Long contextId)
                              throws ErrorException,
                                     ValidationException

Evaluates expression in base evaluation level in the specified context.

Parameters:

expression -

contextId -

Returns:

a return value

Throws:

ErrorException

ValidationException

evaluateExpressionInEvaluationLevel

public EvaluationResultValue evaluateExpressionInEvaluationLevel(String expression,
                                                                 String evaluationLevel,
                                                                 boolean mergeEvaluation)
                                                          throws ErrorException,
                                                                 ValidationException

Evaluates expression in the specified evaluation level.

Parameters:

expression -

evaluationLevel -

mergeEvaluation -

Returns:

a return value

Throws:

ErrorException

ValidationException

evaluateExpressionInEvaluationLevel

public EvaluationResultValue evaluateExpressionInEvaluationLevel(Long contextId,
                                                                 String expression,
                                                                 String evaluationLevel,
                                                                 boolean mergeEvaluation)
                                                          throws ErrorException,
                                                                 ValidationException

Evaluates expression in the given context and the specified evaluation level.

Parameters:

contextId -

expression -

evaluationLevel -

mergeEvaluation -

Returns:

a return value

Throws:

ErrorException

ValidationException

stop

@Deprecated
public void stop()

Deprecated. Use terminate()

Stops this model instance.

terminate

public void terminate()

Terminates this model instance, if it is not already finished.

getErrors

public List<RollbackInfo> getErrors()

getLogs

public ModelInstanceLogs getLogs()

Gets all log entries for this model instance. The result is ordered by the log entry identifiers in ascending order.

Returns:

model instance logs

getState

public ModelInstanceState getState()

Returns the model instance state

Returns:

the state, not null.

getInfo

public ModelInstanceInfo getInfo()

sendSignal

public void sendSignal(Object signal)

Sends a signal to this model instance, with given signal value, or payload.

Parameters:

signal - the signal value, may be null.

sendAsynchronousSignal

public void sendAsynchronousSignal(Object signal)

Sends a signal to this model instance, with given signal value, or payload. Signal is send asynchronously

Parameters:

signal - the signal value, may be null.

removeSignal

public void removeSignal(long signalId)

findTodos

public List<Todo> findTodos()

Finds Todos created by this model instance.

Returns:

the list of Todos

findTodos

public List<Todo> findTodos(TodoStatus status)

Finds todos created by this model instance with the given status.

Parameters:

status - the status of the searched todos

title - the title

Returns:

a list of todos matching the given criteria

findTodos

public List<Todo> findTodos(TodoStatus status,
                            String title)

Finds todos created by this model instance with the given status and a given title.

Parameters:

status - the status of the searched todos

title - the title

Returns:

a list of todos matching the given criteria

findAliveTodos

public List<Todo> findAliveTodos()

Finds alive Todos created by this model instance.

Returns:

the list of Todos

findAliveTodos

public List<Todo> findAliveTodos(String title)

Finds alive Todos created by this model instance.

Parameters:

title - a title

Returns:

the list of Todos

findAliveTodosForPerson

public List<Todo> findAliveTodosForPerson(Person person)

Finds Todos created by this model instance in the given person todo list.

Parameters:

person - a person

Returns:

the list of Todos

findSingleAliveTodo

public Todo findSingleAliveTodo(String title)

Finds an alive Todo with the given title. It is expected that either one or no Todo is found. Todo content is not included.

Parameters:

title - the title of the Todo

Returns:

a Todo belonging to this model instance with the given title or null if no such Todo exists.

Throws:

LspsTesterException - if more than one such a Todo is found

findSingleAliveTodoForPerson

public Todo findSingleAliveTodoForPerson(Person person,
                                         String title)

Finds an alive Todo with the given title in the todo list of the current user belonging to this model instance.

Parameters:

person -

title -

Returns:

ta Todo belonging to this model instance with the given title or null if no such Todo exists.

Throws:

LspsTesterException - if more than one such a Todo is found

submitTodo

public void submitTodo(String title)

Asserts that there is a single alive todo with a given title and submits it.

Parameters:

title -

waitForState

public void waitForState(ModelInstanceState state)
                  throws InterruptedException

Waits at most 60 seconds for the model instance to reach given state. If the state is not reached within 5 seconds, an exception is thrown.

Parameters:

state - expected state, not null.

Throws:

InterruptedException

AssertionError - if the model does not reach given state in given time period.

waitForState

public void waitForState(ModelInstanceState state,
                         long timeoutMillis)
                  throws InterruptedException

Waits for the model instance to reach given state. If the state is not reached within given time period, an exception is thrown.

Parameters:

state - expected state, not null.

timeoutMillis - wait at most this amount of milliseconds.

Throws:

InterruptedException

AssertionError - if the model does not reach given state in given time period.

waitForSingleAliveTodo

public Todo waitForSingleAliveTodo(String title)
                            throws InterruptedException

Throws:

InterruptedException

waitForSingleAliveTodo

public Todo waitForSingleAliveTodo(String title,
                                   long timeoutMillis)
                            throws InterruptedException

Throws:

InterruptedException

waitForLogPresent

public boolean waitForLogPresent(String logMessage)
                          throws InterruptedException

Throws:

InterruptedException

waitForLogPresent

public boolean waitForLogPresent(String logMessage,
                                 long timeoutMillis)
                          throws InterruptedException

Throws:

InterruptedException

waitForExceptionPresent

public boolean waitForExceptionPresent()
                                throws InterruptedException

Throws:

InterruptedException

waitForExceptionPresent

public boolean waitForExceptionPresent(long timeoutMillis)
                                throws InterruptedException

Throws:

InterruptedException

getGoalState

public GoalState getGoalState(String goal)

Returns a state of the given goal. The goal is identified by it's name.

Parameters:

goal - the goal name

Returns:

the state of the goal

deactivateGoal

public void deactivateGoal(String goal)

reactivateGoal

public void reactivateGoal(String goal)

updateGoal

public void updateGoal(String goal,
                       boolean reactivate)

waitForVariableNotNull

public void waitForVariableNotNull(String variableName,
                                   long timeoutMillis)
                            throws InterruptedException

Awaits for given variable to become assigned with a not-null value.

Parameters:

variableName - the variable name, not null.

timeoutMillis - wait at most this amount of milliseconds

Throws:

InterruptedException

AssertionError - if the variable is null after given time period ellapses.

waitForGoalState

public void waitForGoalState(String goalName,
                             GoalState state)
                      throws InterruptedException

Awaits for given goal to enter given state, but at most for 60 seconds. If 60 seconds elapses, assertion error is thrown.

Parameters:

goalName - the goal name, not null.

state - expected state, not null.

Throws:

InterruptedException

AssertionError - if the goal is not in given state.

waitForGoalState

public void waitForGoalState(String goalName,
                             GoalState state,
                             long timeoutMillis)
                      throws InterruptedException

Awaits for given goal to enter given state, but at most for given time duration. If the time period elapses, assertion error is thrown.

Parameters:

goalName - the goal name, not null.

state - expected state, not null.

timeoutMillis - wait at most this amount of milliseconds

Throws:

InterruptedException

AssertionError - if the goal is not in given state.

waitForSignal

public void waitForSignal(Object signal,
                          long timeoutMillis)
                   throws InterruptedException

Throws:

InterruptedException

getProcessInstanceState

public ProcessInstanceState getProcessInstanceState(String name)

Returns the state of a process instance with given name. Fails if there are none or two or more process instances with given name.

Parameters:

name - the process instance name, not null.

Returns:

the process instance state, not null.

Throws:

LspsTesterException - if there is no such process instance, or if there are two or more process instances.

getProcessInstance

public ProcessInstance getProcessInstance(String name)

Returns the single process instance with given name for this model instance.

Parameters:

name - necessary process instance name, not null.

Returns:

the process instance, or null if there is no such process instance.

Throws:

LspsTesterException - if there are multiple process instances with given name.

getProcessInstances

public List<ProcessInstance> getProcessInstances(String name)

Finds all process instances for this model instance, with given name.

Parameters:

name - required name, not null.

Returns:

list of process instances, not null, may be empty.

getMainContextId

public long getMainContextId()

Returns:

mainContextId

getVariableValue

public Object getVariableValue(String name)

Returns the value of module variable. The variable name can be a simple name or a full name (e.g. mymodule::myvariable.

Parameters:

name - the variable name

Returns:

the value, may be null.

setVariableValue

public void setVariableValue(String name,
                             Object value)

Sets the value of the module variable. The variable name can be a simple name or a full name (e.g. mymodule::myvariable.

Parameters:

name - the variable name

value -

notifyModelInstance

public void notifyModelInstance()

Wakes up the model execution and continues the processing. This may be useful e.g. when execute(String) changes value of some variable, used in some model's condition and the execution may now continue.

suspend

public void suspend()

Suspends the model execution. See https://docs.whitestein.com/lsps/3_0/gobpmn-modeling-language/topic/to_suspend for details.

resume

public void resume()

Resumes the model execution. See https://docs.whitestein.com/lsps/3_0/gobpmn-modeling-language/topic/to_suspend for details.

updateModel

public long updateModel(String migrationName,
                        ByteData migrationConfig)

Updates a model.

Parameters:

migrationName - migration name

migrationConfig - the .muc file contents. Use new ByteData(Files.readAllBytes(path)) to read the file.

Returns:

the migration ID

findRollbackInfos

public List<RollbackInfo> findRollbackInfos()

Returns a list of rollback informations (when model run encounters an exception, the DB transaction is rolled back and a instance is produced).

Returns:

a list of rollback infos, not null, may be empty.

gc

public EvaluationResultValue gc()

Performs a GC.

Returns:

the GC result.

getSignals

public List<Signal> getSignals()

Returns a list of signals in the signal queue of this model instance.

Returns:

a list of signals, never null, may be empty.

getProcessLogs

public List<ProcessLog> getProcessLogs()