org.apache.camel.builder.endpoint.dsl

Interface XsltSaxonEndpointBuilderFactory.XsltSaxonEndpointBuilder

All Superinterfaces:

org.apache.camel.builder.EndpointProducerBuilder, org.apache.camel.EndpointProducerResolver

Enclosing interface:

XsltSaxonEndpointBuilderFactory

public static interface XsltSaxonEndpointBuilderFactory.XsltSaxonEndpointBuilder
extends org.apache.camel.builder.EndpointProducerBuilder

Builder for endpoint for the XSLT Saxon component.

Method Summary

Modifier and Type	Method and Description
default XsltSaxonEndpointBuilderFactory.AdvancedXsltSaxonEndpointBuilder	advanced()
default XsltSaxonEndpointBuilderFactory.XsltSaxonEndpointBuilder	allowStAX(boolean allowStAX) Whether to allow using StAX as the javax.xml.transform.Source.
default XsltSaxonEndpointBuilderFactory.XsltSaxonEndpointBuilder	allowStAX(String allowStAX) Whether to allow using StAX as the javax.xml.transform.Source.
default XsltSaxonEndpointBuilderFactory.XsltSaxonEndpointBuilder	contentCache(boolean contentCache) Cache for the resource content (the stylesheet file) when it is loaded.
default XsltSaxonEndpointBuilderFactory.XsltSaxonEndpointBuilder	contentCache(String contentCache) Cache for the resource content (the stylesheet file) when it is loaded.
default XsltSaxonEndpointBuilderFactory.XsltSaxonEndpointBuilder	deleteOutputFile(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.
default XsltSaxonEndpointBuilderFactory.XsltSaxonEndpointBuilder	deleteOutputFile(String 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.
default XsltSaxonEndpointBuilderFactory.XsltSaxonEndpointBuilder	failOnNullBody(boolean failOnNullBody) Whether or not to throw an exception if the input body is null.
default XsltSaxonEndpointBuilderFactory.XsltSaxonEndpointBuilder	failOnNullBody(String failOnNullBody) Whether or not to throw an exception if the input body is null.
default XsltSaxonEndpointBuilderFactory.XsltSaxonEndpointBuilder	lazyStartProducer(boolean lazyStartProducer) Whether the producer should be started lazy (on the first message).
default XsltSaxonEndpointBuilderFactory.XsltSaxonEndpointBuilder	lazyStartProducer(String lazyStartProducer) Whether the producer should be started lazy (on the first message).
default XsltSaxonEndpointBuilderFactory.XsltSaxonEndpointBuilder	output(String output) Option to specify which output type to use.
default XsltSaxonEndpointBuilderFactory.XsltSaxonEndpointBuilder	output(XsltSaxonEndpointBuilderFactory.XsltOutput output) Option to specify which output type to use.
default XsltSaxonEndpointBuilderFactory.XsltSaxonEndpointBuilder	transformerCacheSize(int transformerCacheSize) The number of javax.xml.transform.Transformer object that are cached for reuse to avoid calls to Template.newTransformer().
default XsltSaxonEndpointBuilderFactory.XsltSaxonEndpointBuilder	transformerCacheSize(String transformerCacheSize) The number of javax.xml.transform.Transformer object that are cached for reuse to avoid calls to Template.newTransformer().

Methods inherited from interface org.apache.camel.builder.EndpointProducerBuilder

doSetMultiValueProperties, doSetMultiValueProperty, doSetProperty, expr, expr, getUri

Methods inherited from interface org.apache.camel.EndpointProducerResolver

resolve, resolve

Method Detail

advanced

default XsltSaxonEndpointBuilderFactory.AdvancedXsltSaxonEndpointBuilder advanced()

allowStAX

default XsltSaxonEndpointBuilderFactory.XsltSaxonEndpointBuilder allowStAX(boolean allowStAX)

Whether to allow using StAX as the javax.xml.transform.Source. You can enable this if the XSLT library supports StAX such as the Saxon library (camel-saxon). The Xalan library (default in JVM) does not support StAXSource. The option is a: <code>boolean</code> type. Default: true Group: producer

Parameters:

allowStAX - the value to set

Returns:

the dsl builder

allowStAX

default XsltSaxonEndpointBuilderFactory.XsltSaxonEndpointBuilder allowStAX(String allowStAX)

Whether to allow using StAX as the javax.xml.transform.Source. You can enable this if the XSLT library supports StAX such as the Saxon library (camel-saxon). The Xalan library (default in JVM) does not support StAXSource. The option will be converted to a <code>boolean</code> type. Default: true Group: producer

Parameters:

allowStAX - the value to set

Returns:

the dsl builder

contentCache

default XsltSaxonEndpointBuilderFactory.XsltSaxonEndpointBuilder contentCache(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. The option is a: <code>boolean</code> type. Default: true Group: producer

Parameters:

contentCache - the value to set

Returns:

the dsl builder

contentCache

default XsltSaxonEndpointBuilderFactory.XsltSaxonEndpointBuilder contentCache(String 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. The option will be converted to a <code>boolean</code> type. Default: true Group: producer

Parameters:

contentCache - the value to set

Returns:

the dsl builder

deleteOutputFile

default XsltSaxonEndpointBuilderFactory.XsltSaxonEndpointBuilder deleteOutputFile(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. The option is a: <code>boolean</code> type. Default: false Group: producer

Parameters:

deleteOutputFile - the value to set

Returns:

the dsl builder

deleteOutputFile

default XsltSaxonEndpointBuilderFactory.XsltSaxonEndpointBuilder deleteOutputFile(String 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. The option will be converted to a <code>boolean</code> type. Default: false Group: producer

Parameters:

deleteOutputFile - the value to set

Returns:

the dsl builder

failOnNullBody

default XsltSaxonEndpointBuilderFactory.XsltSaxonEndpointBuilder failOnNullBody(boolean failOnNullBody)

Whether or not to throw an exception if the input body is null. The option is a: <code>boolean</code> type. Default: true Group: producer

Parameters:

failOnNullBody - the value to set

Returns:

the dsl builder

failOnNullBody

default XsltSaxonEndpointBuilderFactory.XsltSaxonEndpointBuilder failOnNullBody(String failOnNullBody)

Whether or not to throw an exception if the input body is null. The option will be converted to a <code>boolean</code> type. Default: true Group: producer

Parameters:

failOnNullBody - the value to set

Returns:

the dsl builder

lazyStartProducer

default XsltSaxonEndpointBuilderFactory.XsltSaxonEndpointBuilder lazyStartProducer(boolean lazyStartProducer)

Whether the producer should be started lazy (on the first message). By starting lazy you can use this to allow CamelContext and routes to startup in situations where a producer may otherwise fail during starting and cause the route to fail being started. By deferring this startup to be lazy then the startup failure can be handled during routing messages via Camel's routing error handlers. Beware that when the first message is processed then creating and starting the producer may take a little time and prolong the total processing time of the processing. The option is a: <code>boolean</code> type. Default: false Group: producer

Parameters:

lazyStartProducer - the value to set

Returns:

the dsl builder

lazyStartProducer

default XsltSaxonEndpointBuilderFactory.XsltSaxonEndpointBuilder lazyStartProducer(String lazyStartProducer)

Whether the producer should be started lazy (on the first message). By starting lazy you can use this to allow CamelContext and routes to startup in situations where a producer may otherwise fail during starting and cause the route to fail being started. By deferring this startup to be lazy then the startup failure can be handled during routing messages via Camel's routing error handlers. Beware that when the first message is processed then creating and starting the producer may take a little time and prolong the total processing time of the processing. The option will be converted to a <code>boolean</code> type. Default: false Group: producer

Parameters:

lazyStartProducer - the value to set

Returns:

the dsl builder

output

default XsltSaxonEndpointBuilderFactory.XsltSaxonEndpointBuilder output(XsltSaxonEndpointBuilderFactory.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. The option is a: <code>org.apache.camel.component.xslt.XsltOutput</code> type. Default: string Group: producer

Parameters:

output - the value to set

Returns:

the dsl builder

output

default XsltSaxonEndpointBuilderFactory.XsltSaxonEndpointBuilder output(String 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. The option will be converted to a <code>org.apache.camel.component.xslt.XsltOutput</code> type. Default: string Group: producer

Parameters:

output - the value to set

Returns:

the dsl builder

transformerCacheSize

default XsltSaxonEndpointBuilderFactory.XsltSaxonEndpointBuilder transformerCacheSize(int transformerCacheSize)

The number of javax.xml.transform.Transformer object that are cached for reuse to avoid calls to Template.newTransformer(). The option is a: <code>int</code> type. Default: 0 Group: producer

Parameters:

transformerCacheSize - the value to set

Returns:

the dsl builder

transformerCacheSize

default XsltSaxonEndpointBuilderFactory.XsltSaxonEndpointBuilder transformerCacheSize(String transformerCacheSize)

The number of javax.xml.transform.Transformer object that are cached for reuse to avoid calls to Template.newTransformer(). The option will be converted to a <code>int</code> type. Default: 0 Group: producer

Parameters:

transformerCacheSize - the value to set

Returns:

the dsl builder