Skip to main content
Jump to: navigation, search

EclipseLink/Release/2.4.0/JAXB RI Extensions/ID Resolver

Design Documentation: IDResolver

ER 360249

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

The abstract class IDResolver provided in the Sun JAXB implementation allows users to override the ID/IDREF processing of the JAXB runtime.

This document will outline the design for an EclipseLink equivalent to this extension.


  • Deliver an abstract IDResolver class in the EclipseLink library that will provide the same functionality as the Sun extension:
    • Given a String id and Object obj, allow the user to perform custom bind code
    • Given a String id and Class type, allow the user to perform custom resolve code
    • Provide the user a hook into startDocument() and endDocument() events
  • Unlike Sun's JAXB implementation, EclipseLink MOXy is not restricted to String-only IDs. Therefore, we will include additional functionality to support complex IDs.
    • Given a IDWrapper id and Object obj, allow the user to perform custom bind code
    • Given a IDWrapper id and Class type, allow the user to perform custom resolve


If an IDResolver has been set on the Unmarshaller (via properties), then the following things must happen during unmarshal:

  • The IDResolver's startDocument() method must be called when unmarshalling starts.
  • When an ID value is encountered during unmarshal, the IDResolver's bind method must be called, to bind the object to the ID.
  • When an IDREF value is encountered during unmarshal, the IDResolver's resolve method must be used to obtain the object for the IDREF.
  • The IDResolver's endDocument() method must be called when unmarshalling completes.


The user must extend the following abstract class:

package org.eclipse.persistence.jaxb;
import java.util.concurrent.Callable;
import javax.xml.bind.ValidationEventHandler;
import org.xml.sax.SAXException;
 * IDResolver can be subclassed to allow customization of the ID/IDREF processing of
 * JAXBUnmarshaller.
 * @see JAXBUnmarshaller
public abstract class IDResolver {
    public abstract Callable<?> resolve(IDWrapper id, Class type) throws SAXException;
    public abstract void bind(IDWrapper id, Object obj) throws SAXException;
    public void startDocument(ValidationEventHandler eventHandler) throws SAXException {
    public void endDocument() throws SAXException {

The IDWrapper class encapsulates the ID information for a given class. It contains a Map of key-value pairs, with the key name mapping to the key's value.

package org.eclipse.persistence.oxm;
import java.util.HashMap;
import java.util.Map;
 * IDWrapper encapsulates the one or more name/value pairs used to uniquely identify
 * an object.   It is used solely with custom IDResolvers.
 * @see IDResolver
public class IDWrapper {
    Map<String, Object> id = null;
    public void addID(String idName, Object idValue) {
        getID().put(idName, idValue);
    public Map<String, Object> getID() {
        if ( == null) {
   = new HashMap<String, Object>(1);

The user's IDResolver class can then be passed to the EclipseLink Unmarshaller through the addProperty() method:

JAXBContext ctx = ...
Unmarshaller u = ctx.createUnmarshaller();
u.setProperty(IDResolver.class.getName(), new MyIDResolver());

XML Bindings




Appendix A - Example IDResolver

From Pluggable ID/IDREF handling in JAXB 2.0

import java.util.HashMap;
import java.util.Map;
import java.util.concurrent.Callable;
import com.sun.xml.bind.IDResolver;
class MyIDResolver extends IDResolver {
    Map<String, Apple> apples = new HashMap<String, Apple>();
    Map<String, Orange> oranges = new HashMap<String, Orange>();
    void startDocument() {
    public void bind(String id, Object obj) {
        if (obj instanceof Apple)
            apples.put(id, (Apple) obj);
            oranges.put(id, (Orange) obj);
    public Callable resolve(final String id, final Class targetType) {
        return new Callable() {
            public Object call() {
                if (targetType == Apple.class)
                    return apples.get(id);
                    return oranges.get(id);

Document History

Date Author Version Description & Notes
111007 Rick Barkhouse 1.00 : First draft
111017 Rick Barkhouse 1.01 : Considering possibility of supporting complex IDs
111020 Rick Barkhouse 1.02 : Revising design to support complex (non-String, composite) IDs

Back to the top