web-services - 純粋な JAX-WS を使用して SOAP ヘッダーオブジェクトを追加する

Question

JAX WSを使用して、 PayPal Express Checkout API用の単純な Web サービスクライアントを実装しようとしています。PayPal Express Checkout APIはWSDLファイルを提供します。このファイルから、 CXF の wsdl2javaユーティリティを使用して Java クラスを生成できました。

認証上の理由から、各リクエストにSOAP ヘッダーを追加する必要があります。このヘッダーは非常にシンプルで、次のようになります: https://cms.paypal.com/us/cgi-bin/?cmd=_render-content&content_ID=developer/e_howto_api_ECSOAPAPIBasics#id09C3I0CF0O6

WSDLクラスから生成されたものには、各リクエストに追加する必要があるヘッダーを表すebay.apis.eblbasecomponents.CustomSecurityHeaderTypeクラスが含まれます。

問題は、次の条件を考慮して、 CustomSecurityHeaderTypeクラスの手動で作成されたインスタンスを SOAP リクエストのヘッダーに追加するにはどうすればよいかということです。

ここでの回答で述べたように、com.sun.*パッケージのクラスを使用することにあまり熱心ではありません: JAX-WS - SOAP ヘッダーの追加(主に、異なる JDK 間で移植性の問題が発生する可能性があるため)
ここでの回答に記載されているように、そのオブジェクトをネストされた javax.xml.soap.SOAPElementインスタンスに手動でマーシャリングしたくありません: How do I add a SOAP Header using Java JAX-WS

score 33 · Accepted Answer

したがって、 SOからのJAX-WSとJAXB関連の回答を組み合わせて可能な回答を見つけたようです（これらのテクノロジーの経験者が以下が正しいかどうかを確認できれば幸いです）：

私にとって明らかなことは、SOAPメッセージハンドラーを追加し、SOAPMessageインスタンスのヘッダーを変更することです。

import javax.xml.ws.Binding;
import javax.xml.ws.BindingProvider;
import javax.xml.ws.handler.Handler;
import javax.xml.bind.JAXBContext;
import javax.xml.bind.JAXBElement;
import javax.xml.bind.Marshaller;
import javax.xml.soap.SOAPHeader;
import ebay.api.paypalapi.ObjectFactory; // class generated by wsdl2java

// following class is generated by wsdl2java utility Service class
final PayPalAPIInterfaceService payPalService = new PayPalAPIInterfaceService();
final PayPalAPIAAInterface expressCheckoutPort = payPalService.getPayPalAPIAA();
final Binding binding = ((BindingProvider) expressCheckoutPort).getBinding();
List<Handler> handlersList = new ArrayList<Handler>();

// now, adding instance of Handler to handlersList which should do our job:
// creating header instance
final CustomSecurityHeaderType headerObj = new CustomSecurityHeaderType();
final UserIdPasswordType credentials = new UserIdPasswordType();
credentials.setUsername("username");
credentials.setPassword("password");
credentials.setSignature("signature");
headerObj.setCredentials(credentials);

// bookmark #1 - please read explanation after code
final ObjectFactory objectFactory = new ObjectFactory();
// creating JAXBElement from headerObj
final JAXBElement<CustomSecurityHeaderType> requesterCredentials = objectFactory.createRequesterCredentials(headerObj);

handlersList.add(new SOAPHandler<SOAPMessageContext>() {
    @Override
    public boolean handleMessage(final SOAPMessageContext context) {        
        try {
            // checking whether handled message is outbound one as per Martin Strauss answer
            final Boolean outbound = (Boolean) context.get("javax.xml.ws.handler.message.outbound");
            if (outbound != null && outbound) {
                // obtaining marshaller which should marshal instance to xml
                final Marshaller marshaller = JAXBContext.newInstance(CustomSecurityHeaderType.class).createMarshaller();
                // adding header because otherwise it's null
                final SOAPHeader soapHeader = context.getMessage().getSOAPPart().getEnvelope().addHeader();
                // marshalling instance (appending) to SOAP header's xml node
                marshaller.marshal(requesterCredentials, soapHeader);
            }
        } catch (final Exception e) {
            throw new RuntimeException(e);
        }
        return true;
    }

    // ... default implementations of other methods go here

});

// as per Jean-Bernard Pellerin's comment setting handlerChain list here, after all handlers were added to list
binding.setHandlerChain(handlersList);

ブックマーク＃1の説明：ヘッダーオブジェクト自体ではなく、そのオブジェクトを表すJAXBElementをマーシャリングする必要があります。そうしないと、例外が発生するためです。元のオブジェクトから必要なJAXBElementインスタンスを作成するには、 WSDLから生成されたObjectFactoryクラスの1つを使用する必要があります。（@skaffmanの回答に感謝します：JAXBによって生成された@XmlRootElementはありません）

`Martin Straus`これを拡張する答えも参照する必要があります

score 11 · Accepted Answer

このソリューションはうまく機能しますが、落とし穴があります。受信メッセージが処理されると、次のエラーが生成されます。

