Spring Integration

org.springframework.integration.config.xml
Class AbstractOutboundChannelAdapterParser

java.lang.Object
  extended by org.springframework.beans.factory.xml.AbstractBeanDefinitionParser
      extended by org.springframework.integration.config.xml.AbstractChannelAdapterParser
          extended by org.springframework.integration.config.xml.AbstractOutboundChannelAdapterParser
All Implemented Interfaces:
org.springframework.beans.factory.xml.BeanDefinitionParser
Direct Known Subclasses:
AbstractXmppOutboundChannelAdapterParser, AmqpOutboundChannelAdapterParser, ConsoleOutboundChannelAdapterParser, DefaultOutboundChannelAdapterParser, EventOutboundChannelAdapterParser, FileOutboundChannelAdapterParser, GemfireOutboundChannelAdapterParser, HttpOutboundChannelAdapterParser, JdbcMessageHandlerParser, JmsOutboundChannelAdapterParser, JpaOutboundChannelAdapterParser, LoggingChannelAdapterParser, MailOutboundChannelAdapterParser, MongoDbOutboundChannelAdapterParser, NotificationPublishingChannelAdapterParser, OperationInvokingChannelAdapterParser, RedisOutboundChannelAdapterParser, RedisStoreOutboundChannelAdapterParser, RemoteFileOutboundChannelAdapterParser, StoredProcMessageHandlerParser, TcpOutboundChannelAdapterParser, TwitterOutboundChannelAdapterParser, UdpOutboundChannelAdapterParser

public abstract class AbstractOutboundChannelAdapterParser
extends AbstractChannelAdapterParser

Base class for outbound Channel Adapter parsers. If this component is defined as the top-level element in the Spring application context it will produce an AbstractEndpoint depending on the channel type. If this component is defined as nested element (e.g., inside of the chain) it will produce a MessageHandler.

Author:
Mark Fisher, Gary Russell, Artem Bilan

Field Summary
 
Fields inherited from class org.springframework.beans.factory.xml.AbstractBeanDefinitionParser
ID_ATTRIBUTE, NAME_ATTRIBUTE
 
Constructor Summary
AbstractOutboundChannelAdapterParser()
           
 
Method Summary
protected  org.springframework.beans.factory.support.AbstractBeanDefinition doParse(org.w3c.dom.Element element, org.springframework.beans.factory.xml.ParserContext parserContext, java.lang.String channelName)
          Subclasses must implement this method to parse the adapter element.
protected  org.springframework.beans.factory.parsing.BeanComponentDefinition doParseAndRegisterConsumer(org.w3c.dom.Element element, org.springframework.beans.factory.xml.ParserContext parserContext)
          Override this method to control the registration process and return the bean name.
protected  boolean isUsingReplyProducer()
          Override this to signal that this channel adapter is actually using a AbstractReplyProducingMessageHandler while it is not possible for this parser to determine that because, say, a FactoryBean is being used.
protected  java.lang.String parseAndRegisterConsumer(org.w3c.dom.Element element, org.springframework.beans.factory.xml.ParserContext parserContext)
          Deprecated. Use doParseAndRegisterConsumer(Element, ParserContext)
protected abstract  org.springframework.beans.factory.support.AbstractBeanDefinition parseConsumer(org.w3c.dom.Element element, org.springframework.beans.factory.xml.ParserContext parserContext)
          Override this method to return the BeanDefinition for the MessageConsumer.
 
Methods inherited from class org.springframework.integration.config.xml.AbstractChannelAdapterParser
parseInternal, resolveId
 
Methods inherited from class org.springframework.beans.factory.xml.AbstractBeanDefinitionParser
parse, postProcessComponentDefinition, registerBeanDefinition, shouldFireEvents, shouldGenerateId, shouldGenerateIdAsFallback
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

AbstractOutboundChannelAdapterParser

public AbstractOutboundChannelAdapterParser()
Method Detail

doParse

protected org.springframework.beans.factory.support.AbstractBeanDefinition doParse(org.w3c.dom.Element element,
                                                                                   org.springframework.beans.factory.xml.ParserContext parserContext,
                                                                                   java.lang.String channelName)
Description copied from class: AbstractChannelAdapterParser
Subclasses must implement this method to parse the adapter element. The name of the MessageChannel bean is provided.

Specified by:
doParse in class AbstractChannelAdapterParser

parseAndRegisterConsumer

@Deprecated
protected java.lang.String parseAndRegisterConsumer(org.w3c.dom.Element element,
                                                               org.springframework.beans.factory.xml.ParserContext parserContext)
Deprecated. Use doParseAndRegisterConsumer(Element, ParserContext)

Override this method to control the registration process and return the bean name. If parsing a bean definition whose name can be auto-generated, consider using parseConsumer(Element, ParserContext) instead.


doParseAndRegisterConsumer

protected org.springframework.beans.factory.parsing.BeanComponentDefinition doParseAndRegisterConsumer(org.w3c.dom.Element element,
                                                                                                       org.springframework.beans.factory.xml.ParserContext parserContext)
Override this method to control the registration process and return the bean name. If parsing a bean definition whose name can be auto-generated, consider using parseConsumer(Element, ParserContext) instead.


parseConsumer

protected abstract org.springframework.beans.factory.support.AbstractBeanDefinition parseConsumer(org.w3c.dom.Element element,
                                                                                                  org.springframework.beans.factory.xml.ParserContext parserContext)
Override this method to return the BeanDefinition for the MessageConsumer. It will be registered with a generated name.


isUsingReplyProducer

protected boolean isUsingReplyProducer()
Override this to signal that this channel adapter is actually using a AbstractReplyProducingMessageHandler while it is not possible for this parser to determine that because, say, a FactoryBean is being used.

Returns:
false, unless overridden.

Spring Integration