[API] Add a PluginXmlFactory

api/maven-api-core/src/main/java/org/apache/maven/api/services/xml/PluginXmlFactory.java

@@ -0,0 +1,30 @@
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one
+ * or more contributor license agreements.  See the NOTICE file
+ * distributed with this work for additional information
+ * regarding copyright ownership.  The ASF licenses this file
+ * to you 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.apache.maven.api.services.xml;
+
+import org.apache.maven.api.annotations.Experimental;
+import org.apache.maven.api.plugin.descriptor.PluginDescriptor;
+
+/**
+ * Reads and writes a {@link PluginDescriptor} object to/from XML.
+ *
+ * @since 4.0.0
+ */
+@Experimental
+public interface PluginXmlFactory extends XmlFactory<PluginDescriptor> {}

maven-core/src/main/java/org/apache/maven/internal/impl/DefaultPluginXmlFactory.java

@@ -0,0 +1,122 @@
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one
+ * or more contributor license agreements.  See the NOTICE file
+ * distributed with this work for additional information
+ * regarding copyright ownership.  The ASF licenses this file
+ * to you 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.apache.maven.internal.impl;
+
+import javax.inject.Named;
+import javax.inject.Singleton;
+
+import java.io.InputStream;
+import java.io.OutputStream;
+import java.io.Reader;
+import java.io.Writer;
+import java.net.URL;
+import java.nio.file.Files;
+import java.nio.file.Path;
+
+import org.apache.maven.api.annotations.Nonnull;
+import org.apache.maven.api.plugin.descriptor.PluginDescriptor;
+import org.apache.maven.api.services.xml.*;
+import org.apache.maven.plugin.descriptor.io.PluginDescriptorStaxReader;
+import org.apache.maven.plugin.descriptor.io.PluginDescriptorStaxWriter;
+
+import static org.apache.maven.internal.impl.Utils.nonNull;
+
+@Named
+@Singleton
+public class DefaultPluginXmlFactory implements PluginXmlFactory {
+    @Override
+    public PluginDescriptor read(@Nonnull XmlReaderRequest request) throws XmlReaderException {
+        nonNull(request, "request");
+        Path path = request.getPath();
+        URL url = request.getURL();
+        Reader reader = request.getReader();
+        InputStream inputStream = request.getInputStream();
+        if (path == null && url == null && reader == null && inputStream == null) {
+            throw new IllegalArgumentException("path, url, reader or inputStream must be non null");
+        }
+        try {
+            PluginDescriptorStaxReader xml = new PluginDescriptorStaxReader();
+            xml.setAddDefaultEntities(request.isAddDefaultEntities());
+            if (inputStream != null) {
+                return xml.read(inputStream, request.isStrict());
+            } else if (reader != null) {
+                return xml.read(reader, request.isStrict());
+            } else if (path != null) {
+                try (InputStream is = Files.newInputStream(path)) {
+                    return xml.read(is, request.isStrict());
+                }
+            } else {
+                try (InputStream is = url.openStream()) {
+                    return xml.read(is, request.isStrict());
+                }
+            }
+        } catch (Exception e) {
+            throw new XmlReaderException("Unable to read model", e);
+        }
+    }
+
+    @Override
+    public void write(XmlWriterRequest<PluginDescriptor> request) throws XmlWriterException {
+        nonNull(request, "request");
+        PluginDescriptor content = nonNull(request.getContent(), "content");
+        Path path = request.getPath();
+        OutputStream outputStream = request.getOutputStream();
+        Writer writer = request.getWriter();
+        if (writer == null && outputStream == null && path == null) {
+            throw new IllegalArgumentException("writer, outputStream or path must be non null");
+        }
+        try {
+            if (writer != null) {
+                new PluginDescriptorStaxWriter().write(writer, content);
+            } else if (outputStream != null) {
+                new PluginDescriptorStaxWriter().write(outputStream, content);
+            } else {
+                try (OutputStream os = Files.newOutputStream(path)) {
+                    new PluginDescriptorStaxWriter().write(outputStream, content);
+                }
+            }
+        } catch (Exception e) {
+            throw new XmlWriterException("Unable to write model", e);
+        }
+    }
+
+    /**
+     * Simply parse the given xml string.
+     *
+     * @param xml the input xml string
+     * @return the parsed object
+     * @throws XmlReaderException if an error occurs during the parsing
+     * @see #toXmlString(Object)
+     */
+    public static PluginDescriptor fromXml(@Nonnull String xml) throws XmlReaderException {
+        return new DefaultPluginXmlFactory().fromXmlString(xml);
+    }
+
+    /**
+     * Simply converts the given content to an xml string.
+     *
+     * @param content the object to convert
+     * @return the xml string representation
+     * @throws XmlWriterException if an error occurs during the transformation
+     * @see #fromXmlString(String)
+     */
+    public static String toXml(@Nonnull PluginDescriptor content) throws XmlWriterException {
+        return new DefaultPluginXmlFactory().toXmlString(content);
+    }
+}