Many resources are needed to download a project. Please understand that we have to compensate our server costs. Thank you in advance.
Project price only 1 $
You can buy this project and download/modify it how often you want.
org.jbpm.bpmn2.xml.XmlBPMNProcessDumper Maven / Gradle / Ivy
/**
* Copyright 2010 Red Hat, Inc. and/or its affiliates.
*
* 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.jbpm.bpmn2.xml;
import java.io.StringReader;
import java.util.ArrayList;
import java.util.Collection;
import java.util.HashMap;
import java.util.HashSet;
import java.util.List;
import java.util.Map;
import java.util.Set;
import org.drools.compiler.compiler.xml.XmlDumper;
import org.drools.compiler.rule.builder.dialect.java.JavaDialect;
import org.drools.core.process.core.Work;
import org.drools.core.process.core.datatype.impl.type.ObjectDataType;
import org.drools.core.xml.Handler;
import org.drools.core.xml.SemanticModule;
import org.drools.core.xml.SemanticModules;
import org.jbpm.bpmn2.core.Association;
import org.jbpm.bpmn2.core.DataStore;
import org.jbpm.bpmn2.core.Definitions;
import org.jbpm.bpmn2.core.Error;
import org.jbpm.bpmn2.core.ItemDefinition;
import org.jbpm.compiler.xml.XmlProcessReader;
import org.jbpm.process.core.ContextContainer;
import org.jbpm.process.core.context.swimlane.Swimlane;
import org.jbpm.process.core.context.swimlane.SwimlaneContext;
import org.jbpm.process.core.context.variable.Variable;
import org.jbpm.process.core.context.variable.VariableScope;
import org.jbpm.process.core.event.EventFilter;
import org.jbpm.process.core.event.EventTypeFilter;
import org.jbpm.process.core.impl.ProcessImpl;
import org.jbpm.process.core.impl.XmlProcessDumper;
import org.jbpm.ruleflow.core.RuleFlowProcess;
import org.jbpm.workflow.core.Constraint;
import org.jbpm.workflow.core.impl.ConnectionImpl;
import org.jbpm.workflow.core.impl.DroolsConsequenceAction;
import org.jbpm.workflow.core.node.ActionNode;
import org.jbpm.workflow.core.node.CompositeNode;
import org.jbpm.workflow.core.node.EndNode;
import org.jbpm.workflow.core.node.EventNode;
import org.jbpm.workflow.core.node.EventTrigger;
import org.jbpm.workflow.core.node.FaultNode;
import org.jbpm.workflow.core.node.ForEachNode;
import org.jbpm.workflow.core.node.HumanTaskNode;
import org.jbpm.workflow.core.node.Join;
import org.jbpm.workflow.core.node.Split;
import org.jbpm.workflow.core.node.StartNode;
import org.jbpm.workflow.core.node.Trigger;
import org.jbpm.workflow.core.node.WorkItemNode;
import org.kie.api.definition.process.Connection;
import org.kie.api.definition.process.Node;
import org.kie.api.definition.process.NodeContainer;
import org.kie.api.definition.process.Process;
import org.kie.api.definition.process.WorkflowProcess;
public class XmlBPMNProcessDumper implements XmlProcessDumper {
public static final String JAVA_LANGUAGE = "http://www.java.com/java";
public static final String MVEL_LANGUAGE = "http://www.mvel.org/2.0";
public static final String RULE_LANGUAGE = "http://www.jboss.org/drools/rule";
public static final String XPATH_LANGUAGE = "http://www.w3.org/1999/XPath";
public static final String JAVASCRIPT_LANGUAGE = "http://www.javascript.com/javascript";
public static final int NO_META_DATA = 0;
public static final int META_DATA_AS_NODE_PROPERTY = 1;
public static final int META_DATA_USING_DI = 2;
public static final XmlBPMNProcessDumper INSTANCE = new XmlBPMNProcessDumper();
private final static String EOL = System.getProperty( "line.separator" );
private SemanticModule semanticModule;
private int metaDataType = META_DATA_USING_DI;
private XmlBPMNProcessDumper() {
semanticModule = new BPMNSemanticModule();
}
public String dump(WorkflowProcess process) {
return dump(process, META_DATA_USING_DI);
}
public String dump(WorkflowProcess process, boolean includeMeta) {
return dump(process, META_DATA_AS_NODE_PROPERTY);
}
public String dump(WorkflowProcess process, int metaDataType) {
StringBuilder xmlDump = new StringBuilder();
visitProcess(process, xmlDump, metaDataType);
return xmlDump.toString();
}
public int getMetaDataType() {
return metaDataType;
}
public void setMetaDataType(int metaDataType) {
this.metaDataType = metaDataType;
}
private Set visitedVariables;
protected void visitProcess(WorkflowProcess process, StringBuilder xmlDump, int metaDataType) {
String targetNamespace = (String) process.getMetaData().get("TargetNamespace");
if (targetNamespace == null) {
targetNamespace = "http://www.jboss.org/drools";
}
xmlDump.append(
" " + EOL +
"" + EOL + EOL);
// item definitions
this.visitedVariables = new HashSet();
VariableScope variableScope = (VariableScope)
((org.jbpm.process.core.Process) process).getDefaultContext(VariableScope.VARIABLE_SCOPE);
Set dumpedItemDefs = new HashSet();
Map itemDefs = (Map) process.getMetaData().get("ItemDefinitions");
if (itemDefs != null) {
for (ItemDefinition def : itemDefs.values()) {
xmlDump.append(
" ());
Definitions def = (Definitions) process.getMetaData().get("Definitions");
visitErrors(def, xmlDump);
//data stores
if (def != null && def.getDataStores() != null) {
for (DataStore dataStore : def.getDataStores()) {
visitDataStore(dataStore, xmlDump);
}
}
// the process itself
xmlDump.append(" " + EOL + EOL);
visitHeader(process, xmlDump, metaDataType);
List processNodes = new ArrayList();
for( Node procNode : process.getNodes()) {
processNodes.add((org.jbpm.workflow.core.Node) procNode);
}
visitNodes(processNodes, xmlDump, metaDataType);
visitConnections(process.getNodes(), xmlDump, metaDataType);
// add associations
List associations = (List) process.getMetaData().get(ProcessHandler.ASSOCIATIONS);
if( associations != null ) {
for (Association association : associations ) {
visitAssociation(association, xmlDump);
}
}
xmlDump.append(" " + EOL + EOL);
if (metaDataType == META_DATA_USING_DI) {
xmlDump.append(
" " + EOL +
" " + EOL);
visitNodesDi(process.getNodes(), xmlDump);
visitConnectionsDi(process.getNodes(), xmlDump);
xmlDump.append(
" " + EOL +
" " + EOL + EOL);
}
xmlDump.append(" ");
}
private void visitDataStore(DataStore dataStore, StringBuilder xmlDump) {
String itemSubjectRef = dataStore.getItemSubjectRef();
String itemDefId = itemSubjectRef.substring(itemSubjectRef.indexOf(':') + 1);
xmlDump.append(" dumpedItemDefs) {
if (variableScope != null && !variableScope.getVariables().isEmpty()) {
int variablesAdded = 0;
for (Variable variable: variableScope.getVariables()) {
String itemDefId = (String) variable.getMetaData("ItemSubjectRef");
if( itemDefId == null ) {
itemDefId = prefix + variable.getName();
}
if( itemDefId != null && ! dumpedItemDefs.add(itemDefId.intern()) ) {
continue;
}
if( ! visitedVariables.add(variable.getName()) ) {
continue;
}
++variablesAdded;
xmlDump.append(
" dumpedItemDefs) {
for (Node node: nodes) {
if (node instanceof ContextContainer) {
VariableScope variableScope = (VariableScope)
((ContextContainer) node).getDefaultContext(VariableScope.VARIABLE_SCOPE);
if (variableScope != null) {
visitVariableScope(variableScope, XmlBPMNProcessDumper.getUniqueNodeId(node) + "-", xmlDump, dumpedItemDefs);
}
}
if (node instanceof NodeContainer) {
visitSubVariableScopes(((NodeContainer) node).getNodes(), xmlDump, dumpedItemDefs);
}
}
}
private void visitLanes(WorkflowProcess process, StringBuilder xmlDump) {
// lanes
Collection swimlanes = ((SwimlaneContext)
((org.jbpm.workflow.core.WorkflowProcess) process)
.getDefaultContext(SwimlaneContext.SWIMLANE_SCOPE)).getSwimlanes();
if (!swimlanes.isEmpty()) {
xmlDump.append(" " + EOL);
for (Swimlane swimlane: swimlanes) {
xmlDump.append(" " + EOL);
visitLane(process, swimlane.getName(), xmlDump);
xmlDump.append(" " + EOL);
}
xmlDump.append(" " + EOL);
}
}
private void visitLane(NodeContainer container, String lane, StringBuilder xmlDump) {
for (Node node: container.getNodes()) {
if (node instanceof HumanTaskNode) {
String swimlane = ((HumanTaskNode) node).getSwimlane();
if (lane.equals(swimlane)) {
xmlDump.append(" " + XmlBPMNProcessDumper.getUniqueNodeId(node) + " " + EOL);
}
} else {
String swimlane = (String) node.getMetaData().get("Lane");
if (lane.equals(swimlane)) {
xmlDump.append(" " + XmlBPMNProcessDumper.getUniqueNodeId(node) + " " + EOL);
}
}
if (node instanceof NodeContainer) {
visitLane((NodeContainer) node, lane, xmlDump);
}
}
}
protected void visitHeader(WorkflowProcess process, StringBuilder xmlDump, int metaDataType) {
Map metaData = getMetaData(process.getMetaData());
Set imports = ((org.jbpm.process.core.Process) process).getImports();
Map globals = ((org.jbpm.process.core.Process) process).getGlobals();
if ((imports != null && !imports.isEmpty()) || (globals != null && globals.size() > 0) || !metaData.isEmpty()) {
xmlDump.append(" " + EOL);
if (imports != null) {
for (String s: imports) {
xmlDump.append(" global: globals.entrySet()) {
xmlDump.append(" " + EOL);
}
// TODO: function imports
// TODO: exception handlers
VariableScope variableScope = (VariableScope)
((org.jbpm.process.core.Process) process).getDefaultContext(VariableScope.VARIABLE_SCOPE);
if (variableScope != null) {
visitVariables(variableScope.getVariables(), xmlDump);
}
visitLanes(process, xmlDump);
}
public static void visitVariables(List variables, StringBuilder xmlDump) {
if (!variables.isEmpty()) {
xmlDump.append(" " + EOL);
for (Variable variable: variables) {
if (variable.getMetaData("DataObject") == null) {
xmlDump.append(" metaData = getMetaData(variable.getMetaData());
if (metaData.isEmpty()) {
xmlDump.append("/>" + EOL);
} else {
xmlDump.append(">" + EOL
+ " " + EOL);
writeMetaData(metaData, xmlDump);
xmlDump.append(" " + EOL
+ " " + EOL);
}
}
}
for (Variable variable: variables) {
if (variable.getMetaData("DataObject") != null) {
xmlDump.append(" metaData = getMetaData(variable.getMetaData());
if (metaData.isEmpty()) {
xmlDump.append("/>" + EOL);
} else {
xmlDump.append(">" + EOL
+ " " + EOL);
writeMetaData(metaData, xmlDump);
xmlDump.append(" " + EOL
+ " " + EOL);
}
}
}
xmlDump.append(EOL);
}
}
public static Map getMetaData(Map input) {
Map metaData = new HashMap();
for (Map.Entry entry: input.entrySet()) {
String name = entry.getKey();
if (entry.getKey().startsWith("custom")
&& entry.getValue() instanceof String) {
metaData.put(name, entry.getValue());
}
}
return metaData;
}
public static void writeMetaData(Map metaData, final StringBuilder xmlDump) {
if (!metaData.isEmpty()) {
for (Map.Entry entry: metaData.entrySet()) {
xmlDump.append(" " + EOL);
xmlDump.append(" " + entry.getValue() + " " + EOL);
xmlDump.append(" " + EOL);
}
}
}
protected void visitInterfaces(Node[] nodes, StringBuilder xmlDump) {
for (Node node: nodes) {
if (node instanceof WorkItemNode) {
Work work = ((WorkItemNode) node).getWork();
if (work != null) {
if ("Service Task".equals(work.getName())) {
String interfaceName = (String) work.getParameter("Interface");
if (interfaceName == null) {
interfaceName = "";
}
String interfaceRef = (String) work.getParameter("interfaceImplementationRef");
if (interfaceRef == null) {
interfaceRef = "";
}
String operationName = (String) work.getParameter("Operation");
if (operationName == null) {
operationName = "";
}
String operationRef = (String) work.getParameter("operationImplementationRef");
if (operationRef == null) {
operationRef = "";
}
String parameterType = (String) work.getParameter("ParameterType");
if (parameterType == null) {
parameterType = "";
}
xmlDump.append(
" " + EOL +
" " + EOL +
" " + getUniqueNodeId(node) + "_InMessage " + EOL +
" " + EOL +
" " + EOL + EOL);
} else if ("Send Task".equals(work.getName())) {
String messageType = (String) work.getParameter("MessageType");
if (messageType == null) {
messageType = "";
}
xmlDump.append(
" filters = ((EventNode) node).getEventFilters();
if (filters.size() > 0) {
String messageRef = ((EventTypeFilter) filters.get(0)).getType();
if (messageRef.startsWith("Message-")) {
messageRef = messageRef.substring(8);
String messageType = (String) node.getMetaData().get("MessageType");
xmlDump.append(
" escalations) {
for (Node node: nodes) {
if (node instanceof FaultNode) {
FaultNode faultNode = (FaultNode) node;
if (!faultNode.isTerminateParent()) {
String escalationCode = faultNode.getFaultName();
if (!escalations.contains(escalationCode)) {
escalations.add(escalationCode);
xmlDump.append(
" errors = definitions.getErrors();
if( errors == null || errors.isEmpty() ) {
return;
}
for( org.jbpm.bpmn2.core.Error error : errors ) {
String id = XmlBPMNProcessDumper.replaceIllegalCharsAttribute(error.getId());
String code = error.getErrorCode();
xmlDump.append(" nodes, StringBuilder xmlDump, int metaDataType) {
xmlDump.append(" " + EOL);
for (Node node: nodes) {
visitNode(node, xmlDump, metaDataType);
}
xmlDump.append(EOL);
}
private void visitNode(Node node, StringBuilder xmlDump, int metaDataType) {
Handler handler = semanticModule.getHandlerByClass(node.getClass());
if (handler != null) {
((AbstractNodeHandler) handler).writeNode((org.jbpm.workflow.core.Node) node, xmlDump, metaDataType);
} else {
throw new IllegalArgumentException(
"Unknown node type: " + node);
}
}
private void visitNodesDi(Node[] nodes, StringBuilder xmlDump) {
for (Node node: nodes) {
Integer x = (Integer) node.getMetaData().get("x");
Integer y = (Integer) node.getMetaData().get("y");
Integer width = (Integer) node.getMetaData().get("width");
Integer height = (Integer) node.getMetaData().get("height");
if (x == null) {
x = 0;
}
if (y == null) {
y = 0;
}
if (width == null) {
width = 48;
}
if (height == null) {
height = 48;
}
if (node instanceof StartNode || node instanceof EndNode || node instanceof EventNode || node instanceof FaultNode) {
int offsetX = (int) ((width - 48) / 2);
width = 48;
x = x + offsetX;
int offsetY = (int) ((height - 48) / 2);
y = y + offsetY;
height = 48;
} else if (node instanceof Join || node instanceof Split) {
int offsetX = (int) ((width - 48) / 2);
width = 48;
x = x + offsetX;
int offsetY = (int) ((height - 48) / 2);
y = y + offsetY;
height = 48;
}
int parentOffsetX = 0;
int parentOffsetY = 0;
NodeContainer nodeContainer = node.getNodeContainer();
while (nodeContainer instanceof CompositeNode) {
CompositeNode parent = (CompositeNode) nodeContainer;
Integer parentX = (Integer) parent.getMetaData().get("x");
if (parentX != null) {
parentOffsetX += parentX;
}
Integer parentY = (Integer) parent.getMetaData().get("y");
if (parentY != null) {
parentOffsetY += (Integer) parent.getMetaData().get("y");
}
nodeContainer = parent.getNodeContainer();
}
x += parentOffsetX;
y += parentOffsetY;
xmlDump.append(
" " + EOL +
" " + EOL);
if (node instanceof CompositeNode) {
visitNodesDi(((CompositeNode) node).getNodes(), xmlDump);
}
}
}
private void visitConnections(Node[] nodes, StringBuilder xmlDump, int metaDataType) {
xmlDump.append(" " + EOL);
List connections = new ArrayList();
for (Node node: nodes) {
for (List connectionList: node.getIncomingConnections().values()) {
connections.addAll(connectionList);
}
}
for (Connection connection: connections) {
visitConnection(connection, xmlDump, metaDataType);
}
xmlDump.append(EOL);
}
private boolean isConnectionRepresentingLinkEvent(Connection connection) {
boolean bValue = connection.getMetaData().get("linkNodeHidden") != null;
return bValue;
}
public void visitConnection(Connection connection, StringBuilder xmlDump, int metaDataType) {
// if the connection was generated by a link event, don't dump.
if (isConnectionRepresentingLinkEvent(connection)) {
return;
}
// if the connection is a hidden one (compensations), don't dump
Object hidden = ((ConnectionImpl) connection).getMetaData("hidden");
if( hidden != null && ((Boolean) hidden) ) {
return;
}
xmlDump.append(" " + EOL +
" " + XmlDumper.replaceIllegalChars(constraintString) + " ");
}
xmlDump.append(EOL
+ " " + EOL);
} else {
xmlDump.append("/>" + EOL);
}
} else {
xmlDump.append("/>" + EOL);
}
}
private void visitConnectionsDi(Node[] nodes, StringBuilder xmlDump) {
List connections = new ArrayList();
for (Node node: nodes) {
for (List connectionList: node.getIncomingConnections().values()) {
connections.addAll(connectionList);
}
if (node instanceof CompositeNode) {
visitConnectionsDi(((CompositeNode) node).getNodes(), xmlDump);
}
}
for (Connection connection: connections) {
String bendpoints = (String) connection.getMetaData().get("bendpoints");
xmlDump.append(
" " + EOL);
Integer x = (Integer) connection.getFrom().getMetaData().get("x");
if (x == null) {
x = 0;
}
Integer y = (Integer) connection.getFrom().getMetaData().get("y");
if (y == null) {
y = 0;
}
Integer width = (Integer) connection.getFrom().getMetaData().get("width");
if (width == null) {
width = 40;
}
Integer height = (Integer) connection.getFrom().getMetaData().get("height");
if (height == null) {
height = 40;
}
xmlDump.append(
" " + EOL);
}
}
public static String getUniqueNodeId(Node node) {
String result = (String) node.getMetaData().get("UniqueId");
if (result != null) {
return result;
}
result = node.getId() + "";
NodeContainer nodeContainer = node.getNodeContainer();
while (nodeContainer instanceof CompositeNode) {
CompositeNode composite = (CompositeNode) nodeContainer;
result = composite.getId() + "-" + result;
nodeContainer = composite.getNodeContainer();
}
return "_" + result;
}
public static String replaceIllegalCharsAttribute(final String code) {
final StringBuilder sb = new StringBuilder();
if ( code != null ) {
final int n = code.length();
for ( int i = 0; i < n; i++ ) {
final char c = code.charAt( i );
switch ( c ) {
case '<' :
sb.append( "<" );
break;
case '>' :
sb.append( ">" );
break;
case '&' :
sb.append( "&" );
break;
case '"' :
sb.append( """ );
break;
default :
sb.append( c );
break;
}
}
} else {
sb.append( "null" );
}
return sb.toString();
}
@Override
public String dumpProcess(Process process) {
return dump((RuleFlowProcess) process, false);
}
@Override
public Process readProcess(String processXml) {
SemanticModules semanticModules = new SemanticModules();
semanticModules.addSemanticModule(new BPMNSemanticModule());
semanticModules.addSemanticModule(new BPMNExtensionsSemanticModule());
semanticModules.addSemanticModule(new BPMNDISemanticModule());
XmlProcessReader xmlReader = new XmlProcessReader(semanticModules, Thread.currentThread().getContextClassLoader());
try {
List processes = xmlReader.read(new StringReader(processXml));
return processes.get(0);
} catch (Throwable t) {
t.printStackTrace();
return null;
}
}
}
