...
Here are some example URIs
Div |
---|
class | confluenceTableSmall |
---|
|
Wiki Markup |
---|
{div:class=confluenceTableSmall}
|| URI || Description ||
| {code}xslt:com/acme/mytransform.xsl |
|
{code} | refers to the file | refers to the file com/acme/mytransform.xsl |
classpath |
| {code}classpath | Code Block |
---|
xslt:file:///foo/bar.xsl |
|
{code} | refers to the file | refers to the file /foo/bar.xsl |
|
| {code} | Code Block |
---|
xslt:http://acme.com/cheese/foo.xsl |
|
{code} | refers to the remote http resource |
{div} | refers to the remote http resource |
|
Maven users will need to add the following dependency to their pom.xml
for this component when using Camel 2.8 or older:
...
From Camel 2.9 onwards the XSLT component is provided directly in the camel-core.
Options
Div |
---|
class | confluenceTableSmall |
---|
|
Wiki Markup |
---|
{div:class=confluenceTableSmall}
|| Name || Default Value || Description ||
| {{converter}} | {{null}} | Option to override default [XmlConverter|http://camel.apache.org/maven/current/camel-core/apidocs/org/apache/camel/converter/jaxp/XmlConverter.html]. Will lookup for the converter in the [Registry]. The provided converted must be of type org.apache.camel.converter.jaxp.XmlConverter. |
| {{transformerFactory}} | {{null}} | Option to override default [TransformerFactory|http://java.sun.com/j2se/1.5.0/docs/api/javax/xml/transform/TransformerFactory.html]. Will lookup for the transformerFactory in the [Registry]. The provided transformer factory must be of type javax.xml.transform.TransformerFactory. |
| {{transformerFactoryClass}} | {{null}} | Option to override default [TransformerFactory|http://java.sun.com/j2se/1.5.0/docs/api/javax/xml/transform/TransformerFactory.html]. Will create a TransformerFactoryClass instance and set it to the converter. |
| {{uriResolver}} | {{null}} | *Camel 2.3*: Allows you to use a custom {{javax.xml.transformation.URIResolver}}. Camel will by default use its own implementation {{Name | Default Value | Description |
---|
converter
| null
| Option to override default XmlConverter. Will lookup for the converter in the Registry. The provided converted must be of type org.apache.camel.converter.jaxp.XmlConverter. | transformerFactory
| null
| Option to override default TransformerFactory. Will lookup for the transformerFactory in the Registry. The provided transformer factory must be of type javax.xml.transform.TransformerFactory. | transformerFactoryClass
| null
| Option to override default TransformerFactory. Will create a TransformerFactoryClass instance and set it to the converter. | uriResolverFactory
| DefaultXsltUriResolverFactory
| Camel 2.17: Reference to a org.apache.camel.component. xslt . XsltUriResolverFactory which creates an URI resolver per endpoint. The default implementation returns an instance of org.apache.camel.component.xslt. DefaultXsltUriResolverFactory which creates the default URI resolver org.apache.camel.builder.xml .XsltUriResolver per endpoint. The default URI resolver reads XSLT documents from the classpath and the file system. This option instead of the option uriResolver shall be used when the URI resolver depends on the resource URI of the root XSLT document specified in the endpoint; for example, if you want to extend the default URI resolver. This option is also available on the XSLT component, so that you can set the resource resolver factory only once for all endpoints. | uriResolver
| null
| Camel 2.3: Allows you to use a custom javax.xml.transformation.URIResolver . Camel will by default use its own implementation |
org.apache.camel.builder.xml.XsltUriResolver
|
}} |
| {{resultHandlerFactory}} | {{null}} | *Camel | resultHandlerFactory
| null
| Camel 2.3: |
* {{org.apache.camel.builder.xml.ResultHandlerFactory
|
}} {{org.apache.camel.builder.xml.ResultHandler
|
}} types. |
| {{failOnNullBody}} | {{true}} | *Camel types. | failOnNullBody
| true
| Camel 2.3: |
* |
| {{deleteOutputFile}} | {{false}} | *Camel 2 | deleteOutputFile
| false
| Camel 2.6: |
* {{}} [] |
| {{output}} | {{string}} | *Camel * {{ }} {{}} {{}} {{}} ** {{}} {{}} |
| {{contentCache}} | {{true}} | *Camel | contentCache
| true
| Camel 2.6: |
* {{}}
* * {{}} |
| {{allowStAX}} | | *Camel | allowStAX
| | Camel 2.8.3/2.9: |
* {{javax.xml.transform.Source
|
}} {{}} {{}} |
| {{transformerCacheSize}} | {{0}} | *Camel | transformerCacheSize
| 0
| Camel 2.9.3/2.10.1: |
* {{javax.xml.transform.Transformer
|
}} {{Template.newTransformer()
|
}}. |
| {{saxon}} | {{false}} | *Camel * the {{transformerFactoryClass}}. If enabled then the class {{the transformerFactoryClass . If enabled then the class net.sf.saxon.TransformerFactoryImpl |
}} |
{div} |
Using XSLT endpoints
For example you could use something like
Code Block |
---|
from("activemq:My.Queue").
to("xslt:com/acme/mytransform.xsl");
|
To use an XSLT template to formulate a response for a message for InOut message exchanges (where there is a JMSReplyTo
header).
If you want to use InOnly and consume the message and send it to another destination you could use the following route:
| saxonExtensionFunctions
| null
| Camel 2.17: Allows to configure one or more custom net.sf.saxon.lib.ExtensionFunctionDefinition. You would need to add Saxon to the classpath. By setting this option, saxon option will be turned out automatically. | errorListener
| | Camel 2.14: Allows to configure to use a custom javax.xml.transform.ErrorListener . Beware when doing this then the default error listener which captures any errors or fatal errors and store information on the Exchange as properties is not in use. So only use this option for special use-cases. | entityResolver | | Camel 2.18: To use a custom org.xml.sax.EntityResolver with javax.xml.transform.sax.SAXSource. |
|
Using XSLT endpoints
For example you could use something like
Code Block |
---|
from("activemq:My. |
Code Block |
---|
from("activemq:My.Queue").
to("xslt:com/acme/mytransform.xsl").
to("activemq:Another.Queue");
|
Getting Parameters into the XSLT to work with
By default, all headers are added as parameters which are available in the XSLT.
To do this you will need to declare the parameter so it is then useable.
...
<setHeader headerName="myParam"><constant>42</constant></setHeader>
<to uri="xslt:MyTransform.xsl"/>
To use an XSLT template to formulate a response for a message for InOut message exchanges (where there is a JMSReplyTo
header).
If you want to use InOnly and consume the message and send it to another destination you could use the following route:
Code Block |
---|
from("activemq:My.Queue").
to("xslt:com/acme/mytransform.xsl").
to("activemq:Another.Queue");
|
Getting Parameters into the XSLT to work with
By default, all headers are added as parameters which are available in the XSLT.
To do this you will need to declare the parameter so it is then useable.
Code Block |
---|
|
<setHeader headerName="myParam"><constant>42</constant></setHeader>
<to uri="xslt:MyTransform.xsl"/>
|
And the XSLT just needs to declare it at the top level for it to be And the XSLT just needs to declare it at the top level for it to be available:
Code Block |
---|
|
<xsl: ...... >
<xsl:param name="myParam"/>
<xsl:template ...>
|
...
Which will load the staff_template.xsl resource from the file system, as the endpoint was configured with "file:" as prefix.
You can still though explicit configure a prefix, and then mix and match. And have both file and classpath loading. But that would be unusual, as most people either use file or classpath based resources.
Dynamic stylesheets
Using Saxon extension functions
Since Saxon 9.2, writing extension functions has been supplemented by a new mechanism, referred to as integrated extension functions you can now easily use camel:
- Java example:
Code Block |
---|
|
SimpleRegistry registry = new SimpleRegistry();
registry.put("function1", new MyExtensionFunction1());
registry.put("function2", new MyExtensionFunction2());
CamelContext context = new DefaultCamelContext(registry);
context.addRoutes(new RouteBuilder() {
@Override
public void configure() throws Exception {
from("direct:start")
.to("xslt:org/apache/camel/component/xslt/extensions/extensions.xslt?saxonExtensionFunctions=#function1,#function2");
}
}); |
Spring example:
Code Block |
---|
|
<camelContext xmlns="http://camel.apache.org/schema/spring">
<route>
<from uri="direct:extensions"/>
<to uri="xslt:org/apache/camel/component/xslt/extensions/extensions.xslt?saxonExtensionFunctions=#function1,#function2"/>
</route>
</camelContext>
<bean id="function1" class="org.apache.camel.component.xslt.extensions.MyExtensionFunction1"/>
<bean id="function2" class="org.apache.camel.component.xslt.extensions.MyExtensionFunction2"/> |
Dynamic stylesheets
To provide a dynamic stylesheet at runtime you can define a dynamic URI. See How to use a dynamic URI in to() for more information.
Available as of Camel 2.9 (removed in 2.11.4, 2.12.3 and 2.13.0)
Camel provides the CamelXsltResourceUri
header which you can use to define a stylesheet to use instead of what is configured on the endpoint URI. This allows you to provide a dynamic stylesheet at runtime.
Accessing warnings, errors and fatalErrors from XSLT ErrorListener
Available as of Camel 2.14
From Camel 2.14 onwards, any warning/error or fatalError is stored on the current Exchange as a property with the keys Exchange.XSLT_ERROR
, Exchange.XSLT_FATAL_ERROR
, or Exchange.XSLT_WARNING
which allows end users to get hold of any errors happening during transformation.
For example in the stylesheet below, we want to terminate if a staff has an empty dob field. And to include a custom error message using xsl:message.
Code Block |
---|
<xsl:template match="/">
<html>
<body>
<xsl:for-each select="staff/programmer">
<p>Name: <xsl:value-of select="name"/><br />
<xsl:if test="dob=''">
<xsl:message terminate="yes">Error: DOB is an empty string!</xsl:message>
</xsl:if>
</p>
</xsl:for-each>
</body>
</html>
</xsl:template> |
This information is not available on the Exchange stored as an Exception that contains the message in the getMessage()
method on the exception. The exception is stored on the Exchange as a warning with the key Exchange.XSLT_WARNING
Available as of Camel 2.9
Camel provides the CamelXsltResourceUri
header which you can use to define a stylesheet to use instead of what is configured on the endpoint URI. This allows you to provide a dynamic stylesheet at runtime.
Notes on using XSLT and Java Versions
...