Customize a Message Thrown by a SoapFault

final Throwable myCustomError = new Throwable("This is a custom error message !!!");

package org.example;

import javax.xml.stream.XMLStreamException;

import org.apache.cxf.binding.soap.SoapFault;
import org.apache.cxf.binding.soap.interceptor.Soap11FaultOutInterceptor;
import org.apache.cxf.interceptor.Fault;
import org.apache.cxf.message.Message;
import org.apache.cxf.phase.AbstractPhaseInterceptor;
import org.apache.cxf.phase.Phase;

/**
 * This interceptor runs just before create the SoapFault.
 * At this point you can change the exception used to create the SoapFault message
 * In this interceptor we are only change the exception when it is an instance
 * of XMLStreamException but you can adapt this behavior.
 */

public class SoapFaultOutInterceptor extends AbstractPhaseInterceptor<Message> {

	public SoapFaultOutInterceptor() {
		super(Phase.PREPARE_SEND);
		this.getBefore().add(Soap11FaultOutInterceptor.class.getName());
		// If you are using SOAP version 1.2
		//this.getBefore().add(Soap12FaultOutInterceptor.class.getName());
	}

	@Override
	public void handleMessage(final Message message) {
  		 System.out.println("********** Start Custom SoapFault Interceptor ***********");

  		 // Original SoapFault
	     final Fault f = (Fault) message.getContent(Exception.class);

	     // Only Customize XMLStreamException
	     if (f.getCause() instanceof XMLStreamException) {

	    	 System.out.println("Original SoapFault:");
	    	 System.out.println("\tClass: " + f.getCause().getClass());
	    	 System.out.println("\tFaultCode :" + f.getFaultCode());
	     	 System.out.println("\tCause :" + f.getCause().getMessage());

	    	 final Throwable myCustomError = new Throwable("This is a custom error message !!!");
	    	 final SoapFault myCustomFault = new SoapFault("Custom Error", myCustomError, f.getFaultCode());

	    	 message.setContent(Exception.class, myCustomFault);
	     }
	     System.out.println("********** End Custom SoapFault Interceptor ***********");
	}
}
java✓ Copied
Expand content

<?xml version="1.0" encoding="UTF-8"?>
<beans xmlns="http://www.springframework.org/schema/beans"
	xmlns:cxf="http://cxf.apache.org/core"
	xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
	xsi:schemaLocation="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">

<!-- 	<bean class="org.apache.cxf.interceptor.LoggingInInterceptor" id="logInbound"/> -->
<!-- 	<bean class="org.apache.cxf.interceptor.LoggingOutInterceptor" id="logOutbound"/> -->
	<bean class="org.example.SoapFaultOutInterceptor" id="soapfaultOutInterceptor"/>

	<cxf:bus>
		<cxf:features>
			<cxf:logging/>
		</cxf:features>

<!-- 		<cxf:inInterceptors> -->
<!-- 			<ref bean="logInbound"/> -->
<!-- 		</cxf:inInterceptors> -->

<!-- 		<cxf:outInterceptors> -->
<!-- 			<ref bean="logOutbound"/> -->
<!-- 		</cxf:outInterceptors> -->

		<cxf:outFaultInterceptors>
			<ref bean="soapfaultOutInterceptor"/>
		</cxf:outFaultInterceptors>

<!-- 		<cxf:inFaultInterceptors> -->
<!-- 			<ref bean="logInbound"/> -->
<!-- 		</cxf:inFaultInterceptors> -->
	</cxf:bus>
</beans>
xml✓ Copied
Expand content

********** Start Custom SoapFault Interceptor ***********
Original SoapFault:
	Class: class com.ctc.wstx.exc.WstxParsingException
	FaultCode :{http://schemas.xmlsoap.org/soap/envelope/}Client
	Cause :Unexpected close tag </soapenv:Body>; expected </soapenv:Envelope>.
 at [row,col {unknown-source}]: [9,17]
********** End Custom SoapFault Interceptor ***********
text✓ Copied

<!-- CXF, avoid log for invalid XML messages, SE-7813 changing the severity to ERROR -->
 <AsyncLogger name="org.apache.cxf.phase.PhaseInterceptorChain" level="ERROR"/>
xml✓ Copied