org.camunda.bpm.engine.impl.migration.instance.parser.ActivityInstanceHandler Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of camunda-engine Show documentation
There is a newer version: 7.21.0
/*
 * Copyright Camunda Services GmbH and/or licensed to Camunda Services GmbH
 * under one or more contributor license agreements. See the NOTICE file
 * distributed with this work for additional information regarding copyright
 * ownership. Camunda licenses this file to you under the Apache License,
 * Version 2.0; 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.camunda.bpm.engine.impl.migration.instance.parser;

import java.util.ArrayList;
import java.util.Collections;
import java.util.List;

import org.camunda.bpm.engine.impl.core.delegate.CoreActivityBehavior;
import org.camunda.bpm.engine.impl.migration.instance.MigratingActivityInstance;
import org.camunda.bpm.engine.impl.persistence.entity.EventSubscriptionEntity;
import org.camunda.bpm.engine.impl.persistence.entity.ExecutionEntity;
import org.camunda.bpm.engine.impl.persistence.entity.JobEntity;
import org.camunda.bpm.engine.impl.persistence.entity.VariableInstanceEntity;
import org.camunda.bpm.engine.impl.pvm.delegate.MigrationObserverBehavior;
import org.camunda.bpm.engine.impl.pvm.process.ScopeImpl;
import org.camunda.bpm.engine.migration.MigrationInstruction;
import org.camunda.bpm.engine.runtime.ActivityInstance;
import org.camunda.bpm.engine.runtime.TransitionInstance;

/**
 * @author Thorben Lindhauer
 *
 */
public class ActivityInstanceHandler implements MigratingInstanceParseHandler {

  @Override
  public void handle(MigratingInstanceParseContext parseContext, ActivityInstance element) {
    MigratingActivityInstance migratingInstance = null;

    MigrationInstruction applyingInstruction = parseContext.getInstructionFor(element.getActivityId());
    ScopeImpl sourceScope = null;
    ScopeImpl targetScope = null;
    ExecutionEntity representativeExecution = parseContext.getMapping().getExecution(element);

    if (element.getId().equals(element.getProcessInstanceId())) {
      sourceScope = parseContext.getSourceProcessDefinition();
      targetScope = parseContext.getTargetProcessDefinition();
    }
    else {
      sourceScope = parseContext.getSourceProcessDefinition().findActivity(element.getActivityId());

      if (applyingInstruction != null) {
        String activityId = applyingInstruction.getTargetActivityId();
        targetScope = parseContext.getTargetProcessDefinition().findActivity(activityId);
      }
    }

    migratingInstance = parseContext.getMigratingProcessInstance()
        .addActivityInstance(
          applyingInstruction,
          element,
          sourceScope,
          targetScope,
          representativeExecution);

    MigratingActivityInstance parentInstance = parseContext.getMigratingActivityInstanceById(element.getParentActivityInstanceId());

    if (parentInstance != null) {
      migratingInstance.setParent(parentInstance);
    }

    CoreActivityBehavior sourceActivityBehavior = sourceScope.getActivityBehavior();
    if (sourceActivityBehavior instanceof MigrationObserverBehavior) {
      ((MigrationObserverBehavior) sourceActivityBehavior).onParseMigratingInstance(parseContext, migratingInstance);
    }

    parseContext.submit(migratingInstance);

    parseTransitionInstances(parseContext, migratingInstance);

    parseDependentInstances(parseContext, migratingInstance);
  }

  public void parseTransitionInstances(MigratingInstanceParseContext parseContext, MigratingActivityInstance migratingInstance) {
    for (TransitionInstance transitionInstance : migratingInstance.getActivityInstance().getChildTransitionInstances()) {
      parseContext.handleTransitionInstance(transitionInstance);
    }
  }

  public void parseDependentInstances(MigratingInstanceParseContext parseContext, MigratingActivityInstance migratingInstance) {
    parseContext.handleDependentVariables(migratingInstance, collectActivityInstanceVariables(migratingInstance));
    parseContext.handleDependentActivityInstanceJobs(migratingInstance, collectActivityInstanceJobs(migratingInstance));
    parseContext.handleDependentEventSubscriptions(migratingInstance, collectActivityInstanceEventSubscriptions(migratingInstance));
  }

  protected List collectActivityInstanceVariables(MigratingActivityInstance instance) {
    List variables = new ArrayList();
    ExecutionEntity representativeExecution = instance.resolveRepresentativeExecution();
    ExecutionEntity parentExecution = representativeExecution.getParent();

    // decide for representative execution and parent execution whether to none/all/concurrentLocal variables
    // belong to this activity instance
    boolean addAllRepresentativeExecutionVariables = instance.getSourceScope().isScope()
        || representativeExecution.isConcurrent();

    if (addAllRepresentativeExecutionVariables) {
      variables.addAll(representativeExecution.getVariablesInternal());
    }
    else {
      variables.addAll(getConcurrentLocalVariables(representativeExecution));
    }

    boolean addAnyParentExecutionVariables = parentExecution != null && instance.getSourceScope().isScope();
    if (addAnyParentExecutionVariables) {
      boolean addAllParentExecutionVariables = parentExecution.isConcurrent();

      if (addAllParentExecutionVariables) {
        variables.addAll(parentExecution.getVariablesInternal());
      }
      else {
        variables.addAll(getConcurrentLocalVariables(parentExecution));
      }
    }

    return variables;
  }

  protected List collectActivityInstanceEventSubscriptions(MigratingActivityInstance migratingInstance) {

    if (migratingInstance.getSourceScope().isScope()) {
      return migratingInstance.resolveRepresentativeExecution().getEventSubscriptions();
    }
    else {
      return Collections.emptyList();
    }
  }

  protected List collectActivityInstanceJobs(MigratingActivityInstance migratingInstance) {
    if (migratingInstance.getSourceScope().isScope()) {
      return migratingInstance.resolveRepresentativeExecution().getJobs();
    }
    else {
      return Collections.emptyList();
    }
  }

  public static List getConcurrentLocalVariables(ExecutionEntity execution) {
    List variables = new ArrayList();

    for (VariableInstanceEntity variable : execution.getVariablesInternal()) {
      if (variable.isConcurrentLocal()) {
        variables.add(variable);
      }
    }

    return variables;
  }


}