web-dev-qa-db-ja.com

SOAP応答のJAX-WSプレフィックスをカスタマイズする

ゴール

私はかなり古い（残念ながら変更できない）インターフェースのWebサービスを実装しています。サービスを呼び出しているクライアントがSOAP応答で特定の名前空間を期待しているため、一致するように変更するのが困難です。

こんにちは世界の例を考えると、私はこれが欲しい：

<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
   <S:Body>
      <ns2:helloResponse xmlns:ns2="http://test/">
         <return>Hello Catchwa!</return>
      </ns2:helloResponse>
   </S:Body>
</S:Envelope>

このように見えるように：

<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
   <S:Body>
      <customns:helloResponse xmlns:customns="http://test/">
         <return>Hello Catchwa!</return>
      </customns:helloResponse>
   </S:Body>
</S:Envelope>

私がやろうとしていることに似たものを見つけました here が、適切に実行するために同様のコードを取得するのに問題があります。 （Metroを使い続けたいのですが、cxfやaxisに変更する必要はありません）

実行

JAXBContextFactory を返す JAXBRIContext の実装は次のようになります。

import com.Sun.xml.bind.api.JAXBRIContext;
import com.Sun.xml.bind.api.TypeReference;
import com.Sun.xml.ws.api.model.SEIModel;
import com.Sun.xml.ws.developer.JAXBContextFactory;
import Java.util.ArrayList;
import Java.util.List;
import javax.xml.bind.JAXBException;
import javax.xml.namespace.QName;

public class HelloJaxbContext implements JAXBContextFactory
{
  @Override
  public JAXBRIContext createJAXBContext(SEIModel seim, List<Class> classesToBind, List<TypeReference> typeReferences) throws JAXBException {
    List<Class> classList = new ArrayList<Class>();
    classList.addAll(classesToBind);

    List<TypeReference> refList = new ArrayList<TypeReference>();
    for (TypeReference tr : typeReferences) {
        refList.add(new TypeReference(new QName(tr.tagName.getNamespaceURI(), tr.tagName.getLocalPart(), "customns"), tr.type, tr.annotations));
    }
    return JAXBRIContext.newInstance(classList.toArray(new Class[classList.size()]), refList, null, seim.getTargetNamespace(), false, null);
  }  
}

Webサービスのいくつかのテストコードは単純です。

import com.Sun.xml.ws.developer.UsesJAXBContext;
import javax.jws.WebService;
import javax.jws.WebMethod;
import javax.jws.WebParam;

@WebService(serviceName = "Hello")
@UsesJAXBContext(value = HelloJaxbContext.class)
public class Hello
{
  @WebMethod(operationName = "hello")
  public String hello(@WebParam(name = "name") String txt)
  {
    return "Hello " + txt + "!";
  }
}

問題

Tomcat 7.0.32とGlassfish 3.1.2（jaxws-rt 2.2.7（Maven製）を使用）では、上記のコードはWebサービスの出力に影響しません（名前空間の接頭辞は「ns2」のままです）。

javasoapjaxbjax-ws
19
Catchwa

古いサービスのWSDLから開始し、wsimportを使用してさまざまなJAXB注釈付きの要求および応答ラッパークラスをすべて生成した場合、生成されたパッケージで次のようなpackage-info.Javaを見つける必要があります。

@javax.xml.bind.annotation.XmlSchema(namespace = "http://test/")
package com.example.test;

JAXBは、@XmlSchemaアノテーションの接頭辞マッピングを提案するメカニズムを提供するため、package-info.Javaを変更して読み取ることができます

@javax.xml.bind.annotation.XmlSchema(namespace = "http://test/",
   xmlns = { 
      @javax.xml.bind.annotation.XmlNs(prefix = "customns", 
         namespaceURI="http://test/")
   }
)
package com.example.test;

生成されたメッセージに違いがあるかどうかを確認します。これには、純粋なJAXB仕様であるという利点もあります（つまり、RI固有のカスタムコンテキストファクトリに依存しません）。

