org.apache.camel.builder.endpoint.dsl

Interface XJEndpointBuilderFactory.XJEndpointBuilder

All Superinterfaces:

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

Enclosing interface:

XJEndpointBuilderFactory

public static interface XJEndpointBuilderFactory.XJEndpointBuilder
extends org.apache.camel.builder.EndpointProducerBuilder

Builder for endpoint for the XJ component.

Method Summary

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

Methods inherited from interface org.apache.camel.EndpointProducerResolver

resolve, resolve

Method Detail

advanced

default XJEndpointBuilderFactory.AdvancedXJEndpointBuilder advanced()

allowStAX

default XJEndpointBuilderFactory.XJEndpointBuilder 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 XJEndpointBuilderFactory.XJEndpointBuilder 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 XJEndpointBuilderFactory.XJEndpointBuilder 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 XJEndpointBuilderFactory.XJEndpointBuilder 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 XJEndpointBuilderFactory.XJEndpointBuilder 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 XJEndpointBuilderFactory.XJEndpointBuilder 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 XJEndpointBuilderFactory.XJEndpointBuilder 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 XJEndpointBuilderFactory.XJEndpointBuilder 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 XJEndpointBuilderFactory.XJEndpointBuilder 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 XJEndpointBuilderFactory.XJEndpointBuilder 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 XJEndpointBuilderFactory.XJEndpointBuilder output(XJEndpointBuilderFactory.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 XJEndpointBuilderFactory.XJEndpointBuilder 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

transformDirection

default XJEndpointBuilderFactory.XJEndpointBuilder transformDirection(XJEndpointBuilderFactory.TransformDirection transformDirection)

Transform direction. Either XML2JSON or JSON2XML. The option is a: <code>org.apache.camel.component.xj.TransformDirection</code> type. Required: true Group: producer

Parameters:

transformDirection - the value to set

Returns:

the dsl builder

transformDirection

default XJEndpointBuilderFactory.XJEndpointBuilder transformDirection(String transformDirection)

Transform direction. Either XML2JSON or JSON2XML. The option will be converted to a <code>org.apache.camel.component.xj.TransformDirection</code> type. Required: true Group: producer

Parameters:

transformDirection - the value to set

Returns:

the dsl builder

transformerCacheSize

default XJEndpointBuilderFactory.XJEndpointBuilder 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 XJEndpointBuilderFactory.XJEndpointBuilder 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