[FIXED JENKINS-22398] RobustMapConverter

jenkinsci · Mar 28, 2014 · 8109b9e · 8109b9e
1 parent 606d84c
commit 8109b9e
Show file tree

Hide file tree

Showing 3 changed files with 73 additions and 0 deletions.
diff --git a/changelog.html b/changelog.html
@@ -67,6 +67,9 @@
   <li class=bug>
     Fixed NPE in <tt>UserCause</tt>
     (<a href="https://issues.jenkins-ci.org/browse/JENKINS-21875">issue 21875</a>)
+  <li class=rfe>
+    Added <code>RobustMapConverter</code>.
+    (<a href="https://issues.jenkins-ci.org/browse/JENKINS-22398">issue 22398</a>)
 </ul>
 </div><!--=TRUNK-END=-->
 

diff --git a/core/src/main/java/hudson/util/RobustMapConverter.java b/core/src/main/java/hudson/util/RobustMapConverter.java
@@ -0,0 +1,69 @@
+/*
+ * The MIT License
+ *
+ * Copyright 2014 Jesse Glick.
+ *
+ * Permission is hereby granted, free of charge, to any person obtaining a copy
+ * of this software and associated documentation files (the "Software"), to deal
+ * in the Software without restriction, including without limitation the rights
+ * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+ * copies of the Software, and to permit persons to whom the Software is
+ * furnished to do so, subject to the following conditions:
+ *
+ * The above copyright notice and this permission notice shall be included in
+ * all copies or substantial portions of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+ * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+ * THE SOFTWARE.
+ */
+
+package hudson.util;
+
+import com.thoughtworks.xstream.XStreamException;
+import com.thoughtworks.xstream.converters.UnmarshallingContext;
+import com.thoughtworks.xstream.converters.collections.MapConverter;
+import com.thoughtworks.xstream.io.HierarchicalStreamReader;
+import com.thoughtworks.xstream.mapper.Mapper;
+import java.util.Map;
+
+/**
+ * Loads a {@link Map} while tolerating read errors on its keys and values.
+ */
+@SuppressWarnings({"rawtypes", "unchecked"})
+final class RobustMapConverter extends MapConverter {
+
+    private static final Object ERROR = new Object();
+
+    RobustMapConverter(Mapper mapper) {
+        super(mapper);
+    }
+
+    @Override protected void putCurrentEntryIntoMap(HierarchicalStreamReader reader, UnmarshallingContext context, Map map, Map target) {
+        Object key = read(reader, context, map);
+        Object value = read(reader, context, map);
+        if (key != ERROR && value != ERROR) {
+            target.put(key, value);
+        }
+    }
+
+    private Object read(HierarchicalStreamReader reader, UnmarshallingContext context, Map map) {
+        reader.moveDown();
+        try {
+            return readItem(reader, context, map);
+        } catch (XStreamException x) {
+            RobustReflectionConverter.addErrorInContext(context, x);
+            return ERROR;
+        } catch (LinkageError x) {
+            RobustReflectionConverter.addErrorInContext(context, x);
+            return ERROR;
+        } finally {
+            reader.moveUp();
+        }
+    }
+
+}
diff --git a/core/src/main/java/hudson/util/XStream2.java b/core/src/main/java/hudson/util/XStream2.java
@@ -145,6 +145,7 @@ private void init() {
         addImmutableType(Result.class);
 
         registerConverter(new RobustCollectionConverter(getMapper(),getReflectionProvider()),10);
+        registerConverter(new RobustMapConverter(getMapper()), 10);
         registerConverter(new ImmutableMapConverter(getMapper(),getReflectionProvider()),10);
         registerConverter(new ImmutableSortedSetConverter(getMapper(),getReflectionProvider()),10);
         registerConverter(new ImmutableSetConverter(getMapper(),getReflectionProvider()),10);