de.codecentric.cxf.logging.soapmsg.SoapMessageLoggingInInterceptor Maven / Gradle / Ivy
Show all versions of cxf-spring-boot-starter Show documentation
package de.codecentric.cxf.logging.soapmsg;
import de.codecentric.cxf.logging.BaseLogger;
import de.codecentric.cxf.logging.CxfLoggingSoapActionUtil;
import de.codecentric.cxf.logging.ElasticsearchField;
import org.apache.cxf.interceptor.LoggingMessage;
import org.slf4j.MDC;
import java.util.logging.Logger;
/**
* This Apache CXF Logging Interceptor extracts the SoapMessage and logs it dependent on the the setted
* {@link #logSoapMessage(boolean)} or {@link #extractSoapMessage(boolean)}.
*
* If {@link #logSoapMessage(boolean)} is set to true, the SoapMessage is logged to commandline respectively STOUT
*
* If {@link #extractSoapMessage(boolean)} is set to true, the {@link BaseLogger} is used to put the SoapMessage
* into the Slf4j MDC (Mapped Diagnostic Context, see http://logback.qos.ch/manual/mdc.html} for more details)
* with a Key directly suitable for processing with the ELK-Stack (Elasticsearch, Logstash, Kibana).
*
* If both are set to true, the SoapMessage is logged to commandline AND put into Slf4j MDC for Elasticsearch processing.
*
* @author Jonas Hecht
*
*/
public class SoapMessageLoggingInInterceptor extends org.apache.cxf.interceptor.LoggingInInterceptor {
private static final BaseLogger LOG = BaseLogger.getLogger(SoapMessageLoggingInInterceptor.class);
private boolean doLogging = false;
private boolean doExtraction = false;
@Override
protected void log(Logger logger, String message) {
if(doLogging) {
super.log(logger, message);
} else if(doExtraction) {
// just do nothing, because we don´t want CXF-Implementation to log,
// we just want to Push the SOAP-Message to Logback -> Logstash -> Elasticsearch -> Kibana
}
}
/* (non-Javadoc)
* @see org.apache.cxf.interceptor.SoapMessageLoggingInInterceptor#formatLoggingMessage(org.apache.cxf.interceptor.LoggingMessage)
*/
@Override
protected String formatLoggingMessage(LoggingMessage loggingMessage) {
String headers = loggingMessage.getHeader().toString();
String soapMethodName = CxfLoggingSoapActionUtil.extractSoapMethodNameFromHttpHeader(headers);
MDC.put(ElasticsearchField.SOAP_METHOD_LOG_NAME.getName(), soapMethodName);
if(logButDontExtract()) {
return buildLogStatementWithSoapMessage(loggingMessage);
} else if(extractButDontLog()) {
return extractSoapMessageForElasticSearchProcessing(loggingMessage, headers);
} else if(logAndExtract()) {
extractSoapMessageForElasticSearchProcessing(loggingMessage, headers);
return buildLogStatementWithSoapMessage(loggingMessage);
} else {
// This should never happen, as this LoggingInterceptor is only configured,
// if either logging or extraction is activated
return "";
}
}
private String extractSoapMessageForElasticSearchProcessing(LoggingMessage loggingMessage, String headers) {
// Only write the Payload (SOAP-Xml) to Logger
if (loggingMessage.getPayload().length() > 0) {
LOG.logInboundSoapMessage(loggingMessage.getPayload().toString());
}
LOG.logHttpHeader(headers);
// This is just hook into CXF and get the SOAP-Message.
// The returned String will never be logged somewhere.
return "";
}
private String buildLogStatementWithSoapMessage(LoggingMessage loggingMessage) {
StringBuilder buffer = new StringBuilder();
// Only write the Payload (SOAP-Xml) to Logger
if (loggingMessage.getPayload().length() > 0) {
buffer.append("000 >>> Inbound Message:\n");
buffer.append(loggingMessage.getPayload());
}
return buffer.toString();
}
private boolean logAndExtract() {
return doLogging && doExtraction;
}
private boolean extractButDontLog() {
return doExtraction && !doLogging;
}
private boolean logButDontExtract() {
return doLogging && !doExtraction;
}
public void extractSoapMessage(boolean active) {
this.doExtraction = active;
}
public void logSoapMessage(boolean active) {
this.doLogging = active;
}
}