Skip to content

Commit

Permalink
Add support for handling custom input parameters for error start and …
Browse files Browse the repository at this point in the history
…boundary events and for passing additional data in error end events
  • Loading branch information
filiphr committed May 25, 2023
1 parent 9da7097 commit 1eb7fcb
Show file tree
Hide file tree
Showing 40 changed files with 1,047 additions and 45 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,7 @@
import org.flowable.bpmn.constants.BpmnXMLConstants;
import org.flowable.bpmn.converter.child.BaseChildElementParser;
import org.flowable.bpmn.converter.child.InParameterParser;
import org.flowable.bpmn.converter.child.OutParameterParser;
import org.flowable.bpmn.converter.child.VariableListenerEventDefinitionParser;
import org.flowable.bpmn.converter.util.BpmnXMLUtil;
import org.flowable.bpmn.model.BaseElement;
Expand Down Expand Up @@ -123,6 +124,7 @@ protected void writeAdditionalAttributes(BaseElement element, BpmnModel model, X
@Override
protected boolean writeExtensionChildElements(BaseElement element, boolean didWriteExtensionStartElement, XMLStreamWriter xtw) throws Exception {
BoundaryEvent boundaryEvent = (BoundaryEvent) element;
didWriteExtensionStartElement = BpmnXMLUtil.writeIOParameters(ELEMENT_IN_PARAMETERS, boundaryEvent.getInParameters(), didWriteExtensionStartElement, xtw);
didWriteExtensionStartElement = writeVariableListenerDefinition(boundaryEvent, didWriteExtensionStartElement, xtw);
return didWriteExtensionStartElement;
}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -12,9 +12,14 @@
*/
package org.flowable.bpmn.converter;

import java.util.HashMap;
import java.util.Map;

import javax.xml.stream.XMLStreamReader;
import javax.xml.stream.XMLStreamWriter;

import org.flowable.bpmn.converter.child.BaseChildElementParser;
import org.flowable.bpmn.converter.child.OutParameterParser;
import org.flowable.bpmn.converter.util.BpmnXMLUtil;
import org.flowable.bpmn.model.BaseElement;
import org.flowable.bpmn.model.BpmnModel;
Expand All @@ -25,6 +30,13 @@
*/
public class EndEventXMLConverter extends BaseBpmnXMLConverter {

protected Map<String, BaseChildElementParser> childParserMap = new HashMap<>();

public EndEventXMLConverter() {
OutParameterParser outParameterParser = new OutParameterParser();
childParserMap.put(outParameterParser.getElementName(), outParameterParser);
}

@Override
public Class<? extends BaseElement> getBpmnElementType() {
return EndEvent.class;
Expand All @@ -42,15 +54,22 @@ protected BaseElement convertXMLToElement(XMLStreamReader xtr, BpmnModel model)
BpmnXMLUtil.addXMLLocation(endEvent, xtr);

BpmnXMLUtil.addCustomAttributes(xtr, endEvent, defaultElementAttributes, defaultActivityAttributes);
parseChildElements(getXMLElementName(), endEvent, model, xtr);

parseChildElements(getXMLElementName(), endEvent, childParserMap, model, xtr);
return endEvent;
}

@Override
protected void writeAdditionalAttributes(BaseElement element, BpmnModel model, XMLStreamWriter xtw) throws Exception {
}

@Override
protected boolean writeExtensionChildElements(BaseElement element, boolean didWriteExtensionStartElement, XMLStreamWriter xtw) throws Exception {
EndEvent endEvent = (EndEvent) element;
didWriteExtensionStartElement = BpmnXMLUtil.writeIOParameters(ELEMENT_OUT_PARAMETERS, endEvent.getOutParameters(), didWriteExtensionStartElement, xtw);
return didWriteExtensionStartElement;
}

@Override
protected void writeAdditionalChildElements(BaseElement element, BpmnModel model, XMLStreamWriter xtw) throws Exception {
EndEvent endEvent = (EndEvent) element;
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,7 @@
import org.apache.commons.lang3.StringUtils;
import org.flowable.bpmn.constants.BpmnXMLConstants;
import org.flowable.bpmn.converter.child.BaseChildElementParser;
import org.flowable.bpmn.converter.child.InParameterParser;
import org.flowable.bpmn.converter.child.VariableListenerEventDefinitionParser;
import org.flowable.bpmn.converter.util.BpmnXMLUtil;
import org.flowable.bpmn.model.BaseElement;
Expand All @@ -46,6 +47,8 @@ public class StartEventXMLConverter extends BaseBpmnXMLConverter {
new ExtensionAttribute(ATTRIBUTE_SAME_DEPLOYMENT));

public StartEventXMLConverter() {
InParameterParser inParameterParser = new InParameterParser();
childParserMap.put(inParameterParser.getElementName(), inParameterParser);
VariableListenerEventDefinitionParser variableListenerEventDefinitionParser = new VariableListenerEventDefinitionParser();
childParserMap.put(variableListenerEventDefinitionParser.getElementName(), variableListenerEventDefinitionParser);
}
Expand Down Expand Up @@ -123,6 +126,7 @@ protected void writeAdditionalAttributes(BaseElement element, BpmnModel model, X
@Override
protected boolean writeExtensionChildElements(BaseElement element, boolean didWriteExtensionStartElement, XMLStreamWriter xtw) throws Exception {
StartEvent startEvent = (StartEvent) element;
didWriteExtensionStartElement = BpmnXMLUtil.writeIOParameters(ELEMENT_IN_PARAMETERS, startEvent.getInParameters(), didWriteExtensionStartElement, xtw);
didWriteExtensionStartElement = writeVariableListenerDefinition(startEvent, didWriteExtensionStartElement, xtw);
didWriteExtensionStartElement = writeFormProperties(startEvent, didWriteExtensionStartElement, xtw);
return didWriteExtensionStartElement;
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -22,9 +22,8 @@
import org.flowable.bpmn.model.BaseElement;
import org.flowable.bpmn.model.BpmnModel;
import org.flowable.bpmn.model.CallActivity;
import org.flowable.bpmn.model.CaseServiceTask;
import org.flowable.bpmn.model.Event;
import org.flowable.bpmn.model.ExtensionAttribute;
import org.flowable.bpmn.model.HasInParameters;
import org.flowable.bpmn.model.IOParameter;

public class InParameterParser extends BaseChildElementParser {
Expand Down Expand Up @@ -67,14 +66,8 @@ public void parseChildElement(XMLStreamReader xtr, BaseElement parentElement, Bp
parameter.setTransient(true);
}

if (parentElement instanceof CallActivity) {
((CallActivity) parentElement).getInParameters().add(parameter);

} else if (parentElement instanceof CaseServiceTask) {
((CaseServiceTask) parentElement).getInParameters().add(parameter);

} else if (parentElement instanceof Event) {
((Event) parentElement).getInParameters().add(parameter);
if (parentElement instanceof HasInParameters) {
((HasInParameters) parentElement).addInParameter(parameter);
}

BpmnXMLUtil.addCustomAttributes(xtr, parameter, defaultInParameterAttributes);
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -22,9 +22,8 @@
import org.flowable.bpmn.model.BaseElement;
import org.flowable.bpmn.model.BpmnModel;
import org.flowable.bpmn.model.CallActivity;
import org.flowable.bpmn.model.CaseServiceTask;
import org.flowable.bpmn.model.Event;
import org.flowable.bpmn.model.ExtensionAttribute;
import org.flowable.bpmn.model.HasOutParameters;
import org.flowable.bpmn.model.IOParameter;

public class OutParameterParser extends BaseChildElementParser {
Expand Down Expand Up @@ -64,15 +63,8 @@ public void parseChildElement(XMLStreamReader xtr, BaseElement parentElement, Bp

BpmnXMLUtil.addCustomAttributes(xtr, parameter, defaultOutParameterAttributes);

if (parentElement instanceof CallActivity) {
CallActivity callActivity = (CallActivity) parentElement;
callActivity.getOutParameters().add(parameter);

} else if (parentElement instanceof CaseServiceTask) {
((CaseServiceTask) parentElement).getOutParameters().add(parameter);

} else if (parentElement instanceof Event) {
((Event) parentElement).getOutParameters().add(parameter);
if (parentElement instanceof HasOutParameters) {
((HasOutParameters) parentElement).addOutParameter(parameter);
}

} else if (parentElement instanceof CallActivity) {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -411,7 +411,7 @@ protected static void writeExtensionElement(ExtensionElement extensionElement, M

public static boolean writeIOParameters(String elementName, List<IOParameter> parameterList, boolean didWriteExtensionStartElement, XMLStreamWriter xtw) throws Exception {

if (parameterList.isEmpty()) {
if (parameterList == null || parameterList.isEmpty()) {
return didWriteExtensionStartElement;
}

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -789,6 +789,7 @@
<attribute name="source" type="string" use="optional"/>
<attribute name="sourceExpression" type="tns:tExpression" use="optional"/>
<attribute name="target" type="string" use="required" />
<attribute name="transient" type="boolean" default="false" use="optional" />
</complexType>
</element>
<element name="out">
Expand All @@ -802,6 +803,7 @@
<attribute name="source" type="string" use="optional"/>
<attribute name="sourceExpression" type="tns:tExpression" use="optional"/>
<attribute name="target" type="string" use="required" />
<attribute name="transient" type="boolean" default="false" use="optional"/>
</complexType>
</element>

Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,42 @@
/* 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.editor.language.xml;

import static org.assertj.core.api.Assertions.assertThat;
import static org.assertj.core.api.Assertions.tuple;

import org.flowable.bpmn.model.BoundaryEvent;
import org.flowable.bpmn.model.BpmnModel;
import org.flowable.bpmn.model.FlowElement;
import org.flowable.bpmn.model.IOParameter;
import org.flowable.editor.language.xml.util.BpmnXmlConverterTest;

/**
* @author Filip Hrisafov
*/
class BoundaryErrorEventConverterTest {

@BpmnXmlConverterTest("boundaryErrorEventWithInParameters.bpmn")
void validateErrorBoundaryWithInParameters(BpmnModel model) {
FlowElement flowElement = model.getFlowElement("theErrorBoundary");
assertThat(flowElement).isInstanceOfSatisfying(BoundaryEvent.class, event -> {
assertThat(event.getInParameters())
.extracting(IOParameter::getTarget, IOParameter::getSource, IOParameter::getSourceExpression)
.containsExactlyInAnyOrder(
tuple("targetErrorVar", "sourceVar", null),
tuple("targetErrorVarFromExpression", null, "${'test'}")
);
});
}

}
Original file line number Diff line number Diff line change
@@ -0,0 +1,43 @@
/* 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.editor.language.xml;

import static org.assertj.core.api.Assertions.assertThat;
import static org.assertj.core.api.Assertions.tuple;

import org.flowable.bpmn.model.BpmnModel;
import org.flowable.bpmn.model.EndEvent;
import org.flowable.bpmn.model.FlowElement;
import org.flowable.bpmn.model.IOParameter;
import org.flowable.bpmn.model.StartEvent;
import org.flowable.editor.language.xml.util.BpmnXmlConverterTest;

/**
* @author Filip Hrisafov
*/
class EndErrorEventConverterTest {

@BpmnXmlConverterTest("endErrorEventWithOutParameters.bpmn")
void validateStartErrorWithInParameters(BpmnModel model) {
FlowElement flowElement = model.getFlowElement("theSubProcessEnd");
assertThat(flowElement).isInstanceOfSatisfying(EndEvent.class, event -> {
assertThat(event.getOutParameters())
.extracting(IOParameter::getTarget, IOParameter::getSource, IOParameter::getSourceExpression)
.containsExactlyInAnyOrder(
tuple("targetErrorVar", "sourceVar", null),
tuple("targetErrorVarFromExpression", null, "${'test'}")
);
});
}

}
Original file line number Diff line number Diff line change
@@ -0,0 +1,43 @@
/* 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.editor.language.xml;

import static org.assertj.core.api.Assertions.assertThat;
import static org.assertj.core.api.Assertions.tuple;

import org.flowable.bpmn.model.BoundaryEvent;
import org.flowable.bpmn.model.BpmnModel;
import org.flowable.bpmn.model.FlowElement;
import org.flowable.bpmn.model.IOParameter;
import org.flowable.bpmn.model.StartEvent;
import org.flowable.editor.language.xml.util.BpmnXmlConverterTest;

/**
* @author Filip Hrisafov
*/
class StartErrorEventConverterTest {

@BpmnXmlConverterTest("startErrorEventWithInParameters.bpmn")
void validateStartErrorWithInParameters(BpmnModel model) {
FlowElement flowElement = model.getFlowElement("startErrorSubProcess");
assertThat(flowElement).isInstanceOfSatisfying(StartEvent.class, event -> {
assertThat(event.getInParameters())
.extracting(IOParameter::getTarget, IOParameter::getSource, IOParameter::getSourceExpression)
.containsExactlyInAnyOrder(
tuple("targetErrorVar", "sourceVar", null),
tuple("targetErrorVarFromExpression", null, "${'test'}")
);
});
}

}
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<definitions xmlns="http://www.omg.org/spec/BPMN/20100524/MODEL" xmlns:flowable="http://flowable.org/bpmn" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
exporter="Yaoqiang BPMN Editor" exporterVersion="2.2.12 (GPLv3, Non-Commercial)" expressionLanguage="http://www.w3.org/1999/XPath"
id="_1384552647085" name="" targetNamespace="http://sourceforge.net/bpmn/definitions/_1384552647085"
typeLanguage="http://www.w3.org/2001/XMLSchema"
xsi:schemaLocation="http://www.omg.org/spec/BPMN/20100524/MODEL http://bpmn.sourceforge.net/schemas/BPMN20.xsd">
<error id="errorOne" name="Error One" errorCode="errorOne"/>
<process id="testProcess" isExecutable="true" name="Test Process">
<startEvent id="theStart"/>
<sequenceFlow id="flow1" sourceRef="theStart" targetRef="theTask"/>
<serviceTask id="theTask" flowable:expression="${true}"/>
<sequenceFlow id="flow2" sourceRef="theTask" targetRef="theEnd"/>
<boundaryEvent id="theErrorBoundary" attachedToRef="theTask">
<extensionElements>
<flowable:in target="targetErrorVar" source="sourceVar"/>
<flowable:in target="targetErrorVarFromExpression" sourceExpression="${'test'}"/>
</extensionElements>
<errorEventDefinition id="one" errorRef="errorOne"/>
</boundaryEvent>
<endEvent id="theEnd"/>
</process>
</definitions>
Original file line number Diff line number Diff line change
@@ -0,0 +1,30 @@
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<definitions xmlns="http://www.omg.org/spec/BPMN/20100524/MODEL" xmlns:flowable="http://flowable.org/bpmn" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
exporter="Yaoqiang BPMN Editor" exporterVersion="2.2.12 (GPLv3, Non-Commercial)" expressionLanguage="http://www.w3.org/1999/XPath"
id="_1384552647085" name="" targetNamespace="http://sourceforge.net/bpmn/definitions/_1384552647085"
typeLanguage="http://www.w3.org/2001/XMLSchema"
xsi:schemaLocation="http://www.omg.org/spec/BPMN/20100524/MODEL http://bpmn.sourceforge.net/schemas/BPMN20.xsd">
<error id="errorOne" name="Error One" errorCode="errorOne"/>
<process id="testProcess" isExecutable="true" name="Test Process">
<startEvent id="theStart"/>
<sequenceFlow id="flow1" sourceRef="theStart" targetRef="theSubProcess"/>
<subProcess id="theSubProcess">
<startEvent id="theSubProcessStart"/>
<sequenceFlow id="subFlow1" sourceRef="theStart" targetRef="theTask"/>
<serviceTask id="theTask" flowable:expression="${true}"/>
<sequenceFlow id="subFlow2" sourceRef="theTask" targetRef="theSubProcessEnd"/>
<endEvent id="theSubProcessEnd">
<extensionElements>
<flowable:out target="targetErrorVar" source="sourceVar"/>
<flowable:out target="targetErrorVarFromExpression" sourceExpression="${'test'}"/>
</extensionElements>
<errorEventDefinition errorRef="testError" />
</endEvent>
</subProcess>
<boundaryEvent id="theErrorBoundary" attachedToRef="theSubProcess">
<errorEventDefinition id="one" errorRef="errorOne"/>
</boundaryEvent>
<sequenceFlow id="flow2" sourceRef="theErrorBoundary" targetRef="theEnd"/>
<endEvent id="theEnd"/>
</process>
</definitions>
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<definitions xmlns="http://www.omg.org/spec/BPMN/20100524/MODEL" xmlns:flowable="http://flowable.org/bpmn" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
exporter="Yaoqiang BPMN Editor" exporterVersion="2.2.12 (GPLv3, Non-Commercial)" expressionLanguage="http://www.w3.org/1999/XPath"
id="_1384552647085" name="" targetNamespace="http://sourceforge.net/bpmn/definitions/_1384552647085"
typeLanguage="http://www.w3.org/2001/XMLSchema"
xsi:schemaLocation="http://www.omg.org/spec/BPMN/20100524/MODEL http://bpmn.sourceforge.net/schemas/BPMN20.xsd">
<error id="errorOne" name="Error One" errorCode="errorOne"/>
<process id="testProcess" isExecutable="true" name="Test Process">
<startEvent id="theStart"/>
<sequenceFlow id="flow1" sourceRef="theStart" targetRef="theTask"/>
<serviceTask id="theTask" flowable:expression="${true}"/>
<sequenceFlow id="flow2" sourceRef="theTask" targetRef="theEnd"/>
<boundaryEvent id="theErrorBoundary" attachedToRef="theTask">
<errorEventDefinition id="one" errorRef="errorOne"/>
</boundaryEvent>
<endEvent id="theEnd"/>

<subProcess id="errorSubProcess" triggeredByEvent="true">
<startEvent id="startErrorSubProcess">
<extensionElements>
<flowable:in target="targetErrorVar" source="sourceVar"/>
<flowable:in target="targetErrorVarFromExpression" sourceExpression="${'test'}"/>
</extensionElements>
<errorEventDefinition/>
</startEvent>
</subProcess>
</process>
</definitions>
Loading

0 comments on commit 1eb7fcb

Please sign in to comment.