INT-1472, reveresed application of 'extractRequestPayload' and 'extractReplyPayload' attributes, changed javadocs, added test as well as minor modification to ChannelPublishingMessageListener to deal with RuntimeException (e.t., NotSerializable) during heneration of the JMS Reply

spring-integration-jms/src/test/java/org/springframework/integration/jms/config/ExtractRequestReplyPayloadTests-context.xml

@@ -0,0 +1,48 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<beans xmlns="http://www.springframework.org/schema/beans"
+	xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+	xsi:schemaLocation="http://www.springframework.org/schema/beans http://www.springframework.org/schema/beans/spring-beans-3.0.xsd
+		http://www.springframework.org/schema/integration http://www.springframework.org/schema/integration/spring-integration-2.0.xsd
+		http://www.springframework.org/schema/integration/jms http://www.springframework.org/schema/integration/jms/spring-integration-jms-2.0.xsd
+		http://www.springframework.org/schema/jms http://www.springframework.org/schema/jms/spring-jms-3.0.xsd
+		http://www.springframework.org/schema/task http://www.springframework.org/schema/task/spring-task-3.0.xsd"
+	xmlns:int="http://www.springframework.org/schema/integration"
+	xmlns:int-jms="http://www.springframework.org/schema/integration/jms"
+	xmlns:jms="http://www.springframework.org/schema/jms"
+	xmlns:task="http://www.springframework.org/schema/task">
+
+	<int:channel id="outboundChannel"/>
+	
+	<int:channel id="replyChannel">
+		<int:queue/>
+	</int:channel>
+	
+	<int-jms:outbound-gateway id="outboundGateway"
+							  request-channel="outboundChannel" 
+	                          request-destination="extractRecRepQueue"
+	                          reply-channel="replyChannel"
+	                          receive-timeout="3000"
+	                          reply-timeout="3000"/>
+	 
+                     
+    <int-jms:inbound-gateway id="inboundGateway"
+                             request-destination="extractRecRepQueue" 
+                             request-channel="jmsInputChannel"
+                             request-timeout="3000"
+                             reply-timeout="3000"/>
+                             
+	<int:channel id="jmsInputChannel"/>
+	                     
+    <bean id="extractRecRepQueue" class="org.apache.activemq.command.ActiveMQQueue">
+		<constructor-arg value="request.queue.req.rep"/>
+	</bean>
+	<bean id="connectionFactory" class="org.springframework.jms.connection.CachingConnectionFactory">
+		<property name="targetConnectionFactory">
+			<bean class="org.apache.activemq.ActiveMQConnectionFactory">
+				<property name="brokerURL" value="vm://localhost"/>		
+			</bean>
+		</property>
+		<property name="sessionCacheSize" value="10"/>
+		<property name="cacheProducers" value="false"/>
+	</bean>
+</beans>

spring-integration-jms/src/test/java/org/springframework/integration/jms/config/ExtractRequestReplyPayloadTests.java

