Made WebServiceMessageFactory generic

SWS-631 - ResponseCallback -> ResponseCreator

Author: poutsma

core/src/main/java/org/springframework/ws/WebServiceMessageFactory.java

@@ -1,5 +1,5 @@
 /*
- * Copyright 2002-2010 the original author or authors.
+ * Copyright 2005-2010 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.
@@ -29,14 +29,14 @@
  * @see org.springframework.ws.WebServiceMessage
  * @since 1.0.0
  */
-public interface WebServiceMessageFactory {
+public interface WebServiceMessageFactory<T extends WebServiceMessage> {
 
     /**
      * Creates a new, empty <code>WebServiceMessage</code>.
      *
      * @return the empty message
      */
-    WebServiceMessage createWebServiceMessage();
+    T createWebServiceMessage();
 
     /**
      * Reads a {@link WebServiceMessage} from the given input stream.
@@ -48,6 +48,6 @@ public interface WebServiceMessageFactory {
      * @return the created message
      * @throws java.io.IOException if an I/O exception occurs
      */
-    WebServiceMessage createWebServiceMessage(InputStream inputStream) throws IOException;
+    T createWebServiceMessage(InputStream inputStream) throws IOException;
 
 }

core/src/main/java/org/springframework/ws/pox/dom/DomPoxMessageFactory.java

@@ -1,5 +1,5 @@
 /*
- * Copyright 2002-2010 the original author or authors.
+ * Copyright 2005-2010 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.
@@ -37,7 +37,7 @@
  * @see org.springframework.ws.pox.dom.DomPoxMessage
  * @since 1.0.0
  */
-public class DomPoxMessageFactory extends TransformerObjectSupport implements WebServiceMessageFactory {
+public class DomPoxMessageFactory extends TransformerObjectSupport implements WebServiceMessageFactory<DomPoxMessage> {
 
     /** The default content type for the POX messages. */
     public static final String DEFAULT_CONTENT_TYPE = "application/xml";

core/src/main/java/org/springframework/ws/soap/SoapMessageFactory.java

@@ -1,5 +1,5 @@
 /*
- * Copyright 2002-2010 the original author or authors.
+ * Copyright 2005-2010 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.
@@ -16,9 +16,6 @@
 
 package org.springframework.ws.soap;
 
-import java.io.IOException;
-import java.io.InputStream;
-
 import org.springframework.ws.WebServiceMessageFactory;
 
 /**
@@ -30,7 +27,7 @@
  * @author Arjen Poutsma
  * @since 1.0.0
  */
-public interface SoapMessageFactory extends WebServiceMessageFactory {
+public interface SoapMessageFactory<T extends SoapMessage> extends WebServiceMessageFactory<T> {
 
     /**
      * Sets the SOAP Version used by this factory.
@@ -41,24 +38,4 @@ public interface SoapMessageFactory extends WebServiceMessageFactory {
      */
     void setSoapVersion(SoapVersion version);
 
-    /**
-     * Creates a new, empty <code>SoapMessage</code>.
-     *
-     * @return the empty message
-     */
-    SoapMessage createWebServiceMessage();
-
-    /**
-     * Reads a {@link SoapMessage} from the given input stream.
-     * <p/>
-     * If the given stream is an instance of {@link org.springframework.ws.transport.TransportInputStream
-     * TransportInputStream}, the headers will be read from the request.
-     *
-     * @param inputStream the input stream to read the message from
-     * @return the created message
-     * @throws java.io.IOException if an I/O exception occurs
-     */
-    SoapMessage createWebServiceMessage(InputStream inputStream) throws IOException;
-
-
 }

core/src/main/java/org/springframework/ws/soap/axiom/AxiomSoapMessageFactory.java

@@ -1,5 +1,5 @@
 /*
- * Copyright 2002-2010 the original author or authors.
+ * Copyright 2005-2010 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.
@@ -79,7 +79,7 @@
  * @since 1.0.0
  */
 @SuppressWarnings("Since15")
-public class AxiomSoapMessageFactory implements SoapMessageFactory, InitializingBean {
+public class AxiomSoapMessageFactory implements SoapMessageFactory<AxiomSoapMessage>, InitializingBean {
 
     private static final String CHARSET_PARAMETER = "charset";
 

core/src/main/java/org/springframework/ws/soap/saaj/SaajSoapMessageFactory.java

@@ -1,5 +1,5 @@
 /*
- * Copyright 2002-2010 the original author or authors.
+ * Copyright 2005-2010 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.
@@ -55,7 +55,7 @@
  * @see org.springframework.ws.soap.saaj.SaajSoapMessage
  * @since 1.0.0
  */
-public class SaajSoapMessageFactory implements SoapMessageFactory, InitializingBean {
+public class SaajSoapMessageFactory implements SoapMessageFactory<SaajSoapMessage>, InitializingBean {
 
     private static final Log logger = LogFactory.getLog(SaajSoapMessageFactory.class);
 

core/src/test/java/org/springframework/ws/MockWebServiceMessageFactory.java

@@ -1,5 +1,5 @@
 /*
- * Copyright 2006 the original author or authors.
+ * Copyright 2005-2010 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.
@@ -21,13 +21,13 @@
 import javax.xml.transform.TransformerException;
 import javax.xml.transform.stream.StreamSource;
 
-public class MockWebServiceMessageFactory implements WebServiceMessageFactory {
+public class MockWebServiceMessageFactory implements WebServiceMessageFactory<MockWebServiceMessage> {
 
-    public WebServiceMessage createWebServiceMessage() {
+    public MockWebServiceMessage createWebServiceMessage() {
         return new MockWebServiceMessage();
     }
 
-    public WebServiceMessage createWebServiceMessage(InputStream inputStream) throws IOException {
+    public MockWebServiceMessage createWebServiceMessage(InputStream inputStream) throws IOException {
         try {
             return new MockWebServiceMessage(new StreamSource(inputStream));
         }

test/src/main/java/org/springframework/ws/mock/client/AbstractResponseCreator.java

@@ -0,0 +1,54 @@
+/*
+ * Copyright 2005-2010 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.mock.client;
+
+import java.io.IOException;
+import java.net.URI;
+
+import org.springframework.ws.WebServiceMessage;
+import org.springframework.ws.WebServiceMessageFactory;
+import org.springframework.xml.transform.TransformerObjectSupport;
+
+/**
+ * Abstract base class for the {@link ResponseCreator} interface.
+ * <p/>
+ * Creates a response using the given {@link WebServiceMessageFactory}, and passes it on to {@link #doWithResponse(URI,
+ * WebServiceMessage, WebServiceMessage)}.
+ *
+ * @author Arjen Poutsma
+ * @since 2.0
+ */
+abstract class AbstractResponseCreator<T extends WebServiceMessage> extends TransformerObjectSupport
+        implements ResponseCreator<T> {
+
+    public final T createResponse(URI uri, T request, WebServiceMessageFactory<T> messageFactory) throws IOException {
+        T response = messageFactory.createWebServiceMessage();
+        doWithResponse(uri, request, response);
+        return response;
+    }
+
+    /**
+     * Execute any number of operations on the supplied response, given the request and URI.
+     *
+     * @param uri      the URI
+     * @param request  the request message
+     * @param response the response message
+     * @throws IOException in case of I/O errors
+     */
+    protected abstract void doWithResponse(URI uri, T request, T response) throws IOException;
+
+}

test/src/main/java/org/springframework/ws/mock/client/ErrorResponseCallback.java renamed to test/src/main/java/org/springframework/ws/mock/client/ErrorResponseCreator.java

@@ -20,24 +20,28 @@
 import java.net.URI;
 
 import org.springframework.ws.WebServiceMessage;
+import org.springframework.ws.WebServiceMessageFactory;
 
 /**
- * Implementation of {@link ResponseCallback} that holds an error message.
+ * Implementation of {@link ResponseCreator} that holds an error message.
  *
  * @author Arjen Poutsma
  * @author Lukas Krecan
  * @since 2.0
  */
-class ErrorResponseCallback implements ResponseCallback {
+class ErrorResponseCreator implements ResponseCreator<WebServiceMessage> {
 
     private final String errorMessage;
 
-    ErrorResponseCallback(String errorMessage) {
+    ErrorResponseCreator(String errorMessage) {
         this.errorMessage = errorMessage;
     }
 
-    public void doWithResponse(URI uri, WebServiceMessage response, WebServiceMessage request) throws IOException {
+    public WebServiceMessage createResponse(URI uri,
+                                            WebServiceMessage request,
+                                            WebServiceMessageFactory<WebServiceMessage> factory) throws IOException {
         // Do nothing
+        return null;
     }
 
     String getErrorMessage() {

test/src/main/java/org/springframework/ws/mock/client/ExceptionResponseCallback.java renamed to test/src/main/java/org/springframework/ws/mock/client/ExceptionResponseCreator.java

@@ -20,27 +20,30 @@
 import java.net.URI;
 
 import org.springframework.ws.WebServiceMessage;
+import org.springframework.ws.WebServiceMessageFactory;
 
 /**
- * Implementation of {@link ResponseCallback} that responds by throwing either an {@link IOException} or a {@link
+ * Implementation of {@link ResponseCreator} that responds by throwing either an {@link IOException} or a {@link
  * RuntimeException}.
  *
  * @author Arjen Poutsma
  * @since 2.0
  */
-class ExceptionResponseCallback implements ResponseCallback {
+class ExceptionResponseCreator implements ResponseCreator<WebServiceMessage> {
 
     private final Exception exception;
 
-    ExceptionResponseCallback(IOException exception) {
+    ExceptionResponseCreator(IOException exception) {
         this.exception = exception;
     }
 
-    ExceptionResponseCallback(RuntimeException exception) {
+    ExceptionResponseCreator(RuntimeException exception) {
         this.exception = exception;
     }
 
-    public void doWithResponse(URI uri, WebServiceMessage request, WebServiceMessage response) throws IOException {
+    public WebServiceMessage createResponse(URI uri,
+                                            WebServiceMessage request,
+                                            WebServiceMessageFactory<WebServiceMessage> factory) throws IOException {
         if (exception instanceof IOException) {
             throw (IOException) exception;
         }

test/src/main/java/org/springframework/ws/mock/client/MockSenderConnection.java

@@ -44,7 +44,7 @@ class MockSenderConnection implements FaultAwareWebServiceConnection, ResponseAc
 
     private WebServiceMessage request;
 
-    private ResponseCallback responseCallback;
+    private ResponseCreator responseCreator;
 
     void addRequestMatcher(RequestMatcher requestMatcher) {
         Assert.notNull(requestMatcher, "'requestMatcher' must not be null");
@@ -67,13 +67,14 @@ public ResponseActions andExpect(RequestMatcher requestMatcher) {
         return this;
     }
 
-    public void andRespond(ResponseCallback responseCallback) {
-        Assert.notNull(responseCallback, "'responseCallback' must not be null");
-        this.responseCallback = responseCallback;
+    public void andRespond(ResponseCreator responseCreator) {
+        Assert.notNull(responseCreator, "'responseCreator' must not be null");
+        this.responseCreator = responseCreator;
     }
 
     // FaultAwareWebServiceConnection implementation
 
+    @SuppressWarnings("unchecked")
     public void send(WebServiceMessage message) throws IOException {
         if (!requestMatchers.isEmpty()) {
             for (RequestMatcher requestMatcher : requestMatchers) {
@@ -86,11 +87,10 @@ public void send(WebServiceMessage message) throws IOException {
         this.request = message;
     }
 
+    @SuppressWarnings("unchecked")
     public WebServiceMessage receive(WebServiceMessageFactory messageFactory) throws IOException {
-        if (responseCallback != null) {
-            WebServiceMessage response = messageFactory.createWebServiceMessage();
-            responseCallback.doWithResponse(uri, request, response);
-            return response;
+        if (responseCreator != null) {
+            return responseCreator.createResponse(uri, request, messageFactory);
         }
         else {
             return null;
@@ -102,20 +102,20 @@ public URI getUri() {
     }
 
     public boolean hasError() throws IOException {
-        return responseCallback instanceof ErrorResponseCallback;
+        return responseCreator instanceof ErrorResponseCreator;
     }
 
     public String getErrorMessage() throws IOException {
-        if (responseCallback instanceof ErrorResponseCallback) {
-            return ((ErrorResponseCallback) responseCallback).getErrorMessage();
+        if (responseCreator instanceof ErrorResponseCreator) {
+            return ((ErrorResponseCreator) responseCreator).getErrorMessage();
         }
         else {
             return null;
         }
     }
 
     public boolean hasFault() throws IOException {
-        return responseCallback instanceof SoapFaultResponseCallback;
+        return responseCreator instanceof SoapFaultResponseCallback;
     }
 
     public void setFault(boolean fault) throws IOException {
@@ -125,7 +125,7 @@ public void setFault(boolean fault) throws IOException {
     public void close() throws IOException {
         requestMatchers.clear();
         request = null;
-        responseCallback = null;
+        responseCreator = null;
         uri = null;
         if (lastConnection) {
             MockWebServiceMessageSenderHolder.clear();