Examples with FlowScopeWalker org.camunda.bpm.engine.impl.tree.FlowScopeWalker used on opensource projects

Example 1 with FlowScopeWalker

use of org.camunda.bpm.engine.impl.tree.FlowScopeWalker in project camunda-bpm-platform by camunda.

the class AbstractInstantiationCmd method execute.

public Void execute(final CommandContext commandContext) {
    ExecutionEntity processInstance = commandContext.getExecutionManager().findExecutionById(processInstanceId);
    final ProcessDefinitionImpl processDefinition = processInstance.getProcessDefinition();
    CoreModelElement elementToInstantiate = getTargetElement(processDefinition);
    EnsureUtil.ensureNotNull(NotValidException.class, describeFailure("Element '" + getTargetElementId() + "' does not exist in process '" + processDefinition.getId() + "'"), "element", elementToInstantiate);
    // rebuild the mapping because the execution tree changes with every iteration
    final ActivityExecutionTreeMapping mapping = new ActivityExecutionTreeMapping(commandContext, processInstanceId);
    // before instantiating an activity, two things have to be determined:
    // 
    // activityStack:
    // For the activity to instantiate, we build a stack of parent flow scopes
    // for which no executions exist yet and that have to be instantiated
    // 
    // scopeExecution:
    // This is typically the execution under which a new sub tree has to be created.
    // if an explicit ancestor activity instance is set:
    // - this is the scope execution for that ancestor activity instance
    // - throws exception if that scope execution is not in the parent hierarchy
    // of the activity to be started
    // if no explicit ancestor activity instance is set:
    // - this is the execution of the first parent/ancestor flow scope that has an execution
    // - throws an exception if there is more than one such execution
    ScopeImpl targetFlowScope = getTargetFlowScope(processDefinition);
    // prepare to walk up the flow scope hierarchy and collect the flow scope activities
    ActivityStackCollector stackCollector = new ActivityStackCollector();
    FlowScopeWalker walker = new FlowScopeWalker(targetFlowScope);
    walker.addPreVisitor(stackCollector);
    ExecutionEntity scopeExecution = null;
    // if no explicit ancestor activity instance is set
    if (ancestorActivityInstanceId == null) {
        // walk until a scope is reached for which executions exist
        walker.walkWhile(new ReferenceWalker.WalkCondition<ScopeImpl>() {

            public boolean isFulfilled(ScopeImpl element) {
                return !mapping.getExecutions(element).isEmpty() || element == processDefinition;
            }
        });
        Set<ExecutionEntity> flowScopeExecutions = mapping.getExecutions(walker.getCurrentElement());
        if (flowScopeExecutions.size() > 1) {
            throw new ProcessEngineException("Ancestor activity execution is ambiguous for activity " + targetFlowScope);
        }
        scopeExecution = flowScopeExecutions.iterator().next();
    } else {
        ActivityInstance tree = commandContext.runWithoutAuthorization(new Callable<ActivityInstance>() {

            public ActivityInstance call() throws Exception {
                return new GetActivityInstanceCmd(processInstanceId).execute(commandContext);
            }
        });
        ActivityInstance ancestorInstance = findActivityInstance(tree, ancestorActivityInstanceId);
        EnsureUtil.ensureNotNull(NotValidException.class, describeFailure("Ancestor activity instance '" + ancestorActivityInstanceId + "' does not exist"), "ancestorInstance", ancestorInstance);
        // determine ancestor activity scope execution and activity
        final ExecutionEntity ancestorScopeExecution = getScopeExecutionForActivityInstance(processInstance, mapping, ancestorInstance);
        final PvmScope ancestorScope = getScopeForActivityInstance(processDefinition, ancestorInstance);
        // walk until the scope of the ancestor scope execution is reached
        walker.walkWhile(new ReferenceWalker.WalkCondition<ScopeImpl>() {

            public boolean isFulfilled(ScopeImpl element) {
                return (mapping.getExecutions(element).contains(ancestorScopeExecution) && element == ancestorScope) || element == processDefinition;
            }
        });
        Set<ExecutionEntity> flowScopeExecutions = mapping.getExecutions(walker.getCurrentElement());
        if (!flowScopeExecutions.contains(ancestorScopeExecution)) {
            throw new NotValidException(describeFailure("Scope execution for '" + ancestorActivityInstanceId + "' cannot be found in parent hierarchy of flow element '" + elementToInstantiate.getId() + "'"));
        }
        scopeExecution = ancestorScopeExecution;
    }
    List<PvmActivity> activitiesToInstantiate = stackCollector.getActivityStack();
    Collections.reverse(activitiesToInstantiate);
    // We have to make a distinction between
    // - "regular" activities for which the activity stack can be instantiated and started
    // right away
    // - interrupting or cancelling activities for which we have to ensure that
    // the interruption and cancellation takes place before we instantiate the activity stack
    ActivityImpl topMostActivity = null;
    ScopeImpl flowScope = null;
    if (!activitiesToInstantiate.isEmpty()) {
        topMostActivity = (ActivityImpl) activitiesToInstantiate.get(0);
        flowScope = topMostActivity.getFlowScope();
    } else if (ActivityImpl.class.isAssignableFrom(elementToInstantiate.getClass())) {
        topMostActivity = (ActivityImpl) elementToInstantiate;
        flowScope = topMostActivity.getFlowScope();
    } else if (TransitionImpl.class.isAssignableFrom(elementToInstantiate.getClass())) {
        TransitionImpl transitionToInstantiate = (TransitionImpl) elementToInstantiate;
        flowScope = transitionToInstantiate.getSource().getFlowScope();
    }
    if (!supportsConcurrentChildInstantiation(flowScope)) {
        throw new ProcessEngineException("Concurrent instantiation not possible for " + "activities in scope " + flowScope.getId());
    }
    ActivityStartBehavior startBehavior = ActivityStartBehavior.CONCURRENT_IN_FLOW_SCOPE;
    if (topMostActivity != null) {
        startBehavior = topMostActivity.getActivityStartBehavior();
        if (!activitiesToInstantiate.isEmpty()) {
            // this is in BPMN relevant if there is an interrupting event sub process.
            // we have to distinguish between instantiation of the start event and any other activity.
            // instantiation of the start event means interrupting behavior; instantiation
            // of any other task means no interruption.
            PvmActivity initialActivity = topMostActivity.getProperties().get(BpmnProperties.INITIAL_ACTIVITY);
            PvmActivity secondTopMostActivity = null;
            if (activitiesToInstantiate.size() > 1) {
                secondTopMostActivity = activitiesToInstantiate.get(1);
            } else if (ActivityImpl.class.isAssignableFrom(elementToInstantiate.getClass())) {
                secondTopMostActivity = (PvmActivity) elementToInstantiate;
            }
            if (initialActivity != secondTopMostActivity) {
                startBehavior = ActivityStartBehavior.CONCURRENT_IN_FLOW_SCOPE;
            }
        }
    }
    switch(startBehavior) {
        case CANCEL_EVENT_SCOPE:
            {
                ScopeImpl scopeToCancel = topMostActivity.getEventScope();
                ExecutionEntity executionToCancel = getSingleExecutionForScope(mapping, scopeToCancel);
                if (executionToCancel != null) {
                    executionToCancel.deleteCascade("Cancelling activity " + topMostActivity + " executed.", skipCustomListeners, skipIoMappings);
                    instantiate(executionToCancel.getParent(), activitiesToInstantiate, elementToInstantiate);
                } else {
                    ExecutionEntity flowScopeExecution = getSingleExecutionForScope(mapping, topMostActivity.getFlowScope());
                    instantiateConcurrent(flowScopeExecution, activitiesToInstantiate, elementToInstantiate);
                }
                break;
            }
        case INTERRUPT_EVENT_SCOPE:
            {
                ScopeImpl scopeToCancel = topMostActivity.getEventScope();
                ExecutionEntity executionToCancel = getSingleExecutionForScope(mapping, scopeToCancel);
                executionToCancel.interrupt("Interrupting activity " + topMostActivity + " executed.", skipCustomListeners, skipIoMappings);
                executionToCancel.setActivity(null);
                executionToCancel.leaveActivityInstance();
                instantiate(executionToCancel, activitiesToInstantiate, elementToInstantiate);
                break;
            }
        case INTERRUPT_FLOW_SCOPE:
            {
                ScopeImpl scopeToCancel = topMostActivity.getFlowScope();
                ExecutionEntity executionToCancel = getSingleExecutionForScope(mapping, scopeToCancel);
                executionToCancel.interrupt("Interrupting activity " + topMostActivity + " executed.", skipCustomListeners, skipIoMappings);
                executionToCancel.setActivity(null);
                executionToCancel.leaveActivityInstance();
                instantiate(executionToCancel, activitiesToInstantiate, elementToInstantiate);
                break;
            }
        default:
            {
                // or this execution has ended executing its scope, it can be reused
                if (!scopeExecution.hasChildren() && (scopeExecution.getActivity() == null || scopeExecution.isEnded())) {
                    // reuse the scope execution
                    instantiate(scopeExecution, activitiesToInstantiate, elementToInstantiate);
                } else {
                    // if the activity is not cancelling/interrupting, it can simply be instantiated as
                    // a concurrent child of the scopeExecution
                    instantiateConcurrent(scopeExecution, activitiesToInstantiate, elementToInstantiate);
                }
                break;
            }
    }
    return null;
}

