V11.2

RELEASE_NOTES.md

@@ -4,7 +4,15 @@ ESA CCSDS MO services - Release Notes
 These Release Notes include a short summary of the updates done for each version.
 The different versions and respective updates are the following:
 
-### Version 11.1 (TBD)
+### Version 11.2 (2025)
+* Fixes the MAL Broker bug that did not allow multiple PUB-SUB operations within the same service
+* MPD specification - Updates to include many of the RIDs found during implementation
+* Word API Generator: Supports the new "Requirements" section on operations. These are obtained from the XML file of the specs
+* Word API Generator: Supports the new "Type Signature" section on operations
+* Updated the Hybrid XSD to be closer to the latest version. Also, testbed XML specs had to be updated for compliance to the Hybrid XSD
+* Adds more tests to the MPD Testbed
+
+### Version 11.1 (05 December 2024)
 * Adds dedicated yaml workflows for testing the MAL with tcpip, http, and zmtp
 * Merges the xml-jaxb project into the generator-interfaces project
 * Improves the Enumerations auto-generated code

RELEASING.md

@@ -69,6 +69,12 @@ mvn clean deploy -P release
 
 6. Create a GitHub release in: https://github.com/esa/mo-services-java/releases
 
+7. Create a new branch from master:
+```
+git checkout master
+git pull
+git checkout -b vAA.B
+```
 
 Extra
 -------------

api-generator/api-generator-maven-plugin/pom.xml

@@ -19,12 +19,12 @@
     <parent>
         <groupId>int.esa.ccsds.mo</groupId>
         <artifactId>parent</artifactId>
-        <version>11.1</version>
+        <version>11.2</version>
         <relativePath>../../parent/pom.xml</relativePath>
     </parent>
 
     <artifactId>api-generator-maven-plugin</artifactId>
-    <version>11.1</version>
+    <version>11.2</version>
     <packaging>maven-plugin</packaging>
 
     <name>ESA MO API Generator - Maven Plugin</name>

api-generator/generator-docs/pom.xml

@@ -19,12 +19,12 @@
     <parent>
         <groupId>int.esa.ccsds.mo</groupId>
         <artifactId>parent</artifactId>
-        <version>11.1</version>
+        <version>11.2</version>
         <relativePath>../../parent/pom.xml</relativePath>
     </parent>
 
     <artifactId>generator-docs</artifactId>
-    <version>11.1</version>
+    <version>11.2</version>
     <packaging>jar</packaging>
 
     <name>ESA MO API Generator - Documentation</name>

api-generator/generator-docs/src/main/java/esa/mo/tools/stubgen/docx/DocxBaseWriter.java

