WS-Reliable Messaging
CXF supports the February 2005 version of the Web Services Reliable Messaging Protocol (WS-ReliableMessaging) specification. Like most other features in CXF, it is interceptor based.
The WS-Reliable Messaging implementation consists of 4 interceptors in total:
Interceptor |
Task |
org.apache.cxf.ws.rm.RMOutInterceptor |
Responsible for sending CreateSequence requests and waiting for their CreateSequenceResponse responses, and and aggregating the sequence properties (id and message number) for an application message. |
org.apache.cxf.ws.rm.RMInInterceptor |
Intercepting and processing RM protocol messages (these will not the application level), as well as SequenceAcknowledgments piggybacked on application messages. |
org.apache.cxf.ws.rm.soap.RMSoapInterceptor |
Encoding and decoding the RM headers |
org.apache.cxf.ws.rm.soap.RetransmissionInterceptor |
Responsible for creating copies of application messages for future resends. |
Interceptor Based QOS
The presence of the RM interceptors on the respective interceptor chains alone will take care that RM protocol messages are exchanged when necessary. For example, upon intercepting the first application message on the outbound interceptor chain, the RMOutInterceptor will send a CreateSequence request and only proceed with processing the original application message after it has the CreateSequenceResponse response. Furthermore, the RM interceptors are responsible for adding the Sequence headers to the application messages and, on the destination side, extracting them from the message.
This means that no changes to application code are required to make the message exchange reliable!
You can still control sequence demarcation and other aspects of the reliable exchange through configuration however. For example, while CXF by default attempts to maximize the lifetime of a sequence, thus reducing the overhead incurred by the RM protocol messages, you can enforce the use of a separate sequence per application message by configuring the RM source's sequence termination policy (setting the maximum sequence length to 1). See the Reliable Messaging Configuration Guide for more details on configuring this and other aspects of the reliable exchange.