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

Class AbstractSetProcessDefinitionStateCmd

java.lang.Object

org.camunda.bpm.engine.impl.cmd.AbstractSetStateCmd

org.camunda.bpm.engine.impl.cmd.AbstractSetProcessDefinitionStateCmd

All Implemented Interfaces:

Command<Void>

Direct Known Subclasses:

ActivateProcessDefinitionCmd, SuspendProcessDefinitionCmd

public abstract class AbstractSetProcessDefinitionStateCmd
extends AbstractSetStateCmd

Author:

Daniel Meyer, Joram Barrez, roman.smirnov

Field Summary

Fields

Modifier and Type	Field	Description
static final String	INCLUDE_PROCESS_INSTANCES_PROPERTY
protected boolean	isTenantIdSet
protected String	processDefinitionId
protected String	processDefinitionKey
protected String	tenantId

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

executionDate, includeSubResources, isLogUserOperationDisabled, SUSPENSION_STATE_PROPERTY

Constructor Summary

Constructors

Constructor	Description
AbstractSetProcessDefinitionStateCmd(UpdateProcessDefinitionSuspensionStateBuilderImpl builder)

Method Summary

Modifier and Type	Method	Description
protected void	checkAuthorization(CommandContext commandContext)
protected void	checkParameters(CommandContext commandContext)
protected UpdateJobDefinitionSuspensionStateBuilderImpl	createJobDefinitionCommandBuilder()
protected UpdateProcessInstanceSuspensionStateBuilderImpl	createProcessInstanceCommandBuilder()
protected abstract String	getDelayedExecutionJobHandlerType()	Subclasses should return the type of the JobHandler here.
protected String	getDeploymentId(CommandContext commandContext)
protected JobHandlerConfiguration	getJobHandlerConfiguration()
protected AbstractSetProcessInstanceStateCmd	getNextCommand()
protected abstract AbstractSetProcessInstanceStateCmd	getNextCommand(UpdateProcessInstanceSuspensionStateBuilderImpl processInstanceCommandBuilder)
protected abstract AbstractSetJobDefinitionStateCmd	getSetJobDefinitionStateCmd(UpdateJobDefinitionSuspensionStateBuilderImpl jobDefinitionSuspensionStateBuilder)	Subclasses should return the type of the AbstractSetJobDefinitionStateCmd here.
protected void	logUserOperation(CommandContext commandContext)
protected void	updateSuspensionState(CommandContext commandContext, SuspensionState suspensionState)

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

disableLogUserOperation, execute, getDeploymentIdByJobDefinition, getDeploymentIdByProcessDefinition, getDeploymentIdByProcessDefinitionKey, getLogEntryOperation, getNewSuspensionState, isIncludeSubResources, isLogUserOperationDisabled, scheduleSuspensionStateUpdate, triggerHistoryEvent

Methods inherited from class java.lang.Object

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

Field Details

INCLUDE_PROCESS_INSTANCES_PROPERTY

public static final String INCLUDE_PROCESS_INSTANCES_PROPERTY

See Also:

• Constant Field Values

processDefinitionId

protected String processDefinitionId

processDefinitionKey

protected String processDefinitionKey

tenantId

protected String tenantId

isTenantIdSet

protected boolean isTenantIdSet

Constructor Details

AbstractSetProcessDefinitionStateCmd

public AbstractSetProcessDefinitionStateCmd(UpdateProcessDefinitionSuspensionStateBuilderImpl builder)

Method Details

checkParameters

protected void checkParameters(CommandContext commandContext)

Specified by:

checkParameters in class AbstractSetStateCmd

checkAuthorization

protected void checkAuthorization(CommandContext commandContext)

Specified by:

checkAuthorization in class AbstractSetStateCmd

updateSuspensionState

protected void updateSuspensionState(CommandContext commandContext,
 SuspensionState suspensionState)

Specified by:

updateSuspensionState in class AbstractSetStateCmd

createJobDefinitionCommandBuilder

protected UpdateJobDefinitionSuspensionStateBuilderImpl createJobDefinitionCommandBuilder()

createProcessInstanceCommandBuilder

protected UpdateProcessInstanceSuspensionStateBuilderImpl createProcessInstanceCommandBuilder()

getJobHandlerConfiguration

protected JobHandlerConfiguration getJobHandlerConfiguration()

Overrides:

getJobHandlerConfiguration in class AbstractSetStateCmd

logUserOperation

protected void logUserOperation(CommandContext commandContext)

Specified by:

logUserOperation in class AbstractSetStateCmd

getDelayedExecutionJobHandlerType

protected abstract String getDelayedExecutionJobHandlerType()

Subclasses should return the type of the JobHandler here. it will be used when the user provides an execution date on which the actual state change will happen.

Overrides:

getDelayedExecutionJobHandlerType in class AbstractSetStateCmd

getSetJobDefinitionStateCmd

protected abstract AbstractSetJobDefinitionStateCmd getSetJobDefinitionStateCmd(UpdateJobDefinitionSuspensionStateBuilderImpl jobDefinitionSuspensionStateBuilder)

Subclasses should return the type of the AbstractSetJobDefinitionStateCmd here. It will be used to suspend or activate the JobDefinitions.

Parameters:

jobDefinitionSuspensionStateBuilder -

getNextCommand

protected AbstractSetProcessInstanceStateCmd getNextCommand()

Overrides:

getNextCommand in class AbstractSetStateCmd

getDeploymentId

protected String getDeploymentId(CommandContext commandContext)

Overrides:

getDeploymentId in class AbstractSetStateCmd

Returns:

the id of the associated deployment, only necessary if the command can potentially be executed in a scheduled way (i.e. if an AbstractSetStateCmd.executionDate can be set) so the job executor responsible for that deployment can execute the resulting job

getNextCommand

protected abstract AbstractSetProcessInstanceStateCmd getNextCommand(UpdateProcessInstanceSuspensionStateBuilderImpl processInstanceCommandBuilder)