blob: 4208d0617612d1c5248ea961146b819bed26507a [file] [log] [blame]
// spring-boot-auto-configure options: START
:page-partial:
:doctitle: Camel Spring Boot Starter for xpath
== Spring Boot Auto-Configuration
When using xpath with Spring Boot make sure to use the following Maven dependency to have support for auto configuration:
[source,xml]
----
<dependency>
<groupId>org.apache.camel.springboot</groupId>
<artifactId>camel-xpath-starter</artifactId>
<version>x.x.x</version>
<!-- use the same version as your Camel core version -->
</dependency>
----
The component supports 9 options, which are listed below.
[width="100%",cols="2,5,^1,2",options="header"]
|===
| Name | Description | Default | Type
| *camel.language.xpath.document-type* | Name of class for document type The default value is org.w3c.dom.Document | | String
| *camel.language.xpath.enabled* | Whether to enable auto configuration of the xpath language. This is enabled by default. | | Boolean
| *camel.language.xpath.factory-ref* | References to a custom XPathFactory to lookup in the registry | | String
| *camel.language.xpath.log-namespaces* | Whether to log namespaces which can assist during trouble shooting | false | Boolean
| *camel.language.xpath.object-model* | The XPath object model to use | | String
| *camel.language.xpath.pre-compile* | Whether to enable pre-compiling the xpath expression during initialization phase. pre-compile is enabled by default. This can be used to turn off, for example in cases the compilation phase is desired at the starting phase, such as if the application is ahead of time compiled (for example with camel-quarkus) which would then load the xpath factory of the built operating system, and not a JVM runtime. | true | Boolean
| *camel.language.xpath.saxon* | Whether to use Saxon. | false | Boolean
| *camel.language.xpath.thread-safety* | Whether to enable thread-safety for the returned result of the xpath expression. This applies to when using NODESET as the result type, and the returned set has multiple elements. In this situation there can be thread-safety issues if you process the NODESET concurrently such as from a Camel Splitter EIP in parallel processing mode. This option prevents concurrency issues by doing defensive copies of the nodes. It is recommended to turn this option on if you are using camel-saxon or Saxon in your application. Saxon has thread-safety issues which can be prevented by turning this option on. | false | Boolean
| *camel.language.xpath.trim* | Whether to trim the value to remove leading and trailing whitespaces and line breaks | true | Boolean
|===
// spring-boot-auto-configure options: END