initial implementation

added enricher parser addressed PR comments
2011-10-17 15:33:25 -04:00
parent 24714fa711
commit aeaf7d6e89
7 changed files with 686 additions and 1 deletions
--- a/spring-integration-core/src/test/java/org/springframework/integration/config/xml/EnricherParserTests-context.xml
+++ b/spring-integration-core/src/test/java/org/springframework/integration/config/xml/EnricherParserTests-context.xml
@@ -0,0 +1,23 @@
+<?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">
+
+	<channel id="input"/>
+
+	<channel id="output">
+		<queue />
+	</channel>
+
+	<channel id="requests"/>
+
+	<enricher id="enricher" input-channel="input" request-channel="requests" order="99" should-clone-payload="true" output-channel="output">
+		<property name="name" expression="payload.sourceName"/>
+		<property name="age" value="42"/>
+	</enricher>
+
+</beans:beans>
--- a/spring-integration-core/src/test/java/org/springframework/integration/config/xml/EnricherParserTests.java
+++ b/spring-integration-core/src/test/java/org/springframework/integration/config/xml/EnricherParserTests.java
@@ -0,0 +1,145 @@
+/*
+ * 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.config.xml;
+
+import static org.junit.Assert.assertEquals;
+import static org.junit.Assert.assertNotSame;
+
+import java.util.Map;
+
+import org.junit.Test;
+import org.junit.runner.RunWith;
+import org.springframework.beans.DirectFieldAccessor;
+import org.springframework.beans.factory.annotation.Autowired;
+import org.springframework.context.ApplicationContext;
+import org.springframework.expression.Expression;
+import org.springframework.integration.Message;
+import org.springframework.integration.MessageChannel;
+import org.springframework.integration.core.PollableChannel;
+import org.springframework.integration.core.SubscribableChannel;
+import org.springframework.integration.endpoint.EventDrivenConsumer;
+import org.springframework.integration.handler.AbstractReplyProducingMessageHandler;
+import org.springframework.integration.support.MessageBuilder;
+import org.springframework.integration.test.util.TestUtils;
+import org.springframework.integration.transformer.ContentEnricher;
+import org.springframework.test.context.ContextConfiguration;
+import org.springframework.test.context.junit4.SpringJUnit4ClassRunner;
+
+/**
+ * @author Mark Fisher
+ * @since 2.1
+ */
+@RunWith(SpringJUnit4ClassRunner.class)
+@ContextConfiguration
+public class EnricherParserTests {
+
+	@Autowired
+	private ApplicationContext context;
+
+
+	@Test
+	@SuppressWarnings("unchecked")
+	public void configurationCheck() {
+		Object endpoint = context.getBean("enricher");
+		assertEquals(EventDrivenConsumer.class, endpoint.getClass());
+		Object handler = TestUtils.getPropertyValue(endpoint, "handler");
+		assertEquals(ContentEnricher.class, handler.getClass());
+		ContentEnricher enricher = (ContentEnricher) handler;
+		assertEquals(99, enricher.getOrder());
+		DirectFieldAccessor accessor = new DirectFieldAccessor(enricher);
+		assertEquals(context.getBean("output"), accessor.getPropertyValue("outputChannel"));
+		assertEquals(true, accessor.getPropertyValue("shouldClonePayload"));
+		Map<Expression, Expression> propertyExpressions = (Map<Expression, Expression>) accessor.getPropertyValue("propertyExpressions");
+		for (Map.Entry<Expression, Expression> e : propertyExpressions.entrySet()) {
+			if ("name".equals(e.getKey().getExpressionString())) {
+				assertEquals("payload.sourceName", e.getValue().getExpressionString());
+			}
+			else if ("age".equals(e.getKey().getExpressionString())) {
+				assertEquals("42", e.getValue().getExpressionString());
+			}
+			else {
+				throw new IllegalStateException("expected 'name' and 'age' only, not: " + e.getKey().getExpressionString());
+			}
+		}
+	}
+
+	@Test
+	public void integrationTest() {
+		SubscribableChannel requests = context.getBean("requests", SubscribableChannel.class);
+		requests.subscribe(new AbstractReplyProducingMessageHandler() {
+			@Override
+			protected Object handleRequestMessage(Message<?> requestMessage) {
+				return new Source("foo");
+			}
+		});
+		Target original = new Target();
+		Message<?> request = MessageBuilder.withPayload(original).build();
+		context.getBean("input", MessageChannel.class).send(request);
+		Message<?> reply = context.getBean("output", PollableChannel.class).receive(0);
+		Target enriched = (Target) reply.getPayload();
+		assertEquals("foo", enriched.getName());
+		assertEquals(42, enriched.getAge());
+		assertNotSame(original, enriched);
+	}
+
+
+	private static class Source {
+		
+		private final String sourceName;
+
+		Source(String sourceName) {
+			this.sourceName = sourceName;
+		}
+
+		@SuppressWarnings("unused")
+		public String getSourceName() {
+			return sourceName;
+		}
+	}
+
+
+	public static class Target implements Cloneable {
+		
+		private volatile String name;
+		
+		private volatile int age;
+		
+		public String getName() {
+			return name;
+		}
+		
+		public void setName(String name) {
+			this.name = name;
+		}
+		
+		public int getAge() {
+			return age;
+		}
+		
+		public void setAge(int age) {
+			this.age = age;
+		}
+
+		public Object clone() {
+			Target copy = new Target();
+			copy.setName(this.name);
+			copy.setAge(this.age);
+			return copy;
+		}
+	}
+
+}
--- a/spring-integration-core/src/test/java/org/springframework/integration/transformer/ContentEnricherTests.java
+++ b/spring-integration-core/src/test/java/org/springframework/integration/transformer/ContentEnricherTests.java
@@ -0,0 +1,169 @@
+/*
+ * 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.transformer;
+
+import static org.junit.Assert.assertEquals;
+import static org.junit.Assert.assertNotSame;
+
+import java.util.HashMap;
+import java.util.Map;
+
+import org.junit.Test;
+import org.springframework.expression.Expression;
+import org.springframework.expression.spel.standard.SpelExpressionParser;
+import org.springframework.integration.Message;
+import org.springframework.integration.channel.DirectChannel;
+import org.springframework.integration.channel.QueueChannel;
+import org.springframework.integration.handler.AbstractReplyProducingMessageHandler;
+import org.springframework.integration.support.MessageBuilder;
+
+/**
+ * @author Mark Fisher
+ * @since 2.1
+ */
+public class ContentEnricherTests {
+
+	@Test
+	public void simpleProperty() {
+		QueueChannel replyChannel = new QueueChannel();
+		DirectChannel requestChannel = new DirectChannel();
+		requestChannel.subscribe(new AbstractReplyProducingMessageHandler() {
+			@Override
+			protected Object handleRequestMessage(Message<?> requestMessage) {
+				return new Source("John", "Doe");
+			}
+		});
+		ContentEnricher enricher = new ContentEnricher(requestChannel);
+		SpelExpressionParser parser = new SpelExpressionParser();
+		Map<String, Expression> propertyExpressions = new HashMap<String, Expression>();
+		propertyExpressions.put("name", parser.parseExpression("payload.lastName + ', ' + payload.firstName"));
+		enricher.setPropertyExpressions(propertyExpressions);
+		Target target = new Target("replace me");
+		Message<?> requestMessage = MessageBuilder.withPayload(target).setReplyChannel(replyChannel).build();
+		enricher.handleMessage(requestMessage);
+		Message<?> reply = replyChannel.receive(0);
+		assertEquals("Doe, John", ((Target) reply.getPayload()).getName());
+	}
+
+	@Test
+	public void nestedProperty() {
+		QueueChannel replyChannel = new QueueChannel();
+		DirectChannel requestChannel = new DirectChannel();
+		requestChannel.subscribe(new AbstractReplyProducingMessageHandler() {
+			@Override
+			protected Object handleRequestMessage(Message<?> requestMessage) {
+				return new Source("John", "Doe");
+			}
+		});
+		ContentEnricher enricher = new ContentEnricher(requestChannel);
+		SpelExpressionParser parser = new SpelExpressionParser();
+		Map<String, Expression> propertyExpressions = new HashMap<String, Expression>();
+		propertyExpressions.put("child.name", parser.parseExpression("payload.lastName + ', ' + payload.firstName"));
+		enricher.setPropertyExpressions(propertyExpressions);
+		Target target = new Target("test");
+		Message<?> requestMessage = MessageBuilder.withPayload(target).setReplyChannel(replyChannel).build();
+		enricher.handleMessage(requestMessage);
+		Message<?> reply = replyChannel.receive(0);
+		Target result = (Target) reply.getPayload();
+		assertEquals("test", result.getName());
+		assertEquals("Doe, John", result.getChild().getName());
+	}
+
+	@Test
+	public void clonePayload() {
+		QueueChannel replyChannel = new QueueChannel();
+		DirectChannel requestChannel = new DirectChannel();
+		requestChannel.subscribe(new AbstractReplyProducingMessageHandler() {
+			@Override
+			protected Object handleRequestMessage(Message<?> requestMessage) {
+				return new Source("John", "Doe");
+			}
+		});
+		ContentEnricher enricher = new ContentEnricher(requestChannel);
+		enricher.setShouldClonePayload(true);
+		SpelExpressionParser parser = new SpelExpressionParser();
+		Map<String, Expression> propertyExpressions = new HashMap<String, Expression>();
+		propertyExpressions.put("name", parser.parseExpression("payload.lastName + ', ' + payload.firstName"));
+		enricher.setPropertyExpressions(propertyExpressions);
+		Target target = new Target("replace me");
+		Message<?> requestMessage = MessageBuilder.withPayload(target).setReplyChannel(replyChannel).build();
+		enricher.handleMessage(requestMessage);
+		Message<?> reply = replyChannel.receive(0);
+		Target result = (Target) reply.getPayload();
+		assertEquals("Doe, John", result.getName());
+		assertNotSame(target, result);
+	}
+
+
+	@SuppressWarnings("unused")
+	private static final class Source {
+
+		private final String firstName, lastName;
+
+		Source(String firstName, String lastName) {
+			this.firstName = firstName;
+			this.lastName = lastName;
+		}
+
+		public String getFirstName() {
+			return firstName;
+		}
+
+		public String getLastName() {
+			return lastName;
+		}
+	}
+
+
+	public static final class Target implements Cloneable {
+
+		private volatile String name;
+
+		private volatile Target child;
+
+		public Target() {
+			this.name = "default";
+		}
+
+		private Target(String name) {
+			this.name = name;
+		}
+
+		public String getName() {
+			return this.name;
+		}
+
+		public void setName(String name) {
+			this.name = name;
+		}
+
+		public Target getChild() {
+			return this.child;
+		}
+
+		public void setChild(Target child) {
+			this.child = child;
+		}
+
+		public Object clone() {
+			Target clone = new Target(this.name);
+			clone.setChild(this.child);
+			return clone;
+		}
+	}
+
+}