Since we're on a major migration process of this website, some component documents here are out of sync right now. In the meantime you may want to look at the early version of the new website
https://camel.apache.org/staging/
We would very much like to receive any feedback on the new site, please join the discussion on the Camel user mailing list.
Available since Camel 2.18.0The Tar File Data Format is a message compression and de-compression format. Messages can be marshalled (compressed) to Tar Files containing a single entry, and Tar Files containing a single entry can be unmarshalled (decompressed) to the original file contents. There is also a aggregation strategy that can aggregate multiple messages into a single Tar File. TarFile OptionsThe Tar File dataformat supports 1 options which are listed below.
MarshalIn this example we marshal a regular text/XML payload to a compressed payload using Tar File compression, and send it to an ActiveMQ queue called MY_QUEUE. from("direct:start").marshal().tarFile().to("activemq:queue:MY_QUEUE");
The name of the Tar entry inside the created Tar File is based on the incoming from("file:input/directory?antInclude=*/.txt").marshal().tarFile().to("file:output/directory");
If there is no incoming CamelFileName message header (for example, if the file component is not the consumer), then the message ID is used by default, and since the message ID is normally a unique generated ID, you will end up with filenames like ID-MACHINENAME-2443-1211718892437-1-0.tar. If you want to override this behavior, then you can set the value of the CamelFileName header explicitly in your route:
from("direct:start").setHeader(Exchange.FILE_NAME, constant("report.txt")).marshal().tarFile().to("file:output/directory");
This route would result in a Tar File named "report.txt.tar" in the output directory, containing a single Tar entry named "report.txt".
UUnmarshalIn this example we unmarshal a Tar File payload from an ActiveMQ queue called MY_QUEUE to its original format, and forward it for processing to the from("activemq:queue:MY_QUEUE").unmarshal().tarFile().process(new UnTarpedMessageProcessor());
If the Tar File has more then one entry, the usingIterator option of TarFileDataFormat to be true, and you can use splitter to do the further work.
TarFileDataFormat tarFile = new TarFileDataFormat();
tarFile.setUsingIterator(true);
from("file:src/test/resources/org/apache/camel/dataformat/tarfile/?consumer.delay=1000&noop=true")
.unmarshal(tarFile)
.split(body(Iterator.class))
.streaming()
.process(new UnTarpedMessageProcessor())
.end();
Or you can use the TarSplitter as an expression for splitter directly like this from("file:src/test/resources/org/apache/camel/dataformat/tarfile?consumer.delay=1000&noop=true")
.split(new TarSplitter())
.streaming()
.process(new UnTarpedMessageProcessor())
.end();
AggregatePlease note that this aggregation strategy requires eager completion check to work properly.
In this example we aggregate all text files found in the input directory into a single Tar File that is stored in the output directory. from("file:input/directory?antInclude=*/.txt")
.aggregate(new TarAggregationStrategy())
.constant(true)
.completionFromBatchConsumer()
.eagerCheckCompletion()
.to("file:output/directory");
The outgoing CamelFileName message header is created using java.io.File.createTempFile, with the ".tar" suffix. If you want to override this behavior, then you can set the value of the CamelFileName header explicitly in your route:
from("file:input/directory?antInclude=*/.txt")
.aggregate(new TarAggregationStrategy())
.constant(true)
.completionFromBatchConsumer()
.eagerCheckCompletion()
.setHeader(Exchange.FILE_NAME, constant("reports.tar"))
.to("file:output/directory");
DependenciesTo use Tar Files in your camel routes you need to add a dependency on camel-tarfile which implements this data format. If you use Maven you can just add the following to your <dependency> <groupId>org.apache.camel</groupId> <artifactId>camel-tarfile</artifactId> <version>x.x.x</version> <!-- use the same version as your Camel core version --> </dependency> |
