Getting Raw XML From SOAPMessage in Java

Question

I've set up a SOAP WebServiceProvider in JAX-WS, but I'm having trouble figuring out how to get the raw XML from a SOAPMessage (or any Node) object. Here's a sample of the code I've got right now, and where I'm trying to grab the XML:

@WebServiceProvider(wsdlLocation="SoapService.wsdl")
@ServiceMode(value=Service.Mode.MESSAGE)
public class SoapProvider implements Provider<SOAPMessage>
{
    public SOAPMessage invoke(SOAPMessage msg)
    {
        // How do I get the raw XML here?
    }
}

Is there a simple way to get the XML of the original request? If there's a way to get the raw XML by setting up a different type of Provider (such as Source), I'd be willing to do that, too.

palacsint · Accepted Answer · 2013-07-19 12:53:19Z

174

You could try in this way.

SOAPMessage msg = messageContext.getMessage();
ByteArrayOutputStream out = new ByteArrayOutputStream();
msg.writeTo(out);
String strMsg = new String(out.toByteArray());

edited Jul 19, 2013 at 12:53

palacsint

29k11 gold badges85 silver badges113 bronze badges

answered Sep 29, 2009 at 3:22

Smith Torsahakul

1,7492 gold badges10 silver badges2 bronze badges

Sign up to request clarification or add additional context in comments.

4 Comments

artbristol Over a year ago

This doesn't take character encoding into account

Ruslan Over a year ago

Will it consume much memory with something like constructing DOM objects or the like? Or will it really give the raw string from the HTTP response without internally parsing the xml?

Ashish Kathait Over a year ago

@artbristol : you can use String class other constructor i.e. String(out.toByteArray(),StandardCharsets.UTF_8) for handling character encoding

artbristol Over a year ago

Sigh. 166 upvotes so far. Please don't use this answer. You will mangle your 'special characters'. You can't use the String constructor idea suggested by Ashish, because you would need to specify the character encoding in the source code at compile time, but you don't know it until runtime. Please use my answer.

artbristol · Accepted Answer · 2013-11-20 08:58:47Z

28

If you have a SOAPMessage or SOAPMessageContext, you can use a Transformer, by converting it to a Source via DOMSource:

            final SOAPMessage message = messageContext.getMessage();
            final StringWriter sw = new StringWriter();

            try {
                TransformerFactory.newInstance().newTransformer().transform(
                    new DOMSource(message.getSOAPPart()),
                    new StreamResult(sw));
            } catch (TransformerException e) {
                throw new RuntimeException(e);
            }

            // Now you have the XML as a String:
            System.out.println(sw.toString());

This will take the encoding into account, so your "special characters" won't get mangled.

edited Nov 20, 2013 at 8:58

answered Nov 20, 2013 at 8:53

artbristol

32.5k5 gold badges73 silver badges104 bronze badges

1 Comment

lospejos Over a year ago

Is provided solustion memory-consuming?

Shahadat Hossain Khan · Accepted Answer · 2014-09-11 09:42:23Z

14

for just debugging purpose, use one line code -

msg.writeTo(System.out);

answered Sep 11, 2014 at 9:42

Shahadat Hossain Khan

73710 silver badges25 bronze badges

2 Comments

nanofarad Over a year ago

