Spring WS client add SoapHeader

Question

I'm trying to send SOAP request with soap header looks like this:

<SOAP-ENV:Header>
<Security xmlns="http://www.xxx.org/xxx/2003/05">
<UsernameToken><Username>yyyy</Username><Password>xxx</Password>
</UsernameToken></Security></SOAP-ENV:Header>

In order to do it I'm adding header element using SoapActionCallback

SoapActionCallback actionCallBack = new SoapActionCallback("https://aaa.com/bbb.asmx") {
            public void doWithMessage(WebServiceMessage msg) {
                SoapMessage smsg = (SoapMessage) msg;
                smsg.setSoapAction("http://www.xxx.org/yyy/2003/05/SessionCreate");
                SoapHeaderElement security = smsg.getSoapHeader().addHeaderElement(new QName("http://www.xxx.org/yyy", "Security"));
                security.setText("<UsernameToken><Username>yyyy</Username><Password>xxx</Password></UsernameToken>");
            }
        };

My problem is that soap header looks like this

<SOAP-ENV:Header><Security xmlns="http://www.xxx.org/yyy/2003/05">&lt;UsernameToken&gt;&lt;Username&gt;yyyyy&lt;/Username&gt;&lt;Password&gt;xxxx&lt;/Password&gt;&lt;/UsernameToken&gt;</Security></SOAP-ENV:Header>

And as result my request fails:

How can I add this message correct?

Do you know that you can convert any soap element to Java Element or Node and then get the document and create new Node/Element and append them to your current soap element ? This being said, what you are trying to be achieve can be configured by spring — VirtualTroll, Oct 02 '13 at 16:14
@VirtualTroll how about showing how it can be done instead of simply stating that it can be? seems like that would be a great answer. — digitaljoel, Apr 18 '14 at 04:04

score 3 · Accepted Answer · edited May 23 '17 at 12:13

I want the same thing as well. However, as it appears in my own searching, Spring doesn't have full functions like the SOAPMessage in java. What you probably needed was an addChildElement() to the header.

I ended up ditching the SoapMessage building and went with this:

SOAPMessage message = MessageFactory.newInstance();
private void buildHeader(String userName, String password) throws SOAPException{
    SOAPHeader header = message.getSOAPHeader();
    QName authHeader = new QName(SCHEMA, "AuthenticationHeader", SCHEMA_PREFIX);
    SOAPHeaderElement authElement = header.addHeaderElement(authHeader);

    QName userNameHeader = new QName(SCHEMA, "UserName", SCHEMA_PREFIX);
    SOAPElement userElement = authElement.addChildElement((userNameHeader));
    userElement.setTextContent(userName);

    QName passwordHeader = new QName(SCHEMA, "Password", SCHEMA_PREFIX);
    SOAPElement passwdElement = authElement.addChildElement(passwordHeader);
    passwdElement.setTextContent(password);


}

Do note that with the approach above passing a SOAPMessage using sendSourceAndReceiveToResult wraps the SOAPMessage in another envelope and this is not what we want. :(

Update (10/25/2013): I found this solution in another discussion. It's a little vague but worth looking into. I'll try to test this out on my end. One of my colleagues tried out spring-integration-ws and looking in google for the topic and soap headers yielded some promising resources.

Update (10/25/2013): After fooling around with the library I discovered there is a quicker way to wrap the SOAPMessage into Spring's SoapMessage using this:

// message is a SOAPMessage object with custom headers
SoapMessage soapMessage = new SaajSoapMessage(message);
soapMessage.writeTo(System.out);

Perhaps after you build your soapmessage you can route it to spring-ws and so on.

As a supplemental solution, I ditched the Spring-WS client approach as well, as having to marshall them through spring was more trouble and time consuming that it was worth. It was simpler to do it in java Saaj & JAXB anyway. — Chad, Oct 14 '13 at 08:12
Not sure if there is a good way to "route" a soap message into Spring-WS. Searching now... — IcedDante, Apr 03 '14 at 15:03

Spring WS client add SoapHeader

1 Answers1

Linked