Ensure wsa:To is OPTIONAL or REQUIRED per the WS Addressing standard used.

leaqui · gregturn · commit e1035a96f065 · 2023-04-10T15:15:20.000-05:00
Introduce means to make wsa:To properly handled based on the version of WS Addressing. There are also some faulty assumptions in the test cases that don't properly reflect these two standards. Resolves: #1100. Original pull request: #115.
diff --git a/spring-ws-core/src/main/java/org/springframework/ws/soap/addressing/client/ActionCallback.java b/spring-ws-core/src/main/java/org/springframework/ws/soap/addressing/client/ActionCallback.java
@@ -48,6 +48,7 @@
  * </pre>
  *
  * @author Arjen Poutsma
+ * @author Leandro Quiroga
  * @since 1.0.0
  */
 public class ActionCallback implements WebServiceMessageCallback {
@@ -58,6 +59,8 @@ public class ActionCallback implements WebServiceMessageCallback {
 
 	private final URI to;
 
+	private boolean shouldInitializeTo;
+
 	private MessageIdStrategy messageIdStrategy;
 
 	private EndpointReference from;
@@ -219,7 +222,7 @@ public void setFaultTo(EndpointReference faultTo) {
 	 * destination was set.
 	 */
 	protected URI getTo() {
-		if (to == null) {
+		if (to == null && (isToHeaderRequired() || shouldInitializeTo)) {
 			TransportContext transportContext = TransportContextHolder.getTransportContext();
 			if (transportContext != null && transportContext.getConnection() != null) {
 				try {
@@ -234,6 +237,17 @@ protected URI getTo() {
 		}
 	}
 
+	private boolean isToHeaderRequired() {
+		return getVersion().isToHeaderRequired();
+	}
+
+	/**
+	 * Set whether to initialize the {@code To} header by default or not.
+	 */
+	public void setShouldInitializeTo(boolean shouldInitializeTo) {
+		this.shouldInitializeTo = shouldInitializeTo;
+	}
+
 	@Override
 	public void doWithMessage(WebServiceMessage message) throws IOException, TransformerException {
 
@@ -244,5 +258,4 @@ public void doWithMessage(WebServiceMessage message) throws IOException, Transfo
 				getAction(), messageId);
 		version.addAddressingHeaders(soapMessage, map);
 	}
-
 }
diff --git a/spring-ws-core/src/main/java/org/springframework/ws/soap/addressing/version/AbstractAddressingVersion.java b/spring-ws-core/src/main/java/org/springframework/ws/soap/addressing/version/AbstractAddressingVersion.java
@@ -197,7 +197,6 @@ public void addAddressingHeaders(SoapMessage message, MessageAddressingPropertie
 		if (map.getTo() != null) {
 			SoapHeaderElement to = header.addHeaderElement(getToName());
 			to.setText(map.getTo().toString());
-			to.setMustUnderstand(true);
 		}
 		// From
 		if (map.getFrom() != null) {
diff --git a/spring-ws-core/src/main/java/org/springframework/ws/soap/addressing/version/Addressing10.java b/spring-ws-core/src/main/java/org/springframework/ws/soap/addressing/version/Addressing10.java
@@ -30,7 +30,8 @@
  * Communication Foundation (WCF), and supported by Axis 1 and 2.
  *
  * @author Arjen Poutsma
- * @see <a href="http://www.w3.org/TR/2006/REC-ws-addr-core-20060509">Web Services Addressing, August 2004</a>
+ * @author Leandro Quiroga
+ * @see <a href="http://www.w3.org/TR/2006/REC-ws-addr-core-20060509">Web Services Addressing, May 2006</a>
  * @since 1.5.0
  */
 
@@ -55,6 +56,11 @@ public boolean hasRequiredProperties(MessageAddressingProperties map) {
 		return true;
 
 	}
+	
+	@Override
+	public boolean isToHeaderRequired() {
+		return false;
+	}
 
 	@Override
 	protected String getNamespaceUri() {
diff --git a/spring-ws-core/src/main/java/org/springframework/ws/soap/addressing/version/Addressing200408.java b/spring-ws-core/src/main/java/org/springframework/ws/soap/addressing/version/Addressing200408.java
@@ -30,6 +30,7 @@
  * Microsoft's Web Services Enhancements (WSE) 3.0, and supported by Axis 1 and 2, and XFire.
  *
  * @author Arjen Poutsma
+ * @author Leandro Quiroga
  * @see <a href="http://www.w3.org/Submission/2004/SUBM-ws-addressing-20040810/">Web Services Addressing, August
  *      2004</a>
  * @since 1.5.0
@@ -58,6 +59,11 @@ public boolean hasRequiredProperties(MessageAddressingProperties map) {
 		}
 		return true;
 	}
+	
+	@Override
+	public boolean isToHeaderRequired() {
+		return true;
+	}
 
 	@Override
 	protected final URI getAnonymous() {
diff --git a/spring-ws-core/src/main/java/org/springframework/ws/soap/addressing/version/AddressingVersion.java b/spring-ws-core/src/main/java/org/springframework/ws/soap/addressing/version/AddressingVersion.java
@@ -26,6 +26,7 @@
  * Defines the contract for a specific version of the WS-Addressing specification.
  *
  * @author Arjen Poutsma
+ * @author Leandro Quiroga
  * @since 1.5.0
  */
 public interface AddressingVersion {
@@ -63,6 +64,14 @@ public interface AddressingVersion {
 	 */
 	boolean hasRequiredProperties(MessageAddressingProperties map);
 
+	
+	/**
+	 * Indicates whether the wsa:To header is REQUIRED or not.
+	 *  
+	 * @return {@code true} if the wsa:To header of the {@link AddressingVersion} is REQUIRED. 
+	 */
+	boolean isToHeaderRequired();
+
 	/*
 	* Address URIs
 	*/
diff --git a/spring-ws-core/src/test/java/org/springframework/ws/soap/addressing/AbstractWsAddressingTestCase.java b/spring-ws-core/src/test/java/org/springframework/ws/soap/addressing/AbstractWsAddressingTestCase.java
@@ -38,6 +38,7 @@ public abstract class AbstractWsAddressingTestCase {
 	@BeforeEach
 	public void createMessageFactory() throws Exception {
 		messageFactory = MessageFactory.newInstance(SOAPConstants.SOAP_1_2_PROTOCOL);
+		XMLUnit.setIgnoreWhitespace(true);
 	}
 
 	protected SaajSoapMessage loadSaajMessage(String fileName) throws SOAPException, IOException {
diff --git a/spring-ws-core/src/test/java/org/springframework/ws/soap/addressing/client/AbstractActionCallbackTestCase.java b/spring-ws-core/src/test/java/org/springframework/ws/soap/addressing/client/AbstractActionCallbackTestCase.java
@@ -93,6 +93,7 @@ public void testDefaults() throws Exception {
 		URI connectionUri = new URI("mailto:fabrikam@example.com");
 		callback = new ActionCallback(action, getVersion());
 		callback.setMessageIdStrategy(strategyMock);
+		callback.setShouldInitializeTo(true);
 		expect(connectionMock.getUri()).andReturn(connectionUri);
 
 		SaajSoapMessage message = createDeleteMessage();
@@ -109,13 +110,35 @@ public void testDefaults() throws Exception {
 
 		verify(strategyMock, connectionMock);
 	}
+	
+	@Test
+	public void testNotInitializeTo() throws Exception {
+		URI action = new URI("http://example.com/fabrikam/mail/Delete");
+		URI connectionUri = new URI("mailto:fabrikam@example.com");
+		callback = new ActionCallback(action, getVersion());
+		callback.setMessageIdStrategy(strategyMock);
+		expect(connectionMock.getUri()).andReturn(connectionUri).times(0, 1);
+
+		SaajSoapMessage message = createDeleteMessage();
+		expect(strategyMock.newMessageId(message)).andReturn(new URI("http://example.com/someuniquestring"));
+		callback.setReplyTo(new EndpointReference(new URI("http://example.com/business/client1")));
+
+		replay(strategyMock, connectionMock);
+
+		callback.doWithMessage(message);
+
+		SaajSoapMessage expected = loadSaajMessage(getTestPath() + "/request-without-shouldInitializeTo.xml");
+		assertXMLSimilar(expected, message);
+		verify(strategyMock, connectionMock);
+	}
+
 
 	private SaajSoapMessage createDeleteMessage() throws SOAPException {
 
 		SOAPMessage saajMessage = messageFactory.createMessage();
 		SOAPBody saajBody = saajMessage.getSOAPBody();
 		SOAPBodyElement delete = saajBody.addBodyElement(new QName("http://example.com/fabrikam", "Delete"));
-		SOAPElement maxCount = delete.addChildElement(new QName("maxCount"));
+		SOAPElement maxCount = delete.addChildElement(new QName("http://example.com/fabrikam", "maxCount"));
 		maxCount.setTextContent("42");
 		return new SaajSoapMessage(saajMessage);
 	}
diff --git a/spring-ws-core/src/test/resources/org/springframework/ws/soap/addressing/10/request-without-shouldInitializeTo.xml b/spring-ws-core/src/test/resources/org/springframework/ws/soap/addressing/10/request-without-shouldInitializeTo.xml
@@ -0,0 +1,14 @@
+<S:Envelope xmlns:S="http://www.w3.org/2003/05/soap-envelope" xmlns:wsa="http://www.w3.org/2005/08/addressing">
+    <S:Header>
+        <wsa:MessageID>http://example.com/someuniquestring</wsa:MessageID>
+        <wsa:ReplyTo>
+            <wsa:Address>http://example.com/business/client1</wsa:Address>
+        </wsa:ReplyTo>
+        <wsa:Action>http://example.com/fabrikam/mail/Delete</wsa:Action>
+    </S:Header>
+    <S:Body>
+        <f:Delete xmlns:f="http://example.com/fabrikam">
+            <f:maxCount>42</f:maxCount>
+        </f:Delete>
+    </S:Body>
+</S:Envelope>
diff --git a/spring-ws-core/src/test/resources/org/springframework/ws/soap/addressing/10/response-anonymous.xml b/spring-ws-core/src/test/resources/org/springframework/ws/soap/addressing/10/response-anonymous.xml
@@ -2,7 +2,7 @@
     <env:Header>
         <wsa:MessageID>uid:1234</wsa:MessageID>
         <wsa:RelatesTo>http://example.com/someuniquestring</wsa:RelatesTo>
-        <wsa:To env:mustUnderstand="true">http://www.w3.org/2005/08/addressing/anonymous</wsa:To>
+        <wsa:To>http://www.w3.org/2005/08/addressing/anonymous</wsa:To>
         <wsa:Action>urn:replyAction</wsa:Action>
     </env:Header>
     <env:Body/>
diff --git a/spring-ws-core/src/test/resources/org/springframework/ws/soap/addressing/10/response-fault-to.xml b/spring-ws-core/src/test/resources/org/springframework/ws/soap/addressing/10/response-fault-to.xml
@@ -2,7 +2,7 @@
     <env:Header>
         <wsa:MessageID>uid:1234</wsa:MessageID>
         <wsa:RelatesTo>http://example.com/someuniquestring</wsa:RelatesTo>
-        <wsa:To env:mustUnderstand="true">http://www.w3.org/2005/08/addressing/anonymous</wsa:To>
+        <wsa:To>http://www.w3.org/2005/08/addressing/anonymous</wsa:To>
         <wsa:Action>urn:faultAction</wsa:Action>
     </env:Header>
     <env:Body>
diff --git a/spring-ws-core/src/test/resources/org/springframework/ws/soap/addressing/10/valid.xml b/spring-ws-core/src/test/resources/org/springframework/ws/soap/addressing/10/valid.xml
@@ -4,7 +4,7 @@
         <wsa:ReplyTo>
             <wsa:Address>http://example.com/business/client1</wsa:Address>
         </wsa:ReplyTo>
-        <wsa:To S:mustUnderstand="true">mailto:fabrikam@example.com</wsa:To>
+        <wsa:To>mailto:fabrikam@example.com</wsa:To>
         <wsa:Action>http://example.com/fabrikam/mail/Delete</wsa:Action>
     </S:Header>
     <S:Body>
diff --git a/spring-ws-core/src/test/resources/org/springframework/ws/soap/addressing/200408/request-without-shouldInitializeTo.xml b/spring-ws-core/src/test/resources/org/springframework/ws/soap/addressing/200408/request-without-shouldInitializeTo.xml
@@ -0,0 +1,16 @@
+<S:Envelope xmlns:S="http://www.w3.org/2003/05/soap-envelope"
+            xmlns:wsa="http://schemas.xmlsoap.org/ws/2004/08/addressing">
+    <S:Header>
+        <wsa:MessageID>http://example.com/someuniquestring</wsa:MessageID>
+        <wsa:ReplyTo>
+            <wsa:Address>http://example.com/business/client1</wsa:Address>
+        </wsa:ReplyTo>
+        <wsa:To>mailto:fabrikam@example.com</wsa:To>
+        <wsa:Action>http://example.com/fabrikam/mail/Delete</wsa:Action>
+    </S:Header>
+    <S:Body>
+        <f:Delete xmlns:f="http://example.com/fabrikam">
+            <f:maxCount>42</f:maxCount>
+        </f:Delete>
+    </S:Body>
+</S:Envelope>
diff --git a/spring-ws-core/src/test/resources/org/springframework/ws/soap/addressing/200408/response-anonymous.xml b/spring-ws-core/src/test/resources/org/springframework/ws/soap/addressing/200408/response-anonymous.xml
@@ -3,7 +3,7 @@
     <env:Header>
         <wsa:MessageID>uid:1234</wsa:MessageID>
         <wsa:RelatesTo>uuid:aaaabbbb-cccc-dddd-eeee-ffffffffffff</wsa:RelatesTo>
-        <wsa:To env:mustUnderstand="true">http://schemas.xmlsoap.org/ws/2004/08/addressing/role/anonymous</wsa:To>
+        <wsa:To>http://schemas.xmlsoap.org/ws/2004/08/addressing/role/anonymous</wsa:To>
         <wsa:Action>urn:replyAction</wsa:Action>
     </env:Header>
     <env:Body/>
diff --git a/spring-ws-core/src/test/resources/org/springframework/ws/soap/addressing/200408/response-fault-to.xml b/spring-ws-core/src/test/resources/org/springframework/ws/soap/addressing/200408/response-fault-to.xml
@@ -3,7 +3,7 @@
     <env:Header>
         <wsa:MessageID>uid:1234</wsa:MessageID>
         <wsa:RelatesTo>uuid:aaaabbbb-cccc-dddd-eeee-ffffffffffff</wsa:RelatesTo>
-        <wsa:To env:mustUnderstand="true">http://schemas.xmlsoap.org/ws/2004/08/addressing/role/anonymous</wsa:To>
+        <wsa:To>http://schemas.xmlsoap.org/ws/2004/08/addressing/role/anonymous</wsa:To>
         <wsa:Action>urn:faultAction</wsa:Action>
     </env:Header>
     <env:Body>
diff --git a/spring-ws-core/src/test/resources/org/springframework/ws/soap/addressing/200408/valid.xml b/spring-ws-core/src/test/resources/org/springframework/ws/soap/addressing/200408/valid.xml
@@ -5,7 +5,7 @@
         <wsa:ReplyTo>
             <wsa:Address>http://example.com/business/client1</wsa:Address>
         </wsa:ReplyTo>
-        <wsa:To S:mustUnderstand="true">mailto:fabrikam@example.com</wsa:To>
+        <wsa:To>mailto:fabrikam@example.com</wsa:To>
         <wsa:Action>http://example.com/fabrikam/mail/Delete</wsa:Action>
     </S:Header>
     <S:Body>

Original file line number	Diff line number	Diff line change
`@@ -197,7 +197,6 @@ public void addAddressingHeaders(SoapMessage message, MessageAddressingPropertie`
`197`	`197`	`if (map.getTo() != null) {`
`198`	`198`	`SoapHeaderElement to = header.addHeaderElement(getToName());`
`199`	`199`	`to.setText(map.getTo().toString());`
`200`		`- to.setMustUnderstand(true);`
`201`	`200`	`}`
`202`	`201`	`// From`
`203`	`202`	`if (map.getFrom() != null) {`
Original file line number	Diff line number	Diff line change
`@@ -30,6 +30,7 @@`
`30`	`30`	`* Microsoft's Web Services Enhancements (WSE) 3.0, and supported by Axis 1 and 2, and XFire.`
`31`	`31`	`*`
`32`	`32`	`* @author Arjen Poutsma`
	`33`	`+ * @author Leandro Quiroga`
`33`	`34`	`* @see <a href="http://www.w3.org/Submission/2004/SUBM-ws-addressing-20040810/">Web Services Addressing, August`
`34`	`35`	`* 2004</a>`
`35`	`36`	`* @since 1.5.0`
`@@ -58,6 +59,11 @@ public boolean hasRequiredProperties(MessageAddressingProperties map) {`
`58`	`59`	`}`
`59`	`60`	`return true;`
`60`	`61`	`}`
	`62`	`+`
	`63`	`+ @Override`
	`64`	`+ public boolean isToHeaderRequired() {`
	`65`	`+ return true;`
	`66`	`+ }`
`61`	`67`
`62`	`68`	`@Override`
`63`	`69`	`protected final URI getAnonymous() {`
Original file line number	Diff line number	Diff line change
`@@ -38,6 +38,7 @@ public abstract class AbstractWsAddressingTestCase {`
`38`	`38`	`@BeforeEach`
`39`	`39`	`public void createMessageFactory() throws Exception {`
`40`	`40`	`messageFactory = MessageFactory.newInstance(SOAPConstants.SOAP_1_2_PROTOCOL);`
	`41`	`+ XMLUnit.setIgnoreWhitespace(true);`
`41`	`42`	`}`
`42`	`43`
`43`	`44`	`protected SaajSoapMessage loadSaajMessage(String fileName) throws SOAPException, IOException {`