SWS-708 - PayloadValidatingInterceptor errors not clearing SecurityContextHolder, backported to 1.5 branch

Author: poutsma

core/src/main/java/org/springframework/ws/server/EndpointInterceptor.java

@@ -1,11 +1,11 @@
 /*
- * Copyright 2005 the original author or authors.
+ * Copyright 2005-2011 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
+ *     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,
@@ -96,4 +96,6 @@ public interface EndpointInterceptor {
      *         blocking of the response handler chain.
      */
     boolean handleFault(MessageContext messageContext, Object endpoint) throws Exception;
+
+    void afterCompletion(MessageContext messageContext, Object endpoint, Exception ex);
 }

core/src/main/java/org/springframework/ws/server/MessageDispatcher.java

@@ -1,11 +1,11 @@
 /*
- * Copyright 2002-2009 the original author or authors.
+ * Copyright 2005-2011 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
+ *     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,
@@ -24,9 +24,6 @@
 import java.util.List;
 import java.util.Map;
 
-import org.apache.commons.logging.Log;
-import org.apache.commons.logging.LogFactory;
-
 import org.springframework.beans.BeansException;
 import org.springframework.beans.factory.BeanFactoryUtils;
 import org.springframework.beans.factory.BeanNameAware;
@@ -45,27 +42,35 @@
 import org.springframework.ws.server.endpoint.MessageEndpoint;
 import org.springframework.ws.server.endpoint.PayloadEndpoint;
 import org.springframework.ws.server.endpoint.adapter.MessageEndpointAdapter;
-import org.springframework.ws.server.endpoint.adapter.MessageMethodEndpointAdapter;
 import org.springframework.ws.server.endpoint.adapter.PayloadEndpointAdapter;
-import org.springframework.ws.server.endpoint.adapter.PayloadMethodEndpointAdapter;
 import org.springframework.ws.soap.server.SoapMessageDispatcher;
 import org.springframework.ws.support.DefaultStrategiesHelper;
 import org.springframework.ws.transport.WebServiceMessageReceiver;
 
+import org.apache.commons.logging.Log;
+import org.apache.commons.logging.LogFactory;
+
 /**
  * Central dispatcher for use within Spring-WS, dispatching Web service messages to registered endpoints.
  * <p/>
  * This dispatcher is quite similar to Spring MVCs {@link DispatcherServlet}. Just like its counterpart, this dispatcher
  * is very flexible. This class is SOAP agnostic; in typical SOAP Web Services, the {@link SoapMessageDispatcher}
- * subclass is used. <ul> <li>It can use any {@link EndpointMapping} implementation - whether standard, or provided as
+ * subclass is used.
+ * <ul>
+ * <li>It can use any {@link EndpointMapping} implementation - whether standard, or provided as
  * part of an application - to control the routing of request messages to endpoint objects. Endpoint mappings can be
- * registered using the <code>endpointMappings</code> property.</li> <li>It can use any {@link EndpointAdapter}; this
- * allows one to use any endpoint interface or form. Defaults to the {@link MessageEndpointAdapter} and {@link
- * PayloadEndpointAdapter}, for {@link MessageEndpoint} and {@link PayloadEndpoint}, respectively, and the {@link
- * MessageMethodEndpointAdapter} and {@link PayloadMethodEndpointAdapter}. Additional endpoint adapters can be added
- * through the <code>endpointAdapters</code> property.</li> <li>Its exception resolution strategy can be specified via a
+ * registered using the {@link #setEndpointMappings(List) endpointMappings} property.</li>
+ * <li>It can use any {@link EndpointAdapter}; this allows one to use any endpoint interface or form. Defaults to
+ * the {@link MessageEndpointAdapter} and {@link PayloadEndpointAdapter}, for {@link MessageEndpoint} and
+ * {@link PayloadEndpoint}, respectively, and the
+ * {@link org.springframework.ws.server.endpoint.adapter.MessageMethodEndpointAdapter MessageMethodEndpointAdapter} and
+ * {@link org.springframework.ws.server.endpoint.adapter.PayloadMethodEndpointAdapter PayloadMethodEndpointAdapter}.
+ * Additional endpoint adapters can be added through the {@link #setEndpointAdapters(List) endpointAdapters} property.</li>
+ * <li>Its exception resolution strategy can be specified via a
  * {@link EndpointExceptionResolver}, for example mapping certain exceptions to SOAP Faults. Default is none. Additional
- * exception resolvers can be added through the <code>endpointExceptionResolvers</code> property.</li> </ul>
+ * exception resolvers can be added through the {@link #setEndpointExceptionResolvers(List) endpointExceptionResolvers}
+ * property.</li>
+ * </ul>
  *
  * @author Arjen Poutsma
  * @see EndpointMapping
@@ -221,6 +226,7 @@ protected final void dispatch(MessageContext messageContext) throws Exception {
                     interceptorIndex = i;
                     if (!interceptor.handleRequest(messageContext, mappedEndpoint.getEndpoint())) {
                         triggerHandleResponse(mappedEndpoint, interceptorIndex, messageContext);
+                        triggerAfterCompletion(mappedEndpoint, interceptorIndex, messageContext, null);
                         return;
                     }
                 }
@@ -231,6 +237,7 @@ protected final void dispatch(MessageContext messageContext) throws Exception {
 
             // Apply handleResponse methods of registered interceptors
             triggerHandleResponse(mappedEndpoint, interceptorIndex, messageContext);
+            triggerAfterCompletion(mappedEndpoint, interceptorIndex, messageContext, null);
         }
         catch (NoEndpointFoundException ex) {
             // No triggering of interceptors if no endpoint is found
@@ -243,6 +250,7 @@ protected final void dispatch(MessageContext messageContext) throws Exception {
             Object endpoint = mappedEndpoint != null ? mappedEndpoint.getEndpoint() : null;
             processEndpointException(messageContext, endpoint, ex);
             triggerHandleResponse(mappedEndpoint, interceptorIndex, messageContext);
+            triggerAfterCompletion(mappedEndpoint, interceptorIndex, messageContext, ex);
         }
     }
 
@@ -363,7 +371,41 @@ private void triggerHandleResponse(EndpointInvocationChain mappedEndpoint,
     }
 
     /**
-     * Initialize the <code>EndpointAdapters</code> used by this class. If no adapter beans are explictely set by using
+     * Trigger afterCompletion callbacks on the mapped EndpointInterceptors.
+     * Will just invoke afterCompletion for all interceptors whose handleRequest invocation
+     * has successfully completed and returned true, in addition to the last interceptor who
+     * returned <code>false</code>.
+     * 
+     * @param mappedEndpoint   the mapped EndpointInvocationChain
+     * @param interceptorIndex index of last interceptor that successfully completed
+     * @param ex Exception thrown on handler execution, or <code>null</code> if none
+     * @see EndpointInterceptor#afterCompletion
+     */
+    private void triggerAfterCompletion(EndpointInvocationChain mappedEndpoint,
+            int interceptorIndex,
+            MessageContext messageContext,
+            Exception ex) throws Exception {
+
+        // Apply afterCompletion methods of registered interceptors.
+        if (mappedEndpoint != null) {
+            EndpointInterceptor[] interceptors = mappedEndpoint.getInterceptors();
+            if (interceptors != null) {
+                for (int i = interceptorIndex; i >= 0; i--) {
+                    EndpointInterceptor interceptor = interceptors[i];
+                    try {
+                        interceptor.afterCompletion(messageContext, mappedEndpoint.getEndpoint(), ex);
+                    }
+                    catch (Throwable ex2) {
+                        logger.error("EndpointInterceptor.afterCompletion threw exception", ex2);
+                    }
+                }
+            }
+        }
+    }
+
+
+    /**
+     * Initialize the <code>EndpointAdapters</code> used by this class. If no adapter beans are explicitly set by using
      * the <code>endpointAdapters</code> property, we use the default strategies.
      *
      * @see #setEndpointAdapters(java.util.List)

core/src/main/java/org/springframework/ws/server/endpoint/AbstractLoggingInterceptor.java

@@ -1,11 +1,11 @@
 /*
- * Copyright 2006 the original author or authors.
+ * Copyright 2005-2011 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
+ *     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,
@@ -24,14 +24,14 @@
 import javax.xml.transform.TransformerException;
 import javax.xml.transform.stream.StreamResult;
 
-import org.apache.commons.logging.Log;
-import org.apache.commons.logging.LogFactory;
-
 import org.springframework.ws.WebServiceMessage;
 import org.springframework.ws.context.MessageContext;
 import org.springframework.ws.server.EndpointInterceptor;
 import org.springframework.xml.transform.TransformerObjectSupport;
 
+import org.apache.commons.logging.Log;
+import org.apache.commons.logging.LogFactory;
+
 /**
  * Abstract base class for <code>EndpointInterceptor</code> instances that log a part of a
  * <code>WebServiceMessage</code>. By default, both request and response messages are logged, but this behaviour can be
@@ -77,7 +77,7 @@ public void setLoggerName(String loggerName) {
     }
 
     /**
-     * Logs the request message payload. Logging only ocurs if <code>logRequest</code> is set to <code>true</code>,
+     * Logs the request message payload. Logging only occurs if <code>logRequest</code> is set to <code>true</code>,
      * which is the default.
      *
      * @param messageContext the message context
@@ -92,7 +92,7 @@ public final boolean handleRequest(MessageContext messageContext, Object endpoin
     }
 
     /**
-     * Logs the response message payload. Logging only ocurs if <code>logResponse</code> is set to <code>true</code>,
+     * Logs the response message payload. Logging only occurs if <code>logResponse</code> is set to <code>true</code>,
      * which is the default.
      *
      * @param messageContext the message context
@@ -111,6 +111,10 @@ public boolean handleFault(MessageContext messageContext, Object endpoint) throw
         return true;
     }
 
+    /** Does nothing by default*/
+    public void afterCompletion(MessageContext messageContext, Object endpoint, Exception ex) {
+    }
+
     /**
      * Determine whether the {@link #logger} field is enabled.
      * <p/>
@@ -152,7 +156,7 @@ protected void logMessageSource(String logMessage, Source source) throws Transfo
      * Logs the given string message.
      * <p/>
      * By default, this method uses a "debug" level of logging. Subclasses can override this method to change the level
-     * of loging used by the logger.
+     * of logging used by the logger.
      *
      * @param message the message
      */

