Fixed #SWS-86: Stream closed before response read with WebServiceTemplate + Axis SAAJ Soap Messages

Author: poutsma

core/src/main/java/org/springframework/ws/client/core/SourceExtractor.java

@@ -0,0 +1,48 @@
+/*
+ * Copyright 2007 the original author or authors.
+ *
+ * Licensed 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.springframework.ws.client.core;
+
+import java.io.IOException;
+import javax.xml.transform.Source;
+
+/**
+ * Callback interface for extracting a result object from a {@link javax.xml.transform.Source} instance.
+ * <p/>
+ * Used for output object creation in {@link WebServiceTemplate}. Alternatively, output sources can also be returned to
+ * client code as-is. In case of a source as execution result, you will almost always want to implement a
+ * <code>SourceExtractor</code>, to be able to read the message content in a managed fashion, with the connection still
+ * open while reading the message.
+ * <p/>
+ * Implementations of this interface perform the actual work of extracting results, but don't need to worry about
+ * exception handling, or resource handling.
+ *
+ * @author Arjen Poutsma
+ * @see org.springframework.ws.client.core.WebServiceTemplate
+ */
+public interface SourceExtractor {
+
+    /**
+     * Process the data in the given <code>Source</code>, creating a corresponding result object.
+     *
+     * @param source the message payload to extract data from
+     * @return an arbitrary result object, or <code>null</code> if none (the extractor will typically be stateful in the
+     *         latter case)
+     * @throws IOException in case of I/O errors
+     */
+    Object extractData(Source source) throws IOException;
+
+}

core/src/main/java/org/springframework/ws/client/core/WebServiceMessageCallback.java

@@ -28,5 +28,11 @@
  */
 public interface WebServiceMessageCallback {
 
+    /**
+     * Gets called by <code>WebServiceTemplate.sendAndReceice</code> with a <code>WebServiceMessage</code>.
+     *
+     * @param message the message
+     * @throws IOException in case of I/O errors
+     */
     void doInMessage(WebServiceMessage message) throws IOException;
 }

core/src/main/java/org/springframework/ws/client/core/WebServiceMessageExtractor.java

@@ -0,0 +1,48 @@
+/*
+ * Copyright 2007 the original author or authors.
+ *
+ * Licensed 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.springframework.ws.client.core;
+
+import java.io.IOException;
+
+import org.springframework.ws.WebServiceMessage;
+
+/**
+ * Callback interface for extracting a result object from a {@link WebServiceMessage} instance.
+ * <p/>
+ * Used for output object creation in {@link WebServiceTemplate}. Alternatively, output messages can also be returned to
+ * client code as-is. In case of a message as execution result, you will almost always want to implement a
+ * <code>WebServiceMessageExtractor</code>, to be able to read the message in a managed fashion, with the connection
+ * still open while reading the message.
+ * <p/>
+ * Implementations of this interface perform the actual work of extracting results, but don't need to worry about
+ * exception handling, or resource handling.
+ *
+ * @author Arjen Poutsma
+ */
+public interface WebServiceMessageExtractor {
+
+    /**
+     * Process the data in the given <code>WebServiceMessage</code>, creating a corresponding result object.
+     *
+     * @param message the message to extract data from (possibly a <code>SoapMessage</code>)
+     * @return an arbitrary result object, or <code>null</code> if none (the extractor will typically be stateful in the
+     *         latter case)
+     * @throws IOException in case of I/O errors
+     */
+    Object extractData(WebServiceMessage message) throws IOException;
+
+}

core/src/main/java/org/springframework/ws/client/core/WebServiceOperations.java

@@ -20,8 +20,6 @@
 import javax.xml.transform.Result;
 import javax.xml.transform.Source;
 
-import org.springframework.ws.WebServiceMessage;
-
 /**
  * Specifies a basic set of Web service operations. Implemented by {@link WebServiceTemplate}. Not often used directly,
  * but a useful option to enhance testability, as it can easily be mocked or stubbed.
@@ -32,77 +30,100 @@
 public interface WebServiceOperations {
 
     /**
-     * Sends a web service message that contains the given payload. Returns the payload of the response message, if
-     * any.
+     * Sends a web service message that contains the given payload, marshalled by the configured
+     * <code>Marshaller</code>. Returns the unmarshalled payload of the response message, if any.
      *
-     * @param requestPayload the payload of the request message
-     * @return the payload of the response message, or <code>null</code> if no response is given
+     * @param requestPayload the object to marshal into the request message payload
+     * @return the unmarshalled payload of the response message, or <code>null</code> if no response is given
+     * @throws IOException in case of I/O errors
+     * @see WebServiceTemplate#setMarshaller(org.springframework.oxm.Marshaller)
+     * @see WebServiceTemplate#setUnmarshaller(org.springframework.oxm.Unmarshaller)
      */
