com.fasterxml.jackson.module.jaxb.JaxbAnnotationIntrospector Maven / Gradle / Ivy
Show all versions of ehcache Show documentation
package com.fasterxml.jackson.module.jaxb;
import java.beans.Introspector;
import java.lang.annotation.Annotation;
import java.lang.reflect.*;
import java.util.*;
import javax.xml.bind.*;
import javax.xml.bind.annotation.*;
import javax.xml.bind.annotation.adapters.*;
import com.fasterxml.jackson.annotation.JsonAutoDetect.Visibility;
import com.fasterxml.jackson.annotation.JsonInclude;
import com.fasterxml.jackson.annotation.JsonTypeInfo;
import com.fasterxml.jackson.annotation.ObjectIdGenerators;
import com.fasterxml.jackson.core.*;
import com.fasterxml.jackson.databind.*;
import com.fasterxml.jackson.databind.cfg.MapperConfig;
import com.fasterxml.jackson.databind.introspect.*;
import com.fasterxml.jackson.databind.jsontype.NamedType;
import com.fasterxml.jackson.databind.jsontype.TypeResolverBuilder;
import com.fasterxml.jackson.databind.jsontype.impl.StdTypeResolverBuilder;
import com.fasterxml.jackson.databind.type.TypeFactory;
import com.fasterxml.jackson.databind.util.BeanUtil;
import com.fasterxml.jackson.databind.util.ClassUtil;
import com.fasterxml.jackson.databind.util.Converter;
import com.fasterxml.jackson.module.jaxb.deser.DataHandlerJsonDeserializer;
import com.fasterxml.jackson.module.jaxb.ser.DataHandlerJsonSerializer;
/**
* Annotation introspector that leverages JAXB annotations where applicable to JSON mapping.
* As of Jackson 2.0, most JAXB annotations are supported at least to some degree.
* Ones that are NOT yet supported are:
*
* - {@link XmlAnyAttribute} not yet used (as of 1.5) but may be in future (as an alias for @JsonAnySetter?)
*
- {@link XmlAnyElement} not yet used, may be as per [JACKSON-253]
*
- {@link javax.xml.bind.annotation.XmlAttachmentRef}: JSON does not support external attachments
*
- {@link XmlElementDecl}
*
- {@link XmlElementRefs} because Jackson doesn't have any support for 'named' collection items -- however,
* this may become partially supported as per [JACKSON-253].
*
- {@link javax.xml.bind.annotation.XmlInlineBinaryData} since the underlying concepts
* (like XOP) do not exist in JSON -- Jackson will always use inline base64 encoding as the method
*
- {@link javax.xml.bind.annotation.XmlList} because JSON does have (or necessarily need)
* method of serializing list of values as space-separated Strings
*
- {@link javax.xml.bind.annotation.XmlMimeType}
*
- {@link javax.xml.bind.annotation.XmlMixed} since JSON has no concept of mixed content
*
- {@link XmlRegistry}
*
- {@link XmlSchema} not used, unlikely to be used
*
- {@link XmlSchemaType} not used, unlikely to be used
*
- {@link XmlSchemaTypes} not used, unlikely to be used
*
- {@link XmlSeeAlso} not yet supported, but [ISSUE-1] filed to use it, so may be supported.
*
*
* Note also the following limitations:
*
*
* - Any property annotated with {@link XmlValue} will have a property named 'value' on its JSON object.
*
*
*
*
*
* A note on compatibility with Jackson XML module: since this module does not depend
* on Jackson XML module, it is bit difficult to make sure we will properly expose
* all information. But effort is made (as of version 2.3.3) to expose this information,
* even without using a specific sub-class from that project.
*
* @author Ryan Heaton
* @author Tatu Saloranta
*/
public class JaxbAnnotationIntrospector
extends AnnotationIntrospector
implements Versioned
{
private static final long serialVersionUID = 2406885758759038380L;
protected final static boolean DEFAULT_IGNORE_XMLIDREF = false;
protected final static String MARKER_FOR_DEFAULT = "##default";
protected final String _jaxbPackageName;
protected final JsonSerializer _dataHandlerSerializer;
protected final JsonDeserializer _dataHandlerDeserializer;
protected final TypeFactory _typeFactory;
protected final boolean _ignoreXmlIDREF;
/**
* @deprecated Since 2.1, use the ctor that takes TypeFactory
*/
@Deprecated
public JaxbAnnotationIntrospector() {
this(TypeFactory.defaultInstance());
}
public JaxbAnnotationIntrospector(MapperConfig config) {
this(config.getTypeFactory());
}
public JaxbAnnotationIntrospector(TypeFactory typeFactory) {
this(typeFactory, DEFAULT_IGNORE_XMLIDREF);
}
/**
* @param typeFactory Type factory used for resolving type information
* @param ignoreXmlIDREF Whether {@link XmlIDREF} annotation should be processed
* JAXB style (meaning that references are always serialized using id), or
* not (first reference as full POJO, others as ids)
*/
public JaxbAnnotationIntrospector(TypeFactory typeFactory, boolean ignoreXmlIDREF)
{
_typeFactory = (typeFactory == null)? TypeFactory.defaultInstance() : typeFactory;
_ignoreXmlIDREF = ignoreXmlIDREF;
_jaxbPackageName = XmlElement.class.getPackage().getName();
JsonSerializer dataHandlerSerializer = null;
JsonDeserializer dataHandlerDeserializer = null;
/* Data handlers included dynamically, to try to prevent issues on platforms
* with less than complete support for JAXB API
*/
try {
dataHandlerSerializer = (JsonSerializer) DataHandlerJsonSerializer.class.newInstance();
dataHandlerDeserializer = (JsonDeserializer) DataHandlerJsonDeserializer.class.newInstance();
} catch (Throwable e) {
//dataHandlers not supported...
}
_dataHandlerSerializer = dataHandlerSerializer;
_dataHandlerDeserializer = dataHandlerDeserializer;
}
/**
* Method that will return version information stored in and read from jar
* that contains this class.
*/
@Override
public Version version() {
return PackageVersion.VERSION;
}
/*
/**********************************************************
/* Extended API (XmlAnnotationIntrospector)
/**********************************************************
*/
// From XmlAnnotationIntrospector
// @Override
public String findNamespace(Annotated ann) {
String ns = null;
if (ann instanceof AnnotatedClass) {
// For classes, it must be @XmlRootElement. Also, we do
// want to use defaults from package, base class
XmlRootElement elem = findRootElementAnnotation((AnnotatedClass) ann);
if (elem != null) {
ns = elem.namespace();
}
} else {
// For others, XmlElement or XmlAttribute work (anything else?)
XmlElement elem = findAnnotation(XmlElement.class, ann, false, false, false);
if (elem != null) {
ns = elem.namespace();
}
if (ns == null || MARKER_FOR_DEFAULT.equals(ns)) {
XmlAttribute attr = findAnnotation(XmlAttribute.class, ann, false, false, false);
if (attr != null) {
ns = attr.namespace();
}
}
}
// JAXB uses marker for "not defined"
if (MARKER_FOR_DEFAULT.equals(ns)) {
ns = null;
}
return ns;
}
// From XmlAnnotationIntrospector
// @Override
public Boolean isOutputAsAttribute(Annotated ann) {
XmlAttribute attr = findAnnotation(XmlAttribute.class, ann, false, false, false);
if (attr != null) {
return Boolean.TRUE;
}
XmlElement elem = findAnnotation(XmlElement.class, ann, false, false, false);
if (elem != null) {
return Boolean.FALSE;
}
return null;
}
// From XmlAnnotationIntrospector
// @Override
public Boolean isOutputAsText(Annotated ann) {
XmlValue attr = findAnnotation(XmlValue.class, ann, false, false, false);
if (attr != null) {
return Boolean.TRUE;
}
return null;
}
/*
/**********************************************************
/* General annotations (for classes, properties)
/**********************************************************
*/
@Override
public ObjectIdInfo findObjectIdInfo(Annotated ann)
{
/* To work in the way that works with JAXB and Jackson,
* we need to do things in bit of round-about way, starting
* with AnnotatedClass, locating @XmlID property, if any.
*/
if (!(ann instanceof AnnotatedClass)) {
return null;
}
AnnotatedClass ac = (AnnotatedClass) ann;
/* Ideally, should not have to infer settings for class from
* individual fields and/or methods; but for now this
* has to do ...
*/
PropertyName idPropName = null;
method_loop:
for (AnnotatedMethod m : ac.memberMethods()) {
XmlID idProp = m.getAnnotation(XmlID.class);
if (idProp == null) {
continue;
}
switch (m.getParameterCount()) {
case 0: // getter
idPropName = findJaxbPropertyName(m, m.getRawType(), BeanUtil.okNameForGetter(m));
break method_loop;
case 1: // setter
idPropName = findJaxbPropertyName(m, m.getRawType(), BeanUtil.okNameForSetter(m));
break method_loop;
}
}
if (idPropName == null) {
for (AnnotatedField f : ac.fields()) {
XmlID idProp = f.getAnnotation(XmlID.class);
if (idProp != null) {
idPropName = findJaxbPropertyName(f, f.getRawType(), f.getName());
break;
}
}
}
if (idPropName != null) {
/* Scoping... hmmh. Could XML requires somewhat global scope, n'est pas?
* The alternative would be to use declared type of this class.
*/
Class scope = Object.class; // alternatively would use 'ac.getRawType()'
// and we will assume that there exists property thus named...
return new ObjectIdInfo(idPropName,
scope, ObjectIdGenerators.PropertyGenerator.class);
}
return null;
}
@Override
public ObjectIdInfo findObjectReferenceInfo(Annotated ann, ObjectIdInfo base)
{
if (!_ignoreXmlIDREF) {
XmlIDREF idref = ann.getAnnotation(XmlIDREF.class);
/* JAXB makes XmlIDREF mean "always as id", as far as I know.
* May need to make it configurable in future, but for not that
* is fine...
*/
if (idref != null) {
base = base.withAlwaysAsId(true);
}
}
return base;
}
/*
/**********************************************************
/* General class annotations
/**********************************************************
*/
@Override
public PropertyName findRootName(AnnotatedClass ac)
{
XmlRootElement elem = findRootElementAnnotation(ac);
if (elem != null) {
return _combineNames(elem.name(), elem.namespace(), "");
}
return null;
}
/*
@Override
public String[] findPropertiesToIgnore(Annotated a) {
// nothing in JAXB for this?
return null;
}
*/
@Override
public Boolean findIgnoreUnknownProperties(AnnotatedClass ac) {
/* 08-Nov-2009, tatus: This is bit trickier: by default JAXB
* does actually ignore all unknown properties.
* But since there is no annotation to
* specify or change this, it seems wrong to claim such setting
* is in effect. May need to revisit this issue in future
*/
return null;
}
@Override
public Boolean isIgnorableType(AnnotatedClass ac) {
// Does JAXB have any such indicators? No?
return null;
}
/*
/**********************************************************
/* General member (field, method/constructor) annotations
/**********************************************************
*/
@Override
public boolean hasIgnoreMarker(AnnotatedMember m) {
return m.getAnnotation(XmlTransient.class) != null;
}
@Override
public PropertyName findWrapperName(Annotated ann)
{
XmlElementWrapper w = findAnnotation(XmlElementWrapper.class, ann, false, false, false);
if (w != null) {
/* 18-Sep-2013, tatu: As per #24, need to take special care with empty
* String, as that should indicate here "use underlying unmodified
* property name" (that is, one NOT overridden by @JsonProperty)
*/
PropertyName name = _combineNames(w.name(), w.namespace(), "");
// clumsy, yes, but has to do:
if (!name.hasSimpleName()) {
if (ann instanceof AnnotatedMethod) {
AnnotatedMethod am = (AnnotatedMethod) ann;
String str;
if (am.getParameterCount() == 0) {
str = BeanUtil.okNameForGetter(am);
} else {
str = BeanUtil.okNameForSetter(am);
}
if (str != null) {
return name.withSimpleName(str);
}
}
return name.withSimpleName(ann.getName());
}
return name;
}
return null;
}
/*
/**********************************************************
/* Property auto-detection
/**********************************************************
*/
@Override
public VisibilityChecker findAutoDetectVisibility(AnnotatedClass ac,
VisibilityChecker checker)
{
XmlAccessType at = findAccessType(ac);
if (at == null) {
/* JAXB default is "PUBLIC_MEMBER"; however, here we should not
* override settings if there is no annotation -- that would mess
* up global baseline. Fortunately Jackson defaults are very close
* to JAXB 'PUBLIC_MEMBER' settings (considering that setters and
* getters must come in pairs)
*/
return checker;
}
// Note: JAXB does not do creator auto-detection, can (and should) ignore
switch (at) {
case FIELD: // all fields, independent of visibility; no methods
return checker.withFieldVisibility(Visibility.ANY)
.withSetterVisibility(Visibility.NONE)
.withGetterVisibility(Visibility.NONE)
.withIsGetterVisibility(Visibility.NONE)
;
case NONE: // no auto-detection
return checker.withFieldVisibility(Visibility.NONE)
.withSetterVisibility(Visibility.NONE)
.withGetterVisibility(Visibility.NONE)
.withIsGetterVisibility(Visibility.NONE)
;
case PROPERTY:
return checker.withFieldVisibility(Visibility.NONE)
.withSetterVisibility(Visibility.PUBLIC_ONLY)
.withGetterVisibility(Visibility.PUBLIC_ONLY)
.withIsGetterVisibility(Visibility.PUBLIC_ONLY)
;
case PUBLIC_MEMBER:
return checker.withFieldVisibility(Visibility.PUBLIC_ONLY)
.withSetterVisibility(Visibility.PUBLIC_ONLY)
.withGetterVisibility(Visibility.PUBLIC_ONLY)
.withIsGetterVisibility(Visibility.PUBLIC_ONLY)
;
}
return checker;
}
/**
* Method for locating JAXB {@link XmlAccessType} annotation value
* for given annotated entity, if it has one, or inherits one from
* its ancestors (in JAXB sense, package etc). Returns null if
* nothing has been explicitly defined.
*/
protected XmlAccessType findAccessType(Annotated ac)
{
XmlAccessorType at = findAnnotation(XmlAccessorType.class, ac, true, true, true);
return (at == null) ? null : at.value();
}
/*
/**********************************************************
/* Class annotations for PM type handling (1.5+)
/**********************************************************
*/
@Override
public TypeResolverBuilder findTypeResolver(MapperConfig config,
AnnotatedClass ac, JavaType baseType)
{
// no per-class type resolvers, right?
return null;
}
@Override
public TypeResolverBuilder findPropertyTypeResolver(MapperConfig config,
AnnotatedMember am, JavaType baseType)
{
/* First: @XmlElements and @XmlElementRefs only applies type for immediate property, if it
* is NOT a structured type.
*/
if (baseType.isContainerType()) return null;
return _typeResolverFromXmlElements(am);
}
@Override
public TypeResolverBuilder findPropertyContentTypeResolver(MapperConfig config,
AnnotatedMember am, JavaType containerType)
{
/* First: let's ensure property is a container type: caller should have
* verified but just to be sure
*/
if (!containerType.isContainerType()) {
throw new IllegalArgumentException("Must call method with a container type (got "+containerType+")");
}
return _typeResolverFromXmlElements(am);
}
protected TypeResolverBuilder _typeResolverFromXmlElements(AnnotatedMember am)
{
/* If simple type, @XmlElements and @XmlElementRefs are applicable.
* Note: @XmlElement and @XmlElementRef are NOT handled here, since they
* are handled specifically as non-polymorphic indication
* of the actual type
*/
XmlElements elems = findAnnotation(XmlElements.class, am, false, false, false);
XmlElementRefs elemRefs = findAnnotation(XmlElementRefs.class, am, false, false, false);
if (elems == null && elemRefs == null) {
return null;
}
TypeResolverBuilder b = new StdTypeResolverBuilder();
// JAXB always uses type name as id
b = b.init(JsonTypeInfo.Id.NAME, null);
// and let's consider WRAPPER_OBJECT to be canonical inclusion method
b = b.inclusion(JsonTypeInfo.As.WRAPPER_OBJECT);
return b;
}
@Override
public List findSubtypes(Annotated a)
{
// No package/superclass defaulting (only used with fields, methods)
XmlElements elems = findAnnotation(XmlElements.class, a, false, false, false);
ArrayList result = null;
if (elems != null) {
result = new ArrayList();
for (XmlElement elem : elems.value()) {
String name = elem.name();
if (MARKER_FOR_DEFAULT.equals(name)) name = null;
result.add(new NamedType(elem.type(), name));
}
} else {
XmlElementRefs elemRefs = findAnnotation(XmlElementRefs.class, a, false, false, false);
if (elemRefs != null) {
result = new ArrayList();
for (XmlElementRef elemRef : elemRefs.value()) {
Class refType = elemRef.type();
// only good for types other than JAXBElement (which is XML based)
if (!JAXBElement.class.isAssignableFrom(refType)) {
// [JACKSON-253] first consider explicit name declaration
String name = elemRef.name();
if (name == null || MARKER_FOR_DEFAULT.equals(name)) {
XmlRootElement rootElement = (XmlRootElement) refType.getAnnotation(XmlRootElement.class);
if (rootElement != null) {
name = rootElement.name();
}
}
if (name == null || MARKER_FOR_DEFAULT.equals(name)) {
name = Introspector.decapitalize(refType.getSimpleName());
}
result.add(new NamedType(refType, name));
}
}
}
}
// [Issue#1] check @XmlSeeAlso as well.
/* 17-Aug-2012, tatu: But wait! For structured type, what we really is
* value (content) type!
* If code below does not make full (or any) sense, do not despair -- it
* is wrong. Yet it works. The call sequence before we get here is mangled,
* its logic twisted... but as Dire Straits put it: "That ain't working --
* that's The Way You Do It!"
*/
XmlSeeAlso ann = a.getAnnotation(XmlSeeAlso.class);
if (ann != null) {
if (result == null) {
result = new ArrayList();
}
for (Class cls : ann.value()) {
result.add(new NamedType(cls));
}
}
return result;
}
@Override
public String findTypeName(AnnotatedClass ac) {
XmlType type = findAnnotation(XmlType.class, ac, false, false, false);
if (type != null) {
String name = type.name();
if (!MARKER_FOR_DEFAULT.equals(name)) return name;
}
return null;
}
/*
/**********************************************************
/* Serialization: general annotations
/**********************************************************
*/
@Override
public JsonSerializer findSerializer(Annotated am)
{
final Class type = _rawSerializationType(am);
/*
// As per [JACKSON-722], more checks for structured types
XmlAdapter adapter = findAdapter(am, true, type);
if (adapter != null) {
boolean fromClass = !(am instanceof AnnotatedMember);
// Ugh. Must match to see if adapter's bounded type (result to map to) matches property type
if (isContainerType(type)) {
Class bt = findAdapterBoundType(adapter);
if (bt.isAssignableFrom(type)) {
return new XmlAdapterJsonSerializer(adapter, fromClass);
}
// Note: if used for value type, handled in different place
} else {
return new XmlAdapterJsonSerializer(adapter, fromClass);
}
}
*/
// [JACKSON-150]: add support for additional core XML types needed by JAXB
if (type != null) {
if (_dataHandlerSerializer != null && isDataHandler(type)) {
return _dataHandlerSerializer;
}
}
return null;
}
/**
* Determines whether the type is assignable to class javax.activation.DataHandler without requiring that class
* to be on the classpath.
*
* @param type The type.
* @return Whether the type is assignable to class javax.activation.DataHandler
*/
private boolean isDataHandler(Class type)
{
return type != null && (Object.class != type)
&& (("javax.activation.DataHandler".equals(type.getName()) || isDataHandler(type.getSuperclass())));
}
@Override
public Object findContentSerializer(Annotated a) {
return null;
}
@Override
public Class findSerializationType(Annotated a)
{
// As per [JACKSON-416], need to allow coercing serialization type...
/* false for class, package, super-class, since annotation can
* only be attached to fields and methods
*/
// Note: caller does necessary sub/supertype checks
XmlElement annotation = findAnnotation(XmlElement.class, a, false, false, false);
if (annotation == null || annotation.type() == XmlElement.DEFAULT.class) {
return null;
}
/* [JACKSON-436]: Apparently collection types (array, Collection, maybe Map)
* require type definition to relate to contents, not collection type
* itself. So; we must return null here for those cases, and modify content
* type on another method.
*/
Class rawPropType = _rawSerializationType(a);
if (isContainerType(rawPropType)) {
return null;
}
/* [JACKSON-288]: Further, JAXB has peculiar notion of declaring intermediate
* (and, for the most part, useless) type... So basically we better
* just ignore type if there is adapter annotation
* (we could check to see if intermediate type is compatible, but let's not yet
* bother)
*
*/
Class allegedType = annotation.type();
if (a.getAnnotation(XmlJavaTypeAdapter.class) != null) {
return null;
}
return allegedType;
}
/**
* Implementation of this method is slightly tricky, given that JAXB defaults differ
* from Jackson defaults. As of version 1.5 and above, this is resolved by honoring
* Jackson defaults (which are configurable), and only using JAXB explicit annotations.
*/
@Override
public JsonInclude.Include findSerializationInclusion(Annotated a, JsonInclude.Include defValue)
{
XmlElementWrapper w = a.getAnnotation(XmlElementWrapper.class);
if (w != null) {
return w.nillable() ? JsonInclude.Include.ALWAYS : JsonInclude.Include.NON_NULL;
}
XmlElement e = a.getAnnotation(XmlElement.class);
if (e != null) {
return e.nillable() ? JsonInclude.Include.ALWAYS : JsonInclude.Include.NON_NULL;
}
/* [JACKSON-256]: better pass default value through, if no explicit direction indicating
* otherwise
*/
return defValue;
}
/*
/**********************************************************
/* Serialization: class annotations
/**********************************************************
*/
@Override
public String[] findSerializationPropertyOrder(AnnotatedClass ac)
{
// @XmlType.propOrder fits the bill here:
XmlType type = findAnnotation(XmlType.class, ac, true, true, true);
if (type == null) {
return null;
}
String[] order = type.propOrder();
if (order == null || order.length == 0) {
return null;
}
return order;
}
@Override
public Boolean findSerializationSortAlphabetically(AnnotatedClass ac) {
// Yup, XmlAccessorOrder can provide this...
XmlAccessorOrder order = findAnnotation(XmlAccessorOrder.class, ac, true, true, true);
return (order == null) ? null : (order.value() == XmlAccessOrder.ALPHABETICAL);
}
@Override
public Object findSerializationConverter(Annotated a)
{
Class serType = _rawSerializationType(a);
// Can apply to both container and regular type; no difference yet here
XmlAdapter adapter = findAdapter(a, true, serType);
if (adapter != null) {
return _converter(adapter, true);
}
return null;
}
@Override
public Object findSerializationContentConverter(AnnotatedMember a)
{
// But this one only applies to structured (container) types:
Class serType = _rawSerializationType(a);
if (isContainerType(serType)) {
XmlAdapter adapter = _findContentAdapter(a, true);
if (adapter != null) {
return _converter(adapter, true);
}
}
return null;
}
/*
/**********************************************************
/* Serialization: property annotations
/**********************************************************
*/
@Override
public PropertyName findNameForSerialization(Annotated a)
{
// [Issue#69], need bit of delegation (note: copy of super-class functionality)
// !!! TODO: in 2.2, remove old methods?
if (a instanceof AnnotatedMethod) {
AnnotatedMethod am = (AnnotatedMethod) a;
if (!isVisible(am)) {
return null;
}
return findJaxbPropertyName(am, am.getRawType(),
BeanUtil.okNameForGetter(am));
}
if (a instanceof AnnotatedField) {
AnnotatedField af = (AnnotatedField) a;
if (!isVisible(af)) {
return null;
}
PropertyName name = findJaxbPropertyName(af, af.getRawType(), null);
/* This may seem wrong, but since JAXB field auto-detection
* needs to find even non-public fields (if enabled by
* JAXB access type), we need to return name like so:
*/
if (name == null) {
return new PropertyName(af.getName());
}
return name;
}
return null;
}
@Deprecated
@Override
public String findSerializationName(AnnotatedMethod am)
{
if (!isVisible(am)) {
return null;
}
return _propertyNameToString(findJaxbPropertyName(am, am.getRawType(), BeanUtil.okNameForGetter(am)));
}
@Deprecated
@Override
public String findSerializationName(AnnotatedField af)
{
if (!isVisible(af)) {
return null;
}
PropertyName name = findJaxbPropertyName(af, af.getRawType(), null);
/* This may seem wrong, but since JAXB field auto-detection
* needs to find even non-public fields (if enabled by
* JAXB access type), we need to return name like so:
*/
if (name == null) {
return af.getName();
}
return _propertyNameToString(name);
}
@Override
public boolean hasAsValueAnnotation(AnnotatedMethod am)
{
//since jaxb says @XmlValue can exist with attributes, this won't map as a JSON value.
return false;
}
/**
*
* !!! 12-Oct-2009, tatu: This is hideously slow implementation,
* called potentially for every single enum value being
* serialized. Should improve...
*/
@Override
public String findEnumValue(Enum e)
{
Class enumClass = e.getDeclaringClass();
String enumValue = e.name();
try {
XmlEnumValue xmlEnumValue = enumClass.getDeclaredField(enumValue).getAnnotation(XmlEnumValue.class);
return (xmlEnumValue != null) ? xmlEnumValue.value() : enumValue;
} catch (NoSuchFieldException e1) {
throw new IllegalStateException("Could not locate Enum entry '"+enumValue+"' (Enum class "+enumClass.getName()+")", e1);
}
}
/*
/**********************************************************
/* Deserialization: general annotations
/**********************************************************
*/
@Override
public Object findDeserializer(Annotated am)
{
final Class type = _rawDeserializationType(am);
/*
// As per [JACKSON-722], more checks for structured types
XmlAdapter adapter = findAdapter(am, true, type);
if (adapter != null) {
// Ugh. Must match to see if adapter's bounded type (result to map to) matches property type
if (isContainerType(type)) {
if (adapterTypeMatches(adapter, type)) {
return new XmlAdapterJsonDeserializer(adapter);
}
} else {
return new XmlAdapterJsonDeserializer(adapter);
}
}
*/
// [JACKSON-150]: add support for additional core XML types needed by JAXB
if (type != null) {
if (_dataHandlerDeserializer != null && isDataHandler(type)) {
return _dataHandlerDeserializer;
}
}
return null;
}
@Override
public Object findKeyDeserializer(Annotated am) {
// Is there something like this in JAXB?
return null;
}
@Override
public Object findContentDeserializer(Annotated a) {
return null;
}
/**
* JAXB does allow specifying (more) concrete class for
* deserialization by using \@XmlElement annotation.
*/
@Override
public Class findDeserializationType(Annotated a, JavaType baseType)
{
/* First: only applicable for non-structured types (yes, JAXB annotations
* are tricky)
*/
if (!baseType.isContainerType()) {
return _doFindDeserializationType(a, baseType);
}
return null;
}
//public Class findDeserializationKeyType(Annotated am, JavaType baseKeyType)
@Override
public Class findDeserializationContentType(Annotated a, JavaType baseContentType)
{
/* 15-Feb-2010, tatus: JAXB usage of XmlElement/XmlElements is really
* confusing: sometimes it's for type (non-container types), sometimes for
* contents (container) types. I guess it's frugal to reuse these... but
* I think it's rather short-sighted. Whatever, it is what it is, and here
* we are being given content type explicitly.
*/
return _doFindDeserializationType(a, baseContentType);
}
protected Class _doFindDeserializationType(Annotated a, JavaType baseType)
{
/* As per [JACKSON-288], @XmlJavaTypeAdapter will complicate handling of type
* information; basically we better just ignore type we might find here altogether
* in that case
*/
if (a.hasAnnotation(XmlJavaTypeAdapter.class)) {
return null;
}
/* false for class, package, super-class, since annotation can
* only be attached to fields and methods
*/
XmlElement annotation = findAnnotation(XmlElement.class, a, false, false, false);
if (annotation != null) {
Class type = annotation.type();
if (type != XmlElement.DEFAULT.class) {
return type;
}
}
/* 16-Feb-2010, tatu: May also have annotation associated with field, not method
* itself... and findAnnotation() won't find that (nor property descriptor)
*/
/*
if (a instanceof AnnotatedMethod) {
AnnotatedMethod am = (AnnotatedMethod) a;
// Hmmhh. does name have to match?
String propName = am.getName();
annotation = findFieldAnnotation(XmlElement.class, am.getDeclaringClass(), propName);
if (annotation != null && annotation.type() != XmlElement.DEFAULT.class) {
return annotation.type();
}
}
*/
return null;
}
/*
/**********************************************************
/* Deserialization: property annotations
/**********************************************************
*/
@Override
public PropertyName findNameForDeserialization(Annotated a)
{
// [Issue#69], need bit of delegation -- note: copy from super-class
// TODO: should simplify, messy.
if (a instanceof AnnotatedMethod) {
AnnotatedMethod am = (AnnotatedMethod) a;
if (!isVisible((AnnotatedMethod) a)) {
return null;
}
Class rawType = am.getRawParameterType(0);
return findJaxbPropertyName(am, rawType, BeanUtil.okNameForSetter(am));
}
if (a instanceof AnnotatedField) {
AnnotatedField af = (AnnotatedField) a;
if (!isVisible(af)) {
return null;
}
PropertyName name = findJaxbPropertyName(af, af.getRawType(), null);
/* This may seem wrong, but since JAXB field auto-detection
* needs to find even non-public fields (if enabled by
* JAXB access type), we need to return name like so:
*/
if (name == null) {
return new PropertyName(af.getName());
}
return name;
}
return null;
/*
if (name != null) {
if (name.length() == 0) { // empty String means 'default'
return PropertyName.USE_DEFAULT;
}
return new PropertyName(name);
}
*/
}
@Deprecated
@Override
public String findDeserializationName(AnnotatedMethod am)
{
if (!isVisible(am)) {
return null;
}
Class rawType = am.getRawParameterType(0);
return _propertyNameToString(findJaxbPropertyName(am, rawType, BeanUtil.okNameForSetter(am)));
}
@Deprecated
@Override
public String findDeserializationName(AnnotatedField af)
{
if (!isVisible(af)) {
return null;
}
PropertyName name = findJaxbPropertyName(af, af.getRawType(), null);
/* This may seem wrong, but since JAXB field auto-detection
* needs to find even non-public fields (if enabled by
* JAXB access type), we need to return name like so:
*/
if (name == null) {
return af.getName();
}
return _propertyNameToString(name);
}
/*
public String findDeserializationName(AnnotatedParameter param)
{
// JAXB has nothing like this...
return null;
}
*/
@Override
public boolean hasAnySetterAnnotation(AnnotatedMethod am)
{
//(ryan) JAXB has @XmlAnyAttribute and @XmlAnyElement annotations, but they're not applicable in this case
// because JAXB says those annotations are only applicable to methods with specific signatures
// that Jackson doesn't support (Jackson's any setter needs 2 arguments, name and value, whereas
// JAXB expects use of Map
return false;
}
@Override
public boolean hasCreatorAnnotation(Annotated am)
{
return false;
}
@Override
public Boolean hasRequiredMarker(AnnotatedMember m) {
XmlElement annotation = m.getAnnotation(XmlElement.class);
return annotation == null ? null : Boolean.valueOf(annotation.required());
}
@Override
public Object findDeserializationConverter(Annotated a)
{
// One limitation: for structured types this is done later on
Class deserType = _rawDeserializationType(a);
if (isContainerType(deserType)) {
XmlAdapter adapter = findAdapter(a, true, deserType);
if (adapter != null) {
return _converter(adapter, false);
}
} else {
XmlAdapter adapter = findAdapter(a, true, deserType);
if (adapter != null) {
return _converter(adapter, false);
}
}
return null;
}
@Override
public Object findDeserializationContentConverter(AnnotatedMember a)
{
// conversely, here we only apply this to container types:
Class deserType = _rawDeserializationType(a);
if (isContainerType(deserType)) {
XmlAdapter adapter = _findContentAdapter(a, true);
if (adapter != null) {
return _converter(adapter, false);
}
}
return null;
}
/*
/**********************************************************
/* Helper methods (non-API)
/**********************************************************
*/
/**
* Whether the specified field is invisible, per the JAXB visibility rules.
*
* @param f The field.
* @return Whether the field is invisible.
*/
private boolean isVisible(AnnotatedField f)
{
// TODO: use AnnotatedField's annotations directly
for (Annotation annotation : f.getAnnotated().getDeclaredAnnotations()) {
if (isJAXBAnnotation(annotation)) {
return true;
}
}
XmlAccessType accessType = XmlAccessType.PUBLIC_MEMBER;
XmlAccessorType at = findAnnotation(XmlAccessorType.class, f, true, true, true);
if (at != null) {
accessType = at.value();
}
if (accessType == XmlAccessType.FIELD) {
return true;
}
if (accessType == XmlAccessType.PUBLIC_MEMBER) {
return Modifier.isPublic(f.getAnnotated().getModifiers());
}
return false;
}
private boolean isVisible(AnnotatedMethod m)
{
// TODO: use AnnotatedField's annotations directly
for (Annotation annotation : m.getAnnotated().getDeclaredAnnotations()) {
if (isJAXBAnnotation(annotation)) {
return true;
}
}
XmlAccessType accessType = XmlAccessType.PUBLIC_MEMBER;
XmlAccessorType at = findAnnotation(XmlAccessorType.class, m, true, true, true);
if (at != null) {
accessType = at.value();
}
if (accessType == XmlAccessType.PROPERTY || accessType == XmlAccessType.PUBLIC_MEMBER) {
return Modifier.isPublic(m.getModifiers());
}
return false;
}
/**
* Finds an annotation associated with given annotatable thing; or if
* not found, a default annotation it may have (from super class, package
* and so on)
*
* @param annotationClass the annotation class.
* @param annotated The annotated element.
* @param includePackage Whether the annotation can be found on the package of the annotated element.
* @param includeClass Whether the annotation can be found on the class of the annotated element.
* @param includeSuperclasses Whether the annotation can be found on any superclasses of the class of the annotated element.
* @return The annotation, or null if not found.
*/
private A findAnnotation(Class annotationClass, Annotated annotated,
boolean includePackage, boolean includeClass, boolean includeSuperclasses)
{
A annotation = annotated.getAnnotation(annotationClass);
if (annotation != null) {
return annotation;
}
Class memberClass = null;
/* 13-Feb-2011, tatu: [JACKSON-495] - need to handle AnnotatedParameter
* bit differently, since there is no JDK counterpart. We can still
* access annotations directly, just using different calls.
*/
if (annotated instanceof AnnotatedParameter) {
memberClass = ((AnnotatedParameter) annotated).getDeclaringClass();
} else {
AnnotatedElement annType = annotated.getAnnotated();
if (annType instanceof Member) {
memberClass = ((Member) annType).getDeclaringClass();
if (includeClass) {
annotation = (A) memberClass.getAnnotation(annotationClass);
if (annotation != null) {
return annotation;
}
}
} else if (annType instanceof Class) {
memberClass = (Class) annType;
} else {
throw new IllegalStateException("Unsupported annotated member: " + annotated.getClass().getName());
}
}
if (memberClass != null) {
if (includeSuperclasses) {
Class superclass = memberClass.getSuperclass();
while (superclass != null && superclass != Object.class) {
annotation = (A) superclass.getAnnotation(annotationClass);
if (annotation != null) {
return annotation;
}
superclass = superclass.getSuperclass();
}
}
if (includePackage) {
Package pkg = memberClass.getPackage();
if (pkg != null) {
return memberClass.getPackage().getAnnotation(annotationClass);
}
}
}
return null;
}
/*
/**********************************************************
/* Helper methods for bean property introspection
/**********************************************************
*/
/**
* An annotation is handled if it's in the same package as @XmlElement, including subpackages.
*
* @param ann The annotation.
* @return Whether the annotation is in the JAXB package.
*/
protected boolean isJAXBAnnotation(Annotation ann)
{
/* note: class we want is the annotation class, not instance
* (since annotation instances, like enums, may be of different
* physical type!)
*/
Class cls = ann.annotationType();
Package pkg = cls.getPackage();
String pkgName = (pkg != null) ? pkg.getName() : cls.getName();
if (pkgName.startsWith(_jaxbPackageName)) {
return true;
}
return false;
}
private static PropertyName findJaxbPropertyName(Annotated ae, Class aeType, String defaultName)
{
XmlAttribute attribute = ae.getAnnotation(XmlAttribute.class);
if (attribute != null) {
return _combineNames(attribute.name(), attribute.namespace(), defaultName);
}
XmlElement element = ae.getAnnotation(XmlElement.class);
if (element != null) {
return _combineNames(element.name(), element.namespace(), defaultName);
}
/* 11-Sep-2012, tatu: Wrappers should not be automatically used for renaming.
* At least not here (databinding core can do it if feature enabled).
*/
/*
XmlElementWrapper elementWrapper = ae.getAnnotation(XmlElementWrapper.class);
if (elementWrapper != null) {
return _combineNames(elementWrapper.name(), elementWrapper.namespace(), defaultName);
}
*/
XmlElementRef elementRef = ae.getAnnotation(XmlElementRef.class);
if (elementRef != null) {
if (!MARKER_FOR_DEFAULT.equals(elementRef.name())) {
return _combineNames(elementRef.name(), elementRef.namespace(), defaultName);
}
if (aeType != null) {
XmlRootElement rootElement = (XmlRootElement) aeType.getAnnotation(XmlRootElement.class);
if (rootElement != null) {
String name = rootElement.name();
if (!MARKER_FOR_DEFAULT.equals(name)) {
return _combineNames(name, rootElement.namespace(), defaultName);
}
// Is there a namespace there to use? Probably not?
return new PropertyName(Introspector.decapitalize(aeType.getSimpleName()));
}
}
}
XmlValue valueInfo = ae.getAnnotation(XmlValue.class);
if (valueInfo != null) {
return new PropertyName("value");
}
return null;
}
private static PropertyName _combineNames(String localName, String namespace,
String defaultName)
{
if (MARKER_FOR_DEFAULT.equals(localName)) {
if (MARKER_FOR_DEFAULT.equals(namespace)) {
return new PropertyName(defaultName);
}
return new PropertyName(defaultName, namespace);
}
if (MARKER_FOR_DEFAULT.equals(namespace)) {
return new PropertyName(localName);
}
return new PropertyName(localName, namespace);
}
private XmlRootElement findRootElementAnnotation(AnnotatedClass ac)
{
// Yes, check package, no class (already included), yes superclasses
return findAnnotation(XmlRootElement.class, ac, true, false, true);
}
/**
* Finds the XmlAdapter for the specified annotation.
*
* @param am The annotated element.
* @param forSerialization If true, adapter for serialization; if false, for deserialization
* @param type
*
* @return The adapter, or null if none.
*/
private XmlAdapter findAdapter(Annotated am, boolean forSerialization,
Class type)
{
// First of all, are we looking for annotations for class?
if (am instanceof AnnotatedClass) {
return findAdapterForClass((AnnotatedClass) am, forSerialization);
}
// Otherwise for a member. First, let's figure out type of property
XmlJavaTypeAdapter adapterInfo = findAnnotation(XmlJavaTypeAdapter.class, am, true, false, false);
if (adapterInfo != null) {
XmlAdapter adapter = checkAdapter(adapterInfo, type, forSerialization);
if (adapter != null) {
return adapter;
}
}
XmlJavaTypeAdapters adapters = findAnnotation(XmlJavaTypeAdapters.class, am, true, false, false);
if (adapters != null) {
for (XmlJavaTypeAdapter info : adapters.value()) {
XmlAdapter adapter = checkAdapter(info, type, forSerialization);
if (adapter != null) {
return adapter;
}
}
}
return null;
}
@SuppressWarnings("unchecked")
private final XmlAdapter checkAdapter(XmlJavaTypeAdapter adapterInfo, Class typeNeeded,
boolean forSerialization)
{
// if annotation has no type, it's applicable; if it has, must match
Class adaptedType = adapterInfo.type();
if (adaptedType == XmlJavaTypeAdapter.DEFAULT.class) {
JavaType[] params = _typeFactory.findTypeParameters(adapterInfo.value(), XmlAdapter.class);
adaptedType = params[forSerialization ? 1 : 0].getRawClass();
}
if (adaptedType.isAssignableFrom(typeNeeded)) {
@SuppressWarnings("rawtypes")
Class cls = adapterInfo.value();
// true -> yes, force access if need be
return ClassUtil.createInstance(cls, true);
}
return null;
}
@SuppressWarnings("unchecked")
private XmlAdapter findAdapterForClass(AnnotatedClass ac, boolean forSerialization)
{
/* As per [JACKSON-411], XmlJavaTypeAdapter should not be inherited from super-class.
* It would still be nice to be able to use mix-ins; but unfortunately we seem to lose
* knowledge of class that actually declared the annotation. Thus, we'll only accept
* declaration from specific class itself.
*/
XmlJavaTypeAdapter adapterInfo = ac.getAnnotated().getAnnotation(XmlJavaTypeAdapter.class);
if (adapterInfo != null) { // should we try caching this?
@SuppressWarnings("rawtypes")
Class cls = adapterInfo.value();
// true -> yes, force access if need be
return ClassUtil.createInstance(cls, true);
}
return null;
}
protected final TypeFactory getTypeFactory() {
return _typeFactory;
}
/**
* Helper method used to distinguish structured types (arrays, Lists, Maps),
* which with JAXB use different rules for defining content types.
*/
private boolean isContainerType(Class raw)
{
return raw.isArray() || Collection.class.isAssignableFrom(raw)
|| Map.class.isAssignableFrom(raw);
}
private boolean adapterTypeMatches(XmlAdapter adapter, Class targetType)
{
return findAdapterBoundType(adapter).isAssignableFrom(targetType);
}
private Class findAdapterBoundType(XmlAdapter adapter)
{
TypeFactory tf = getTypeFactory();
JavaType adapterType = tf.constructType(adapter.getClass());
JavaType[] params = tf.findTypeParameters(adapterType, XmlAdapter.class);
// should not happen, except if our type resolution has a flaw, but:
if (params == null || params.length < 2) {
return Object.class;
}
return params[1].getRawClass();
}
protected XmlAdapter _findContentAdapter(Annotated ann,
boolean forSerialization)
{
Class rawType = forSerialization ?
_rawSerializationType(ann) : _rawDeserializationType(ann);
// and let's assume this only applies as member annotation:
if (isContainerType(rawType) && (ann instanceof AnnotatedMember)) {
AnnotatedMember member = (AnnotatedMember) ann;
JavaType fullType = forSerialization ?
_fullSerializationType(member) : _fullDeserializationType(member);
Class contentType = fullType.getContentType().getRawClass();
XmlAdapter adapter = findAdapter(member, forSerialization, contentType);
if (adapter != null && adapterTypeMatches(adapter, contentType)) {
return adapter;
}
}
return null;
}
protected String _propertyNameToString(PropertyName n)
{
return (n == null) ? null : n.getSimpleName();
}
/**
* @since 2.1.2
*/
protected Class _rawDeserializationType(Annotated a)
{
if (a instanceof AnnotatedMethod) {
AnnotatedMethod am = (AnnotatedMethod) a;
// 27-Nov-2012, tatu: Bit nasty, as we are assuming
// things about method signatures here... but has to do
if (am.getParameterCount() == 1) {
return am.getRawParameterType(0);
}
}
return a.getRawType();
}
/**
* @since 2.1.2
*/
protected JavaType _fullDeserializationType(AnnotatedMember am)
{
if (am instanceof AnnotatedMethod) {
AnnotatedMethod method = (AnnotatedMethod) am;
// 27-Nov-2012, tatu: Bit nasty, as we are assuming
// things about method signatures here... but has to do
if (method.getParameterCount() == 1) {
return getTypeFactory().constructType(((AnnotatedMethod) am).getGenericParameterType(0),
am.getDeclaringClass());
}
}
return getTypeFactory().constructType(am.getGenericType(),
am.getDeclaringClass());
}
/**
* @since 2.1.2
*/
protected Class _rawSerializationType(Annotated a)
{
// 27-Nov-2012, tatu: No work-arounds needed yet...
return a.getRawType();
}
/**
* @since 2.1.2
*/
protected JavaType _fullSerializationType(AnnotatedMember am)
{
return getTypeFactory().constructType(am.getGenericType(),
am.getDeclaringClass());
}
protected Converter _converter(XmlAdapter adapter, boolean forSerialization)
{
JavaType[] pt = getTypeFactory().findTypeParameters(adapter.getClass(), XmlAdapter.class);
// Order of type parameters for Converter is reverse between serializer, deserializer,
// whereas JAXB just uses single ordering
if (forSerialization) {
return new AdapterConverter(adapter, pt[1], pt[0], forSerialization);
}
return new AdapterConverter(adapter, pt[0], pt[1], forSerialization);
}
}