@@ -74,7 +74,7 @@ public void startTable(int[] widths) throws IOException {
     }
 
     public void startTable(int[] widths, String caption) throws IOException {
-        if (null != caption) {
+        if (caption != null) {
             buffer.append(makeLine(2, "<w:p>"));
             buffer.append(makeLine(3, "<w:pPr><w:pStyle w:val=\"TableTitle\"/></w:pPr><w:r><w:t xml:space=\"preserve\">Table </w:t></w:r>"));
             buffer.append(makeLine(3, "<w:bookmarkStart w:id=\"0\" w:name=\"T_" + caption + "\"/>"));
@@ -85,8 +85,8 @@ public void startTable(int[] widths, String caption) throws IOException {
             buffer.append(makeLine(3, "<w:bookmarkEnd w:id=\"1\"/><w:r><w:instrText>\"</w:instrText></w:r><w:r><w:fldChar w:fldCharType=\"end\"/></w:r>"));
             buffer.append(makeLine(3, "<w:r><w:t>:  " + caption + "</w:t></w:r>"));
             buffer.append(makeLine(2, "</w:p>"));
-
         }
+
         buffer.append(makeLine(2, "<w:tbl>"));
         buffer.append(makeLine(3, "<w:tblPr>"));
         buffer.append(makeLine(4, "<w:tblW w:w=\"00\" w:type=\"auto\"/>"));
@@ -100,7 +100,7 @@ public void startTable(int[] widths, String caption) throws IOException {
         buffer.append(makeLine(4, "</w:tblBorders>"));
         buffer.append(makeLine(3, "</w:tblPr>"));
 
-        if (null != widths) {
+        if (widths != null) {
             buffer.append(makeLine(3, "<w:tblGrid>"));
             for (int i : widths) {
                 buffer.append(makeLine(4, "<w:gridCol w:w=\"" + i + "\"/>"));
@@ -273,7 +273,8 @@ public void addTitle(int level, String name) throws IOException {
     public void addTitle(int level, String section, String name, String bookmarkSection, boolean bookmark) throws IOException {
         buffer.append(makeLine(2, "<w:p><w:pPr><w:pStyle w:val=\"Heading" + level + "\"/></w:pPr>"));
         if (bookmark) {
-            buffer.append(makeLine(3, "<w:bookmarkStart w:id=\"1\" w:name=\"_" + bookmarkSection + "_" + name + "\"/><w:bookmarkEnd w:id=\"1\"/>"));
+            String linkTo = bookmarkSection + "_" + name;
+            buffer.append(makeLine(3, "<w:bookmarkStart w:id=\"1\" w:name=\"_" + linkTo + "\"/><w:bookmarkEnd w:id=\"1\"/>"));
         }
         buffer.append(makeLine(3, "<w:r><w:t>" + section + name + "</w:t></w:r>"));
         buffer.append(makeLine(2, "</w:p>"));
@@ -287,28 +288,19 @@ public void addNumberedComment(List<String> strings) throws IOException {
             }
 
             addNumberedComment(instance, 0, strings.iterator());
-            /*
-            if (strings.size() == 1) {
-                addComment(strings.get(0));
-            } else {
-                int instance = 0;
-                if (null != this.numberWriter) {
-                    instance = this.numberWriter.getNextNumberingInstance();
-                }
-
-                addNumberedComment(instance, 0, strings.iterator());
-            }
-             */
         }
     }
 
-    public void addNumberedComment(int instance, int level, Iterator<String> iterator) throws IOException {
-        while (iterator.hasNext()) {
-            String text = iterator.next();
+    public void addNumberedComment(int instance, int level, Iterator<String> lines) throws IOException {
+        while (lines.hasNext()) {
+            String text = lines.next();
 
             if (text != null) {
+                if (text.trim().isEmpty()) { // Jump over empty lines
+                    continue;
+                }
                 if ("<ol>".equalsIgnoreCase(text)) {
-                    addNumberedComment(instance, level + 1, iterator);
+                    addNumberedComment(instance, level + 1, lines);
                 } else if ("</ol>".equalsIgnoreCase(text)) {
                     return;
                 } else {
@@ -342,7 +334,7 @@ public void addComment(String text) throws IOException {
             }
 
             for (String str : strings) {
-                if (null != str) {
+                if (str != null) {
                     buffer.append(makeLine(2, str));
                 }
             }
@@ -369,7 +361,15 @@ private void addNumberedComment(int instance, int level, String text) throws IOE
                     addNumberedComment(instance, level, str);
                 }
             } else {
+                // Case when strings.size() == 1
                 String str = strings.get(0);
+
+                // Exceptional case when it has a "Note:"
+                if (text.toLowerCase().contains("note:")) {
+                    addNote(text);
+                    return;
+                }
+
                 if (str != null && str.length() > 0) {
                     buffer.append(makeLine(2, "<w:p><w:pPr><w:numPr><w:ilvl w:val=\""
                             + level + "\"/><w:numId w:val=\"" + instance + "\"/></w:numPr></w:pPr><w:r><w:t>"
@@ -379,6 +379,30 @@ private void addNumberedComment(int instance, int level, String text) throws IOE
         }
     }
 
+    public void addSingleTypeSignature(String fieldName, String fieldComment) throws IOException {
+        int instance = 1;
+        int level = 0;
+
+        buffer.append(makeLine(2, "<w:p><w:pPr><w:numPr><w:ilvl w:val=\""
+                + level + "\"/><w:numId w:val=\"" + instance + "\"/></w:numPr></w:pPr>"
+                + "<w:r><w:rPr><w:b/><w:bCs/></w:rPr><w:t>" + escape(fieldName)
+                + "</w:t></w:r><w:r><w:t  xml:space=\"preserve\">"
+                + " - " + escape(fieldComment) + "</w:t></w:r></w:p>"));
+    }
+
+    public void addNote(String noteText) throws IOException {
+        // Fix the text by removing the "Note: " and "NOTE: " strings
+        noteText = noteText.replace("Note: ", "");
+        noteText = noteText.replace("NOTE: ", "");
+
+        buffer.append(makeLine(2, "<w:p w14:paraId=\"7F00DCB7\" w14:textId=\"77777777\" w:rsidR=\"00B06274\" w:rsidRPr=\"00B06274\" w:rsidRDefault=\"00B06274\" w:rsidP=\"00B06274\">"));
+        buffer.append(makeLine(3, "<w:pPr><w:keepLines/><w:tabs><w:tab w:val=\"left\" w:pos=\"806\"/></w:tabs><w:spacing w:before=\"240\" w:after=\"0\" w:line=\"280\" w:lineRule=\"atLeast\"/><w:ind w:left=\"1138\" w:hanging=\"1138\"/><w:jc w:val=\"both\"/><w:rPr><w:kern w:val=\"0\"/><w:sz w:val=\"24\"/><w:szCs w:val=\"20\"/><w14:ligatures w14:val=\"none\"/></w:rPr></w:pPr>"));
+        buffer.append(makeLine(3, "<w:r w:rsidRPr=\"00B06274\"><w:t>NOTE</w:t></w:r>"));
+        buffer.append(makeLine(3, "<w:r w:rsidRPr=\"00B06274\"><w:tab/><w:t>–</w:t></w:r>"));
+        buffer.append(makeLine(3, "<w:r w:rsidRPr=\"00B06274\"><w:tab/><w:t>" + noteText + "</w:t></w:r>"));
+        buffer.append(makeLine(2, "</w:p>"));
+    }
+
     private String createTypeHyperLink(boolean includeMessageFieldNames, boolean oldStyle,
             AreaType area, ServiceType service, TypeRef ref) throws IOException {
         String prefix = "";
@@ -440,7 +464,6 @@ public String createHyperLink(String prefix, String typeName, String postfix,
 
         String temp = linkTo.replace("ObjectRef<", "").replace(">", "");
         String objectRefRemoved = temp.replace("ObjectRef(", "").replace(")", "");
-
         buf.append("</w:t></w:r>");
 
         if (withHyperlink) {

api-generator/generator-interfaces/pom.xml

@@ -19,12 +19,12 @@
     <parent>
         <groupId>int.esa.ccsds.mo</groupId>
         <artifactId>parent</artifactId>
-        <version>11.1</version>
+        <version>11.2</version>
         <relativePath>../../parent/pom.xml</relativePath>
     </parent>
 
     <artifactId>generator-interfaces</artifactId>
-    <version>11.1</version>
+    <version>11.2</version>
     <packaging>jar</packaging>
 
     <name>ESA MO API Generator - Interfaces</name>
@@ -65,12 +65,12 @@
         <dependency>
             <groupId>int.esa.ccsds.mo</groupId>
             <artifactId>xml-ccsds-mo-prototypes</artifactId>
-            <version>11.1</version>
+            <version>11.2</version>
         </dependency>
         <dependency>
             <groupId>int.esa.ccsds.mo</groupId>
             <artifactId>xml-ccsds-mo-standards</artifactId>
-            <version>11.1</version>
+            <version>11.2</version>
         </dependency>
         <!-- The dependencies below are needed for Java 9 and higher -->
         <dependency>
@@ -142,7 +142,7 @@
                     <dependency>
                         <groupId>xalan</groupId>
                         <artifactId>xalan</artifactId>
-                        <version>2.7.1</version>
+                        <version>2.7.2</version>
                     </dependency>
                 </dependencies>
             </plugin>

api-generator/generator-interfaces/src/main/java/esa/mo/tools/stubgen/GeneratorBase.java

@@ -613,7 +613,7 @@ private OperationSummary extractOperationSummary(OperationType op, int capNum) {
             SendOperationType lop = (SendOperationType) op;
             return new OperationSummary(InteractionPatternEnum.SEND_OP, op, capNum,
                     TypeUtils.convertTypeReferences(this,
-                            TypeUtils.getTypeListViaXSDAny(lop.getMessages().getSend().getAny())),
+                            TypeUtils.getTypeListViaField(lop.getMessages().getSend().getField())),
                     lop.getMessages().getSend().getComment(),
                     null, "",
                     null, "",
@@ -622,7 +622,7 @@ private OperationSummary extractOperationSummary(OperationType op, int capNum) {
             SubmitOperationType lop = (SubmitOperationType) op;
             return new OperationSummary(InteractionPatternEnum.SUBMIT_OP, op, capNum,
                     TypeUtils.convertTypeReferences(this,
-                            TypeUtils.getTypeListViaXSDAny(lop.getMessages().getSubmit().getAny())),
+                            TypeUtils.getTypeListViaField(lop.getMessages().getSubmit().getField())),
                     lop.getMessages().getSubmit().getComment(),
                     null, "",
                     null, "",
@@ -631,48 +631,48 @@ private OperationSummary extractOperationSummary(OperationType op, int capNum) {
             RequestOperationType lop = (RequestOperationType) op;
             return new OperationSummary(InteractionPatternEnum.REQUEST_OP, op, capNum,
                     TypeUtils.convertTypeReferences(this,
-                            TypeUtils.getTypeListViaXSDAny(lop.getMessages().getRequest().getAny())),
+                            TypeUtils.getTypeListViaField(lop.getMessages().getRequest().getField())),
                     lop.getMessages().getRequest().getComment(),
                     null, "",
                     null, "",
                     TypeUtils.convertTypeReferences(this,
-                            TypeUtils.getTypeListViaXSDAny(lop.getMessages().getResponse().getAny())),
+                            TypeUtils.getTypeListViaField(lop.getMessages().getResponse().getField())),
                     lop.getMessages().getResponse().getComment());
         } else if (op instanceof InvokeOperationType) {
             InvokeOperationType lop = (InvokeOperationType) op;
             return new OperationSummary(InteractionPatternEnum.INVOKE_OP, op, capNum,
                     TypeUtils.convertTypeReferences(this,
-                            TypeUtils.getTypeListViaXSDAny(lop.getMessages().getInvoke().getAny())),
+                            TypeUtils.getTypeListViaField(lop.getMessages().getInvoke().getField())),
                     lop.getMessages().getInvoke().getComment(),
                     TypeUtils.convertTypeReferences(this,
-                            TypeUtils.getTypeListViaXSDAny(lop.getMessages().getAcknowledgement().getAny())),
+                            TypeUtils.getTypeListViaField(lop.getMessages().getAcknowledgement().getField())),
                     lop.getMessages().getAcknowledgement().getComment(),
                     null, "",
                     TypeUtils.convertTypeReferences(this,
-                            TypeUtils.getTypeListViaXSDAny(lop.getMessages().getResponse().getAny())),
+                            TypeUtils.getTypeListViaField(lop.getMessages().getResponse().getField())),
                     lop.getMessages().getResponse().getComment());
         } else if (op instanceof ProgressOperationType) {
             ProgressOperationType lop = (ProgressOperationType) op;
             return new OperationSummary(InteractionPatternEnum.PROGRESS_OP, op, capNum,
                     TypeUtils.convertTypeReferences(this,
-                            TypeUtils.getTypeListViaXSDAny(lop.getMessages().getProgress().getAny())),
+                            TypeUtils.getTypeListViaField(lop.getMessages().getProgress().getField())),
                     lop.getMessages().getProgress().getComment(),
                     TypeUtils.convertTypeReferences(this,
-                            TypeUtils.getTypeListViaXSDAny(lop.getMessages().getAcknowledgement().getAny())),
+                            TypeUtils.getTypeListViaField(lop.getMessages().getAcknowledgement().getField())),
                     lop.getMessages().getAcknowledgement().getComment(),
                     TypeUtils.convertTypeReferences(this,
-                            TypeUtils.getTypeListViaXSDAny(lop.getMessages().getUpdate().getAny())),
+                            TypeUtils.getTypeListViaField(lop.getMessages().getUpdate().getField())),
                     lop.getMessages().getUpdate().getComment(),
                     TypeUtils.convertTypeReferences(this,
-                            TypeUtils.getTypeListViaXSDAny(lop.getMessages().getResponse().getAny())),
+                            TypeUtils.getTypeListViaField(lop.getMessages().getResponse().getField())),
                     lop.getMessages().getResponse().getComment());
         } else if (op instanceof PubSubOperationType) {
             PubSubOperationType lop = (PubSubOperationType) op;
-            AnyTypeReference subs = lop.getMessages().getSubscriptionKeys();
+            MessageBodyType subs = lop.getMessages().getSubscriptionKeys();
             List<FieldInfo> subKeysList = (subs == null) ? null
-                    : TypeUtils.convertTypeReferences(this, TypeUtils.getTypeListViaXSDAny(subs.getAny()));
+                    : TypeUtils.convertTypeReferences(this, TypeUtils.getTypeListViaField(subs.getField()));
             List<FieldInfo> riList = TypeUtils.convertTypeReferences(this,
-                    TypeUtils.getTypeListViaXSDAny(lop.getMessages().getPublishNotify().getAny()));
+                    TypeUtils.getTypeListViaField(lop.getMessages().getPublishNotify().getField()));
 
             return new OperationSummary(InteractionPatternEnum.PUBSUB_OP, op, capNum,
                     subKeysList, "",

api-generator/generator-interfaces/src/main/java/esa/mo/tools/stubgen/specification/OperationSummary.java

@@ -20,7 +20,7 @@
  */
 package esa.mo.tools.stubgen.specification;
 
-import esa.mo.xsd.AnyTypeReference;
+import esa.mo.xsd.MessageBodyType;
 import esa.mo.xsd.OperationType;
 import esa.mo.xsd.PubSubOperationType;
 import java.util.List;
@@ -220,7 +220,7 @@ public String getRetComment() {
         return retComment;
     }
 
-    public AnyTypeReference getSubscriptionKeys() {
+    public MessageBodyType getSubscriptionKeys() {
         PubSubOperationType lop = (PubSubOperationType) originalOp;
         return lop.getMessages().getSubscriptionKeys();
     }

api-generator/generator-interfaces/src/main/java/esa/mo/tools/stubgen/specification/TypeUtils.java

@@ -226,6 +226,23 @@ public static String getTypeShortForm(TypeInformation tiSource,
         return tiSource.convertToNamespace(targetType + ".SHORT_FORM");
     }
 
+    public static List<TypeRef> getTypeListViaField(List<NamedElementReferenceWithCommentType> any) {
+        if (any == null) {
+            return null;
+        }
+
+        if (any instanceof List) {
+            ArrayList<TypeRef> list = new ArrayList<>(any.size());
+            for (NamedElementReferenceWithCommentType e : any) {
+                list.add(getTypeFromValue(e));
+            }
+            return list;
+        } else {
+            throw new IllegalArgumentException(
+                    "Unexpected type in message body of : " + any.getClass().getSimpleName());
+        }
+    }
+
     /**
      * Converts an XML any field into a list of types.
      *
@@ -250,6 +267,25 @@ public static List<TypeRef> getTypeListViaXSDAny(Object any) {
         }
     }
 
+    /**
+     * Converts an NamedElementReferenceWithCommentType field into a type reference.
+     *
+     * @param any the XML any field.
+     * @return the converted type.
+     */
+    public static TypeRef getTypeFromValue(NamedElementReferenceWithCommentType any) {
+        if (any == null) {
+            return null;
+        }
+
+        if (any instanceof NamedElementReferenceWithCommentType) {
+            return new TypeRef((NamedElementReferenceWithCommentType) any);
+        } else {
+            throw new IllegalArgumentException(
+                    "Unexpected type in message body of : " + any.getClass().getSimpleName());
+        }
+    }
+
     /**
      * Converts an XML any field into a type reference.
      *