wsimportを再実行する必要がある場合は、package-infoオプションをxjcに渡して、変更した-npaを上書きしないようにすることができます（これにより、 package-info.Java代わりに、必要なすべてのnamespace設定をクラスレベルのアノテーションに配置します）。これを正確に行う方法は、wsimportの実行方法によって異なります。

コマンドライン：

wsimport -B-npa ....

蟻：

<wsimport wsdl="..." destdir="..." .... >
  <xjcarg value="-npa" />
</wsimport>

Maven：

<plugin>
  <groupId>org.jvnet.jax-ws-commons</groupId>
  <artifactId>jaxws-maven-plugin</artifactId>
  <version>2.2</version>
  <executions>
    <execution>
      <goals>
        <goal>wsimport</goal>
      </goals>
      <configuration>
        <xjcArgs>
          <xjcArg>-npa</xjcArg>
        </xjcArgs>
      </configuration>
    </execution>
  </executions>
</plugin>
24
Ian Roberts

あなたが達成しようとしていることを達成するための推奨される/標準的な方法は SOAPMessage Handler を使用することです。これらは Chain of Responsibilityパターン を実装するために使用されるため、Java Webアプリケーションフィルター（理論的にはここでも機能します）に類似しています。たとえば、あなたの場合、あなたはこれを持つことができます：

import Java.util.Set;
import Java.util.logging.Level;
import Java.util.logging.Logger;
import javax.xml.namespace.QName;
import javax.xml.soap.SOAPBody;
import javax.xml.soap.SOAPEnvelope;
import javax.xml.soap.SOAPException;
import javax.xml.ws.handler.MessageContext;
import javax.xml.ws.handler.soap.SOAPHandler;
import javax.xml.ws.handler.soap.SOAPMessageContext;


public class SOAPBodyHandler implements SOAPHandler<SOAPMessageContext> {

static final String DESIRED_NS_PREFIX = "customns";
static final String DESIRED_NS_URI = "http://test/";
static final String UNWANTED_NS_PREFIX = "ns";

@Override
public Set<QName> getHeaders() {
   //do nothing
   return null;
}

@Override
public boolean handleMessage(SOAPMessageContext context) {
    if ((boolean) context.get(MessageContext.MESSAGE_OUTBOUND_PROPERTY)) { //Check here that the message being intercepted is an outbound message from your service, otherwise ignore.
        try {
            SOAPEnvelope msg = context.getMessage().getSOAPPart().getEnvelope(); //get the SOAP Message envelope
            SOAPBody body = msg.getBody();
            body.removeNamespaceDeclaration(UNWANTED_NS_PREFIX);
            body.addNamespaceDeclaration(DESIRED_NS_PREFIX, DESIRED_NS_URI); 
        } catch (SOAPException ex) {
            Logger.getLogger(SOAPBodyHandler.class.getName()).log(Level.SEVERE, null, ex);
        }
    }
    return true; //indicates to the context to proceed with (normal)message processing
}

@Override
public boolean handleFault(SOAPMessageContext context) {
      //do nothing
   return null;
}

@Override
public void close(MessageContext context) {
      //do nothing

}

}

サービス実装Beanクラス宣言に、以下を追加します

  @HandlerChain(file = "handler-chain.xml")

上記の注釈は、ハンドラーが実際に起動できるようにする構成ファイルへの参照です。設定ファイルは次のようになります

  <?xml version="1.0" encoding="UTF-8" standalone="yes"?>
     <javaee:handler-chains xmlns:javaee="http://Java.Sun.com/xml/ns/javaee" 
        xmlns:xsd="http://www.w3.org/2001/XMLSchema">
        <javaee:handler-chain>
           <javaee:handler>
              <javaee:handler-class>your.handler.FQN.here</javaee:handler-class>
           </javaee:handler>
        </javaee:handler-chain>
     </javaee:handler-chains>

これを自宅で試してください。この特定のコードはテストされていません

4
kolossus

リファレンス実装では、最終的に機能させるためにこれを行いました。参照 Metroを使用してJAXBクラスをマーシャリングする場合、schemaLocationは無視されます

0
Zagrev