CXF and Custom Fault Error

CXF and Custom Fault Error

Recently, my friend is working on CXF working with Spring boot 2.0.
We get an error as follow:
org.apache.cxf.interceptor.Fault: No binding operation info while invoking unknown method with params unknown.
    at org.apache.cxf.service.invoker.AbstractInvoker.invoke(AbstractInvoker.java:59)
Is this a real ERROR from spring boot and CXF? NO, it is not.
If the system visit the ?wsdl link, everything works great, according to a lot of documents or discussion like this https://codeday.me/bug/20190219/659141.html. It is the right behavior from the server side. If the request is not SOAP protocol and can not match any SOAP operation, it will give No binding operation. Our request is a normal GET HTTP to the SOAP Servlet URL, that is the right response.
In old days with axis1.4 in axis.war, they may provide some html response.
It latest CXF 3 or other SOAP library now, It will give error response from org.apache.cxf.interceptor.Fault classes. Which is SOAP response.
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
    <soap:Body>
    <soap:Fault>
        <faultcode>soap:Server</faultcode>
        <faultstring>
            No binding operation info while invoking unknown method with params unknown.
        </faultstring>
    </soap:Fault>
    </soap:Body>
</soap:Envelope>
We can use OutInterceptor in CXF to custom the error content. That is a good thing. Even we are using a integration help plugin called https://github.com/codecentric/cxf-spring-boot-starter consider to custom the error contents.
The issue is, all people consider to custom is the content in <faultstring> or <faultcode>. NOT very popular to make a SOAP SERVER response NON SOAP response, haha.
But in our requirement, we can not change or do anything to the old beasts, legacy system, that is out of our control. They need SOAP Service to return HTML or Text. Let us make it happen.
Fork the plugin project, directly hard code the response there if the error is “No binding….” From Fault class.
https://github.com/luohuazju/cxf-spring-boot-starter
Here is the Interceptor we change
package de.codecentric.cxf.xmlvalidation;
import java.io.IOException;
import javax.servlet.http.HttpServletResponse;
import javax.xml.bind.UnmarshalException;
import org.apache.cxf.binding.soap.SoapMessage;
import org.apache.cxf.binding.soap.interceptor.AbstractSoapInterceptor;
import org.apache.cxf.interceptor.Fault;
import org.apache.cxf.phase.Phase;
import org.apache.cxf.transport.http.AbstractHTTPDestination;
import com.ctc.wstx.exc.WstxException;
import com.ctc.wstx.exc.WstxUnexpectedCharException;
import de.codecentric.cxf.common.FaultType;
import de.codecentric.cxf.logging.BaseLogger;
/**
* Apache CXF Interceptor, which is processed early in the Interceptor-Chain,
* that tries to analyze and handle all XML schema valdiation errors that could
* occur somewhere in Apache CXF´s SOAP-Processing. Refers to the
* {@link SoapFaultBuilder} to build a custom Soap-Fault, when
* {@link CustomFaultBuilder} is implemented and configured.
*
* @author Jonas Hecht
*
*/
public class XmlValidationInterceptor extends AbstractSoapInterceptor {
    private static final String NO_BINDDING_ERROR_MESSAGE = "No binding operation info while invoking unknown method with params unknown.";
    private static final String MATCH_TO_OLD_BAD_WRONG_AXIS1 = "<h1>QBWebService</h1>\n"
            + "<p>Hi there, this is an AXIS service!</p>\n"
            + "<i>Perhaps there will be a form for invoking the service here...</i>";
    private static final BaseLogger LOG = BaseLogger.getLogger(XmlValidationInterceptor.class);
    private SoapFaultBuilder soapFaultBuilder;
    public XmlValidationInterceptor() {
        super(Phase.PRE_STREAM);
    }
    @Override
    public void handleMessage(SoapMessage soapMessage) throws Fault {
        Fault fault = (Fault) soapMessage.getContent(Exception.class);
        Throwable faultCause = fault.getCause();
        String faultMessage = fault.getMessage();
        if (containsFaultIndicatingNotSchemeCompliantXml(faultCause, faultMessage)) {
            LOG.schemaValidationError(FaultType.SCHEME_VALIDATION_ERROR, faultMessage);
            soapFaultBuilder.buildCustomFaultAndSet2SoapMessage(soapMessage, FaultType.SCHEME_VALIDATION_ERROR);
        } else if (containsFaultIndicatingSyntacticallyIncorrectXml(faultCause)) {
            LOG.schemaValidationError(FaultType.SYNTACTICALLY_INCORRECT_XML_ERROR, faultMessage);
            soapFaultBuilder.buildCustomFaultAndSet2SoapMessage(soapMessage,
                    FaultType.SYNTACTICALLY_INCORRECT_XML_ERROR);
        } else if (nobindingIssue(faultMessage)) {
            HttpServletResponse response = (HttpServletResponse) soapMessage.getExchange().getInMessage()
                    .get(AbstractHTTPDestination.HTTP_RESPONSE);
            response.setStatus(200);
            try {
                response.getOutputStream().write(MATCH_TO_OLD_BAD_WRONG_AXIS1.getBytes());
                response.getOutputStream().flush();
                soapMessage.getInterceptorChain().abort();
            } catch (IOException ioex) {
                throw new RuntimeException("Error writing the response");
            }
        } else if (someOtherErrorOccured(faultCause)) {
            // Some other Error occured, we don´t know. But we want to react with a Custom
            // Error-Message
            LOG.errorOccuredInBackendProcessing(faultCause);
            soapFaultBuilder.buildCustomFaultAndSet2SoapMessage(soapMessage, FaultType.BACKEND_PROCESSING_FAILED);
        }
    }
    private boolean nobindingIssue(String faultMessage) {
        if (NO_BINDDING_ERROR_MESSAGE.equalsIgnoreCase(faultMessage)) {
            return true;
        }
        return false;
    }
    private boolean containsFaultIndicatingNotSchemeCompliantXml(Throwable faultCause, String faultMessage) {
        if (faultCause instanceof UnmarshalException
                // 1.) If the root-Element of the SoapBody is syntactically correct, but not
                // scheme-compliant,
                // there is no UnmarshalException and we have to look for
                // 2.) Missing / lead to Faults without Causes, but to Messages like "Unexpected
                // wrapper element XYZ found. Expected"
                // One could argue, that this is syntactically incorrect, but here we just take
                // it as Non-Scheme-compliant
                || isNotNull(faultMessage) && faultMessage.contains("Unexpected wrapper element")) {
            return true;
        }
        return false;
    }
    private boolean containsFaultIndicatingSyntacticallyIncorrectXml(Throwable faultCause) {
        if (faultCause instanceof WstxException
                // If Xml-Header is invalid, there is a wrapped Cause in the original Cause we
                // have to check
                || isNotNull(faultCause) && faultCause.getCause() instanceof WstxUnexpectedCharException
                || faultCause instanceof IllegalArgumentException) {
            return true;
        }
        return false;
    }
    private boolean someOtherErrorOccured(Throwable faultCause) {
        // Catch all other (un-)checked Exceptions, to handle with Custom Error-Message
        return isNotNull(faultCause);
    }
    private boolean isNotNull(Object object) {
        return object != null;
    }
    public void setSoapFaultBuilder(SoapFaultBuilder soapFaultBuilder) {
        this.soapFaultBuilder = soapFaultBuilder;
    }
}
When you want to use that Custom Fault, you just enable it like this.
package com.sillycat.connectors.quickbooks.customfault;
import org.springframework.stereotype.Component;
import de.codecentric.cxf.common.FaultType;
import de.codecentric.cxf.xmlvalidation.CustomFaultBuilder;
@Component
public class CustomSOAPNoBindingFault implements CustomFaultBuilder {
private static final String MATCH_TO_OLD_BAD_WRONG_AXIS1 = "<h1>QBWebService</h1>\n"
+ "<p>Hi there, this is an AXIS service!</p>\n"
+ "<i>Perhaps there will be a form for invoking the service here...</i>";
@Override
public Object createCustomFaultDetail(String originalFaultMessage, FaultType faultContent) {
return MATCH_TO_OLD_BAD_WRONG_AXIS1;
}
@Override
public String createCustomFaultMessage(FaultType arg0) {
return MATCH_TO_OLD_BAD_WRONG_AXIS1;
}
}

References:
https://alvinalexander.com/java/jwarehouse/apache-cxf/systests/jaxrs/src/test/java/org/apache/cxf/systest/jaxrs/CustomOutFaultInterceptor.java.shtml
https://github.com/codecentric/cxf-spring-boot-starter
https://github.com/luohuazju/cxf-spring-boot-starter
https://stackoverflow.com/questions/37984617/propagate-exception-from-cxf-interceptor-to-exception-mapper
https://www.jianshu.com/p/db047f740269
https://codeday.me/bug/20190219/659141.html