Refactored the 'jms-target' element to an 'outbound-channel-adapter' element within the 'jms' namespace.

This commit is contained in:
Mark Fisher
2008-10-12 03:23:48 +00:00
parent 6873274353
commit 118dc27b7c
10 changed files with 77 additions and 57 deletions

View File

@@ -20,11 +20,12 @@ import org.springframework.integration.message.Message;
import org.springframework.integration.message.MessageConsumer;
/**
* A target for sending JMS Messages.
* A MessageConsumer that sends the converted Message payload within
* a JMS Message.
*
* @author Mark Fisher
*/
public class JmsTarget extends AbstractJmsTemplateBasedAdapter implements MessageConsumer {
public class JmsSendingMessageConsumer extends AbstractJmsTemplateBasedAdapter implements MessageConsumer {
public final void onMessage(final Message<?> message) {
if (message == null) {

View File

@@ -28,7 +28,7 @@ public class JmsNamespaceHandler extends NamespaceHandlerSupport {
public void init() {
this.registerBeanDefinitionParser("jms-gateway", new JmsGatewayParser());
this.registerBeanDefinitionParser("inbound-channel-adapter", new JmsInboundChannelAdapterParser());
this.registerBeanDefinitionParser("jms-target", new JmsTargetParser());
this.registerBeanDefinitionParser("outbound-channel-adapter", new JmsOutboundChannelAdapterParser());
}
}

View File

@@ -19,10 +19,11 @@ package org.springframework.integration.jms.config;
import org.w3c.dom.Element;
import org.springframework.beans.factory.BeanCreationException;
import org.springframework.beans.factory.support.AbstractBeanDefinition;
import org.springframework.beans.factory.support.BeanDefinitionBuilder;
import org.springframework.beans.factory.xml.AbstractSingleBeanDefinitionParser;
import org.springframework.beans.factory.xml.ParserContext;
import org.springframework.integration.jms.JmsTarget;
import org.springframework.integration.config.xml.AbstractOutboundChannelAdapterParser;
import org.springframework.integration.jms.JmsSendingMessageConsumer;
import org.springframework.util.StringUtils;
/**
@@ -30,21 +31,11 @@ import org.springframework.util.StringUtils;
*
* @author Mark Fisher
*/
public class JmsTargetParser extends AbstractSingleBeanDefinitionParser {
public class JmsOutboundChannelAdapterParser extends AbstractOutboundChannelAdapterParser {
protected Class<?> getBeanClass(Element element) {
return JmsTarget.class;
}
protected boolean shouldGenerateId() {
return false;
}
protected boolean shouldGenerateIdAsFallback() {
return true;
}
protected void doParse(Element element, ParserContext parserContext, BeanDefinitionBuilder builder) {
@Override
protected AbstractBeanDefinition parseConsumer(Element element, ParserContext parserContext) {
BeanDefinitionBuilder builder = BeanDefinitionBuilder.genericBeanDefinition(JmsSendingMessageConsumer.class);
String jmsTemplate = element.getAttribute(JmsAdapterParserUtils.JMS_TEMPLATE_ATTRIBUTE);
String destination = element.getAttribute(JmsAdapterParserUtils.DESTINATION_ATTRIBUTE);
String destinationName = element.getAttribute(JmsAdapterParserUtils.DESTINATION_NAME_ATTRIBUTE);
@@ -53,7 +44,7 @@ public class JmsTargetParser extends AbstractSingleBeanDefinitionParser {
if (element.hasAttribute(JmsAdapterParserUtils.CONNECTION_FACTORY_ATTRIBUTE) ||
element.hasAttribute(JmsAdapterParserUtils.DESTINATION_ATTRIBUTE) ||
element.hasAttribute(JmsAdapterParserUtils.DESTINATION_NAME_ATTRIBUTE)) {
throw new BeanCreationException("when providing a 'jms-template' reference, none of " +
throw new BeanCreationException("When providing a 'jms-template' reference, none of " +
"'connection-factory', 'destination', or 'destination-name' should be provided.");
}
builder.addPropertyReference(JmsAdapterParserUtils.JMS_TEMPLATE_PROPERTY, jmsTemplate);
@@ -69,12 +60,13 @@ public class JmsTargetParser extends AbstractSingleBeanDefinitionParser {
}
}
else {
throw new BeanCreationException("Either a 'jms-template' reference or " +
"one of 'destination' or 'destination-name' attributes must be provided.");
throw new BeanCreationException("Either a 'jms-template' reference " +
"or one of 'destination' or 'destination-name' must be provided.");
}
if (StringUtils.hasText(headerMapper)) {
builder.addPropertyReference(JmsAdapterParserUtils.HEADER_MAPPER_PROPERTY, headerMapper);
}
return builder.getBeanDefinition();
}
}

View File

@@ -62,15 +62,16 @@
</xsd:complexType>
</xsd:element>
<xsd:element name="jms-target">
<xsd:element name="outbound-channel-adapter">
<xsd:annotation>
<xsd:documentation>
Defines a target that sends JMS Messages.
Defines an outbound JMS Message-sending Channel Adapter.
</xsd:documentation>
</xsd:annotation>
<xsd:complexType>
<xsd:complexContent>
<xsd:extension base="jmsAdapterType">
<xsd:attribute name="channel" type="xsd:string"/>
<xsd:attribute name="header-mapper" type="xsd:string"/>
</xsd:extension>
</xsd:complexContent>

View File

@@ -26,57 +26,61 @@ import org.springframework.beans.factory.BeanCreationException;
import org.springframework.beans.factory.BeanDefinitionStoreException;
import org.springframework.context.support.ClassPathXmlApplicationContext;
import org.springframework.integration.adapter.MessageHeaderMapper;
import org.springframework.integration.jms.JmsTarget;
import org.springframework.integration.endpoint.SubscribingConsumerEndpoint;
/**
* @author Mark Fisher
*/
public class JmsTargetParserTests {
public class JmsOutboundChannelAdapterParserTests {
@Test
public void testTargetWithConnectionFactoryAndDestination() {
public void adapterWithConnectionFactoryAndDestination() {
ClassPathXmlApplicationContext context = new ClassPathXmlApplicationContext(
"targetWithConnectionFactoryAndDestination.xml", this.getClass());
JmsTarget target = (JmsTarget) context.getBean("target");
DirectFieldAccessor accessor = new DirectFieldAccessor(target);
"jmsOutboundWithConnectionFactoryAndDestination.xml", this.getClass());
SubscribingConsumerEndpoint endpoint = (SubscribingConsumerEndpoint) context.getBean("adapter");
DirectFieldAccessor accessor = new DirectFieldAccessor(
new DirectFieldAccessor(endpoint).getPropertyValue("consumer"));
assertNotNull(accessor.getPropertyValue("jmsTemplate"));
}
@Test
public void testTargetWithConnectionFactoryAndDestinationName() {
public void adapterWithConnectionFactoryAndDestinationName() {
ClassPathXmlApplicationContext context = new ClassPathXmlApplicationContext(
"targetWithConnectionFactoryAndDestinationName.xml", this.getClass());
JmsTarget target = (JmsTarget) context.getBean("target");
DirectFieldAccessor accessor = new DirectFieldAccessor(target);
"jmsOutboundWithConnectionFactoryAndDestinationName.xml", this.getClass());
SubscribingConsumerEndpoint endpoint = (SubscribingConsumerEndpoint) context.getBean("adapter");
DirectFieldAccessor accessor = new DirectFieldAccessor(
new DirectFieldAccessor(endpoint).getPropertyValue("consumer"));
assertNotNull(accessor.getPropertyValue("jmsTemplate"));
}
@Test
public void testTargetWithDefaultConnectionFactory() {
public void adapterWithDefaultConnectionFactory() {
ClassPathXmlApplicationContext context = new ClassPathXmlApplicationContext(
"targetWithDefaultConnectionFactory.xml", this.getClass());
JmsTarget target = (JmsTarget) context.getBean("target");
DirectFieldAccessor accessor = new DirectFieldAccessor(target);
"jmsOutboundWithDefaultConnectionFactory.xml", this.getClass());
SubscribingConsumerEndpoint endpoint = (SubscribingConsumerEndpoint) context.getBean("adapter");
DirectFieldAccessor accessor = new DirectFieldAccessor(
new DirectFieldAccessor(endpoint).getPropertyValue("consumer"));
assertNotNull(accessor.getPropertyValue("jmsTemplate"));
}
@Test
@SuppressWarnings("unchecked")
public void testTargetWithHeaderMapper() {
public void adapterWithHeaderMapper() {
ClassPathXmlApplicationContext context = new ClassPathXmlApplicationContext(
"targetWithHeaderMapper.xml", this.getClass());
JmsTarget target = (JmsTarget) context.getBean("target");
DirectFieldAccessor accessor = new DirectFieldAccessor(target);
"jmsOutboundWithHeaderMapper.xml", this.getClass());
SubscribingConsumerEndpoint endpoint = (SubscribingConsumerEndpoint) context.getBean("adapter");
DirectFieldAccessor accessor = new DirectFieldAccessor(
new DirectFieldAccessor(endpoint).getPropertyValue("consumer"));
MessageHeaderMapper headerMapper = (MessageHeaderMapper)
accessor.getPropertyValue("headerMapper");
assertNotNull(headerMapper);
assertEquals(TestMessageHeaderMapper.class, headerMapper.getClass());
}
@Test(expected=BeanDefinitionStoreException.class)
public void testTargetWithEmptyConnectionFactory() {
@Test(expected = BeanDefinitionStoreException.class)
public void adapterWithEmptyConnectionFactory() {
try {
new ClassPathXmlApplicationContext("targetWithEmptyConnectionFactory.xml", this.getClass());
new ClassPathXmlApplicationContext("jmsOutboundWithEmptyConnectionFactory.xml", this.getClass());
}
catch (RuntimeException e) {
assertEquals(BeanCreationException.class, e.getCause().getClass());

View File

@@ -1,6 +1,7 @@
<?xml version="1.0" encoding="UTF-8"?>
<beans xmlns="http://www.springframework.org/schema/beans"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xmlns:integration="http://www.springframework.org/schema/integration"
xmlns:jms="http://www.springframework.org/schema/integration/jms"
xsi:schemaLocation="http://www.springframework.org/schema/beans
http://www.springframework.org/schema/beans/spring-beans-2.5.xsd
@@ -9,9 +10,12 @@
http://www.springframework.org/schema/integration/jms
http://www.springframework.org/schema/integration/jms/spring-integration-jms-1.0.xsd">
<jms:jms-target id="target"
connection-factory="testConnectionFactory"
destination="testDestination"/>
<integration:channel id="input"/>
<jms:outbound-channel-adapter id="adapter"
channel="input"
connection-factory="testConnectionFactory"
destination="testDestination"/>
<bean id="testConnectionFactory" class="org.springframework.jms.connection.SingleConnectionFactory">
<constructor-arg>

View File

@@ -1,6 +1,7 @@
<?xml version="1.0" encoding="UTF-8"?>
<beans xmlns="http://www.springframework.org/schema/beans"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xmlns:integration="http://www.springframework.org/schema/integration"
xmlns:jms="http://www.springframework.org/schema/integration/jms"
xsi:schemaLocation="http://www.springframework.org/schema/beans
http://www.springframework.org/schema/beans/spring-beans-2.5.xsd
@@ -9,9 +10,12 @@
http://www.springframework.org/schema/integration/jms
http://www.springframework.org/schema/integration/jms/spring-integration-jms-1.0.xsd">
<jms:jms-target id="target"
connection-factory="testConnectionFactory"
destination-name="queue.test"/>
<integration:channel id="input"/>
<jms:outbound-channel-adapter id="adapter"
channel="input"
connection-factory="testConnectionFactory"
destination-name="queue.test"/>
<bean id="testConnectionFactory" class="org.springframework.jms.connection.SingleConnectionFactory">
<constructor-arg>

View File

@@ -1,6 +1,7 @@
<?xml version="1.0" encoding="UTF-8"?>
<beans xmlns="http://www.springframework.org/schema/beans"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xmlns:integration="http://www.springframework.org/schema/integration"
xmlns:jms="http://www.springframework.org/schema/integration/jms"
xsi:schemaLocation="http://www.springframework.org/schema/beans
http://www.springframework.org/schema/beans/spring-beans-2.5.xsd
@@ -9,9 +10,10 @@
http://www.springframework.org/schema/integration/jms
http://www.springframework.org/schema/integration/jms/spring-integration-jms-1.0.xsd">
<jms:jms-target id="target" destination="testDestination" header-mapper="mapper"/>
<integration:channel id="input"/>
<bean id="mapper" class="org.springframework.integration.jms.config.TestMessageHeaderMapper"/>
<jms:outbound-channel-adapter id="adapter"
channel="input" destination="testDestination"/>
<bean id="connectionFactory" class="org.springframework.jms.connection.SingleConnectionFactory">
<constructor-arg>

View File

@@ -1,6 +1,7 @@
<?xml version="1.0" encoding="UTF-8"?>
<beans xmlns="http://www.springframework.org/schema/beans"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xmlns:integration="http://www.springframework.org/schema/integration"
xmlns:jms="http://www.springframework.org/schema/integration/jms"
xsi:schemaLocation="http://www.springframework.org/schema/beans
http://www.springframework.org/schema/beans/spring-beans-2.5.xsd
@@ -9,9 +10,12 @@
http://www.springframework.org/schema/integration/jms
http://www.springframework.org/schema/integration/jms/spring-integration-jms-1.0.xsd">
<jms:jms-target id="target"
connection-factory=""
destination="testDestination"/>
<integration:channel id="input"/>
<jms:outbound-channel-adapter id="adapter"
channel="input"
connection-factory=""
destination="testDestination"/>
<bean id="testDestination" class="org.springframework.integration.jms.StubDestination"/>

View File

@@ -1,6 +1,7 @@
<?xml version="1.0" encoding="UTF-8"?>
<beans xmlns="http://www.springframework.org/schema/beans"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xmlns:integration="http://www.springframework.org/schema/integration"
xmlns:jms="http://www.springframework.org/schema/integration/jms"
xsi:schemaLocation="http://www.springframework.org/schema/beans
http://www.springframework.org/schema/beans/spring-beans-2.5.xsd
@@ -9,7 +10,14 @@
http://www.springframework.org/schema/integration/jms
http://www.springframework.org/schema/integration/jms/spring-integration-jms-1.0.xsd">
<jms:jms-target id="target" destination="testDestination"/>
<integration:channel id="input"/>
<jms:outbound-channel-adapter id="adapter"
channel="input"
destination="testDestination"
header-mapper="mapper"/>
<bean id="mapper" class="org.springframework.integration.jms.config.TestMessageHeaderMapper"/>
<bean id="connectionFactory" class="org.springframework.jms.connection.SingleConnectionFactory">
<constructor-arg>