Package org.camunda.bpm.engine.impl.cmd

Class CorrelateAllMessageCmd

java.lang.Object

org.camunda.bpm.engine.impl.cmd.AbstractCorrelateMessageCmd

org.camunda.bpm.engine.impl.cmd.CorrelateAllMessageCmd

All Implemented Interfaces:

SynchronousOperationLogProducer<MessageCorrelationResultImpl>, Command<List<MessageCorrelationResultImpl>>

public class CorrelateAllMessageCmd
extends AbstractCorrelateMessageCmd
implements Command<List<MessageCorrelationResultImpl>>, SynchronousOperationLogProducer<MessageCorrelationResultImpl>

Author:

Thorben Lindhauer, Daniel Meyer, Michael Scholz

Field Summary

Fields inherited from class org.camunda.bpm.engine.impl.cmd.AbstractCorrelateMessageCmd

builder, deserializeVariableValues, messageName, variablesCount, variablesInResultEnabled, variablesListener

Fields inherited from interface org.camunda.bpm.engine.impl.history.SynchronousOperationLogProducer

SUMMARY_LOG, UNLIMITED_LOG

Constructor Summary

Constructors

Constructor	Description
CorrelateAllMessageCmd(MessageCorrelationBuilderImpl messageCorrelationBuilderImpl, boolean collectVariables, boolean deserializeVariableValues)	Initialize the command with a builder

Method Summary

Modifier and Type	Method	Description
void	createOperationLogEntry(CommandContext commandContext, MessageCorrelationResultImpl result, List<PropertyChange> propChanges, boolean isSummary)	Calls the code that produces the operation log.
List<MessageCorrelationResultImpl>	execute(CommandContext commandContext)
protected List<PropertyChange>	getGenericPropChangesForOperation()
Map<MessageCorrelationResultImpl,List<PropertyChange>>	getPropChangesForOperation(List<MessageCorrelationResultImpl> results)	Returns a map containing a list of changed properties for every result of the operation.
List<PropertyChange>	getSummarizingPropChangesForOperation(List<MessageCorrelationResultImpl> results)	Returns a list of changed properties summarizing the whole operation involving multiple entities.

Methods inherited from class org.camunda.bpm.engine.impl.cmd.AbstractCorrelateMessageCmd

checkAuthorization, countVariables, createMessageCorrelationResult, findProcessInstanceExecution, instantiateProcess, resolveVariables, triggerExecution

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.camunda.bpm.engine.impl.interceptor.Command

isRetryable

Methods inherited from interface org.camunda.bpm.engine.impl.history.SynchronousOperationLogProducer

produceOperationLog

Constructor Details

CorrelateAllMessageCmd

public CorrelateAllMessageCmd(MessageCorrelationBuilderImpl messageCorrelationBuilderImpl,
 boolean collectVariables,
 boolean deserializeVariableValues)

Initialize the command with a builder

Parameters:

messageCorrelationBuilderImpl -

Method Details

execute

public List<MessageCorrelationResultImpl> execute(CommandContext commandContext)

Specified by:

execute in interface Command<List<MessageCorrelationResultImpl>>

createOperationLogEntry

public void createOperationLogEntry(CommandContext commandContext,
 MessageCorrelationResultImpl result,
 List<PropertyChange> propChanges,
 boolean isSummary)

Description copied from interface: SynchronousOperationLogProducer

Calls the code that produces the operation log. Usually commandContext.getOperationLogManager().log... The implementation must be capable of producing a single, summarizing operation log that contain information about an operation spanning affecting multiple entities as well as producing a single, detailed operation log containing information about a single affected entity. This method is called by the produceOperationLog method.

Specified by:

createOperationLogEntry in interface SynchronousOperationLogProducer<MessageCorrelationResultImpl>

Parameters:

commandContext - the current command context

result - An object resulting from the operation for which this method produces the operation log. In case the operation produced multiple objects, depending on the implementation a representative object from the list of results or null can be passed.

propChanges - property changes to be attached to the operation log

isSummary - indicates whether the implementation should produce a summary log or a detailed log

getPropChangesForOperation

public Map<MessageCorrelationResultImpl,List<PropertyChange>> getPropChangesForOperation(List<MessageCorrelationResultImpl> results)

Description copied from interface: SynchronousOperationLogProducer

Returns a map containing a list of changed properties for every result of the operation. Used to produce an operation log entry per entry contained in the returned map.

Specified by:

getPropChangesForOperation in interface SynchronousOperationLogProducer<MessageCorrelationResultImpl>

getSummarizingPropChangesForOperation

public List<PropertyChange> getSummarizingPropChangesForOperation(List<MessageCorrelationResultImpl> results)

Description copied from interface: SynchronousOperationLogProducer

Returns a list of changed properties summarizing the whole operation involving multiple entities.

Specified by:

getSummarizingPropChangesForOperation in interface SynchronousOperationLogProducer<MessageCorrelationResultImpl>

getGenericPropChangesForOperation

protected List<PropertyChange> getGenericPropChangesForOperation()