org.springframework.integration.config.xml.SpelPropertyAccessorsParser Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of spring-integration-core Show documentation
Spring Integration Core
There is a newer version: 6.3.3
Show newest version
/*
 * Copyright 2013-2019 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
 *
 *      https://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 java.util.Map;

import org.w3c.dom.Element;
import org.w3c.dom.Node;
import org.w3c.dom.NodeList;

import org.springframework.beans.factory.config.BeanDefinition;
import org.springframework.beans.factory.config.BeanReference;
import org.springframework.beans.factory.support.BeanDefinitionBuilder;
import org.springframework.beans.factory.support.ManagedMap;
import org.springframework.beans.factory.xml.BeanDefinitionParser;
import org.springframework.beans.factory.xml.BeanDefinitionParserDelegate;
import org.springframework.beans.factory.xml.ParserContext;
import org.springframework.integration.context.IntegrationContextUtils;
import org.springframework.integration.expression.SpelPropertyAccessorRegistrar;
import org.springframework.util.StringUtils;

/**
 * Parser for the <spel-property-accessors> element.
 *
 * @author Artem Bilan
 * @author Gary Russell
 * @since 3.0
 */
public class SpelPropertyAccessorsParser implements BeanDefinitionParser {

	private final Map propertyAccessors = new ManagedMap();

	@Override
	public BeanDefinition parse(Element element, ParserContext parserContext) {
		initializeSpelPropertyAccessorRegistrarIfNecessary(parserContext);

		BeanDefinitionParserDelegate delegate = parserContext.getDelegate();

		NodeList children = element.getChildNodes();

		for (int i = 0; i < children.getLength(); i++) {
			Node node = children.item(i);
			String propertyAccessorName;
			Object propertyAccessor;
			if (node instanceof Element &&
					!delegate.nodeNameEquals(node, BeanDefinitionParserDelegate.DESCRIPTION_ELEMENT)) {
				Element ele = (Element) node;

				if (delegate.nodeNameEquals(ele, BeanDefinitionParserDelegate.BEAN_ELEMENT)) {
					propertyAccessorName = ele.getAttribute(BeanDefinitionParserDelegate.ID_ATTRIBUTE);
					if (!StringUtils.hasText(propertyAccessorName)) {
						parserContext.getReaderContext()
								.error("The '' 'id' attribute is required within 'spel-property-accessors'.", ele);
						return null;
					}
					propertyAccessor = delegate.parseBeanDefinitionElement(ele);
				}
				else if (delegate.nodeNameEquals(ele, BeanDefinitionParserDelegate.REF_ELEMENT)) {
					BeanReference propertyAccessorRef = (BeanReference) delegate.parsePropertySubElement(ele, null);
					propertyAccessorName = propertyAccessorRef.getBeanName(); // NOSONAR not null
					propertyAccessor = propertyAccessorRef;
				}
				else {
					parserContext.getReaderContext().error("Only '' and '' elements are allowed.", element);
					return null;
				}

				this.propertyAccessors.put(propertyAccessorName, propertyAccessor);
			}
		}

		return null;
	}

	private synchronized void initializeSpelPropertyAccessorRegistrarIfNecessary(ParserContext parserContext) {
		if (!parserContext.getRegistry()
				.containsBeanDefinition(IntegrationContextUtils.SPEL_PROPERTY_ACCESSOR_REGISTRAR_BEAN_NAME)) {

			BeanDefinitionBuilder registrarBuilder = BeanDefinitionBuilder
					.genericBeanDefinition(SpelPropertyAccessorRegistrar.class)
					.setRole(BeanDefinition.ROLE_INFRASTRUCTURE)
					.addConstructorArgValue(this.propertyAccessors);
			parserContext.getRegistry()
					.registerBeanDefinition(IntegrationContextUtils.SPEL_PROPERTY_ACCESSOR_REGISTRAR_BEAN_NAME,
							registrarBuilder.getBeanDefinition());
		}
	}

}