core/src/main/java/org/springframework/ws/server/endpoint/interceptor/AbstractValidatingInterceptor.java

@@ -20,9 +20,6 @@
 import javax.xml.transform.Source;
 import javax.xml.transform.TransformerException;
 
-import org.xml.sax.SAXException;
-import org.xml.sax.SAXParseException;
-
 import org.springframework.beans.factory.InitializingBean;
 import org.springframework.core.io.Resource;
 import org.springframework.util.Assert;
@@ -39,6 +36,9 @@
 import org.springframework.xml.xsd.XsdSchema;
 import org.springframework.xml.xsd.XsdSchemaCollection;
 
+import org.xml.sax.SAXException;
+import org.xml.sax.SAXParseException;
+
 /**
  * Abstract base class for <code>EndpointInterceptor</code> implementations that validate part of the message using a
  * schema. The exact message part is determined by the <code>getValidationRequestSource</code> and
@@ -245,6 +245,10 @@ public boolean handleFault(MessageContext messageContext, Object endpoint) throw
         return true;
     }
 
+    /** Does nothing by default.*/
+    public void afterCompletion(MessageContext messageContext, Object endpoint, Exception ex) {
+    }
+
     /**
      * Abstract template method that returns the part of the request message that is to be validated.
      *

core/src/main/java/org/springframework/ws/server/endpoint/interceptor/EndpointInterceptorAdapter.java

@@ -1,11 +1,11 @@
 /*
- * Copyright 2005 the original author or authors.
+ * Copyright 2005-2011 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
+ *     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,
@@ -16,10 +16,11 @@
 
 package org.springframework.ws.server.endpoint.interceptor;
 
-import org.apache.commons.logging.Log;
-import org.apache.commons.logging.LogFactory;
 import org.springframework.ws.context.MessageContext;
 import org.springframework.ws.server.EndpointInterceptor;
+
+import org.apache.commons.logging.Log;
+import org.apache.commons.logging.LogFactory;
 import org.w3c.dom.Element;
 
 /**
@@ -65,4 +66,10 @@ public boolean handleResponse(MessageContext messageContext, Object endpoint) th
     public boolean handleFault(MessageContext messageContext, Object endpoint) {
         return true;
     }
+
+    /**
+     * Does nothing by default.
+     */
+    public void afterCompletion(MessageContext messageContext, Object endpoint, Exception ex) {
+    }
 }

