Class IntegrationNamespaceUtils

java.lang.Object
org.springframework.integration.config.xml.IntegrationNamespaceUtils
public abstract class IntegrationNamespaceUtils extends Object
Shared utility methods for integration namespace parsers.
Author:
Mark Fisher, Marius Bogoevici, Alex Peters, Oleg Zhurakousky, Gary Russell, Artem Bilan, Gunnar Hillert

  • Field Details

  • Constructor Details

    • IntegrationNamespaceUtils

      public IntegrationNamespaceUtils()

  • Method Details

    • setValueIfAttributeDefined

      public static void setValueIfAttributeDefined(BeanDefinitionBuilder builder, Element element, String attributeName, String propertyName)
      Configures the provided bean definition builder with a property value corresponding to the attribute whose name is provided if that attribute is defined in the given element.
      Parameters:
      builder - the bean definition builder to be configured
      element - the XML element where the attribute should be defined
      attributeName - the name of the attribute whose value will be used to populate the property
      propertyName - the name of the property to be populated

    • setValueIfAttributeDefined

      public static void setValueIfAttributeDefined(BeanDefinitionBuilder builder, Element element, String attributeName)
      Configures the provided bean definition builder with a property value corresponding to the attribute whose name is provided if that attribute is defined in the given element.

      The property name will be the camel-case equivalent of the lower case hyphen separated attribute (e.g. the "foo-bar" attribute would match the "fooBar" property).

      Parameters:
      builder - the bean definition builder to be configured
      element - - the XML element where the attribute should be defined
      attributeName - - the name of the attribute whose value will be set on the property
      See Also:

    • setValueIfAttributeDefined

      public static void setValueIfAttributeDefined(BeanDefinitionBuilder builder, Element element, String attributeName, String propertyName, boolean emptyStringAllowed)
      Configures the provided bean definition builder with a property value corresponding to the attribute whose name is provided if that attribute is defined in the given element.
      Parameters:
      builder - the bean definition builder to be configured
      element - the XML element where the attribute should be defined
      attributeName - the name of the attribute whose value will be used to populate the property
      propertyName - the name of the property to be populated
      emptyStringAllowed - - if true, the value is set, even if an empty String (""); if false, an empty String is treated as if the attribute wasn't provided.

    • setValueIfAttributeDefined

      public static void setValueIfAttributeDefined(BeanDefinitionBuilder builder, Element element, String attributeName, boolean emptyStringAllowed)
      Configures the provided bean definition builder with a property value corresponding to the attribute whose name is provided if that attribute is defined in the given element.

      The property name will be the camel-case equivalent of the lower case hyphen separated attribute (e.g. the "foo-bar" attribute would match the "fooBar" property).

      Parameters:
      builder - the bean definition builder to be configured
      element - - the XML element where the attribute should be defined
      attributeName - - the name of the attribute whose value will be set on the property
      emptyStringAllowed - - if true, the value is set, even if an empty String (""); if false, an empty String is treated as if the attribute wasn't provided.
      See Also:

    • setReferenceIfAttributeDefined

      public static void setReferenceIfAttributeDefined(BeanDefinitionBuilder builder, Element element, String attributeName, String propertyName)
      Configures the provided bean definition builder with a property reference to a bean. The bean reference is identified by the value from the attribute whose name is provided if that attribute is defined in the given element.
      Parameters:
      builder - the bean definition builder to be configured
      element - the XML element where the attribute should be defined
      attributeName - the name of the attribute whose value will be used as a bean reference to populate the property
      propertyName - the name of the property to be populated

    • setReferenceIfAttributeDefined

      public static void setReferenceIfAttributeDefined(BeanDefinitionBuilder builder, Element element, String attributeName, String propertyName, boolean emptyStringAllowed)

    • setReferenceIfAttributeDefined

      public static void setReferenceIfAttributeDefined(BeanDefinitionBuilder builder, Element element, String attributeName)
      Configures the provided bean definition builder with a property reference to a bean. The bean reference is identified by the value from the attribute whose name is provided if that attribute is defined in the given element.

      The property name will be the camel-case equivalent of the lower case hyphen separated attribute (e.g. the "foo-bar" attribute would match the "fooBar" property).

      Parameters:
      builder - the bean definition builder to be configured
      element - - the XML element where the attribute should be defined
      attributeName - - the name of the attribute whose value will be used as a bean reference to populate the property
      See Also:

    • setReferenceIfAttributeDefined

      public static void setReferenceIfAttributeDefined(BeanDefinitionBuilder builder, Element element, String attributeName, boolean emptyStringAllowed)

    • createElementDescription

      public static String createElementDescription(Element element)
      Provides a user friendly description of an element based on its node name and, if available, its "id" attribute value. This is useful for creating error messages from within bean definition parsers.
      Parameters:
      element - The element.
      Returns:
      The description.

    • configurePollerMetadata

      public static void configurePollerMetadata(Element pollerElement, BeanDefinitionBuilder targetBuilder, ParserContext parserContext)
      Parse a "poller" element to provide a reference for the target BeanDefinitionBuilder. If the poller element does not contain a "ref" attribute, this will create and register a PollerMetadata instance and then add it as a property reference of the target builder.
      Parameters:
      pollerElement - the "poller" element to parse
      targetBuilder - the builder that expects the "trigger" property
      parserContext - the parserContext for the target builder

    • getTextFromAttributeOrNestedElement

      public static @Nullable String getTextFromAttributeOrNestedElement(Element element, String name, ParserContext parserContext)
      Get a text value from a named attribute if it exists, otherwise check for a nested element of the same name. If both are specified it is an error, but if neither is specified, just returns null.
      Parameters:
      element - a DOM node
      name - the name of the property (attribute or child element)
      parserContext - the current context
      Returns:
      the text from the attribute or element or null

    • parseInnerHandlerDefinition

      public static @Nullable BeanComponentDefinition parseInnerHandlerDefinition(Element element, ParserContext parserContext)

    • configureHeaderMapper

      public static void configureHeaderMapper(Element element, BeanDefinitionBuilder rootBuilder, ParserContext parserContext, Class<?> headerMapperClass, @Nullable String replyHeaderValue)
      Utility method to configure a HeaderMapper for Inbound and Outbound channel adapters/gateway.
      Parameters:
      element - The element.
      rootBuilder - The root builder.
      parserContext - The parser context.
      headerMapperClass - The header mapper class.
      replyHeaderValue - The reply header value.

    • configureHeaderMapper

      public static void configureHeaderMapper(Element element, BeanDefinitionBuilder rootBuilder, ParserContext parserContext, BeanDefinitionBuilder headerMapperBuilder, @Nullable String replyHeaderValueArg)
      Utility method to configure a HeaderMapper for Inbound and Outbound channel adapters/gateway.
      Parameters:
      element - The element.
      rootBuilder - The root builder.
      parserContext - The parser context.
      headerMapperBuilder - The header mapper builder.
      replyHeaderValueArg - The reply header value.

    • configureTransactionAttributes

      public static BeanDefinition configureTransactionAttributes(Element txElement)
      Parse a "transactional" element and configure a TransactionInterceptor with "transactionManager" and other "transactionDefinition" properties. For example, this advisor will be applied on the Polling Task proxy.
      Parameters:
      txElement - The transactional element.
      Returns:
      The bean definition.
      See Also:

    • configureTransactionAttributes

      public static BeanDefinition configureTransactionAttributes(Element txElement, boolean handleMessageAdvice)
      Parse a "transactional" element and configure a TransactionInterceptor or TransactionHandleMessageAdvice with "transactionManager" and other "transactionDefinition" properties. For example, this advisor will be applied on the Polling Task proxy.
      Parameters:
      txElement - The transactional element.
      handleMessageAdvice - flag if to use TransactionHandleMessageAdvice or regular TransactionInterceptor
      Returns:
      The bean definition.
      See Also:

    • configureTransactionDefinition

      public static BeanDefinition configureTransactionDefinition(Element txElement)
      Parse attributes of "transactional" element and configure a DefaultTransactionAttribute with provided "transactionDefinition" properties.
      Parameters:
      txElement - The transactional element.
      Returns:
      The bean definition.

    • generateAlias

      public static String @Nullable [] generateAlias(Element element)

    • configureAndSetAdviceChainIfPresent

      public static void configureAndSetAdviceChainIfPresent(@Nullable Element adviceChainElement, @Nullable Element txElement, BeanDefinition parentBeanDefinition, ParserContext parserContext)

    • configureAndSetAdviceChainIfPresent

      public static void configureAndSetAdviceChainIfPresent(@Nullable Element adviceChainElement, @Nullable Element txElement, boolean handleMessageAdvice, BeanDefinition parentBeanDefinition, ParserContext parserContext)

    • configureAndSetAdviceChainIfPresent

      public static void configureAndSetAdviceChainIfPresent(@Nullable Element adviceChainElement, @Nullable Element txElement, BeanDefinition parentBeanDefinition, ParserContext parserContext, String propertyName)

    • configureAndSetAdviceChainIfPresent

      public static void configureAndSetAdviceChainIfPresent(@Nullable Element adviceChainElement, @Nullable Element txElement, boolean handleMessageAdvice, BeanDefinition parentBeanDefinition, ParserContext parserContext, String propertyName)

    • configureAdviceChain

      public static ManagedList configureAdviceChain(@Nullable Element adviceChainElement, @Nullable Element txElement, BeanDefinition parentBeanDefinition, ParserContext parserContext)

    • configureAdviceChain

      public static ManagedList configureAdviceChain(@Nullable Element adviceChainElement, @Nullable Element txElement, boolean handleMessageAdvice, BeanDefinition parentBeanDefinition, ParserContext parserContext)

    • createExpressionDefinitionFromValueOrExpression

      public static @Nullable BeanDefinition createExpressionDefinitionFromValueOrExpression(String valueElementName, String expressionElementName, ParserContext parserContext, Element element, boolean oneRequired)

    • createExpressionDefIfAttributeDefined

      public static @Nullable BeanDefinition createExpressionDefIfAttributeDefined(String expressionElementName, Element element)

    • createDirectChannel

      public static String createDirectChannel(Element element, ParserContext parserContext)

    • checkAndConfigureFixedSubscriberChannel

      public static void checkAndConfigureFixedSubscriberChannel(Element element, ParserContext parserContext, String channelName, String handlerBeanName)

    • injectPropertyWithAdapter

      public static void injectPropertyWithAdapter(String beanRefAttribute, String methodRefAttribute, String expressionAttribute, String beanProperty, String adapterClass, Element element, BeanDefinitionBuilder builder, @Nullable BeanMetadataElement processor, ParserContext parserContext)

    • injectConstructorWithAdapter

      public static void injectConstructorWithAdapter(String beanRefAttribute, String methodRefAttribute, String expressionAttribute, String adapterClass, Element element, BeanDefinitionBuilder builder, @Nullable BeanMetadataElement processor, ParserContext parserContext)