org.apache.camel.component.xslt

Class XsltEndpoint

java.lang.Object

org.apache.camel.support.ServiceSupport

org.apache.camel.impl.DefaultEndpoint

org.apache.camel.impl.ScheduledPollEndpoint

org.apache.camel.impl.DefaultPollingEndpoint

org.apache.camel.impl.ProcessorEndpoint

org.apache.camel.component.xslt.XsltEndpoint

All Implemented Interfaces:

CamelContextAware, Endpoint, IsSingleton, Service, ShutdownableService, HasId, StatefulService, SuspendableService

@ManagedResource(description="Managed XsltEndpoint")
 @UriEndpoint(firstVersion="1.3.0",
             scheme="xslt",
             title="XSLT",
             syntax="xslt:resourceUri",
             producerOnly=true,
             label="core,transformation")
public class XsltEndpoint
extends ProcessorEndpoint

Transforms the message using a XSLT template.

Field Summary

Fields

Modifier and Type	Field and Description
static String	SAXON_TRANSFORMER_FACTORY_CLASS_NAME

Fields inherited from class org.apache.camel.support.ServiceSupport

shutdown, shuttingdown, started, starting, stopped, stopping, suspended, suspending

Constructor Summary

Constructors

Constructor and Description
XsltEndpoint(String endpointUri, Component component)
XsltEndpoint(String endpointUri, Component component, XsltBuilder xslt, String resourceUri, boolean cacheStylesheet) Deprecated.

Method Summary

Modifier and Type	Method and Description
void	clearCachedStylesheet()
protected void	configureOutput(XsltBuilder xslt, String output)
protected void	doStart() Implementations override this method to support customized start/stop.
protected void	doStop() Implementations override this method to support customized start/stop.
XsltEndpoint	findOrCreateEndpoint(String uri, String newResourceUri)
XmlConverter	getConverter()
EntityResolver	getEntityResolver()
ErrorListener	getErrorListener()
XsltOutput	getOutput()
Map<String,Object>	getParameters()
String	getResourceUri()
ResultHandlerFactory	getResultHandlerFactory()
Object	getSaxonConfiguration()
Map<String,Object>	getSaxonConfigurationProperties()
List<Object>	getSaxonExtensionFunctions()
int	getTransformerCacheSize()
TransformerFactory	getTransformerFactory()
String	getTransformerFactoryClass()
URIResolver	getUriResolver()
XsltBuilder	getXslt()
boolean	isAllowStAX()
boolean	isCacheCleared()
boolean	isCacheStylesheet()
boolean	isContentCache()
boolean	isDeleteOutputFile()
boolean	isFailOnNullBody()
boolean	isSaxon()
protected void	loadResource(String resourceUri) Loads the resource.
protected void	onExchange(Exchange exchange)
void	setAllowStAX(boolean allowStAX) Whether to allow using StAX as the javax.xml.transform.Source.
void	setCacheCleared(boolean cacheCleared)
void	setContentCache(boolean contentCache) Cache for the resource content (the stylesheet file) when it is loaded.
void	setConverter(XmlConverter converter) To use a custom implementation of XmlConverter
void	setDeleteOutputFile(boolean deleteOutputFile) If you have output=file then this option dictates whether or not the output file should be deleted when the Exchange is done processing.
void	setEntityResolver(EntityResolver entityResolver) To use a custom org.xml.sax.EntityResolver with javax.xml.transform.sax.SAXSource.
void	setErrorListener(ErrorListener errorListener) Allows to configure to use a custom javax.xml.transform.ErrorListener.
void	setFailOnNullBody(boolean failOnNullBody) Whether or not to throw an exception if the input body is null.
void	setOutput(XsltOutput output) Option to specify which output type to use.
void	setParameters(Map<String,Object> parameters) Additional parameters to configure on the javax.xml.transform.Transformer.
void	setResourceUri(String resourceUri) Path to the template.
void	setResultHandlerFactory(ResultHandlerFactory resultHandlerFactory) Allows you to use a custom org.apache.camel.builder.xml.ResultHandlerFactory which is capable of using custom org.apache.camel.builder.xml.ResultHandler types.
void	setSaxon(boolean saxon) Whether to use Saxon as the transformerFactoryClass.
void	setSaxonConfiguration(Object saxonConfiguration) To use a custom Saxon configuration
void	setSaxonConfigurationProperties(Map<String,Object> configurationProperties) To set custom Saxon configuration properties
void	setSaxonExtensionFunctions(List<Object> extensionFunctions) Allows you to use a custom net.sf.saxon.lib.ExtensionFunctionDefinition.
void	setSaxonExtensionFunctions(String extensionFunctions) Allows you to use a custom net.sf.saxon.lib.ExtensionFunctionDefinition.
void	setTransformerCacheSize(int transformerCacheSize) The number of javax.xml.transform.Transformer object that are cached for reuse to avoid calls to Template.newTransformer().
void	setTransformerFactory(TransformerFactory transformerFactory) To use a custom XSLT transformer factory
void	setTransformerFactoryClass(String transformerFactoryClass) To use a custom XSLT transformer factory, specified as a FQN class name
void	setUriResolver(URIResolver uriResolver) To use a custom javax.xml.transform.URIResolver
void	setXslt(XsltBuilder xslt)

