001 /*
002 GRANITE DATA SERVICES
003 Copyright (C) 2011 GRANITE DATA SERVICES S.A.S.
004
005 This file is part of Granite Data Services.
006
007 Granite Data Services is free software; you can redistribute it and/or modify
008 it under the terms of the GNU Library General Public License as published by
009 the Free Software Foundation; either version 2 of the License, or (at your
010 option) any later version.
011
012 Granite Data Services is distributed in the hope that it will be useful, but
013 WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
014 FITNESS FOR A PARTICULAR PURPOSE. See the GNU Library General Public License
015 for more details.
016
017 You should have received a copy of the GNU Library General Public License
018 along with this library; if not, see <http://www.gnu.org/licenses/>.
019 */
020
021 package org.granite.spring;
022
023 import java.util.HashMap;
024 import java.util.List;
025 import java.util.Map;
026
027 import org.springframework.beans.factory.config.BeanDefinition;
028 import org.springframework.beans.factory.parsing.BeanComponentDefinition;
029 import org.springframework.beans.factory.parsing.CompositeComponentDefinition;
030 import org.springframework.beans.factory.support.BeanDefinitionBuilder;
031 import org.springframework.beans.factory.support.ManagedList;
032 import org.springframework.beans.factory.xml.AbstractSingleBeanDefinitionParser;
033 import org.springframework.beans.factory.xml.ParserContext;
034 import org.springframework.core.Conventions;
035 import org.springframework.util.StringUtils;
036 import org.springframework.util.xml.DomUtils;
037 import org.w3c.dom.Element;
038
039 /**
040 * @author William Drai
041 */
042 public class FlexFilterBeanDefinitionParser extends AbstractSingleBeanDefinitionParser {
043
044 private static final String DEFAULT_HANDLER_MAPPING_CLASS_NAME = "org.springframework.web.servlet.handler.SimpleUrlHandlerMapping";
045
046
047 @Override
048 @SuppressWarnings("unchecked")
049 protected void doParse(Element element, ParserContext parserContext, BeanDefinitionBuilder builder) {
050 CompositeComponentDefinition componentDefinition = new CompositeComponentDefinition(element.getLocalName(),
051 parserContext.extractSource(element));
052 parserContext.pushContainingComponent(componentDefinition);
053
054 // Set the default ID if necessary
055 if (!StringUtils.hasText(element.getAttribute(ID_ATTRIBUTE)))
056 element.setAttribute(ID_ATTRIBUTE, "org.granite.spring.FlexFilter");
057
058 mapOptionalAttributes(element, parserContext, builder, "tide");
059
060 Object source = parserContext.extractSource(element);
061
062 ManagedList roles = new ManagedList();
063 roles.setSource(source);
064 List<Element> rolesElements = DomUtils.getChildElementsByTagName(element, "tide-roles");
065 for (Element rolesElement : rolesElements) {
066 List<Element> valueElements = DomUtils.getChildElementsByTagName(rolesElement, "value");
067 for (Element valueElement : valueElements)
068 roles.add(valueElement.getTextContent());
069 }
070 if (!roles.isEmpty())
071 builder.addPropertyValue("tideRoles", roles);
072
073 ManagedList tideAnnotations = new ManagedList();
074 tideAnnotations.setSource(source);
075 List<Element> tideAnnotationsElements = DomUtils.getChildElementsByTagName(element, "tide-annotations");
076 for (Element tideAnnotationsElement : tideAnnotationsElements) {
077 List<Element> valueElements = DomUtils.getChildElementsByTagName(tideAnnotationsElement, "value");
078 for (Element valueElement : valueElements)
079 tideAnnotations.add(valueElement.getTextContent());
080 }
081 builder.addPropertyValue("tideAnnotations", tideAnnotations);
082
083 ManagedList tideInterfaces = new ManagedList();
084 tideInterfaces.setSource(source);
085 List<Element> tideInterfacesElements = DomUtils.getChildElementsByTagName(element, "tide-interfaces");
086 for (Element tideInterfacesElement : tideInterfacesElements) {
087 List<Element> valueElements = DomUtils.getChildElementsByTagName(tideInterfacesElement, "value");
088 for (Element valueElement : valueElements)
089 tideInterfaces.add(valueElement.getTextContent());
090 }
091 builder.addPropertyValue("tideInterfaces", tideInterfaces);
092
093 ManagedList tideNames = new ManagedList();
094 tideNames.setSource(source);
095 List<Element> tideNamesElements = DomUtils.getChildElementsByTagName(element, "tide-names");
096 for (Element tideNamesElement : tideNamesElements) {
097 List<Element> valueElements = DomUtils.getChildElementsByTagName(tideNamesElement, "value");
098 for (Element valueElement : valueElements)
099 tideNames.add(valueElement.getTextContent());
100 }
101 builder.addPropertyValue("tideNames", tideNames);
102
103 ManagedList tideTypes = new ManagedList();
104 tideTypes.setSource(source);
105 List<Element> tideTypesElements = DomUtils.getChildElementsByTagName(element, "tide-types");
106 for (Element tideTypesElement : tideTypesElements) {
107 List<Element> valueElements = DomUtils.getChildElementsByTagName(tideTypesElement, "value");
108 for (Element valueElement : valueElements)
109 tideTypes.add(valueElement.getTextContent());
110 }
111 builder.addPropertyValue("tideTypes", tideTypes);
112
113 ManagedList exceptionConverters = new ManagedList();
114 exceptionConverters.setSource(source);
115 List<Element> exceptionConvertersElements = DomUtils.getChildElementsByTagName(element, "exception-converters");
116 for (Element exceptionConvertersElement : exceptionConvertersElements) {
117 List<Element> valueElements = DomUtils.getChildElementsByTagName(exceptionConvertersElement, "value");
118 for (Element valueElement : valueElements)
119 exceptionConverters.add(valueElement.getTextContent());
120 }
121 builder.addPropertyValue("exceptionConverters", exceptionConverters);
122
123 Element amf3MessageInterceptor = DomUtils.getChildElementByTagName(element, "amf3-message-interceptor");
124 if (amf3MessageInterceptor != null)
125 builder.addPropertyReference("amf3MessageInterceptor", amf3MessageInterceptor.getTextContent());
126
127 configureGraniteDS(element, parserContext, DomUtils.getChildElementByTagName(element, "granite-config"));
128
129 registerHandlerMappings(element, parserContext, element.getAttribute("url-pattern"));
130
131 parserContext.popAndRegisterContainingComponent();
132 }
133
134 @Override
135 protected String getBeanClassName(Element element) {
136 return "org.granite.spring.FlexFilter";
137 }
138
139 private void configureGraniteDS(Element parent, ParserContext parserContext, Element graniteConfigElement) {
140 if (parserContext.getRegistry().containsBeanDefinition("org.granite.spring.SpringGraniteConfig"))
141 return;
142
143 Element source = graniteConfigElement != null ? graniteConfigElement : parent;
144
145 BeanDefinitionBuilder graniteConfigBuilder = BeanDefinitionBuilder.genericBeanDefinition("org.granite.spring.SpringGraniteConfig");
146
147 registerInfrastructureComponent(source, parserContext, graniteConfigBuilder,
148 parent.getAttribute(ID_ATTRIBUTE) + "_graniteConfig");
149 }
150
151 @SuppressWarnings({ "unchecked", "rawtypes" })
152 private void registerHandlerMappings(Element parent, ParserContext parserContext, String urlPattern) {
153 BeanDefinitionBuilder handlerMappingBuilder = BeanDefinitionBuilder.genericBeanDefinition(DEFAULT_HANDLER_MAPPING_CLASS_NAME);
154
155 Map mappings = new HashMap();
156 if (urlPattern != null)
157 mappings.put(urlPattern, parent.getAttribute(ID_ATTRIBUTE));
158
159 handlerMappingBuilder.addPropertyValue("urlMap", mappings);
160 registerInfrastructureComponent(parent, parserContext, handlerMappingBuilder,
161 parent.getAttribute(ID_ATTRIBUTE) + "_handlerMapping");
162 }
163
164
165 // From Spring-Flex
166
167 static void registerInfrastructureComponent(Element element, ParserContext parserContext, BeanDefinitionBuilder componentBuilder, String beanName) {
168 componentBuilder.getRawBeanDefinition().setSource(parserContext.extractSource(element));
169 componentBuilder.getRawBeanDefinition().setRole(BeanDefinition.ROLE_INFRASTRUCTURE);
170 parserContext.registerBeanComponent(new BeanComponentDefinition(componentBuilder.getBeanDefinition(), beanName));
171 }
172
173 static void mapOptionalAttributes(Element element, ParserContext parserContext, BeanDefinitionBuilder builder, String... attrs) {
174 for (String attr : attrs) {
175 String value = element.getAttribute(attr);
176 if (StringUtils.hasText(value)) {
177 String propertyName = Conventions.attributeNameToPropertyName(attr);
178 if (validateProperty(element, parserContext, propertyName, attr)) {
179 builder.addPropertyValue(propertyName, value);
180 }
181 }
182 }
183 }
184
185 private static boolean validateProperty(Element element, ParserContext parserContext, String propertyName, String attr) {
186 if (!StringUtils.hasText(propertyName)) {
187 parserContext.getReaderContext().error(
188 "Illegal property name trying to convert from attribute '" + attr + "' : cannot be null or empty.",
189 parserContext.extractSource(element));
190 return false;
191 }
192 return true;
193 }
194 }