Package org.eclipse.persistence.oxm

Class XMLContext

  • public class XMLContext
extends Context<AbstractSession,​XMLDescriptor,​XMLField,​NamespaceResolver,​Project,​DatabaseSession,​SessionEventListener>

    An XMLContext is created based on EclipseLink sessions or projects and can then used to create instances of XMLMarshaller, XMLUnmarshaller and XMLValidator.

    There are constructors to create an XMLContext with a single EclipseLink project or with a String which is a single EclipseLink session name or a ':' separated list of EclipseLink session names.

    Code Sample
    XMLContext context = new XMLContext("mySessionName");
    XMLMarshaller marshaller = context.createMarshaller();
    XMLUnmarshaller unmarshaller = context.createUnmarshaller();
    XMLValidator validator = context.createValidator();

    The XMLContext is thread-safe. 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. The same is true of instances of XMLUnmarshaller and XMLValidator.

    See Also:
    XMLMarshaller, XMLUnmarshaller, XMLValidator

    • Constructor Detail

      • XMLContext

        public XMLContext​(String sessionNames)
        Create a new XMLContext based on the specified session name or list of session names
        Parameters:
        sessionNames - A single session name or multiple session names separated by a :

      • XMLContext

        public XMLContext​(String sessionNames,
                  ClassLoader classLoader)
        Create a new XMLContext based on the specified session name or list of session names
        Parameters:
        sessionNames - A single session name or multiple session names separated by a :
        classLoader - classloader for loading sessions.xml

      • XMLContext

        public XMLContext​(String sessionNames,
                  String xmlResource)
        Create a new XMLContext based on passed in session names and session meta XML.
        Parameters:
        sessionNames - A single session name or multiple session names separated by a:
        xmlResource - path to XML file containing session meta data to initialize and load sessions.

      • XMLContext

        public XMLContext​(String sessionNames,
                  ClassLoader classLoader,
                  String xmlResource)
        Create a new XMLContext based on passed in session names, classloader and session meta XML.
        Parameters:
        sessionNames - A single session name or multiple session names separated by a :
        classLoader - classloader for loading sessions.xml
        xmlResource - path to XML file containing session meta data to initialize and load sessions.

      • XMLContext

        public XMLContext​(Project project)
        Create a new XMLContext based on the specified project
        Parameters:
        project - An EclipseLink project

      • XMLContext

        public XMLContext​(Project project,
                  ClassLoader classLoader)
        Create a new XMLContext based on the specified Project and ClassLoader.
        Parameters:
        project - An EclipseLink project
        classLoader - The ClassLoader to be used

      • XMLContext

        public XMLContext​(Project project,
                  ClassLoader classLoader,
                  SessionEventListener sessionEventListener)
        Create a new XMLContext based on the specified Project and ClassLoader.
        Parameters:
        project - An EclipseLink project
        classLoader - The ClassLoader to be used
        sessionEventListener - If non-null, this listener will be registered with the SessionEventManager
        See Also:
        SessionEventListener, SessionEventManager

      • XMLContext

        public XMLContext​(Project project,
                  ClassLoader classLoader,
                  Collection<SessionEventListener> sessionEventListeners)
        Create a new XMLContext based on the specified Project and ClassLoader.
        Parameters:
        project - An EclipseLink project
        classLoader - The ClassLoader to be used
        sessionEventListeners - If non-null, these listeners will be registered with the SessionEventManager
        See Also:
        SessionEventListener, SessionEventManager

      • XMLContext

        public XMLContext​(Collection projects)

    • Method Detail

      • getXMLContextState

        public org.eclipse.persistence.oxm.XMLContext.XMLContextState getXMLContextState()
        INTERNAL: Return the XMLContextState that represents the XMLContexts stateful information. This method is provided for the benefits of layers that build on top of the core OXM layer such as MOXy's JAXB implementation.

      • setXMLContextState

        public void setXMLContextState​(org.eclipse.persistence.oxm.XMLContext.XMLContextState xcs)
        INTERNAL: Set the stateful information for this XMLContext. Once the new state has been set, OXM operations (marshal, unmarshal, etc) will be based on this new state. This method is provided for the benefit of layers that build on top of the core OXM layer such as MOXy's JAXB

      • addSession

        public void addSession​(DatabaseSession sessionToAdd)
        INTERNAL: Add and initialize a new session to the list of sessions associated with this XMLContext.

      • createUnmarshaller

        public XMLUnmarshaller createUnmarshaller​(Map<String,​Boolean> parserFeatures)
        Create a new XMLUnmarshaller 
         Map<String, Boolean> parserFeatures = new HashMap<String, Boolean>(1);
 parserFeatures.put("http://apache.org/xml/features/validation/schema/normalized-value", false);
 XMLUnmarshaller unmarshaller = xmlContext.createUnmarshaller(parserFeatures);
        Returns:
        An XMLUnmarshaller based on this XMLContext, the underlying parser will use the passed in parser features.

      • createBinder

        public XMLBinder createBinder()
        Create a new XMLBinder
        Returns:
        an XMLBinder based on this XMLContext

      • createBinder

        public XMLBinder createBinder​(XMLMarshaller marshaller,
                              XMLUnmarshaller unmarshaller)
        Create a new XMLBinder with supplied marshaller and unmarshaller instances.
        Returns:
        an XMLBinder based on this XMLContext,

      • createValidator

        public XMLValidator createValidator()
        Create a new XMLValidator
        Returns:
        An XMLValidator based on this XMLContext

      • getReadSession

        public AbstractSession getReadSession​(Object object)
        INTERNAL: Return the session corresponding to this object. Since the object may be mapped by more that one of the projects used to create the XML Context, this method will return the first match. The session will be a unit of work if document preservation is not enabled. This method will typically be used for unmarshalling when a non-shared cache is desired.

      • getReadSession

        public AbstractSession getReadSession​(Class clazz)
        INTERNAL: Return the session corresponding to this class. Since the class may be mapped by more that one of the projects used to create the XML Context, this method will return the first match. The session will be a unit of work if document preservation is not enabled. This method will typically be used for unmarshalling when a non-shared cache is desired.

      • getReadSession

        public AbstractSession getReadSession​(XMLDescriptor xmlDescriptor)
        INTERNAL: Return the session corresponding to this XMLDescriptor. Since the class may be mapped by more that one of the projects used to create the XML Context, this method will return the first match. The session will be a unit of work if document preservation is not enabled. This method will typically be used for unmarshalling when a non-shared cache is desired.

      • getSessions

        public List getSessions()
        INTERNAL: Return the EclipseLink session used to marshal.

      • getSession

        public DatabaseSession getSession​(int index)
        INTERNAL: XMLContext xmlContext = new XMLContext("path0:path1");
        DatabaseSession session = xmlContext.getSession(0); // returns session for path0

      • storeXMLDescriptorByQName

        public void storeXMLDescriptorByQName​(XMLDescriptor xmlDescriptor)
        INTERNAL:

      • addDescriptorByQName

        public void addDescriptorByQName​(QName qName,
                                 XMLDescriptor descriptor)

      • getDocumentPreservationPolicy

        public DocumentPreservationPolicy getDocumentPreservationPolicy​(AbstractSession session)
        INTERNAL: Return the DocumentPreservationPolicy associated with this session
        Parameters:
        session -
        Returns:

      • setupDocumentPreservationPolicy

        public void setupDocumentPreservationPolicy​(DatabaseSession session)

      • applyORMMetadata

        public void applyORMMetadata​(AbstractSession ormSession)
        ADVANCED: Adjust the OXM metadata to take into account ORM mapping metadata,

      • getValueByXPath

        public <T> T getValueByXPath​(Object object,
                             String xPath,
                             NamespaceResolver namespaceResolver,
                             Class<T> returnType)

        Query the object model based on the corresponding XML document. The following pairings are equivalent:

        Return the Customer's ID 
         Integer id = xmlContext.getValueByXPath(customer, "@id", null, Integer.class);
 Integer id = customer.getId();
        Return the Customer's Name 
         String name = xmlContext.getValueByXPath(customer, "ns:personal-info/ns:name/text()", null, String.class);
 String name = customer.getName();
        Return the Customer's Address 
         Address address = xmlContext.getValueByXPath(customer, "ns:contact-info/ns:address", aNamespaceResolver, Address.class);
 Address address = customer.getAddress();
        Return all the Customer's PhoneNumbers 
         List phoneNumbers = xmlContext.getValueByXPath(customer, "ns:contact-info/ns:phone-number", aNamespaceResolver, List.class);
 List phoneNumbers = customer.getPhoneNumbers();
        Return the Customer's second PhoneNumber 
         PhoneNumber phoneNumber = xmlContext.getValueByXPath(customer, "ns:contact-info/ns:phone-number[2]", aNamespaceResolver, PhoneNumber.class);
 PhoneNumber phoneNumber = customer.getPhoneNumbers().get(1);
        Return the base object 
         Customer customer = xmlContext.getValueByXPath(customer, ".", aNamespaceResolver, Customer.class);
 Customer customer = customer;
        Overrides:
        getValueByXPath in class Context<AbstractSession,​XMLDescriptor,​XMLField,​NamespaceResolver,​Project,​DatabaseSession,​SessionEventListener>
        Type Parameters:
        T - The return type of this method corresponds to the returnType parameter.
        Parameters:
        object - The XPath will be executed relative to this object.
        xPath - The XPath statement
        namespaceResolver - A NamespaceResolver containing the prefix/URI pairings from the XPath statement.
        returnType - The return type.
        Returns:
        The object corresponding to the XPath or null if no result was found.

      • setValueByXPath

        public void setValueByXPath​(Object object,
                            String xPath,
                            NamespaceResolver namespaceResolver,
                            Object value)

        Set values in the object model based on the corresponding XML document. The following pairings are equivalent:

        Set the Customer's ID 
         xmlContext.setValueByXPath(customer, "@id", null, Integer.valueOf(123));
 customer.setId(Integer.valueOf(123));
        Set the Customer's Name 
         xmlContext.setValueByXPath(customer, "ns:personal-info/ns:name/text()", aNamespaceResolver, "Jane Doe");
 customer.setName("Jane Doe");
        Set the Customer's Address 
         xmlContext.setValueByXPath(customer, "ns:contact-info/ns:address", aNamespaceResolver, anAddress);
 customer.setAddress(anAddress);
        Set the Customer's PhoneNumbers 
         xmlContext.setValueByXPath(customer, "ns:contact-info/ns:phone-number", aNamespaceResolver, phoneNumbers);
 customer.setPhoneNumbers(phoneNumbers);
        Set the Customer's second PhoneNumber 
         xmlContext.setValueByXPath(customer, "ns:contact-info/ns:phone-number[2]", aNamespaceResolver, aPhoneNumber);
 customer.getPhoneNumbers().get(1);
        Overrides:
        setValueByXPath in class Context<AbstractSession,​XMLDescriptor,​XMLField,​NamespaceResolver,​Project,​DatabaseSession,​SessionEventListener>
        Parameters:
        object - The XPath will be executed relative to this object.
        xPath - The XPath statement
        namespaceResolver - A NamespaceResolver containing the prefix/URI pairings from the XPath statement.
        value - The value to be set.

      • createByQualifiedName

        public Object createByQualifiedName​(String namespace,
                                    String typeName,
                                    boolean isGlobalType)
                             throws IllegalArgumentException
        Create a new object instance for a given XML namespace and name.
        Parameters:
        namespace - The namespace of the complex type to create a new Java instance of.
        typeName - The XML type name to create a new Java instance of.
        isGlobalType - True if the object to be created represents a global type, false if it represents a global element.
        Returns:
        An instance of the Java class mapped to the indicated XML type, or null if no result was found.
        Throws:
        IllegalArgumentException

      • createByXPath

        public <T> T createByXPath​(Object parentObject,
                           String xPath,
                           NamespaceResolver namespaceResolver,
                           Class<T> returnType)
        Create a new object instance for a given XPath, relative to the parentObject.
        Overrides:
        createByXPath in class Context<AbstractSession,​XMLDescriptor,​XMLField,​NamespaceResolver,​Project,​DatabaseSession,​SessionEventListener>
        Type Parameters:
        T - The return type of this method corresponds to the returnType parameter.
        Parameters:
        parentObject - The XPath will be executed relative to this object.
        xPath - The XPath statement.
        namespaceResolver - A NamespaceResolver containing the prefix/URI pairings from the XPath statement.
        returnType - The return type.
        Returns:
        An instance of the Java class mapped to the supplied XML type, or null if no result was found.

      • getDescriptors

        public List<Descriptor> getDescriptors()
        Returns descriptors from all sessions.
        Returns:
        descriptors from all sessions

      • getOxmConversionManager

        public ConversionManager getOxmConversionManager()
        Returns conversion manager from session datasource platform.
        Returns:
        conversion manager

      • getDescriptorForObject

        public Descriptor getDescriptorForObject​(Object object)
        Returns descriptor for given object.
        Parameters:
        object -
        Returns:
        descriptor for given object