Mapping nested xml elements to single Java Object

Question

How would I map this

    <urn:envelope xmlns:urn="urn:com.twinstrata.webservice:2.1">
<urn:encoded>
    <urn:response>
        <urn:license>
            <urn:licenseTag>WHATEVER934</urn:licenseTag>
            <urn:accountNumber>2016763117</urn:accountNumber>
            <urn:licenseType>TRIAL</urn:licenseType>
            <urn:licenseClass>Credentialed</urn:licenseClass>
            <urn:volumeAllowed>Unlimited</urn:volumeAllowed>
            <urn:volumeProvisioned>0</urn:volumeProvisioned>
            <urn:snapshotLimit>Unlimited</urn:snapshotLimit>
            <urn:snapshotLimitPerVolume>10</urn:snapshotLimitPerVolume>
            <urn:status>Active</urn:status>
            <urn:usedSpace>0</urn:usedSpace>
            <urn:expirtationDate>2013-03-27 14:48:47.0</urn:expirtationDate>
            <urn:storageLimit>Unlimited</urn:storageLimit>
        </urn:license>
    </urn:response>
</urn:encoded>
<urn:signature>Hl8rk2aTEsOkkq5e383LH0BqdFfmVcKIg9FuFEnnrlFk9fwYVEQwkrm/7MPM2Zmli2Um00L2Ab25tZg2w8pEzXyDsd+vwCAH0ypQwhIVPayDjgYKlYXbnkqG5S+7qiVbqD2qZDektuPoEWvaSdxO3ZgUibT+nnrO0kl6E7i4lB0=
</urn:signature>

to this

    package com.folio3.bean;

    import javax.xml.bind.annotation.XmlElement;
    import javax.xml.bind.annotation.XmlRootElement;

    @XmlRootElement(name = "envelope" , namespace = "urn:com.twinstrata.webservice:2.1")
    public class ResponseXML {


        private String userName;
        private String license;
        private String signature;
        private String licenseTag;
        private String accountNumber;
        private String licenseType;
        private String licenseClass;
        private String volumeAllowed;
        private String volumeProvisioned;
        private String publicKey;

        @XmlElement(name = "userName" , namespace = "urn:com.twinstrata.webservice:2.1")
        public String getUserName() {
            return userName;
        }
        public void setUserName(String userName) {
            this.userName = userName;
        }

        @XmlElement(name = "license" , namespace = "urn:com.twinstrata.webservice:2.1")
        public String getLicense() {
            return license;
        }
        public void setLicense(String license) {
            this.license = license;
        }

        @XmlElement(name = "signature" , namespace = "urn:com.twinstrata.webservice:2.1")
        public String getSignature() {
            return signature;
        }
        public void setSignature(String signature) {
            this.signature = signature;
        }


        @XmlElement(name = "licenseTag" , namespace = "urn:com.twinstrata.webservice:2.1")
        public String getLicenseTag() {
            return licenseTag;
        }
        public void setLicenseTag(String licenseTag) {
            this.licenseTag = licenseTag;
        }

        @XmlElement(name = "accountNumber" , namespace = "urn:com.twinstrata.webservice:2.1")
        public String getAccountNumber() {
            return accountNumber;
        }
        public void setAccountNumber(String accountNumber) {
            this.accountNumber = accountNumber;
        }

        @XmlElement(name = "licenseType" , namespace = "urn:com.twinstrata.webservice:2.1")
        public String getLicenseType() {
            return licenseType;
        }
        public void setLicenseType(String licenseType) {
            this.licenseType = licenseType;
        }

        @XmlElement(name = "licenseClass" , namespace = "urn:com.twinstrata.webservice:2.1")
        public String getLicenseClass() {
            return licenseClass;
        }
        public void setLicenseClass(String licenseClass) {
            this.licenseClass = licenseClass;
        }

        @XmlElement(name = "volumeAllowed" , namespace = "urn:com.twinstrata.webservice:2.1")
        public String getVolumeAllowed() {
            return volumeAllowed;
        }
        public void setVolumeAllowed(String volumeAllowed) {
            this.volumeAllowed = volumeAllowed;
        }

        @XmlElement(name = "volumeProvisioned" , namespace = "urn:com.twinstrata.webservice:2.1")
        public String getVolumeProvisioned() {
            return volumeProvisioned;
        }
        public void setVolumeProvisioned(String volumeProvisioned) {
            this.volumeProvisioned = volumeProvisioned;
        }

        @XmlElement(name = "publicKey" , namespace = "urn:com.twinstrata.webservice:2.1")
        public String getPublicKey() {
            return publicKey;
        }
        public void setPublicKey(String publicKey) {
            this.publicKey = publicKey;
        }


        @Override
        public String toString() {
            StringBuilder builder = new StringBuilder();
            builder.append("ResponseXML [userName=");
            builder.append(userName);
            builder.append(", license=");
            builder.append(license);
            builder.append(", signature=");
            builder.append(signature);
            builder.append(", licenseTag=");
            builder.append(licenseTag);
            builder.append(", accountNumber=");
            builder.append(accountNumber);
            builder.append(", licenseType=");
            builder.append(licenseType);
            builder.append(", licenseClass=");
            builder.append(licenseClass);
            builder.append(", volumeAllowed=");
            builder.append(volumeAllowed);
            builder.append(", volumeProvisioned=");
            builder.append(volumeProvisioned);
            builder.append(", publicKey=");
            builder.append(publicKey);
            builder.append("]");
            return builder.toString();
        }
    }

