WFCORE-6779 Replace PersistentResourceXMLDescription with more robust API

.github/workflows/dep-diff-pull_request.yml

@@ -38,7 +38,7 @@ jobs:
         uses: actions/setup-java@v4
         with:
           distribution: 'temurin'
-          java-version: 11
+          java-version: 17
 
       # Run the caching against the base version only
       - name: Cache local Maven repository

README.md

@@ -14,7 +14,7 @@ Building
 
 Prerequisites:
 
-* JDK 11 or newer - check `java -version`
+* JDK 17 or newer - check `java -version`
 * Maven 3.6.0 or newer - check `mvn -v`
 
 To build with your own Maven installation:
@@ -63,7 +63,7 @@ Contributing
 Using Eclipse
 -------------
 1. Install the latest version of Eclipse.
-2. Make sure Xmx in Eclipse.ini is at least 1280M, and it's using java 11
+2. Make sure Xmx in Eclipse.ini is at least 1280M, and it's using java 17
 3. Launch Eclipse and install the m2e plugin, make sure it uses your repo configs
    (get it from: https://www.eclipse.org/m2e/
    or install "Maven Integration for Eclipse" from the Eclipse Marketplace).

controller/src/main/java/org/jboss/as/controller/AttributeParser.java

@@ -7,11 +7,13 @@
 
 
 import java.util.Collections;
+
 import javax.xml.stream.XMLStreamException;
 import javax.xml.stream.XMLStreamReader;
 
 import org.jboss.as.controller.operations.validation.ParameterValidator;
 import org.jboss.as.controller.parsing.ParseUtils;
+import org.jboss.as.controller.xml.XMLCardinality;
 import org.jboss.dmr.ModelNode;
 import org.jboss.staxmapper.XMLExtendedStreamReader;
 
@@ -96,6 +98,15 @@ public String getXmlName(final AttributeDefinition attribute){
         return attribute.getXmlName();
     }
 
+    /**
+     * Returns the cardinality of the XML particle for the specified attribute.
+     * @param attribute an attribute definition
+     * @return the cardinality of the XML particle for the specified attribute.
+     */
+    public XMLCardinality getCardinality(AttributeDefinition attribute) {
+        return this.isParseAsElement() ? (attribute.isNillable() ? XMLCardinality.Single.OPTIONAL : XMLCardinality.Single.REQUIRED) : XMLCardinality.NONE;
+    }
+
     public static final AttributeParser SIMPLE = new AttributeParser() {
     };
 

controller/src/main/java/org/jboss/as/controller/AttributeParsers.java

@@ -19,6 +19,7 @@
 import javax.xml.stream.XMLStreamException;
 
 import org.jboss.as.controller.parsing.ParseUtils;
+import org.jboss.as.controller.xml.XMLCardinality;
 import org.jboss.dmr.ModelNode;
 import org.jboss.staxmapper.XMLExtendedStreamReader;
 
@@ -95,39 +96,35 @@ public void parseElement(AttributeDefinition attribute, XMLExtendedStreamReader
             assert attribute instanceof MapAttributeDefinition;
             MapAttributeDefinition mapAttribute = (MapAttributeDefinition) attribute;
 
-            operation.get(attribute.getName()).setEmptyObject();//create empty attribute to address WFCORE-1448
+            if (!operation.hasDefined(attribute.getName())) {
+                // Create empty attribute to address WFCORE-1448
+                operation.get(attribute.getName()).setEmptyObject();
+            }
             if (wrapElement) {
                 if (!reader.getLocalName().equals(wrapper)) {
                     throw ParseUtils.unexpectedElement(reader, Collections.singleton(wrapper));
-                } else {
-                    // allow empty properties list
-                    if (reader.nextTag() == END_ELEMENT) {
-                        return;
-                    }
                 }
-            }
-
-            do {
-                if (elementName.equals(reader.getLocalName())) {
-                    //real parsing happens
-                    parseSingleElement(mapAttribute, reader, operation);
-                } else {
-                    throw ParseUtils.unexpectedElement(reader, Collections.singleton(elementName));
+                while (reader.hasNext() && (reader.nextTag() != END_ELEMENT)) {
+                    this.readElement(mapAttribute, reader, operation);
                 }
+            } else {
+                this.readElement(mapAttribute, reader, operation);
+            }
+        }
 
-            } while (reader.hasNext() && reader.nextTag() != END_ELEMENT && reader.getLocalName().equals(elementName));
-
-            if (wrapElement) {
-                // To exit the do loop either we hit an END_ELEMENT or a START_ELEMENT not for 'elementName'
-                // The latter means a bad document
-                if (reader.getEventType() != END_ELEMENT) {
-                    throw ParseUtils.unexpectedElement(reader, Collections.singleton(elementName));
-                }
+        private void readElement(MapAttributeDefinition attribute, XMLExtendedStreamReader reader, ModelNode operation) throws XMLStreamException {
+            if (!reader.getLocalName().equals(this.elementName)) {
+                throw ParseUtils.unexpectedElement(reader, Collections.singleton(this.elementName));
             }
+            this.parseSingleElement(attribute, reader, operation);
         }
 
         public abstract void parseSingleElement(MapAttributeDefinition attribute, XMLExtendedStreamReader reader, ModelNode operation) throws XMLStreamException;
 
+        @Override
+        public XMLCardinality getCardinality(AttributeDefinition attribute) {
+            return (this.wrapperElement != null) ? (attribute.isNillable() ? XMLCardinality.Single.OPTIONAL : XMLCardinality.Single.REQUIRED) : (attribute.isNillable() ? XMLCardinality.Unbounded.OPTIONAL : XMLCardinality.Unbounded.REQUIRED);
+        }
     }
 
 
