com.whitestein.lsps.engine

Class ProcessServiceBean

java.lang.Object

com.whitestein.lsps.common.SecureAndLoggingService

com.whitestein.lsps.engine.ProcessServiceBean

All Implemented Interfaces:

ProcessServiceLocal, ProcessServiceRemote, ProcessService

@PermitAll
public class ProcessServiceBean
extends com.whitestein.lsps.common.SecureAndLoggingService
implements ProcessServiceLocal, ProcessServiceRemote

Service for accessing process instances.

Author:

rba

Field Summary

Fields inherited from class com.whitestein.lsps.common.SecureAndLoggingService

PRINCIPAL_KEY

Constructor Summary

Constructors

Constructor and Description
ProcessServiceBean() Creates new instance.
ProcessServiceBean(ModelInstanceDao modelInstanceDao, ProcessLogDao processLogDao, ModelProviderService modelProviderService, CommunicationService communicationService) Creates new instance.

Method Summary

Modifier and Type	Method and Description
ExecutionTrace	createAndStartModelInstance(long modelId, StringProperties properties, boolean synchronously, boolean startInterpretation) Creates new model instance for given model id and properties and possibly starts the model instance interpretation, This can be done either synchronously or asynchronously.
ExecutionTrace	createAndStartModelInstanceWithParent(long modelId, StringProperties properties, Long parentModelInstanceId, boolean synchronously, boolean startInterpretation) Creates new model instance for given model id and properties and possibly starts the model instance interpretation, This can be done either synchronously or asynchronously.
ExecutionTrace	createModelInstance(long modelId, StringProperties properties, boolean synchronously) Creates new model instance for given model id and properties.
Long	createModelInstanceSimple(long modelId, StringProperties properties, boolean synchronously) Creates new model instance for given model id and properties.
ModelInstanceInfoList	findModelInstances(ModelInstanceCriteria criteria) Returns model instance info-s according to the provided criteria.
CompressedModelInstance	getCompressedModelInstance(long modelInstanceId) Returns a compressed model instance execution state for given model instance* id or null if it does not exist.
CompressedString	getCompressedModelInstanceXml(long modelInstanceId, List<ModelInstanceData> data) Returns the specified model instance as an xml structure or null if it does not exist.
CompressedData	getCompressedRawModelInstanceXml(long modelInstanceId) Returns the specified model instance as an xml structure or null if it does not exist.
ModelInstance	getModelInstance(long modelInstanceId) Returns complete model instance execution state for given model instance id or null if it does not exist.
ModelInstanceInfo	getModelInstanceInfo(long modelInstanceId) Returns model instance info for given model instance id or null if it does not exist.
String	getModelInstanceXml(long modelInstanceId, List<ModelInstanceData> data) Returns the specified model instance as an xml structure or null if it does not exist.
ByteData	getRawModelInstanceXml(long modelInstanceId) Returns the specified model instance as an xml structure or null if it does not exist.
void	notifyModelInstance(long modelInstanceId, String reason, boolean synchronously) Notifies a model instance.
void	notifyTask(long modelInstanceId, long taskId, String reason, boolean synchronously) Notifies a task in model instance.
void	removeAllFormPreviewModelInstances() Removes all model instances created by form preview.
void	removeSignalFromModelInstance(long modelInstanceId, long id, boolean synchronously) Removes a signal from a running model instance.
ExternalRecordValue	resolveReference(long modelInstanceId, ExternalRecordValue value) Resolves external record value reference to a value, attributes of which are populated.
void	restartModelInstances(Collection<Long> modelInstanceIds, long newModuleId) Restarts model instances with new model.
void	resumeModelInstance(long modelInstanceId, boolean synchronously) Resumes model instance execution.
ExecutionTrace	sendSignalToModelInstance(long modelInstanceId, ObjectValue signal, boolean synchronously) Sends a signal to a running model instance.
void	setCompressedRawModelInstanceXml(long modelInstanceId, CompressedData data) Sets the model instance state.
void	setRawModelInstanceXml(long modelInstanceId, ByteData data) Sets the model instance state.
ExecutionTrace	startInterpretModelInstance(long modelInstanceId, boolean synchronously) Starts the interpretation of an existing model instance for given model instance id.
List<Long>	startInterpretModelInstanceSimple(long modelInstanceId, boolean synchronously) Starts the interpretation of an existing model instance for given model instance id.
void	suspendModelInstance(long modelInstanceId, boolean synchronously) Suspends model instance execution.
ExecutionTrace	terminateModelInstance(long modelInstanceId, boolean synchronously) Terminates model instance for given model instance id.
void	updateContextVariable(long modelInstanceId, long contextId, String variable, ObjectValue value, boolean synchronously) Updates the value of a given variable.
void	updateGoalState(long modelInstanceId, long processInstanceId, String goalName, boolean reactivate, boolean synchronously) Changes the state of the given goal.
void	updateRecordField(long modelInstanceId, String recordType, String recordId, String field, ObjectValue value, boolean synchronously) Updates the value of a given record field.

