How to log Apache CXF Soap Request and Soap Response using Log4j

Question

I am using the Apache CXF Framework  Inside my client program  I need to log CXF SOAP Requests and SOAP Responses  When I used   JaxWsProxyFactoryBean factory   new JaxWsProxyFactoryBean    factory setAddress host   factory setServiceClass MyService class   factory getInInterceptors   add new LoggingInInterceptor     factory getOutInterceptors   add new LoggingOutInterceptor       I got these SOAP Request and SOAP Responses in the console   Nov 9  2011 6 48 01 PM org apache cxf interceptor LoggingOutInterceptor LoggingCallback onClose INFO  Outbound Message --------------------------- ID  2 Encoding  UTF-8 Content-Type  text xml Headers     Payload   lt soap Envelope xmlns soap  http   schemas xmlsoap org soap envelope   gt  lt soap Body gt  lt ns4 MYResponse --------------------------------------   But my actual requirement is  instead of printing them to the server console  I need to have them inside the log file   When I used log4j directly as shown   log4j factory getInInterceptors   add new LoggingInInterceptor      log4j factory getOutInterceptors   add new LoggingOutInterceptor        It is only printing true and true inside the log file   Could anybody please let me know how to configure this

User · Answer

This worked for me   Setup log4j as normal  Then use this code          LOGGING      LoggingOutInterceptor loi   new LoggingOutInterceptor         loi setPrettyLogging true        LoggingInInterceptor lii   new LoggingInInterceptor         lii setPrettyLogging true         org apache cxf endpoint Client client   org apache cxf frontend ClientProxy getClient isalesService        org apache cxf endpoint Endpoint cxfEndpoint   client getEndpoint          cxfEndpoint getOutInterceptors   add loi        cxfEndpoint getInInterceptors   add lii

User · Answer

Try this code   EndpointImpl impl    EndpointImpl Endpoint publish address  implementor       impl getServer   getEndpoint   getInInterceptors   add new LoggingInInterceptor         impl getServer   getEndpoint   getOutInterceptors   add new LoggingOutInterceptor       Inside the logback xml you need to put the interface name for webservice     lt appender name  FILE  class  ch qos logback classic sift SiftingAppender  gt       lt discriminator         class  com progressoft ecc integration logging ThreadNameDiscriminator  gt           lt key gt threadName lt  key gt           lt defaultValue gt unknown lt  defaultValue gt       lt  discriminator gt       lt filter class  ch qos logback core filter EvaluatorFilter  gt           lt evaluator gt               lt expression gt logger contains  InterfaceWebServiceSoap   lt  expression gt           lt  evaluator gt           lt OnMismatch gt DENY lt  OnMismatch gt           lt OnMatch gt NEUTRAL lt  OnMatch gt       lt  filter gt       lt filter class  ch qos logback classic filter ThresholdFilter  gt           lt level gt TRACE lt  level gt       lt  filter gt       lt sift gt           lt appender name  FILE-  threadName               class  ch qos logback core rolling RollingFileAppender  gt               lt File gt   LOGGING PATH    threadName  log lt  File gt               lt rollingPolicy class  ch qos logback core rolling TimeBasedRollingPolicy  gt                   lt FileNamePattern gt   ARCHIVING PATH   d yyyy-MM-dd    threadName  i log zip                  lt  FileNamePattern gt                   lt MaxHistory gt 30 lt  MaxHistory gt                   lt TimeBasedFileNamingAndTriggeringPolicy                     class  ch qos logback core rolling SizeAndTimeBasedFNATP  gt                       lt MaxFileSize gt 50MB lt  MaxFileSize gt                   lt  TimeBasedFileNamingAndTriggeringPolicy gt               lt  rollingPolicy gt               lt encoder class  ch qos logback classic encoder PatternLayoutEncoder  gt                   lt Pattern gt  date dd-MM-yyyy HH mm ss SSS     5level    -60   logger 53   line     msg  ex full   n lt  Pattern gt               lt  encoder gt           lt  appender gt       lt  sift gt   lt  appender gt    lt root gt       lt level value  ALL    gt       lt appender-ref ref  FILE    gt   lt  root gt

User · Answer

cxf xml   lt cxf bus gt       lt cxf ininterceptors gt           lt ref bean  loggingInInterceptor    gt       lt  cxf ininterceptors gt       lt cxf outinterceptors gt           lt ref bean  logOutInterceptor    gt       lt  cxf outinterceptors gt   lt  cxf bus gt    org apache cxf Logger  org apache cxf common logging Log4jLogger   Please check screenshot here

User · Answer

Another easy way is to set the logger like this- ensure that you do it before you load the cxf web service related classes. You can use it in some static blocks.