-    Source sendAndReceive(Source requestPayload) throws IOException;
+    Object marshalSendAndReceive(Object requestPayload) throws IOException;
 
     /**
-     * Sends a web service message that contains the given payload. Returns the payload of the response message, if any.
-     * The given callback allows changing of the request message after the payload has been written to it.
+     * Sends a web service message that contains the given payload, marshalled by the configured
+     * <code>Marshaller</code>. Returns the unmarshalled payload of the response message, if any. The given callback
+     * allows changing of the request message after the payload has been marshalled to it.
      *
-     * @param requestPayload  the payload of the request message
+     * @param requestPayload  the object to marshal into the request message payload
      * @param requestCallback callback to change message, can be <code>null</code>
-     * @return the payload of the response message, or <code>null</code> if no response is given
+     * @return the unmarshalled payload of the response message, or <code>null</code> if no response is given
+     * @throws IOException in case of I/O errors
+     * @see WebServiceTemplate#setMarshaller(org.springframework.oxm.Marshaller)
+     * @see WebServiceTemplate#setUnmarshaller(org.springframework.oxm.Unmarshaller)
+     */
+    Object marshalSendAndReceive(Object requestPayload, WebServiceMessageCallback requestCallback) throws IOException;
+
+    /**
+     * Sends a web service message that contains the given payload, reading the result with a
+     * <code>SourceExtractor</code>.
+     *
+     * @param requestPayload    the payload of the request message
+     * @param responseExtractor object that will extract results
+     * @return an arbitrary result object, as returned by the <code>SourceExtractor</code>
+     */
+    Object sendAndReceive(Source requestPayload, SourceExtractor responseExtractor) throws IOException;
+
+    /**
+     * Sends a web service message that contains the given payload, reading the result with a
+     * <code>SourceExtractor</code>.
+     * <p/>
+     * The given callback allows changing of the request message after the payload has been written to it.
+     *
+     * @param requestPayload    the payload of the request message
+     * @param requestCallback   callback to change message, can be <code>null</code>
+     * @param responseExtractor object that will extract results
+     * @return an arbitrary result object, as returned by the <code>SourceExtractor</code>
      */
-    Source sendAndReceive(Source requestPayload, WebServiceMessageCallback requestCallback) throws IOException;
+    Object sendAndReceive(Source requestPayload,
+                          WebServiceMessageCallback requestCallback,
+                          SourceExtractor responseExtractor) throws IOException;
 
     /**
      * Sends a web service message that contains the given payload. Writes the response, if any, to the given
      * <code>Result</code>.
      *
      * @param requestPayload the payload of the request message
      * @param responseResult the result to write the response payload to
-     * @return <code>true</code> if a response was received; <code>false</code> otherwise
+     * @throws IOException in case of I/O errors
      */
-    boolean sendAndReceive(Source requestPayload, Result responseResult) throws IOException;
+    void sendAndReceive(Source requestPayload, Result responseResult) throws IOException;
 
     /**
      * Sends a web service message that contains the given payload. Writes the response, if any, to the given
-     * <code>Result</code>. The given callback allows changing of the request message after the payload has been written
-     * to it.
+     * <code>Result</code>.
+     * <p/>
+     * The given callback allows changing of the request message after the payload has been written to it.
      *
      * @param requestPayload  the payload of the request message
      * @param requestCallback callback to change message, can be <code>null</code>
      * @param responseResult  the result to write the response payload to
-     * @return <code>true</code> if a response was received; <code>false</code> otherwise
+     * @throws IOException in case of I/O errors
      */
-    boolean sendAndReceive(Source requestPayload, WebServiceMessageCallback requestCallback, Result responseResult)
+    void sendAndReceive(Source requestPayload, WebServiceMessageCallback requestCallback, Result responseResult)
             throws IOException;
 
     /**
-     * Sends a web service message that contains the given payload, marshalled by the configured
-     * <code>Marshaller</code>. Returns the unmarshalled payload of the response message, if any.
-     *
-     * @param requestPayload the object to marshal into the request message payload
-     * @return the unmarshalled payload of the response message, or <code>null</code> if no response is given
-     * @see org.springframework.ws.client.core.WebServiceTemplate#setMarshaller(org.springframework.oxm.Marshaller)
-     * @see org.springframework.ws.client.core.WebServiceTemplate#setUnmarshaller(org.springframework.oxm.Unmarshaller)
-     */
-    Object marshalSendAndReceive(Object requestPayload) throws IOException;
-
-    /**
-     * Sends a web service message that contains the given payload, marshalled by the configured
-     * <code>Marshaller</code>. Returns the unmarshalled payload of the response message, if any. The given callback
-     * allows changing of the request message after the payload has been marshalled to it.
+     * Sends a web service message that can be manipulated with the given callback, reading the result with a
+     * <code>WebServiceMessageExtractor</code>.
      *
-     * @param requestPayload  the object to marshal into the request message payload
-     * @param requestCallback callback to change message, can be <code>null</code>
-     * @return the unmarshalled payload of the response message, or <code>null</code> if no response is given
-     * @see org.springframework.ws.client.core.WebServiceTemplate#setMarshaller(org.springframework.oxm.Marshaller)
-     * @see org.springframework.ws.client.core.WebServiceTemplate#setUnmarshaller(org.springframework.oxm.Unmarshaller)
+     * @param requestCallback   the requestCallback to be used for manipulating the request message
+     * @param responseExtractor object that will extract results
+     * @return an arbitrary result object, as returned by the <code>WebServiceMessageExtractor</code>
+     * @throws IOException in case of I/O errors
      */
-    Object marshalSendAndReceive(Object requestPayload, WebServiceMessageCallback requestCallback) throws IOException;
+    Object sendAndReceive(WebServiceMessageCallback requestCallback, WebServiceMessageExtractor responseExtractor)
+            throws IOException;
 
     /**
-     * Sends a web service message that can be manipulated with the given callback. Returns the response message, if
-     * any.
+     * Sends a web service message that can be manipulated with the given callback, reading the result with a
+     * <code>WebServiceMessageExtractor</code>.
      *
-     * @param requestCallback the requestCallback to be used for manipulating the request message
-     * @return the response message, or <code>null</code> if no response is given
+     * @param requestCallback  the callback to be used for manipulating the request message
+     * @param responseCallback the callback to be used for manipulating the response message
+     * @throws IOException in case of I/O errors
      */
-    WebServiceMessage sendAndReceive(WebServiceMessageCallback requestCallback) throws IOException;
+    void sendAndReceive(WebServiceMessageCallback requestCallback, WebServiceMessageCallback responseCallback)
+            throws IOException;
 }