Methods inherited from class com.whitestein.lsps.common.SecureAndLoggingService

getCurrentTransactionData, getOriginalPrincipal, getSecurityManagerService

Methods inherited from class java.lang.Object

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

Constructor Detail

ProcessServiceBean

public ProcessServiceBean()

Creates new instance.

ProcessServiceBean

public ProcessServiceBean(ModelInstanceDao modelInstanceDao,
                          ProcessLogDao processLogDao,
                          ModelProviderService modelProviderService,
                          CommunicationService communicationService)

Creates new instance.

Parameters:

modelInstanceDao -

processLogDao -

modelProviderService -

communicationService -

Throws:

NullPointerException - if any argument is null

Method Detail

getModelInstanceInfo

@RightsAllowed(value="ModelInstance:Read")
public ModelInstanceInfo getModelInstanceInfo(long modelInstanceId)

Description copied from interface: ProcessService

Returns model instance info for given model instance id or null if it does not exist.

Specified by:

getModelInstanceInfo in interface ProcessService

Parameters:

modelInstanceId - process id

Returns:

process info for given model instance id

findModelInstances

@RightsAllowed(value="ModelInstance:Read")
public ModelInstanceInfoList findModelInstances(ModelInstanceCriteria criteria)

Description copied from interface: ProcessService

Returns model instance info-s according to the provided criteria. The list is ordered by id. The model instance info-s have no informations about the model instance model.

Specified by:

findModelInstances in interface ProcessService

Parameters:

criteria - criteria for searching

Returns:

collection of ModelInstanceInfos

getModelInstance

@RightsAllowed(value="ModelInstance:Read")
public ModelInstance getModelInstance(long modelInstanceId)

Description copied from interface: ProcessService

Returns complete model instance execution state for given model instance id or null if it does not exist. The state does not contain BPMN transactions.

Specified by:

getModelInstance in interface ProcessService

Returns:

model instance execution state

getCompressedModelInstance

@RightsAllowed(value="ModelInstance:Read")
public CompressedModelInstance getCompressedModelInstance(long modelInstanceId)

Description copied from interface: ProcessService

Returns a compressed model instance execution state for given model instance* id or null if it does not exist. The state does not contain BPMN transactions.

Use this method when transferring large model instance states over the network.

Specified by:

getCompressedModelInstance in interface ProcessService

Returns:

a compressed model instance execution state

sendSignalToModelInstance

@RightsAllowed(value="Signal:Send")
public ExecutionTrace sendSignalToModelInstance(long modelInstanceId,
                                                                                    ObjectValue signal,
                                                                                    boolean synchronously)
                                                                             throws ModelInstanceNotFoundException,
                                                                                    InvalidModelInstanceStateException,
                                                                                    ErrorException

Description copied from interface: ProcessService

Sends a signal to a running model instance.

Specified by:

sendSignalToModelInstance in interface ProcessService

Returns:

null or instance of ExecutionTrace, which describes model instance interpretation

Throws:

ModelInstanceNotFoundException - if no running model instance exists for the given model instance id

InvalidModelInstanceStateException

ErrorException

See Also:

SimpleType

removeSignalFromModelInstance

@RightsAllowed(value="Signal:Remove")
public void removeSignalFromModelInstance(long modelInstanceId,
                                                                                long id,
                                                                                boolean synchronously)
                                                                         throws ModelInstanceNotFoundException,
                                                                                InvalidModelInstanceStateException,
                                                                                ErrorException

Description copied from interface: ProcessService

Removes a signal from a running model instance. Signal which you want to delete is identified by its index in signal queue and model instance by its model instance id.

Specified by:

removeSignalFromModelInstance in interface ProcessService

Throws:

ModelInstanceNotFoundException - if no running model instance exists for the given model instance id

InvalidModelInstanceStateException

ErrorException

createModelInstance

@RightsAllowed(value="ModelInstance:Create")
public ExecutionTrace createModelInstance(long modelId,
                                                                                       StringProperties properties,
                                                                                       boolean synchronously)
                                                                                throws ModuleNotFoundException

