Package org.flowable.engine.impl.cmd

Class MessageEventReceivedCmd

java.lang.Object

org.flowable.engine.impl.cmd.NeedsActiveExecutionCmd<Void>

org.flowable.engine.impl.cmd.MessageEventReceivedCmd

All Implemented Interfaces:

Serializable, Command<Void>

public class MessageEventReceivedCmd
extends NeedsActiveExecutionCmd<Void>

Author:

Daniel Meyer, Joram Barrez

See Also:

• Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
protected final boolean	async
protected final String	messageName
protected final Map<String,Object>	payload

Fields inherited from class org.flowable.engine.impl.cmd.NeedsActiveExecutionCmd

executionId

Constructor Summary

Constructors

Constructor	Description
MessageEventReceivedCmd(String messageName, String executionId, boolean async)
MessageEventReceivedCmd(String messageName, String executionId, Map<String,Object> processVariables)

Method Summary

Modifier and Type	Method	Description
protected Void	execute(CommandContext commandContext, ExecutionEntity execution)	Subclasses should implement this method.
protected String	getSuspendedExceptionMessagePrefix()	Subclasses can override this to provide a more detailed exception message that will be thrown when the execution is suspended.

Methods inherited from class org.flowable.engine.impl.cmd.NeedsActiveExecutionCmd

execute

Methods inherited from class java.lang.Object

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

Field Details

payload

protected final Map<String,Object> payload

messageName

protected final String messageName

async

protected final boolean async

Constructor Details

MessageEventReceivedCmd

public MessageEventReceivedCmd(String messageName,
 String executionId,
 Map<String,Object> processVariables)

MessageEventReceivedCmd

public MessageEventReceivedCmd(String messageName,
 String executionId,
 boolean async)

Method Details

execute

protected Void execute(CommandContext commandContext,
 ExecutionEntity execution)

Description copied from class: NeedsActiveExecutionCmd

Subclasses should implement this method. The provided ExecutionEntity is guaranteed to be active (ie. not suspended).

Specified by:

execute in class NeedsActiveExecutionCmd<Void>

getSuspendedExceptionMessagePrefix

protected String getSuspendedExceptionMessagePrefix()

Description copied from class: NeedsActiveExecutionCmd

Subclasses can override this to provide a more detailed exception message that will be thrown when the execution is suspended.

Overrides:

getSuspendedExceptionMessagePrefix in class NeedsActiveExecutionCmd<Void>