cxf-issues mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From "Gary Gregory (JIRA)" <>
Subject [jira] Commented: (CXF-2594) No SOAP fault XML elements when a Fault is thrown in the output chain after SAAJOutInterceptor
Date Mon, 28 Dec 2009 00:06:30 GMT


Gary Gregory commented on CXF-2594:

-----Original Message-----
From: Gary Gregory [] 
Sent: Monday, December 21, 2009 17:13
To: Daniel Kulp;
Subject: RE: Inflexible fault interceptor chain?

Hello Dan and all,

Ok, the SAAJOutInterceptor solution almost worked. The behavior I describe below is the same
in CXF 2.2.4 and 2.2.6-SNAPSHOT (as of Saturday's build). I am not on 2.2.5 due to some bugs
that are fixed in 2.2.6. The debugging information I gathered for this message is with 2.2.4.

I have two scenarios, one works and one does not with the SAAJOutInterceptor solution. 

If a Fault is thrown by a custom interceptor at a certain point in the output chain, the wrong
SOAP XML is generated, specifically no SOAP fault XML elements are generated. Let me start
by showing what works and why before showing what does not and why.

In the first scenario, which works, a SoapFault is thrown by our provider's invoke(SOAPMessage)
method under certain conditions, basically if our server detects certain errors. Our provider
looks like this:

@ServiceMode(value = Service.Mode.MESSAGE)
public static class LdeWebServiceProvider implements Provider<SOAPMessage> {
   public SOAPMessage invoke(SOAPMessage soapRequest) {
      throw new SoapFault("Our message", Soap11.getInstance().getReceiver());

In SAAJOutInterceptor.handleMessage, the local variable saaj is null, so the code path taken
builds a SOAP message from scratch and plugs in a W3CDOMStreamWriter. All of the interceptors
then write to W3CDOMStreamWriter instead of the default XMLStreamWriter which normally caches
and writes to the HTTP wire. The W3CDOMStreamWriter allows me to transform the DOM before
it gets on the wire. Great stuff, it works.

In the second scenario, I test our output feature where in addition to an optional transformation,
we have custom interceptors to do optional XML validation before and after the XML transformation.
After our provider successfully processed a message, the output chain processing kicks in
and looks like this:

Chain org.apache.cxf.phase.PhaseInterceptorChain@c375934. Current flow:
  setup [PolicyOutInterceptor]
  pre-logical [SwAOutInterceptor, SoapHeaderOutFilterInterceptor]
  post-logical [SoapPreProtocolOutInterceptor]
  prepare-send [MessageSenderInterceptor, MessageModeOutInterceptor]
  pre-stream [LoggingOutInterceptor, XmlDeclOutInterceptor*, AttachmentOutInterceptor, StaxOutInterceptor]
  pre-protocol [MessageModeOutInterceptorInternal, SAAJOutInterceptor, SOAPHandlerInterceptor,
  write [SoapOutInterceptor]
  pre-marshal [LogicalHandlerOutInterceptor, ValidatingOutInterceptor*, TransformOutInterceptor*,
  marshal [BareOutInterceptor]
  write-ending [SoapOutEndingInterceptor]
  pre-protocol-ending [SAAJOutEndingInterceptor]
  pre-stream-ending [StaxOutEndingInterceptor]
  prepare-send-ending [MessageSenderEndingInterceptor]

The interceptors marked with * are mine:
- XmlDeclOutInterceptor forces the XML declaration to be written.
- ValidatingOutInterceptor validates XML
- TransformOutInterceptor transforms XML
- ValidatingOutInterceptor validates XML

The problem occurs if XML validation fails (the first validation in this test).

When the XML validation fails, an exception thrown, caught, and re-thrown as a fault.
At the start of fault processing, the chain when SAAJOutInterceptor is called looks like this:
  Chain org.apache.cxf.phase.PhaseInterceptorChain@77c16c5f. Current flow:
  setup [ServerPolicyOutFaultInterceptor]
  prepare-send [MessageSenderInterceptor, Soap11FaultOutInterceptor]
  pre-stream [LoggingOutInterceptor, XmlDeclOutInterceptor*, StaxOutInterceptor]
  pre-protocol [WebFaultOutInterceptor, SAAJOutInterceptor, SOAPHandlerFaultOutInterceptor]
  write [SoapOutInterceptor]
  pre-marshal [LogicalHandlerFaultOutInterceptor]
  marshal [Soap11FaultOutInterceptorInternal]
  pre-protocol-ending [TransformOutFaultInterceptor*]
  prepare-send-ending [MessageSenderEndingInterceptor]

The interceptors marked with * are mine:
- XmlDeclOutInterceptor forces the XML declaration to be written.
- TransformOutFaultInterceptor validates XML

When I step through this SAAJOutInterceptor invocation, the saaj variable is NOT null, so
the code path taken is different from what I described above. Instead of a W3CDOMStreamWriter,
a dummy XMLStreamWriter is created that throws away whatever is written to it:

            //as the SOAPMessage already has everything in place, we do not need XMLStreamWriter
to write
            //anything for us, so we just set XMLStreamWriter's output to a dummy output stream.
            XMLStreamWriter origWriter = message.getContent(XMLStreamWriter.class);
            message.put(ORIGINAL_XML_WRITER, origWriter);
            XMLStreamWriter dummyWriter = StaxUtils.createXMLStreamWriter(new OutputStream()
                    public void write(int b) throws IOException {
                    public void write(byte b[], int off, int len) throws IOException {
            message.setContent(XMLStreamWriter.class, dummyWriter);

No wonder I get no SOAP fault information back, I get:

<?xml version='1.0' encoding='ISO-8859-1'?>
<SOAP-ENV:Envelope xmlns:SOAP-ENV="" xmlns:soap="">
	<SOAP-ENV:Header xmlns:SOAP-ENV="">
		<ais:requestID xmlns:ais="http://com.seagullsw.appinterface/AppInterfaceServer">{c0a80102-00ce16ad0000010e75da25398002}</ais:requestID>
	<SOAP-ENV:Body xmlns:SOAP-ENV="" />

Is this a bug? Why would there be a dummy writer put in place? Is there another CXF way to
do this?

Thank you,

> No SOAP fault XML elements when a Fault is thrown in the output chain after SAAJOutInterceptor
> ----------------------------------------------------------------------------------------------
>                 Key: CXF-2594
>                 URL:
>             Project: CXF
>          Issue Type: Bug
>    Affects Versions: 2.2.4
>         Environment: java version "1.6.0_16"
> Java(TM) SE Runtime Environment (build 1.6.0_16-b01)
> Java HotSpot(TM) 64-Bit Server VM (build 14.2-b01, mixed mode)
> Microsoft Windows [Version 6.0.6002]
> Apache Maven 2.2.1 (r801777; 2009-08-06 12:16:01-0700)
> Java version: 1.6.0_16
> Java home: C:\Program Files\Java\jdk1.6.0_16\jre
> Default locale: en_US, platform encoding: Cp1252
> OS name: "windows vista" version: "6.0" arch: "amd64" Family: "windows"
> Eclipse 3.6M4:
> Version: 3.6.0
> Build id: I20091210-1301
>            Reporter: Gary Gregory
>             Fix For: 2.2.6
> The attached unit test runs on top of the 2.2.x SVN branch updated from SVN as of now.
> This ticket originated with this thread:
> Which I replicate here with comments used for each step:
> Hi All:
> I need to apply an XSL transformation to messages coming out of CXF (our users configure
what the XSL looks like.) For a normal (successful) message, I have an interceptor (during
Phase.PRE_MARSHAL) that uses the DOM aspect of a message. That works great. BTW, I get to
the DOM like this:
> Node node = (Node) message.getContent(List.class).get(0);
> That seems brittle, is there a safer way to get to an aspect of the message I can feed
to javax.xml.transform?
> The real issue comes with fault messages because the fault chain uses an XMLStreamWriter<>.
The fault chain looks like this:
> Chain org.apache.cxf.phase.PhaseInterceptorChain@3015b303. Current flow:
>   setup [ServerPolicyOutFaultInterceptor]
>   prepare-send [MessageSenderInterceptor, Soap11FaultOutInterceptor]
>   pre-stream [LoggingOutInterceptor, XmlDeclOutInterceptor*, StaxOutInterceptor]
>   pre-protocol [WebFaultOutInterceptor, SOAPHandlerFaultOutInterceptor]
>   write [SoapOutInterceptor]
>   pre-marshal [LogicalHandlerFaultOutInterceptor]
>   marshal [Soap11FaultOutInterceptorInternal]
>   pre-stream-ending [StaxOutEndingInterceptor, TransformOutFaultInterceptor*]
>   prepare-send-ending [MessageSenderEndingInterceptor]
> FYI, the interceptors marked with * are our own:
> *         XmlDeclOutInterceptor forces an XML declaration to be written.
> *         TransformOutFaultInterceptor is where I thought I could transform the fault
XML message.
> The XMLStreamWriter<>
looks like this:
> [StreamWriter: class com.ctc.wstx.sw.SimpleNsStreamWriter, underlying outputter: com.ctc.wstx.sw.ISOLatin1XmlWriter@1125cf44<mailto:com.ctc.wstx.sw.ISOLatin1XmlWriter@1125cf44>
> The com.ctc.wstx.sw.ISOLatin1XmlWriter wraps a,
which in turns wraps:
> *         currentStream - LoadingByteArrayOutputStream
> *         flowThroughStream - AbstractHTTPDestination$WrappedOutputStream
> All of this to say that when the chain's interceptors are working with the message's
the bytes are cached and written to the wire. It is not possible to catch the fault XML message
and change it.
> The only thing I've come up with but not implemented yet would be to insert an interceptor
before the XML declaration is written and put the XMLStreamWriter<>
into a temp spot in the message content map, then put a new XMLStreamWriter<>
on a byte array in its place. A pre-stream-ending interceptor can take those bytes, apply
XSL to them and then write them to the original XMLStreamWriter<>,
before putting the original XMLStreamWriter<>
back in it original slot in the message content map.
> That seems like big old hack.
> Any ideas on a cleaner solution?
> Thank you,
> Gary Gregory
> Seagull Software

This message is automatically generated by JIRA.
You can reply to this email to add a comment to the issue online.

View raw message