Description copied from interface: ProcessService

Creates new model instance for given model id and properties. This does not start the model instance interpretation, only creates the model instance. To start the interpretation see ProcessService.startInterpretModelInstance(long, boolean). This can be done either synchronously or asynchronously. If asynchronously, the returned ModelInstanceInfo will not contain the model instance id (the id will be -1).

Specified by:

createModelInstance in interface ProcessService

Returns:

execution trace

Throws:

ModuleNotFoundException - if no model exists for the given model id

createModelInstanceSimple

@RightsAllowed(value="ModelInstance:Create")
public Long createModelInstanceSimple(long modelId,
                                                                                   StringProperties properties,
                                                                                   boolean synchronously)
                                                                            throws ModuleNotFoundException

Description copied from interface: ProcessService

Creates new model instance for given model id and properties. This does not start the model instance interpretation, only creates the model instance. To start the interpretation see ProcessService.startInterpretModelInstance(long, boolean). This can be done either synchronously or asynchronously. If asynchronously, the returned ModelInstanceInfo will not contain the model instance id (the id will be -1).

Specified by:

createModelInstanceSimple in interface ProcessService

Returns:

List of model instances

Throws:

ModuleNotFoundException - if no model exists for the given model id

createAndStartModelInstance

@RightsAllowed(value="ModelInstance:Create")
public ExecutionTrace createAndStartModelInstance(long modelId,
                                                                                               StringProperties properties,
                                                                                               boolean synchronously,
                                                                                               boolean startInterpretation)
                                                                                        throws ModuleNotFoundException

Description copied from interface: ProcessService

Creates new model instance for given model id and properties and possibly starts the model instance interpretation, This can be done either synchronously or asynchronously. If asynchronously, the returned ModelInstanceInfo will not contain the model instance id (the id will be -1).

Specified by:

createAndStartModelInstance in interface ProcessService

Returns:

execution trace

Throws:

ModuleNotFoundException - if no model exists for the given model id

createAndStartModelInstanceWithParent

@RightsAllowed(value="ModelInstance:Create")
public ExecutionTrace createAndStartModelInstanceWithParent(long modelId,
                                                                                                         StringProperties properties,
                                                                                                         Long parentModelInstanceId,
                                                                                                         boolean synchronously,
                                                                                                         boolean startInterpretation)
                                                                                                  throws ModuleNotFoundException

Description copied from interface: ProcessService

Creates new model instance for given model id and properties and possibly starts the model instance interpretation, This can be done either synchronously or asynchronously. If asynchronously, the returned execution trace will be empty.

Specified by:

createAndStartModelInstanceWithParent in interface ProcessService

parentModelInstanceId - id of the parent model instance, may be null

Returns:

execution trace

Throws:

ModuleNotFoundException - if no model exists for the given model id

terminateModelInstance

@RightsAllowed(value="ModelInstance:Terminate")
public ExecutionTrace terminateModelInstance(long modelInstanceId,
                                                                                             boolean synchronously)
                                                                                      throws ModelInstanceNotFoundException,
                                                                                             InvalidModelInstanceStateException

Description copied from interface: ProcessService

Terminates model instance for given model instance id. The top goals are de-activated and the model instance is archived.

Specified by:

terminateModelInstance in interface ProcessService

Returns:

null or instance of ExecutionTrace, which describes model instance interpretation

Throws:

ModelInstanceNotFoundException - if no running model instance exists for the given model instance id

InvalidModelInstanceStateException - if the model instance is finished

startInterpretModelInstance

@RightsAllowed(value="ModelInstance:Create")
public ExecutionTrace startInterpretModelInstance(long modelInstanceId,
                                                                                               boolean synchronously)
                                                                                        throws ModelInstanceNotFoundException,
                                                                                               InvalidModelInstanceStateException,
                                                                                               ErrorException

Description copied from interface: ProcessService

Starts the interpretation of an existing model instance for given model instance id.

Specified by:

startInterpretModelInstance in interface ProcessService

Returns:

null or instance of ExecutionTrace, which describes model instance interpretation

Throws:

ModelInstanceNotFoundException - if no running model instance exists for the given model instance id

InvalidModelInstanceStateException - if the model instance is finished

ErrorException

startInterpretModelInstanceSimple

@RightsAllowed(value="ModelInstance:Create")
public List<Long> startInterpretModelInstanceSimple(long modelInstanceId,
                                                                                                 boolean synchronously)
                                                                                          throws ModelInstanceNotFoundException,
                                                                                                 InvalidModelInstanceStateException,
                                                                                                 ErrorException

