Відстеження XML-запиту / відповідей за допомогою JAX-WS

Чи є простий спосіб (він же: не використовувати проксі), щоб отримати доступ до необробленого XML запиту / відповіді для веб-сервісу, опублікованого з реалізацією посилання JAX-WS (той, що включений у JDK 1.5 і вище)? Мені потрібно зробити це за допомогою коду. Просто ввійти до файлу за допомогою розумних конфігурацій реєстрації було б добре, але досить.

Я знаю, що існують інші більш складні та повні рамки, які могли б це зробити, але я хотів би зробити це максимально простим і ось, cxf і т. Д. Все це додасть значних накладних витрат, чого я хочу уникнути.

Дякую!

Наступні параметри дозволяють вести журнал усієї комунікації до консолі (технічно вам потрібна лише одна з них, але це залежить від використовуваних бібліотек, тому налаштування всіх чотирьох є більш безпечним варіантом). Ви можете встановити його в коді, як, наприклад, або як параметр командного рядка, використовуючи -D або як змінну середовища, як написав Upendra.

System.setProperty("com.sun.xml.ws.transport.http.client.HttpTransportPipe.dump", "true");
System.setProperty("com.sun.xml.internal.ws.transport.http.client.HttpTransportPipe.dump", "true");
System.setProperty("com.sun.xml.ws.transport.http.HttpAdapter.dump", "true");
System.setProperty("com.sun.xml.internal.ws.transport.http.HttpAdapter.dump", "true");
System.setProperty("com.sun.xml.internal.ws.transport.http.HttpAdapter.dumpTreshold", "999999");

Дивіться питання Відстеження запитів / відповідей XML за допомогою JAX-WS, коли виникає помилка для деталей.

Ось рішення в сирому коді (складене завдяки stjohnroe та Shamik):

Endpoint ep = Endpoint.create(new WebserviceImpl());
List<Handler> handlerChain = ep.getBinding().getHandlerChain();
handlerChain.add(new SOAPLoggingHandler());
ep.getBinding().setHandlerChain(handlerChain);
ep.publish(publishURL);

