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.component.xslt;
018
019 import java.util.Map;
020 import javax.xml.transform.TransformerFactory;
021 import javax.xml.transform.URIResolver;
022
023 import org.apache.camel.Endpoint;
024 import org.apache.camel.builder.xml.ResultHandlerFactory;
025 import org.apache.camel.builder.xml.XsltBuilder;
026 import org.apache.camel.builder.xml.XsltUriResolver;
027 import org.apache.camel.component.ResourceBasedComponent;
028 import org.apache.camel.converter.jaxp.XmlConverter;
029 import org.apache.camel.impl.ProcessorEndpoint;
030 import org.apache.camel.util.ObjectHelper;
031 import org.springframework.core.io.Resource;
032
033 /**
034 * An <a href="http://camel.apache.org/xslt.html">XSLT Component</a>
035 * for performing XSLT transforms of messages
036 *
037 * @version $Revision: 928841 $
038 */
039 public class XsltComponent extends ResourceBasedComponent {
040 private XmlConverter xmlConverter;
041 private URIResolver uriResolver;
042
043 public XmlConverter getXmlConverter() {
044 return xmlConverter;
045 }
046
047 public void setXmlConverter(XmlConverter xmlConverter) {
048 this.xmlConverter = xmlConverter;
049 }
050
051 public URIResolver getUriResolver() {
052 return uriResolver;
053 }
054
055 public void setUriResolver(URIResolver uriResolver) {
056 this.uriResolver = uriResolver;
057 }
058
059 protected Endpoint createEndpoint(String uri, String remaining, Map<String, Object> parameters) throws Exception {
060 Resource resource = resolveMandatoryResource(remaining);
061 if (log.isDebugEnabled()) {
062 log.debug(this + " using schema resource: " + resource);
063 }
064 XsltBuilder xslt = getCamelContext().getInjector().newInstance(XsltBuilder.class);
065
066 // lets allow the converter to be configured
067 XmlConverter converter = resolveAndRemoveReferenceParameter(parameters, "converter", XmlConverter.class);
068 if (converter == null) {
069 converter = getXmlConverter();
070 }
071 if (converter != null) {
072 xslt.setConverter(converter);
073 }
074
075 String transformerFactoryClassName = getAndRemoveParameter(parameters, "transformerFactoryClass", String.class);
076 TransformerFactory factory = null;
077 if (transformerFactoryClassName != null) {
078 // provide the class loader of this component to work in OSGi environments
079 Class<?> factoryClass = getCamelContext().getClassResolver().resolveClass(transformerFactoryClassName, XsltComponent.class.getClassLoader());
080 if (factoryClass != null) {
081 factory = (TransformerFactory) getCamelContext().getInjector().newInstance(factoryClass);
082 } else {
083 log.warn("Cannot find the TransformerFactoryClass with the class name: " + transformerFactoryClassName);
084 }
085 }
086
087 if (parameters.get("transformerFactory") != null) {
088 factory = resolveAndRemoveReferenceParameter(parameters, "transformerFactory", TransformerFactory.class);
089 }
090
091 if (factory != null) {
092 xslt.getConverter().setTransformerFactory(factory);
093 }
094
095 // lookup custom resolver to use
096 URIResolver resolver = resolveAndRemoveReferenceParameter(parameters, "uriResolver", URIResolver.class);
097 if (resolver == null) {
098 // not in endpoint then use component specific resolver
099 resolver = getUriResolver();
100 }
101 if (resolver == null) {
102 // fallback to use a Camel specific resolver
103 resolver = new XsltUriResolver(getCamelContext().getClassResolver(), remaining);
104 }
105 // set resolver before input stream as resolver is used when loading the input stream
106 xslt.setUriResolver(resolver);
107
108 ResultHandlerFactory resultHandlerFactory = resolveAndRemoveReferenceParameter(parameters, "resultHandlerFactory", ResultHandlerFactory.class);
109 if (resultHandlerFactory != null) {
110 xslt.setResultHandlerFactory(resultHandlerFactory);
111 }
112
113 Boolean failOnNullBody = getAndRemoveParameter(parameters, "failOnNullBody", Boolean.class);
114 if (failOnNullBody != null) {
115 xslt.setFailOnNullBody(failOnNullBody);
116 }
117 String output = getAndRemoveParameter(parameters, "output", String.class);
118 configureOutput(xslt, output);
119
120 xslt.setTransformerInputStream(resource.getInputStream());
121 configureXslt(xslt, uri, remaining, parameters);
122 return new ProcessorEndpoint(uri, this, xslt);
123 }
124
125 protected void configureXslt(XsltBuilder xslt, String uri, String remaining, Map<String, Object> parameters) throws Exception {
126 setProperties(xslt, parameters);
127 }
128
129 protected void configureOutput(XsltBuilder xslt, String output) throws Exception {
130 if (ObjectHelper.isEmpty(output)) {
131 return;
132 }
133
134 if ("string".equalsIgnoreCase(output)) {
135 xslt.outputString();
136 } else if ("bytes".equalsIgnoreCase(output)) {
137 xslt.outputBytes();
138 } else if ("DOM".equalsIgnoreCase(output)) {
139 xslt.outputDOM();
140 } else if ("file".equalsIgnoreCase(output)) {
141 xslt.outputFile();
142 } else {
143 throw new IllegalArgumentException("Unknown output type: " + output);
144 }
145 }
146
147 }