瀏覽代碼

HDDS-739. Support MultiDeleteRequest without XML namespace. Contributed by Elek Marton.

(cherry picked from commit 199703f9853b8dfd9df114030208ed45fc830c2b)
Bharat Viswanadham 6 年之前
父節點
當前提交
63814f6d7a

+ 1 - 1
hadoop-ozone/s3gateway/src/main/java/org/apache/hadoop/ozone/s3/endpoint/MultiDeleteRequest.java

@@ -34,7 +34,7 @@ import java.util.List;
 public class MultiDeleteRequest {
 
   @XmlElement(name = "Quiet")
-  private boolean quiet;
+  private Boolean quiet = Boolean.FALSE;
 
   @XmlElement(name = "Object")
   private List<DeleteObject> objects = new ArrayList<>();

+ 84 - 0
hadoop-ozone/s3gateway/src/main/java/org/apache/hadoop/ozone/s3/endpoint/MultiDeleteRequestUnmarshaller.java

@@ -0,0 +1,84 @@
+/**
+ * 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
+ * <p>
+ * http://www.apache.org/licenses/LICENSE-2.0
+ * <p>
+ * 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.hadoop.ozone.s3.endpoint;
+
+import javax.ws.rs.Produces;
+import javax.ws.rs.WebApplicationException;
+import javax.ws.rs.core.MediaType;
+import javax.ws.rs.core.MultivaluedMap;
+import javax.ws.rs.ext.MessageBodyReader;
+import javax.ws.rs.ext.Provider;
+import javax.xml.bind.JAXBContext;
+import javax.xml.bind.UnmarshallerHandler;
+import javax.xml.parsers.SAXParserFactory;
+import java.io.IOException;
+import java.io.InputStream;
+import java.lang.annotation.Annotation;
+import java.lang.reflect.Type;
+
+import org.xml.sax.InputSource;
+import org.xml.sax.XMLReader;
+
+/**
+ * Custom unmarshaller to read MultiDeleteRequest w/wo namespace.
+ */
+@Provider
+@Produces(MediaType.APPLICATION_XML)
+public class MultiDeleteRequestUnmarshaller
+    implements MessageBodyReader<MultiDeleteRequest> {
+
+  private final JAXBContext context;
+  private final XMLReader xmlReader;
+
+  public MultiDeleteRequestUnmarshaller() {
+    try {
+      context = JAXBContext.newInstance(MultiDeleteRequest.class);
+      SAXParserFactory saxParserFactory = SAXParserFactory.newInstance();
+      xmlReader = saxParserFactory.newSAXParser().getXMLReader();
+    } catch (Exception ex) {
+      throw new AssertionError("Can't instantiate MultiDeleteRequest parser",
+          ex);
+    }
+  }
+
+  @Override
+  public boolean isReadable(Class<?> type, Type genericType,
+      Annotation[] annotations, MediaType mediaType) {
+    return type.equals(MultiDeleteRequest.class);
+  }
+
+  @Override
+  public MultiDeleteRequest readFrom(Class<MultiDeleteRequest> type,
+      Type genericType, Annotation[] annotations, MediaType mediaType,
+      MultivaluedMap<String, String> httpHeaders, InputStream entityStream)
+      throws IOException, WebApplicationException {
+    try {
+      UnmarshallerHandler unmarshallerHandler =
+          context.createUnmarshaller().getUnmarshallerHandler();
+
+      XmlNamespaceFilter filter =
+          new XmlNamespaceFilter("http://s3.amazonaws.com/doc/2006-03-01/");
+      filter.setContentHandler(unmarshallerHandler);
+      filter.setParent(xmlReader);
+      filter.parse(new InputSource(entityStream));
+      return (MultiDeleteRequest) unmarshallerHandler.getResult();
+    } catch (Exception e) {
+      throw new WebApplicationException("Can't parse request body to XML.", e);
+    }
+  }
+}

+ 54 - 0
hadoop-ozone/s3gateway/src/main/java/org/apache/hadoop/ozone/s3/endpoint/XmlNamespaceFilter.java

@@ -0,0 +1,54 @@
+/**
+ * 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
+ * <p>
+ * http://www.apache.org/licenses/LICENSE-2.0
+ * <p>
+ * 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.hadoop.ozone.s3.endpoint;
+
+import org.xml.sax.Attributes;
+import org.xml.sax.SAXException;
+import org.xml.sax.helpers.XMLFilterImpl;
+
+/**
+ * SAX filter to force namespace usage.
+ * <p>
+ * This filter will read the XML content as namespace qualified content
+ * independent from the current namespace usage.
+ */
+public class XmlNamespaceFilter extends XMLFilterImpl {
+
+  private String namespace;
+
+  /**
+   * Create the filter.
+   *
+   * @param namespace to add to every elements.
+   */
+  public XmlNamespaceFilter(String namespace) {
+    this.namespace = namespace;
+  }
+
+  @Override
+  public void startElement(String uri, String localName, String qName,
+      Attributes atts) throws SAXException {
+    super.startElement(namespace, localName, qName, atts);
+  }
+
+  @Override
+  public void endElement(String uri, String localName, String qName)
+      throws SAXException {
+    super.endElement(namespace, localName, qName);
+  }
+}

+ 76 - 0
hadoop-ozone/s3gateway/src/test/java/org/apache/hadoop/ozone/s3/endpoint/TestMultiDeleteRequestUnmarshaller.java

@@ -0,0 +1,76 @@
+/*
+ * 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.hadoop.ozone.s3.endpoint;
+
+import java.io.ByteArrayInputStream;
+import java.io.IOException;
+
+import org.junit.Assert;
+import static org.junit.Assert.*;
+import org.junit.Test;
+
+/**
+ * Test custom marshalling of MultiDeleteRequest.
+ */
+public class TestMultiDeleteRequestUnmarshaller {
+
+  @Test
+  public void fromStreamWithNamespace() throws IOException {
+    //GIVEN
+    ByteArrayInputStream inputBody =
+        new ByteArrayInputStream(
+            ("<Delete xmlns=\"http://s3.amazonaws"
+                + ".com/doc/2006-03-01/\"><Object>key1</Object><Object>key2"
+                + "</Object><Object>key3"
+                + "</Object></Delete>")
+                .getBytes());
+
+    //WHEN
+    MultiDeleteRequest multiDeleteRequest =
+        unmarshall(inputBody);
+
+    //THEN
+    Assert.assertEquals(3, multiDeleteRequest.getObjects().size());
+  }
+
+  @Test
+  public void fromStreamWithoutNamespace() throws IOException {
+    //GIVEN
+    ByteArrayInputStream inputBody =
+        new ByteArrayInputStream(
+            ("<Delete><Object>key1</Object><Object>key2"
+                + "</Object><Object>key3"
+                + "</Object></Delete>")
+                .getBytes());
+
+    //WHEN
+    MultiDeleteRequest multiDeleteRequest =
+        unmarshall(inputBody);
+
+    //THEN
+    Assert.assertEquals(3, multiDeleteRequest.getObjects().size());
+  }
+
+  private MultiDeleteRequest unmarshall(ByteArrayInputStream inputBody)
+      throws IOException {
+    return new MultiDeleteRequestUnmarshaller()
+        .readFrom(null, null, null, null, null, inputBody);
+  }
+}