Removing namespace prefix in the output of Spring WS web service

Question

I have created web service using Spring-WS. When I send a request to the web service, this is the response I get in soap-ui:

enter code here
<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/">
   <SOAP-ENV:Header/>
   <SOAP-ENV:Body>
      <ns2:SendResponse xmlns:ns2="http://mycompany.com/schema/">
         <ns2:SendResult>
            <ns2:Token>A00179-02</ns2:Token>
         </ns2:SendResult>
      </ns2:SendResponse>
   </SOAP-ENV:Body>
</SOAP-ENV:Envelope>

Is there any way to get rid of the "ns2" namespace prefix from the response? I tried a couple of options: 1) Manually updated package-info.java to set the prefix to "":

@XmlSchema(namespace = "http://mycompany.com/schema/",  
    xmlns = {   
        @XmlNs(namespaceURI = "http://mycompany.com/schema/", prefix = "")  
    },  
    elementFormDefault = javax.xml.bind.annotation.XmlNsForm.QUALIFIED)  

package com.example.foo.jaxb;

2) Set the prefix to "" in the QName object in the endpoint class:

return new JAXBElement<SendAndCommitResponse>(new QName("http://mycompany.com/schema/",
"SendResponse",""), SendResponse.class, response);

Both didn't work. How to get rid off the "ns2" namespace prefix?

Try: `@XmlSchema(namespace = "http://mycompany.com/schema/", elementFormDefault = javax.xml.bind.annotation.XmlNsForm.UNQUALIFIED)`. In the `package-info.java`. — acdcjunior, May 17 '13 at 20:20
That didn't work. I'm getting a SOAP fault after setting the element form unqualified. — Anand Jayabalan, May 17 '13 at 20:27
Alright, what about that same `@XmlSchema`, but with `QUALIFIED`? There's a small chance, but have you tried? — acdcjunior, May 17 '13 at 20:38
I have tried the same `@XmlSchema` with `QUALIFIED` as well, with no luck. — Anand Jayabalan, May 17 '13 at 20:44
@Anand Did you ever find a solution to this ? I'm currently facing the same problem and searching in vain. — Jimmy Selgen Nielsen, Jun 03 '13 at 19:18
@JimmySelgenNielsen, I couldn't find a way to get rid of the "ns2" namespace prefix. Instead, in the client when reading the XML, I ignore the namespace prefix by using namespace aware methods (for example: doc.getElementsByTagNameNS("*", "Token")) — Anand Jayabalan, Jun 25 '13 at 14:50

score 2 · Accepted Answer · answered Jun 25 '13 at 20:16

I eventually found a solution for this.

