blob: 39513ba2c79b6ebce5a7baaaef10c87be04e48c4 [file] [log] [blame]
// kafka-connector options: START
[[camel-xslt-kafka-connector-sink]]
= camel-xslt-kafka-connector sink configuration
When using camel-xslt-kafka-connector as sink make sure to use the following Maven dependency to have support for the connector:
[source,xml]
----
<dependency>
<groupId>org.apache.camel.kafkaconnector</groupId>
<artifactId>camel-xslt-kafka-connector</artifactId>
<version>x.x.x</version>
<!-- use the same version as your Camel Kafka connector version -->
</dependency>
----
The camel-xslt sink connector supports 23 options, which are listed below.
[width="100%",cols="2,5,^1,2",options="header"]
|===
| Name | Description | Default | Priority
| *camel.sink.path.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 | null | ConfigDef.Importance.HIGH
| *camel.sink.endpoint.content Cache* | 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. | true | ConfigDef.Importance.MEDIUM
| *camel.sink.endpoint.delete OutputFile* | 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. | false | ConfigDef.Importance.MEDIUM
| *camel.sink.endpoint.failOnNull Body* | Whether or not to throw an exception if the input body is null. | true | ConfigDef.Importance.MEDIUM
| *camel.sink.endpoint.lazyStart Producer* | 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. | false | ConfigDef.Importance.MEDIUM
| *camel.sink.endpoint.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. One of: [string] [bytes] [DOM] [file] | "string" | ConfigDef.Importance.MEDIUM
| * camel.sink.endpoint.transformer CacheSize* | The number of javax.xml.transform.Transformer object that are cached for reuse to avoid calls to Template.newTransformer(). | 0 | ConfigDef.Importance.MEDIUM
| *camel.sink.endpoint.basic PropertyBinding* | Whether the endpoint should use basic property binding (Camel 2.x) or the newer property binding with additional capabilities | false | ConfigDef.Importance.MEDIUM
| *camel.sink.endpoint.entity Resolver* | To use a custom org.xml.sax.EntityResolver with javax.xml.transform.sax.SAXSource. | null | ConfigDef.Importance.MEDIUM
| *camel.sink.endpoint.error Listener* | 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. | null | ConfigDef.Importance.MEDIUM
| *camel.sink.endpoint.result HandlerFactory* | 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. | null | ConfigDef.Importance.MEDIUM
| * camel.sink.endpoint.synchronous* | Sets whether synchronous processing should be strictly used, or Camel is allowed to use asynchronous processing (if supported). | false | ConfigDef.Importance.MEDIUM
| * camel.sink.endpoint.transformer Factory* | To use a custom XSLT transformer factory | null | ConfigDef.Importance.MEDIUM
| * camel.sink.endpoint.transformer FactoryClass* | To use a custom XSLT transformer factory, specified as a FQN class name | null | ConfigDef.Importance.MEDIUM
| * camel.sink.endpoint.transformer FactoryConfigurationStrategy* | A configuration strategy to apply on freshly created instances of TransformerFactory. | null | ConfigDef.Importance.MEDIUM
| *camel.sink.endpoint.uri Resolver* | To use a custom javax.xml.transform.URIResolver | null | ConfigDef.Importance.MEDIUM
| *camel.component.xslt.content Cache* | 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. | true | ConfigDef.Importance.MEDIUM
| *camel.component.xslt.lazyStart Producer* | 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. | false | ConfigDef.Importance.MEDIUM
| *camel.component.xslt.basic PropertyBinding* | Whether the component should use basic property binding (Camel 2.x) or the newer property binding with additional capabilities | false | ConfigDef.Importance.MEDIUM
| * camel.component.xslt.transformer FactoryClass* | To use a custom XSLT transformer factory, specified as a FQN class name | null | ConfigDef.Importance.MEDIUM
| * camel.component.xslt.transformer FactoryConfigurationStrategy* | A configuration strategy to apply on freshly created instances of TransformerFactory. | null | ConfigDef.Importance.MEDIUM
| *camel.component.xslt.uri Resolver* | To use a custom UriResolver. Should not be used together with the option 'uriResolverFactory'. | null | ConfigDef.Importance.MEDIUM
| *camel.component.xslt.uri ResolverFactory* | To use a custom UriResolver which depends on a dynamic endpoint resource URI. Should not be used together with the option 'uriResolver'. | null | ConfigDef.Importance.MEDIUM
|===
// kafka-connector options: END