001 /**
002 * Licensed to the Apache Software Foundation (ASF) under one or more
003 * contributor license agreements. See the NOTICE file distributed with
004 * this work for additional information regarding copyright ownership.
005 * The ASF licenses this file to You under the Apache License, Version 2.0
006 * (the "License"); you may not use this file except in compliance with
007 * the License. You may obtain a copy of the License at
008 *
009 * http://www.apache.org/licenses/LICENSE-2.0
010 *
011 * Unless required by applicable law or agreed to in writing, software
012 * distributed under the License is distributed on an "AS IS" BASIS,
013 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
014 * See the License for the specific language governing permissions and
015 * limitations under the License.
016 */
017 package org.apache.camel.spring.handler;
018
019 import java.util.HashMap;
020 import java.util.HashSet;
021 import java.util.Map;
022 import java.util.Set;
023
024 import javax.xml.bind.Binder;
025 import javax.xml.bind.JAXBContext;
026 import javax.xml.bind.JAXBException;
027
028 import org.w3c.dom.Element;
029 import org.w3c.dom.Node;
030 import org.w3c.dom.NodeList;
031
032 import org.apache.camel.builder.xml.Namespaces;
033 import org.apache.camel.model.dataformat.ArtixDSDataFormat;
034 import org.apache.camel.model.dataformat.JaxbDataFormat;
035 import org.apache.camel.model.dataformat.SerializationDataFormat;
036 import org.apache.camel.model.dataformat.XMLBeansDataFormat;
037 import org.apache.camel.model.loadbalancer.RandomLoadBalanceStrategy;
038 import org.apache.camel.model.loadbalancer.RoundRobinLoadBalanceStrategy;
039 import org.apache.camel.model.loadbalancer.StickyLoadBalanceStrategy;
040 import org.apache.camel.model.loadbalancer.TopicLoadBalanceStrategy;
041 import org.apache.camel.spi.NamespaceAware;
042 import org.apache.camel.spring.CamelBeanPostProcessor;
043 import org.apache.camel.spring.CamelContextFactoryBean;
044 import org.apache.camel.spring.CamelJMXAgentType;
045 import org.apache.camel.spring.CamelTemplateFactoryBean;
046 import org.apache.camel.spring.EndpointFactoryBean;
047 import org.apache.camel.spring.remoting.CamelProxyFactoryBean;
048 import org.apache.camel.spring.remoting.CamelServiceExporter;
049 import org.apache.camel.util.ObjectHelper;
050 import org.apache.camel.view.ModelFileGenerator;
051 import org.springframework.beans.factory.BeanDefinitionStoreException;
052 import org.springframework.beans.factory.config.BeanDefinition;
053 import org.springframework.beans.factory.config.RuntimeBeanReference;
054 import org.springframework.beans.factory.parsing.BeanComponentDefinition;
055 import org.springframework.beans.factory.support.BeanDefinitionBuilder;
056 import org.springframework.beans.factory.xml.NamespaceHandlerSupport;
057 import org.springframework.beans.factory.xml.ParserContext;
058
059
060 /**
061 * Camel namespace for the spring XML configuration file.
062 */
063 public class CamelNamespaceHandler extends NamespaceHandlerSupport {
064
065 protected BeanDefinitionParser endpointParser = new BeanDefinitionParser(EndpointFactoryBean.class);
066 protected BeanDefinitionParser beanPostProcessorParser = new BeanDefinitionParser(CamelBeanPostProcessor.class);
067 protected Set<String> parserElementNames = new HashSet<String>();
068 protected Binder<Node> binder;
069 private JAXBContext jaxbContext;
070 private Map<String, BeanDefinitionParser> parserMap = new HashMap<String, BeanDefinitionParser>();
071
072
073 public ModelFileGenerator createModelFileGenerator() throws JAXBException {
074 return new ModelFileGenerator(getJaxbContext());
075 }
076
077
078 public void init() {
079 // remoting
080 addBeanDefinitionParser("proxy", CamelProxyFactoryBean.class);
081 addBeanDefinitionParser("template", CamelTemplateFactoryBean.class);
082 addBeanDefinitionParser("export", CamelServiceExporter.class);
083
084 // data types
085 addBeanDefinitionParser("artixDS", ArtixDSDataFormat.class);
086 addBeanDefinitionParser("jaxb", JaxbDataFormat.class);
087 addBeanDefinitionParser("serialization", SerializationDataFormat.class);
088 addBeanDefinitionParser("xmlBeans", XMLBeansDataFormat.class);
089
090 // load balancers
091 addBeanDefinitionParser("roundRobin", RoundRobinLoadBalanceStrategy.class);
092 addBeanDefinitionParser("random", RandomLoadBalanceStrategy.class);
093 addBeanDefinitionParser("sticky", StickyLoadBalanceStrategy.class);
094 addBeanDefinitionParser("topic", TopicLoadBalanceStrategy.class);
095
096 // jmx agent
097 addBeanDefinitionParser("jmxAgent", CamelJMXAgentType.class);
098
099 // TODO switch to use the above mechanism?
100 registerParser("endpoint", endpointParser);
101
102 Class cl = CamelContextFactoryBean.class;
103 try {
104 cl = Class.forName("org.apache.camel.osgi.CamelContextFactoryBean");
105 } catch (Throwable t) {
106 }
107 registerParser("camelContext", new CamelContextBeanDefinitionParser(cl));
108 }
109
110 private void addBeanDefinitionParser(String elementName, Class<?> type) {
111 BeanDefinitionParser parser = new BeanDefinitionParser(type);
112 registerParser(elementName, parser);
113 parserMap.put(elementName, parser);
114 }
115
116 protected void createBeanPostProcessor(ParserContext parserContext, String contextId, Element childElement, BeanDefinitionBuilder parentBuilder) {
117 String beanPostProcessorId = contextId + ":beanPostProcessor";
118 childElement.setAttribute("id", beanPostProcessorId);
119 BeanDefinition definition = beanPostProcessorParser.parse(childElement, parserContext);
120 definition.getPropertyValues().addPropertyValue("camelContext", new RuntimeBeanReference(contextId));
121 parentBuilder.addPropertyReference("beanPostProcessor", beanPostProcessorId);
122 }
123
124 protected void registerScriptParser(String elementName, String engineName) {
125 registerParser(elementName, new ScriptDefinitionParser(engineName));
126 }
127
128 protected void registerParser(String name,
129 org.springframework.beans.factory.xml.BeanDefinitionParser parser) {
130 parserElementNames.add(name);
131 registerBeanDefinitionParser(name, parser);
132 }
133
134 public Set<String> getParserElementNames() {
135 return parserElementNames;
136 }
137
138 protected Object parseUsingJaxb(Element element, ParserContext parserContext) {
139 try {
140 binder = getJaxbContext().createBinder();
141 return binder.unmarshal(element);
142 /*
143 * Unmarshaller unmarshaller =
144 * getJaxbContext().createUnmarshaller(); return
145 * unmarshaller.unmarshal(element);
146 */
147 } catch (JAXBException e) {
148 throw new BeanDefinitionStoreException("Failed to parse JAXB element: " + e, e);
149 }
150 }
151
152 public JAXBContext getJaxbContext() throws JAXBException {
153 if (jaxbContext == null) {
154 jaxbContext = createJaxbContext();
155 }
156 return jaxbContext;
157 }
158
159 protected JAXBContext createJaxbContext() throws JAXBException {
160 StringBuilder packages = new StringBuilder();
161 for (Class cl : getJaxbPackages()) {
162 if (packages.length() > 0) {
163 packages.append(":");
164 }
165 packages.append(cl.getName().substring(0, cl.getName().lastIndexOf('.')));
166 }
167 return JAXBContext.newInstance(packages.toString(), getClass().getClassLoader());
168 }
169
170 protected Set<Class> getJaxbPackages() {
171 Set<Class> classes = new HashSet<Class>();
172 classes.add(org.apache.camel.spring.CamelContextFactoryBean.class);
173 classes.add(org.apache.camel.model.RouteType.class);
174 classes.add(org.apache.camel.model.config.StreamResequencerConfig.class);
175 classes.add(org.apache.camel.model.dataformat.DataFormatType.class);
176 classes.add(org.apache.camel.model.language.ExpressionType.class);
177 classes.add(org.apache.camel.model.loadbalancer.LoadBalancerType.class);
178 return classes;
179 }
180
181 protected class CamelContextBeanDefinitionParser extends BeanDefinitionParser {
182 public CamelContextBeanDefinitionParser(Class type) {
183 super(type);
184 }
185
186 @Override
187 protected void doParse(Element element, ParserContext parserContext, BeanDefinitionBuilder builder) {
188 super.doParse(element, parserContext, builder);
189
190 String contextId = element.getAttribute("id");
191
192 // lets avoid folks having to explicitly give an ID to a camel
193 // context
194 if (ObjectHelper.isNullOrBlank(contextId)) {
195 contextId = "camelContext";
196 element.setAttribute("id", contextId);
197 }
198
199 // now lets parse the routes
200 Object value = parseUsingJaxb(element, parserContext);
201 if (value instanceof CamelContextFactoryBean) {
202 CamelContextFactoryBean factoryBean = (CamelContextFactoryBean)value;
203 builder.addPropertyValue("id", contextId);
204 builder.addPropertyValue("routes", factoryBean.getRoutes());
205 builder.addPropertyValue("intercepts", factoryBean.getIntercepts());
206 builder.addPropertyValue("dataFormats", factoryBean.getDataFormats());
207 builder.addPropertyValue("builderRefs", factoryBean.getBuilderRefs());
208
209 if (factoryBean.getPackages().length > 0) {
210 builder.addPropertyValue("packages", factoryBean.getPackages());
211 }
212 }
213
214 boolean createdBeanPostProcessor = false;
215 NodeList list = element.getChildNodes();
216 int size = list.getLength();
217 for (int i = 0; i < size; i++) {
218 Node child = list.item(i);
219 if (child instanceof Element) {
220 Element childElement = (Element)child;
221 String localName = child.getLocalName();
222 if (localName.equals("beanPostProcessor")) {
223 createBeanPostProcessor(parserContext, contextId, childElement, builder);
224 createdBeanPostProcessor = true;
225 } else if (localName.equals("endpoint")) {
226 BeanDefinition definition = endpointParser.parse(childElement, parserContext);
227 String id = childElement.getAttribute("id");
228 if (ObjectHelper.isNotNullAndNonEmpty(id)) {
229 // TODO we can zap this?
230 definition.getPropertyValues()
231 .addPropertyValue("camelContext", new RuntimeBeanReference(contextId));
232 // definition.getPropertyValues().addPropertyValue("context",
233 // builder.getBeanDefinition());
234 parserContext.registerComponent(new BeanComponentDefinition(definition, id));
235 }
236 } else {
237 BeanDefinitionParser parser = parserMap.get(localName);
238 if (parser != null) {
239 BeanDefinition definition = parser.parse(childElement, parserContext);
240 String id = childElement.getAttribute("id");
241 if (ObjectHelper.isNotNullAndNonEmpty(id)) {
242 parserContext.registerComponent(new BeanComponentDefinition(definition, id));
243 if (localName.equals("jmxAgent")) {
244 builder.addPropertyReference("camelJMXAgent", id);
245 }
246 }
247 }
248
249 }
250 }
251 }
252 // lets inject the namespaces into any namespace aware POJOs
253 injectNamespaces(element);
254 if (!createdBeanPostProcessor) {
255 // no bean processor element so lets create it by ourself
256 Element childElement = element.getOwnerDocument().createElement("beanPostProcessor");
257 element.appendChild(childElement);
258 createBeanPostProcessor(parserContext, contextId, childElement, builder);
259 }
260 }
261 }
262
263 protected void injectNamespaces(Element element) {
264 NodeList list = element.getChildNodes();
265 Namespaces namespaces = null;
266 int size = list.getLength();
267 for (int i = 0; i < size; i++) {
268 Node child = list.item(i);
269 if (child instanceof Element) {
270 Element childElement = (Element)child;
271 Object object = binder.getJAXBNode(child);
272 if (object instanceof NamespaceAware) {
273 NamespaceAware namespaceAware = (NamespaceAware)object;
274 if (namespaces == null) {
275 namespaces = new Namespaces(element);
276 }
277 namespaces.configure(namespaceAware);
278 }
279 injectNamespaces(childElement);
280 }
281 }
282 }
283 }