Jump to: navigation, search

Difference between revisions of "EclipseLink/Development/359251"

 
(12 intermediate revisions by the same user not shown)
Line 8: Line 8:
 
This page will track the various JAXB Extensions that we want to bring into MOXy.  
 
This page will track the various JAXB Extensions that we want to bring into MOXy.  
  
'''Jan. 2012''': Other extension properties: http://jaxb.java.net/2.2/docs/vendorProperties.html
+
See: http://jaxb.java.net/2.2/docs/vendorProperties.html
  
 
== Goal ==
 
== Goal ==
Line 14: Line 14:
 
Our intent is to support these extensions as is, so that MOXy can be a drop in replacement for the JAXB RI.
 
Our intent is to support these extensions as is, so that MOXy can be a drop in replacement for the JAXB RI.
  
== To Do ==
+
== Completed ==
  
=== XML Headers ===
+
=== Object Identity Config (2.4 only) ===
 
+
* Bug: https://bugs.eclipse.org/bugs/show_bug.cgi?id=379704
+
 
+
=== Canonicalization ===
+
 
+
* Bug: https://bugs.eclipse.org/bugs/show_bug.cgi?id=379705
+
 
+
=== Object Identity Config ===
+
  
 +
* '''COMPLETE'''
 +
* Documentation: http://wiki.eclipse.org/EclipseLink/Development/379706
 
* Bug: https://bugs.eclipse.org/bugs/show_bug.cgi?id=379706
 
* Bug: https://bugs.eclipse.org/bugs/show_bug.cgi?id=379706
  
== Completed ==
+
=== XML Headers (2.4 only) ===
  
The following items have been checked into EclipseLink 2.3.3 and 2.4.0.
+
* '''COMPLETE'''
 
+
* '''DOCS NEEDED'''
=== Test Get/Set For All Properties ===
+
* Bug: https://bugs.eclipse.org/bugs/show_bug.cgi?id=379704
 
+
* We need to ensure that we test getting all these properties as well as setting them.
+
* '''COMPLETE''' : org.eclipse.persistence.testing.jaxb.properties.PropertyTestCases
+
  
 
=== AccessorFactory (2.4 only) ===
 
=== AccessorFactory (2.4 only) ===
  
 
* '''COMPLETE'''
 
* '''COMPLETE'''
* '''DOCS NEEDED'''
+
* Documentation: http://wiki.eclipse.org/EclipseLink/Development/372403
 
* Bug: https://bugs.eclipse.org/bugs/show_bug.cgi?id=372403
 
* Bug: https://bugs.eclipse.org/bugs/show_bug.cgi?id=372403
 
* Added for the benefit of Hibernate users  
 
* Added for the benefit of Hibernate users  
Line 48: Line 39:
  
 
* '''COMPLETE'''
 
* '''COMPLETE'''
* '''DOCS NEEDED'''
+
* Documentation: http://wiki.eclipse.org/EclipseLink/Development/372404
 
* Bug: https://bugs.eclipse.org/bugs/show_bug.cgi?id=372404
 
* Bug: https://bugs.eclipse.org/bugs/show_bug.cgi?id=372404
* Can't get it to work in RI or Metro!
 
* '''mgrebac''': "You can have a look under cycle-recovery sample in jaxb sources or jaxb release artifacts."
 
 
* http://jaxb.java.net/guide/Mapping_cyclic_references_to_XML.html
 
* http://jaxb.java.net/guide/Mapping_cyclic_references_to_XML.html
 
* http://www.java.net/node/654639
 
* http://www.java.net/node/654639
Line 62: Line 51:
 
* 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
 
* 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 ===
+
=== NamespacePrefixMapper (2.3.3 and 2.4) ===
  
 
* '''COMPLETE'''
 
* '''COMPLETE'''
* '''DOCS NEEDED'''
+
* Documentation: http://wiki.eclipse.org/EclipseLink/Development/357266
 
* Background Info:  [http://jaxb.java.net/2.2/docs/vendorProperties.html#prefixmapper http://jaxb.java.net/2.2/docs/vendorProperties.html#prefixmapper]
 
* Background Info:  [http://jaxb.java.net/2.2/docs/vendorProperties.html#prefixmapper http://jaxb.java.net/2.2/docs/vendorProperties.html#prefixmapper]
 
* Bug: https://bugs.eclipse.org/bugs/show_bug.cgi?id=357266  
 
* Bug: https://bugs.eclipse.org/bugs/show_bug.cgi?id=357266  
 
* Allows the user to customize the namespace prefixes that are generated  
 
* Allows the user to customize the namespace prefixes that are generated  
* Could create our own NamespacePrefixMapper that users could subclass
 
 
* Custom Mapper would be provided via Marshaller properties
 
* Custom Mapper would be provided via Marshaller properties
  
=== IDResolver ===
+
=== IDResolver (2.3.3 and 2.4) ===
  
 
* '''COMPLETE'''
 
* '''COMPLETE'''
Line 78: Line 66:
 
* Bug: https://bugs.eclipse.org/bugs/show_bug.cgi?id=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  
 
* Exampe: http://weblogs.java.net/blog/kohsuke/archive/2005/08/pluggable_ididr.html  
* IDResolver works for Kohsuke's first example (Distinctive Symbol Spaces) but the combination with Unmarshall.Listener doesn't seem to work (Scoped Symbol Spaces)
 
*'''mgrebac''': "Need to look into this one further."
 
  
=== IndentString ===
+
=== IndentString (2.3.3 and 2.4) ===
  
 
* '''COMPLETE'''
 
* '''COMPLETE'''
Line 89: Line 75:
 
* Allows the user to customize the indenting that happens in marshalled documents
 
* Allows the user to customize the indenting that happens in marshalled documents
  
=== CharacterEscapeHandler ===
+
=== CharacterEscapeHandler (2.3.3 and 2.4) ===
  
 
* '''COMPLETE'''
 
* '''COMPLETE'''
Line 98: Line 84:
 
* Not applicable when marshalling to: XMLStreamWriter, XMLEventWriter, ContentHandler, Node
 
* Not applicable when marshalling to: XMLStreamWriter, XMLEventWriter, ContentHandler, Node
  
=== XML Declaration Control ===
+
=== XML Declaration Control (2.3.3 and 2.4) ===
  
 
* '''COMPLETE'''
 
* '''COMPLETE'''
* '''DOCS NEEDED'''
 
 
* Background Info:  [http://jaxb.java.net/2.2/docs/vendorProperties.html#xmldecl http://jaxb.java.net/2.2/docs/vendorProperties.html#xmldecl]
 
* Background Info:  [http://jaxb.java.net/2.2/docs/vendorProperties.html#xmldecl http://jaxb.java.net/2.2/docs/vendorProperties.html#xmldecl]
* Same as Marshaller.JAXB_FRAGMENT
+
* 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 ==
 
== Future ==
  
The following items are of low priority and will be pushed out to a future release.
+
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
  
 
=== <strike>OverrideAnnotationOf</strike>  ===
 
=== <strike>OverrideAnnotationOf</strike>  ===

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)

XML Headers (2.4 only)

AccessorFactory (2.4 only)

CycleRecoverable (2.4 only)

XmlLocation (2.4 only)

NamespacePrefixMapper (2.3.3 and 2.4)

IDResolver (2.3.3 and 2.4)

IndentString (2.3.3 and 2.4)

CharacterEscapeHandler (2.3.3 and 2.4)

XML Declaration Control (2.3.3 and 2.4)

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

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."