org.camunda.bpm.engine.impl.runtime
Class DefaultCorrelationHandler

java.lang.Object
  org.camunda.bpm.engine.impl.runtime.DefaultCorrelationHandler

All Implemented Interfaces:

CorrelationHandler

public class DefaultCorrelationHandler
extends Object
implements CorrelationHandler

Author:

Thorben Lindhauer, Daniel Meyer, Michael Scholz

Constructor Summary

DefaultCorrelationHandler()

Method Summary

MessageCorrelationResult	correlateMessage(CommandContext commandContext, String messageName, CorrelationSet correlationSet) Correlate the given message to either a waiting execution or a process definition with a message start event.
List<MessageCorrelationResult>	correlateMessages(CommandContext commandContext, String messageName, CorrelationSet correlationSet) Correlate the given message to all waiting executions and a process definition with a message start event.
protected List<MessageCorrelationResult>	correlateMessageToExecutions(CommandContext commandContext, String messageName, CorrelationSet correlationSet)
MessageCorrelationResult	correlateStartMessage(CommandContext commandContext, String messageName, CorrelationSet correlationSet) Correlate the given message to a process definition with a message start event.
protected MessageCorrelationResult	correlateStartMessageByEventSubscription(CommandContext commandContext, String messageName)
protected MessageCorrelationResult	correlateStartMessageByProcessDefinitionId(CommandContext commandContext, String messageName, String processDefinitionId)
protected String	findStartActivityIdByMessage(ProcessDefinitionEntity processDefinition, String messageName)
protected boolean	isMessageStartEventWithName(EventSubscriptionDeclaration declaration, String messageName)

Methods inherited from class java.lang.Object

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

Constructor Detail

DefaultCorrelationHandler

public DefaultCorrelationHandler()

Method Detail

correlateMessage

public MessageCorrelationResult correlateMessage(CommandContext commandContext,
                                                 String messageName,
                                                 CorrelationSet correlationSet)

Description copied from interface: CorrelationHandler

Correlate the given message to either a waiting execution or a process definition with a message start event.

Specified by:

correlateMessage in interface CorrelationHandler

correlationSet - any of its members may be null

Returns:

the matched correlation target or null if the message could not be correlated.

correlateMessages

public List<MessageCorrelationResult> correlateMessages(CommandContext commandContext,
                                                        String messageName,
                                                        CorrelationSet correlationSet)

Description copied from interface: CorrelationHandler

Correlate the given message to all waiting executions and a process definition with a message start event.

Specified by:

correlateMessages in interface CorrelationHandler

correlationSet - any of its members may be null

Returns:

all matched correlation targets or an empty List if the message could not be correlated.

correlateMessageToExecutions

protected List<MessageCorrelationResult> correlateMessageToExecutions(CommandContext commandContext,
                                                                      String messageName,
                                                                      CorrelationSet correlationSet)

correlateStartMessage

public MessageCorrelationResult correlateStartMessage(CommandContext commandContext,
                                                      String messageName,
                                                      CorrelationSet correlationSet)

Description copied from interface: CorrelationHandler

Correlate the given message to a process definition with a message start event.

Specified by:

correlateStartMessage in interface CorrelationHandler

correlationSet - any of its members may be null

Returns:

the matched correlation target or null if the message could not be correlated.

correlateStartMessageByEventSubscription

protected MessageCorrelationResult correlateStartMessageByEventSubscription(CommandContext commandContext,
                                                                            String messageName)

correlateStartMessageByProcessDefinitionId

protected MessageCorrelationResult correlateStartMessageByProcessDefinitionId(CommandContext commandContext,
                                                                              String messageName,
                                                                              String processDefinitionId)

findStartActivityIdByMessage

protected String findStartActivityIdByMessage(ProcessDefinitionEntity processDefinition,
                                              String messageName)

isMessageStartEventWithName

protected boolean isMessageStartEventWithName(EventSubscriptionDeclaration declaration,
                                              String messageName)