org.jbpm.command
Class ChangeProcessInstanceVersionCommand

java.lang.Object
  org.jbpm.command.AbstractBaseCommand
      org.jbpm.command.AbstractProcessInstanceBaseCommand
          org.jbpm.command.ChangeProcessInstanceVersionCommand

All Implemented Interfaces:

Serializable, Command

public class ChangeProcessInstanceVersionCommand
extends AbstractProcessInstanceBaseCommand

Migrate a process instance to a different version of its process definition.

Migration works only if the active nodes are also available in the target process definition version or a node name mapping is provided.

Known limitations

• Task definitions cannot move to another node. If an active TaskInstance exists, the Task definition must exist in the TaskNode with the same (or mapped) name. Otherwise the right node cannot be found easily because it may be ambiguous.
• Subprocesses are not tested yet. Since the ProcessState is a Node like any other, it should work anyway.
• Migration can have negative impact on referential integrity because the ProcessInstance may have ProcessLogs pointing to the old ProcessDefinition. Hence, deleting a ProcessDefinition may not work and throw constraint violation exceptions.
• The JBoss ESB uses Token.id and Node.id as correlation identifier. After changing the version of a ProcessInstance the node identifier has changed, so a signal from ESB will result in an exception and has to be corrected manually.

Author:

Bernd Ruecker (bernd.ruecker@camunda.com)

See Also:

Serialized Form

Constructor Summary

ChangeProcessInstanceVersionCommand()

ChangeProcessInstanceVersionCommand(long processInstanceId, int newVersion)

Method Summary

ProcessInstance	execute(ProcessInstance pi)
String	getAdditionalToStringInformation()
Map	getNameMapping() Deprecated. use getNodeNameMapping instead
int	getNewVersion()
Map	getNodeNameMapping()
long	getProcessId() Deprecated. use getProcessInstanceId instead
Map	getTaskNameMapping()
ChangeProcessInstanceVersionCommand	newVersion(int newVersion)
ChangeProcessInstanceVersionCommand	nodeNameMapping(Map nameMapping)
ChangeProcessInstanceVersionCommand	nodeNameMappingAdd(String oldNodeName, String newNodeName)
void	setNameMapping(Map nameMapping) Deprecated. use setNodeNameMapping instead
void	setNewVersion(int newVersion)
void	setNodeNameMapping(Map nameMapping)
void	setProcessId(long processId) Deprecated. use setProcessInstanceId instead
void	setTaskNameMapping(Map nameMapping)
ChangeProcessInstanceVersionCommand	taskNameMapping(Map nameMapping)
ChangeProcessInstanceVersionCommand	taskNameMappingAdd(String oldTaskName, String newNodeName)

Methods inherited from class org.jbpm.command.AbstractProcessInstanceBaseCommand

execute, getJbpmContext, getProcessInstanceId, getProcessInstanceIds, getProcessName, getProcessVersion, isOnlyRunning, onlyRunning, processInstanceId, processInstanceIds, processName, processVersion, setOnlyRunning, setProcessInstanceId, setProcessInstanceIds, setProcessName, setProcessVersion, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

ChangeProcessInstanceVersionCommand

public ChangeProcessInstanceVersionCommand()

ChangeProcessInstanceVersionCommand

public ChangeProcessInstanceVersionCommand(long processInstanceId,
                                           int newVersion)

Method Detail

getAdditionalToStringInformation

public String getAdditionalToStringInformation()

Overrides:

getAdditionalToStringInformation in class AbstractBaseCommand

execute

public ProcessInstance execute(ProcessInstance pi)

Specified by:

execute in class AbstractProcessInstanceBaseCommand

getNodeNameMapping

public Map getNodeNameMapping()

setNodeNameMapping

public void setNodeNameMapping(Map nameMapping)

getNewVersion

public int getNewVersion()

setNewVersion

public void setNewVersion(int newVersion)

getTaskNameMapping

public Map getTaskNameMapping()

setTaskNameMapping

public void setTaskNameMapping(Map nameMapping)

getProcessId

public long getProcessId()

Deprecated. use getProcessInstanceId instead

setProcessId

public void setProcessId(long processId)

Deprecated. use setProcessInstanceId instead

getNameMapping

public Map getNameMapping()

Deprecated. use getNodeNameMapping instead

setNameMapping

public void setNameMapping(Map nameMapping)

Deprecated. use setNodeNameMapping instead

nodeNameMapping

public ChangeProcessInstanceVersionCommand nodeNameMapping(Map nameMapping)

newVersion

public ChangeProcessInstanceVersionCommand newVersion(int newVersion)

taskNameMapping

public ChangeProcessInstanceVersionCommand taskNameMapping(Map nameMapping)

nodeNameMappingAdd

public ChangeProcessInstanceVersionCommand nodeNameMappingAdd(String oldNodeName,
                                                              String newNodeName)

taskNameMappingAdd

public ChangeProcessInstanceVersionCommand taskNameMappingAdd(String oldTaskName,
                                                              String newNodeName)