Putting string in soap message

[Prajatna Mahunta]

How to put a string inside a soap message, which am sending.
Need to put a XML(which is in string format) inside the soap message.
Please suggest me how to put that string inside the soap message.

[Prajatna Mahunta]

Let me tell you one thing...we are using Java, in WAS 5.1

[Jimmy Clark]

Below is an example for reference.

SOAPMessage message = messageFactory.createMessage();
..
SOAPPart part = message.getSOAPPart();
SOAPEnvelope envelope = part.getEnvelope();
...
SOAPBody body = envelope.getBody();
...
SOAPElement string = body.addChildElement(envelope.createName("string","abc","http://abc.com"));
Name attr = envelope.createName("xsi:type");
string.addChildElement("stringName").addAttribute, "xsd:string").addTextNode("anotherString");
message.saveChanges();
...

[Peer Reynders]

Originally posted by Prajatna Mahunta:
Need to put a XML(which is in string format) inside the soap message.

Let me tell you one thing...we are using Java, in WAS 5.1

I suspect that you are actually asking how to pass or return a string that contains XML with a JAX-RPC web method. Under JAX-RPC a parameter that contains plain XML has to be in a javax.xml.soap.SOAPElement - otherwise the code generator doesn't know that it has to publish it under the "xsd:any" XML Schema Type.

See also Xml document as a SOAP payload

To convert a string that contains XML to a javax.xml.soap.SOAPElement you can use something like the following:

import java.io.InputStream;
import java.io.ByteArrayInputStream;
import java.io.IOException;
 
import javax.xml.parsers.DocumentBuilderFactory;
import javax.xml.parsers.ParserConfigurationException;
import org.xml.sax.SAXException;
import org.w3c.dom.Document;
 
//SAAJ
import javax.xml.soap.MessageFactory;
import javax.xml.soap.SOAPException;
import javax.xml.soap.SOAPMessage;
import javax.xml.soap.SOAPElement;
import javax.xml.soap.SOAPBody;
 

import javax.xml.soap.Node;
 
public class StrToSoapElem {
  
    public static SOAPElement stringToSOAPElement(String xmlText) {
        try {
            // Load the XML text into a DOM Document
            DocumentBuilderFactory builderFactory = DocumentBuilderFactory.newInstance();
            builderFactory.setNamespaceAware(true);
            InputStream stream  = new ByteArrayInputStream(xmlText.getBytes());
            Document doc = builderFactory.newDocumentBuilder().parse(stream); 
 
            // Use SAAJ to convert Document to SOAPElement
            // Create SoapMessage
            MessageFactory msgFactory = MessageFactory.newInstance();
            SOAPMessage    message    = msgFactory.createMessage();
            SOAPBody       soapBody   = message.getSOAPBody();
            
            // This returns the SOAPBodyElement 
            // that contains ONLY the Payload
            return soapBody.addDocument(doc);
          
        } catch (SOAPException  e) {
            System.out.println("SOAPException : " + e);
            return null;
 
        } catch (IOException  e) {
            System.out.println("IOException : " + e);
            return null;
 
        } catch (ParserConfigurationException  e) {
            System.out.println("ParserConfigurationException : " + e);
            return null;
 
        } catch (SAXException  e) {
            System.out.println("SAXException : " + e);
            return null;
 
        }
    }
 
    public static void main(String[] args) {
        // There is no XML Prolog as this is going to occur inside of another XML document
        String xmlText =
              "<mh:getBookPrice "
            +     "xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\" "
            +     "xmlns:mh=\"http://www.Monson-Haefel.com/jwsbook/BookQuote\">"
            +   "<isbn xsi:type=\"xsd:string\">0321146182</isbn>"
            + "</mh:getBookPrice>";
 
            SOAPElement payload       = stringToSOAPElement( xmlText );
       
            if( payload != null ) {
                // To test, navigate to the isbn value 
                Node node = (Node) payload;            // "mh:getBookPrice"
                System.out.println(
                    node.getChildNodes().item(0)       // "isbn"
                    .getChildNodes().item(0)           // text node inside "isbn" 
                        .getNodeValue()
                );
            } else {
                System.out.println("Conversion failed!");
            }
    }
}

[Peer Reynders]

Originally posted by Prajatna Mahunta:
We generated the client class using WSAD Wizard for this WSDL file, and we found that we need to send our input xml as Parameter. Problem here is the Method is expecting complex type as parameter where as we are generating our input xml as String. here We cant cast String variable to ComplexType.

J2EE 1.4 is supposed to support "JAX-RPC Mapping Files" which describe the custom binding between WSDL and Java types. There may be a mechanism by which you can provide the Wizard with a mapping file so that you can coerce that particular XML type to a String or SOAPElement (xsd:any).

"JAX-RPC Mapping Files" are described in "7.3 JAX-RPC Mapping Deployment Descriptor" of JSR-000921 Implementing Enterprise Web Services 1.1

Ultimately it may be easier to "tweak" a local copy of the WSDL (replace the appropriate XML type with xsd:any or xsd:string in the affected message part) so that the generated Java method is more to your liking.

Another alternative is JiBX to define a mapping between your XML to the generated complex type.
[ November 20, 2008: Message edited by: Peer Reynders ]

[vishnu viswanath]

Hi Peer Reynders ,

Can you tell me how to add text with xml to SOAPHeader. Since the addDocument method is not there for SOAPHeader.

Thanks