Jump to: navigation, search

Difference between revisions of "EclipseLink/UserGuide/MOXy/Runtime/Bootstrapping Dynamic/Specifying the EclipseLink Runtime"

Line 35: Line 35:
 
* <tt>properties</tt> -  A map of properties to use when creating a new <tt>DynamicJAXBContext</tt>.  This map must contain one of the following keys:
 
* <tt>properties</tt> -  A map of properties to use when creating a new <tt>DynamicJAXBContext</tt>.  This map must contain one of the following keys:
 
**<tt>JAXBContext.ECLIPSELINK_OXM_XML_KEY</tt>, which can have several possible values:
 
**<tt>JAXBContext.ECLIPSELINK_OXM_XML_KEY</tt>, which can have several possible values:
***One of the following, pointing to your OXM file: <tt>java.io.File</tt>, <tt>java.io.InputStream</tt>, <tt>java.io.Reader</tt>, <tt>java.net.URL</tt>,<br>
+
***One of the following, pointing to your OXM file: <tt>java.io.File</tt>, <tt>java.io.InputStream</tt>, <tt>java.io.Reader</tt>, <tt>java.net.URL</tt>, <tt>javax.xml.stream.XMLEventReader</tt>, <tt>javax.xml.stream.XMLStreamReader</tt>, <tt>javax.xml.transform.Source</tt>, <tt>org.w3c.dom.Node</tt>, or <tt>org.xml.sax.InputSource</tt>.
<tt>javax.xml.stream.XMLEventReader</tt>, <tt>javax.xml.stream.XMLStreamReader</tt>, <tt>javax.xml.transform.Source</tt>,<br>
+
<tt>org.w3c.dom.Node</tt>, or <tt>org.xml.sax.InputSource</tt>.
+
 
***A <tt>List</tt> of objects from the set above.
 
***A <tt>List</tt> of objects from the set above.
 
***A <tt>Map&lt;String, Object&gt;</tt>, where <tt>String</tt> is a package name, and <tt>Object</tt> is the pointer to the OXM file, from the set<br>
 
***A <tt>Map&lt;String, Object&gt;</tt>, where <tt>String</tt> is a package name, and <tt>Object</tt> is the pointer to the OXM file, from the set<br>

Revision as of 11:48, 6 January 2011

EclipseLink MOXy

link="http://wiki.eclipse.org/EclipseLink"
EclipseLink
Website
Download
Community
Mailing ListForumsIRC
Bugzilla
Open
Help Wanted
Bug Day
Contribute
Browse Source


Specifying the EclipseLink Runtime

In order to use EclipseLink Dynamic MOXy as your JAXB implementation, you must identify the EclipseLink DynamicJAXBContextFactory in your jaxb.properties file.

  1. Create a text file named jaxb.properties, specifying DynamicJAXBContextFactory as the factory used to build new JAXBContexts.
    javax.xml.bind.context.factory=org.eclipse.persistence.jaxb.dynamic.DynamicJAXBContextFactory
  2. Copy the file to your application package (or any of your packages on your classpath).
  3. Use the standard JAXBContext.newInstance(String contextPath) API to create a DynamicJAXBContext.
    DynamicJAXBContext jaxbContext = (DynamicJAXBContext) JAXBContext.newInstance("org.example.mypackage");

Because you do not need to change any application code, you can easily switch between different JAXB implementations.

The following methods on DynamicJAXBContextFactory can be used to create DynamicJAXBContexts:

public static JAXBContext newInstance(String contextPath) throws JAXBException
 
public static JAXBContext newInstance(String contextPath, ClassLoader classLoader) throws JAXBException
 
public static JAXBContext newInstance(String contextPath, ClassLoader classLoader, Map<String,?> properties) throws JAXBException
  • contextPath - Location of jaxb.properties file.
  • classLoader - The application's current class loader, which will be used to first lookup classes to see if they exist before new DynamicTypes are generated.
  • properties - A map of properties to use when creating a new DynamicJAXBContext. This map must contain one of the following keys:
    • JAXBContext.ECLIPSELINK_OXM_XML_KEY, which can have several possible values:
      • One of the following, pointing to your OXM file: java.io.File, java.io.InputStream, java.io.Reader, java.net.URL, javax.xml.stream.XMLEventReader, javax.xml.stream.XMLStreamReader, javax.xml.transform.Source, org.w3c.dom.Node, or org.xml.sax.InputSource.
      • A List of objects from the set above.
      • A Map<String, Object>, where String is a package name, and Object is the pointer to the OXM file, from the set

of possibilities above. If using this option, a package-name element is not required in the xml-bindings element of your OXM file.

Eclipselink-logo.gif
Version: 2.2.0 - DRAFT
Other versions...