INTSAMPLES-19 Add Gateway Example

basic/testing-examples/src/main/java/org/springframework/integration/samples/testing/gateway/VoidGateway.java

@@ -0,0 +1,30 @@
+/*
+ * Copyright 2002-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
+ *
+ * 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.integration.samples.testing.gateway;
+
+import org.springframework.integration.annotation.Header;
+import org.springframework.integration.file.FileHeaders;
+
+/**
+ * @author Gary Russell
+ * @since 2.0.2
+ *
+ */
+public interface VoidGateway {
+	
+	public void process(String thing, @Header(FileHeaders.FILENAME) String fileName);
+
+}

basic/testing-examples/src/main/resources/META-INF/spring/integration/06-filter/integration-context.xml

@@ -13,7 +13,7 @@
 		output-channel="outputChannel">
 		<beans:bean class="org.springframework.integration.samples.testing.filter.PetFilter"/>
 	</filter>
-	
+
 	<channel id="outputChannel"/>
 	
 </beans:beans>

basic/testing-examples/src/main/resources/META-INF/spring/integration/07-gateway/integration-context.xml

@@ -0,0 +1,20 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<beans:beans xmlns="http://www.springframework.org/schema/integration"
+	xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+	xmlns:beans="http://www.springframework.org/schema/beans"
+	xsi:schemaLocation="http://www.springframework.org/schema/beans
+			http://www.springframework.org/schema/beans/spring-beans.xsd
+			http://www.springframework.org/schema/integration
+			http://www.springframework.org/schema/integration/spring-integration.xsd">
+
+	<gateway id="voidGateway" 
+		default-request-channel="inputChannel"
+		service-interface="org.springframework.integration.samples.testing.gateway.VoidGateway">
+		<method name="process">
+			<header name="configuredHeader" value="abc"/>
+		</method>
+	</gateway>
+	
+	<channel id="inputChannel" />
+	
+</beans:beans>

basic/testing-examples/src/test/java/org/springframework/integration/samples/testing/filter/PetFilterTests.java

@@ -34,11 +34,11 @@ import org.springframework.test.context.junit4.SpringJUnit4ClassRunner;
 
 /**
  * 
- * Shows how to test a router; the router is configured to route to direct
- * channel names. The configuration would
- * be a fragment of a larger flow. Since the output channels are direct,
- * they have no subscribers outside the context of a larger flow. So, 
- * in this test case, we bridge them to {@link QueueChannel}s to
+ * Shows how to test a filter. 
+ * The filter has direct input and output channels. The filter configuration would
+ * be a fragment of a larger flow. Since the output channel is direct,
+ * it has no subscribers outside the context of a larger flow. So, 
+ * in this test case, we bridge it to a {@link QueueChannel} to
  * facilitate easy testing.
  * 
  * @author Gary Russell

basic/testing-examples/src/test/java/org/springframework/integration/samples/testing/gateway/GatewayTests-context.xml

@@ -0,0 +1,19 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<beans:beans xmlns="http://www.springframework.org/schema/integration"
+	xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+	xmlns:beans="http://www.springframework.org/schema/beans"
+	xsi:schemaLocation="http://www.springframework.org/schema/beans
+			http://www.springframework.org/schema/beans/spring-beans.xsd
+			http://www.springframework.org/schema/integration
+			http://www.springframework.org/schema/integration/spring-integration.xsd">
+
+	<beans:import resource="classpath:META-INF/spring/integration/07-gateway/integration-context.xml" />
+	
+	<bridge input-channel="inputChannel"
+		output-channel="testChannel"/>
+		
+	<channel id="testChannel">
+		<queue/>
+	</channel>
+	
+</beans:beans>

basic/testing-examples/src/test/java/org/springframework/integration/samples/testing/gateway/GatewayTests.java

@@ -0,0 +1,68 @@
+/*
+ * Copyright 2002-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
+ *
+ * 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.integration.samples.testing.gateway;
+
+import static org.junit.Assert.assertEquals;
+import static org.junit.Assert.assertNotNull;
+
+import org.junit.Test;
+import org.junit.runner.RunWith;
+import org.springframework.beans.factory.annotation.Autowired;
+import org.springframework.integration.Message;
+import org.springframework.integration.MessageHeaders;
+import org.springframework.integration.channel.QueueChannel;
+import org.springframework.integration.file.FileHeaders;
+import org.springframework.test.context.ContextConfiguration;
+import org.springframework.test.context.junit4.SpringJUnit4ClassRunner;
+
+
+/**
+ * 
+ * Shows how to test a gateway to ensure the message injected
+ * into the Spring Integration flow is what we expected.
+ * The gateway uses a direct input channel. The configuration would
+ * be a fragment of a larger flow. Since the input channel is direct,
+ * it has no subscribers outside the context of a larger flow. So, 
+ * in this test case, we bridge it to a {@link QueueChannel} to
+ * facilitate easy testing.
+ * 
+ * @author Gary Russell
+ * @since 2.0.2
+ *
+ */
+@ContextConfiguration	// default context name is <ClassName>-context.xml
+@RunWith(SpringJUnit4ClassRunner.class)
+public class GatewayTests {
+	
+	@Autowired
+	QueueChannel testChannel;
+	
+	@Autowired
+	VoidGateway gateway;
+	
+	@Test
+	public void testTrueHeader() {
+		String payload = "XXXABCXXX";
+		String fileName = "abc.txt";
+		gateway.process(payload, fileName);
+		Message<?> inMessage = testChannel.receive(0);
+		assertNotNull("Expected a message", inMessage);
+		assertEquals(payload, inMessage.getPayload());
+		MessageHeaders headers = inMessage.getHeaders();
+		assertEquals(fileName, headers.get(FileHeaders.FILENAME));
+		assertEquals("abc", headers.get("configuredHeader"));
+	}
+}