SWS-277

Author: poutsma

core/src/main/java/org/springframework/ws/server/endpoint/mapping/UriEndpointMapping.java

@@ -0,0 +1,72 @@
+/*
+ * Copyright 2008 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.server.endpoint.mapping;
+
+import java.net.URI;
+import java.net.URISyntaxException;
+
+import org.springframework.ws.context.MessageContext;
+import org.springframework.ws.soap.axiom.AxiomSoapMessageFactory;
+import org.springframework.ws.transport.WebServiceConnection;
+import org.springframework.ws.transport.context.TransportContext;
+import org.springframework.ws.transport.context.TransportContextHolder;
+
+/**
+ * Implementation of the <code>EndpointMapping</code> interface to map from the full request URI to endpoint beans.
+ * Supports both mapping to bean instances and mapping to bean names: the latter is required for prototype handlers.
+ * <p/>
+ * The <code>endpointMap</code> property is suitable for populating the endpoint map with bean references, e.g. via the
+ * map element in XML bean definitions.
+ * <p/>
+ * Mappings to bean names can be set via the <code>mappings</code> property, in a form accepted by the
+ * <code>java.util.Properties</code> class, like as follows:
+ * <pre>
+ * http://example.com:8080/services/bookFlight=bookFlightEndpoint
+ * jms://exampleQueue=getFlightsEndpoint
+ * </pre>
+ * The syntax is SOAP_ACTION=ENDPOINT_BEAN_NAME.
+ * <p/>
+ * This endpoint mapping does not read from the request message, and therefore is more suitable for message factories
+ * which directly read from the transport request (such as the {@link AxiomSoapMessageFactory} with the
+ * <code>payloadCaching</code> disabled). However, this endpoint mapping obviously is transport specific.
+ *
+ * @author Arjen Poutsma
+ * @since 1.5.0
+ */
+public class UriEndpointMapping extends AbstractMapBasedEndpointMapping {
+
+    protected boolean validateLookupKey(String key) {
+        try {
+            new URI(key);
+            return true;
+        }
+        catch (URISyntaxException e) {
+            return false;
+        }
+    }
+
+    protected String getLookupKeyForMessage(MessageContext messageContext) throws Exception {
+        TransportContext transportContext = TransportContextHolder.getTransportContext();
+        if (transportContext != null) {
+            WebServiceConnection connection = transportContext.getConnection();
+            if (connection != null) {
+                return connection.getUri().toString();
+            }
+        }
+        return null;
+    }
+}

core/src/main/java/org/springframework/ws/transport/WebServiceConnection.java

@@ -18,6 +18,7 @@
 
 import java.io.IOException;
 import java.net.URI;
+import java.net.URISyntaxException;
 
 import org.springframework.ws.WebServiceMessage;
 import org.springframework.ws.WebServiceMessageFactory;