core/src/main/java/org/springframework/ws/server/endpoint/interceptor/PayloadTransformingInterceptor.java

@@ -1,11 +1,11 @@
 /*
- * Copyright 2006 the original author or authors.
+ * Copyright 2005-2011 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
+ *     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,
@@ -26,11 +26,6 @@
 import javax.xml.transform.stream.StreamResult;
 import javax.xml.transform.stream.StreamSource;
 
-import org.apache.commons.logging.Log;
-import org.apache.commons.logging.LogFactory;
-import org.xml.sax.XMLReader;
-import org.xml.sax.helpers.XMLReaderFactory;
-
 import org.springframework.beans.factory.InitializingBean;
 import org.springframework.core.io.Resource;
 import org.springframework.util.Assert;
@@ -40,6 +35,11 @@
 import org.springframework.xml.transform.ResourceSource;
 import org.springframework.xml.transform.TransformerObjectSupport;
 
+import org.apache.commons.logging.Log;
+import org.apache.commons.logging.LogFactory;
+import org.xml.sax.XMLReader;
+import org.xml.sax.helpers.XMLReaderFactory;
+
 /**
  * Interceptor that transforms the payload of <code>WebServiceMessage</code>s using XSLT stylesheet. Allows for seperate
  * stylesheets for request and response. This interceptor is especially useful when supporting with multiple version of
@@ -125,6 +125,10 @@ public boolean handleFault(MessageContext messageContext, Object endpoint) throw
         return true;
     }
 
+    /** Does nothing by default.*/
+    public void afterCompletion(MessageContext messageContext, Object endpoint, Exception ex) {
+    }
+
     public void afterPropertiesSet() throws Exception {
         if (requestXslt == null && responseXslt == null) {
             throw new IllegalArgumentException("Setting either 'requestXslt' or 'responseXslt' is required");

core/src/main/java/org/springframework/ws/soap/addressing/server/AddressingEndpointInterceptor.java

@@ -1,11 +1,11 @@
 /*
- * Copyright 2007 the original author or authors.
+ * Copyright 2005-2011 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
+ *     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,
@@ -19,9 +19,6 @@
 import java.io.IOException;
 import java.net.URI;
 
-import org.apache.commons.logging.Log;
-import org.apache.commons.logging.LogFactory;
-
 import org.springframework.util.Assert;
 import org.springframework.ws.context.MessageContext;
 import org.springframework.ws.soap.SoapHeaderElement;
@@ -34,6 +31,9 @@
 import org.springframework.ws.transport.WebServiceConnection;
 import org.springframework.ws.transport.WebServiceMessageSender;
 
+import org.apache.commons.logging.Log;
+import org.apache.commons.logging.LogFactory;
+
 /**
  * {@link SoapEndpointInterceptor} implementation that deals with WS-Addressing headers. Stateful, and instatiated by
  * the {@link AbstractAddressingEndpointMapping}.
@@ -178,6 +178,9 @@ private URI getMessageId(SoapMessage response) {
         return responseMessageId;
     }
 
+    public void afterCompletion(MessageContext messageContext, Object endpoint, Exception ex) {
+    }
+
     public boolean understands(SoapHeaderElement header) {
         return version.understands(header);
     }