Minor Description
SOAPFaultImpl#internalSerialize contains logic to reorder the child elements to satisfy the requirements of SOAP 1.2 (which explicitly requires the child elements of a SOAP fault to appear in a specific order). This is useful for programmatically created SOAP faults because the application code doesn't need to take care of the order in which setCode, setReason, etc. are called. However, the reordering only works with some serialization methods. In particular, the child elements are not reordered when the SOAP message is serialized using a pull parser.
This can be shown using the following code:
SOAPFactory factory = OMAbstractFactory.getSOAP12Factory();
SOAPFault fault = factory.createSOAPFault();
SOAPFaultReason reason = factory.createSOAPFaultReason();
reason.setText("Some reason");
fault.setReason(reason);
SOAPFaultCode code = factory.createSOAPFaultCode();
code.setText(new QName(factory.getNamespace().getNamespaceURI(), "Server"));
fault.setCode(code);
System.out.println("Using serialize:");
fault.serialize(System.out);
System.out.println();
System.out.println("Using pull parser:");
XMLStreamWriter writer = StAXUtils.createXMLStreamWriter(System.out);
new StreamingOMSerializer().serialize(fault.getXMLStreamReader(), writer);
writer.close();
The output is:
Using serialize:
<soapenv:Fault xmlns:soapenv="http://www.w3.org/2003/05/soap-envelope"><soapenv:Code>soapenv:Server</soapenv:Code><soapenv:Reason>Some reason</soapenv:Reason></soapenv:Fault>
Using pull parser:
<soapenv:Fault xmlns:soapenv="http://www.w3.org/2003/05/soap-envelope"><soapenv:Reason>Some reason</soapenv:Reason><soapenv:Code>soapenv:Server</soapenv:Code></soapenv:Fault>
The reordering only occurs in the first case.
Ideally, Axiom should take care of the order of child elements in the setCode, setReason, etc. methods and then just serialize the object model as is.