All Downloads are FREE. Search and download functionalities are using the official Maven repository.

org.flowable.engine.impl.cmd.SetExecutionVariablesCmd Maven / Gradle / Ivy

There is a newer version: 7.0.1
Show newest version
/* Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 * 
 *      http://www.apache.org/licenses/LICENSE-2.0
 * 
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package org.flowable.engine.impl.cmd;

import java.util.Map;

import org.flowable.common.engine.impl.interceptor.CommandContext;
import org.flowable.engine.compatibility.Flowable5CompatibilityHandler;
import org.flowable.engine.impl.persistence.entity.ExecutionEntity;
import org.flowable.engine.impl.util.CommandContextUtil;
import org.flowable.engine.impl.util.Flowable5Util;
import org.flowable.engine.impl.util.VariableListenerUtil;

/**
 * @author Tom Baeyens
 * @author Joram Barrez
 */
public class SetExecutionVariablesCmd extends NeedsActiveExecutionCmd {

    private static final long serialVersionUID = 1L;

    protected Map variables;
    protected boolean isLocal;

    public SetExecutionVariablesCmd(String executionId, Map variables, boolean isLocal) {
        super(executionId);
        this.variables = variables;
        this.isLocal = isLocal;
    }

    @Override
    protected Object execute(CommandContext commandContext, ExecutionEntity execution) {

        if (Flowable5Util.isFlowable5ProcessDefinitionId(commandContext, execution.getProcessDefinitionId())) {
            Flowable5CompatibilityHandler compatibilityHandler = Flowable5Util.getFlowable5CompatibilityHandler();
            compatibilityHandler.setExecutionVariables(executionId, variables, isLocal);
            return null;
        }

        if (isLocal) {
            if (variables != null) {
                for (String variableName : variables.keySet()) {
                    execution.setVariableLocal(variableName, variables.get(variableName), false);
                }
            }
        } else {
            if (variables != null) {
                for (String variableName : variables.keySet()) {
                    execution.setVariable(variableName, variables.get(variableName), false);
                }
            }
        }

        // ACT-1887: Force an update of the execution's revision to prevent
        // simultaneous inserts of the same
        // variable. If not, duplicate variables may occur since optimistic
        // locking doesn't work on inserts
        execution.forceUpdate();
        
        if (VariableListenerUtil.hasVariableListenerEventDefinitions(execution.getProcessDefinitionId())) {
            CommandContextUtil.getAgenda(commandContext).planEvaluateVariableListenerEventsOperation(
                    execution.getProcessDefinitionId(), execution.getProcessInstanceId());
        }
        
        return null;
    }

    @Override
    protected String getSuspendedExceptionMessage() {
        return "Cannot set variables because execution '" + executionId + "' is suspended";
    }

}