dic 19, 2012 7:00:55 PM com.sun.xml.messaging.saaj.soap.impl.EnvelopeImpl addHeader
SEVERE: SAAJ0120: no se puede agregar una cabecera si ya hay una
Exception in thread "main" javax.xml.ws.WebServiceException: java.lang.RuntimeException: com.sun.xml.messaging.saaj.SOAPExceptionImpl: Can't add a header when one is already present.
    at com.sun.xml.ws.handler.ClientSOAPHandlerTube.callHandlersOnResponse(ClientSOAPHandlerTube.java:167)
    at com.sun.xml.ws.handler.HandlerTube.processResponse(HandlerTube.java:174)
    at com.sun.xml.ws.api.pipe.Fiber.__doRun(Fiber.java:1074)
    at com.sun.xml.ws.api.pipe.Fiber._doRun(Fiber.java:979)
    at com.sun.xml.ws.api.pipe.Fiber.doRun(Fiber.java:950)
    at com.sun.xml.ws.api.pipe.Fiber.runSync(Fiber.java:825)
    at com.sun.xml.ws.client.Stub.process(Stub.java:443)
    at com.sun.xml.ws.client.sei.SEIStub.doProcess(SEIStub.java:174)
    at com.sun.xml.ws.client.sei.SyncMethodHandler.invoke(SyncMethodHandler.java:119)
    at com.sun.xml.ws.client.sei.SyncMethodHandler.invoke(SyncMethodHandler.java:102)
    at com.sun.xml.ws.client.sei.SEIStub.invoke(SEIStub.java:154)
    at $Proxy38.wsRdyCrearTicketDA(Unknown Source)
    at ar.com.fit.fides.remedy.api.ws.ServicioCreacionTickets.crearTicket(ServicioCreacionTickets.java:55)
    at ar.com.fit.fides.remedy.api.ws.ConectorRemedyWS.crearTicket(ConectorRemedyWS.java:43)
    at ar.com.fit.fides.remedy.api.ws.ConectorRemedyWS.main(ConectorRemedyWS.java:90)
Caused by: java.lang.RuntimeException: com.sun.xml.messaging.saaj.SOAPExceptionImpl: Can't add a header when one is already present.
    at ar.com.fit.fides.remedy.api.ws.AuthenticationHandler.handleMessage(AuthenticationHandler.java:50)
    at ar.com.fit.fides.remedy.api.ws.AuthenticationHandler.handleMessage(AuthenticationHandler.java:23)
    at com.sun.xml.ws.handler.HandlerProcessor.callHandleMessageReverse(HandlerProcessor.java:341)
    at com.sun.xml.ws.handler.HandlerProcessor.callHandlersResponse(HandlerProcessor.java:214)
    at com.sun.xml.ws.handler.ClientSOAPHandlerTube.callHandlersOnResponse(ClientSOAPHandlerTube.java:161)
    ... 14 more
Caused by: com.sun.xml.messaging.saaj.SOAPExceptionImpl: Can't add a header when one is already present.
    at com.sun.xml.messaging.saaj.soap.impl.EnvelopeImpl.addHeader(EnvelopeImpl.java:128)
    at com.sun.xml.messaging.saaj.soap.impl.EnvelopeImpl.addHeader(EnvelopeImpl.java:108)
    at ar.com.fit.fides.remedy.api.ws.AuthenticationHandler.handleMessage(AuthenticationHandler.java:45)

したがって、解決策は、次のように、メッセージが送信メッセージであるかどうかを確認することです。

public boolean handleMessage(SOAPMessageContext context) {
    try {
        Boolean outbound = (Boolean) context.get("javax.xml.ws.handler.message.outbound");
        if (outbound != null && outbound) {
            // obtaining marshaller which should marshal instance to xml
            final Marshaller marshaller = JAXBContext.newInstance(AuthenticationInfo.class).createMarshaller();
            // adding header because otherwise it's null
            final SOAPHeader soapHeader = context.getMessage().getSOAPPart().getEnvelope().addHeader();
            // marshalling instance (appending) to SOAP header's xml node
            marshaller.marshal(info, soapHeader);
        }
    } catch (final Exception e) {
        throw new RuntimeException(e);
    }
    return true;
}

score 5 · Accepted Answer

次のように、ヘッダーとしてparamsuserとpasswordを使用してWebサービス公開メソッドを作成しました。

@WebService(serviceName="authentication")
public class WSAuthentication {
   String name = null;
   String password = null;

   public WSAuthentication() {
       super();
   }

   public WSAuthentication(String name, String password) {
       this.name = name;
       this.password = password;
   }

   private static String getData(WSAuthentication sec) {
       System.out.println("********************* AUTHENTICATION ********************" + "\n" + 
       "**********USER: " + sec.name + "\n" + 
       "******PASSWORD: " + sec.password + "\n" + 
       "******************************** AUTHENTICATION ****************************");
       return sec.name + " -- " + sec.password;
   }

   @WebMethod(operationName="security", action="authenticate")
   @WebResult(name="answer")
   public String security(@WebParam(header=true, mode=Mode.IN, name="user") String user, @WebParam(header=true, mode=Mode.IN, name="password") String password) {
        WSAuthentication secure = new WSAuthentication(user, password);
        return getData(secure);
     }
}

それをコンパイルして、WSDLクラスから生成されたテストを試してください。これがお役に立てば幸いです。

score 1 · Accepted Answer

私はこの答えを見つけました：

JAX-WS - SOAP ヘッダーの追加

基本的に、コンパイラオプションに -XadditionalHeaders を追加すると、ヘッダー内のオブジェクトもメソッドのパラメーターとして生成されたコードに表示されます。

web-services - 純粋な JAX-WS を使用して SOAP ヘッダー オブジェクトを追加する

5 に答える 5

Martin Strausこれを拡張する答えも参照する必要があります

Related

Reference

web-services - 純粋な JAX-WS を使用して SOAP ヘッダーオブジェクトを追加する

`Martin Straus`これを拡張する答えも参照する必要があります