Flatpack

Parse fixed width and delimited files using the FlatPack library.

What’s inside

Flatpack component, URI syntax: flatpack:type:resourceUri
Flatpack data format

Please refer to the above links for usage and configuration details.

Maven coordinates

<dependency>
    <groupId>org.apache.camel.springboot</groupId>
    <artifactId>camel-flatpack-starter</artifactId>
</dependency>

Spring Boot Auto-Configuration

The starter supports 13 options, which are listed below.

Name	Description	Default	Type
camel.component.flatpack.autowired-enabled	Whether autowiring is enabled. This is used for automatic autowiring options (the option must be marked as autowired) by looking up in the registry to find if there is a single instance of matching type, which then gets configured on the component. This can be used for automatic configuring JDBC data sources, JMS connection factories, AWS Clients, etc.	true	Boolean
camel.component.flatpack.bridge-error-handler	Allows for bridging the consumer to the Camel routing Error Handler, which mean any exceptions (if possible) occurred while the Camel consumer is trying to pickup incoming messages, or the likes, will now be processed as a message and handled by the routing Error Handler. Important: This is only possible if the 3rd party component allows Camel to be alerted if an exception was thrown. Some components handle this internally only, and therefore bridgeErrorHandler is not possible. In other situations we may improve the Camel component to hook into the 3rd party component and make this possible for future releases. By default the consumer will use the org.apache.camel.spi.ExceptionHandler to deal with exceptions, that will be logged at WARN or ERROR level and ignored.	false	Boolean
camel.component.flatpack.enabled	Whether to enable auto configuration of the flatpack component. This is enabled by default.		Boolean
camel.component.flatpack.lazy-start-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	Boolean
camel.dataformat.flatpack.allow-short-lines	Allows for lines to be shorter than expected and ignores the extra characters.	false	Boolean
camel.dataformat.flatpack.definition	The flatpack pzmap configuration file. Can be omitted in simpler situations, but its preferred to use the pzmap.		String
camel.dataformat.flatpack.delimiter	The delimiter char (could be ; , or similar).	,	String
camel.dataformat.flatpack.enabled	Whether to enable auto configuration of the flatpack data format. This is enabled by default.		Boolean
camel.dataformat.flatpack.fixed	Delimited or fixed. Is by default false = delimited.	false	Boolean
camel.dataformat.flatpack.ignore-extra-columns	Allows for lines to be longer than expected and ignores the extra characters.	false	Boolean
camel.dataformat.flatpack.ignore-first-record	Whether the first line is ignored for delimited files (for the column headers). Is by default true.	true	Boolean
camel.dataformat.flatpack.parser-factory	References to a custom parser factory to lookup in the registry. The option is a net.sf.flatpack.ParserFactory type.		String
camel.dataformat.flatpack.text-qualifier	If the text is qualified with a character. Uses quote character by default.		String

Name

Description

Default

Type

camel.component.flatpack.autowired-enabled

Whether autowiring is enabled. This is used for automatic autowiring options (the option must be marked as autowired) by looking up in the registry to find if there is a single instance of matching type, which then gets configured on the component. This can be used for automatic configuring JDBC data sources, JMS connection factories, AWS Clients, etc.

true

Boolean

camel.component.flatpack.bridge-error-handler

Allows for bridging the consumer to the Camel routing Error Handler, which mean any exceptions (if possible) occurred while the Camel consumer is trying to pickup incoming messages, or the likes, will now be processed as a message and handled by the routing Error Handler. Important: This is only possible if the 3rd party component allows Camel to be alerted if an exception was thrown. Some components handle this internally only, and therefore bridgeErrorHandler is not possible. In other situations we may improve the Camel component to hook into the 3rd party component and make this possible for future releases. By default the consumer will use the org.apache.camel.spi.ExceptionHandler to deal with exceptions, that will be logged at WARN or ERROR level and ignored.

false

Boolean

camel.component.flatpack.enabled

Whether to enable auto configuration of the flatpack component. This is enabled by default.

Boolean

camel.component.flatpack.lazy-start-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

Boolean

camel.dataformat.flatpack.allow-short-lines

Allows for lines to be shorter than expected and ignores the extra characters.

false

Boolean

camel.dataformat.flatpack.definition

The flatpack pzmap configuration file. Can be omitted in simpler situations, but its preferred to use the pzmap.

String

camel.dataformat.flatpack.delimiter

The delimiter char (could be ; , or similar).

String

camel.dataformat.flatpack.enabled

Whether to enable auto configuration of the flatpack data format. This is enabled by default.

Boolean

camel.dataformat.flatpack.fixed

Delimited or fixed. Is by default false = delimited.

false

Boolean

camel.dataformat.flatpack.ignore-extra-columns

Allows for lines to be longer than expected and ignores the extra characters.

false

Boolean

camel.dataformat.flatpack.ignore-first-record

Whether the first line is ignored for delimited files (for the column headers). Is by default true.

true

Boolean

camel.dataformat.flatpack.parser-factory

References to a custom parser factory to lookup in the registry. The option is a net.sf.flatpack.ParserFactory type.

String

camel.dataformat.flatpack.text-qualifier

If the text is qualified with a character. Uses quote character by default.

String