Example 2 with FlowScopeWalker

use of org.camunda.bpm.engine.impl.tree.FlowScopeWalker in project camunda-bpm-platform by camunda.

the class CompensationUtil method collectCompensateEventSubscriptionsForScope.

/**
 * Collect all compensate event subscriptions for scope of given execution.
 */
public static List<EventSubscriptionEntity> collectCompensateEventSubscriptionsForScope(ActivityExecution execution) {
    final Map<ScopeImpl, PvmExecutionImpl> scopeExecutionMapping = execution.createActivityExecutionMapping();
    ScopeImpl activity = (ScopeImpl) execution.getActivity();
    // <LEGACY>: different flow scopes may have the same scope execution =>
    // collect subscriptions in a set
    final Set<EventSubscriptionEntity> subscriptions = new HashSet<EventSubscriptionEntity>();
    TreeVisitor<ScopeImpl> eventSubscriptionCollector = new TreeVisitor<ScopeImpl>() {

        @Override
        public void visit(ScopeImpl obj) {
            PvmExecutionImpl execution = scopeExecutionMapping.get(obj);
            subscriptions.addAll(((ExecutionEntity) execution).getCompensateEventSubscriptions());
        }
    };
    new FlowScopeWalker(activity).addPostVisitor(eventSubscriptionCollector).walkUntil(new ReferenceWalker.WalkCondition<ScopeImpl>() {

        @Override
        public boolean isFulfilled(ScopeImpl element) {
            Boolean consumesCompensationProperty = (Boolean) element.getProperty(BpmnParse.PROPERTYNAME_CONSUMES_COMPENSATION);
            return consumesCompensationProperty == null || consumesCompensationProperty == Boolean.TRUE;
        }
    });
    return new ArrayList<EventSubscriptionEntity>(subscriptions);
}