The OP is not necessarily debugging to System.out (which isn't necessarily conveniently accessible for a webserver)--he/she might need to send the original XML over a socket, store it somewhere, or calculate its statistics.

vikingsteve Over a year ago

You can easily write to a ByteArrayOutputStream convert to String... seems easy to me

childno͡.de · Accepted Answer · 2012-08-23 14:48:16Z

13

It turns out that one can get the raw XML by using Provider<Source>, in this way:

import java.io.ByteArrayOutputStream;
import javax.xml.transform.Source;
import javax.xml.transform.Transformer;
import javax.xml.transform.TransformerFactory;
import javax.xml.transform.stream.StreamResult;
import javax.xml.ws.Provider;
import javax.xml.ws.Service;
import javax.xml.ws.ServiceMode;
import javax.xml.ws.WebServiceProvider;

@ServiceMode(value=Service.Mode.PAYLOAD)
@WebServiceProvider()
public class SoapProvider implements Provider<Source>
{
    public Source invoke(Source msg)
    {
        StreamResult sr = new StreamResult();

        ByteArrayOutputStream out = new ByteArrayOutputStream();
        sr.setOutputStream(out);

        try {
            Transformer trans = TransformerFactory.newInstance().newTransformer();
            trans.transform(msg, sr);

            // Use out to your heart's desire.
        }
        catch (TransformerException e) {
            e.printStackTrace();
        }    

        return msg;
    }
}

I've ended up not needing this solution, so I haven't actually tried this code myself - it might need some tweaking to get right. But I know this is the right path to go down to get the raw XML from a web service.

(I'm not sure how to make this work if you absolutely must have a SOAPMessage object, but then again, if you're going to be handling the raw XML anyways, why would you use a higher-level object?)

edited Aug 23, 2012 at 14:48

childno͡.de

4,8744 gold badges36 silver badges60 bronze badges

answered Feb 25, 2009 at 19:00

Dan Lew

87.7k33 gold badges184 silver badges177 bronze badges

1 Comment

artbristol Over a year ago

A StringWriter is a good alternative to the ByteArrayOutputStream+StreamResult combination, if you want the XML as a String with the correct encoding

Sireesh Yarlagadda · Accepted Answer · 2016-06-22 20:10:20Z

Using Transformer Factory:-

public static String printSoapMessage(final SOAPMessage soapMessage) throws TransformerFactoryConfigurationError,
            TransformerConfigurationException, SOAPException, TransformerException
    {
        final TransformerFactory transformerFactory = TransformerFactory.newInstance();
        final Transformer transformer = transformerFactory.newTransformer();

        // Format it
        transformer.setOutputProperty(OutputKeys.INDENT, "yes");
        transformer.setOutputProperty("{http://xml.apache.org/xslt}indent-amount", "2");

        final Source soapContent = soapMessage.getSOAPPart().getContent();

        final ByteArrayOutputStream streamOut = new ByteArrayOutputStream();
        final StreamResult result = new StreamResult(streamOut);
        transformer.transform(soapContent, result);

        return streamOut.toString();
    }

Michael Myers · Accepted Answer · 2010-12-04 16:52:56Z

7

If you need formatting the xml string to xml, try this:

String xmlStr = "your-xml-string";
Source xmlInput = new StreamSource(new StringReader(xmlStr));
Transformer transformer = TransformerFactory.newInstance().newTransformer();
transformer.setOutputProperty(OutputKeys.INDENT, "yes");
transformer.setOutputProperty("{http://xml.apache.org/xslt}indent-amount", "2");
transformer.transform(xmlInput,
        new StreamResult(new FileOutputStream("response.xml")));

edited Dec 4, 2010 at 16:52

Michael Myers♦

193k47 gold badges301 silver badges297 bronze badges

answered Dec 4, 2010 at 16:28

Hari

711 silver badge1 bronze badge

1 Comment

Philippe Gioseffi Over a year ago

Is it possible to choose between spaces and tabs to do this formatting? BTW, I know tabs are not indicated.

sygi · Accepted Answer · 2017-04-13 14:32:41Z

3

this works

 final StringWriter sw = new StringWriter();

try {
    TransformerFactory.newInstance().newTransformer().transform(
        new DOMSource(soapResponse.getSOAPPart()),
        new StreamResult(sw));
} catch (TransformerException e) {
    throw new RuntimeException(e);
}
System.out.println(sw.toString());
return sw.toString();

edited Apr 13, 2017 at 14:32

sygi

4,6872 gold badges38 silver badges57 bronze badges

answered Apr 13, 2017 at 12:32

user2900572

6213 gold badges9 silver badges24 bronze badges

1 Comment

Martin Kersten Over a year ago

No explanation needed.

ARIJIT · Accepted Answer · 2016-06-17 15:20:02Z

0

if you have the client code then you just need to add the following two lines to get the XML request/response. Here _call is org.apache.axis.client.Call

String request = _call.getMessageContext().getRequestMessage().getSOAPPartAsString();
String response = _call.getMessageContext().getResponseMessage().getSOAPPartAsString();

answered Jun 17, 2016 at 15:20

ARIJIT

6775 silver badges7 bronze badges

Comments

Oguz Demir · Accepted Answer · 2019-08-13 17:37:59Z

It is pretty old thread but recently i had a similar issue. I was calling a downstream soap service, from a rest service, and I needed to return the xml response coming from the downstream server as is.

So, i ended up adding a SoapMessageContext handler to get the XML response. Then i injected the response xml into servlet context as an attribute.

public boolean handleMessage(SOAPMessageContext context) {

            // Get xml response
            try {

                ServletContext servletContext =
                        ((ServletRequestAttributes) RequestContextHolder.getRequestAttributes()).getRequest().getServletContext();

                SOAPMessage msg = context.getMessage();

                ByteArrayOutputStream out = new ByteArrayOutputStream();
                msg.writeTo(out);
                String strMsg = new String(out.toByteArray());

                servletContext.setAttribute("responseXml", strMsg);

                return true;
            } catch (Exception e) {
                return false;
            }
        }

Then I have retrieved the xml response string in the service layer.

ServletContext servletContext =
                ((ServletRequestAttributes) RequestContextHolder.getRequestAttributes()).getRequest().getServletContext();

        String msg = (String) servletContext.getAttribute("responseXml");

Didn't have chance to test it yet but this approach must be thread safe since it is using the servlet context.

Collectives™ on Stack Overflow

Getting Raw XML From SOAPMessage in Java

9 Answers 9

4 Comments

1 Comment

2 Comments

1 Comment

Comments

1 Comment

1 Comment

Comments

Comments

Your Answer

Linked

Hot Network Questions

Collectives™ on Stack Overflow

9 Answers 9

4 Comments

1 Comment

2 Comments

1 Comment

Comments

1 Comment

1 Comment

Comments

Comments

Your Answer

Sign up or log in

Post as a guest

Linked

Related