Де SOAPLoggingHandler (зірваний із пов'язаних прикладів):

package com.myfirm.util.logging.ws;

import java.io.PrintStream;
import java.util.Map;
import java.util.Set;

import javax.xml.namespace.QName;
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;

/*
 * This simple SOAPHandler will output the contents of incoming
 * and outgoing messages.
 */
public class SOAPLoggingHandler implements SOAPHandler<SOAPMessageContext> {

    // change this to redirect output if desired
    private static PrintStream out = System.out;

    public Set<QName> getHeaders() {
        return null;
    }

    public boolean handleMessage(SOAPMessageContext smc) {
        logToSystemOut(smc);
        return true;
    }

    public boolean handleFault(SOAPMessageContext smc) {
        logToSystemOut(smc);
        return true;
    }

    // nothing to clean up
    public void close(MessageContext messageContext) {
    }

    /*
     * Check the MESSAGE_OUTBOUND_PROPERTY in the context
     * to see if this is an outgoing or incoming message.
     * Write a brief message to the print stream and
     * output the message. The writeTo() method can throw
     * SOAPException or IOException
     */
    private void logToSystemOut(SOAPMessageContext smc) {
        Boolean outboundProperty = (Boolean)
            smc.get (MessageContext.MESSAGE_OUTBOUND_PROPERTY);

        if (outboundProperty.booleanValue()) {
            out.println("\nOutbound message:");
        } else {
            out.println("\nInbound message:");
        }

        SOAPMessage message = smc.getMessage();
        try {
            message.writeTo(out);
            out.println("");   // just to add a newline
        } catch (Exception e) {
            out.println("Exception in handler: " + e);
        }
    }
}

Перш ніж запустити tomcat, встановіть, JAVA_OPTSяк зазначено нижче, у Linux envs. Потім запустіть Tomcat. Ви побачите запит та відповідь у catalina.outфайлі.

export JAVA_OPTS="$JAVA_OPTS -Dcom.sun.xml.ws.transport.http.client.HttpTransportPipe.dump=true"

Встановіть наступні властивості системи, це дозволить вести журнал xml. Ви можете встановити його у Java або конфігураційному файлі.

static{
        System.setProperty("com.sun.xml.ws.transport.http.client.HttpTransportPipe.dump", "true");
        System.setProperty("com.sun.xml.ws.transport.http.HttpAdapter.dump", "true");
        System.setProperty("com.sun.xml.internal.ws.transport.http.client.HttpTransportPipe.dump", "true");
        System.setProperty("com.sun.xml.internal.ws.transport.http.HttpAdapter.dump", "true");
        System.setProperty("com.sun.xml.internal.ws.transport.http.HttpAdapter.dumpTreshold", "999999");
    }

консольні журнали:

INFO: Outbound Message
---------------------------
ID: 1
Address: http://localhost:7001/arm-war/castService
Encoding: UTF-8
Http-Method: POST
Content-Type: text/xml
Headers: {Accept=[*/*], SOAPAction=[""]}
Payload: xml
--------------------------------------
INFO: Inbound Message
----------------------------
ID: 1
Response-Code: 200
Encoding: UTF-8
Content-Type: text/xml; charset=UTF-8
Headers: {content-type=[text/xml; charset=UTF-8], Date=[Fri, 20 Jan 2017 11:30:48 GMT], transfer-encoding=[chunked]}
Payload: xml
--------------------------------------

Вводять SOAPHandlerдо кінцевої точки інтерфейсу. ми можемо простежити запит та відповідь SOAP

Впровадження SOAPHandler з Programmatic

ServerImplService service = new ServerImplService();
Server port = imgService.getServerImplPort();
/**********for tracing xml inbound and outbound******************************/
Binding binding = ((BindingProvider)port).getBinding();
List<Handler> handlerChain = binding.getHandlerChain();
handlerChain.add(new SOAPLoggingHandler());
binding.setHandlerChain(handlerChain);

Декларативне додавання @HandlerChain(file = "handlers.xml")примітки до інтерфейсу кінцевої точки.

handlers.xml

<?xml version="1.0" encoding="UTF-8"?>
<handler-chains xmlns="http://java.sun.com/xml/ns/javaee">
    <handler-chain>
        <handler>
            <handler-class>SOAPLoggingHandler</handler-class>
        </handler>
    </handler-chain>
</handler-chains>

SOAPLoggingHandler.java

/*
 * This simple SOAPHandler will output the contents of incoming
 * and outgoing messages.
 */


public class SOAPLoggingHandler implements SOAPHandler<SOAPMessageContext> {
    public Set<QName> getHeaders() {
        return null;
    }

    public boolean handleMessage(SOAPMessageContext context) {
        Boolean isRequest = (Boolean) context.get(MessageContext.MESSAGE_OUTBOUND_PROPERTY);
        if (isRequest) {
            System.out.println("is Request");
        } else {
            System.out.println("is Response");
        }
        SOAPMessage message = context.getMessage();
        try {
            SOAPEnvelope envelope = message.getSOAPPart().getEnvelope();
            SOAPHeader header = envelope.getHeader();
            message.writeTo(System.out);
        } catch (SOAPException | IOException e) {
            // TODO Auto-generated catch block
            e.printStackTrace();
        }
        return true;
    }

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

    // nothing to clean up
    public void close(MessageContext messageContext) {
    }

}

Існують різні способи зробити це програмно, як описано в інших відповідях, але вони є досить інвазивними механізмами. Однак якщо ви знаєте, що ви використовуєте JAX-WS RI (він же "Метро"), ви можете зробити це на рівні конфігурації. Дивіться тут інструкції, як це зробити. Не потрібно возитися з вашою заявою.

// Це рішення забезпечує спосіб програмного додавання обробника до клієнтської мережі веб-служб без конфігурації XML

// Дивіться повний документ тут: http://docs.oracle.com/cd/E17904_01//web.1111/e13734/handlers.htm#i222476

// Створіть новий клас, який реалізує SOAPHandler

public class LogMessageHandler implements SOAPHandler<SOAPMessageContext> {

@Override
public Set<QName> getHeaders() {
    return Collections.EMPTY_SET;
}

@Override
public boolean handleMessage(SOAPMessageContext context) {
    SOAPMessage msg = context.getMessage(); //Line 1
    try {
        msg.writeTo(System.out);  //Line 3
    } catch (Exception ex) {
        Logger.getLogger(LogMessageHandler.class.getName()).log(Level.SEVERE, null, ex);
    } 
    return true;
}

@Override
public boolean handleFault(SOAPMessageContext context) {
    return true;
}

@Override
public void close(MessageContext context) {
}
}

// Програматично додайте свій LogMessageHandler

   com.csd.Service service = null;
    URL url = new URL("https://service.demo.com/ResService.svc?wsdl");

    service = new com.csd.Service(url);

    com.csd.IService port = service.getBasicHttpBindingIService();
    BindingProvider bindingProvider = (BindingProvider)port;
    Binding binding = bindingProvider.getBinding();
    List<Handler> handlerChain = binding.getHandlerChain();
    handlerChain.add(new LogMessageHandler());
    binding.setHandlerChain(handlerChain);

Я публікую нову відповідь, оскільки мені не вистачає репутації, щоб прокоментувати ту, яку надав Антоніо (див .: https://stackoverflow.com/a/1957777 ).

Якщо ви хочете, щоб повідомлення SOAP було надруковано у файлі (наприклад, через Log4j), ви можете використовувати:

OutputStream os = new ByteArrayOutputStream();
javax.xml.soap.SOAPMessage soapMsg = context.getMessage();
soapMsg.writeTo(os);
Logger LOG = Logger.getLogger(SOAPLoggingHandler.class); // Assuming SOAPLoggingHandler is the class name
LOG.info(os.toString());

Зверніть увагу, що за певних обставин виклик методу writeTo () може не вести себе так, як очікувалося (див. Https://community.oracle.com/thread/1123104?tstart=0 або https://www.java.net/node / 691073 ), тому наступний код зробить трюк:

javax.xml.soap.SOAPMessage soapMsg = context.getMessage();
com.sun.xml.ws.api.message.Message msg = new com.sun.xml.ws.message.saaj.SAAJMessage(soapMsg);
com.sun.xml.ws.api.message.Packet packet = new com.sun.xml.ws.api.message.Packet(msg);
Logger LOG = Logger.getLogger(SOAPLoggingHandler.class); // Assuming SOAPLoggingHandler is the class name
LOG.info(packet.toString());

Вам потрібно реалізувати javax.xml.ws.handler.LogicalHandler, на цей обробник потрібно посилатися у файлі конфігурації обробника, на який у свою чергу посилається анотація @HandlerChain у кінцевій точці служби (інтерфейс чи реалізація). Потім ви можете або вивести повідомлення через system.out або реєстратор у вашій програмі ProcessMessage.

Побачити

http://publib.boulder.ibm.com/infocenter/wasinfo/v7r0/index.jsp?topic=/com.ibm.websphere.express.doc/info/exp/ae/twbs_jaxwshandler.html

http://java.sun.com/mailers/techtips/enterprise/2006/TechTips_June06.html

Тут наведені відповіді, які керують вами SOAPHandler, цілком правильні. Перевага такого підходу полягає в тому, що він буде працювати з будь-якою реалізацією JAX-WS, оскільки SOAPHandler є частиною специфікації JAX-WS. Однак проблема з SOAPHandler полягає в тому, що він неявно намагається представити ціле повідомлення XML в пам'яті. Це може призвести до величезного використання пам'яті. Різні реалізації JAX-WS додали для цього власні обхідні шляхи. Якщо ви працюєте з великими запитами або великими відповідями, то вам потрібно вивчити один із фірмових підходів.

Оскільки ви запитуєте про "той, що включений у JDK 1.5 або краще", я відповім на те, що офіційно відоме як JAX-WS RI (він же "Метро"), що є тим, що входить до JDK.

JAX-WS RI має для цього специфічне рішення, яке є дуже ефективним з точки зору використання пам'яті.

Дивіться https://javaee.github.io/metro/doc/user-guide/ch02.html#efficient-handlers-in-jax-ws-ri . На жаль, це посилання зараз розірвано, але його можна знайти на WayBack Machine. Я дам основні моменти нижче:

Люди метрополітену ще в 2007 році представили додатковий тип обробника MessageHandler<MessageHandlerContext>, який є власником Metro. Це набагато ефективніше, ніж SOAPHandler<SOAPMessageContext>воно не намагається зробити представлення DOM в пам'яті.

Ось вирішальний текст з оригінальної статті блогу:

MessageHandler:

Скориставшись розширюваною рамкою обробника, що надається специфікацією JAX-WS, та кращою абстракцією повідомлень у RI, ми представили новий обробник, покликаний MessageHandlerрозширити ваші програми веб-служб. MessageHandler схожий на SOAPHandler, за винятком того, що його реалізації отримують доступMessageHandlerContext(розширення MessageContext). Через MessageHandlerContext можна отримати доступ до Повідомлення та обробити його за допомогою API повідомлення. Як я зазначив у назві блогу, цей обробник дозволяє вам працювати над Message, який забезпечує ефективні способи доступу / обробки повідомлення не просто повідомлення на основі DOM. Модель програмування обробників однакова, і обробники повідомлень можна змішувати зі стандартними обробниками Logical та SOAP. Я додав зразок у JAX-WS RI 2.1.3, що показує використання MessageHandler для журналу повідомлень, і ось фрагмент із зразка:

public class LoggingHandler implements MessageHandler<MessageHandlerContext> {
    public boolean handleMessage(MessageHandlerContext mhc) {
        Message m = mhc.getMessage().copy();
        XMLStreamWriter writer = XMLStreamWriterFactory.create(System.out);
        try {
            m.writeTo(writer);
        } catch (XMLStreamException e) {
            e.printStackTrace();
            return false;
        }
        return true;
    }

    public boolean handleFault(MessageHandlerContext mhc) {
        ..... 
        return true;
    }

    public void close(MessageContext messageContext) {    }

    public Set getHeaders() {
        return null;
    }
}

(кінцева цитата з публікації в блозі 2007 року)

LoggingHandlerПотрібно сказати, що ваш прикладний обробник, наприклад, повинен бути доданий до вашої ланцюга обробника, щоб мати будь-який ефект. Це те саме, що додавати будь-які інші Handler, тож ви можете подивитися в інших відповідях на цій сторінці, як це зробити.

Ви можете знайти повний приклад у репо Metro GitHub .

Ви можете спробувати поставити ServletFilterперед веб-службою та перевірити запит та відповідь, що переходить на / повертається із служби.

Хоча ви спеціально не просили проксі, іноді мені здається, що tcptrace достатньо, щоб побачити, що відбувається у зв'язку. Це простий інструмент, без установки, він показує потоки даних і може також писати у файл.

Під час виконання ви можете просто виконати

com.sun.xml.internal.ws.transport.http.client.HttpTransportPipe.dump = true

як dump - це загальнодоступний var, визначений у класі наступним чином

public static boolean dump;

Чи правильно я розумію, що ви хочете змінити / отримати доступ до вихідного XML-повідомлення?

Якщо це так, ви (або оскільки це п’ять років, наступний хлопець), можливо, захочете ознайомитися з інтерфейсом провайдера, який є частиною JAXWS. Клієнтський аналог виконується за допомогою класу "Відправка". У будь-якому випадку, вам не потрібно додавати обробники чи перехоплювачі. Ви все-таки МОЖЕТЕ, звичайно. Мінус полягає в цьому, ви повністю відповідальні за створення SOAPMessage, але це легко, і якщо це те, що ви хочете (як я зробив), це ідеально.

Ось приклад для серверної сторони (трохи незграбно, це було лише для експериментів) -

@WebServiceProvider(portName="Provider1Port",serviceName="Provider1",targetNamespace = "http://localhost:8123/SoapContext/SoapPort1")
@ServiceMode(value=Service.Mode.MESSAGE)
public class Provider1 implements Provider<SOAPMessage>
{
  public Provider1()
  {
  }

  public SOAPMessage invoke(SOAPMessage request)
  { try{


        File log= new File("/home/aneeshb/practiceinapachecxf/log.txt");//creates file object
        FileWriter fw=new FileWriter(log);//creates filewriter and actually creates file on disk

            fw.write("Provider has been invoked");
            fw.write("This is the request"+request.getSOAPBody().getTextContent());

      MessageFactory mf = MessageFactory.newInstance();
      SOAPFactory sf = SOAPFactory.newInstance();

      SOAPMessage response = mf.createMessage();
      SOAPBody respBody = response.getSOAPBody();
      Name bodyName = sf.createName("Provider1Insertedmainbody");
      respBody.addBodyElement(bodyName);
      SOAPElement respContent = respBody.addChildElement("provider1");
      respContent.setValue("123.00");
      response.saveChanges();
      fw.write("This is the response"+response.getSOAPBody().getTextContent());
      fw.close();
      return response;}catch(Exception e){return request;}


   }
}

Ви публікуєте це так, як би ви SEI,

public class ServerJSFB {

    protected ServerJSFB() throws Exception {
        System.out.println("Starting Server");
        System.out.println("Starting SoapService1");

        Object implementor = new Provider1();//create implementor
        String address = "http://localhost:8123/SoapContext/SoapPort1";

        JaxWsServerFactoryBean svrFactory = new JaxWsServerFactoryBean();//create serverfactorybean

        svrFactory.setAddress(address);
        svrFactory.setServiceBean(implementor);

        svrFactory.create();//create the server. equivalent to publishing the endpoint
        System.out.println("Starting SoapService1");
  }

public static void main(String args[]) throws Exception {
    new ServerJSFB();
    System.out.println("Server ready...");

    Thread.sleep(10 * 60 * 1000);
    System.out.println("Server exiting");
    System.exit(0);
}
}

Або ви можете використовувати для нього клас Endpoint. Сподіваюся, що це було корисно.

І ось, якщо ви хочете, вам не потрібно займатися заголовками та іншим, якщо ви зміните режим обслуговування на PAYLOAD (ви отримаєте лише Soap Body).

з файлами конфігурації logback.xml ви можете:

<logger name="com.sun.xml.internal.ws.transport.http.client.HttpTransportPipe" level="trace" additivity="false">
    <appender-ref ref="STDOUT"/>
</logger>

Це записуватиме запит та відповідь так (залежно від конфігурації для виходу журналу):

09:50:23.266 [qtp1068445309-21] DEBUG c.s.x.i.w.t.h.c.HttpTransportPipe - ---[HTTP request - http://xyz:8081/xyz.svc]---
Accept: application/soap+xml, multipart/related
Content-Type: application/soap+xml; charset=utf-8;action="http://xyz.Web.Services/IServiceBase/GetAccessTicket"
User-Agent: JAX-WS RI 2.2.9-b130926.1035 svn-revision#5f6196f2b90e9460065a4c2f4e30e065b245e51e
<?xml version="1.0" ?><S:Envelope xmlns:S="http://www.w3.org/2003/05/soap-envelope">[CONTENT REMOVED]</S:Envelope>--------------------

09:50:23.312 [qtp1068445309-21] DEBUG c.s.x.i.w.t.h.c.HttpTransportPipe - ---[HTTP response - http://xyz:8081/xyz.svc - 200]---
null: HTTP/1.1 200 OK
Content-Length: 792
Content-Type: application/soap+xml; charset=utf-8
Date: Tue, 12 Feb 2019 14:50:23 GMT
Server: Microsoft-IIS/10.0
X-Powered-By: ASP.NET
<s:Envelope xmlns:s="http://www.w3.org/2003/05/soap-envelope" xmlns:a="http://www.w3.org/2005/08/addressing">[CONTENT REMOVED]</s:Envelope>--------------------

Я намагався знайти якусь бібліотеку фреймворків, щоб записати запит мила на веб-службу та відповідь протягом декількох днів. Код нижче вирішив проблему для мене:

System.setProperty("com.sun.xml.ws.transport.http.client.HttpTransportPipe.dump", "true");
        System.setProperty("com.sun.xml.ws.transport.http.HttpAdapter.dump", "true");
        System.setProperty("com.sun.xml.internal.ws.transport.http.client.HttpTransportPipe.dump", "true");
        System.setProperty("com.sun.xml.internal.ws.transport.http.HttpAdapter.dump", "true");

Один із способів зробити це - не використовувати свій код, але використовувати мережеві сніфери пакетів, такі як Etheral або WireShark, які можуть захоплювати HTTP-пакет разом із XML-повідомленням як корисне навантаження на нього, і ви можете продовжувати вести їх до файлу чи так.

Але більш складний підхід - це написання власних обробників повідомлень. Ви можете подивитися тут .

Насправді. Якщо ви подивитесь на джерела HttpClientTransport, ви помітите, що він також пише повідомлення в java.util.logging.Logger. Це означає, що ви можете бачити ці повідомлення також у своїх журналах.

Наприклад, якщо ви використовуєте Log4J2, все, що вам потрібно зробити, це:

• додайте міст JUL-Log4J2 у свій клас
• встановити рівень TRACE для пакета com.sun.xml.internal.ws.transport.http.client.
• додати в командний рядок запуску додаток -Djava.util.logging.manager = org.apache.logging.log4j.jul.LogManager властивість системи

Після цих кроків ви починаєте бачити повідомлення SOAP у своїх журналах.

У цій темі є кілька відповідей, які використовують SoapHandlers. Ви повинні знати, що SoapHandlers змінюють повідомлення, якщо writeTo(out)його викликають.

Виклик writeTo(out)методу SOAPMessage також автоматично викликає saveChanges()метод виклику . В результаті всі додані бінарні дані MTOM / XOP у повідомленні втрачаються.

Я не впевнений, чому це відбувається, але це, здається, є документально підтвердженою особливістю.

Крім того, цей метод позначає точку, в яку дані з усіх складових об'єктів AttachmentPart втягуються в повідомлення.

https://docs.oracle.com/javase/7/docs/api/javax/xml/soap/SOAPMessage.html#saveChanges ()

Якщо у вас трапляється запустити сервер додатків IBM Liberty, просто додайте ibm-ws-bnd.xml у каталог WEB-INF.

<?xml version="1.0" encoding="UTF-8"?>
<webservices-bnd
    xmlns="http://websphere.ibm.com/xml/ns/javaee"
    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
    xsi:schemaLocation="http://websphere.ibm.com/xml/ns/javaee http://websphere.ibm.com/xml/ns/javaee/ibm-ws-bnd_1_0.xsd"
    version="1.0">
    <webservice-endpoint-properties
        enableLoggingInOutInterceptor="true" />
</webservices-bnd>