diff --git a/core/src/main/java/hudson/util/XStream2.java b/core/src/main/java/hudson/util/XStream2.java index d484f43dca..bfe953b8f3 100644 --- a/core/src/main/java/hudson/util/XStream2.java +++ b/core/src/main/java/hudson/util/XStream2.java @@ -49,6 +49,8 @@ import hudson.util.xstream.ImmutableMapConverter; import java.lang.reflect.Constructor; import java.lang.reflect.InvocationTargetException; +import java.util.HashMap; +import java.util.Map; import java.util.concurrent.ConcurrentHashMap; /** @@ -59,6 +61,8 @@ public class XStream2 extends XStream { private Converter reflectionConverter; private ThreadLocal oldData = new ThreadLocal(); + private final Map compatibilityAliases = new ConcurrentHashMap(); + public XStream2() { init(); } @@ -124,6 +128,23 @@ public class XStream2 extends XStream { return a; } + /** + * Adds an alias in case class names change. + * + * Unlike {@link #alias(String, Class)}, which uses the registered alias name for writing XML, + * this method registers an alias to be used only for the sake of reading from XML. This makes + * this method usable for the situation when class names change. + * + * @param oldClassName + * Fully qualified name of the old class name. + * @param newClass + * New class that's field-compatible with the given old class name. + * @since 1.416 + */ + public void addCompatibilityAlias(String oldClassName, Class newClass) { + compatibilityAliases.put(oldClassName,newClass); + } + /** * Prior to Hudson 1.106, XStream 1.1.x was used which encoded "$" in class names * as "-" instead of "_-" that is used now. Up through Hudson 1.348 compatibility @@ -138,6 +159,9 @@ public class XStream2 extends XStream { @Override public Class realClass(String elementName) { + Class s = compatibilityAliases.get(elementName); + if (s!=null) return s; + try { return super.realClass(elementName); } catch (CannotResolveClassException e) { diff --git a/core/src/test/java/hudson/util/XStream2Test.java b/core/src/test/java/hudson/util/XStream2Test.java index 1626aaefe1..9a4cef91fc 100644 --- a/core/src/test/java/hudson/util/XStream2Test.java +++ b/core/src/test/java/hudson/util/XStream2Test.java @@ -27,6 +27,7 @@ import com.google.common.collect.ImmutableMap; import junit.framework.TestCase; import hudson.model.Result; import hudson.model.Run; +import org.jvnet.hudson.test.Bug; import java.util.Map; @@ -165,9 +166,25 @@ public class XStream2Test extends TestCase { assertEquals(m,a.m); } - // @Bug(8006) -- Previously a null entry in an array caused NPE + @Bug(8006) // Previously a null entry in an array caused NPE public void testEmptyStack() { assertEquals("", Run.XSTREAM.toXML(new Object[2]).replaceAll("[ \n\r\t]+", "")); } + + @Bug(9843) + public void testCompatibilityAlias() { + XStream2 xs = new XStream2(); + xs.addCompatibilityAlias("legacy.Point",Point.class); + Point pt = (Point)xs.fromXML("12"); + assertEquals(1,pt.x); + assertEquals(2,pt.y); + String xml = xs.toXML(pt); + System.out.println(xml); + assertFalse("Shouldn't use the alias when writing back",xml.contains("legacy")); + } + + public static class Point { + public int x,y; + } }