+ * Note, while a reference-keeping marshaller will not write references for immutable types into the stream, a + * reference-keeping unmarshaller can still support such references in the stream for compatibility reasons at the + * expense of memory consumption. Therefore declare these types only as referenceable if your already persisted + * streams do contain such references. Otherwise you may waste a lot of memory during deserialization. + *
+ * + * @param isReferenceabletrue if support at deserialization time is required for compatibility at the
+ * cost of a higher memory footprint, false otherwise
+ * @throws InitializationException if no {@link ImmutableTypesMapper} is available
+ * @since 1.4.9
+ */
+ public void addImmutableType(final Class type, final boolean isReferenceable) {
if (immutableTypesMapper == null) {
throw new com.thoughtworks.xstream.InitializationException("No "
+ ImmutableTypesMapper.class.getName()
+ " available");
}
- immutableTypesMapper.addImmutableType(type);
+ immutableTypesMapper.addImmutableType(type, isReferenceable);
}
public void registerConverter(Converter converter) {
@@ -1453,7 +1497,7 @@
/**
* Register a local {@link Converter} for a field.
- *
+ *
* @param definedIn the class type the field is defined in
* @param fieldName the field name
* @param converter the converter to use
@@ -1470,7 +1514,7 @@
/**
* Register a local {@link SingleValueConverter} for a field.
- *
+ *
* @param definedIn the class type the field is defined in
* @param fieldName the field name
* @param converter the converter to use
@@ -1495,7 +1539,7 @@
/**
* Retrieve the {@link ReflectionProvider} in use.
- *
+ *
* @return the mapper
* @since 1.2.1
*/
@@ -1551,7 +1595,7 @@
/**
* Adds a default implicit collection which is used for any unmapped XML tag.
- *
+ *
* @param ownerType class owning the implicit collection
* @param fieldName name of the field in the ownerType. This field must be a concrete
* collection type or matching the default implementation type of the collection
@@ -1563,7 +1607,7 @@
/**
* Adds implicit collection which is used for all items of the given itemType.
- *
+ *
* @param ownerType class owning the implicit collection
* @param fieldName name of the field in the ownerType. This field must be a concrete
* collection type or matching the default implementation type of the collection
@@ -1594,7 +1638,7 @@
/**
* Adds an implicit array.
- *
+ *
* @param ownerType class owning the implicit array
* @param fieldName name of the array field
* @since 1.4
@@ -1634,7 +1678,7 @@
/**
* Adds an implicit map.
- *
+ *
* @param ownerType class owning the implicit map
* @param fieldName name of the field in the ownerType. This field must be a concrete
* map type or matching the default implementation type of the map
@@ -1649,7 +1693,7 @@
/**
* Adds an implicit map.
- *
+ *
* @param ownerType class owning the implicit map
* @param fieldName name of the field in the ownerType. This field must be a concrete
* map type or matching the default implementation type of the map
@@ -1673,7 +1717,7 @@
* Create a DataHolder that can be used to pass data to the converters. The DataHolder is
* provided with a call to {@link #marshal(Object, HierarchicalStreamWriter, DataHolder)} or
* {@link #unmarshal(HierarchicalStreamReader, Object, DataHolder)}.
- *
+ *
* @return a new {@link DataHolder}
*/
public DataHolder newDataHolder() {
@@ -1776,7 +1820,7 @@
* be incomplete.
*
*
* ObjectOutputStream out = xstream.createObjectOutputStream(aWriter, "things");
* out.writeInt(123);
@@ -1784,7 +1828,7 @@
* out.writeObject(someObject)
* out.close();
*
- *
+ *
* @param writer The writer to serialize the objects to.
* @param rootNodeName The name of the root node enclosing the stream of objects.
* @see #createObjectInputStream(com.thoughtworks.xstream.io.HierarchicalStreamReader)
@@ -1908,7 +1952,7 @@
/**
* Retrieve the ClassLoader XStream uses to load classes.
- *
+ *
* @since 1.1.1
*/
public ClassLoader getClassLoader() {
@@ -1945,7 +1989,7 @@
/**
* Ignore all unknown elements.
- *
+ *
* @since 1.4.5
*/
public void ignoreUnknownElements() {
@@ -1954,7 +1998,7 @@
/**
* Add pattern for unknown element names to ignore.
- *
+ *
* @param pattern the name pattern as regular expression
* @since 1.4.5
*/
@@ -1964,7 +2008,7 @@
/**
* Add pattern for unknown element names to ignore.
- *
+ *
* @param pattern the name pattern as regular expression
* @since 1.4.5
*/
@@ -1979,7 +2023,7 @@
/**
* Process the annotations of the given types and configure the XStream.
- *
+ *
* @param types the types with XStream annotations
* @since 1.3
*/
@@ -2025,7 +2069,7 @@
* Permissions are evaluated in the added sequence. An instance of {@link NoTypePermission} or
* {@link AnyTypePermission} will implicitly wipe any existing permission.
*
- *
+ *
* @param permission the permission to add
* @since 1.4.7
*/
@@ -2037,7 +2081,7 @@
/**
* Add security permission for explicit types by name.
- *
+ *
* @param names the type names to allow
* @since 1.4.7
*/
@@ -2047,7 +2091,7 @@
/**
* Add security permission for explicit types.
- *
+ *
* @param types the types to allow
* @since 1.4.7
*/
@@ -2057,7 +2101,7 @@
/**
* Add security permission for a type hierarchy.
- *
+ *
* @param type the base type to allow
* @since 1.4.7
*/
@@ -2067,7 +2111,7 @@
/**
* Add security permission for types matching one of the specified regular expressions.
- *
+ *
* @param regexps the regular expressions to allow type names
* @since 1.4.7
*/
@@ -2077,7 +2121,7 @@
/**
* Add security permission for types matching one of the specified regular expressions.
- *
+ *
* @param regexps the regular expressions to allow type names
* @since 1.4.7
*/
@@ -2095,7 +2139,7 @@
* null
* @since 1.4
*/
- public Field fieldOrNull(Class cls, String name, Class definedIn) {
- Map fields = buildMap(cls, definedIn != null);
- Field field = (Field)fields.get(definedIn != null
+ public Field fieldOrNull(final Class cls, final String name, final Class definedIn) {
+ final Map fields = buildMap(cls, definedIn != null);
+ final Field field = (Field)fields.get(definedIn != null
? (Object)new FieldKey(name, definedIn, -1)
: (Object)name);
return field;
}
- private Map buildMap(final Class type, boolean tupleKeyed) {
+ private Map buildMap(final Class type, final boolean tupleKeyed) {
+
Class cls = type;
- synchronized (this) {
- if (!keyedByFieldNameCache.containsKey(type)) {
- final List superClasses = new ArrayList();
- while (!Object.class.equals(cls) && cls != null) {
- superClasses.add(0, cls);
- cls = cls.getSuperclass();
+
+ DictionaryEntry lastDictionaryEntry = null;
+ final LinkedList superClasses = new LinkedList();
+ while (lastDictionaryEntry == null) {
+ if (Object.class.equals(cls) || cls == null) {
+ lastDictionaryEntry = OBJECT_DICTIONARY_ENTRY;
+ } else {
+ lastDictionaryEntry = getDictionaryEntry(cls);
+ }
+ if (lastDictionaryEntry == null) {
+ superClasses.addFirst(cls);
+ cls = cls.getSuperclass();
+ }
+ }
+
+ for (final Iterator iter = superClasses.iterator(); iter.hasNext();) {
+ cls = (Class)iter.next();
+ DictionaryEntry newDictionaryEntry = buildDictionaryEntryForClass(cls, lastDictionaryEntry);
+ synchronized (this) {
+ final DictionaryEntry concurrentEntry = getDictionaryEntry(cls);
+ if (concurrentEntry == null) {
+ dictionaryEntries.put(cls, newDictionaryEntry);
+ } else {
+ newDictionaryEntry = concurrentEntry;
}
- Map lastKeyedByFieldName = Collections.EMPTY_MAP;
- Map lastKeyedByFieldKey = Collections.EMPTY_MAP;
- for (final Iterator iter = superClasses.iterator(); iter.hasNext();) {
- cls = (Class)iter.next();
- if (!keyedByFieldNameCache.containsKey(cls)) {
- final Map keyedByFieldName = new HashMap(lastKeyedByFieldName);
- final Map keyedByFieldKey = new OrderRetainingMap(lastKeyedByFieldKey);
- Field[] fields = cls.getDeclaredFields();
- if (JVM.reverseFieldDefinition()) {
- for (int i = fields.length >> 1; i-- > 0;) {
- final int idx = fields.length - i - 1;
- final Field field = fields[i];
- fields[i] = fields[idx];
- fields[idx] = field;
- }
- }
- for (int i = 0; i < fields.length; i++ ) {
- Field field = fields[i];
- if (!field.isAccessible()) {
- field.setAccessible(true);
- }
- FieldKey fieldKey = new FieldKey(
- field.getName(), field.getDeclaringClass(), i);
- Field existent = (Field)keyedByFieldName.get(field.getName());
- if (existent == null
- // do overwrite statics
- || ((existent.getModifiers() & Modifier.STATIC) != 0)
- // overwrite non-statics with non-statics only
- || (existent != null && ((field.getModifiers() & Modifier.STATIC) == 0))) {
- keyedByFieldName.put(field.getName(), field);
- }
- keyedByFieldKey.put(fieldKey, field);
- }
- final Map sortedFieldKeys = sorter.sort(cls, keyedByFieldKey);
- keyedByFieldNameCache.put(cls, keyedByFieldName);
- keyedByFieldKeyCache.put(cls, sortedFieldKeys);
- lastKeyedByFieldName = keyedByFieldName;
- lastKeyedByFieldKey = sortedFieldKeys;
- } else {
- lastKeyedByFieldName = (Map)keyedByFieldNameCache.get(cls);
- lastKeyedByFieldKey = (Map)keyedByFieldKeyCache.get(cls);
- }
- }
- return tupleKeyed ? lastKeyedByFieldKey : lastKeyedByFieldName;
- }
- }
- return (Map)(tupleKeyed
- ? keyedByFieldKeyCache.get(type)
- : keyedByFieldNameCache.get(type));
+ }
+ lastDictionaryEntry = newDictionaryEntry;
+ }
+
+ return tupleKeyed ? lastDictionaryEntry.getKeyedByFieldKey() : lastDictionaryEntry.getKeyedByFieldName();
+
+ }
+
+ private DictionaryEntry buildDictionaryEntryForClass(final Class cls, final DictionaryEntry lastDictionaryEntry) {
+ final Map keyedByFieldName = new HashMap(lastDictionaryEntry.getKeyedByFieldName());
+ final Map keyedByFieldKey = new OrderRetainingMap(lastDictionaryEntry.getKeyedByFieldKey());
+ final Field[] fields = cls.getDeclaredFields();
+ if (JVM.reverseFieldDefinition()) {
+ for (int i = fields.length >> 1; i-- > 0;) {
+ final int idx = fields.length - i - 1;
+ final Field field = fields[i];
+ fields[i] = fields[idx];
+ fields[idx] = field;
+ }
+ }
+ for (int i = 0; i < fields.length; i++) {
+ final Field field = fields[i];
+ if (!field.isAccessible()) {
+ field.setAccessible(true);
+ }
+ final FieldKey fieldKey = new FieldKey(field.getName(), field.getDeclaringClass(), i);
+ final Field existent = (Field)keyedByFieldName.get(field.getName());
+ if (existent == null
+ // do overwrite statics
+ || (existent.getModifiers() & Modifier.STATIC) != 0
+ // overwrite non-statics with non-statics only
+ || (existent != null && (field.getModifiers() & Modifier.STATIC) == 0)) {
+ keyedByFieldName.put(field.getName(), field);
+ }
+ keyedByFieldKey.put(fieldKey, field);
+ }
+ final Map sortedFieldKeys = sorter.sort(cls, keyedByFieldKey);
+ return new DictionaryEntry(keyedByFieldName, sortedFieldKeys);
+ }
+
+ private synchronized DictionaryEntry getDictionaryEntry(final Class cls) {
+ return (DictionaryEntry)dictionaryEntries.get(cls);
}
public synchronized void flushCache() {
- Set objectTypeSet = Collections.singleton(Object.class);
- keyedByFieldNameCache.keySet().retainAll(objectTypeSet);
- keyedByFieldKeyCache.keySet().retainAll(objectTypeSet);
+ dictionaryEntries.clear();
if (sorter instanceof Caching) {
((Caching)sorter).flushCache();
}
@@ -190,4 +193,24 @@
init();
return this;
}
+
+ private static final class DictionaryEntry {
+
+ private final Map keyedByFieldName;
+ private final Map keyedByFieldKey;
+
+ public DictionaryEntry(final Map keyedByFieldName, final Map keyedByFieldKey) {
+ super();
+ this.keyedByFieldName = keyedByFieldName;
+ this.keyedByFieldKey = keyedByFieldKey;
+ }
+
+ public Map getKeyedByFieldName() {
+ return keyedByFieldName;
+ }
+
+ public Map getKeyedByFieldKey() {
+ return keyedByFieldKey;
+ }
+ }
}
diff --git a/xstream/src/java/com/thoughtworks/xstream/converters/reflection/MissingFieldException.java b/xstream/src/java/com/thoughtworks/xstream/converters/reflection/MissingFieldException.java
index 102fa92..1046d5c 100644
--- a/xstream/src/java/com/thoughtworks/xstream/converters/reflection/MissingFieldException.java
+++ b/xstream/src/java/com/thoughtworks/xstream/converters/reflection/MissingFieldException.java
@@ -1,5 +1,5 @@
/*
- * Copyright (C) 2011 XStream Committers.
+ * Copyright (C) 2011, 2016 XStream Committers.
* All rights reserved.
*
* The software in this package is published under the terms of the BSD
@@ -29,9 +29,10 @@
* @since 1.4.2
*/
public MissingFieldException(final String className, final String fieldName) {
- super("No field '" + fieldName + "' found in class '" + className + "'");
+ super("Field not found in class.");
this.className = className;
this.fieldName = fieldName;
+ add("field", className + "." + fieldName);
}
/**
diff --git a/xstream/src/java/com/thoughtworks/xstream/converters/reflection/ObjectAccessException.java b/xstream/src/java/com/thoughtworks/xstream/converters/reflection/ObjectAccessException.java
index c3ac302..5ea05e8 100644
--- a/xstream/src/java/com/thoughtworks/xstream/converters/reflection/ObjectAccessException.java
+++ b/xstream/src/java/com/thoughtworks/xstream/converters/reflection/ObjectAccessException.java
@@ -1,6 +1,6 @@
/*
* Copyright (C) 2004 Joe Walnes.
- * Copyright (C) 2006, 2007 XStream Committers.
+ * Copyright (C) 2006, 2007, 2016 XStream Committers.
* All rights reserved.
*
* The software in this package is published under the terms of the BSD
@@ -11,9 +11,9 @@
*/
package com.thoughtworks.xstream.converters.reflection;
-import com.thoughtworks.xstream.XStreamException;
+import com.thoughtworks.xstream.converters.ErrorWritingException;
-public class ObjectAccessException extends XStreamException {
+public class ObjectAccessException extends ErrorWritingException {
public ObjectAccessException(String message) {
super(message);
}
diff --git a/xstream/src/java/com/thoughtworks/xstream/converters/reflection/PureJavaReflectionProvider.java b/xstream/src/java/com/thoughtworks/xstream/converters/reflection/PureJavaReflectionProvider.java
index 8158e37..d2beebd 100644
--- a/xstream/src/java/com/thoughtworks/xstream/converters/reflection/PureJavaReflectionProvider.java
+++ b/xstream/src/java/com/thoughtworks/xstream/converters/reflection/PureJavaReflectionProvider.java
@@ -1,6 +1,6 @@
/*
* Copyright (C) 2004, 2005, 2006 Joe Walnes.
- * Copyright (C) 2006, 2007, 2009, 2011, 2013 XStream Committers.
+ * Copyright (C) 2006, 2007, 2009, 2011, 2013, 2016 XStream Committers.
* All rights reserved.
*
* The software in this package is published under the terms of the BSD
@@ -12,6 +12,7 @@
package com.thoughtworks.xstream.converters.reflection;
import com.thoughtworks.xstream.core.JVM;
+import com.thoughtworks.xstream.core.util.Fields;
import java.io.ByteArrayInputStream;
import java.io.ByteArrayOutputStream;
@@ -57,6 +58,7 @@
}
public Object newInstance(Class type) {
+ ObjectAccessException oaex = null;
try {
Constructor[] constructors = type.getDeclaredConstructors();
for (int i = 0; i < constructors.length; i++) {
@@ -71,25 +73,27 @@
if (Serializable.class.isAssignableFrom(type)) {
return instantiateUsingSerialization(type);
} else {
- throw new ObjectAccessException("Cannot construct " + type.getName()
- + " as it does not have a no-args constructor");
+ oaex = new ObjectAccessException("Cannot construct type as it does not have a no-args constructor");
}
} catch (InstantiationException e) {
- throw new ObjectAccessException("Cannot construct " + type.getName(), e);
+ oaex = new ObjectAccessException("Cannot construct type", e);
} catch (IllegalAccessException e) {
- throw new ObjectAccessException("Cannot construct " + type.getName(), e);
+ oaex = new ObjectAccessException("Cannot construct type", e);
} catch (InvocationTargetException e) {
if (e.getTargetException() instanceof RuntimeException) {
throw (RuntimeException)e.getTargetException();
} else if (e.getTargetException() instanceof Error) {
throw (Error)e.getTargetException();
} else {
- throw new ObjectAccessException("Constructor for " + type.getName() + " threw an exception", e.getTargetException());
- }
- }
+ oaex = new ObjectAccessException("Constructor for type threw an exception", e.getTargetException());
+ }
+ }
+ oaex.add("construction-type", type.getName());
+ throw oaex;
}
private Object instantiateUsingSerialization(final Class type) {
+ ObjectAccessException oaex = null;
try {
synchronized (serializedDataCache) {
byte[] data = (byte[]) serializedDataCache.get(type);
@@ -119,10 +123,12 @@
return in.readObject();
}
} catch (IOException e) {
- throw new ObjectAccessException("Cannot create " + type.getName() + " by JDK serialization", e);
+ oaex = new ObjectAccessException("Cannot create type by JDK serialization", e);
} catch (ClassNotFoundException e) {
- throw new ObjectAccessException("Cannot find class " + e.getMessage(), e);
- }
+ oaex = new ObjectAccessException("Cannot find class", e);
+ }
+ oaex.add("construction-type", type.getName());
+ throw oaex;
}
public void visitSerializableFields(Object object, ReflectionProvider.Visitor visitor) {
@@ -132,27 +138,15 @@
continue;
}
validateFieldAccess(field);
- try {
- Object value = field.get(object);
- visitor.visit(field.getName(), field.getType(), field.getDeclaringClass(), value);
- } catch (IllegalArgumentException e) {
- throw new ObjectAccessException("Could not get field " + field.getClass() + "." + field.getName(), e);
- } catch (IllegalAccessException e) {
- throw new ObjectAccessException("Could not get field " + field.getClass() + "." + field.getName(), e);
- }
+ Object value = Fields.read(field, object);
+ visitor.visit(field.getName(), field.getType(), field.getDeclaringClass(), value);
}
}
public void writeField(Object object, String fieldName, Object value, Class definedIn) {
Field field = fieldDictionary.field(object.getClass(), fieldName, definedIn);
validateFieldAccess(field);
- try {
- field.set(object, value);
- } catch (IllegalArgumentException e) {
- throw new ObjectAccessException("Could not set field " + object.getClass() + "." + field.getName(), e);
- } catch (IllegalAccessException e) {
- throw new ObjectAccessException("Could not set field " + object.getClass() + "." + field.getName(), e);
- }
+ Fields.write(field, object, value);
}
public Class getFieldType(Object object, String fieldName, Class definedIn) {
diff --git a/xstream/src/java/com/thoughtworks/xstream/converters/reflection/SerializableConverter.java b/xstream/src/java/com/thoughtworks/xstream/converters/reflection/SerializableConverter.java
index 2825980..6488069 100644
--- a/xstream/src/java/com/thoughtworks/xstream/converters/reflection/SerializableConverter.java
+++ b/xstream/src/java/com/thoughtworks/xstream/converters/reflection/SerializableConverter.java
@@ -1,6 +1,6 @@
/*
* Copyright (C) 2004, 2005, 2006 Joe Walnes.
- * Copyright (C) 2006, 2007, 2008, 2010, 2011, 2012, 2013, 2014, 2015 XStream Committers.
+ * Copyright (C) 2006, 2007, 2008, 2010, 2011, 2012, 2013, 2014, 2015, 2016 XStream Committers.
* All rights reserved.
*
* The software in this package is published under the terms of the BSD
@@ -32,10 +32,12 @@
import com.thoughtworks.xstream.core.JVM;
import com.thoughtworks.xstream.core.util.CustomObjectInputStream;
import com.thoughtworks.xstream.core.util.CustomObjectOutputStream;
+import com.thoughtworks.xstream.core.util.Fields;
import com.thoughtworks.xstream.core.util.HierarchicalStreams;
import com.thoughtworks.xstream.io.ExtendedHierarchicalStreamWriterHelper;
import com.thoughtworks.xstream.io.HierarchicalStreamReader;
import com.thoughtworks.xstream.io.HierarchicalStreamWriter;
+import com.thoughtworks.xstream.io.StreamException;
import com.thoughtworks.xstream.mapper.Mapper;
/**
@@ -151,8 +153,7 @@
ObjectStreamField field = objectStreamClass.getField(name);
Object value = fields.get(name);
if (field == null) {
- throw new ObjectAccessException("Class " + value.getClass().getName()
- + " may not write a field named '" + name + "'");
+ throw new MissingFieldException(value.getClass().getName(), name);
}
if (value != null) {
ExtendedHierarchicalStreamWriterHelper.startNode(
@@ -280,7 +281,7 @@
}
}
} catch (IOException e) {
- throw new ObjectAccessException("Could not call defaultWriteObject()", e);
+ throw new StreamException("Cannot write defaults", e);
}
}
@@ -291,21 +292,8 @@
}
private Object readField(ObjectStreamField field, Class type, Object instance) {
- try {
- Field javaField = type.getDeclaredField(field.getName());
- if (!javaField.isAccessible()) {
- javaField.setAccessible(true);
- }
- return javaField.get(instance);
- } catch (IllegalArgumentException e) {
- throw new ObjectAccessException("Could not get field " + field.getClass() + "." + field.getName(), e);
- } catch (IllegalAccessException e) {
- throw new ObjectAccessException("Could not get field " + field.getClass() + "." + field.getName(), e);
- } catch (NoSuchFieldException e) {
- throw new ObjectAccessException("Could not get field " + field.getClass() + "." + field.getName(), e);
- } catch (SecurityException e) {
- throw new ObjectAccessException("Could not get field " + field.getClass() + "." + field.getName(), e);
- }
+ Field javaField = Fields.find(type, field.getName());
+ return Fields.read(javaField, instance);
}
protected List hierarchyFor(Class type) {
@@ -426,7 +414,7 @@
try {
validation.validateObject();
} catch (InvalidObjectException e) {
- throw new ObjectAccessException("Cannot validate object : " + e.getMessage(), e);
+ throw new ObjectAccessException("Cannot validate object", e);
}
}
}, priority);
@@ -458,7 +446,7 @@
try {
callback.defaultReadObject();
} catch (IOException e) {
- throw new ObjectAccessException("Could not call defaultWriteObject()", e);
+ throw new StreamException("Cannot read defaults", e);
}
}
}
diff --git a/xstream/src/java/com/thoughtworks/xstream/converters/reflection/SortableFieldKeySorter.java b/xstream/src/java/com/thoughtworks/xstream/converters/reflection/SortableFieldKeySorter.java
index f6bee5e..91333c8 100644
--- a/xstream/src/java/com/thoughtworks/xstream/converters/reflection/SortableFieldKeySorter.java
+++ b/xstream/src/java/com/thoughtworks/xstream/converters/reflection/SortableFieldKeySorter.java
@@ -1,41 +1,41 @@
/*
- * Copyright (C) 2007, 2009, 2011 XStream Committers.
+ * Copyright (C) 2007, 2009, 2011, 2016 XStream Committers.
* All rights reserved.
*
* The software in this package is published under the terms of the BSD
* style license a copy of which has been included with this distribution in
* the LICENSE.txt file.
- *
+ *
* Created on 10. April 2007 by Guilherme Silveira
*/
package com.thoughtworks.xstream.converters.reflection;
-
-import com.thoughtworks.xstream.core.Caching;
-import com.thoughtworks.xstream.core.util.OrderRetainingMap;
-import com.thoughtworks.xstream.io.StreamException;
import java.util.Arrays;
import java.util.Comparator;
import java.util.HashMap;
import java.util.Map;
+import com.thoughtworks.xstream.converters.ConversionException;
+import com.thoughtworks.xstream.core.Caching;
+import com.thoughtworks.xstream.core.util.OrderRetainingMap;
+
/**
- * The default implementation for sorting fields. Invoke registerFieldOrder in order to set the
- * field order for an specific type.
- *
+ * The default implementation for sorting fields. Invoke registerFieldOrder in order to set the field order for an
+ * specific type.
+ *
* @author Guilherme Silveira
* @since 1.2.2
*/
public class SortableFieldKeySorter implements FieldKeySorter, Caching {
+ private final static FieldKey[] EMPTY_FIELD_KEY_ARRAY = {};
private final Map map = new HashMap();
- public Map sort(Class type, Map keyedByFieldKey) {
+ public Map sort(final Class type, final Map keyedByFieldKey) {
if (map.containsKey(type)) {
- Map result = new OrderRetainingMap();
- FieldKey[] fieldKeys = (FieldKey[])keyedByFieldKey.keySet().toArray(
- new FieldKey[keyedByFieldKey.size()]);
+ final Map result = new OrderRetainingMap();
+ final FieldKey[] fieldKeys = (FieldKey[])keyedByFieldKey.keySet().toArray(EMPTY_FIELD_KEY_ARRAY);
Arrays.sort(fieldKeys, (Comparator)map.get(type));
for (int i = 0; i < fieldKeys.length; i++ ) {
result.put(fieldKeys[i], keyedByFieldKey.get(fieldKeys[i]));
@@ -47,28 +47,30 @@
}
/**
- * Registers the field order to use for a specific type. This will not affect any of the
- * type's super or sub classes. If you skip a field which will be serialized, XStream will
- * thrown an StreamException during the serialization process.
- *
+ * Registers the field order to use for a specific type. This will not affect any of the type's super or sub
+ * classes. If you skip a field which will be serialized, XStream will thrown a {@link ConversionException} during
+ * the serialization process.
+ *
* @param type the type
* @param fields the field order
*/
- public void registerFieldOrder(Class type, String[] fields) {
- map.put(type, new FieldComparator(fields));
+ public void registerFieldOrder(final Class type, final String[] fields) {
+ map.put(type, new FieldComparator(type, fields));
}
private class FieldComparator implements Comparator {
private final String[] fieldOrder;
+ private final Class type;
- public FieldComparator(String[] fields) {
- this.fieldOrder = fields;
+ public FieldComparator(final Class type, final String[] fields) {
+ this.type = type;
+ fieldOrder = fields;
}
- public int compare(String first, String second) {
+ public int compare(final String first, final String second) {
int firstPosition = -1, secondPosition = -1;
- for (int i = 0; i < fieldOrder.length; i++ ) {
+ for (int i = 0; i < fieldOrder.length; i++) {
if (fieldOrder[i].equals(first)) {
firstPosition = i;
}
@@ -78,14 +80,16 @@
}
if (firstPosition == -1 || secondPosition == -1) {
// field not defined!!!
- throw new StreamException(
- "You have not given XStream a list of all fields to be serialized.");
+ final ConversionException exception = new ConversionException(
+ "Incomplete list of serialized fields for type");
+ exception.add("sort-type", type.getName());
+ throw exception;
}
return firstPosition - secondPosition;
}
- public int compare(Object firstObject, Object secondObject) {
- FieldKey first = (FieldKey)firstObject, second = (FieldKey)secondObject;
+ public int compare(final Object firstObject, final Object secondObject) {
+ final FieldKey first = (FieldKey)firstObject, second = (FieldKey)secondObject;
return compare(first.getFieldName(), second.getFieldName());
}
diff --git a/xstream/src/java/com/thoughtworks/xstream/converters/reflection/SunLimitedUnsafeReflectionProvider.java b/xstream/src/java/com/thoughtworks/xstream/converters/reflection/SunLimitedUnsafeReflectionProvider.java
index 4faef33..2c569ae 100644
--- a/xstream/src/java/com/thoughtworks/xstream/converters/reflection/SunLimitedUnsafeReflectionProvider.java
+++ b/xstream/src/java/com/thoughtworks/xstream/converters/reflection/SunLimitedUnsafeReflectionProvider.java
@@ -1,6 +1,6 @@
/*
* Copyright (C) 2004, 2005 Joe Walnes.
- * Copyright (C) 2006, 2007, 2008, 2011, 2013, 2014 XStream Committers.
+ * Copyright (C) 2006, 2007, 2008, 2011, 2013, 2014, 2016 XStream Committers.
* All rights reserved.
*
* Created on 08. January 2014 by Joerg Schaible, factored out from SunUnsafeReflectionProvider
@@ -8,6 +8,9 @@
package com.thoughtworks.xstream.converters.reflection;
import java.lang.reflect.Field;
+
+import com.thoughtworks.xstream.converters.ConversionException;
+import com.thoughtworks.xstream.converters.ErrorWritingException;
import sun.misc.Unsafe;
@@ -70,17 +73,22 @@
public Object newInstance(Class type) {
if (exception != null) {
- throw new ObjectAccessException("Cannot construct " + type.getName(), exception);
+ ObjectAccessException ex = new ObjectAccessException("Cannot construct type", exception);
+ ex.add("construction-type", type.getName());
+ throw ex;
}
+ ErrorWritingException ex = null;
try {
return unsafe.allocateInstance(type);
} catch (SecurityException e) {
- throw new ObjectAccessException("Cannot construct " + type.getName(), e);
+ ex = new ObjectAccessException("Cannot construct type", e);
} catch (InstantiationException e) {
- throw new ObjectAccessException("Cannot construct " + type.getName(), e);
+ ex = new ConversionException("Cannot construct type", e);
} catch (IllegalArgumentException e) {
- throw new ObjectAccessException("Cannot construct " + type.getName(), e);
+ ex = new ObjectAccessException("Cannot construct type", e);
}
+ ex.add("construction-type", type.getName());
+ throw ex;
}
protected void validateFieldAccess(Field field) {
diff --git a/xstream/src/java/com/thoughtworks/xstream/converters/reflection/SunUnsafeReflectionProvider.java b/xstream/src/java/com/thoughtworks/xstream/converters/reflection/SunUnsafeReflectionProvider.java
index c97c0c8..4c13023 100644
--- a/xstream/src/java/com/thoughtworks/xstream/converters/reflection/SunUnsafeReflectionProvider.java
+++ b/xstream/src/java/com/thoughtworks/xstream/converters/reflection/SunUnsafeReflectionProvider.java
@@ -1,6 +1,6 @@
/*
* Copyright (C) 2004, 2005 Joe Walnes.
- * Copyright (C) 2006, 2007, 2008, 2011, 2013, 2014 XStream Committers.
+ * Copyright (C) 2006, 2007, 2008, 2011, 2013, 2014, 2016 XStream Committers.
* All rights reserved.
*
* The software in this package is published under the terms of the BSD
@@ -58,8 +58,9 @@
private void write(Field field, Object object, Object value) {
if (exception != null) {
- throw new ObjectAccessException("Could not set field " + object.getClass() + "." + field.getName(),
- exception);
+ ObjectAccessException ex = new ObjectAccessException("Cannot set field", exception);
+ ex.add("field", object.getClass() + "." + field.getName());
+ throw ex;
}
try {
long offset = getFieldOffset(field);
@@ -82,19 +83,19 @@
} else if (type.equals(Boolean.TYPE)) {
unsafe.putBoolean(object, offset, ((Boolean)value).booleanValue());
} else {
- throw new ObjectAccessException("Could not set field "
- + object.getClass()
- + "."
- + field.getName()
- + ": Unknown type "
- + type);
+ ObjectAccessException ex = new ObjectAccessException("Cannot set field of unknown type", exception);
+ ex.add("field", object.getClass() + "." + field.getName());
+ ex.add("unknown-type", type.getName());
+ throw ex;
}
} else {
unsafe.putObject(object, offset, value);
}
} catch (IllegalArgumentException e) {
- throw new ObjectAccessException("Could not set field " + object.getClass() + "." + field.getName(), e);
+ ObjectAccessException ex = new ObjectAccessException("Cannot set field", e);
+ ex.add("field", object.getClass() + "." + field.getName());
+ throw ex;
}
}
diff --git a/xstream/src/java/com/thoughtworks/xstream/core/AbstractReferenceUnmarshaller.java b/xstream/src/java/com/thoughtworks/xstream/core/AbstractReferenceUnmarshaller.java
index d8218fd..791ca18 100644
--- a/xstream/src/java/com/thoughtworks/xstream/core/AbstractReferenceUnmarshaller.java
+++ b/xstream/src/java/com/thoughtworks/xstream/core/AbstractReferenceUnmarshaller.java
@@ -1,11 +1,11 @@
/*
- * Copyright (C) 2006, 2007, 2008, 2011 XStream Committers.
+ * Copyright (C) 2006, 2007, 2008, 2011, 2015 XStream Committers.
* All rights reserved.
*
* The software in this package is published under the terms of the BSD
* style license a copy of which has been included with this distribution in
* the LICENSE.txt file.
- *
+ *
* Created on 15. March 2007 by Joerg Schaible
*/
package com.thoughtworks.xstream.core;
@@ -22,7 +22,7 @@
/**
* Abstract base class for a TreeUnmarshaller, that resolves references.
- *
+ *
* @author Joe Walnes
* @author Jörg Schaible
* @author Mauro Talevi
@@ -49,16 +49,21 @@
}
}
final Object result;
- String attributeName = getMapper().aliasForSystemAttribute("reference");
- String reference = attributeName == null ? null : reader.getAttribute(attributeName);
+ final String attributeName = getMapper().aliasForSystemAttribute("reference");
+ final String reference = attributeName == null ? null : reader.getAttribute(attributeName);
+ final boolean isReferenceable = getMapper().isReferenceable(type);
if (reference != null) {
- Object cache = values.get(getReferenceKey(reference));
+ final Object cache = isReferenceable ? values.get(getReferenceKey(reference)) : null;
if (cache == null) {
final ConversionException ex = new ConversionException("Invalid reference");
ex.add("reference", reference);
+ ex.add("referenced-type", type.getName());
+ ex.add("referenceable", Boolean.toString(isReferenceable));
throw ex;
}
result = cache == NULL ? null : cache;
+ } else if (!isReferenceable) {
+ result = super.convert(parent, type, converter);
} else {
Object currentReferenceKey = getCurrentReferenceKey();
parentStack.push(currentReferenceKey);
diff --git a/xstream/src/java/com/thoughtworks/xstream/core/BaseException.java b/xstream/src/java/com/thoughtworks/xstream/core/BaseException.java
index a1bdb51..de33aa6 100644
--- a/xstream/src/java/com/thoughtworks/xstream/core/BaseException.java
+++ b/xstream/src/java/com/thoughtworks/xstream/core/BaseException.java
@@ -1,6 +1,6 @@
/*
* Copyright (C) 2004 Joe Walnes.
- * Copyright (C) 2006, 2007, 2008, 2009 XStream Committers.
+ * Copyright (C) 2006, 2007, 2008, 2009, 2016 XStream Committers.
* All rights reserved.
*
* The software in this package is published under the terms of the BSD
@@ -14,7 +14,6 @@
import com.thoughtworks.xstream.XStreamException;
/**
- * JDK1.3 friendly exception that retains cause.
* @deprecated As of 1.3, use {@link XStreamException} instead
*/
public abstract class BaseException extends RuntimeException {
@@ -23,5 +22,7 @@
super(message);
}
- public abstract Throwable getCause();
+ protected BaseException(String message, Throwable cause) {
+ super(message, cause);
+ }
}
diff --git a/xstream/src/java/com/thoughtworks/xstream/core/DefaultConverterLookup.java b/xstream/src/java/com/thoughtworks/xstream/core/DefaultConverterLookup.java
index b4b955f..c89055a 100644
--- a/xstream/src/java/com/thoughtworks/xstream/core/DefaultConverterLookup.java
+++ b/xstream/src/java/com/thoughtworks/xstream/core/DefaultConverterLookup.java
@@ -1,6 +1,6 @@
/*
* Copyright (C) 2004, 2005, 2006 Joe Walnes.
- * Copyright (C) 2006, 2007, 2008, 2009, 2011, 2013 XStream Committers.
+ * Copyright (C) 2006, 2007, 2008, 2009, 2011, 2013, 2016 XStream Committers.
* All rights reserved.
*
* The software in this package is published under the terms of the BSD
@@ -58,7 +58,9 @@
return converter;
}
}
- throw new ConversionException("No converter specified for " + type);
+ ConversionException exception = new ConversionException("No converter specified");
+ exception.add("type", type.getName());
+ throw exception;
}
public void registerConverter(Converter converter, int priority) {
diff --git a/xstream/src/java/com/thoughtworks/xstream/core/util/CustomObjectInputStream.java b/xstream/src/java/com/thoughtworks/xstream/core/util/CustomObjectInputStream.java
index 5b47e5e..9ef7479 100644
--- a/xstream/src/java/com/thoughtworks/xstream/core/util/CustomObjectInputStream.java
+++ b/xstream/src/java/com/thoughtworks/xstream/core/util/CustomObjectInputStream.java
@@ -1,6 +1,6 @@
/*
* Copyright (C) 2004, 2005 Joe Walnes.
- * Copyright (C) 2006, 2007, 2010, 2011, 2013 XStream Committers.
+ * Copyright (C) 2006, 2007, 2010, 2011, 2013, 2016 XStream Committers.
* All rights reserved.
*
* The software in this package is published under the terms of the BSD
@@ -20,9 +20,10 @@
import java.io.StreamCorruptedException;
import java.util.Map;
-import com.thoughtworks.xstream.converters.ConversionException;
import com.thoughtworks.xstream.converters.DataHolder;
+import com.thoughtworks.xstream.converters.reflection.ObjectAccessException;
import com.thoughtworks.xstream.core.ClassLoaderReference;
+import com.thoughtworks.xstream.io.StreamException;
public class CustomObjectInputStream extends ObjectInputStream {
@@ -63,8 +64,10 @@
result.pushCallback(callback);
}
return result;
+ } catch (SecurityException e) {
+ throw new ObjectAccessException("Cannot create CustomObjectStream", e);
} catch (IOException e) {
- throw new ConversionException("Cannot create CustomObjectStream", e);
+ throw new StreamException("Cannot create CustomObjectStream", e);
}
}
diff --git a/xstream/src/java/com/thoughtworks/xstream/core/util/CustomObjectOutputStream.java b/xstream/src/java/com/thoughtworks/xstream/core/util/CustomObjectOutputStream.java
index 09a2cdf..a354005 100644
--- a/xstream/src/java/com/thoughtworks/xstream/core/util/CustomObjectOutputStream.java
+++ b/xstream/src/java/com/thoughtworks/xstream/core/util/CustomObjectOutputStream.java
@@ -1,6 +1,6 @@
/*
* Copyright (C) 2004, 2005 Joe Walnes.
- * Copyright (C) 2006, 2007 XStream Committers.
+ * Copyright (C) 2006, 2007, 2016 XStream Committers.
* All rights reserved.
*
* The software in this package is published under the terms of the BSD
@@ -16,8 +16,9 @@
import java.io.ObjectOutputStream;
import java.util.Map;
-import com.thoughtworks.xstream.converters.ConversionException;
import com.thoughtworks.xstream.converters.DataHolder;
+import com.thoughtworks.xstream.converters.reflection.ObjectAccessException;
+import com.thoughtworks.xstream.io.StreamException;
public class CustomObjectOutputStream extends ObjectOutputStream {
@@ -36,8 +37,10 @@
result.pushCallback(callback);
}
return result;
+ } catch (SecurityException e) {
+ throw new ObjectAccessException("Cannot create CustomObjectStream", e);
} catch (IOException e) {
- throw new ConversionException("Cannot create CustomObjectStream", e);
+ throw new StreamException("Cannot create CustomObjectStream", e);
}
}
diff --git a/xstream/src/java/com/thoughtworks/xstream/core/util/DependencyInjectionFactory.java b/xstream/src/java/com/thoughtworks/xstream/core/util/DependencyInjectionFactory.java
index b7cb672..293d4b6 100644
--- a/xstream/src/java/com/thoughtworks/xstream/core/util/DependencyInjectionFactory.java
+++ b/xstream/src/java/com/thoughtworks/xstream/core/util/DependencyInjectionFactory.java
@@ -1,11 +1,11 @@
/*
- * Copyright (c) 2007, 2009, 2010, 2011, 2012, 2013 XStream Committers.
+ * Copyright (c) 2007, 2009, 2010, 2011, 2012, 2013, 2016 XStream Committers.
* All rights reserved.
*
* The software in this package is published under the terms of the BSD
* style license a copy of which has been included with this distribution in
* the LICENSE.txt file.
- *
+ *
* Created on 30. March 2007 by Joerg Schaible
*/
package com.thoughtworks.xstream.core.util;
@@ -23,7 +23,7 @@
/**
* A dependency injection factory.
- *
+ *
* @author Jörg Schaible
* @since 1.2.2
*/
@@ -35,7 +35,7 @@
* matching the sequence of the dependencies' types match first. Otherwise all the types of the dependencies must
* match one of the the parameters although no dependency is used twice. Use a {@link TypedNull} instance to inject
* null as parameter.
- *
+ *
* @param type the type to create an instance of
* @param dependencies the possible dependencies
* @return the instantiated object
@@ -46,14 +46,14 @@
public static Object newInstance(final Class type, final Object[] dependencies) {
return newInstance(type, dependencies, null);
}
-
+
/**
* Create an instance with dependency injection. The given dependencies are used to match the parameters of the
* constructors of the type. Constructors with most parameters are examined first. A parameter type sequence
* matching the sequence of the dependencies' types match first. Otherwise all the types of the dependencies must
* match one of the the parameters although no dependency is used twice. Use a {@link TypedNull} instance to inject
* null as parameter.
- *
+ *
* @param type the type to create an instance of
* @param dependencies the possible dependencies
* @param usedDependencies bit mask set by the method for all used dependencies (may be null)
@@ -85,7 +85,7 @@
}
final TypedValue[] typedDependencies = new TypedValue[dependencies.length];
- for (int i = 0; i < dependencies.length; i++ ) {
+ for (int i = 0; i < dependencies.length; i++) {
Object dependency = dependencies[i];
Class depType = dependency.getClass();
if (depType.isPrimitive()) {
@@ -100,7 +100,7 @@
Constructor possibleCtor = null;
int arity = Integer.MAX_VALUE;
- for (int i = 0; bestMatchingCtor == null && i < ctors.length; i++ ) {
+ for (int i = 0; bestMatchingCtor == null && i < ctors.length; i++) {
final Constructor constructor = ctors[i];
final Class[] parameterTypes = constructor.getParameterTypes();
if (parameterTypes.length > dependencies.length) {
@@ -118,7 +118,7 @@
arity = parameterTypes.length;
}
- for (int j = 0; j < parameterTypes.length; j++ ) {
+ for (int j = 0; j < parameterTypes.length; j++) {
if (parameterTypes[j].isPrimitive()) {
parameterTypes[j] = Primitives.box(parameterTypes[j]);
}
@@ -129,11 +129,11 @@
matchingDependencies.clear();
usedDeps = 0;
for (int j = 0, k = 0; j < parameterTypes.length
- && parameterTypes.length + k - j <= typedDependencies.length; k++ ) {
+ && parameterTypes.length + k - j <= typedDependencies.length; k++) {
if (parameterTypes[j].isAssignableFrom(typedDependencies[k].type)) {
matchingDependencies.add(typedDependencies[k].value);
- usedDeps |= 1L << k;
- if ( ++j == parameterTypes.length) {
+ usedDeps |= 1L << k;
+ if (++j == parameterTypes.length) {
bestMatchingCtor = constructor;
break;
}
@@ -151,7 +151,7 @@
usedDeps = 0;
for (int j = 0; j < parameterTypes.length; j++ ) {
int assignable = -1;
- for (int k = 0; k < deps.length; k++ ) {
+ for (int k = 0; k < deps.length; k++) {
if (deps[k] == null) {
continue;
}
@@ -162,8 +162,8 @@
} else if (parameterTypes[j].isAssignableFrom(deps[k].type)) {
// use most specific type
if (assignable < 0
- || (deps[assignable].type != deps[k].type && deps[assignable].type
- .isAssignableFrom(deps[k].type))) {
+ || deps[assignable].type != deps[k].type
+ && deps[assignable].type.isAssignableFrom(deps[k].type)) {
assignable = k;
}
}
@@ -178,7 +178,7 @@
break;
}
}
-
+
if (possible) {
// the smaller the value, the smaller the indices in the deps array
if (possibleCtor != null && usedDeps >= possibleUsedDeps) {
@@ -194,9 +194,10 @@
if (bestMatchingCtor == null) {
if (possibleCtor == null) {
usedDeps = 0;
- throw new ObjectAccessException("Cannot construct "
- + type.getName()
- + ", none of the dependencies match any constructor's parameters");
+ final ObjectAccessException ex = new ObjectAccessException(
+ "Cannot construct type, none of the arguments match any constructor's parameters");
+ ex.add("construction-type", type.getName());
+ throw ex;
} else {
bestMatchingCtor = possibleCtor;
matchingDependencies.clear();
@@ -206,6 +207,7 @@
}
}
+ Throwable th = null;
try {
final Object instance;
if (bestMatchingCtor == null) {
@@ -216,7 +218,7 @@
if (usedDependencies != null) {
usedDependencies.clear();
int i = 0;
- for(long l = 1; l < usedDeps; l <<= 1, ++i) {
+ for (long l = 1; l < usedDeps; l <<= 1, ++i) {
if ((usedDeps & l) > 0) {
usedDependencies.set(i);
}
@@ -224,16 +226,19 @@
}
return instance;
} catch (final InstantiationException e) {
- throw new ObjectAccessException("Cannot construct " + type.getName(), e);
+ th = e;
} catch (final IllegalAccessException e) {
- throw new ObjectAccessException("Cannot construct " + type.getName(), e);
+ th = e;
} catch (final InvocationTargetException e) {
- throw new ObjectAccessException("Cannot construct " + type.getName(), e);
+ th = e.getCause();
} catch (final SecurityException e) {
- throw new ObjectAccessException("Cannot construct " + type.getName(), e);
+ th = e;
} catch (final ExceptionInInitializerError e) {
- throw new ObjectAccessException("Cannot construct " + type.getName(), e);
- }
+ th = e;
+ }
+ final ObjectAccessException ex = new ObjectAccessException("Cannot construct type", th);
+ ex.add("construction-type", type.getName());
+ throw ex;
}
private static class TypedValue {
@@ -246,8 +251,7 @@
this.value = value;
}
- public String toString()
- {
+ public String toString() {
return type.getName() + ":" + value;
}
}
diff --git a/xstream/src/java/com/thoughtworks/xstream/core/util/Fields.java b/xstream/src/java/com/thoughtworks/xstream/core/util/Fields.java
index 368353a..32d179c 100644
--- a/xstream/src/java/com/thoughtworks/xstream/core/util/Fields.java
+++ b/xstream/src/java/com/thoughtworks/xstream/core/util/Fields.java
@@ -1,12 +1,12 @@
/*
* Copyright (C) 2004 Joe Walnes.
- * Copyright (C) 2006, 2007, 2008, 2009, 2011, 2013 XStream Committers.
+ * Copyright (C) 2006, 2007, 2008, 2009, 2011, 2013, 2016 XStream Committers.
* All rights reserved.
*
* The software in this package is published under the terms of the BSD
* style license a copy of which has been included with this distribution in
* the LICENSE.txt file.
- *
+ *
* Created on 06. April 2004 by Joe Walnes
*/
package com.thoughtworks.xstream.core.util;
@@ -16,18 +16,19 @@
import com.thoughtworks.xstream.converters.reflection.ObjectAccessException;
+
/**
- * Slightly nicer way to find, get and set fields in classes. Wraps standard java.lang.reflect.Field calls but wraps
- * wraps exception in XStreamExceptions.
+ * Slightly nicer way to find, get and set fields in classes. Wraps standard java.lang.reflect.Field calls and turns
+ * exceptions into XStreamExceptions.
*
* @author Joe Walnes
* @author Jörg Schaible
*/
public class Fields {
- public static Field locate(Class definedIn, Class fieldType, boolean isStatic) {
+ public static Field locate(final Class definedIn, final Class fieldType, final boolean isStatic) {
Field field = null;
try {
- Field[] fields = definedIn.getDeclaredFields();
+ final Field[] fields = definedIn.getDeclaredFields();
for(int i = 0; i < fields.length; ++i) {
if (Modifier.isStatic(fields[i].getModifiers()) == isStatic) {
if (fieldType.isAssignableFrom(fields[i].getType())) {
@@ -38,45 +39,62 @@
if (field != null && !field.isAccessible()) {
field.setAccessible(true);
}
- } catch (SecurityException e) {
+ } catch (final SecurityException e) {
// active SecurityManager
- } catch (NoClassDefFoundError e) {
+ } catch (final NoClassDefFoundError e) {
// restricted type in GAE
}
return field;
}
- public static Field find(Class type, String name) {
+ public static Field find(final Class type, final String name) {
try {
- Field result = type.getDeclaredField(name);
+ final Field result = type.getDeclaredField(name);
if (!result.isAccessible()) {
result.setAccessible(true);
}
return result;
- } catch (NoSuchFieldException e) {
- throw new IllegalArgumentException("Could not access " + type.getName() + "." + name + " field: " + e.getMessage());
- } catch (NoClassDefFoundError e) {
- throw new ObjectAccessException("Could not access " + type.getName() + "." + name + " field: " + e.getMessage());
+ } catch (final SecurityException e) {
+ throw wrap("Cannot access field", type, name, e);
+ } catch (final NoSuchFieldException e) {
+ throw wrap("Cannot access field", type, name, e);
+ } catch (final NoClassDefFoundError e) {
+ throw wrap("Cannot access field", type, name, e);
}
}
- public static void write(Field field, Object instance, Object value) {
+ public static void write(final Field field, final Object instance, final Object value) {
try {
field.set(instance, value);
- } catch (IllegalAccessException e) {
- throw new ObjectAccessException("Could not write " + field.getType().getName() + "." + field.getName() + " field", e);
- } catch (NoClassDefFoundError e) {
- throw new ObjectAccessException("Could not write " + field.getType().getName() + "." + field.getName() + " field", e);
+ } catch (final SecurityException e) {
+ throw wrap("Cannot write field", field.getType(), field.getName(), e);
+ } catch (final IllegalArgumentException e) {
+ throw wrap("Cannot write field", field.getType(), field.getName(), e);
+ } catch (final IllegalAccessException e) {
+ throw wrap("Cannot write field", field.getType(), field.getName(), e);
+ } catch (final NoClassDefFoundError e) {
+ throw wrap("Cannot write field", field.getType(), field.getName(), e);
}
}
- public static Object read(Field field, Object instance) {
+ public static Object read(final Field field, final Object instance) {
try {
return field.get(instance);
- } catch (IllegalAccessException e) {
- throw new ObjectAccessException("Could not read " + field.getType().getName() + "." + field.getName() + " field", e);
- } catch (NoClassDefFoundError e) {
- throw new ObjectAccessException("Could not read " + field.getType().getName() + "." + field.getName() + " field", e);
+ } catch (final SecurityException e) {
+ throw wrap("Cannot read field", field.getType(), field.getName(), e);
+ } catch (final IllegalArgumentException e) {
+ throw wrap("Cannot read field", field.getType(), field.getName(), e);
+ } catch (final IllegalAccessException e) {
+ throw wrap("Cannot read field", field.getType(), field.getName(), e);
+ } catch (final NoClassDefFoundError e) {
+ throw wrap("Cannot read field", field.getType(), field.getName(), e);
}
}
+
+ private static ObjectAccessException wrap(final String message, final Class type, final String name,
+ final Throwable ex) {
+ final ObjectAccessException exception = new ObjectAccessException(message, ex);
+ exception.add("field", type.getName() + "." + name);
+ return exception;
+ }
}
diff --git a/xstream/src/java/com/thoughtworks/xstream/core/util/SerializationMembers.java b/xstream/src/java/com/thoughtworks/xstream/core/util/SerializationMembers.java
index 505df5d..b8fc632 100644
--- a/xstream/src/java/com/thoughtworks/xstream/core/util/SerializationMembers.java
+++ b/xstream/src/java/com/thoughtworks/xstream/core/util/SerializationMembers.java
@@ -1,6 +1,6 @@
/*
* Copyright (C) 2004, 2005 Joe Walnes.
- * Copyright (C) 2006, 2007, 2008, 2010, 2011, 2014, 2015 XStream Committers.
+ * Copyright (C) 2006, 2007, 2008, 2010, 2011, 2014, 2015, 2016 XStream Committers.
* All rights reserved.
*
* The software in this package is published under the terms of the BSD
@@ -24,6 +24,7 @@
import java.util.Map;
import com.thoughtworks.xstream.converters.ConversionException;
+import com.thoughtworks.xstream.converters.ErrorWritingException;
import com.thoughtworks.xstream.converters.reflection.ObjectAccessException;
import com.thoughtworks.xstream.core.Caching;
@@ -72,17 +73,16 @@
final Class resultType = result.getClass();
final Method readResolveMethod = getRRMethod(resultType, "readResolve");
if (readResolveMethod != null) {
+ ErrorWritingException ex = null;
try {
return readResolveMethod.invoke(result, EMPTY_ARGS);
} catch (IllegalAccessException e) {
- throw new ObjectAccessException("Could not call "
- + resultType.getName()
- + ".readResolve()", e);
+ ex = new ObjectAccessException("Cannot access method", e);
} catch (InvocationTargetException e) {
- throw new ObjectAccessException("Could not call "
- + resultType.getName()
- + ".readResolve()", e.getTargetException());
- }
+ ex = new ConversionException("Failed calling method", e.getTargetException());
+ }
+ ex.add("method", resultType.getName() + ".readResolve()");
+ throw ex;
} else {
return result;
}
@@ -96,17 +96,16 @@
final Class objectType = object.getClass();
final Method writeReplaceMethod = getRRMethod(objectType, "writeReplace");
if (writeReplaceMethod != null) {
+ ErrorWritingException ex = null;
try {
return writeReplaceMethod.invoke(object, EMPTY_ARGS);
} catch (IllegalAccessException e) {
- throw new ObjectAccessException("Could not call "
- + objectType.getName()
- + ".writeReplace()", e);
+ ex = new ObjectAccessException("Cannot access method", e);
} catch (InvocationTargetException e) {
- throw new ObjectAccessException("Could not call "
- + objectType.getName()
- + ".writeReplace()", e.getTargetException());
- }
+ ex = new ConversionException("Failed calling method", e.getTargetException());
+ }
+ ex.add("method", objectType.getName() + ".writeReplace()");
+ throw ex;
} else {
return object;
}
@@ -119,18 +118,19 @@
}
public void callReadObject(final Class type, final Object object, final ObjectInputStream stream) {
+ ErrorWritingException ex = null;
try {
Method readObjectMethod = getMethod(
type, "readObject", new Class[]{ObjectInputStream.class}, false);
readObjectMethod.invoke(object, new Object[]{stream});
} catch (IllegalAccessException e) {
- throw new ConversionException("Could not call "
- + object.getClass().getName()
- + ".readObject()", e);
+ ex = new ObjectAccessException("Cannot access method", e);
} catch (InvocationTargetException e) {
- throw new ConversionException("Could not call "
- + object.getClass().getName()
- + ".readObject()", e.getTargetException());
+ ex = new ConversionException("Failed calling method", e.getTargetException());
+ }
+ if (ex != null) {
+ ex.add("method", object.getClass().getName() + ".readObject()");
+ throw ex;
}
}
@@ -140,18 +140,19 @@
}
public void callWriteObject(final Class type, final Object instance, final ObjectOutputStream stream) {
+ ErrorWritingException ex = null;
try {
Method readObjectMethod = getMethod(
type, "writeObject", new Class[]{ObjectOutputStream.class}, false);
readObjectMethod.invoke(instance, new Object[]{stream});
} catch (IllegalAccessException e) {
- throw new ConversionException("Could not call "
- + instance.getClass().getName()
- + ".writeObject()", e);
+ ex = new ObjectAccessException("Cannot access method", e);
} catch (InvocationTargetException e) {
- throw new ConversionException("Could not call "
- + instance.getClass().getName()
- + ".writeObject()", e.getTargetException());
+ ex = new ConversionException("Failed calling method", e.getTargetException());
+ }
+ if (ex != null) {
+ ex.add("method", instance.getClass().getName() + ".writeObject()");
+ throw ex;
}
}
@@ -210,6 +211,7 @@
}
Map result = (Map)fieldCache.get(type.getName());
if (result == null) {
+ ErrorWritingException ex = null;
try {
final Field field = type.getDeclaredField("serialPersistentFields");
if ((field.getModifiers() & PERSISTENT_FIELDS_MODIFIER) == PERSISTENT_FIELDS_MODIFIER) {
@@ -224,9 +226,13 @@
}
} catch (final NoSuchFieldException e) {
} catch (final IllegalAccessException e) {
- throw new ObjectAccessException("Cannot get " + type.getName() + ".serialPersistentFields.", e);
+ ex = new ObjectAccessException("Cannot get field", e);
} catch (final ClassCastException e) {
- throw new ObjectAccessException("Cannot get " + type.getName() + ".serialPersistentFields.", e);
+ ex = new ConversionException("Incompatible field type", e);
+ }
+ if (ex != null) {
+ ex.add("field", type.getName() + ".serialPersistentFields");
+ throw ex;
}
if (result == null) {
result = NO_FIELDS;
diff --git a/xstream/src/java/com/thoughtworks/xstream/core/util/ThreadSafePropertyEditor.java b/xstream/src/java/com/thoughtworks/xstream/core/util/ThreadSafePropertyEditor.java
index 34c9953..af811ef 100644
--- a/xstream/src/java/com/thoughtworks/xstream/core/util/ThreadSafePropertyEditor.java
+++ b/xstream/src/java/com/thoughtworks/xstream/core/util/ThreadSafePropertyEditor.java
@@ -1,5 +1,5 @@
/*
- * Copyright (c) 2007, 2008 XStream Committers.
+ * Copyright (c) 2007, 2008, 2016 XStream Committers.
* All rights reserved.
*
* The software in this package is published under the terms of the BSD
@@ -10,6 +10,8 @@
*/
package com.thoughtworks.xstream.core.util;
+import com.thoughtworks.xstream.converters.ConversionException;
+import com.thoughtworks.xstream.converters.ErrorWritingException;
import com.thoughtworks.xstream.converters.reflection.ObjectAccessException;
import java.beans.PropertyEditor;
@@ -44,15 +46,16 @@
editorType = type;
pool = new Pool(initialPoolSize, maxPoolSize, new Pool.Factory() {
public Object newInstance() {
+ ErrorWritingException ex = null;
try {
return editorType.newInstance();
} catch (InstantiationException e) {
- throw new ObjectAccessException("Could not call default constructor of "
- + editorType.getName(), e);
+ ex = new ConversionException("Faild to call default constructor", e);
} catch (IllegalAccessException e) {
- throw new ObjectAccessException("Could not call default constructor of "
- + editorType.getName(), e);
+ ex = new ObjectAccessException("Cannot call default constructor", e);
}
+ ex.add("construction-type", editorType.getName());
+ throw ex;
}
});
diff --git a/xstream/src/java/com/thoughtworks/xstream/io/xml/AbstractXppDriver.java b/xstream/src/java/com/thoughtworks/xstream/io/xml/AbstractXppDriver.java
index efcd59a..37d2a1f 100644
--- a/xstream/src/java/com/thoughtworks/xstream/io/xml/AbstractXppDriver.java
+++ b/xstream/src/java/com/thoughtworks/xstream/io/xml/AbstractXppDriver.java
@@ -1,5 +1,5 @@
/*
- * Copyright (C) 2009, 2011 XStream Committers.
+ * Copyright (C) 2009, 2011, 2015 XStream Committers.
* All rights reserved.
*
* The software in this package is published under the terms of the BSD
@@ -52,8 +52,8 @@
public HierarchicalStreamReader createReader(Reader in) {
try {
return new XppReader(in, createParser(), getNameCoder());
- } catch (XmlPullParserException e) {
- throw new StreamException("Cannot create XmlPullParser");
+ } catch (final XmlPullParserException e) {
+ throw new StreamException("Cannot create XmlPullParser", e);
}
}
diff --git a/xstream/src/java/com/thoughtworks/xstream/io/xml/BEAStaxDriver.java b/xstream/src/java/com/thoughtworks/xstream/io/xml/BEAStaxDriver.java
index 3c67699..01efa8f 100644
--- a/xstream/src/java/com/thoughtworks/xstream/io/xml/BEAStaxDriver.java
+++ b/xstream/src/java/com/thoughtworks/xstream/io/xml/BEAStaxDriver.java
@@ -1,11 +1,11 @@
/*
- * Copyright (C) 2009, 2011 XStream Committers.
+ * Copyright (C) 2009, 2011, 2014, 2015 XStream Committers.
* All rights reserved.
*
* The software in this package is published under the terms of the BSD
* style license a copy of which has been included with this distribution in
* the LICENSE.txt file.
- *
+ *
* Created on 29. April 2009 by Joerg Schaible
*/
package com.thoughtworks.xstream.io.xml;
@@ -19,7 +19,7 @@
/**
* A driver using the BEA StAX implementation.
- *
+ *
* @author Jörg Schaible
* @since 1.4
*/
@@ -62,7 +62,11 @@
}
protected XMLInputFactory createInputFactory() {
- return new MXParserFactory();
+ final XMLInputFactory instance = new MXParserFactory();
+ instance.setProperty(XMLInputFactory.IS_SUPPORTING_EXTERNAL_ENTITIES, Boolean.FALSE);
+// if (instance.isPropertySupported(XMLInputFactory.IS_SUPPORTING_EXTERNAL_ENTITIES))
+// throw new IllegalStateException("Should not support external entities now!");
+ return instance;
}
protected XMLOutputFactory createOutputFactory() {
diff --git a/xstream/src/java/com/thoughtworks/xstream/io/xml/Dom4JDriver.java b/xstream/src/java/com/thoughtworks/xstream/io/xml/Dom4JDriver.java
index bce7cff..7018f42 100644
--- a/xstream/src/java/com/thoughtworks/xstream/io/xml/Dom4JDriver.java
+++ b/xstream/src/java/com/thoughtworks/xstream/io/xml/Dom4JDriver.java
@@ -1,6 +1,6 @@
/*
* Copyright (C) 2004, 2005, 2006 Joe Walnes.
- * Copyright (C) 2006, 2007, 2009, 2011 XStream Committers.
+ * Copyright (C) 2006, 2007, 2009, 2011, 2014, 2015 XStream Committers.
* All rights reserved.
*
* The software in this package is published under the terms of the BSD
@@ -26,6 +26,7 @@
import org.dom4j.io.OutputFormat;
import org.dom4j.io.SAXReader;
import org.dom4j.io.XMLWriter;
+import org.xml.sax.SAXException;
import com.thoughtworks.xstream.io.HierarchicalStreamReader;
import com.thoughtworks.xstream.io.HierarchicalStreamWriter;
@@ -89,8 +90,7 @@
public HierarchicalStreamReader createReader(Reader text) {
try {
- SAXReader reader = new SAXReader();
- Document document = reader.read(text);
+ final Document document = createReader().read(text);
return new Dom4JReader(document, getNameCoder());
} catch (DocumentException e) {
throw new StreamException(e);
@@ -99,8 +99,7 @@
public HierarchicalStreamReader createReader(InputStream in) {
try {
- SAXReader reader = new SAXReader();
- Document document = reader.read(in);
+ final Document document = createReader().read(in);
return new Dom4JReader(document, getNameCoder());
} catch (DocumentException e) {
throw new StreamException(e);
@@ -112,8 +111,7 @@
*/
public HierarchicalStreamReader createReader(URL in) {
try {
- SAXReader reader = new SAXReader();
- Document document = reader.read(in);
+ final Document document = createReader().read(in);
return new Dom4JReader(document, getNameCoder());
} catch (DocumentException e) {
throw new StreamException(e);
@@ -125,8 +123,7 @@
*/
public HierarchicalStreamReader createReader(File in) {
try {
- SAXReader reader = new SAXReader();
- Document document = reader.read(in);
+ final Document document = createReader().read(in);
return new Dom4JReader(document, getNameCoder());
} catch (DocumentException e) {
throw new StreamException(e);
@@ -148,4 +145,21 @@
final Writer writer = new OutputStreamWriter(out);
return createWriter(writer);
}
+
+ /**
+ * Create and initialize the SAX reader.
+ *
+ * @return the SAX reader instance.
+ * @throws DocumentException if DOCTYPE processing cannot be disabled
+ * @since 1.4.9
+ */
+ protected SAXReader createReader() throws DocumentException {
+ final SAXReader reader = new SAXReader();
+ try {
+ reader.setFeature("http://apache.org/xml/features/disallow-doctype-decl", true);
+ } catch (SAXException e) {
+ throw new DocumentException("Cannot disable DOCTYPE processing", e);
+ }
+ return reader;
+ }
}
diff --git a/xstream/src/java/com/thoughtworks/xstream/io/xml/DomDriver.java b/xstream/src/java/com/thoughtworks/xstream/io/xml/DomDriver.java
index 7b1709e..ae50fbe 100644
--- a/xstream/src/java/com/thoughtworks/xstream/io/xml/DomDriver.java
+++ b/xstream/src/java/com/thoughtworks/xstream/io/xml/DomDriver.java
@@ -1,12 +1,12 @@
/*
* Copyright (C) 2004, 2005, 2006 Joe Walnes.
- * Copyright (C) 2006, 2007, 2008, 2009, 2011 XStream Committers.
+ * Copyright (C) 2006, 2007, 2008, 2009, 2011, 2014, 2015 XStream Committers.
* All rights reserved.
*
* The software in this package is published under the terms of the BSD
* style license a copy of which has been included with this distribution in
* the LICENSE.txt file.
- *
+ *
* Created on 07. March 2004 by Joe Walnes
*/
package com.thoughtworks.xstream.io.xml;
@@ -19,6 +19,8 @@
import java.io.Reader;
import java.io.UnsupportedEncodingException;
import java.io.Writer;
+import java.lang.reflect.InvocationTargetException;
+import java.lang.reflect.Method;
import java.net.URL;
import javax.xml.parsers.DocumentBuilder;
@@ -30,6 +32,8 @@
import org.xml.sax.InputSource;
import org.xml.sax.SAXException;
+import com.thoughtworks.xstream.converters.reflection.ObjectAccessException;
+import com.thoughtworks.xstream.core.JVM;
import com.thoughtworks.xstream.io.HierarchicalStreamReader;
import com.thoughtworks.xstream.io.HierarchicalStreamWriter;
import com.thoughtworks.xstream.io.StreamException;
@@ -39,7 +43,7 @@
public class DomDriver extends AbstractXmlDriver {
private final String encoding;
- private final DocumentBuilderFactory documentBuilderFactory;
+ private DocumentBuilderFactory documentBuilderFactory;
/**
* Construct a DomDriver.
@@ -61,7 +65,6 @@
*/
public DomDriver(String encoding, NameCoder nameCoder) {
super(nameCoder);
- documentBuilderFactory = DocumentBuilderFactory.newInstance();
this.encoding = encoding;
}
@@ -91,7 +94,14 @@
private HierarchicalStreamReader createReader(InputSource source) {
try {
- DocumentBuilder documentBuilder = documentBuilderFactory.newDocumentBuilder();
+ if (documentBuilderFactory == null) {
+ synchronized (this) {
+ if (documentBuilderFactory == null) {
+ documentBuilderFactory = createDocumentBuilderFactory();
+ }
+ }
+ }
+ final DocumentBuilder documentBuilder = documentBuilderFactory.newDocumentBuilder();
if (encoding != null) {
source.setEncoding(encoding);
}
@@ -121,4 +131,34 @@
throw new StreamException(e);
}
}
+
+ /**
+ * Create the DocumentBuilderFactory instance.
+ *
+ * @return the new instance
+ * @since 1.4.9
+ */
+ protected DocumentBuilderFactory createDocumentBuilderFactory() {
+ final DocumentBuilderFactory factory = DocumentBuilderFactory.newInstance();
+ if (JVM.is15()) {
+ try {
+ Method method = DocumentBuilderFactory.class.getMethod("setFeature",
+ new Class[]{ String.class, boolean.class });
+ method.invoke(factory, new Object[]{ "http://apache.org/xml/features/disallow-doctype-decl", Boolean.TRUE });
+ } catch (NoSuchMethodException e) {
+ // Ignore
+ } catch (IllegalAccessException e) {
+ throw new ObjectAccessException("Cannot set feature of DocumentBuilderFactory.", e);
+ } catch (InvocationTargetException e) {
+ Throwable cause = e.getCause();
+ if (JVM.is16()
+ || (cause instanceof ParserConfigurationException
+ && cause.getMessage().indexOf("disallow-doctype-decl") < 0)) {
+ throw new StreamException(cause);
+ }
+ }
+ }
+ factory.setExpandEntityReferences(false);
+ return factory;
+ }
}
diff --git a/xstream/src/java/com/thoughtworks/xstream/io/xml/JDom2Driver.java b/xstream/src/java/com/thoughtworks/xstream/io/xml/JDom2Driver.java
index 876630e..86f4170 100644
--- a/xstream/src/java/com/thoughtworks/xstream/io/xml/JDom2Driver.java
+++ b/xstream/src/java/com/thoughtworks/xstream/io/xml/JDom2Driver.java
@@ -1,5 +1,5 @@
/*
- * Copyright (C) 2013 XStream Committers.
+ * Copyright (C) 2013, 2015 XStream Committers.
* All rights reserved.
*
* The software in this package is published under the terms of the BSD
@@ -47,8 +47,8 @@
public HierarchicalStreamReader createReader(Reader reader) {
try {
- SAXBuilder builder = new SAXBuilder();
- Document document = builder.build(reader);
+ final SAXBuilder builder = createBuilder();
+ final Document document = builder.build(reader);
return new JDom2Reader(document, getNameCoder());
} catch (IOException e) {
throw new StreamException(e);
@@ -59,8 +59,8 @@
public HierarchicalStreamReader createReader(InputStream in) {
try {
- SAXBuilder builder = new SAXBuilder();
- Document document = builder.build(in);
+ final SAXBuilder builder = createBuilder();
+ final Document document = builder.build(in);
return new JDom2Reader(document, getNameCoder());
} catch (IOException e) {
throw new StreamException(e);
@@ -71,8 +71,8 @@
public HierarchicalStreamReader createReader(URL in) {
try {
- SAXBuilder builder = new SAXBuilder();
- Document document = builder.build(in);
+ final SAXBuilder builder = createBuilder();
+ final Document document = builder.build(in);
return new JDom2Reader(document, getNameCoder());
} catch (IOException e) {
throw new StreamException(e);
@@ -83,8 +83,8 @@
public HierarchicalStreamReader createReader(File in) {
try {
- SAXBuilder builder = new SAXBuilder();
- Document document = builder.build(in);
+ final SAXBuilder builder = createBuilder();
+ final Document document = builder.build(in);
return new JDom2Reader(document, getNameCoder());
} catch (IOException e) {
throw new StreamException(e);
@@ -100,5 +100,17 @@
public HierarchicalStreamWriter createWriter(OutputStream out) {
return new PrettyPrintWriter(new OutputStreamWriter(out));
}
+
+ /**
+ * Create and initialize the SAX builder.
+ *
+ * @return the SAX builder instance.
+ * @since 1.4.9
+ */
+ protected SAXBuilder createBuilder() {
+ final SAXBuilder builder = new SAXBuilder();
+ builder.setFeature("http://apache.org/xml/features/disallow-doctype-decl", true);
+ return builder;
+ }
}
diff --git a/xstream/src/java/com/thoughtworks/xstream/io/xml/JDomDriver.java b/xstream/src/java/com/thoughtworks/xstream/io/xml/JDomDriver.java
index 6bc3255..22a496b 100644
--- a/xstream/src/java/com/thoughtworks/xstream/io/xml/JDomDriver.java
+++ b/xstream/src/java/com/thoughtworks/xstream/io/xml/JDomDriver.java
@@ -1,6 +1,6 @@
/*
* Copyright (C) 2004, 2005, 2006 Joe Walnes.
- * Copyright (C) 2006, 2007, 2009, 2011 XStream Committers.
+ * Copyright (C) 2006, 2007, 2009, 2011, 2015 XStream Committers.
* All rights reserved.
*
* The software in this package is published under the terms of the BSD
@@ -55,8 +55,8 @@
public HierarchicalStreamReader createReader(Reader reader) {
try {
- SAXBuilder builder = new SAXBuilder();
- Document document = builder.build(reader);
+ final SAXBuilder builder = createBuilder();
+ final Document document = builder.build(reader);
return new JDomReader(document, getNameCoder());
} catch (IOException e) {
throw new StreamException(e);
@@ -67,8 +67,8 @@
public HierarchicalStreamReader createReader(InputStream in) {
try {
- SAXBuilder builder = new SAXBuilder();
- Document document = builder.build(in);
+ final SAXBuilder builder = createBuilder();
+ final Document document = builder.build(in);
return new JDomReader(document, getNameCoder());
} catch (IOException e) {
throw new StreamException(e);
@@ -79,8 +79,8 @@
public HierarchicalStreamReader createReader(URL in) {
try {
- SAXBuilder builder = new SAXBuilder();
- Document document = builder.build(in);
+ final SAXBuilder builder = createBuilder();
+ final Document document = builder.build(in);
return new JDomReader(document, getNameCoder());
} catch (IOException e) {
throw new StreamException(e);
@@ -91,8 +91,8 @@
public HierarchicalStreamReader createReader(File in) {
try {
- SAXBuilder builder = new SAXBuilder();
- Document document = builder.build(in);
+ final SAXBuilder builder = createBuilder();
+ final Document document = builder.build(in);
return new JDomReader(document, getNameCoder());
} catch (IOException e) {
throw new StreamException(e);
@@ -109,5 +109,17 @@
return new PrettyPrintWriter(new OutputStreamWriter(out));
}
+ /**
+ * Create and initialize the SAX builder.
+ *
+ * @return the SAX builder instance.
+ * @since 1.4.9
+ */
+ protected SAXBuilder createBuilder() {
+ final SAXBuilder builder = new SAXBuilder();
+ builder.setFeature("http://apache.org/xml/features/disallow-doctype-decl", true);
+ return builder;
+ }
+
}
diff --git a/xstream/src/java/com/thoughtworks/xstream/io/xml/QNameMap.java b/xstream/src/java/com/thoughtworks/xstream/io/xml/QNameMap.java
index e047b13..06e7e96 100644
--- a/xstream/src/java/com/thoughtworks/xstream/io/xml/QNameMap.java
+++ b/xstream/src/java/com/thoughtworks/xstream/io/xml/QNameMap.java
@@ -22,7 +22,7 @@
* allowing class aliases and namespace aware mappings of QNames to class names.
*
* @author James Strachan
- * @version $Revision: 1345 $
+ * @version $Revision$
*/
public class QNameMap {
diff --git a/xstream/src/java/com/thoughtworks/xstream/io/xml/SjsxpDriver.java b/xstream/src/java/com/thoughtworks/xstream/io/xml/SjsxpDriver.java
index 26d8009..a8d4d77 100644
--- a/xstream/src/java/com/thoughtworks/xstream/io/xml/SjsxpDriver.java
+++ b/xstream/src/java/com/thoughtworks/xstream/io/xml/SjsxpDriver.java
@@ -1,5 +1,5 @@
/*
- * Copyright (C) 2009, 2011, 2013 XStream Committers.
+ * Copyright (C) 2009, 2011, 2013, 2014, 2015 XStream Committers.
* All rights reserved.
*
* The software in this package is published under the terms of the BSD
@@ -58,8 +58,10 @@
protected XMLInputFactory createInputFactory() {
Exception exception = null;
try {
- return (XMLInputFactory)Class.forName("com.sun.xml.internal.stream.XMLInputFactoryImpl").newInstance();
- } catch (InstantiationException e) {
+ final XMLInputFactory instance = (XMLInputFactory)Class.forName("com.sun.xml.internal.stream.XMLInputFactoryImpl").newInstance();
+ instance.setProperty(XMLInputFactory.IS_SUPPORTING_EXTERNAL_ENTITIES, Boolean.FALSE);
+ return instance;
+ } catch (final InstantiationException e) {
exception = e;
} catch (IllegalAccessException e) {
exception = e;
diff --git a/xstream/src/java/com/thoughtworks/xstream/io/xml/StandardStaxDriver.java b/xstream/src/java/com/thoughtworks/xstream/io/xml/StandardStaxDriver.java
index 1fe744d..272be6c 100644
--- a/xstream/src/java/com/thoughtworks/xstream/io/xml/StandardStaxDriver.java
+++ b/xstream/src/java/com/thoughtworks/xstream/io/xml/StandardStaxDriver.java
@@ -1,11 +1,11 @@
/*
- * Copyright (C) 2013 XStream Committers.
+ * Copyright (C) 2013, 2014, 2015 XStream Committers.
* All rights reserved.
*
* The software in this package is published under the terms of the BSD
* style license a copy of which has been included with this distribution in
* the LICENSE.txt file.
- *
+ *
* Created on 27. July 2013 by Joerg Schaible
*/
package com.thoughtworks.xstream.io.xml;
@@ -28,7 +28,7 @@
* implementations configured in lib/stax.properties or registered with the Service
* API.
*
- *
+ *
* @author Jörg Schaible
* @since 1.4.5
*/
@@ -75,7 +75,9 @@
try {
Class staxInputFactory = JVM.getStaxInputFactory();
if (staxInputFactory != null) {
- return (XMLInputFactory)staxInputFactory.newInstance();
+ final XMLInputFactory instance = (XMLInputFactory)staxInputFactory.newInstance();
+ instance.setProperty(XMLInputFactory.IS_SUPPORTING_EXTERNAL_ENTITIES, Boolean.FALSE);
+ return instance;
} else {
throw new StreamException("Java runtime has no standard XMLInputFactory implementation.", exception);
}
diff --git a/xstream/src/java/com/thoughtworks/xstream/io/xml/StaxDriver.java b/xstream/src/java/com/thoughtworks/xstream/io/xml/StaxDriver.java
index b4c0086..d1ee523 100644
--- a/xstream/src/java/com/thoughtworks/xstream/io/xml/StaxDriver.java
+++ b/xstream/src/java/com/thoughtworks/xstream/io/xml/StaxDriver.java
@@ -1,6 +1,6 @@
/*
* Copyright (C) 2004, 2005, 2006 Joe Walnes.
- * Copyright (C) 2006, 2007, 2009, 2011, 2013 XStream Committers.
+ * Copyright (C) 2006, 2007, 2009, 2011, 2013, 2014, 2015 XStream Committers.
* All rights reserved.
*
* The software in this package is published under the terms of the BSD
@@ -40,7 +40,7 @@
*
* @author James Strachan
* @author Jörg Schaible
- * @version $Revision: 2116 $
+ * @version $Revision$
*/
public class StaxDriver extends AbstractXmlDriver {
@@ -238,7 +238,9 @@
* @since 1.4
*/
protected XMLInputFactory createInputFactory() {
- return XMLInputFactory.newInstance();
+ final XMLInputFactory instance = XMLInputFactory.newInstance();
+ instance.setProperty(XMLInputFactory.IS_SUPPORTING_EXTERNAL_ENTITIES, Boolean.FALSE);
+ return instance;
}
/**
diff --git a/xstream/src/java/com/thoughtworks/xstream/io/xml/StaxReader.java b/xstream/src/java/com/thoughtworks/xstream/io/xml/StaxReader.java
index 08fe718..84e126f 100644
--- a/xstream/src/java/com/thoughtworks/xstream/io/xml/StaxReader.java
+++ b/xstream/src/java/com/thoughtworks/xstream/io/xml/StaxReader.java
@@ -24,7 +24,7 @@
* A reader using the StAX API.
*
* @author James Strachan
- * @version $Revision: 1861 $
+ * @version $Revision$
*/
public class StaxReader extends AbstractPullReader {
diff --git a/xstream/src/java/com/thoughtworks/xstream/io/xml/StaxWriter.java b/xstream/src/java/com/thoughtworks/xstream/io/xml/StaxWriter.java
index 79410cc..6146717 100644
--- a/xstream/src/java/com/thoughtworks/xstream/io/xml/StaxWriter.java
+++ b/xstream/src/java/com/thoughtworks/xstream/io/xml/StaxWriter.java
@@ -23,7 +23,7 @@
* A stream writing that outputs to a StAX stream writer
*
* @author James Strachan
- * @version $Revision: 1906 $
+ * @version $Revision$
*/
public class StaxWriter extends AbstractXmlWriter {
diff --git a/xstream/src/java/com/thoughtworks/xstream/io/xml/WstxDriver.java b/xstream/src/java/com/thoughtworks/xstream/io/xml/WstxDriver.java
index fd9b316..d01f319 100644
--- a/xstream/src/java/com/thoughtworks/xstream/io/xml/WstxDriver.java
+++ b/xstream/src/java/com/thoughtworks/xstream/io/xml/WstxDriver.java
@@ -1,5 +1,5 @@
/*
- * Copyright (C) 2009, 2011 XStream Committers.
+ * Copyright (C) 2009, 2011, 2014, 2015 XStream Committers.
* All rights reserved.
*
* The software in this package is published under the terms of the BSD
@@ -62,7 +62,9 @@
}
protected XMLInputFactory createInputFactory() {
- return new WstxInputFactory();
+ final XMLInputFactory instance = new WstxInputFactory();
+ instance.setProperty(XMLInputFactory.IS_SUPPORTING_EXTERNAL_ENTITIES, Boolean.FALSE);
+ return instance;
}
protected XMLOutputFactory createOutputFactory() {
diff --git a/xstream/src/java/com/thoughtworks/xstream/io/xml/XomDriver.java b/xstream/src/java/com/thoughtworks/xstream/io/xml/XomDriver.java
index 5700ea6..d6c041d 100644
--- a/xstream/src/java/com/thoughtworks/xstream/io/xml/XomDriver.java
+++ b/xstream/src/java/com/thoughtworks/xstream/io/xml/XomDriver.java
@@ -1,6 +1,6 @@
/*
* Copyright (C) 2006 Joe Walnes.
- * Copyright (C) 2006, 2007, 2009, 2011 XStream Committers.
+ * Copyright (C) 2006, 2007, 2009, 2011, 2016 XStream Committers.
* All rights reserved.
*
* The software in this package is published under the terms of the BSD
@@ -35,9 +35,12 @@
private final Builder builder;
public XomDriver() {
- this(new Builder());
+ this(new XmlFriendlyNameCoder());
}
+ /**
+ * @deprecated As of 1.4.9, use {@link #XomDriver()} and overload {@link #createBuilder()} instead
+ */
public XomDriver(Builder builder) {
this(builder, new XmlFriendlyNameCoder());
}
@@ -46,40 +49,63 @@
* @since 1.4
*/
public XomDriver(NameCoder nameCoder) {
- this(new Builder(), nameCoder);
+ super(nameCoder);
+ this.builder = null;
}
/**
* @since 1.4
+ * @deprecated As of 1.4.9, use {@link #XomDriver(NameCoder)} and overload {@link #createBuilder()} instead
*/
public XomDriver(Builder builder, NameCoder nameCoder) {
- super(nameCoder);
+ super(nameCoder);
this.builder = builder;
}
/**
* @since 1.2
- * @deprecated As of 1.4, use {@link #XomDriver(Builder, NameCoder)} instead
+ * @deprecated As of 1.4, use {@link #XomDriver(NameCoder)} instead
*/
public XomDriver(XmlFriendlyReplacer replacer) {
- this(new Builder(), replacer);
+ this((NameCoder)replacer);
}
/**
* @since 1.2
- * @deprecated As of 1.4, use {@link #XomDriver(Builder, NameCoder)} instead
+ * @deprecated As of 1.4, use {@link #XomDriver(NameCoder)} and overload {@link #createBuilder()} instead
*/
public XomDriver(Builder builder, XmlFriendlyReplacer replacer) {
- this((NameCoder)replacer);
+ this(builder, (NameCoder)replacer);
}
+ /**
+ * @deprecated As of 1.4.9, overload {@link #createBuilder()} instead
+ */
protected Builder getBuilder() {
return this.builder;
}
+ /**
+ * Create the Builder instance.
+ *
+ * A XOM builder is a wrapper around a {@link org.xml.sax.XMLReader}
+ * instance which is not thread-safe by definition. Therefore each reader
+ * should use its own builder instance to avoid concurrency problems.
+ *
+ * Overload this method to configure the generated builder instances e.g.
+ * to activate validation.
+ *
+ * @return the new builder
+ * @since 1.4.9
+ */
+ protected Builder createBuilder() {
+ final Builder builder = getBuilder();
+ return builder != null ? builder : new Builder();
+ }
+
public HierarchicalStreamReader createReader(Reader text) {
try {
- Document document = builder.build(text);
+ final Document document = createBuilder().build(text);
return new XomReader(document, getNameCoder());
} catch (ValidityException e) {
throw new StreamException(e);
@@ -92,7 +118,7 @@
public HierarchicalStreamReader createReader(InputStream in) {
try {
- Document document = builder.build(in);
+ final Document document = createBuilder().build(in);
return new XomReader(document, getNameCoder());
} catch (ValidityException e) {
throw new StreamException(e);
@@ -105,7 +131,7 @@
public HierarchicalStreamReader createReader(URL in) {
try {
- Document document = builder.build(in.toExternalForm());
+ final Document document = createBuilder().build(in.toExternalForm());
return new XomReader(document, getNameCoder());
} catch (ValidityException e) {
throw new StreamException(e);
@@ -118,7 +144,7 @@
public HierarchicalStreamReader createReader(File in) {
try {
- Document document = builder.build(in);
+ final Document document = createBuilder().build(in);
return new XomReader(document, getNameCoder());
} catch (ValidityException e) {
throw new StreamException(e);
diff --git a/xstream/src/java/com/thoughtworks/xstream/mapper/AnnotationMapper.java b/xstream/src/java/com/thoughtworks/xstream/mapper/AnnotationMapper.java
index 7d0e78e..e8145e9 100644
--- a/xstream/src/java/com/thoughtworks/xstream/mapper/AnnotationMapper.java
+++ b/xstream/src/java/com/thoughtworks/xstream/mapper/AnnotationMapper.java
@@ -1,5 +1,5 @@
/*
- * Copyright (C) 2007, 2008, 2009, 2011, 2012, 2013 XStream Committers.
+ * Copyright (C) 2007, 2008, 2009, 2011, 2012, 2013, 2016 XStream Committers.
* All rights reserved.
*
* The software in this package is published under the terms of the BSD
@@ -505,12 +505,13 @@
if (array != null) {
int length = Array.getLength(array);
for (int i = 0; i < length; i++ ) {
- Object object = Array.get(array, i);
- if (!parameter.contains(object)) {
- parameter.add(object);
- }
- }
- }
+ parameter.add(Array.get(array, i));
+ }
+ }
+ }
+ for (final Class type : annotation.nulls()) {
+ final TypedNull nullType = new TypedNull(type);
+ parameter.add(nullType);
}
final Class converterType = annotation.value();
Map+ * To build up the functionality required, wrap this mapper with other mapper implementations. + *
* * @author Joe Walnes * @author Jörg Schaible @@ -38,7 +40,7 @@ /** * Construct a DefaultMapper. - * + * * @param classLoaderReference the reference to the classloader used by the XStream instance. * @since 1.4.5 */ @@ -48,7 +50,7 @@ /** * Construct a DefaultMapper. - * + * * @param classLoader the ClassLoader used by the XStream instance. * @deprecated As of 1.4.5 use {@link #DefaultMapper(ClassLoaderReference)} */ @@ -98,6 +100,10 @@ public boolean isImmutableValueType(Class type) { return false; + } + + public boolean isReferenceable(final Class type) { + return true; } public String getFieldNameForItemTypeAndName(Class definedIn, Class itemType, String itemFieldName) { diff --git a/xstream/src/java/com/thoughtworks/xstream/mapper/EnumMapper.java b/xstream/src/java/com/thoughtworks/xstream/mapper/EnumMapper.java index f46e4c2..d562126 100644 --- a/xstream/src/java/com/thoughtworks/xstream/mapper/EnumMapper.java +++ b/xstream/src/java/com/thoughtworks/xstream/mapper/EnumMapper.java @@ -1,12 +1,12 @@ /* * Copyright (C) 2005 Joe Walnes. - * Copyright (C) 2006, 2007, 2008, 2009, 2011 XStream Committers. + * Copyright (C) 2006, 2007, 2008, 2009, 2011, 2015 XStream Committers. * All rights reserved. * * The software in this package is published under the terms of the BSD * style license a copy of which has been included with this distribution in * the LICENSE.txt file. - * + * * Created on 20. March 2005 by Joe Walnes */ package com.thoughtworks.xstream.mapper; @@ -22,11 +22,10 @@ /** - * Mapper that handles the special case of polymorphic enums in Java 1.5. This renames MyEnum$1 - * to MyEnum making it less bloaty in the XML and avoiding the need for an alias per enum value - * to be specified. Additionally every enum is treated automatically as immutable type and can - * be written as attribute. - * + * Mapper that handles the special case of polymorphic enums in Java 1.5. This renames MyEnum$1 to MyEnum making it less + * bloaty in the XML and avoiding the need for an alias per enum value to be specified. Additionally every enum is + * treated automatically as immutable and non-refrenceable type that can be written as attribute. + * * @author Joe Walnes * @author Jörg Schaible */ @@ -69,12 +68,21 @@ } @Override + public boolean isReferenceable(final Class type) { + if (type != null && Enum.class.isAssignableFrom(type)) { + return false; + } else { + return super.isReferenceable(type); + } + } + + @Override public SingleValueConverter getConverterFromItemType(String fieldName, Class type, - Class definedIn) { - SingleValueConverter converter = getLocalConverter(fieldName, type, definedIn); - return converter == null - ? super.getConverterFromItemType(fieldName, type, definedIn) - : converter; + Class definedIn) { + SingleValueConverter converter = getLocalConverter(fieldName, type, definedIn); + return converter == null + ? super.getConverterFromItemType(fieldName, type, definedIn) + : converter; } @Override @@ -88,8 +96,8 @@ private SingleValueConverter getLocalConverter(String fieldName, Class type, Class definedIn) { if (attributeMapper != null - && Enum.class.isAssignableFrom(type) - && attributeMapper.shouldLookForSingleValueConverter(fieldName, type, definedIn)) { + && Enum.class.isAssignableFrom(type) + && attributeMapper.shouldLookForSingleValueConverter(fieldName, type, definedIn)) { synchronized (enumConverterMap) { SingleValueConverter singleValueConverter = enumConverterMap.get(type); if (singleValueConverter == null) { diff --git a/xstream/src/java/com/thoughtworks/xstream/mapper/ImmutableTypesMapper.java b/xstream/src/java/com/thoughtworks/xstream/mapper/ImmutableTypesMapper.java index f6db320..b218807 100644 --- a/xstream/src/java/com/thoughtworks/xstream/mapper/ImmutableTypesMapper.java +++ b/xstream/src/java/com/thoughtworks/xstream/mapper/ImmutableTypesMapper.java @@ -1,12 +1,12 @@ /* * Copyright (C) 2005 Joe Walnes. - * Copyright (C) 2006, 2007, 2009 XStream Committers. + * Copyright (C) 2006, 2007, 2009, 2015 XStream Committers. * All rights reserved. * * The software in this package is published under the terms of the BSD * style license a copy of which has been included with this distribution in * the LICENSE.txt file. - * + * * Created on 22. January 2005 by Joe Walnes */ package com.thoughtworks.xstream.mapper; @@ -17,19 +17,44 @@ /** * Mapper that specifies which types are basic immutable types. Types that are marked as immutable will be written * multiple times in the serialization stream without using references. + *+ * Note, that an already persisted stream might still contain references for immutable types. They can be dereferenced + * at deserialization time, unless the type is explicitly declared as unreferenceable. However, this is only possible at + * the expense of memory book-keeping all instances. + *
* * @author Joe Walnes */ public class ImmutableTypesMapper extends MapperWrapper { + private final Set unreferenceableTypes = new HashSet(); private final Set immutableTypes = new HashSet(); public ImmutableTypesMapper(Mapper wrapped) { super(wrapped); } + /** + * @deprecated As of 1.4.9 use {@link #addImmutableType(Class, boolean)} + */ public void addImmutableType(Class type) { + addImmutableType(type, true); + } + + /** + * Declare a type as immutable. + * + * @param type the immutable type + * @param isReferenceable flag for possible references + * @since 1.4.9 + */ + public void addImmutableType(final Class type, final boolean isReferenceable) { immutableTypes.add(type); + if (!isReferenceable) { + unreferenceableTypes.add(type); + } else { + unreferenceableTypes.remove(type); + } } public boolean isImmutableValueType(Class type) { @@ -40,4 +65,11 @@ } } + public boolean isReferenceable(final Class type) { + if (unreferenceableTypes.contains(type)) { + return false; + } else { + return super.isReferenceable(type); + } + } } diff --git a/xstream/src/java/com/thoughtworks/xstream/mapper/ImplicitCollectionMapper.java b/xstream/src/java/com/thoughtworks/xstream/mapper/ImplicitCollectionMapper.java index 36eca76..2eb442b 100644 --- a/xstream/src/java/com/thoughtworks/xstream/mapper/ImplicitCollectionMapper.java +++ b/xstream/src/java/com/thoughtworks/xstream/mapper/ImplicitCollectionMapper.java @@ -1,12 +1,12 @@ /* * Copyright (C) 2005 Joe Walnes. - * Copyright (C) 2006, 2007, 2009, 2011, 2012, 2013, 2014 XStream Committers. + * Copyright (C) 2006, 2007, 2009, 2011, 2012, 2013, 2014, 2015 XStream Committers. * All rights reserved. * * The software in this package is published under the terms of the BSD * style license a copy of which has been included with this distribution in * the LICENSE.txt file. - * + * * Created on 16. February 2005 by Joe Walnes */ package com.thoughtworks.xstream.mapper; @@ -15,6 +15,7 @@ import com.thoughtworks.xstream.core.util.Primitives; import java.lang.reflect.Field; +import java.lang.reflect.Modifier; import java.util.Collection; import java.util.HashMap; import java.util.Iterator; @@ -30,12 +31,27 @@ // { definedIn (Class) -> (ImplicitCollectionMapperForClass) } private final Map classNameToMapper = new HashMap(); - private ImplicitCollectionMapperForClass getMapper(Class definedIn) { + private ImplicitCollectionMapperForClass getMapper(final Class declaredFor, final String fieldName) { + Class definedIn = declaredFor; while (definedIn != null) { ImplicitCollectionMapperForClass mapper = (ImplicitCollectionMapperForClass)classNameToMapper .get(definedIn); if (mapper != null) { return mapper; + } else { + if (fieldName != null) { + try { + // do not continue search for a hidden field + final Field field = definedIn.getDeclaredField(fieldName); + if (field != null && !Modifier.isStatic(field.getModifiers())) { + return null; + } + } catch (final SecurityException e) { + throw new InitializationException("Access denied for field with implicit collection", e); + } catch (final NoSuchFieldException e) { + // OK, we can continue the search in the class hierarchy + } + } } definedIn = definedIn.getSuperclass(); } @@ -54,7 +70,7 @@ public String getFieldNameForItemTypeAndName(Class definedIn, Class itemType, String itemFieldName) { - ImplicitCollectionMapperForClass mapper = getMapper(definedIn); + ImplicitCollectionMapperForClass mapper = getMapper(definedIn, null); if (mapper != null) { return mapper.getFieldNameForItemTypeAndName(itemType, itemFieldName); } else { @@ -63,7 +79,7 @@ } public Class getItemTypeForItemFieldName(Class definedIn, String itemFieldName) { - ImplicitCollectionMapperForClass mapper = getMapper(definedIn); + ImplicitCollectionMapperForClass mapper = getMapper(definedIn, null); if (mapper != null) { return mapper.getItemTypeForItemFieldName(itemFieldName); } else { @@ -73,7 +89,7 @@ public ImplicitCollectionMapping getImplicitCollectionDefForFieldName(Class itemType, String fieldName) { - ImplicitCollectionMapperForClass mapper = getMapper(itemType); + ImplicitCollectionMapperForClass mapper = getMapper(itemType, fieldName); if (mapper != null) { return mapper.getImplicitCollectionDefForFieldName(fieldName); } else { @@ -91,16 +107,20 @@ public void add(Class definedIn, String fieldName, String itemFieldName, Class itemType, String keyFieldName) { Field field = null; - Class declaredIn = definedIn; - while (declaredIn != Object.class && definedIn != null) { - try { - field = declaredIn.getDeclaredField(fieldName); - break; - } catch (SecurityException e) { - throw new InitializationException( - "Access denied for field with implicit collection", e); - } catch (NoSuchFieldException e) { - declaredIn = declaredIn.getSuperclass(); + if (definedIn != null) { + Class declaredIn = definedIn; + while (declaredIn != Object.class) { + try { + field = declaredIn.getDeclaredField(fieldName); + if (!Modifier.isStatic(field.getModifiers())) { + break; + } + field = null; + } catch (final SecurityException e) { + throw new InitializationException("Access denied for field with implicit collection", e); + } catch (final NoSuchFieldException e) { + declaredIn = declaredIn.getSuperclass(); + } } } if (field == null) { @@ -177,7 +197,7 @@ if (unnamed != null) { return unnamed.getFieldName(); } else { - ImplicitCollectionMapperForClass mapper = ImplicitCollectionMapper.this.getMapper(definedIn.getSuperclass()); + ImplicitCollectionMapperForClass mapper = ImplicitCollectionMapper.this.getMapper(definedIn.getSuperclass(), null); return mapper != null ? mapper.getFieldNameForItemTypeAndName(itemType, itemFieldName) : null; } } @@ -187,7 +207,7 @@ if (def != null) { return def.getItemType(); } else { - ImplicitCollectionMapperForClass mapper = ImplicitCollectionMapper.this.getMapper(definedIn.getSuperclass()); + ImplicitCollectionMapperForClass mapper = ImplicitCollectionMapper.this.getMapper(definedIn.getSuperclass(), null); return mapper != null ? mapper.getItemTypeForItemFieldName(itemFieldName) : null; } } @@ -201,7 +221,7 @@ if (mapping != null) { return mapping; } else { - ImplicitCollectionMapperForClass mapper = ImplicitCollectionMapper.this.getMapper(definedIn.getSuperclass()); + ImplicitCollectionMapperForClass mapper = ImplicitCollectionMapper.this.getMapper(definedIn.getSuperclass(), null); return mapper != null ? mapper.getImplicitCollectionDefByItemFieldName(itemFieldName) : null; } } @@ -212,7 +232,7 @@ if (mapping != null) { return mapping; } else { - ImplicitCollectionMapperForClass mapper = ImplicitCollectionMapper.this.getMapper(definedIn.getSuperclass()); + ImplicitCollectionMapperForClass mapper = ImplicitCollectionMapper.this.getMapper(definedIn.getSuperclass(), null); return mapper != null ? mapper.getImplicitCollectionDefForFieldName(fieldName) : null; } } diff --git a/xstream/src/java/com/thoughtworks/xstream/mapper/Mapper.java b/xstream/src/java/com/thoughtworks/xstream/mapper/Mapper.java index 17bcaeb..3760ab2 100644 --- a/xstream/src/java/com/thoughtworks/xstream/mapper/Mapper.java +++ b/xstream/src/java/com/thoughtworks/xstream/mapper/Mapper.java @@ -1,12 +1,12 @@ /* * Copyright (C) 2005, 2006 Joe Walnes. - * Copyright (C) 2006, 2007, 2008, 2009, 2011 XStream Committers. + * Copyright (C) 2006, 2007, 2008, 2009, 2011, 2015 XStream Committers. * All rights reserved. * * The software in this package is published under the terms of the BSD * style license a copy of which has been included with this distribution in * the LICENSE.txt file. - * + * * Created on 22. January 2005 by Joe Walnes */ package com.thoughtworks.xstream.mapper; @@ -41,16 +41,23 @@ String realMember(Class type, String serialized); /** - * Whether this type is a simple immutable value (int, boolean, String, URL, etc. - * Immutable types will be repeatedly written in the serialized stream, instead of using object references. + * Whether this type is a simple immutable value (int, boolean, String, URL, etc). Immutable types will be + * repeatedly written in the serialized stream, instead of using object references. */ boolean isImmutableValueType(Class type); + + /** + * Whether this type is referenceable in a stream. + * + * @since 1.4.9 + */ + boolean isReferenceable(Class type); Class defaultImplementationOf(Class type); /** * Get the alias for an attribute's name. - * + * * @param attribute the attribute * @return the alias * @since 1.2 @@ -59,7 +66,7 @@ /** * Get the attribute's name for an alias. - * + * * @param alias the alias * @return the attribute's name * @since 1.2 @@ -68,7 +75,7 @@ /** * Get the alias for a system attribute's name. - * + * * @param attribute the system attribute * @return the alias * @since 1.3.1 @@ -78,8 +85,8 @@ /** * Get the name of the field that acts as the default collection for an object, or return null if there is none. * - * @param definedIn owning type - * @param itemType item type + * @param definedIn owning type + * @param itemType item type * @param itemFieldName optional item element name */ String getFieldNameForItemTypeAndName(Class definedIn, Class itemType, String itemFieldName); @@ -123,7 +130,7 @@ /** * Returns a single value converter to be used in a specific field. - * + * * @param fieldName the field name * @param type the field type * @param definedIn the type which defines this field @@ -157,7 +164,7 @@ /** * Returns which converter to use for an specific attribute in a type. - * + * * @param definedIn the field's parent * @param attribute the attribute name * @deprecated As of 1.3.1, use {@link #getConverterFromAttribute(Class, String, Class)} @@ -166,7 +173,7 @@ /** * Returns which converter to use for an specific attribute in a type. - * + * * @param definedIn the field's parent * @param attribute the attribute name * @param type the type the converter should create diff --git a/xstream/src/java/com/thoughtworks/xstream/mapper/MapperWrapper.java b/xstream/src/java/com/thoughtworks/xstream/mapper/MapperWrapper.java index 93ced3d..71649f8 100644 --- a/xstream/src/java/com/thoughtworks/xstream/mapper/MapperWrapper.java +++ b/xstream/src/java/com/thoughtworks/xstream/mapper/MapperWrapper.java @@ -1,6 +1,6 @@ /* * Copyright (C) 2005, 2006 Joe Walnes. - * Copyright (C) 2006, 2007, 2008, 2009 XStream Committers. + * Copyright (C) 2006, 2007, 2008, 2009, 2015 XStream Committers. * All rights reserved. * * The software in this package is published under the terms of the BSD @@ -40,6 +40,10 @@ public boolean isImmutableValueType(Class type) { return wrapped.isImmutableValueType(type); + } + + public boolean isReferenceable(Class type) { + return wrapped.isReferenceable(type); } public Class defaultImplementationOf(Class type) { diff --git a/xstream/src/java/com/thoughtworks/xstream/mapper/OuterClassMapper.java b/xstream/src/java/com/thoughtworks/xstream/mapper/OuterClassMapper.java index f98c514..6b136bc 100644 --- a/xstream/src/java/com/thoughtworks/xstream/mapper/OuterClassMapper.java +++ b/xstream/src/java/com/thoughtworks/xstream/mapper/OuterClassMapper.java @@ -1,24 +1,34 @@ /* * Copyright (C) 2005 Joe Walnes. - * Copyright (C) 2006, 2007, 2009 XStream Committers. + * Copyright (C) 2006, 2007, 2009, 2015 XStream Committers. * All rights reserved. * * The software in this package is published under the terms of the BSD * style license a copy of which has been included with this distribution in * the LICENSE.txt file. - * + * * Created on 31. January 2005 by Joe Walnes */ package com.thoughtworks.xstream.mapper; + +import java.lang.reflect.Field; +import java.util.Collections; +import java.util.HashMap; +import java.util.Map; + +import com.thoughtworks.xstream.core.Caching; + /** * Mapper that uses a more meaningful alias for the field in an inner class (this$0) that refers to the outer class. * * @author Joe Walnes */ -public class OuterClassMapper extends MapperWrapper { +public class OuterClassMapper extends MapperWrapper implements Caching { + private static final String[] EMPTY_NAMES = new String[0]; private final String alias; + private final Map innerFields; public OuterClassMapper(Mapper wrapped) { this(wrapped, "outer-class"); @@ -27,21 +37,61 @@ public OuterClassMapper(Mapper wrapped, String alias) { super(wrapped); this.alias = alias; + innerFields = Collections.synchronizedMap(new HashMap()); + innerFields.put(Object.class.getName(), EMPTY_NAMES); } public String serializedMember(Class type, String memberName) { - if (memberName.equals("this$0")) { - return alias; - } else { - return super.serializedMember(type, memberName); + if (memberName.startsWith("this$")) { + final String[] innerFieldNames = getInnerFieldNames(type); + for (int i = 0; i < innerFieldNames.length; ++i) { + if (innerFieldNames[i].equals(memberName)) { + return i == 0 ? alias : alias + '-' + i; + } + } } + return super.serializedMember(type, memberName); } public String realMember(Class type, String serialized) { - if (serialized.equals(alias)) { - return "this$0"; - } else { - return super.realMember(type, serialized); + if (serialized.startsWith(alias)) { + int idx = -1; + final int len = alias.length(); + if (len == serialized.length()) { + idx = 0; + } else if (serialized.length() > len + 1 && serialized.charAt(len) == '-') { + idx = Integer.valueOf(serialized.substring(len + 1)).intValue(); + } + if (idx >= 0) { + final String[] innerFieldNames = getInnerFieldNames(type); + if (idx < innerFieldNames.length) { + return innerFieldNames[idx]; + } + } } + return super.realMember(type, serialized); + } + + private String[] getInnerFieldNames(final Class type) { + String[] innerFieldNames = (String[])innerFields.get(type.getName()); + if (innerFieldNames == null) { + innerFieldNames = getInnerFieldNames(type.getSuperclass()); + Field[] declaredFields = type.getDeclaredFields(); + for (int i = 0; i < declaredFields.length; i++) { + final Field field = declaredFields[i]; + if (field.getName().startsWith("this$")) { + String[] temp = new String[innerFieldNames.length+1]; + System.arraycopy(innerFieldNames, 0, temp, 0, innerFieldNames.length); + innerFieldNames = temp; + innerFieldNames[innerFieldNames.length - 1] = field.getName(); + } + } + innerFields.put(type.getName(), innerFieldNames); + } + return innerFieldNames; + } + + public void flushCache() { + innerFields.keySet().retainAll(Collections.singletonList(Object.class.getName())); } } diff --git a/xstream/src/java/com/thoughtworks/xstream/persistence/FilePersistenceStrategy.java b/xstream/src/java/com/thoughtworks/xstream/persistence/FilePersistenceStrategy.java index ea973e8..1fe685e 100644 --- a/xstream/src/java/com/thoughtworks/xstream/persistence/FilePersistenceStrategy.java +++ b/xstream/src/java/com/thoughtworks/xstream/persistence/FilePersistenceStrategy.java @@ -1,32 +1,31 @@ /* - * Copyright (C) 2008 XStream Committers. + * Copyright (C) 2008, 2016 XStream Committers. * All rights reserved. * * The software in this package is published under the terms of the BSD * style license a copy of which has been included with this distribution in * the LICENSE.txt file. - * + * * Created on 20. November 2008 by Joerg Schaible */ package com.thoughtworks.xstream.persistence; +import java.io.File; + import com.thoughtworks.xstream.XStream; +import com.thoughtworks.xstream.converters.ConversionException; import com.thoughtworks.xstream.converters.Converter; import com.thoughtworks.xstream.converters.SingleValueConverter; -import com.thoughtworks.xstream.io.StreamException; import com.thoughtworks.xstream.io.xml.DomDriver; - -import java.io.File; /** - * PersistenceStrategy to assign keys with single value to objects persisted in files. The - * default naming strategy is based on the key's type and its {@link SingleValueConverter}. It - * escapes all characters that are normally illegal in the most common file systems. Such a - * character is escaped with percent escaping as it is done by URL encoding. The XStream used to - * marshal the values is also requested for the key's SingleValueConverter. A - * {@link StreamException} is thrown if no such converter is registered. - * + * PersistenceStrategy to assign keys with single value to objects persisted in files. The default naming strategy is + * based on the key's type and its {@link SingleValueConverter}. It escapes all characters that are normally illegal in + * the most common file systems. Such a character is escaped with percent escaping as it is done by URL encoding. The + * XStream used to marshal the values is also requested for the key's SingleValueConverter. A + * {@link ConversionException} is thrown if no such converter is registered. + * * @author Jörg Schaible * @author Guilherme Silveira * @since 1.3.1 @@ -36,9 +35,8 @@ private final String illegalChars; /** - * Create a new FilePersistenceStrategy. Use a standard XStream instance with a - * {@link DomDriver}. - * + * Create a new FilePersistenceStrategy. Use a standard XStream instance with a {@link DomDriver}. + * * @param baseDirectory the directory for the serialized values * @since 1.3.1 */ @@ -48,7 +46,7 @@ /** * Create a new FilePersistenceStrategy with a provided XStream instance. - * + * * @param baseDirectory the directory for the serialized values * @param xstream the XStream instance to use for (de)serialization * @since 1.3.1 @@ -58,19 +56,17 @@ } /** - * Create a new FilePersistenceStrategy with a provided XStream instance and the characters - * to encode. - * + * Create a new FilePersistenceStrategy with a provided XStream instance and the characters to encode. + * * @param baseDirectory the directory for the serialized values * @param xstream the XStream instance to use for (de)serialization * @param encoding encoding used to write the files - * @param illegalChars illegal characters for file names (should always include '%' as long - * as you do not overwrite the (un)escape methods) + * @param illegalChars illegal characters for file names (should always include '%' as long as you do not overwrite + * the (un)escape methods) * @since 1.3.1 */ public FilePersistenceStrategy( - final File baseDirectory, final XStream xstream, final String encoding, - final String illegalChars) { + final File baseDirectory, final XStream xstream, final String encoding, final String illegalChars) { super(baseDirectory, xstream, encoding); this.illegalChars = illegalChars; } @@ -81,7 +77,7 @@ /** * Given a filename, the unescape method returns the key which originated it. - * + * * @param name the filename * @return the original key */ @@ -90,19 +86,22 @@ if ("null@null".equals(key)) { return null; } - int idx = key.indexOf('@'); + final int idx = key.indexOf('@'); if (idx < 0) { - throw new StreamException("Not a valid key: " + key); + final ConversionException exception = new ConversionException("No valid key"); + exception.add("key", key); + throw exception; } - Class type = getMapper().realClass(key.substring(0, idx)); - Converter converter = getConverterLookup().lookupConverterForType(type); + final Class type = getMapper().realClass(key.substring(0, idx)); + final Converter converter = getConverterLookup().lookupConverterForType(type); if (converter instanceof SingleValueConverter) { final SingleValueConverter svConverter = (SingleValueConverter)converter; return svConverter.fromString(key.substring(idx + 1)); } else { - throw new StreamException("No SingleValueConverter for type " - + type.getName() - + " available"); + final ConversionException exception = new ConversionException( + "No SingleValueConverter available for key type"); + exception.add("key-type", type.getName()); + throw exception; } } @@ -110,7 +109,7 @@ final StringBuffer buffer = new StringBuffer(); for (int idx = name.indexOf('%'); idx >= 0; idx = name.indexOf('%')) { buffer.append(name.substring(0, idx)); - int c = Integer.parseInt(name.substring(idx + 1, idx + 3), 16); + final int c = Integer.parseInt(name.substring(idx + 1, idx + 3), 16); buffer.append((char)c); name = name.substring(idx + 3); } @@ -120,7 +119,7 @@ /** * Given a key, the escape method returns the filename which shall be used. - * + * * @param key the key * @return the desired and escaped filename */ @@ -128,18 +127,16 @@ if (key == null) { return "null@null.xml"; } - Class type = key.getClass(); - Converter converter = getConverterLookup().lookupConverterForType(type); + final Class type = key.getClass(); + final Converter converter = getConverterLookup().lookupConverterForType(type); if (converter instanceof SingleValueConverter) { final SingleValueConverter svConverter = (SingleValueConverter)converter; - return getMapper().serializedClass(type) - + '@' - + escape(svConverter.toString(key)) - + ".xml"; + return getMapper().serializedClass(type) + '@' + escape(svConverter.toString(key)) + ".xml"; } else { - throw new StreamException("No SingleValueConverter for type " - + type.getName() - + " available"); + final ConversionException exception = new ConversionException( + "No SingleValueConverter available for key type"); + exception.add("key-type", type.getName()); + throw exception; } } diff --git a/xstream/src/test/com/thoughtworks/acceptance/AbstractAcceptanceTest.java b/xstream/src/test/com/thoughtworks/acceptance/AbstractAcceptanceTest.java index 7fcf9f6..ee11141 100644 --- a/xstream/src/test/com/thoughtworks/acceptance/AbstractAcceptanceTest.java +++ b/xstream/src/test/com/thoughtworks/acceptance/AbstractAcceptanceTest.java @@ -1,6 +1,6 @@ /* * Copyright (C) 2003, 2004, 2005, 2006 Joe Walnes. - * Copyright (C) 2006, 2007, 2008, 2014 XStream Committers. + * Copyright (C) 2006, 2007, 2008, 2014, 2015 XStream Committers. * All rights reserved. * * The software in this package is published under the terms of the BSD @@ -71,9 +71,8 @@ Class type = Class.forName(driver); return (HierarchicalStreamDriver) type.newInstance(); } - } - catch (Exception e) { - throw new RuntimeException("Could not load driver: " + driver); + } catch (final Exception e) { + throw new RuntimeException("Could not load driver: " + driver, e); } return new XppDriver(); } @@ -121,9 +120,10 @@ return resultRoot; - } catch (TransformerException e) { - throw new AssertionFailedError("Cannot normalize XML: " + e.getMessage()); - // .initCause(e); ... still JDK 1.3 + } catch (final TransformerException e) { + final AssertionFailedError error = new AssertionFailedError("Cannot normalize XML: " + e.getMessage()); + error.initCause(e); + throw error; } } diff --git a/xstream/src/test/com/thoughtworks/acceptance/AbstractReferenceTest.java b/xstream/src/test/com/thoughtworks/acceptance/AbstractReferenceTest.java index 514187c..07664a4 100644 --- a/xstream/src/test/com/thoughtworks/acceptance/AbstractReferenceTest.java +++ b/xstream/src/test/com/thoughtworks/acceptance/AbstractReferenceTest.java @@ -1,6 +1,6 @@ /* * Copyright (C) 2004, 2005 Joe Walnes. - * Copyright (C) 2006, 2007, 2009, 2010, 2011, 2014 XStream Committers. + * Copyright (C) 2006, 2007, 2009, 2010, 2011, 2014, 2015 XStream Committers. * All rights reserved. * * The software in this package is published under the terms of the BSD @@ -66,6 +66,8 @@ Thing t0 = (Thing)result.get(0); Thing t1 = (Thing)result.get(1); Thing t2 = (Thing)result.get(2); + + assertSame(t0, t1); t0.field = "bye"; @@ -472,4 +474,59 @@ String xml = xstream.toXML(emails); assertEquals(emails, xstream.fromXML(xml)); } + + public void testImmutableInstancesAreNotReferenced() { + xstream.addImmutableType(Thing.class, false); + + Thing sameThing = new Thing("hello"); + Thing anotherThing = new Thing("hello"); + + List list = new ArrayList(); + list.add(sameThing); + list.add(sameThing); + list.add(anotherThing); + + String xml = xstream.toXML(list); + List result = (List)xstream.fromXML(xml); + + Thing t0 = (Thing)result.get(0); + Thing t1 = (Thing)result.get(1); + Thing t2 = (Thing)result.get(2); + + assertEquals(t0, t1); + assertNotSame(t0, t1); + } + + public void testImmutableInstancesCanBeDereferenced() { + + Thing sameThing = new Thing("hello"); + Thing anotherThing = new Thing("hello"); + + List list = new ArrayList(); + list.add(sameThing); + list.add(sameThing); + list.add(anotherThing); + + String xml = xstream.toXML(list); + + xstream.addImmutableType(Thing.class, false); + + try { + xstream.fromXML(xml); + fail("Thrown " + ConversionException.class.getName() + " expected"); + } catch (final ConversionException e) { + assertEquals(Thing.class.getName(), e.get("referenced-type")); + } + + xstream.addImmutableType(Thing.class, true); + + List result = (List)xstream.fromXML(xml); + + Thing t0 = (Thing)result.get(0); + Thing t1 = (Thing)result.get(1); + Thing t2 = (Thing)result.get(2); + + assertEquals(t0, t1); + assertSame(t0, t1); + } } diff --git a/xstream/src/test/com/thoughtworks/acceptance/Extended17TypesTest.java b/xstream/src/test/com/thoughtworks/acceptance/Extended17TypesTest.java new file mode 100644 index 0000000..edc7b99 --- /dev/null +++ b/xstream/src/test/com/thoughtworks/acceptance/Extended17TypesTest.java @@ -0,0 +1,64 @@ +/* + * Copyright (C) 2016 XStream Committers. + * All rights reserved. + * + * The software in this package is published under the terms of the BSD + * style license a copy of which has been included with this distribution in + * the LICENSE.txt file. + * + * Created on 7. February 2016 by Aaron Johnson + */ +package com.thoughtworks.acceptance; + +import java.io.IOException; +import java.net.URI; +import java.nio.file.FileSystem; +import java.nio.file.FileSystems; +import java.nio.file.Path; +import java.nio.file.Paths; +import java.util.HashMap; +import java.util.Map; + +import com.thoughtworks.xstream.XStream; + + +/** + * @author Aaron Johnson + * @author Jörg Schaible + */ +public class Extended17TypesTest extends AbstractAcceptanceTest { + + @Override + protected void setupSecurity(final XStream xstream) { + super.setupSecurity(xstream); + xstream.allowTypeHierarchy(Path.class); + } + + public void testPathOfDefaultFileSystem() { + assertBothWays(Paths.get("../a/relative/path"), "\n" +
+ " Microsoft \n" +
+ " Windows \n" +
+ " \n" +
+ " \n" +
+ " Red Hat \n" +
+ " Linux \n" +
+ " \n" +
+ " Benchmark results are always dependent on a very individual setup. Normally it is not useful to generalize such results + for every use case, but it can give you a hint. However, if you're really in the need of maximum performance, you should + probably create an own benchmark with your objects or even use a profiler to detect the real hot spots in your application.
+ +XStream uses the Java Microbenchmark Harness (JMH) + of the JDK Tools as benchmark framework starting with version 1.4.9. As result it contains a ZIP file + (xstream-jmh-<version>-app.zip) as new artifact containing anything required to run the benchmarks. Unpack + the file and use the scripts in the bin directory to execute the benchmarks. Use option -h to look at the + options provided by JMH. You may exchange the libraries in the lib directory with other versions of + XStream or the individual parsers or you may even add new JMH benchmarks to the default ones of XStream.
+ +All benchmark values below measure the average throughput in nanosecond per operation. JMH provides additional + measurement options, see online help. The maximum deviation for each benchmark is recorded in the reference files + of the distributed ZIP file. The benchmark is executed on Linux 4.1.12 Gentoo 64-bit system with an Intel Core i7 + CPU 920 of 2.67 GHz. Note again, that these values are no replacement for real profiler results and they may + vary from run to run (see reference files) due to this machine's background processes on a single CPU. However, it + can give you some idea of what you can expect using different parser technologies.
+ +The values represent the average throughput of 15 runs with a single thread. The benchmarks emphasis the parser + efficiency for different structures.
+ +| Parser | +Text | +Array | +Nested | +
|---|---|---|---|
| W3C DOM (Oracle JDK 1.8.0_66) | +10037380.795 | +54234293.351 | +1917332.056 | +
| JDOM (1.1.3) | +6368317.636 | +7910979.223 | +3862796.027 | +
| JDOM 2 (2.0.5) | +5767640.105 | +10570210.653 | +2980906.727 | +
| DOM4J (1.6.1) | +7816280.084 | +92998322.952 | +2108075.646 | +
| XOM (1.1) | +7950778.533 | +38704485.310 | +2471019.743 | +
| StAX (BEA 1.2.0) | +3108517.699 | +1310406.961 | +669111.164 | +
| StAX (Woodstox 3.2.7) | +1884858.525 | +1240767.393 | +650470.623 | +
| StAX (Oracle JDK 1.8.0_66) | +7366387.272 | +1334398.501 | +688229.709 | +
| XPP (Xpp3 min 1.1.4c) | +2109341.076 | +1309607.210 | +3301732.767 | +
| XPP (kXML2 min 2.3.0) | +3391204.266 | +1514514.680 | +8105934.241 | +
| Binary (XStream 1.4.9) | +1144243.750 | +1062031.901 | +496839.565 | +
| Jettison (1.2) | +3002547.220 | +1159238.555 | +682182.733 | +
The values represent the average throughput of 16 runs with four threads using the Xpp3 parser for a structure + with 1.000 elements. The benchmarks demonstrate the different converter types that can be used for a standard Java + class.
+ +| Converter Type | +Throughput | +
|---|---|
| Custom | +11276718.384 | +
| Java Bean | +28878706.293 | +
| Reflection | +40085786.696 | +
The values represent the average throughput of 16 runs with four threads using the Xpp3 parser for a structure + with 10.000 string elements of various sizes and duplicates. The benchmarks demonstrate different implementations + and configurations of the StringConverter.
+ +| StringConverter Strategy | +Throughput | +
|---|---|
| No Cache | +19626160.696 | +
| Intern | +23060982.052 | +
| ConcurrentMap (length limit) | +21796001.29 | +
| ConcurrentMap (unlimited) | +21378299.003 | +
| Sync'd WeakCache (length limit) | +21838410.801 | +
| Sync'd WeakCache (unlimited) | +22011251.691 | +
The values represent the average throughput of 25 runs with four threads using the Xpp3 parser for a structure + with 250 nested elements using names invalid for XML elements. The benchmarks demonstrate different implementation + strategies for a NameCoder to create valid tag names in XML.
+ +| NameCoder Implementation | +Throughput | +
|---|---|
| No Coding | +7299475.975 | +
| Dollar Coding | +7767196.902 | +
| Escaped Underscore Coding | +9894393.289 | +
| Cached Escaped Underscore Coding | +7867671.962 | +
| Xml Friendly Coding | +8635501.208 | +