Jump to: navigation, search

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

(Instantiating a DynamicJAXBContext)
(Instantiating a DynamicJAXBContext)
Line 39: Line 39:
 
* <tt>classLoader</tt> - The application's current class loader, which will be used to first lookup classes to see if they exist before new <tt>DynamicTypes</tt> are generated.
 
* <tt>classLoader</tt> - The application's current class loader, which will be used to first lookup classes to see if they exist before new <tt>DynamicTypes</tt> are generated.
 
* <tt>properties</tt> -  A map of properties to use when creating a new <tt>DynamicJAXBContext</tt>.  This map must contain one of the following two 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 two keys:
**<tt>JAXBContext.XML_SCHEMA_KEY</tt>, which can have several possible values:
+
**<tt>JAXBContextFactory.XML_SCHEMA_KEY</tt>, which can have several possible values:
 
***One of the following, pointing to your XML Schema file:
 
***One of the following, pointing to your XML Schema file:
 
****<tt>java.io.InputStream</tt>
 
****<tt>java.io.InputStream</tt>
 
****<tt>org.w3c.dom.Node</tt>
 
****<tt>org.w3c.dom.Node</tt>
 
****<tt>javax.xml.transform.Source</tt>
 
****<tt>javax.xml.transform.Source</tt>
**<tt>JAXBContext.ECLIPSELINK_OXM_XML_KEY</tt>, which can have several possible values:
+
**<tt>JAXBContextFactory.ECLIPSELINK_OXM_XML_KEY</tt>, which can have several possible values:
 
***One of the following, pointing to your OXM file:
 
***One of the following, pointing to your OXM file:
 
****<tt>java.io.File</tt>
 
****<tt>java.io.File</tt>

Revision as of 17:44, 6 January 2011

EclipseLink MOXy

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.


Instantiating a DynamicJAXBContext

The following methods on JAXBContext can be used to create new instances of 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 two keys:
    • JAXBContextFactory.XML_SCHEMA_KEY, which can have several possible values:
      • One of the following, pointing to your XML Schema file:
        • java.io.InputStream
        • org.w3c.dom.Node
        • javax.xml.transform.Source
    • JAXBContextFactory.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
        • 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...