@@ -52,6 +53,9 @@ public interface WebServiceConnection {
      */
     WebServiceMessage receive(WebServiceMessageFactory messageFactory) throws IOException;
 
+    /** Returns the URI for this connection. */
+    URI getUri() throws URISyntaxException;
+
     /**
      * Indicates whether this connection has an error. Typically, error detection is done by inspecting connection error
      * codes, etc.

core/src/main/java/org/springframework/ws/transport/http/CommonsHttpConnection.java

@@ -20,11 +20,14 @@
 import java.io.IOException;
 import java.io.InputStream;
 import java.io.OutputStream;
+import java.net.URI;
+import java.net.URISyntaxException;
 import java.util.Arrays;
 import java.util.Iterator;
 
 import org.apache.commons.httpclient.Header;
 import org.apache.commons.httpclient.HttpClient;
+import org.apache.commons.httpclient.URIException;
 import org.apache.commons.httpclient.methods.ByteArrayRequestEntity;
 import org.apache.commons.httpclient.methods.PostMethod;
 
@@ -63,6 +66,18 @@ public void onClose() throws IOException {
     }
 
     /*
+     * URI
+     */
+
+    public URI getUri() throws URISyntaxException {
+        try {
+            return new URI(postMethod.getURI().toString());
+        }
+        catch (URIException ex) {
+            throw new URISyntaxException("", ex.getMessage());
+        }
+    }
+/*
      * Sending request
      */
 

core/src/main/java/org/springframework/ws/transport/http/HttpServletConnection.java

@@ -19,6 +19,8 @@
 import java.io.IOException;
 import java.io.InputStream;
 import java.io.OutputStream;
+import java.net.URI;
+import java.net.URISyntaxException;
 import java.util.Iterator;
 import javax.servlet.http.HttpServletRequest;
 import javax.servlet.http.HttpServletResponse;
@@ -82,9 +84,19 @@ public String getErrorMessage() throws IOException {
     }
 
     /*
-     * Receiving request
+     * URI
      */
 
+    public URI getUri() throws URISyntaxException {
+        return new URI(httpServletRequest.getScheme(), null, httpServletRequest.getServerName(),
+                httpServletRequest.getServerPort(), httpServletRequest.getRequestURI(),
+                httpServletRequest.getQueryString(), null);
+    }
+
+    /*
+    * Receiving request
+    */
+
     protected Iterator getRequestHeaderNames() throws IOException {
         return new EnumerationIterator(getHttpServletRequest().getHeaderNames());
     }

core/src/main/java/org/springframework/ws/transport/http/HttpUrlConnection.java

@@ -20,6 +20,8 @@
 import java.io.InputStream;
 import java.io.OutputStream;
 import java.net.HttpURLConnection;
+import java.net.URI;
+import java.net.URISyntaxException;
 import java.util.ArrayList;
 import java.util.Collections;
 import java.util.Iterator;
@@ -59,6 +61,14 @@ public void onClose() {
         connection.disconnect();
     }
 
+    /*
+     * URI
+     */
+
+    public URI getUri() throws URISyntaxException {
+        return connection.getURL().toURI();
+    }
+
     /*
      * Sending request
      */

core/src/main/java/org/springframework/ws/transport/support/WebServiceMessageReceiverObjectSupport.java

@@ -16,6 +16,8 @@
 
 package org.springframework.ws.transport.support;
 
+import java.net.URISyntaxException;
+
 import org.apache.commons.logging.Log;
 import org.apache.commons.logging.LogFactory;
 
@@ -76,6 +78,7 @@ public void afterPropertiesSet() throws Exception {
      */
     protected final void handleConnection(WebServiceConnection connection, WebServiceMessageReceiver receiver)
             throws Exception {
+        logUri(connection);
         TransportContext previousTransportContext = TransportContextHolder.getTransportContext();
         TransportContextHolder.setTransportContext(new DefaultTransportContext(connection));
 
@@ -105,4 +108,15 @@ protected final void handleConnection(WebServiceConnection connection, WebServic
         }
     }
 
+    private void logUri(WebServiceConnection connection) {
+        if (logger.isDebugEnabled()) {
+            try {
+                logger.debug("Regestering incoming connection [" + connection.getUri() + "]");
+            }
+            catch (URISyntaxException e) {
+                // ignore
+            }
+        }
+    }
+
 }

core/src/test/java/org/springframework/ws/client/core/WebServiceTemplateTest.java

@@ -52,6 +52,7 @@ protected void setUp() throws Exception {
         template.setMessageFactory(messageFactory);
         connectionControl = MockControl.createStrictControl(FaultAwareWebServiceConnection.class);
         connectionMock = (FaultAwareWebServiceConnection) connectionControl.getMock();
+        connectionControl.expectAndDefaultReturn(connectionMock.getUri(), new URI("mock"));
         final URI expectedUri = new URI("http://www.springframework.org/spring-ws");
         template.setMessageSender(new WebServiceMessageSender() {
 

core/src/test/java/org/springframework/ws/server/endpoint/mapping/UriEndpointMappingTest.java

@@ -0,0 +1,61 @@
+/*
+ * Copyright ${YEAR} 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.server.endpoint.mapping;
+
+import java.net.URI;
+
+import junit.framework.TestCase;
+import org.easymock.MockControl;
+
+import org.springframework.ws.MockWebServiceMessageFactory;
+import org.springframework.ws.context.DefaultMessageContext;
+import org.springframework.ws.context.MessageContext;
+import org.springframework.ws.transport.WebServiceConnection;
+import org.springframework.ws.transport.context.DefaultTransportContext;
+import org.springframework.ws.transport.context.TransportContextHolder;
+
+public class UriEndpointMappingTest extends TestCase {
+
+    private UriEndpointMapping mapping;
+
+    private MessageContext context;
+
+    protected void setUp() throws Exception {
+        mapping = new UriEndpointMapping();
+        context = new DefaultMessageContext(new MockWebServiceMessageFactory());
+    }
+
+    public void testGetLookupKeyForMessage() throws Exception {
+        MockControl control = MockControl.createControl(WebServiceConnection.class);
+        WebServiceConnection connectionMock = (WebServiceConnection) control.getMock();
+        TransportContextHolder.setTransportContext(new DefaultTransportContext(connectionMock));
+
+        URI uri = new URI("jms://exampleQueue");
+        control.expectAndReturn(connectionMock.getUri(), uri);
+        control.replay();
+
+        assertEquals("Invalid lookup key", uri.toString(), mapping.getLookupKeyForMessage(context));
+
+        control.verify();
+        TransportContextHolder.setTransportContext(null);
+    }
+
+    public void testValidateLookupKey() throws Exception {
+        assertTrue("URI not valid", mapping.validateLookupKey("http://example.com/services"));
+        assertFalse("URI not valid", mapping.validateLookupKey("some string"));
+    }
+}

core/src/test/java/org/springframework/ws/transport/support/WebServiceMessageReceiverObjectSupportTest.java

@@ -16,8 +16,11 @@
 
 package org.springframework.ws.transport.support;
 
+import java.net.URI;
+
 import junit.framework.TestCase;
 import org.easymock.MockControl;
+
 import org.springframework.ws.MockWebServiceMessage;
 import org.springframework.ws.MockWebServiceMessageFactory;
 import org.springframework.ws.context.MessageContext;
@@ -46,6 +49,7 @@ protected void setUp() throws Exception {
     }
 
     public void testHandleConnectionResponse() throws Exception {
+        connectionControl.expectAndReturn(connectionMock.getUri(), new URI("http://example.com"));
         connectionControl.expectAndReturn(connectionMock.receive(messageFactory), request);
         connectionMock.send(new MockWebServiceMessage());
         connectionControl.setMatcher(MockControl.ALWAYS_MATCHER);
@@ -67,6 +71,7 @@ public void receive(MessageContext messageContext) throws Exception {
     }
 
     public void testHandleConnectionNoResponse() throws Exception {
+        connectionControl.expectAndReturn(connectionMock.getUri(), new URI("http://example.com"));
         connectionControl.expectAndReturn(connectionMock.receive(messageFactory), request);
         connectionMock.close();
 

support/src/main/java/org/springframework/ws/transport/jms/JmsReceiverConnection.java

@@ -21,6 +21,8 @@
 import java.io.IOException;
 import java.io.InputStream;
 import java.io.OutputStream;
+import java.net.URI;
+import java.net.URISyntaxException;
 import java.util.Iterator;
 import javax.jms.BytesMessage;
 import javax.jms.JMSException;
@@ -98,6 +100,19 @@ public Message getResponseMessage() {
         return responseMessage;
     }
 
+    /*
+     * URI
+     */
+
+    public URI getUri() throws URISyntaxException {
+        try {
+            return JmsTransportUtils.toUri(requestMessage.getJMSDestination());
+        }
+        catch (JMSException ex) {
+            throw new URISyntaxException("", ex.getMessage());
+        }
+    }
+
     /*
      * Errors
      */

support/src/main/java/org/springframework/ws/transport/jms/JmsSenderConnection.java

@@ -21,6 +21,8 @@
 import java.io.IOException;
 import java.io.InputStream;
 import java.io.OutputStream;
+import java.net.URI;
+import java.net.URISyntaxException;
 import java.util.Iterator;
 import javax.jms.BytesMessage;
 import javax.jms.Connection;
@@ -136,6 +138,19 @@ void setMessageType(int messageType) {
         this.messageType = messageType;
     }
 
+    /*
+     * URI
+     */
+
+    public URI getUri() throws URISyntaxException {
+        try {
+            return JmsTransportUtils.toUri(requestDestination);
+        }
+        catch (JMSException ex) {
+            throw new URISyntaxException("", ex.getMessage());
+        }
+    }
+
     /*
      * Errors
      */