Description copied from interface: ProcessService

Starts the interpretation of an existing model instance for given model instance id.

Specified by:

startInterpretModelInstanceSimple in interface ProcessService

Returns:

null or List of todo IDs

Throws:

ModelInstanceNotFoundException - if no running model instance exists for the given model instance id

InvalidModelInstanceStateException - if the model instance is finished

ErrorException

updateContextVariable

@RightsAllowed(value="Variables:Update")
public void updateContextVariable(long modelInstanceId,
                                                                           long contextId,
                                                                           String variable,
                                                                           ObjectValue value,
                                                                           boolean synchronously)
                                                                    throws ModelInstanceNotFoundException,
                                                                           InvalidModelInstanceStateException,
                                                                           ErrorException

Description copied from interface: ProcessService

Updates the value of a given variable.

Specified by:

updateContextVariable in interface ProcessService

Throws:

ModelInstanceNotFoundException - if no running model instance exists for the given model instance id

InvalidModelInstanceStateException

ErrorException

updateRecordField

@RightsAllowed(value="Variables:Update")
public void updateRecordField(long modelInstanceId,
                                                                       String recordType,
                                                                       String recordId,
                                                                       String field,
                                                                       ObjectValue value,
                                                                       boolean synchronously)
                                                                throws ModelInstanceNotFoundException,
                                                                       InvalidModelInstanceStateException,
                                                                       ErrorException

Description copied from interface: ProcessService

Updates the value of a given record field.

Specified by:

updateRecordField in interface ProcessService

recordId - The identifier of the record. The identifier is a string representation of the holder's handle.

Throws:

ModelInstanceNotFoundException - if no running model instance exists for the given model instance id

InvalidModelInstanceStateException

ErrorException

updateGoalState

@RightsAllowed(value="GoalState:Update")
public void updateGoalState(long modelInstanceId,
                                                                     long processInstanceId,
                                                                     String goalName,
                                                                     boolean reactivate,
                                                                     boolean synchronously)
                                                              throws ModelInstanceNotFoundException,
                                                                     InvalidModelInstanceStateException,
                                                                     ErrorException

Description copied from interface: ProcessService

Changes the state of the given goal.

Specified by:

updateGoalState in interface ProcessService

reactivate - true if the goal should be reactivated

Throws:

ModelInstanceNotFoundException - if no running model instance exists for the given model instance id

InvalidModelInstanceStateException

ErrorException

getModelInstanceXml

@RightsAllowed(value="ModelInstance:Read")
public String getModelInstanceXml(long modelInstanceId,
                                                                             List<ModelInstanceData> data)

Description copied from interface: ProcessService

Returns the specified model instance as an xml structure or null if it does not exist.

Specified by:

getModelInstanceXml in interface ProcessService

Returns:

model instance data values

getCompressedModelInstanceXml

@RightsAllowed(value="ModelInstance:Read")
public CompressedString getCompressedModelInstanceXml(long modelInstanceId,
                                                                                                 List<ModelInstanceData> data)

Description copied from interface: ProcessService

Returns the specified model instance as an xml structure or null if it does not exist.

Specified by:

getCompressedModelInstanceXml in interface ProcessService

Returns:

model instance data values

getRawModelInstanceXml

@RightsAllowed(value="ModelInstance:Read")
public ByteData getRawModelInstanceXml(long modelInstanceId)

Description copied from interface: ProcessService

Returns the specified model instance as an xml structure or null if it does not exist.

Unlike ProcessService.getCompressedModelInstanceXml(long, List), this method returns the raw XML as is stored in model instance state. This is useful when the XML is not valid and cannot be unmarshalled by JAXB.

Specified by:

getRawModelInstanceXml in interface ProcessService

Returns:

model instance data values

getCompressedRawModelInstanceXml

@RightsAllowed(value="ModelInstance:Read")
public CompressedData getCompressedRawModelInstanceXml(long modelInstanceId)

Description copied from interface: ProcessService

Returns the specified model instance as an xml structure or null if it does not exist.

Unlike ProcessService.getCompressedModelInstanceXml(long, List), this method returns the raw XML as is stored in model instance state. This is useful when the XML is not valid and cannot be unmarshalled by JAXB.

Specified by:

getCompressedRawModelInstanceXml in interface ProcessService

Returns:

model instance data values

setRawModelInstanceXml

@RightsAllowed(value="ModelInstance:Write")
public void setRawModelInstanceXml(long modelInstanceId,
                                                                               ByteData data)
                                                                        throws ModelInstanceNotFoundException,
                                                                               InvalidModelInstanceStateException