My problem was caused by JDK 6 not shipping a full version of rt.jar (http://www.oracle.com/technetwork/java/javase/compatibility-137541.html).

I added the following to my maven config

<dependency>
    <groupId>com.sun.xml.bind</groupId>
    <artifactId>jaxb-impl</artifactId>
    <version>2.2.6</version>
</dependency>

And then added

@XmlSchema(namespace = "http://mycompany.com/schema/", 
   elementFormDefault = javax.xml.bind.annotation.XmlNsForm.UNQUALIFIED).

In the package-info.java (like suggested by @acdcjunior above)

this just caused my content to have ns4 instead of ns2?? – GSUgambit Feb 26 '18 at 19:58 — GSUgambit, Feb 26 '18 at 19:58

score 2 · Answer 2 · answered Jun 19 '19 at 05:29

I tried a few of the approaches discussed here, but nothing worked...

Below Class from the link - https://zhuanlan.zhihu.com/p/35298171 fixed my issue

Added the below interceptor to remove the namespaces -

public class PayloadPrefixInterceptor extends TransformerHelper implements EndpointInterceptor {

    public static final String NAMESPACE = ObjectFactory.class.getPackage().getAnnotation(XmlSchema.class).namespace();
    public static final String XMLNS = "xmlns:";

    @Override
    public boolean handleRequest(MessageContext messageContext, Object endpoint) throws Exception {
        return true;
    }

    @Override
    public boolean handleResponse(MessageContext messageContext, Object endpoint) throws Exception {
        WebServiceMessage response = messageContext.getResponse();
        Source payloadSource = response.getPayloadSource();
        DOMResult result = new DOMResult();
        transform(payloadSource, result);
        removePrefix(result.getNode());
        transform(new DOMSource(result.getNode()), response.getPayloadResult());
        return true;
    }

    private void removePrefix(Node node) {
        if (node == null) {
            return;
        }

        if (node.getNodeType() == Node.ELEMENT_NODE) {
            removeNamespaceDeclaration(node);
        }
        if (node.getPrefix() != null) {
            node.setPrefix(null);
        }
        NodeList childNodes = node.getChildNodes();
        if (childNodes != null) {
            IntStream.of(0, childNodes.getLength()).forEach(index -> removePrefix(childNodes.item(index)));
        }
        Node nextSibling = node.getNextSibling();
        if (nextSibling != null) {
            removePrefix(nextSibling);
        }
    }

    private void removeNamespaceDeclaration(Node node) {
        NamedNodeMap attributes = node.getAttributes();
        IntStream.range(0, attributes.getLength()).forEach(index -> {
            Node attribute = attributes.item(index);
            if (StringUtils.startsWith(attribute.getNodeName(), XMLNS) &&
                    StringUtils.equals(attribute.getNodeValue(), NAMESPACE)) {
                attributes.removeNamedItemNS(attribute.getNamespaceURI(), attribute.getLocalName());
            }
        });
    }

    @Override
    public boolean handleFault(MessageContext messageContext, Object endpoint) throws Exception {
        return true;
    }

    @Override
    public void afterCompletion(MessageContext messageContext, Object endpoint, Exception ex) throws Exception {
    }
}

Registered the interceptor using below -

@EnableWs
@Configuration
public class Config extends WsConfigurerAdapter {

    @Override
    public void addInterceptors(List<EndpointInterceptor> interceptors) {
        interceptors.add(new PayloadPrefixInterceptor());
        super.addInterceptors(interceptors);
    }

}

score 0 · Answer 3 · edited Dec 12 '14 at 00:24

it was hard

first: create a class that intercepts soap request and responses:

package examples.webservices.handler;

import java.lang.reflect.Method;
import java.util.Collections;
import java.util.Set;

import javax.xml.namespace.QName;
import javax.xml.soap.SOAPElement;
import javax.xml.soap.SOAPMessage;
import javax.xml.ws.handler.MessageContext;
import javax.xml.ws.handler.soap.SOAPHandler;
import javax.xml.ws.handler.soap.SOAPMessageContext;

import org.w3c.dom.Node;
import org.w3c.dom.NodeList;

public class CorrigirConteudoRequisicaoSOAP implements SOAPHandler<SOAPMessageContext> {
    public Set<QName> getHeaders() {
        return Collections.emptySet();
    }

    public boolean handleMessage(SOAPMessageContext messageContext) {
        this.corrigirConteudoRequisicaoSOAP(messageContext);
        return true;
    }

    private void corrigirConteudoRequisicaoSOAP(SOAPMessageContext messageContext){
        SOAPMessage msg = messageContext.getMessage();
        try {
            NodeList childNodes = msg.getSOAPBody().getChildNodes();

            for(int k = 0; k < childNodes.getLength(); k++){
                Node item = childNodes.item(k);
                String localName = item.getLocalName();
                {
                    item.setPrefix("");
                    Method m = SOAPElement.class.getDeclaredMethod("setElementQName", QName.class);
                    //I was forced to use reflection because the method setElementQname is not //visible, neither the class that implements it
                    m.invoke(item, new QName("", item.getLocalName()));
                    msg.saveChanges();
                }

            }
        } catch (Exception e) {
            try {
                msg.writeTo(System.out);
            } catch (Exception e1) {
                e1.printStackTrace();
            }
            System.out.println();
        }
    }

    public boolean handleFault(SOAPMessageContext messageContext) {
        return true;
    }

    public void close(MessageContext messageContext) {
    }

    public static void main(String[] args)throws Exception {
    }
}

second: associate the service to soap handle

public class PortalFornecedor {

    public Usuario getUsuario(){
        XIF367Afae09A3344Fbf2E1De819D6EcbaService classeComNomeFeio = new XIF367Afae09A3344Fbf2E1De819D6EcbaService();

        Usuario service = classeComNomeFeio.getHTTPPort();
        BindingProvider bp = (BindingProvider)service;
        Map<String, Object> requestContext = bp.getRequestContext();
        requestContext.put(BindingProvider.USERNAME_PROPERTY, "user");
        requestContext.put(BindingProvider.PASSWORD_PROPERTY, "pass");
        this.handle(service);
        return service;
    }

    public Object getDashboard(){
        return "";
    }
    // here we associate the service to soap handle
    private BindingProvider handle(Usuario service) {
        BindingProvider bp = (BindingProvider)service;
        @SuppressWarnings("rawtypes")
        List<Handler> chain = new ArrayList<Handler>();
        chain.add(new CorrigirConteudoRequisicaoSOAP());
        bp.getBinding().setHandlerChain(chain);
        return bp;
    }

    public static void main(String[] args) {

        PortalFornecedor pf = new PortalFornecedor();
        Usuario usuario = pf.getUsuario();
        LoginExecutarIN in = new LoginExecutarIN();
        generated.Usuario user = new generated.Usuario();
        user.setLogin("onias");
        user.setSenha("12345");
        user.setCodigoUsuario(0);
        in.setParametroEntrada(user);
        try {
            LoginExecutarOUT out = usuario.loginExecutar(in);
            // SOAPMessageContext.getMessage();

            System.out.println(out.getRegistroSelecionado().getNome());
        } catch (Exception e) {
            e.printStackTrace();
        }
    }

}

score 0 · Answer 4 · answered Oct 03 '20 at 04:26

Here is the simple and easiest solution for that problem. Create Package-Info.Java file in your model package and add the below script to that.

@javax.xml.bind.annotation.XmlSchema(namespace = "http://mycompany.com/schema", elementFormDefault = javax.xml.bind.annotation.XmlNsForm.QUALIFIED, xmlns = { @javax.xml.bind.annotation.XmlNs(namespaceURI = "http://mycompany.com/schema", prefix = "") })
package my.com.scicom.stars.model;

And add elementFormDefault as "qualified" in your xsd or wsdl file.

<xs:schema xmlns:xs="http://www.w3.org/2001/XMLSchema"
           xmlns="http://mycompany.com/schema"
           targetNamespace="http://mycompany.com/schema"
           elementFormDefault="qualified">

Removing namespace prefix in the output of Spring WS web service

4 Answers4

Linked