JAXM and entities in SOAP document

Question

I've been trying out JAXM (1.0.0) and I've reached a situation where JAXM is telling me that I can't have entities (such as & lt ;) in my SOAP document. I've not seen this restriction mentioned anywhere before -- I can't find it in the SOAP 1.1 spec. Can anyone provide me with a clue here?
The exception is:
javax.xml.soap.SOAPException: Unable to create envelope from given source: Entities are illegal in a SOAP document Nested exception: Entities are illegal in a SOAP document at com.sun.xml.messaging.soap.dom4j.EnvelopeFactoryImpl.createEnvelope(EnvelopeFactoryImpl.java:76)
at com.sun.xml.messaging.soap.SOAPPartImpl.getEnvelope(SOAPPartImpl.java:92)
I'm trying to do the following; for testing I thought it would be useful to modify the simple.war/ReceiveServlet to return the message it receives in a SOAP response. That is, if I send a message like this.....
<soap-env:Envelope xmlns:soap-env="http://schemas.xmlsoap.org/soap/envelope/">
<soap-env:Body>
<f:checksheet-request xmlns:f="http://someone.com/SOAP/checksheet" locale="en_GB">
<VIN>12345678901234567
</VIN>
</f:checksheet-request>
</soap-env:Body>
</soap-env:Envelope>
I'd get back the following......
<soap-env:Envelope xmlns:soap-env="http://schemas.xmlsoap.org/soap/envelope/">
<soap-env:Header/>
<soap-env:Body>
<Response><soap-env:Envelope xmlns:soap-env="http://schemas.xmlsoap.org/soap/envelope/"><soap-env:Body><f:checksheet-request xmlns:f="http://someone.com/SOAP/checksheet" locale="en_GB"><VIN>12345678901234567</VIN></f:checksheet-request></soap-env:Body></soap-env:Envelope>
</Response>
</soap-env:Body>
</soap-env:Envelope>
...and those are the messages that are sent (I watched the messages using the Axis project's tcpmon tool).
This is the code I'm using the read the message:
SOAPMessage response = connection.call(message, endpoint);
SOAPPart soapPart = response.getSOAPPart();
// The next line throws the exeption....
SOAPEnvelope env = soapPart.getEnvelope();
What's the problem with having entities in the response?
Many thanks
Richard

Answer 1

Thanks for the help. The onMessage implementation is as follows:
public SOAPMessage onMessage(SOAPMessage message)
        logger.debug("onMessage called in receiving servlet");
        try
            logger.debug("Here's the message: ");
               ByteArrayOutputStream bytes = new ByteArrayOutputStream();
               message.writeTo(bytes);
               String receivedMessage = bytes.toString();
            logger.debug(receivedMessage);
            SOAPMessage msg = fac.createMessage();
            SOAPEnvelope env = msg.getSOAPPart().getEnvelope();
            env.getBody()
                .addChildElement(env.createName("Response"))
                .addTextNode(receivedMessage);
            return msg;
        catch(Exception e)
            logger.error("Error in processing or replying to a message", e);
            return null;
    }As you can probably tell, that's just a small change to one of the sample servlets in the JAXM distribution.
The client that sends the message is a junit test class as follows:
     public void testEchoSendRequest() throws SOAPException
          SOAPConnectionFactory scFactory =  SOAPConnectionFactory.newInstance();
          SOAPConnection connection = scFactory.createConnection();
          MessageFactory mf = MessageFactory.newInstance();
         SOAPMessage message = mf.createMessage();
           SOAPPart sp = message.getSOAPPart();
         SOAPEnvelope envelope = sp.getEnvelope();
         SOAPHeader header = envelope.getHeader();
          header.detachNode();
         SOAPBody body = envelope.getBody();
          Name bodyName = envelope.createName("checksheet-request",     
               "f", "http://someone.com/SOAP/checksheet");     
          SOAPBodyElement checksheetRequest = body.addBodyElement(bodyName);
          SOAPElement vin = checksheetRequest.addChildElement("VIN");
          vin.addTextNode("12345678901234567");
          checksheetRequest.addAttribute(envelope.createName("locale"), "en_GB");
          URLEndpoint endpoint = new URLEndpoint("http://127.0.0.1:9888/etis/soap-echo");     
          SOAPMessage response = connection.call(message, endpoint);
          assertTrue("Expected non-null response", response !=null);
          SOAPPart soapPart = response.getSOAPPart();
          SOAPEnvelope env = soapPart.getEnvelope();
          SOAPBody contents = env.getBody();
          assertTrue("Didn't expect a fault: "+ contents.getFault().getFaultString(), contents.hasFault() == false);
          Iterator it = contents.getChildElements(env.createName("Response"));
          assertTrue("Expected content in response", it != null && it.hasNext());
          SOAPBodyElement bodyElement = (SOAPBodyElement)it.next();     
          assertTrue("Expected non-empty response", bodyElement != null);
          String sentMsg = bodyElement.getValue();     
          System.out.println("Got back: "+sentMsg);
     }Thanks for looking into this.
Richard