SWS-642 - Support resolving SOAP header elements in @Endpoint method parameters

core/src/test/java/org/springframework/ws/soap/server/endpoint/adapter/method/SoapHeaderElementMethodArgumentResolverTest.java

@@ -0,0 +1,142 @@
+/*
+ * 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.soap.server.endpoint.adapter.method;
+
+import org.junit.Before;
+import org.junit.Test;
+import org.springframework.core.MethodParameter;
+import org.springframework.ws.context.MessageContext;
+import org.springframework.ws.server.endpoint.adapter.method.AbstractMethodArgumentResolverTestCase;
+import org.springframework.ws.soap.SoapHeaderElement;
+import org.springframework.ws.soap.SoapMessage;
+import org.springframework.ws.soap.server.endpoint.annotation.SoapHeader;
+
+import javax.xml.namespace.QName;
+import java.util.List;
+
+import static org.junit.Assert.*;
+
+/**
+ * @author Tareq Abedrabbo
+ */
+public class SoapHeaderElementMethodArgumentResolverTest extends AbstractMethodArgumentResolverTestCase {
+
+    private static final QName HEADER_QNAME = new QName(NAMESPACE_URI, "header");
+
+    private static final String HEADER_CONTENT = "content";
+
+    private SoapHeaderElementMethodArgumentResolver resolver;
+
+    private MessageContext messageContext;
+
+    private MethodParameter soapHeaderWithEmptyValue;
+
+    private MethodParameter soapHeaderElementParameter;
+
+    private MethodParameter soapHeaderElementListParameter;
+
+    private MethodParameter soapHeaderMismatch;
+
+    private MethodParameter soapHeaderMismatchList;
+
+    @Before
+    public void setUp() throws Exception {
+        resolver = new SoapHeaderElementMethodArgumentResolver();
+        messageContext = createSaajMessageContext();
+        SoapMessage message = (SoapMessage) messageContext.getRequest();
+        for (int i = 0; i < 3; i++) {
+            SoapHeaderElement element = message.getSoapHeader().addHeaderElement(HEADER_QNAME);
+            element.setText(HEADER_CONTENT + i);
+        }
+        soapHeaderWithEmptyValue = new MethodParameter(getClass().getMethod("soapHeaderWithEmptyValue", SoapHeaderElement.class), 0);
+        soapHeaderElementParameter = new MethodParameter(getClass().getMethod("soapHeaderElement", SoapHeaderElement.class), 0);
+        soapHeaderElementListParameter = new MethodParameter(getClass().getMethod("soapHeaderElementList", List.class), 0);
+        soapHeaderMismatch = new MethodParameter(getClass().getMethod("soapHeaderMismatch", SoapHeaderElement.class), 0);
+        soapHeaderMismatchList = new MethodParameter(getClass().getMethod("soapHeaderMismatchList", List.class), 0);
+    }
+
+    @Test
+    public void supportsParameter() throws Exception {
+        assertTrue("resolver does not support soapHeaderElement", resolver.supportsParameter(soapHeaderElementParameter));
+        assertTrue("resolver does not support List<soapHeaderElement>", resolver.supportsParameter(soapHeaderElementListParameter));
+    }
+
+    @Test(expected = IllegalArgumentException.class)
+    public void failOnEmptyValue() throws Exception {
+        resolver.resolveArgument(messageContext, soapHeaderWithEmptyValue);
+    }
+
+    @Test
+    public void resolveSoapHeaderElement() throws Exception {
+        Object result = resolver.resolveArgument(messageContext, soapHeaderElementParameter);
+
+        assertTrue("result must be a SoapHeaderElement", SoapHeaderElement.class.isAssignableFrom(result.getClass()));
+
+        SoapHeaderElement element = (SoapHeaderElement) result;
+
+        assertTrue("headers must be equal", element.getName().equals(HEADER_QNAME));
+        assertEquals("header text must be equal to [" + HEADER_CONTENT + "0]", HEADER_CONTENT + "0", element.getText());
+    }
+
+
+    @Test
+    public void resolveSoapHeaderElementList() throws Exception {
+        Object result = resolver.resolveArgument(messageContext, soapHeaderElementListParameter);
+
+        assertTrue("result must be a List", List.class.isAssignableFrom(result.getClass()));
+
+        List<SoapHeaderElement> elements = (List) result;
+
+        assertTrue("size", elements.size() > 1);
+        for (int i = 0; i < elements.size(); i++) {
+            SoapHeaderElement element = elements.get(i);
+            assertTrue("headers must be equal", element.getName().equals(HEADER_QNAME));
+            assertEquals("header must be equal to [" + HEADER_CONTENT + i + "]", HEADER_CONTENT + i, elements.get(i).getText());
+        }
+    }
+
+    @Test
+    public void resolveSoapHeaderMismatch() throws Exception {
+        Object result = resolver.resolveArgument(messageContext, soapHeaderMismatch);
+        assertNull(result);
+    }
+
+    @Test
+    public void resolveSoapHeaderMismatchList() throws Exception {
+        Object result = resolver.resolveArgument(messageContext, soapHeaderMismatchList);
+        assertTrue("result must be a List", List.class.isAssignableFrom(result.getClass()));
+        assertTrue("result List must be empty", ((List) result).isEmpty());
+    }
+
+
+    public void soapHeaderWithEmptyValue(@SoapHeader("") SoapHeaderElement element) {
+    }
+
+    public void soapHeaderElement(@SoapHeader("{http://springframework.org/ws}header") SoapHeaderElement element) {
+    }
+
+    public void soapHeaderElementList(@SoapHeader("{http://springframework.org/ws}header") List<SoapHeaderElement> elements) {
+    }
+
+    public void soapHeaderMismatch(@SoapHeader("{http://springframework.org/ws}xxx") SoapHeaderElement element) {
+    }
+
+    public void soapHeaderMismatchList(@SoapHeader("{http://springframework.org/ws}xxx") List<SoapHeaderElement> elements) {
+    }
+
+
+}