Latest revision as of 11:35, 5 June 2012

Design Documentation: JAXB RI Extensions

ER 359251

In the JAXB RI, developed by Sun, there are a series of "proprietary" extensions that are available to provide advanced JAXB functionality outside of the JAXB spec (these extension classes reside in the com.sun.xml.bind and com.sun.internal.xml.bind packages).

This page will track the various JAXB Extensions that we want to bring into MOXy.

See: http://jaxb.java.net/2.2/docs/vendorProperties.html

Goal

Our intent is to support these extensions as is, so that MOXy can be a drop in replacement for the JAXB RI.

Completed

Object Identity Config (2.4 only)

• COMPLETE
• Documentation: http://wiki.eclipse.org/EclipseLink/Development/379706
• Bug: https://bugs.eclipse.org/bugs/show_bug.cgi?id=379706

XML Headers (2.4 only)

• COMPLETE
• DOCS NEEDED
• Bug: https://bugs.eclipse.org/bugs/show_bug.cgi?id=379704

AccessorFactory (2.4 only)

• COMPLETE
• Documentation: http://wiki.eclipse.org/EclipseLink/Development/372403
• Bug: https://bugs.eclipse.org/bugs/show_bug.cgi?id=372403
• Added for the benefit of Hibernate users
• Difficult to implement, no documentation, can be replaced by @XmlJavaTypeAdapter

CycleRecoverable (2.4 only)

• COMPLETE
• Documentation: http://wiki.eclipse.org/EclipseLink/Development/372404
• Bug: https://bugs.eclipse.org/bugs/show_bug.cgi?id=372404
• http://jaxb.java.net/guide/Mapping_cyclic_references_to_XML.html
• http://www.java.net/node/654639

XmlLocation (2.4 only)

• COMPLETE
• Documentation: http://wiki.eclipse.org/EclipseLink/Development/355766
• Bug: https://bugs.eclipse.org/bugs/show_bug.cgi?id=355766
• Would give the user more information after unmarshalling, could be useful in WSDL environments, or other times when JAXB XML data may be embedded within other XML

NamespacePrefixMapper (2.3.3 and 2.4)

• COMPLETE
• Documentation: http://wiki.eclipse.org/EclipseLink/Development/357266
• Background Info: http://jaxb.java.net/2.2/docs/vendorProperties.html#prefixmapper
• Bug: https://bugs.eclipse.org/bugs/show_bug.cgi?id=357266
• Allows the user to customize the namespace prefixes that are generated
• Custom Mapper would be provided via Marshaller properties

IDResolver (2.3.3 and 2.4)

• COMPLETE
• Documentation: http://wiki.eclipse.org/EclipseLink/Development/360249
• Bug: https://bugs.eclipse.org/bugs/show_bug.cgi?id=360249
• Exampe: http://weblogs.java.net/blog/kohsuke/archive/2005/08/pluggable_ididr.html

IndentString (2.3.3 and 2.4)

• COMPLETE
• Background Info: http://jaxb.java.net/2.2/docs/vendorProperties.html#indent
• Documentation: http://wiki.eclipse.org/EclipseLink/Development/370574
• Bug: https://bugs.eclipse.org/bugs/show_bug.cgi?id=370574
• Allows the user to customize the indenting that happens in marshalled documents

CharacterEscapeHandler (2.3.3 and 2.4)

• COMPLETE
• Background Info: http://jaxb.java.net/2.2/docs/vendorProperties.html#charescape
• Documentation: http://wiki.eclipse.org/EclipseLink/Development/370589
• Bug: https://bugs.eclipse.org/bugs/show_bug.cgi?id=370589
• Allows the user to customize the escaping of special characters
• Not applicable when marshalling to: XMLStreamWriter, XMLEventWriter, ContentHandler, Node

XML Declaration Control (2.3.3 and 2.4)

• COMPLETE
• Background Info: http://jaxb.java.net/2.2/docs/vendorProperties.html#xmldecl
• Opposite of Marshaller.JAXB_FRAGMENT (no bug entered)

Test Get/Set For All Properties

• We need to ensure that we test getting all these properties as well as setting them.
• COMPLETE : org.eclipse.persistence.testing.jaxb.properties.PropertyTestCases

Future

The following items are of low priority and there is no current plan to implement these.

Canonicalization

• Bug: https://bugs.eclipse.org/bugs/show_bug.cgi?id=379705

OverrideAnnotationOf

• Allows for more flexible mapping (?)
• Doesn't work if the field to override is not named "content", customization doesn't work (RI)
• mgrebac: "The above annotation was actually used only for a very specific case of supporting usecase with XmlMixed, and is actually even not expected to be used outside of xjc."

Locatable

• Seems to be mainly used internally by the RI
• Interface only defines get methods... is user resonsible for setting up com.sun.xml.bind.v2.runtime.Location objects? Is this even meant to be a user-feature?
• mgrebac: "No, this is as well not meant to be user feature, is usable for xjc itself and plugins to point to correct source when there is a failure."

XmlIsSet

• Doesn't work in RI
• Deprecated in the RI, no need to implement since we have XmlIsSetNullPolicy?
• mgrebac: "Correct - deprecated, unused, we shall be able to remove it safely at this point actually."