Example 3 with FlowScopeWalker

use of org.camunda.bpm.engine.impl.tree.FlowScopeWalker in project camunda-bpm-platform by camunda.

the class CannotAddMultiInstanceBodyValidator method validate.

@Override
public void validate(ValidatingMigrationInstruction instruction, final ValidatingMigrationInstructions instructions, MigrationInstructionValidationReportImpl report) {
    ActivityImpl targetActivity = instruction.getTargetActivity();
    FlowScopeWalker flowScopeWalker = new FlowScopeWalker(targetActivity.getFlowScope());
    MiBodyCollector miBodyCollector = new MiBodyCollector();
    flowScopeWalker.addPreVisitor(miBodyCollector);
    // walk until a target scope is found that is mapped
    flowScopeWalker.walkWhile(new WalkCondition<ScopeImpl>() {

        @Override
        public boolean isFulfilled(ScopeImpl element) {
            return element == null || !instructions.getInstructionsByTargetScope(element).isEmpty();
        }
    });
    if (miBodyCollector.firstMiBody != null) {
        report.addFailure("Target activity '" + targetActivity.getId() + "' is a descendant of multi-instance body '" + miBodyCollector.firstMiBody.getId() + "' that is not mapped from the source process definition.");
    }
}

Example 4 with FlowScopeWalker

use of org.camunda.bpm.engine.impl.tree.FlowScopeWalker in project camunda-bpm-platform by camunda.

the class MigratingProcessElementInstanceVisitor method collectNonExistingFlowScopes.

/**
 * Returns a list of flow scopes from the given scope until a scope is reached that is already present in the given
 * {@link MigratingScopeInstanceBranch} (exclusive). The order of the returned list is top-down, i.e. the highest scope
 * is the first element of the list.
 */
protected List<ScopeImpl> collectNonExistingFlowScopes(ScopeImpl scope, final MigratingScopeInstanceBranch migratingExecutionBranch) {
    FlowScopeWalker walker = new FlowScopeWalker(scope);
    final List<ScopeImpl> result = new LinkedList<ScopeImpl>();
    walker.addPreVisitor(new TreeVisitor<ScopeImpl>() {

        @Override
        public void visit(ScopeImpl obj) {
            result.add(0, obj);
        }
    });
    walker.walkWhile(new ReferenceWalker.WalkCondition<ScopeImpl>() {

        @Override
        public boolean isFulfilled(ScopeImpl element) {
            return migratingExecutionBranch.hasInstance(element);
        }
    });
    return result;
}

Example 5 with FlowScopeWalker

use of org.camunda.bpm.engine.impl.tree.FlowScopeWalker in project camunda-bpm-platform by camunda.

the class ProcessInstanceStartContext method getInstantiationStack.

@SuppressWarnings({ "unchecked", "rawtypes" })
public InstantiationStack getInstantiationStack() {
    if (instantiationStack == null) {
        FlowScopeWalker flowScopeWalker = new FlowScopeWalker(initial.getFlowScope());
        ScopeCollector scopeCollector = new ScopeCollector();
        flowScopeWalker.addPreVisitor(scopeCollector).walkWhile(new ReferenceWalker.WalkCondition<ScopeImpl>() {

            public boolean isFulfilled(ScopeImpl element) {
                return element == null || element == initial.getProcessDefinition();
            }
        });
        List<PvmActivity> scopeActivities = (List) scopeCollector.getScopes();
        Collections.reverse(scopeActivities);
        instantiationStack = new InstantiationStack(scopeActivities, initial, null);
    }
    return instantiationStack;
}