Methods inherited from class org.apache.camel.impl.ProcessorEndpoint

createPollingConsumer, createProcessor, createProducer, getProcessor, isSingleton, setProcessor

Methods inherited from class org.apache.camel.impl.DefaultPollingEndpoint

createConsumer

Methods inherited from class org.apache.camel.impl.ScheduledPollEndpoint

configurePollingConsumer, configureProperties, configureScheduledPollConsumerProperties, getBackoffErrorThreshold, getBackoffIdleThreshold, getBackoffMultiplier, getDelay, getInitialDelay, getPollStrategy, getRunLoggingLevel, getScheduledExecutorService, getScheduler, getSchedulerProperties, getTimeUnit, initConsumerProperties, isGreedy, isSendEmptyMessageWhenIdle, isStartScheduler, isUseFixedDelay, setBackoffErrorThreshold, setBackoffIdleThreshold, setBackoffMultiplier, setDelay, setGreedy, setInitialDelay, setPollStrategy, setRunLoggingLevel, setScheduledExecutorService, setScheduler, setScheduler, setSchedulerProperties, setSendEmptyMessageWhenIdle, setStartScheduler, setTimeUnit, setUseFixedDelay

Methods inherited from class org.apache.camel.impl.DefaultEndpoint

configureConsumer, createEndpointConfiguration, createEndpointUri, createExchange, createExchange, createExchange, equals, getCamelContext, getComponent, getConsumerProperties, getEndpointConfiguration, getEndpointKey, getEndpointUri, getExceptionHandler, getExchangePattern, getId, getPollingConsumerBlockTimeout, getPollingConsumerQueueSize, hashCode, isBridgeErrorHandler, isLenientProperties, isPollingConsumerBlockWhenFull, isSynchronous, setBridgeErrorHandler, setCamelContext, setConsumerProperties, setEndpointConfiguration, setEndpointUri, setEndpointUriIfNotSpecified, setExceptionHandler, setExchangePattern, setPollingConsumerBlockTimeout, setPollingConsumerBlockWhenFull, setPollingConsumerQueueSize, setProperties, setSynchronous, toString

Methods inherited from class org.apache.camel.support.ServiceSupport

doResume, doShutdown, doSuspend, getStatus, getVersion, isRunAllowed, isStarted, isStarting, isStopped, isStopping, isStoppingOrStopped, isSuspended, isSuspending, isSuspendingOrSuspended, resume, shutdown, start, stop, suspend

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.apache.camel.Service

start, stop

Field Detail

SAXON_TRANSFORMER_FACTORY_CLASS_NAME

public static final String SAXON_TRANSFORMER_FACTORY_CLASS_NAME

See Also:

Constant Field Values

Constructor Detail

XsltEndpoint