@@ -0,0 +1,213 @@
+/**
+ * 
+ */
+package org.springframework.integration.jms.config;
+
+import static junit.framework.Assert.assertTrue;
+import static org.mockito.Mockito.spy;
+import static org.mockito.Mockito.times;
+import static org.mockito.Mockito.verify;
+
+import org.junit.After;
+import org.junit.Before;
+import org.junit.Test;
+import org.mockito.Mockito;
+import org.springframework.beans.DirectFieldAccessor;
+import org.springframework.context.support.ClassPathXmlApplicationContext;
+import org.springframework.integration.Message;
+import org.springframework.integration.MessageChannel;
+import org.springframework.integration.MessageTimeoutException;
+import org.springframework.integration.MessagingException;
+import org.springframework.integration.core.MessageHandler;
+import org.springframework.integration.core.MessagingTemplate;
+import org.springframework.integration.core.PollableChannel;
+import org.springframework.integration.core.SubscribableChannel;
+import org.springframework.integration.jms.ChannelPublishingJmsMessageListener;
+import org.springframework.integration.jms.JmsOutboundGateway;
+import org.springframework.integration.message.GenericMessage;
+
+/**
+ * @author ozhurakousky
+ *
+ */
+public class ExtractRequestReplyPayloadTests {
+	ClassPathXmlApplicationContext applicationContext;
+	MessageChannel outboundChannel;
+	SubscribableChannel jmsInputChannel;
+	PollableChannel replyChannel;
+	@Before
+	public void prepare(){
+		ActiveMqTestUtils.prepare();
+		applicationContext = new ClassPathXmlApplicationContext("ExtractRequestReplyPayloadTests-context.xml", this.getClass());
+		outboundChannel = applicationContext.getBean("outboundChannel", MessageChannel.class);
+		jmsInputChannel = applicationContext.getBean("jmsInputChannel", SubscribableChannel.class);
+		replyChannel = applicationContext.getBean("replyChannel", PollableChannel.class);
+	}
+	@After
+	public void cleanup(){
+		applicationContext.destroy();
+	}
+
+	@Test
+	public void testOutboundInboundDefault(){
+		jmsInputChannel.subscribe(new MessageHandler() {
+			public void handleMessage(Message<?> message) throws MessagingException {
+				assertTrue(message.getPayload() instanceof String);
+				MessagingTemplate template = new MessagingTemplate((MessageChannel) message.getHeaders().getReplyChannel());
+				template.send(message);
+			}
+		});
+		outboundChannel.send(new GenericMessage<String>("Hello"));
+		
+		Message<?> replyMessage = replyChannel.receive(1000);	
+		assertTrue(replyMessage.getPayload() instanceof String);
+	}
+	
+	@Test
+	public void testOutboundBothFalseInboundDefault(){
+	
+		JmsOutboundGateway outboundGateway = 
+			(JmsOutboundGateway) new DirectFieldAccessor(applicationContext.getBean("outboundGateway")).getPropertyValue("handler");
+		outboundGateway.setExtractRequestPayload(false);
+		outboundGateway.setExtractReplyPayload(false);
+		
+		jmsInputChannel.subscribe(new MessageHandler() {
+			public void handleMessage(Message<?> message) throws MessagingException {
+				assertTrue(message.getPayload() instanceof String);
+				MessagingTemplate template = new MessagingTemplate((MessageChannel) message.getHeaders().getReplyChannel());
+				template.send(message);
+			}
+		});
+		outboundChannel.send(new GenericMessage<String>("Hello"));
+		
+		Message<?> replyMessage = replyChannel.receive(1000);		
+		assertTrue(replyMessage.getPayload() instanceof javax.jms.Message);
+	}
+	@Test(expected=MessageTimeoutException.class)
+	public void testOutboundDefaultInboundBothTrue(){
+		
+		ChannelPublishingJmsMessageListener inboundGateway = 
+			(ChannelPublishingJmsMessageListener)new DirectFieldAccessor(applicationContext.getBean("inboundGateway")).
+																	getPropertyValue("listener");
+		inboundGateway.setExtractReplyPayload(false);
+		inboundGateway.setExtractRequestPayload(false);
+		
+		MessageHandler handler = new MessageHandler() {
+			public void handleMessage(Message<?> message) throws MessagingException {
+				assertTrue(message.getPayload() instanceof javax.jms.Message);
+				MessagingTemplate template = new MessagingTemplate((MessageChannel) message.getHeaders().getReplyChannel());
+				template.send(message);
+			}
+		};
+		handler = spy(handler);
+		jmsInputChannel.subscribe(handler);
+		outboundChannel.send(new GenericMessage<String>("Hello"));
+		verify(handler, times(1)).handleMessage(Mockito.any(Message.class));
+		replyChannel.receive(1000);	
+	}
+	@Test
+	public void testOutboundDefaultInboundReplyTrueRequestFalse(){
+		
+		ChannelPublishingJmsMessageListener inboundGateway = 
+			(ChannelPublishingJmsMessageListener)new DirectFieldAccessor(applicationContext.getBean("inboundGateway")).
+																	getPropertyValue("listener");
+		inboundGateway.setExtractReplyPayload(true);
+		inboundGateway.setExtractRequestPayload(false);
+		
+		MessageHandler handler = new MessageHandler() {
+			public void handleMessage(Message<?> message) throws MessagingException {
+				assertTrue(message.getPayload() instanceof javax.jms.Message);
+				MessagingTemplate template = new MessagingTemplate((MessageChannel) message.getHeaders().getReplyChannel());
+				template.send(message);
+			}
+		};
+		jmsInputChannel.subscribe(handler);
+		outboundChannel.send(new GenericMessage<String>("Hello"));
+		Message<?> replyMessage = replyChannel.receive(1000);	
+		assertTrue(replyMessage.getPayload() instanceof String);
+	}
+	@Test
+	public void testOutboundDefaultInboundReplyFalseRequestTrue(){
+		
+		ChannelPublishingJmsMessageListener inboundGateway = 
+			(ChannelPublishingJmsMessageListener)new DirectFieldAccessor(applicationContext.getBean("inboundGateway")).
+																	getPropertyValue("listener");
+		inboundGateway.setExtractReplyPayload(false);
+		inboundGateway.setExtractRequestPayload(true);
+		
+		MessageHandler handler = new MessageHandler() {
+			public void handleMessage(Message<?> message) throws MessagingException {
+				assertTrue(message.getPayload() instanceof String);
+				MessagingTemplate template = new MessagingTemplate((MessageChannel) message.getHeaders().getReplyChannel());
+				template.send(message);
+			}
+		};
+		jmsInputChannel.subscribe(handler);
+		outboundChannel.send(new GenericMessage<String>("Hello"));
+		Message<?> replyMessage = replyChannel.receive(1000);	
+		assertTrue(replyMessage.getPayload() instanceof String);
+	}
+	@Test
+	public void testOutboundRequestTrueReplyFalseInboundDefault(){
+		JmsOutboundGateway outboundGateway = 
+			(JmsOutboundGateway) new DirectFieldAccessor(applicationContext.getBean("outboundGateway")).getPropertyValue("handler");
+		outboundGateway.setExtractRequestPayload(true);
+		outboundGateway.setExtractReplyPayload(false);
+		
+		MessageHandler handler = new MessageHandler() {
+			public void handleMessage(Message<?> message) throws MessagingException {
+				assertTrue(message.getPayload() instanceof String);
+				MessagingTemplate template = new MessagingTemplate((MessageChannel) message.getHeaders().getReplyChannel());
+				template.send(message);
+			}
+		};
+		jmsInputChannel.subscribe(handler);
+		outboundChannel.send(new GenericMessage<String>("Hello"));
+		Message<?> replyMessage = replyChannel.receive(1000);	
+		assertTrue(replyMessage.getPayload() instanceof javax.jms.Message);
+	}
+	@Test
+	public void testOutboundRequestFalseReplyTrueInboundDefault(){
+		JmsOutboundGateway outboundGateway = 
+			(JmsOutboundGateway) new DirectFieldAccessor(applicationContext.getBean("outboundGateway")).getPropertyValue("handler");
+		outboundGateway.setExtractRequestPayload(false);
+		outboundGateway.setExtractReplyPayload(true);
+		
+		MessageHandler handler = new MessageHandler() {
+			public void handleMessage(Message<?> message) throws MessagingException {
+				assertTrue(message.getPayload() instanceof String);
+				MessagingTemplate template = new MessagingTemplate((MessageChannel) message.getHeaders().getReplyChannel());
+				template.send(message);
+			}
+		};
+		jmsInputChannel.subscribe(handler);
+		outboundChannel.send(new GenericMessage<String>("Hello"));
+		Message<?> replyMessage = replyChannel.receive(1000);	
+		assertTrue(replyMessage.getPayload() instanceof String);
+	}
+	@Test(expected=MessageTimeoutException.class)
+	public void testAllFalse(){
+		JmsOutboundGateway outboundGateway = 
+			(JmsOutboundGateway) new DirectFieldAccessor(applicationContext.getBean("outboundGateway")).getPropertyValue("handler");
+		outboundGateway.setExtractRequestPayload(false);
+		outboundGateway.setExtractReplyPayload(false);
+		
+		ChannelPublishingJmsMessageListener inboundGateway = 
+			(ChannelPublishingJmsMessageListener)new DirectFieldAccessor(applicationContext.getBean("inboundGateway")).
+																	getPropertyValue("listener");
+		inboundGateway.setExtractReplyPayload(false);
+		inboundGateway.setExtractRequestPayload(false);
+		
+		MessageHandler handler = new MessageHandler() {
+			public void handleMessage(Message<?> message) throws MessagingException {
+				assertTrue(message.getPayload() instanceof javax.jms.Message);
+				MessagingTemplate template = new MessagingTemplate((MessageChannel) message.getHeaders().getReplyChannel());
+				template.send(message);
+			}
+		};
+		jmsInputChannel.subscribe(handler);
+		outboundChannel.send(new GenericMessage<String>("Hello"));
+		Message<?> replyMessage = replyChannel.receive(1000);	
+		assertTrue(replyMessage.getPayload() instanceof String);
+	}
+}

spring-integration-jms/src/test/resources/log4j.properties

@@ -0,0 +1,11 @@
+log4j.rootCategory=WARN, stdout
+
+log4j.appender.stdout=org.apache.log4j.ConsoleAppender
+log4j.appender.stdout.layout=org.apache.log4j.PatternLayout
+log4j.appender.stdout.layout.ConversionPattern=%d{ABSOLUTE} %5p %t %c{2}:%L - %m%n
+
+
+log4j.category.org.springframework=WARN
+# log4j.category.org.springframework.integration=DEBUG
+# log4j.category.org.springframework.integration.jdbc=DEBUG
+log4j.category.org.springframework.jms=DEBUG