@@ -192,7 +189,6 @@ public void parseSingleElement(MapAttributeDefinition attribute, XMLExtendedStre
             String key = reader.getAttributeValue(null, keyAttributeName);
             ModelNode op = operation.get(attribute.getName(), key);
             parseEmbeddedElement(objectType, reader, op, keyAttributeName);
-            ParseUtils.requireNoContent(reader);
         }
     }
 
@@ -218,9 +214,6 @@ public void parseElement(AttributeDefinition attribute, XMLExtendedStreamReader
             } else {
                 throw ParseUtils.unexpectedElement(reader, Collections.singleton(attribute.getXmlName()));
             }
-            if (!reader.isEndElement()) {
-                ParseUtils.requireNoContent(reader);
-            }
         }
 
         static void parseEmbeddedElement(ObjectTypeAttributeDefinition attribute, XMLExtendedStreamReader reader, ModelNode op, String... additionalExpectedAttributes) throws XMLStreamException {
@@ -261,8 +254,9 @@ static void parseEmbeddedElement(ObjectTypeAttributeDefinition attribute, XMLExt
                         throw ParseUtils.unexpectedElement(reader, attributeElements.keySet());
                     }
                 }
+            } else {
+                ParseUtils.requireNoContent(reader);
             }
-
         }
 
     }
@@ -297,9 +291,6 @@ public void parseElement(AttributeDefinition attribute, XMLExtendedStreamReader
                 } else {
                     throw ParseUtils.unexpectedElement(reader, Collections.singleton(objectType.getXmlName()));
                 }
-                if (!reader.isEndElement()) {
-                    ParseUtils.requireNoContent(reader);
-                }
             }
             operation.get(attribute.getName()).set(listValue);
         }
@@ -327,9 +318,11 @@ public void parseElement(AttributeDefinition attribute, XMLExtendedStreamReader
             } else {
                 throw ParseUtils.unexpectedElement(reader, Collections.singleton(xmlName));
             }
-            if (!reader.isEndElement()) {
-                ParseUtils.requireNoContent(reader);
-            }
+        }
+
+        @Override
+        public XMLCardinality getCardinality(AttributeDefinition attribute) {
+            return attribute.isNillable() ? XMLCardinality.Unbounded.OPTIONAL : XMLCardinality.Unbounded.REQUIRED;
         }
     }
 
@@ -348,6 +341,11 @@ public void parseElement(AttributeDefinition ad, XMLExtendedStreamReader reader,
             addPermissionMapper.get(ad.getName()).add(name);
             ParseUtils.requireNoContent(reader);
         }
+
+        @Override
+        public XMLCardinality getCardinality(AttributeDefinition attribute) {
+            return attribute.isNillable() ? XMLCardinality.Unbounded.OPTIONAL : XMLCardinality.Unbounded.REQUIRED;
+        }
     }
 
     static AttributeParser getObjectMapAttributeParser(String keyElementName) {