@Deprecated
public XsltEndpoint(String endpointUri,
                                Component component,
                                XsltBuilder xslt,
                                String resourceUri,
                                boolean cacheStylesheet)
                         throws Exception

Deprecated.

Throws:

Exception

XsltEndpoint

public XsltEndpoint(String endpointUri,
                    Component component)

Method Detail

clearCachedStylesheet

@ManagedOperation(description="Clears the cached XSLT stylesheet, forcing to re-load the stylesheet on next request")
public void clearCachedStylesheet()

isCacheStylesheet

@ManagedAttribute(description="Whether the XSLT stylesheet is cached")
public boolean isCacheStylesheet()

findOrCreateEndpoint

public XsltEndpoint findOrCreateEndpoint(String uri,
                                         String newResourceUri)

onExchange

protected void onExchange(Exchange exchange)
                   throws Exception

Overrides:

onExchange in class ProcessorEndpoint

Throws:

Exception

isCacheCleared

public boolean isCacheCleared()

setCacheCleared

public void setCacheCleared(boolean cacheCleared)

getXslt

public XsltBuilder getXslt()

setXslt

public void setXslt(XsltBuilder xslt)

getResourceUri

@ManagedAttribute(description="Path to the template")
public String getResourceUri()

setResourceUri

public void setResourceUri(String resourceUri)

Path to the template.

The following is supported by the default URIResolver. You can prefix with: classpath, file, http, ref, or bean. classpath, file and http loads the resource using these protocols (classpath is default). ref will lookup the resource in the registry. bean will call a method on a bean to be used as the resource. For bean you can specify the method name after dot, eg bean:myBean.myMethod

Parameters:

resourceUri - the resource path

getConverter

public XmlConverter getConverter()

setConverter

public void setConverter(XmlConverter converter)

To use a custom implementation of XmlConverter

getTransformerFactoryClass

public String getTransformerFactoryClass()

setTransformerFactoryClass

public void setTransformerFactoryClass(String transformerFactoryClass)

To use a custom XSLT transformer factory, specified as a FQN class name

getTransformerFactory

public TransformerFactory getTransformerFactory()

setTransformerFactory

public void setTransformerFactory(TransformerFactory transformerFactory)

To use a custom XSLT transformer factory

isSaxon

@ManagedAttribute(description="Whether to use Saxon as the transformerFactoryClass")
public boolean isSaxon()

setSaxon

public void setSaxon(boolean saxon)

Whether to use Saxon as the transformerFactoryClass. If enabled then the class net.sf.saxon.TransformerFactoryImpl. You would need to add Saxon to the classpath.

getSaxonExtensionFunctions

public List<Object> getSaxonExtensionFunctions()

setSaxonExtensionFunctions

public void setSaxonExtensionFunctions(List<Object> extensionFunctions)

Allows you to use a custom net.sf.saxon.lib.ExtensionFunctionDefinition. You would need to add camel-saxon to the classpath. The function is looked up in the registry, where you can comma to separate multiple values to lookup.

setSaxonExtensionFunctions

public void setSaxonExtensionFunctions(String extensionFunctions)

Allows you to use a custom net.sf.saxon.lib.ExtensionFunctionDefinition. You would need to add camel-saxon to the classpath. The function is looked up in the registry, where you can comma to separate multiple values to lookup.

getSaxonConfiguration

public Object getSaxonConfiguration()

setSaxonConfiguration

public void setSaxonConfiguration(Object saxonConfiguration)

To use a custom Saxon configuration

getSaxonConfigurationProperties

public Map<String,Object> getSaxonConfigurationProperties()

setSaxonConfigurationProperties

public void setSaxonConfigurationProperties(Map<String,Object> configurationProperties)

To set custom Saxon configuration properties

getResultHandlerFactory

public ResultHandlerFactory getResultHandlerFactory()

setResultHandlerFactory

public void setResultHandlerFactory(ResultHandlerFactory resultHandlerFactory)

Allows you to use a custom org.apache.camel.builder.xml.ResultHandlerFactory which is capable of using custom org.apache.camel.builder.xml.ResultHandler types.

