// spring-boot-auto-configure options: START
:page-partial:
:doctitle: Camel Spring Boot Starter for tarfile

== Spring Boot Auto-Configuration

When using tarfile 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-tarfile-starter</artifactId>
  <version>x.x.x</version>
  <!-- use the same version as your Camel core version -->
</dependency>
----


The component supports 6 options, which are listed below.



[width="100%",cols="2,5,^1,2",options="header"]
|===
| Name | Description | Default | Type
| *camel.dataformat.tarfile.allow-empty-directory* | If the tar file has more then one entry, setting this option to true, allows to get the iterator even if the directory is empty | false | Boolean
| *camel.dataformat.tarfile.content-type-header* | Whether the data format should set the Content-Type header with the type from the data format if the data format is capable of doing so. For example application/xml for data formats marshalling to XML, or application/json for data formats marshalling to JSON etc. | false | Boolean
| *camel.dataformat.tarfile.enabled* | Whether to enable auto configuration of the tarfile data format. This is enabled by default. |  | Boolean
| *camel.dataformat.tarfile.max-decompressed-size* | Set the maximum decompressed size of a tar file (in bytes). The default value if not specified corresponds to 1 gigabyte. An IOException will be thrown if the decompressed size exceeds this amount. Set to -1 to disable setting a maximum decompressed size. | 1073741824 | Long
| *camel.dataformat.tarfile.preserve-path-elements* | If the file name contains path elements, setting this option to true, allows the path to be maintained in the tar file. | false | Boolean
| *camel.dataformat.tarfile.using-iterator* | If the tar file has more then one entry, the setting this option to true, allows to work with the splitter EIP, to split the data using an iterator in a streaming mode. | false | Boolean
|===
// spring-boot-auto-configure options: END
