/**
* Licensed to the Apache Software Foundation (ASF) under one
* or more contributor license agreements. See the NOTICE file
* distributed with this work for additional information
* regarding copyright ownership. The ASF licenses this file
* to you under the Apache License, Version 2.0 (the
* "License"); you may not use this file except in compliance
* with the License. You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing,
* software distributed under the License is distributed on an
* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
* KIND, either express or implied. See the License for the
* specific language governing permissions and limitations
* under the License.
*/
package org.apache.cxf.ws.rm.soap;
import java.io.InputStream;
import java.lang.reflect.Method;
import java.util.ArrayList;
import java.util.Collection;
import java.util.Iterator;
import java.util.List;
import java.util.Set;
import javax.xml.namespace.QName;
import javax.xml.stream.XMLInputFactory;
import javax.xml.stream.XMLStreamException;
import javax.xml.stream.XMLStreamReader;
import org.w3c.dom.Element;
import org.apache.cxf.BusFactory;
import org.apache.cxf.binding.soap.SoapFault;
import org.apache.cxf.binding.soap.SoapMessage;
import org.apache.cxf.binding.soap.interceptor.ReadHeadersInterceptor;
import org.apache.cxf.binding.soap.interceptor.StartBodyInterceptor;
import org.apache.cxf.headers.Header;
import org.apache.cxf.message.Exchange;
import org.apache.cxf.message.ExchangeImpl;
import org.apache.cxf.message.Message;
import org.apache.cxf.message.MessageImpl;
import org.apache.cxf.message.MessageUtils;
import org.apache.cxf.ws.addressing.AddressingProperties;
import org.apache.cxf.ws.addressing.Names;
import org.apache.cxf.ws.rm.RM10Constants;
import org.apache.cxf.ws.rm.RMConstants;
import org.apache.cxf.ws.rm.RMContextUtils;
import org.apache.cxf.ws.rm.RMProperties;
import org.apache.cxf.ws.rm.SequenceFault;
import org.apache.cxf.ws.rm.v200702.AckRequestedType;
import org.apache.cxf.ws.rm.v200702.Identifier;
import org.apache.cxf.ws.rm.v200702.ObjectFactory;
import org.apache.cxf.ws.rm.v200702.SequenceAcknowledgement;
import org.apache.cxf.ws.rm.v200702.SequenceAcknowledgement.AcknowledgementRange;
import org.apache.cxf.ws.rm.v200702.SequenceType;
import org.easymock.EasyMock;
import org.easymock.IMocksControl;
import org.junit.Assert;
import org.junit.Before;
import org.junit.Test;
public class RMSoapInterceptorTest extends Assert {
private static final String SEQ_IDENTIFIER = "http://Business456.com/RM/ABC";
private static final Long ONE = new Long(1);
private static final Long TEN = new Long(10);
private static final Long MSG1_MESSAGE_NUMBER = ONE;
private static final Long MSG2_MESSAGE_NUMBER = new Long(2);
private IMocksControl control;
private SequenceType s1;
private SequenceType s2;
private SequenceAcknowledgement ack1;
private SequenceAcknowledgement ack2;
private AckRequestedType ar1;
private AckRequestedType ar2;
@Before
public void setUp() {
control = EasyMock.createNiceControl();
}
@Test
public void testGetUnderstoodHeaders() throws Exception {
RMSoapInterceptor codec = new RMSoapInterceptor();
Set<QName> headers = codec.getUnderstoodHeaders();
assertTrue("expected Sequence header", headers.contains(RM10Constants.SEQUENCE_QNAME));
assertTrue("expected SequenceAcknowledgment header",
headers.contains(RM10Constants.SEQUENCE_ACK_QNAME));
assertTrue("expected AckRequested header",
headers.contains(RM10Constants.ACK_REQUESTED_QNAME));
}
@Test
public void testHandleMessage() throws NoSuchMethodException {
Method m = RMSoapInterceptor.class.getDeclaredMethod("mediate",
new Class[] {SoapMessage.class});
RMSoapInterceptor codec =
EasyMock.createMockBuilder(RMSoapInterceptor.class)
.addMockedMethod(m).createMock(control);
SoapMessage msg = control.createMock(SoapMessage.class);
codec.mediate(msg);
EasyMock.expectLastCall();
control.replay();
codec.handleMessage(msg);
control.verify();
}
@Test
public void testMediate() throws NoSuchMethodException, XMLStreamException {
Method m1 = RMSoapInterceptor.class.getDeclaredMethod("encode",
new Class[] {SoapMessage.class});
Method m2 = RMSoapInterceptor.class.getDeclaredMethod("decode",
new Class[] {SoapMessage.class});
RMSoapInterceptor codec =
EasyMock.createMockBuilder(RMSoapInterceptor.class)
.addMockedMethods(m1, m2).createMock(control);
SoapMessage msg = control.createMock(SoapMessage.class);
Exchange exchange = control.createMock(Exchange.class);
EasyMock.expect(msg.getExchange()).andReturn(exchange);
EasyMock.expect(exchange.getOutMessage()).andReturn(msg);
codec.encode(msg);
EasyMock.expectLastCall();
control.replay();
codec.mediate(msg);
control.verify();
control.reset();
EasyMock.expect(msg.getExchange()).andReturn(null);
codec.decode(msg);
EasyMock.expectLastCall();
control.replay();
codec.mediate(msg);
control.verify();
}
@Test
public void testEncode() throws Exception {
RMSoapInterceptor codec = new RMSoapInterceptor();
setUpOutbound();
SoapMessage message = setupOutboundMessage();
// no RM headers
codec.handleMessage(message);
verifyHeaders(message, new String[] {});
// one sequence header
message = setupOutboundMessage();
RMProperties rmps = RMContextUtils.retrieveRMProperties(message, true);
rmps.setSequence(s1);
codec.encode(message);
verifyHeaders(message, new String[] {RMConstants.SEQUENCE_NAME});
// one acknowledgment header
message = setupOutboundMessage();
rmps = RMContextUtils.retrieveRMProperties(message, true);
Collection<SequenceAcknowledgement> acks = new ArrayList<SequenceAcknowledgement>();
acks.add(ack1);
rmps.setAcks(acks);
codec.encode(message);
verifyHeaders(message, new String[] {RMConstants.SEQUENCE_ACK_NAME});
// two acknowledgment headers
message = setupOutboundMessage();
rmps = RMContextUtils.retrieveRMProperties(message, true);
acks.add(ack2);
rmps.setAcks(acks);
codec.encode(message);
verifyHeaders(message, new String[] {RMConstants.SEQUENCE_ACK_NAME,
RMConstants.SEQUENCE_ACK_NAME});
// one ack requested header
message = setupOutboundMessage();
rmps = RMContextUtils.retrieveRMProperties(message, true);
Collection<AckRequestedType> requested = new ArrayList<AckRequestedType>();
requested.add(ar1);
rmps.setAcksRequested(requested);
codec.encode(message);
verifyHeaders(message, new String[] {RMConstants.ACK_REQUESTED_NAME});
// two ack requested headers
message = setupOutboundMessage();
rmps = RMContextUtils.retrieveRMProperties(message, true);
requested.add(ar2);
rmps.setAcksRequested(requested);
codec.encode(message);
verifyHeaders(message, new String[] {RMConstants.ACK_REQUESTED_NAME,
RMConstants.ACK_REQUESTED_NAME});
}
@Test
public void testEncodeFault() throws Exception {
RMSoapInterceptor codec = new RMSoapInterceptor();
setUpOutbound();
SoapMessage message = setupOutboundFaultMessage();
// no RM headers and no fault
codec.encode(message);
verifyHeaders(message, new String[] {});
// fault is not a SoapFault
message = setupOutboundFaultMessage();
assertTrue(MessageUtils.isFault(message));
Exception ex = new RuntimeException("");
message.setContent(Exception.class, ex);
codec.encode(message);
verifyHeaders(message, new String[] {});
// fault is a SoapFault but does not have a SequenceFault cause
message = setupOutboundFaultMessage();
SoapFault f = new SoapFault("REASON", RM10Constants.UNKNOWN_SEQUENCE_FAULT_QNAME);
message.setContent(Exception.class, f);
codec.encode(message);
verifyHeaders(message, new String[] {});
// fault is a SoapFault and has a SequenceFault cause
message = setupOutboundFaultMessage();
SequenceFault sf = new SequenceFault("REASON");
sf.setFaultCode(RM10Constants.UNKNOWN_SEQUENCE_FAULT_QNAME);
Identifier sid = new Identifier();
sid.setValue("SID");
sf.setSender(true);
f.initCause(sf);
message.setContent(Exception.class, f);
codec.encode(message);
verifyHeaders(message, new String[] {RMConstants.SEQUENCE_FAULT_NAME});
}
@Test
public void testDecodeSequence() throws XMLStreamException {
SoapMessage message = setUpInboundMessage("resources/Message1.xml");
RMSoapInterceptor codec = new RMSoapInterceptor();
codec.handleMessage(message);
RMProperties rmps = RMContextUtils.retrieveRMProperties(message, false);
SequenceType st = rmps.getSequence();
assertNotNull(st);
assertEquals(st.getIdentifier().getValue(), SEQ_IDENTIFIER);
assertEquals(st.getMessageNumber(), MSG1_MESSAGE_NUMBER);
assertNull(rmps.getAcks());
assertNull(rmps.getAcksRequested());
}
@Test
public void testDecodeAcknowledgements() throws XMLStreamException {
SoapMessage message = setUpInboundMessage("resources/Acknowledgment.xml");
RMSoapInterceptor codec = new RMSoapInterceptor();
codec.handleMessage(message);
RMProperties rmps = RMContextUtils.retrieveRMProperties(message, false);
Collection<SequenceAcknowledgement> acks = rmps.getAcks();
assertNotNull(acks);
assertEquals(1, acks.size());
SequenceAcknowledgement ack = acks.iterator().next();
assertNotNull(ack);
assertEquals(ack.getIdentifier().getValue(), SEQ_IDENTIFIER);
assertEquals(2, ack.getAcknowledgementRange().size());
AcknowledgementRange r1 = ack.getAcknowledgementRange().get(0);
AcknowledgementRange r2 = ack.getAcknowledgementRange().get(1);
verifyRange(r1, 1, 1);
verifyRange(r2, 3, 3);
assertNull(rmps.getSequence());
assertNull(rmps.getAcksRequested());
}
@Test
public void testDecodeAcknowledgements2() throws XMLStreamException {
SoapMessage message = setUpInboundMessage("resources/Acknowledgment2.xml");
RMSoapInterceptor codec = new RMSoapInterceptor();
codec.handleMessage(message);
RMProperties rmps = RMContextUtils.retrieveRMProperties(message, false);
Collection<SequenceAcknowledgement> acks = rmps.getAcks();
assertNotNull(acks);
assertEquals(1, acks.size());
SequenceAcknowledgement ack = acks.iterator().next();
assertNotNull(ack);
assertEquals(1, ack.getAcknowledgementRange().size());
AcknowledgementRange r1 = ack.getAcknowledgementRange().get(0);
verifyRange(r1, 1, 3);
assertNull(rmps.getSequence());
assertNull(rmps.getAcksRequested());
}
private void verifyRange(AcknowledgementRange r, int i, int j) {
assertNotNull(r);
if (i > 0) {
assertNotNull(r.getLower());
assertEquals(i, r.getLower().longValue());
}
if (j > 0) {
assertNotNull(r.getUpper());
assertEquals(j, r.getUpper().longValue());
}
}
@Test
public void testDecodeAcksRequested() throws XMLStreamException {
SoapMessage message = setUpInboundMessage("resources/Retransmission.xml");
RMSoapInterceptor codec = new RMSoapInterceptor();
codec.handleMessage(message);
RMProperties rmps = RMContextUtils.retrieveRMProperties(message, false);
Collection<AckRequestedType> requested = rmps.getAcksRequested();
assertNotNull(requested);
assertEquals(1, requested.size());
AckRequestedType ar = requested.iterator().next();
assertNotNull(ar);
assertEquals(ar.getIdentifier().getValue(), SEQ_IDENTIFIER);
SequenceType s = rmps.getSequence();
assertNotNull(s);
assertEquals(s.getIdentifier().getValue(), SEQ_IDENTIFIER);
assertEquals(s.getMessageNumber(), MSG2_MESSAGE_NUMBER);
assertNull(rmps.getAcks());
}
private void setUpOutbound() {
ObjectFactory factory = new ObjectFactory();
s1 = factory.createSequenceType();
Identifier sid = factory.createIdentifier();
sid.setValue("sequence1");
s1.setIdentifier(sid);
s1.setMessageNumber(ONE);
s2 = factory.createSequenceType();
sid = factory.createIdentifier();
sid.setValue("sequence2");
s2.setIdentifier(sid);
s2.setMessageNumber(TEN);
ack1 = factory.createSequenceAcknowledgement();
SequenceAcknowledgement.AcknowledgementRange r =
factory.createSequenceAcknowledgementAcknowledgementRange();
r.setLower(ONE);
r.setUpper(ONE);
ack1.getAcknowledgementRange().add(r);
ack1.setIdentifier(s1.getIdentifier());
ack2 = factory.createSequenceAcknowledgement();
r = factory.createSequenceAcknowledgementAcknowledgementRange();
r.setLower(ONE);
r.setUpper(TEN);
ack2.getAcknowledgementRange().add(r);
ack2.setIdentifier(s2.getIdentifier());
ar1 = factory.createAckRequestedType();
ar1.setIdentifier(s1.getIdentifier());
ar2 = factory.createAckRequestedType();
ar2.setIdentifier(s2.getIdentifier());
}
private SoapMessage setupOutboundMessage() throws Exception {
Exchange ex = new ExchangeImpl();
Message message = new MessageImpl();
SoapMessage soapMessage = new SoapMessage(message);
RMProperties rmps = new RMProperties();
rmps.exposeAs(RM10Constants.NAMESPACE_URI);
RMContextUtils.storeRMProperties(soapMessage, rmps, true);
AddressingProperties maps = new AddressingProperties();
RMContextUtils.storeMAPs(maps, soapMessage, true, false);
ex.setOutMessage(soapMessage);
soapMessage.setExchange(ex);
return soapMessage;
}
private SoapMessage setupOutboundFaultMessage() throws Exception {
Exchange ex = new ExchangeImpl();
Message message = new MessageImpl();
RMProperties rmps = new RMProperties();
rmps.exposeAs(RM10Constants.NAMESPACE_URI);
RMContextUtils.storeRMProperties(message, rmps, false);
AddressingProperties maps = new AddressingProperties();
RMContextUtils.storeMAPs(maps, message, false, false);
ex.setInMessage(message);
message = new MessageImpl();
SoapMessage soapMessage = new SoapMessage(message);
ex.setOutFaultMessage(soapMessage);
soapMessage.setExchange(ex);
return soapMessage;
}
private void verifyHeaders(SoapMessage message, String... names) {
List<Header> header = message.getHeaders();
// check all expected headers are present
for (String name : names) {
boolean found = false;
Iterator<Header> iter = header.iterator();
while (iter.hasNext()) {
Object obj = iter.next().getObject();
if (obj instanceof Element) {
Element elem = (Element) obj;
String namespace = elem.getNamespaceURI();
String localName = elem.getLocalName();
if (RM10Constants.NAMESPACE_URI.equals(namespace)
&& localName.equals(name)) {
found = true;
break;
} else if (Names.WSA_NAMESPACE_NAME.equals(namespace)
&& localName.equals(name)) {
found = true;
break;
}
}
}
assertTrue("Could not find header element " + name, found);
}
// no other headers should be present
Iterator<Header> iter1 = header.iterator();
while (iter1.hasNext()) {
Object obj = iter1.next().getObject();
if (obj instanceof Element) {
Element elem = (Element) obj;
String namespace = elem.getNamespaceURI();
String localName = elem.getLocalName();
assertTrue(RM10Constants.NAMESPACE_URI.equals(namespace)
|| Names.WSA_NAMESPACE_NAME.equals(namespace));
boolean found = false;
for (String name : names) {
if (localName.equals(name)) {
found = true;
break;
}
}
assertTrue("Unexpected header element " + localName, found);
}
}
}
private SoapMessage setUpInboundMessage(String resource) throws XMLStreamException {
Message message = new MessageImpl();
SoapMessage soapMessage = new SoapMessage(message);
RMProperties rmps = new RMProperties();
rmps.exposeAs(RM10Constants.NAMESPACE_URI);
RMContextUtils.storeRMProperties(soapMessage, rmps, false);
AddressingProperties maps = new AddressingProperties();
RMContextUtils.storeMAPs(maps, soapMessage, false, false);
message.put(Message.SCHEMA_VALIDATION_ENABLED, false);
InputStream is = RMSoapInterceptorTest.class.getResourceAsStream(resource);
assertNotNull(is);
XMLStreamReader reader = XMLInputFactory.newInstance().createXMLStreamReader(is);
soapMessage.setContent(XMLStreamReader.class, reader);
ReadHeadersInterceptor rji = new ReadHeadersInterceptor(BusFactory.getDefaultBus());
rji.handleMessage(soapMessage);
StartBodyInterceptor sbi = new StartBodyInterceptor();
sbi.handleMessage(soapMessage);
return soapMessage;
}
}