8347433: Deprecate XML interchange in java.management/javax/management/modelmbean/DescriptorSupport for removal

Reviewed-by: sspitsyn, dfuchs

Author: kevinjwalls

src/java.management/share/classes/javax/management/modelmbean/DescriptorSupport.java

@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2000, 2024, Oracle and/or its affiliates. All rights reserved.
+ * Copyright (c) 2000, 2025, Oracle and/or its affiliates. All rights reserved.
  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
  *
  * This code is free software; you can redistribute it and/or modify it
@@ -201,12 +201,16 @@ public DescriptorSupport(DescriptorSupport inDescr) {
      * @exception XMLParseException XML parsing problem while parsing
      * the input String
      * @exception MBeanException Wraps a distributed communication Exception.
+     * @deprecated This constructor exists for historical reasons.  If
+     * reading from XML is required, it should be implemented externally.
      */
     /* At some stage we should rewrite this code to be cleverer.  Using
        a StringTokenizer as we do means, first, that we accept a lot of
        bogus strings without noticing they are bogus, and second, that we
        split the string being parsed at characters like > even if they
        occur in the middle of a field value. */
+    @Deprecated(since="25", forRemoval=true)
+    @SuppressWarnings("removal")
     public DescriptorSupport(String inStr)
             throws MBeanException, RuntimeOperationsException,
                    XMLParseException {
@@ -230,6 +234,7 @@ public DescriptorSupport(String inStr)
         if (!lowerInStr.startsWith("<descriptor>")
             || !lowerInStr.endsWith("</descriptor>")) {
             throw new XMLParseException("No <descriptor>, </descriptor> pair");
+            // XMLParseException is deprecated for removal.
         }
 
         // parse xmlstring into structures
@@ -284,11 +289,13 @@ else if (kwPart.equalsIgnoreCase("VALUE"))
                         final String msg =
                             "Expected `name' or `value', got `" + tok + "'";
                         throw new XMLParseException(msg);
+                        // XMLParseException is deprecated for removal.
                     }
                 } else { // xml parse exception
                     final String msg =
                         "Expected `keyword=value', got `" + tok + "'";
                     throw new XMLParseException(msg);
+                    // XMLParseException is deprecated for removal.
                 }
             }
         }  // while tokens
@@ -967,7 +974,10 @@ private boolean validateField(String fldName, Object fldValue) {
      * field Names or field Values.  If the XML formatted string
      * construction fails for any reason, this exception will be
      * thrown.
+     * @deprecated This method exists for historical reasons.  If
+     * writing to XML is required, it should be implemented externally.
      */
+    @Deprecated(since="25", forRemoval=true)
     public synchronized String toXMLString() {
         final StringBuilder buf = new StringBuilder("<Descriptor>");
         Set<Map.Entry<String, Object>> returnedSet = descriptorMap.entrySet();
@@ -1057,9 +1067,12 @@ private static String quote(String s) {
         return buf.toString();
     }
 
+    @SuppressWarnings("removal")
     private static String unquote(String s) throws XMLParseException {
-        if (!s.startsWith("\"") || !s.endsWith("\""))
+        if (!s.startsWith("\"") || !s.endsWith("\"")) {
             throw new XMLParseException("Value must be quoted: <" + s + ">");
+            // XMLParseException is deprecated for removal.
+        }
         final StringBuilder buf = new StringBuilder();
         final int len = s.length() - 1;
         for (int i = 1; i < len; i++) {
@@ -1120,6 +1133,7 @@ private static String makeFieldValue(Object value) {
      * - some other string, in which case the result is that string,
      * without the parentheses.
      */
+    @SuppressWarnings("removal")
     private static Object parseQuotedFieldValue(String s)
             throws XMLParseException {
         s = unquote(s);
@@ -1142,8 +1156,8 @@ private static Object parseQuotedFieldValue(String s)
                 Class.forName(className, false, contextClassLoader);
             constr = c.getConstructor(new Class<?>[] {String.class});
         } catch (Exception e) {
-            throw new XMLParseException(e,
-                                        "Cannot parse value: <" + s + ">");
+            throw new XMLParseException(e, "Cannot parse value: <" + s + ">");
+            // XMLParseException is deprecated for removal.
         }
         final String arg = s.substring(slash + 1, s.length() - 1);
         try {
@@ -1153,6 +1167,7 @@ private static Object parseQuotedFieldValue(String s)
                 "Cannot construct instance of " + className +
                 " with arg: <" + s + ">";
             throw new XMLParseException(e, msg);
+            // XMLParseException is deprecated for removal.
         }
     }
 

src/java.management/share/classes/javax/management/modelmbean/RequiredModelMBean.java

@@ -91,8 +91,7 @@
  * from MBeans, connectors/adaptors like other MBeans. Through the
  * Descriptors, values and methods in the managed application can be
  * defined and mapped to attributes and operations of the ModelMBean.
- * This mapping can be defined in an XML formatted file or dynamically and
- * programmatically at runtime.
+ * This mapping can be defined dynamically and programmatically at runtime.
  * <P>
  * Every RequiredModelMBean which is instantiated in the MBeanServer
  * becomes manageable:<br>
@@ -129,7 +128,6 @@ public class RequiredModelMBean
      * and operations will be executed */
     private Object managedResource = null;
 
-
     /* records the registering in MBeanServer */
     private boolean registered = false;
     private transient MBeanServer server = null;
@@ -367,7 +365,7 @@ public void load()
         throw new MBeanException(x, x.getMessage());
     }
 
-        /**
+    /**
      * <p>Captures the current state of this MBean instance and writes
      * it out to the persistent store.  The state stored could include
      * attribute and operation values.</p>
@@ -651,7 +649,6 @@ private String printModelMBeanInfo(ModelMBeanInfo info) {
         retStr.append("\nCLASSNAME: \t").append(info.getClassName());
         retStr.append("\nDESCRIPTION: \t").append(info.getDescription());
 
-
         try {
             retStr.append("\nMBEAN DESCRIPTOR: \t").append(info.getMBeanDescriptor());
         } catch (Exception e) {

src/java.management/share/classes/javax/management/modelmbean/XMLParseException.java

@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2000, 2024, Oracle and/or its affiliates. All rights reserved.
+ * Copyright (c) 2000, 2025, Oracle and/or its affiliates. All rights reserved.
  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
  *
  * This code is free software; you can redistribute it and/or modify it
@@ -44,8 +44,12 @@
 *
 * <p>The <b>serialVersionUID</b> of this class is <code>3176664577895105181L</code>.
 *
+* @deprecated This class exists only to support XML parsing implemented privately in this module,
+* in DescriptorSupport.  That feature is deprecated for removal.
+*
 * @since 1.5
 */
+@Deprecated(since="25", forRemoval=true)
 public class XMLParseException
 extends Exception
 {