Currently , It maps only one property of XML , that is "signature". For the sake of simplicity, I don't want to make other classes and nest the objects inside it. I just want to parse nested xml tags in single Java class. How do I do that ?

Answer 1

Note: I'm the EclipseLink JAXB (MOXy) lead and a member of the JAXB (JSR-222) expert group.

ResponseXML

You could use MOXy's @XmlPath extension to map your use case (see: http://blog.bdoughan.com/2010/09/xpath-based-mapping-geocode-example.html ). Below is a partial mapping of your use case.

package forum15391077;

import javax.xml.bind.annotation.*;
import org.eclipse.persistence.oxm.annotations.XmlPath;

@XmlRootElement(name = "envelope")
@XmlType(propOrder={"licenseTag", "accountNumber", "licenseType", "licenseClass", "volumeAllowed", "volumeProvisioned", "signature", "license", "publicKey", "userName"})
@XmlAccessorType(XmlAccessType.FIELD)
public class ResponseXML {

    private String userName;
    private String license;
    private String signature;

    @XmlPath("urn:encoded/urn:response/urn:license/urn:licenseTag/text()")
    private String licenseTag;

    @XmlPath("urn:encoded/urn:response/urn:license/urn:accountNumber/text()")
    private String accountNumber;

    @XmlPath("urn:encoded/urn:response/urn:license/urn:licenseType/text()")
    private String licenseType;

    @XmlPath("urn:encoded/urn:response/urn:license/urn:licenseClass/text()")
    private String licenseClass;

    @XmlPath("urn:encoded/urn:response/urn:license/urn:volumeAllowed/text()")
    private String volumeAllowed;

    @XmlPath("urn:encoded/urn:response/urn:license/urn:volumeProvisioned/text()")
    private String volumeProvisioned;

    private String publicKey;

}

package-info

We will use the package level @XmlSchema annotation to specify the namespace qualification (see: http://blog.bdoughan.com/2010/08/jaxb-namespaces.html ). We will also use it to define the urn prefix which we leveraged in the @XmlPath annotation.

@XmlSchema(
    namespace="urn:com.twinstrata.webservice:2.1",
    elementFormDefault=XmlNsForm.QUALIFIED,
    xmlns={
        @XmlNs(namespaceURI = "urn:com.twinstrata.webservice:2.1", prefix = "urn")
    }
)
package forum15391077;

import javax.xml.bind.annotation.*;

jaxb.properties

To specify MOXy as your JAXB provider you need to include a file called jaxb.properties in the same package as your domain model with the following entry (see: http://blog.bdoughan.com/2011/05/specifying-eclipselink-moxy-as-your.html )

javax.xml.bind.context.factory=org.eclipse.persistence.jaxb.JAXBContextFactory

Demo

Since MOXy is a standard JAXB implementation, the standard JAXB runtime APIs are used.

package forum15391077;

import java.io.File;
import javax.xml.bind.*;

public class Demo {

    public static void main(String[] args) throws Exception {
        JAXBContext jc = JAXBContext.newInstance(ResponseXML.class);

        Unmarshaller unmarshaller = jc.createUnmarshaller();
        File xml = new File("src/forum15391077/input.xml");
        ResponseXML response = (ResponseXML) unmarshaller.unmarshal(xml);

        Marshaller marshaller = jc.createMarshaller();
        marshaller.setProperty(Marshaller.JAXB_FORMATTED_OUTPUT, true);
        marshaller.marshal(response, System.out);
    }

}

input.xml/Output

Below is a sample XML document based on the part of your use case that I mapped.

<?xml version="1.0" encoding="UTF-8"?>
<urn:envelope xmlns:urn="urn:com.twinstrata.webservice:2.1">
   <urn:encoded>
      <urn:response>
         <urn:license>
            <urn:licenseTag>WHATEVER934</urn:licenseTag>
            <urn:accountNumber>2016763117</urn:accountNumber>
            <urn:licenseType>TRIAL</urn:licenseType>
            <urn:licenseClass>Credentialed</urn:licenseClass>
            <urn:volumeAllowed>Unlimited</urn:volumeAllowed>
            <urn:volumeProvisioned>0</urn:volumeProvisioned>
         </urn:license>
      </urn:response>
   </urn:encoded>
   <urn:signature>Hl8rk2aTEsOkkq5e383LH0BqdFfmVcKIg9FuFEnnrlFk9fwYVEQwkrm/7MPM2Zmli2Um00L2Ab25tZg2w8pEzXyDsd+vwCAH0ypQwhIVPayDjgYKlYXbnkqG5S+7qiVbqD2qZDektuPoEWvaSdxO3ZgUibT+nnrO0kl6E7i4lB0=
    </urn:signature>
</urn:envelope>

Answer 2

我通过创建嵌套类并使用正确的JAXB注释使其工作。