Description copied from interface: ProcessService

Sets the model instance state.

Specified by:

setRawModelInstanceXml in interface ProcessService

Throws:

ModelInstanceNotFoundException

InvalidModelInstanceStateException

setCompressedRawModelInstanceXml

@RightsAllowed(value="ModelInstance:Write")
public void setCompressedRawModelInstanceXml(long modelInstanceId,
                                                                                         CompressedData data)
                                                                                  throws ModelInstanceNotFoundException,
                                                                                         InvalidModelInstanceStateException

Description copied from interface: ProcessService

Sets the model instance state.

Specified by:

setCompressedRawModelInstanceXml in interface ProcessService

Throws:

ModelInstanceNotFoundException

InvalidModelInstanceStateException

resumeModelInstance

@RightsAllowed(value="ModelInstance:Suspend")
public void resumeModelInstance(long modelInstanceId,
                                                                              boolean synchronously)
                                                                       throws ModelInstanceNotFoundException,
                                                                              InvalidModelInstanceStateException,
                                                                              ErrorException

Description copied from interface: ProcessService

Resumes model instance execution.

Specified by:

resumeModelInstance in interface ProcessService

Throws:

ModelInstanceNotFoundException - if no running model instance exists for the given model instance id

InvalidModelInstanceStateException

ErrorException

suspendModelInstance

@RightsAllowed(value="ModelInstance:Suspend")
public void suspendModelInstance(long modelInstanceId,
                                                                               boolean synchronously)
                                                                        throws ModelInstanceNotFoundException,
                                                                               InvalidModelInstanceStateException,
                                                                               ErrorException

Description copied from interface: ProcessService

Suspends model instance execution.

Specified by:

suspendModelInstance in interface ProcessService

Throws:

ModelInstanceNotFoundException - if no running model instance exists for the given model instance id

InvalidModelInstanceStateException

ErrorException

notifyModelInstance

@RightsAllowed(value="ModelInstance:Notify")
public void notifyModelInstance(long modelInstanceId,
                                                                             String reason,
                                                                             boolean synchronously)
                                                                      throws ModelInstanceNotFoundException,
                                                                             InvalidModelInstanceStateException,
                                                                             ErrorException

Description copied from interface: ProcessService

Notifies a model instance.

Specified by:

notifyModelInstance in interface ProcessService

Throws:

ModelInstanceNotFoundException - if no running model instance exists for the given model instance id

InvalidModelInstanceStateException

ErrorException

notifyTask

@RightsAllowed(value="ModelInstance:Notify")
public void notifyTask(long modelInstanceId,
                                                                    long taskId,
                                                                    String reason,
                                                                    boolean synchronously)
                                                             throws ModelInstanceNotFoundException,
                                                                    InvalidModelInstanceStateException,
                                                                    ErrorException

Description copied from interface: ProcessService

Notifies a task in model instance.

Specified by:

notifyTask in interface ProcessService

Throws:

ModelInstanceNotFoundException - if no running model instance exists for the given model instance id

InvalidModelInstanceStateException

ErrorException

removeAllFormPreviewModelInstances

@RightsAllowed(value="ModelInstance:Read")
public void removeAllFormPreviewModelInstances()

Description copied from interface: ProcessService

Removes all model instances created by form preview.

Specified by:

removeAllFormPreviewModelInstances in interface ProcessService

resolveReference

public ExternalRecordValue resolveReference(long modelInstanceId,
                                            ExternalRecordValue value)
                                     throws ModelInstanceNotFoundException

Description copied from interface: ProcessService

Resolves external record value reference to a value, attributes of which are populated.

Specified by:

resolveReference in interface ProcessService

Parameters:

modelInstanceId - the identifier of the model instance in which the value is defined

value - an external record value which is just a reference, that is it's ExternalRecordValue.isReferenceOnly() returns true.

Returns:

an external record value with populated attributes

Throws:

ModelInstanceNotFoundException

See Also:

ExternalRecordValue.isReferenceOnly()

restartModelInstances

public void restartModelInstances(Collection<Long> modelInstanceIds,
                                  long newModuleId)
                           throws ModelInstanceNotFoundException,
                                  InvalidModelInstanceStateException,
                                  ErrorException

Description copied from interface: ProcessService

Restarts model instances with new model. State of each model instance is backed up.

Specified by:

restartModelInstances in interface ProcessService

newModuleId - id of the new module, if -1 the current model of each instance is used

Throws:

ModelInstanceNotFoundException

InvalidModelInstanceStateException

ErrorException