YourClientConstructor() {

  LogUtils.setLoggerClass(org.apache.cxf.common.logging.Log4jLogger.class);

  URL wsdlURL = YOurURL;//

  //create the service
  YourService = new YourService(wsdlURL, SERVICE_NAME);
  port = yourService.getServicePort(); 

  Client client = ClientProxy.getClient(port);
  client.getInInterceptors().add(new LoggingInInterceptor());
  client.getOutInterceptors().add(new LoggingOutInterceptor());
}

Then the inbound and outbound messages will be printed to Log4j file instead of the console. Make sure your log4j is configured properly

User · Answer

When configuring log4j properties  putting org apache cxf logging level to INFO is enough to see the plain SOAP messages   log4j logger org apache cxf INFO   DEBUG is too verbose

User · Answer

Procedure for global setting of client server logging of SOAP REST requests  responses with log4j logger  This way you set up logging for the whole application without having to change the code  war  jar files  etc   install file cxf-rt-features-logging-X Y Z jar to your CLASS PATH  create file  path for example   opt cxf cxf-logging xml    lt  xml version  quot 1 0 quot  encoding  quot UTF-8 quot   gt   lt beans xmlns  quot http   www springframework org schema beans quot  xmlns xsi  quot http   www w3 org 2001 XMLSchema-instance quot  xmlns cxf  quot http   cxf apache org core quot  xsi schemaLocation  quot http   cxf apache org core http   cxf apache org schemas core xsd http   www springframework org schema beans http   www springframework org schema beans spring-beans-2 0 xsd quot  gt   lt cxf bus gt    lt cxf features gt    lt bean class  quot org apache cxf ext logging LoggingFeature quot  gt    lt property name  quot prettyLogging quot  value  quot true quot   gt    lt  bean gt    lt  cxf features gt    lt  cxf bus gt    lt  beans gt    set logging for org apache cxf  log4j 1 x  log4j logger org apache cxf INFO YOUR APPENDER  set these properties on java start-up   java     -Dcxf config file url file    opt cxf cxf-logging xml -Dorg apache cxf Logger org apache cxf common logging Log4jLogger -Dcom sun xml ws transport http client HttpTransportPipe dump true -Dcom sun xml internal ws transport http client HttpTransportPipe dump true -Dcom sun xml ws transport http HttpAdapter dump true -Dcom sun xml internal ws transport http HttpAdapter dump true     I don t know why  but it is necessary to set variables as well com sun xml

User · Answer

Simplest way to achieve pretty logging in Preethi Jain szenario   LoggingInInterceptor loggingInInterceptor   new LoggingInInterceptor    loggingInInterceptor setPrettyLogging true   LoggingOutInterceptor loggingOutInterceptor   new LoggingOutInterceptor    loggingOutInterceptor setPrettyLogging true   factory getInInterceptors   add loggingInInterceptor   factory getOutInterceptors   add loggingOutInterceptor

User · Answer

You need to create a file named org apache cxf Logger  that is  org apache cxf file with Logger extension  under  META-INF cxf  with the following contents   org apache cxf common logging Log4jLogger   Reference  Using Log4j Instead of java util logging   Also if you replace standard    lt cxf bus gt     lt cxf features gt       lt cxf logging  gt     lt  cxf features gt   lt  cxf bus gt    with much more verbose    lt bean id  abstractLoggingInterceptor  abstract  true  gt       lt property name  prettyLogging  value  true   gt   lt  bean gt   lt bean id  loggingInInterceptor  class  org apache cxf interceptor LoggingInInterceptor  parent  abstractLoggingInterceptor   gt   lt bean id  loggingOutInterceptor  class  org apache cxf interceptor LoggingOutInterceptor  parent  abstractLoggingInterceptor   gt    lt cxf bus gt       lt cxf inInterceptors gt           lt ref bean  loggingInInterceptor   gt       lt  cxf inInterceptors gt       lt cxf outInterceptors gt           lt ref bean  loggingOutInterceptor   gt       lt  cxf outInterceptors gt       lt cxf outFaultInterceptors gt           lt ref bean  loggingOutInterceptor   gt       lt  cxf outFaultInterceptors gt       lt cxf inFaultInterceptors gt           lt ref bean  loggingInInterceptor   gt       lt  cxf inFaultInterceptors gt   lt  cxf bus gt    Apache CXF will pretty print XML messages formatting them with proper indentation and line breaks  Very useful  More about it here

User · Answer

In your spring context configuring below would log the request and response soap messsage    lt bean id  loggingFeature  class  org apache cxf feature LoggingFeature  gt       lt property name  prettyLogging  value  true    gt   lt  bean gt    lt cxf bus gt       lt cxf features gt           lt ref bean  loggingFeature    gt       lt  cxf features gt   lt  cxf bus gt

User · Answer

In case somebody wants to do this  using Play Framework  and using LogBack http   logback qos ch    then you can configure the application-logger xml with this line     lt logger name  org apache cxf  level  DEBUG   gt    For me  it did the trick

[log4j] How to log Apache CXF Soap Request and Soap Response using Log4j?

The answer is

Examples related to log4j

Examples related to cxf

Tags