diff --git a/spring-integration-core/src/main/java/org/springframework/integration/config/xml/IntegrationNamespaceHandler.java b/spring-integration-core/src/main/java/org/springframework/integration/config/xml/IntegrationNamespaceHandler.java index 88ee9c1f54..892860c744 100644 --- a/spring-integration-core/src/main/java/org/springframework/integration/config/xml/IntegrationNamespaceHandler.java +++ b/spring-integration-core/src/main/java/org/springframework/integration/config/xml/IntegrationNamespaceHandler.java @@ -59,6 +59,7 @@ public class IntegrationNamespaceHandler extends AbstractIntegrationNamespaceHan registerBeanDefinitionParser("poller", new PollerParser()); registerBeanDefinitionParser("annotation-config", new AnnotationConfigParser()); registerBeanDefinitionParser("application-event-multicaster", new ApplicationEventMulticasterParser()); + registerBeanDefinitionParser("publisher", new PublisherParser()); registerBeanDefinitionParser("publishing-interceptor", new PublishingInterceptorParser()); registerBeanDefinitionParser("channel-interceptor", new GlobalChannelInterceptorParser()); registerBeanDefinitionParser("converter", new ConverterParser()); diff --git a/spring-integration-core/src/main/java/org/springframework/integration/config/xml/PublisherParser.java b/spring-integration-core/src/main/java/org/springframework/integration/config/xml/PublisherParser.java new file mode 100644 index 0000000000..885c4d74b6 --- /dev/null +++ b/spring-integration-core/src/main/java/org/springframework/integration/config/xml/PublisherParser.java @@ -0,0 +1,89 @@ +/* + * Copyright 2002-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.integration.config.xml; + +import org.w3c.dom.Element; + +import org.springframework.beans.factory.support.BeanDefinitionBuilder; +import org.springframework.beans.factory.support.RootBeanDefinition; +import org.springframework.beans.factory.xml.AbstractSingleBeanDefinitionParser; +import org.springframework.beans.factory.xml.ParserContext; +import org.springframework.util.StringUtils; + +/** + * Parser for the <publisher> element. + * + * @author Mark Fisher + * @since 2.0 + */ +public class PublisherParser extends AbstractSingleBeanDefinitionParser { + + @Override + protected String getBeanClassName(Element element) { + return IntegrationNamespaceUtils.BASE_PACKAGE + ".endpoint.TriggeredMessagePublisher"; + } + + @Override + protected boolean shouldGenerateIdAsFallback() { + return true; + } + + @Override + protected void doParse(Element element, ParserContext parserContext, BeanDefinitionBuilder builder) { + String fixedDelay = element.getAttribute("fixed-delay"); + String fixedRate = element.getAttribute("fixed-rate"); + String cron = element.getAttribute("cron"); + String trigger = element.getAttribute("trigger"); + int numTriggers = 0; + if (StringUtils.hasText(fixedDelay)) { + RootBeanDefinition triggerDefinition = new RootBeanDefinition( + "org.springframework.scheduling.support.PeriodicTrigger"); + triggerDefinition.getConstructorArgumentValues().addGenericArgumentValue(fixedDelay); + builder.addConstructorArgValue(triggerDefinition); + numTriggers++; + } + if (StringUtils.hasText(fixedRate)) { + RootBeanDefinition triggerDefinition = new RootBeanDefinition( + "org.springframework.scheduling.support.PeriodicTrigger"); + triggerDefinition.getConstructorArgumentValues().addGenericArgumentValue(fixedRate); + triggerDefinition.getPropertyValues().add("fixedRate", Boolean.TRUE); + builder.addConstructorArgValue(triggerDefinition); + numTriggers++; + } + if (StringUtils.hasText(cron)) { + RootBeanDefinition triggerDefinition = new RootBeanDefinition( + "org.springframework.scheduling.support.CronTrigger"); + triggerDefinition.getConstructorArgumentValues().addGenericArgumentValue(cron); + builder.addConstructorArgValue(triggerDefinition); + numTriggers++; + } + if (StringUtils.hasText(trigger)) { + builder.addConstructorArgReference(trigger); + numTriggers++; + } + if (numTriggers != 1) { + parserContext.getReaderContext().error("exactly one of the following trigger attributes must be provided: " + + "fixed-delay, fixed-rate, cron, or trigger", parserContext.extractSource(element)); + return; + } + builder.addPropertyReference("outputChannel", element.getAttribute("channel")); + builder.addConstructorArgValue(element.getAttribute("payload")); + IntegrationNamespaceUtils.setValueIfAttributeDefined(builder, element, "auto-startup"); + // TODO: add support for header expression sub-elements + } + +} diff --git a/spring-integration-core/src/main/resources/org/springframework/integration/config/xml/spring-integration-2.0.xsd b/spring-integration-core/src/main/resources/org/springframework/integration/config/xml/spring-integration-2.0.xsd index 7865b66c12..5f0f85f241 100644 --- a/spring-integration-core/src/main/resources/org/springframework/integration/config/xml/spring-integration-2.0.xsd +++ b/spring-integration-core/src/main/resources/org/springframework/integration/config/xml/spring-integration-2.0.xsd @@ -2246,6 +2246,77 @@ Name of the header whose value to use. + + + + Defines a component that evaluates an expression to generate a Message payload + (as well as optional expression evaluation for headers). The resulting Message + is then sent to a MessageChannel. Each execution is driven by a Trigger. + Exactly one of the trigger type attributes must be provided. The options are: + fixed-delay, fixed-rate, cron, or trigger (reference). + + + + + + + Fixed delay trigger (in milliseconds). + + + + + Fixed rate trigger (in milliseconds). + + + + + Cron trigger. + + + + + + Reference to a Trigger instance. + + + + + + + + + + + + SpEL expression to be evaluated for each triggered execution. + The result of the evaluation will be passed as the payload of + the Message that is sent to the MessageChannel. + + + + + + + MessageChannel to which this publisher's output should be sent. + + + + + + + + + + + + Specify whether this publisher should start automatically. + By default it will. Set this to 'false' to require a manual start. + + + + + + diff --git a/spring-integration-core/src/test/java/org/springframework/integration/config/xml/PublisherParserTests-context.xml b/spring-integration-core/src/test/java/org/springframework/integration/config/xml/PublisherParserTests-context.xml new file mode 100644 index 0000000000..d7600c7d4a --- /dev/null +++ b/spring-integration-core/src/test/java/org/springframework/integration/config/xml/PublisherParserTests-context.xml @@ -0,0 +1,32 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/spring-integration-core/src/test/java/org/springframework/integration/config/xml/PublisherParserTests.java b/spring-integration-core/src/test/java/org/springframework/integration/config/xml/PublisherParserTests.java new file mode 100644 index 0000000000..30206b049f --- /dev/null +++ b/spring-integration-core/src/test/java/org/springframework/integration/config/xml/PublisherParserTests.java @@ -0,0 +1,109 @@ +/* + * Copyright 2002-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.integration.config.xml; + +import static org.junit.Assert.assertEquals; +import static org.junit.Assert.assertFalse; +import static org.junit.Assert.assertTrue; + +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.endpoint.TriggeredMessagePublisher; +import org.springframework.scheduling.Trigger; +import org.springframework.scheduling.support.CronTrigger; +import org.springframework.scheduling.support.PeriodicTrigger; +import org.springframework.test.context.ContextConfiguration; +import org.springframework.test.context.junit4.SpringJUnit4ClassRunner; + +/** + * @author Mark Fisher + * @since 2.0 + */ +@ContextConfiguration +@RunWith(SpringJUnit4ClassRunner.class) +public class PublisherParserTests { + + @Autowired + private ApplicationContext context; + + + @Test + public void fixedDelay() { + TriggeredMessagePublisher publisher = context.getBean("fixedDelayPublisher", TriggeredMessagePublisher.class); + assertFalse(publisher.isAutoStartup()); + DirectFieldAccessor publisherAccessor = new DirectFieldAccessor(publisher); + Trigger trigger = (Trigger) publisherAccessor.getPropertyValue("trigger"); + assertEquals(PeriodicTrigger.class, trigger.getClass()); + DirectFieldAccessor triggerAccessor = new DirectFieldAccessor(trigger); + assertEquals(1234L, triggerAccessor.getPropertyValue("period")); + assertEquals(Boolean.FALSE, triggerAccessor.getPropertyValue("fixedRate")); + assertEquals(context.getBean("fixedDelayChannel"), publisherAccessor.getPropertyValue("outputChannel")); + Expression payloadExpression = (Expression) new DirectFieldAccessor( + publisherAccessor.getPropertyValue("task")).getPropertyValue("payloadExpression"); + assertEquals("'fixedDelayTest'", payloadExpression.getExpressionString()); + } + + @Test + public void fixedRate() { + TriggeredMessagePublisher publisher = context.getBean("fixedRatePublisher", TriggeredMessagePublisher.class); + assertFalse(publisher.isAutoStartup()); + DirectFieldAccessor publisherAccessor = new DirectFieldAccessor(publisher); + Trigger trigger = (Trigger) publisherAccessor.getPropertyValue("trigger"); + assertEquals(PeriodicTrigger.class, trigger.getClass()); + DirectFieldAccessor triggerAccessor = new DirectFieldAccessor(trigger); + assertEquals(5678L, triggerAccessor.getPropertyValue("period")); + assertEquals(Boolean.TRUE, triggerAccessor.getPropertyValue("fixedRate")); + assertEquals(context.getBean("fixedRateChannel"), publisherAccessor.getPropertyValue("outputChannel")); + Expression payloadExpression = (Expression) new DirectFieldAccessor( + publisherAccessor.getPropertyValue("task")).getPropertyValue("payloadExpression"); + assertEquals("'fixedRateTest'", payloadExpression.getExpressionString()); + } + + @Test + public void cron() { + TriggeredMessagePublisher publisher = context.getBean("cronPublisher", TriggeredMessagePublisher.class); + assertFalse(publisher.isAutoStartup()); + DirectFieldAccessor publisherAccessor = new DirectFieldAccessor(publisher); + Trigger trigger = (Trigger) publisherAccessor.getPropertyValue("trigger"); + assertEquals(CronTrigger.class, trigger.getClass()); + assertEquals("7 6 5 4 3 ?", new DirectFieldAccessor(new DirectFieldAccessor( + trigger).getPropertyValue("sequenceGenerator")).getPropertyValue("expression")); + assertEquals(context.getBean("cronChannel"), publisherAccessor.getPropertyValue("outputChannel")); + Expression payloadExpression = (Expression) new DirectFieldAccessor( + publisherAccessor.getPropertyValue("task")).getPropertyValue("payloadExpression"); + assertEquals("'cronTest'", payloadExpression.getExpressionString()); + } + + @Test + public void triggerRef() { + TriggeredMessagePublisher publisher = context.getBean("triggerRefPublisher", TriggeredMessagePublisher.class); + assertTrue(publisher.isAutoStartup()); + DirectFieldAccessor publisherAccessor = new DirectFieldAccessor(publisher); + Trigger trigger = (Trigger) publisherAccessor.getPropertyValue("trigger"); + assertEquals(context.getBean("customTrigger"), trigger); + assertEquals(context.getBean("triggerRefChannel"), publisherAccessor.getPropertyValue("outputChannel")); + Expression payloadExpression = (Expression) new DirectFieldAccessor( + publisherAccessor.getPropertyValue("task")).getPropertyValue("payloadExpression"); + assertEquals("'triggerRefTest'", payloadExpression.getExpressionString()); + } + +}