io.camunda.zeebe.model.bpmn.validation.zeebe.MessageThrowEventValidator Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of zeebe-bpmn-model Show documentation
Zeebe BPMN model API
There is a newer version: 8.7.0-alpha2
/*
 * Copyright © 2017 camunda services GmbH ([email protected])
 *
 * 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 io.camunda.zeebe.model.bpmn.validation.zeebe;

import io.camunda.zeebe.model.bpmn.impl.QueryImpl;
import io.camunda.zeebe.model.bpmn.impl.ZeebeConstants;
import io.camunda.zeebe.model.bpmn.instance.BpmnModelElementInstance;
import io.camunda.zeebe.model.bpmn.instance.ExtensionElements;
import io.camunda.zeebe.model.bpmn.instance.MessageEventDefinition;
import io.camunda.zeebe.model.bpmn.instance.ThrowEvent;
import io.camunda.zeebe.model.bpmn.instance.zeebe.ZeebePublishMessage;
import io.camunda.zeebe.model.bpmn.instance.zeebe.ZeebeTaskDefinition;
import java.util.Collection;
import java.util.Collections;
import org.camunda.bpm.model.xml.validation.ModelElementValidator;
import org.camunda.bpm.model.xml.validation.ValidationResultCollector;

public class MessageThrowEventValidator implements ModelElementValidator {

  @Override
  public Class getElementType() {
    return ThrowEvent.class;
  }

  @Override
  public void validate(
      final ThrowEvent element, final ValidationResultCollector validationResultCollector) {

    if (isMessageThrowEvent(element)) {
      final MessageEventDefinition messageEventDefinition = getEventDefinition(element);
      final Collection publishMessageExtensions =
          getExtensionElementsByType(
              messageEventDefinition.getExtensionElements(), ZeebePublishMessage.class);

      final Collection taskDefinitionExtensions =
          getExtensionElementsByType(element.getExtensionElements(), ZeebeTaskDefinition.class);

      // a message throw event must have either one task definition or publish message
      if (!hasExactlyOneExtension(publishMessageExtensions, taskDefinitionExtensions)) {
        validationResultCollector.addError(
            0,
            String.format(
                "Must have either one 'zeebe:%s' or one 'zeebe:%s' extension element",
                ZeebeConstants.ELEMENT_PUBLISH_MESSAGE, ZeebeConstants.ELEMENT_TASK_DEFINITION));
      } else {
        if (taskDefinitionExtensions.isEmpty() && messageEventDefinition.getMessage() == null) {
          validationResultCollector.addError(0, "Must reference a message");
        }
      }
    }
  }

  private boolean isMessageThrowEvent(final ThrowEvent element) {
    return element.getEventDefinitions().stream()
        .anyMatch(MessageEventDefinition.class::isInstance);
  }

  private MessageEventDefinition getEventDefinition(final ThrowEvent event) {
    return new QueryImpl<>(event.getEventDefinitions())
        .filterByType(MessageEventDefinition.class)
        .singleResult();
  }

  public  Collection getExtensionElementsByType(
      final ExtensionElements extensionElements, Class type) {
    if (extensionElements == null) {
      return Collections.emptyList();
    }
    return extensionElements.getChildElementsByType(type);
  }

  private boolean hasExactlyOneExtension(
      final Collection publishMessageExtensions,
      final Collection taskDefinitionExtensions) {
    return publishMessageExtensions.size() == 1 && taskDefinitionExtensions.isEmpty()
        || publishMessageExtensions.isEmpty() && taskDefinitionExtensions.size() == 1;
  }
}