Web Services and XML Documents

For some it's obvious. As it was not for me, I decided to put it on e-paper so that you can google this when you need it.

If you want to exchange XML Document, meaning the whole content of an XML file, with Web services, you should not use org.w3c.dom.Document or any other object representation of your XML DOM tree in your method signature. Instead, you should be using a Plain Old Types (POT) like String or byte[].

Take the following code sample, here using JSR-181 annotations:

@WebMethod
public Document getDocument(String input) {
  Document res = null;
  try {
    DOMParser builder = new DOMParser();
    builder.parse(new StringReader(STR_XML_DOCUMENT));
    res = builder.getDocument();
  } catch (Exception ex) {
    ex.printStackTrace();
  }
  return res;
}

private static final String STR_XML_DOCUMENT =
  "<?xml version=\"1.0\"?>\n" +
  "<!DOCTYPE module PUBLIC\n" +
  "\"-//Puppy Crawl//DTD Check Configuration 1.2//EN\"\n" +
  "\"http://www.puppycrawl.com/dtds/configuration_1_2.dtd\">\n" +
  "\n" + "<module name=\"Checker\">\n" +
  " <!-- Comments are safe -->\n" +
  " <metadata name=\"com.atlas-sw.eclipse\" value=\"I like   Sydney\"/>\n" +
  "</module>";


You will be able to assemble and deploy the service endpoint just fine, but it may not behaves as once could expect. The SOAP Response carries only the inner Element; the <module> node.

<?xml version="1.0" encoding="UTF-8"?>
  <env:Envelope
   xmlns:env="http://schemas.xmlsoap.org/soap/envelope/"
   xmlns:xsd="http://www.w3.org/2001/XMLSchema"
   xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
   xmlns:ns0="http://rajkovic.org/types/">
  <env:Body>
    <ans1:getDocumentResponse        xmlns:ans1="http://rajkovic.org/">
      <ns0:return>
        <module name="Checker">
          <metadata name="com.atlas-sw.eclipse" value="I like Sydney"/>
        </module>
      </ns0:return>
    </ans1:getDocumentResponse>
  </env:Body>
</env:Envelope>


If the PI, CDATA or comments are important to you, using org.w3c.dom.Document or org.w3c.dom.Element is not an option. Instead, you should be using xsd:string or some binary data type like byte[].

-ecco

ps. This information is based on the current 10.1.3.0 release of JDeveloper.

Comments

Post a Comment

Popular posts from this blog

Changing the version of JDK used by JDeveloper

I have recently learned a quick and lazy way to change the version of the JDK used to run JDeveloper 10g R3. I am sure there is an option somewhere in the configuration screen to do the same, which I couldn't find... While JDeveloper is not running, locate the embedded JDK on disk and rename (or delete) that directory. For me, it was C:\opt\jdev\jdk. Once it's done, restart and you will by asked to locate the version of the JDK you want to use. It's another step to get going with JAVA on Vista. -ecco
Read more

Connection reset from a WCF Web Service

Here is an error message you may see, when calling WCF Web Services from java: IOException retrieving the response: java.net.SocketException: Connection reset As it may not be obvious the first time you see it, this may save you some time. One reason for this behaviour is when the WCF endpint is expecting to see wsa:Action SOAP header in the request. To find out if you are facing this case, you have to look inside the WSDL, and search for the policy that describes the contract for your endpoint. <wsp:Policy wsu:Id="CustomBinding_Echo1_policy">   <wsp:ExactlyOne>     <wsp:All>       <wsaw:UsingAddressing/>     </wsp:All>   </wsp:ExactlyOne> </wsp:Policy> To make this a concrete example, here is a sample WSDL . To find the policy, you will need to follow the import as the policy are not always advertized in the top-level document. Here is how the import looks:   <ws...
Read more

unexpected null value for literal data

There is a challenge that is hard to overcome at first; making sense of error messages. You can always Google with the text of the error, “unexpected null value for literal data” and hope to be lucky . If you are using Oracle Application Server 10.1.3.0, here is the explaination for the message and two ways out. The Exception: unexpected null value for literal data at oracle.j2ee.ws.common.util.exception.JAXRPCExceptionBase.<init>(JAXRPCExceptionBase.java:52) at oracle.j2ee.ws.common.encoding.SerializationException.<init>(SerializationException.java:26) ... The relevant schema: <complexType name="Customer"> <sequence> <element name="address" type="tns:Address"/> <element name="firstName" type="string"/> <element name="lastName" type="string"/> </sequence> </complexType> A sample code that will cause this exception: public void testServ() throw...
Read more