isFailOnNullBody

@ManagedAttribute(description="Whether or not to throw an exception if the input body is null")
public boolean isFailOnNullBody()

setFailOnNullBody

public void setFailOnNullBody(boolean failOnNullBody)

Whether or not to throw an exception if the input body is null.

getOutput

@ManagedAttribute(description="What kind of option to use.")
public XsltOutput getOutput()

setOutput

public void setOutput(XsltOutput output)

Option to specify which output type to use. Possible values are: string, bytes, DOM, file. The first three options are all in memory based, where as file is streamed directly to a java.io.File. For file you must specify the filename in the IN header with the key Exchange.XSLT_FILE_NAME which is also CamelXsltFileName. Also any paths leading to the filename must be created beforehand, otherwise an exception is thrown at runtime.

getTransformerCacheSize

public int getTransformerCacheSize()

setTransformerCacheSize

public void setTransformerCacheSize(int transformerCacheSize)

The number of javax.xml.transform.Transformer object that are cached for reuse to avoid calls to Template.newTransformer().

getErrorListener

public ErrorListener getErrorListener()

setErrorListener

public void setErrorListener(ErrorListener errorListener)

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.

isContentCache

@ManagedAttribute(description="Cache for the resource content (the stylesheet file) when it is loaded.")
public boolean isContentCache()

setContentCache

public void setContentCache(boolean contentCache)

Cache for the resource content (the stylesheet file) when it is loaded. If set to false Camel will reload the stylesheet file on each message processing. This is good for development. A cached stylesheet can be forced to reload at runtime via JMX using the clearCachedStylesheet operation.

getUriResolver

public URIResolver getUriResolver()

setUriResolver

public void setUriResolver(URIResolver uriResolver)

To use a custom javax.xml.transform.URIResolver

isAllowStAX

@ManagedAttribute(description="Whether to allow using StAX as the javax.xml.transform.Source")
public boolean isAllowStAX()

setAllowStAX

public void setAllowStAX(boolean allowStAX)

Whether to allow using StAX as the javax.xml.transform.Source.

isDeleteOutputFile

public boolean isDeleteOutputFile()

setDeleteOutputFile

public void setDeleteOutputFile(boolean deleteOutputFile)

If you have output=file then this option dictates whether or not the output file should be deleted when the Exchange is done processing. For example suppose the output file is a temporary file, then it can be a good idea to delete it after use.

getEntityResolver

public EntityResolver getEntityResolver()

setEntityResolver

public void setEntityResolver(EntityResolver entityResolver)

To use a custom org.xml.sax.EntityResolver with javax.xml.transform.sax.SAXSource.

getParameters

public Map<String,Object> getParameters()

setParameters

public void setParameters(Map<String,Object> parameters)

Additional parameters to configure on the javax.xml.transform.Transformer.

loadResource

protected void loadResource(String resourceUri)
                     throws TransformerException,
                            IOException

Loads the resource.

Parameters:

resourceUri - the resource to load

Throws:

TransformerException - is thrown if error loading resource

IOException - is thrown if error loading resource

doStart

protected void doStart()
                throws Exception

Description copied from class: ServiceSupport

Implementations override this method to support customized start/stop.

Important: See ServiceSupport.doStop() for more details.

Overrides:

doStart in class ScheduledPollEndpoint

Throws:

Exception

See Also:

ServiceSupport.doStop()

configureOutput

protected void configureOutput(XsltBuilder xslt,
                               String output)
                        throws Exception

Throws:

Exception

doStop

protected void doStop()
               throws Exception

Description copied from class: ServiceSupport

Implementations override this method to support customized start/stop.

Important: Camel will invoke this ServiceSupport.doStop() method when the service is being stopped. This method will also be invoked if the service is still in uninitialized state (eg has not been started). The method is always called to allow the service to do custom logic when the service is being stopped, such as when CamelContext is shutting down.

Overrides:

doStop in class ScheduledPollEndpoint

Throws:

Exception

See Also:

ServiceSupport.doStart()