Introduction to XML Projects (ELUG)
This section provides an overview of XML projects and their components.
For information on project concepts and features common to more than one type of EclipseLink projects, see Introduction to Projects.
XML Project Concepts
Use an XML project for nontransactional, nonpersistent (in-memory) conversions between Java objects and XML documents using JAXB (see EclipseLink Support for Java Architecture for XML Binding (JAXB) and JAXB Validation). The Workbench provides complete support for creating XML projects.
The EclipseLink runtime performs XML data conversion based on one or more XML schemas. In an XML project, Workbench directly references schemas in the deployment XML, and exports mappings configured with respect to the schemas you specify. For information on how to use Workbench with XML schemas, see Using XML Schemas. For information on how EclipseLink supports XML namespaces, see XML Namespaces Overview.
XML Project Components
For more information, see Descriptor Concepts.
For more information, see XML Mappings.
In an XML project, you do not use EclipseLink queries and expressions.
EclipseLink Support for Java Architecture for XML Binding (JAXB)
JAXB defines annotations to control the mapping of Java objects to XML, but it also defines a default set of mappings. Using the defaults, EclipseLink can marshall a set of objects into XML, and unmarshall an XML documennt into objects. JAXB provides a standard Java object-to-XML API. For more information, see http://java.sun.com/xml/jaxb/index%7Cl.
EclipseLink provides an extra layer of functions on top of JAXB. It allows for the creation and subsequent manipulation of mappings (in the form of a Workbench project) from an existing object model, without requiring the recompilation of the JAXB object model.
An essential component of this function is the EclipseLink JAXB compiler. Using the EclipseLink JAXB compiler, you can generate both an EclipseLink XML project and JAXB-compliant object model classes from your XML schema.
The EclipseLink JAXB compiler simplifies JAXB application development with EclipseLink by automatically generating (see Creating an XML Project from an XML Schema) both the required JAXB files (see Working with JAXB-Specific Generated Files) and the EclipseLink files ( Working with EclipseLink-Specific Generated Files) from your XML schema (XSD) document.
For more information on using the JAXB and EclipseLink-specific run-time classes, see Using EclipseLink JAXB Compiler Generated Files at Run Time.
Working with JAXB-Specific Generated Files
The EclipseLink JAXB compiler generates the following JAXB-specific files from your XSD:
The JAXB runtime uses these files as specified by the JAXB specification.
All JAXB-specific files are generated in the output directory you define, and in the subdirectories implied by the target package name you define. For more information about EclipseLink JAXB binding compiler options, see #Creating an XML Project from an XML SchemaCreating an XML Project from an XML Schema.
Before you compile your generated classes, be sure to configure your IDE classpath to include <ECLIPSELINK_HOME>\lib\xml.jar. For an example, see Using an Integrated Development Environment.
All implementation classes are named according to the content, element, or implementation name attribute defined in the XSD.
The generated implementation classes are simple domain classes, with private attributes for each JAXB property, and public get and set methods that return or set attribute values.
Working with EclipseLink-Specific Generated Files
The EclipseLink JAXB compiler generates the following EclipseLink-specific files from your XSD:
- EclipseLink Sessions XML File
- EclipseLink Project XML File
- Workbench Project
- Typesafe Enumeration Converter Amendment Method DescriptorAfterLoads Class
You use these files to customize the EclipseLink metadata that corresponds to the generated JAXB-specific objects.
All EclipseLink-specific files are generated in a subdirectory, named eclipselink, of the output directory you specify (see Creating an XML Project from an XML Schema).
The eclipselink subdirectory is organized as this figure illustrates.
JAXB Binding Compiler Generated Files and Directories
EclipseLink Sessions XML File
In the generated sessions.xml file, the name element is the name of the context path and the project-xml element is the name of the generated project XML file.
This example shows a typical sessions.xml file where the context path is examples.ox.model.
Typical Generated sessions.xml File
<?xml version="1.0" encoding="US-ASCII"?> <eclipselink-sessions xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="file://xsd/sessions_10_0_3.xsd" version="0"> <session xsi:type="database-session"> <name>customer_example</name> <primary-project xsi:type="xml">purchaseOrder.xml</primary-project> <login xsi:type="xml-login"> <platform-class>org.eclipse.persistence.ox.platform.SAXPlatform</platform-class> </login> </session> </eclipselink-sessions>
As in any EclipseLink project, the EclipseLink session is your primary facade to the EclipseLink XML API (see Using EclipseLink JAXB Compiler Generated Files at Run Time).
EclipseLink Project XML File
The project XML file is named the same as the XSD, but with a file extension of xml. In the JAXB Binding Compiler Generated Files and Directories figure, the name of the generated project XML file is purchaseOrder.xml.
The project XML file contains a descriptor and associated mappings for each content, element, and implementation class.
The Workbench project is written to a subdirectory as the JAXB Binding Compiler Generated Files and Directories figure illustrates. This subdirectory contains a Workbench project file named with the same name as the XSD, but with a file extension of mwp and the required descriptor and class subdirectories. In the JAXB Binding Compiler Generated Files and Directories figure, the Workbench project is named purchaseOrder.mwp.
Optionally, you can use this Workbench project to customize the generated descriptors and mappings and reexport the project XML file.
Typesafe Enumeration Converter Amendment Method DescriptorAfterLoads Class
The EclipseLink JAXB compiler will generate a single class called DescriptorAfterLoads if any implementation class contains a mapping to a type safe enumeration (see Mappings and JAXB Typesafe Enumerations).
The EclipseLink JAXB compiler will update this DescriptorAfterLoads class with a descriptor amendment method called amend<ImplementationClassName> for each implementation class that contains a mapping to a typesafe enumeration. The amendment method sets an instance of JAXBTypesafeEnumConverter on each mapping that maps to a typesafe enumeration in that implementation class.
The Workbench project that the EclipseLink JAXB compiler creates (see Workbench Project) configures the implementation class descriptor with this amendment method. You can open the generated Workbench project and regenerate deployment XML without losing support for this feature.
Using EclipseLink JAXB Compiler Generated Files at Run Time
At run time, you can access the EclipseLink JAXB compiler-generated files by doing the following:
- Using EclipseLink XMLContext (see How to Use EclipseLink XML Context)
- Using EclipseLink XMLBinder (see How to Use EclipseLink XML Binder)
- Using EclipseLink JAXBContext (see How to Use JAXB Context)
How to Use EclipseLink XML Context
EclipseLink provides an XMLContext class with which you can create instances of EclipseLink XMLMarshaller, XMLUnmarshaller, XMLBinder (see How to Use EclipseLink XML Binder), and XMLValidator.
The XMLContext is thread-safe. For example, if multiple threads accessing the same XMLContext object request an XMLMarshaller, each will receive their own instance of XMLMarshaller, so any state that the XMLMarshaller maintains will be unique to that process. By using the XMLContext, you can use EclipseLink XML in multithreaded architectures, such as the binding layer for Web services.
To use the EclipseLink XMLContext, do the following:
- Configure your application classpath to include your domain object class files (see Working with JAXB-Specific Generated Files) and the EclipseLink runtime.
- Acquire the session manager (see Acquiring the Session Manager).
- Use the session manager to acquire your XML session using the sessions.xml file you generated with the EclipseLink JAXB compiler (see Acquiring a Session from the Session Manager).
- Get the XML project instance from the session:
Project myProject = session.getProject();
- Create an EclipseLink XML context instance with the project:
XMLContext context = new XMLContext(myProject);
- Use the XMLContext to create an EclipseLink XMLMarshaller, XMLUnmarshaller, XMLBinder, and XMLValidator:
XMLMarshaller marshaller = context.createMarshaller(); marshaller.marshal(myObject, outputStream); marshaller.setFormattedOutput(true); XMLUnmarshaller unmarshaller = context.createUnmarshaller(); Employee emp = (Employee)unmarshaller.unmarshal(new File("employee.xml")); XMLBinder binder = context.createBinder(); Address add = (Address)binder.unmarshal(myElement); XMLValidator validator = context.createValidator(); boolean isValid = validator.validate(emp);
Using the XMLContext getDocumentPreservationPolicy method, you can retrieve this context's document preservation policy in a form of the DocumentPreservationPolicy object. This object's API lets you specify the position of newly added to the node elements, as well as disable the addition of new elements.
How to Use EclipseLink XML Binder
XMLBinder is a run-time class that allows you to preserve a document that you have unmarshalled, as well as to resynchronize that document with the unmarshalled objects at any time.
Note: This functionality is based on the JAXB binder API (javax.xml.bind.Binder<XmlNode>). This is an addition to the design-time method of document preservation.
When the XMLBinder unmarshalls XML nodes into mapping objects, and then performs an update operation, it preserves not only the order of elements, but also the comments from an original XML document using the cached value. This way, both the returned node and the cached node are identical and reflect the preserved document. When adding new elements, EclipseLink XMLBinder places them at the correct location (relative to other mapped content) in the node.
When unmarshalling a document that contains only unmapped content, setting some values and then marshalling, the XMLBinder adds new elements before existing unmapped data, such as comments and processing instructions.
This example demonstrates how you can unmarshall a document using an instance of an XMLBinder.
Unmarshalling a Document Using XMLBinder
XMLContext conext = new XMLContext(myProject); XMLBinder binder = context.createBinder(); Employee emp = (Employee) binder.unmarshal(myDocument);
In the preceding example, emp is the root object that was unmarshalled from the provided document. The binder maintains references to the original XML document as well as objects generated during the unmarshall operation.
This example demonstrates how you can make changes to the object (Employee) and update the XML document using an instance of an XMLBinder.
Making Changes to an Object and to Updating XML Using XMLBinder
... emp.setPhoneNumber("123-4567"); binder.updateXML(emp);
In the preceding example, the updateXML method will update the cached node in the binder. Note that the cached node preserves the document, including comments, as the following example shows:
<employee> <!--comment1 --> <name>John Smith </name> <phone-number>123-4567</phone-number> <!--comment2 --> </employee>
This example demonstrates how you can obtain an associated node for a subobject (Address) of the Employee using an instance of an XMLBinder.
Obtaining an Associated Node Using XMLBinder
... Address addr = emp.getAddress(); Node addressNode = binder.getXMLNode(addr);
In the preceding example, the returned node (addressNode) is the XML node in the original XML document that was used to build this employee's Address object.
This example demonstrates how you can make changes to an XML node and update objects (Address) of the Employee using an instance of an XMLBinder.
Making Changes to an XML Node and Updating Objects Using XMLBinder
... addressNode.setAttribute("apt-no", "1527"); Address updatedAddressNode = binder.updateObject(addressNode);
In the preceding example, the address returned from the binder operation is the original Address object created during the unmarshall operation, but now it contains the updated apartment number information from the XML document.
How to Use JAXB Context
You can create an instance of JAXBContext using the target package name you selected for your files (see Working with JAXB-Specific Generated Files) as the context path, as the Using the Context Path example shows. This example assumes that you configure your application classpath to include your domain object class files.
The JAXBContext object is thread-safe.
Using the Context Path
JAXBContext jaxbContext = JAXBContext.newInstance("examples.ox.model"); Unmarshaller unmarshaller = jaxbContext.createUnmarshaller(); PurchaseOrder purchaseOrder = (PurchaseOrder)unmarshaller.unmarshal(new File("purchaseOrder.xml"));
EclipseLink can validate both complete object trees and subtrees against the XML schema that was used to generate the implementation classes. In addition, EclipseLink will validate both root objects (objects that correspond to the root element of the XML document) and nonroot objects against the schema used to generate the object's implementation class.
When validating an object tree, EclipseLink performs the following checks (in order):
- Check that element appears in the document at the specified location.
- If maxOccurs or minOccurs is specified, check number of elements.
- If type is specified, check that element value satisfies the type constraints.
- If a fixed value is specified, check that the element value matches it.
- If restrictions (length, patterns, enumerations, and so on) are specified, check that the element value satisfies it.
- If an ID type is specified during a validateRoot operation, check that the ID value is unique in the document.
- If an IDREF type is specified during a validateRoot operation, check that the ID referenced exists in the document.
If validation errors are encountered, EclipseLink stops validating the object tree and creates a ValidationEvent object, according to the JAXB specification. If an error occurs in a subobject, EclipseLink will not validate further down that object's subtree.
For more information on using EclipseLink XML to perform validation, see Using EclipseLink JAXB Compiler Generated Files at Run Time.
For additional information on JAXB and validation, refer to the JAXB specification at http://java.sun.com/xml/jaxb/.