com.whitestein.lsps.test

Class ModelInstance

java.lang.Object

com.whitestein.lsps.test.ModelInstance

public class ModelInstance
extends Object

Author:

mvy

Field Summary

Fields

Modifier and Type	Field and Description
long	id The model instance ID.

Constructor Summary

Constructors

Constructor and Description
ModelInstance(long id)

Method Summary

Modifier and Type	Method and Description
void	escalateTodo(long todoId, String reasonText)
void	escalateTodo(Todo todo, String reasonText)
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.
EvaluationResultValue	execute(String expression, Todo todo) Evaluates expression in base evaluation level in the context of the given To-do.
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>	findAliveTodosForAdmin() Finds Todos created by this model instance in the Admin's todo list.
List<Todo>	findAliveTodosForCurrentUser() Deprecated. a misleading method name as it returns TODOs for Admin only. Use findAliveTodosForUser(String) or findAliveTodosForUser(TestPerson) instead; use findAliveTodosForAdmin() if you really wish to retrieve Admin TODOs.
List<Todo>	findAliveTodosForUser(String personId) Finds Todos created by this model instance in the given person todo list.
List<Todo>	findAliveTodosForUser(TestPerson 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).
List<Signal>	findSignals() Finds signals sent to this model instance.
Todo	findSingleAliveTodo(String title) Finds an alive Todo with the given title.
Todo	findSingleAliveTodo(String title, boolean includeContent) Finds an alive Todo with the given title.
Todo	findSingleAliveTodoForCurrentUser(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, String title) Finds todos with the given status and a title which match the given title pattern.
EvaluationResultValue	gc() Performs a GC.
GoalState	getGoalState(String goal) Returns a state of the given goal.
ModelInstanceInfo	getInfo()
ModelInstanceLogs	getLogs() Gets all log entries for this model instance.
long	getMainContextId()
String	getModelName()
String	getModelVersion()
ModelInstanceLogs	getNewLogs() Gets the log entries that were added after the method getLogs() or getNewLogs() was called the last time.
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<Signal>	getSignalQueue() Returns the signal queue for this model instance.
ModelInstanceState	getState() Returns the model instance state
Object	getVariableValue(String name) Returns the global variable value.
void	notifyModelInstance() Wakes up the model execution and continues the processing.
void	resumeModelInstance() Resumes the model execution.
void	sendSignal(String signal) Sends a signal to this model instance, with given signal value, or payload.
void	stop() Stops this model instance.
void	submitTodo(String title) Asserts that there is a single alive todo with a given title and submits it.
void	submitTodo(Todo todo)
void	submitTodos(Iterable<Todo> todos)
void	suspendModelInstance() Suspends the model execution.
long	updateModel(String migrationName, ByteData migrationConfig) Updates a model.
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(String signalString, 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, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

id

public final long id

The model instance ID.

Constructor Detail

ModelInstance

public ModelInstance(long id)

Method Detail

getModelName

public String getModelName()

getModelVersion

public String getModelVersion()

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

execute

public EvaluationResultValue execute(String expression,
                                     Todo todo)
                              throws ErrorException,
                                     ValidationException

Evaluates expression in base evaluation level in the context of the given To-do.

Parameters:

expression -

todo -

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

stop

public void stop()

Stops this model instance.

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

getNewLogs

public ModelInstanceLogs getNewLogs()

Gets the log entries that were added after the method getLogs() or getNewLogs() was called the last time.

Returns:

the new log entries

submitTodo

public void submitTodo(Todo todo)

Parameters:

todo -

submitTodos

public void submitTodos(Iterable<Todo> todos)

escalateTodo

public void escalateTodo(Todo todo,
                         String reasonText)

escalateTodo

public void escalateTodo(long todoId,
                         String reasonText)

getState

public ModelInstanceState getState()

Returns the model instance state

Returns:

the state, not null.

getInfo

public ModelInstanceInfo getInfo()

sendSignal

public void sendSignal(String signal)

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

Parameters:

signal - the signal value, may be null.

findTodos

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

Finds todos with the given status and a title which match the given title pattern.

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

findTodos

public List<Todo> findTodos()

Finds Todos created by this model instance.

Returns:

the list of Todos

findAliveTodosForCurrentUser

@Deprecated
public List<Todo> findAliveTodosForCurrentUser()

Deprecated. a misleading method name as it returns TODOs for Admin only. Use findAliveTodosForUser(String) or findAliveTodosForUser(TestPerson) instead; use findAliveTodosForAdmin() if you really wish to retrieve Admin TODOs.

Finds Todos created by this model instance in the Admin's todo list.

Returns:

the list of Admin Todos, not null.

findAliveTodosForAdmin

public List<Todo> findAliveTodosForAdmin()

Finds Todos created by this model instance in the Admin's todo list.

Returns:

the list of Todos, not null.

findAliveTodosForUser

public List<Todo> findAliveTodosForUser(String personId)
                                 throws PersonNotFoundException

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

Parameters:

personId -

Returns:

the list of Todos

Throws:

PersonNotFoundException

findAliveTodosForUser

public List<Todo> findAliveTodosForUser(TestPerson person)
                                 throws PersonNotFoundException

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

Parameters:

person - a person

Returns:

the list of Todos

Throws:

PersonNotFoundException

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:

RuntimeException - if more than one such a Todo is found

findSingleAliveTodo

public Todo findSingleAliveTodo(String title,
                                boolean includeContent)

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

Parameters:

title - the title of the Todo

includeContent - a flag specifying whether Todo content should be included

Returns:

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

Throws:

RuntimeException - if more than one such a Todo is found

findSingleAliveTodoForCurrentUser

public Todo findSingleAliveTodoForCurrentUser(String title)

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

Parameters:

title -

Returns:

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

Throws:

RuntimeException - if more than one such a Todo is found

findSignals

public List<Signal> findSignals()

Finds signals sent to this model instance.

Returns:

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

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

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

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(String signalString,
                          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:

RuntimeException - 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:

RuntimeException - 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 global variable value.

Parameters:

name - the global variable name.

Returns:

the value, may be null.

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.

suspendModelInstance

public void suspendModelInstance()

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

resumeModelInstance

public void resumeModelInstance()

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.

getSignalQueue

public List<Signal> getSignalQueue()

Returns the signal queue for this model instance.

Returns:

the signal queue, never null, may be empty.