Repository: camel Updated Branches: refs/heads/master a877cd7ad -> ce33151ba
CAMEL-11146: Update description for all data formats and languages on big readme file Project: http://git-wip-us.apache.org/repos/asf/camel/repo Commit: http://git-wip-us.apache.org/repos/asf/camel/commit/ce33151b Tree: http://git-wip-us.apache.org/repos/asf/camel/tree/ce33151b Diff: http://git-wip-us.apache.org/repos/asf/camel/diff/ce33151b Branch: refs/heads/master Commit: ce33151badba434c16a46f3c07bb8643a9c5f921 Parents: a877cd7 Author: Claus Ibsen <davscl...@apache.org> Authored: Fri Sep 22 15:37:53 2017 +0200 Committer: Claus Ibsen <davscl...@apache.org> Committed: Fri Sep 22 15:37:53 2017 +0200 ---------------------------------------------------------------------- camel-core/readme.adoc | 10 +- .../camel/model/dataformat/ASN1DataFormat.java | 2 +- .../camel/model/dataformat/AvroDataFormat.java | 2 +- .../model/dataformat/BarcodeDataFormat.java | 2 +- .../model/dataformat/Base64DataFormat.java | 2 +- .../model/dataformat/BeanioDataFormat.java | 2 +- .../camel/model/dataformat/BindyDataFormat.java | 2 +- .../camel/model/dataformat/BoonDataFormat.java | 2 +- .../model/dataformat/CastorDataFormat.java | 2 +- .../model/dataformat/CryptoDataFormat.java | 2 +- .../camel/model/dataformat/CsvDataFormat.java | 2 +- .../model/dataformat/CustomDataFormat.java | 2 +- .../model/dataformat/FlatpackDataFormat.java | 2 +- .../camel/model/dataformat/GzipDataFormat.java | 2 +- .../camel/model/dataformat/HL7DataFormat.java | 2 +- .../model/dataformat/HessianDataFormat.java | 3 +- .../camel/model/dataformat/IcalDataFormat.java | 4 +- .../model/dataformat/JacksonXMLDataFormat.java | 2 +- .../camel/model/dataformat/JaxbDataFormat.java | 2 +- .../camel/model/dataformat/JibxDataFormat.java | 2 +- .../camel/model/dataformat/JsonDataFormat.java | 2 +- .../camel/model/dataformat/LZFDataFormat.java | 2 +- .../dataformat/MimeMultipartDataFormat.java | 3 +- .../camel/model/dataformat/PGPDataFormat.java | 2 +- .../model/dataformat/ProtobufDataFormat.java | 2 +- .../camel/model/dataformat/RssDataFormat.java | 2 +- .../dataformat/SerializationDataFormat.java | 3 +- .../model/dataformat/SoapJaxbDataFormat.java | 2 +- .../model/dataformat/StringDataFormat.java | 2 +- .../model/dataformat/SyslogDataFormat.java | 4 +- .../model/dataformat/TarFileDataFormat.java | 2 +- .../model/dataformat/ThriftDataFormat.java | 2 +- .../model/dataformat/TidyMarkupDataFormat.java | 2 +- .../dataformat/UniVocityCsvDataFormat.java | 2 +- .../UniVocityFixedWidthDataFormat.java | 2 +- .../dataformat/UniVocityTsvDataFormat.java | 2 +- .../model/dataformat/XMLBeansDataFormat.java | 3 +- .../model/dataformat/XMLSecurityDataFormat.java | 2 +- .../model/dataformat/XStreamDataFormat.java | 2 +- .../model/dataformat/XmlJsonDataFormat.java | 2 +- .../model/dataformat/XmlRpcDataFormat.java | 2 +- .../camel/model/dataformat/YAMLDataFormat.java | 2 +- .../camel/model/dataformat/ZipDataFormat.java | 2 +- .../model/dataformat/ZipFileDataFormat.java | 2 +- .../src/main/docs/base64-dataformat.adoc | 47 +++---- .../camel-ftp/src/main/docs/ftp-component.adoc | 3 +- .../camel-ftp/src/main/docs/ftps-component.adoc | 3 +- .../src/main/docs/hessian-dataformat.adoc | 4 +- .../src/main/docs/xmlBeans-dataformat.adoc | 4 +- .../src/main/docs/zipfile-dataformat.adoc | 122 +++++++++---------- components/readme.adoc | 14 +-- .../springboot/GzipDataFormatConfiguration.java | 3 +- .../SerializationDataFormatConfiguration.java | 4 +- .../StringDataFormatConfiguration.java | 3 +- .../springboot/ZipDataFormatConfiguration.java | 3 +- 55 files changed, 160 insertions(+), 154 deletions(-) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/camel/blob/ce33151b/camel-core/readme.adoc ---------------------------------------------------------------------- diff --git a/camel-core/readme.adoc b/camel-core/readme.adoc index 267c4ee..c88d6b7 100644 --- a/camel-core/readme.adoc +++ b/camel-core/readme.adoc @@ -103,19 +103,19 @@ Data Formats // dataformats: START -Number of Data Formats: 4 in 39 JAR artifacts (0 deprecated) +Number of Data Formats: 4 in 39 JAR artifacts (2 deprecated) [width="100%",cols="4,1,5",options="header"] |=== | Data Format | Available From | Description -| link:src/main/docs/gzip-dataformat.adoc[GZip] (camel-core) | 2.0 | GZip compression data format +| link:src/main/docs/gzip-dataformat.adoc[GZip] (camel-core) | 2.0 | The GZip data format is a message compression and de-compression format (which works with the popular gzip/gunzip tools). -| link:src/main/docs/serialization-dataformat.adoc[Java Object Serialization] (camel-core) | 2.12 | Java Object Serialization data format +| link:src/main/docs/serialization-dataformat.adoc[Java Object Serialization] (camel-core) | 2.12 | Serialization is a data format which uses the standard Java Serialization mechanism to unmarshal a binary payload into Java objects or to marshal Java objects into a binary blob. -| link:src/main/docs/string-dataformat.adoc[String Encoding] (camel-core) | 2.12 | String (text based) data format +| link:src/main/docs/string-dataformat.adoc[String Encoding] (camel-core) | 2.12 | String data format is a textual based format that supports character encoding. -| link:src/main/docs/zip-dataformat.adoc[Zip Deflate Compression] (camel-core) | 2.12 | Zip compression data format (not for zip files) +| link:src/main/docs/zip-dataformat.adoc[Zip Deflate Compression] (camel-core) | 2.12 | Zip Deflate Compression data format is a message compression and de-compression format (not zip files). |=== // dataformats: END http://git-wip-us.apache.org/repos/asf/camel/blob/ce33151b/camel-core/src/main/java/org/apache/camel/model/dataformat/ASN1DataFormat.java ---------------------------------------------------------------------- diff --git a/camel-core/src/main/java/org/apache/camel/model/dataformat/ASN1DataFormat.java b/camel-core/src/main/java/org/apache/camel/model/dataformat/ASN1DataFormat.java index 14a5975..6f14a22 100644 --- a/camel-core/src/main/java/org/apache/camel/model/dataformat/ASN1DataFormat.java +++ b/camel-core/src/main/java/org/apache/camel/model/dataformat/ASN1DataFormat.java @@ -27,7 +27,7 @@ import org.apache.camel.spi.DataFormat; import org.apache.camel.spi.Metadata; /** - * ASN.1 data format + * The ASN.1 data format is used for file transfer with telecommunications protocols. */ @Metadata(firstVersion = "2.20.0", label = "dataformat,transformation,file", title = "ASN.1 File") @XmlRootElement(name = "asn1") http://git-wip-us.apache.org/repos/asf/camel/blob/ce33151b/camel-core/src/main/java/org/apache/camel/model/dataformat/AvroDataFormat.java ---------------------------------------------------------------------- diff --git a/camel-core/src/main/java/org/apache/camel/model/dataformat/AvroDataFormat.java b/camel-core/src/main/java/org/apache/camel/model/dataformat/AvroDataFormat.java index 9e5ad50..ab301fe 100644 --- a/camel-core/src/main/java/org/apache/camel/model/dataformat/AvroDataFormat.java +++ b/camel-core/src/main/java/org/apache/camel/model/dataformat/AvroDataFormat.java @@ -28,7 +28,7 @@ import org.apache.camel.spi.DataFormat; import org.apache.camel.spi.Metadata; /** - * Avro data format + * The Avro data format is used for serialization and deserialization of messages using Apache Avro binary dataformat. * * @version */ http://git-wip-us.apache.org/repos/asf/camel/blob/ce33151b/camel-core/src/main/java/org/apache/camel/model/dataformat/BarcodeDataFormat.java ---------------------------------------------------------------------- diff --git a/camel-core/src/main/java/org/apache/camel/model/dataformat/BarcodeDataFormat.java b/camel-core/src/main/java/org/apache/camel/model/dataformat/BarcodeDataFormat.java index c97a66b..be2500a 100644 --- a/camel-core/src/main/java/org/apache/camel/model/dataformat/BarcodeDataFormat.java +++ b/camel-core/src/main/java/org/apache/camel/model/dataformat/BarcodeDataFormat.java @@ -27,7 +27,7 @@ import org.apache.camel.spi.DataFormat; import org.apache.camel.spi.Metadata; /** - * Barcode data format + * The Barcode data format is used for creating barccode images (such as QR-Code) * * @version */ http://git-wip-us.apache.org/repos/asf/camel/blob/ce33151b/camel-core/src/main/java/org/apache/camel/model/dataformat/Base64DataFormat.java ---------------------------------------------------------------------- diff --git a/camel-core/src/main/java/org/apache/camel/model/dataformat/Base64DataFormat.java b/camel-core/src/main/java/org/apache/camel/model/dataformat/Base64DataFormat.java index 77dc289..5b3192b 100644 --- a/camel-core/src/main/java/org/apache/camel/model/dataformat/Base64DataFormat.java +++ b/camel-core/src/main/java/org/apache/camel/model/dataformat/Base64DataFormat.java @@ -27,7 +27,7 @@ import org.apache.camel.spi.DataFormat; import org.apache.camel.spi.Metadata; /** - * Base64 data format + * The Base64 data format is used for base64 encoding and decoding. * * @version */ http://git-wip-us.apache.org/repos/asf/camel/blob/ce33151b/camel-core/src/main/java/org/apache/camel/model/dataformat/BeanioDataFormat.java ---------------------------------------------------------------------- diff --git a/camel-core/src/main/java/org/apache/camel/model/dataformat/BeanioDataFormat.java b/camel-core/src/main/java/org/apache/camel/model/dataformat/BeanioDataFormat.java index 16d7720..8aad5c9 100644 --- a/camel-core/src/main/java/org/apache/camel/model/dataformat/BeanioDataFormat.java +++ b/camel-core/src/main/java/org/apache/camel/model/dataformat/BeanioDataFormat.java @@ -27,7 +27,7 @@ import org.apache.camel.spi.DataFormat; import org.apache.camel.spi.Metadata; /** - * BeanIO data format + * The BeanIO data format is used for working with flat payloads (such as CSV, delimited, or fixed length formats). * * @version */ http://git-wip-us.apache.org/repos/asf/camel/blob/ce33151b/camel-core/src/main/java/org/apache/camel/model/dataformat/BindyDataFormat.java ---------------------------------------------------------------------- diff --git a/camel-core/src/main/java/org/apache/camel/model/dataformat/BindyDataFormat.java b/camel-core/src/main/java/org/apache/camel/model/dataformat/BindyDataFormat.java index c01ef8a..3951845 100644 --- a/camel-core/src/main/java/org/apache/camel/model/dataformat/BindyDataFormat.java +++ b/camel-core/src/main/java/org/apache/camel/model/dataformat/BindyDataFormat.java @@ -30,7 +30,7 @@ import org.apache.camel.spi.RouteContext; import org.apache.camel.util.ObjectHelper; /** - * Bindy data format + * The Bindy data format is used for working with flat payloads (such as CSV, delimited, fixed length formats, or FIX messages). * * @version */ http://git-wip-us.apache.org/repos/asf/camel/blob/ce33151b/camel-core/src/main/java/org/apache/camel/model/dataformat/BoonDataFormat.java ---------------------------------------------------------------------- diff --git a/camel-core/src/main/java/org/apache/camel/model/dataformat/BoonDataFormat.java b/camel-core/src/main/java/org/apache/camel/model/dataformat/BoonDataFormat.java index 5f0da5c..498fbf0 100644 --- a/camel-core/src/main/java/org/apache/camel/model/dataformat/BoonDataFormat.java +++ b/camel-core/src/main/java/org/apache/camel/model/dataformat/BoonDataFormat.java @@ -30,7 +30,7 @@ import org.apache.camel.spi.RouteContext; import org.apache.camel.util.ObjectHelper; /** - * Boon data format + * Boon data format is used for unmarshal a JSon payload to POJO or to marshal POJO back to JSon payload. */ @Metadata(firstVersion = "2.16.0", label = "dataformat,transformation,json", title = "Boon") @XmlRootElement(name = "boon") http://git-wip-us.apache.org/repos/asf/camel/blob/ce33151b/camel-core/src/main/java/org/apache/camel/model/dataformat/CastorDataFormat.java ---------------------------------------------------------------------- diff --git a/camel-core/src/main/java/org/apache/camel/model/dataformat/CastorDataFormat.java b/camel-core/src/main/java/org/apache/camel/model/dataformat/CastorDataFormat.java index 3dedbc3..10f57dc 100644 --- a/camel-core/src/main/java/org/apache/camel/model/dataformat/CastorDataFormat.java +++ b/camel-core/src/main/java/org/apache/camel/model/dataformat/CastorDataFormat.java @@ -27,7 +27,7 @@ import org.apache.camel.spi.DataFormat; import org.apache.camel.spi.Metadata; /** - * Castor data format + * Castor data format is used for unmarshal a XML payload to POJO or to marshal POJO back to XML payload. * * @version */ http://git-wip-us.apache.org/repos/asf/camel/blob/ce33151b/camel-core/src/main/java/org/apache/camel/model/dataformat/CryptoDataFormat.java ---------------------------------------------------------------------- diff --git a/camel-core/src/main/java/org/apache/camel/model/dataformat/CryptoDataFormat.java b/camel-core/src/main/java/org/apache/camel/model/dataformat/CryptoDataFormat.java index 3d7b7ab..c352a38 100644 --- a/camel-core/src/main/java/org/apache/camel/model/dataformat/CryptoDataFormat.java +++ b/camel-core/src/main/java/org/apache/camel/model/dataformat/CryptoDataFormat.java @@ -32,7 +32,7 @@ import org.apache.camel.util.CamelContextHelper; import org.apache.camel.util.ObjectHelper; /** - * Crypto data format + * Crypto data format is used for encrypting and decrypting of messages using Java Cryptographic Extension. * * @version */ http://git-wip-us.apache.org/repos/asf/camel/blob/ce33151b/camel-core/src/main/java/org/apache/camel/model/dataformat/CsvDataFormat.java ---------------------------------------------------------------------- diff --git a/camel-core/src/main/java/org/apache/camel/model/dataformat/CsvDataFormat.java b/camel-core/src/main/java/org/apache/camel/model/dataformat/CsvDataFormat.java index 1c0213b..d47ca7f 100644 --- a/camel-core/src/main/java/org/apache/camel/model/dataformat/CsvDataFormat.java +++ b/camel-core/src/main/java/org/apache/camel/model/dataformat/CsvDataFormat.java @@ -31,7 +31,7 @@ import org.apache.camel.util.CamelContextHelper; import org.apache.camel.util.ObjectHelper; /** - * CSV data format + * The CSV data format is used for handling CSV payloads. */ @Metadata(firstVersion = "1.3.0", label = "dataformat,transformation,csv", title = "CSV") @XmlRootElement(name = "csv") http://git-wip-us.apache.org/repos/asf/camel/blob/ce33151b/camel-core/src/main/java/org/apache/camel/model/dataformat/CustomDataFormat.java ---------------------------------------------------------------------- diff --git a/camel-core/src/main/java/org/apache/camel/model/dataformat/CustomDataFormat.java b/camel-core/src/main/java/org/apache/camel/model/dataformat/CustomDataFormat.java index 7bf42de..a9528e3 100644 --- a/camel-core/src/main/java/org/apache/camel/model/dataformat/CustomDataFormat.java +++ b/camel-core/src/main/java/org/apache/camel/model/dataformat/CustomDataFormat.java @@ -27,7 +27,7 @@ import org.apache.camel.spi.Metadata; import org.apache.camel.spi.RouteContext; /** - * Custom data format + * To use a custom data format implementation that does not come out of the box from Apache Camel. * * @version */ http://git-wip-us.apache.org/repos/asf/camel/blob/ce33151b/camel-core/src/main/java/org/apache/camel/model/dataformat/FlatpackDataFormat.java ---------------------------------------------------------------------- diff --git a/camel-core/src/main/java/org/apache/camel/model/dataformat/FlatpackDataFormat.java b/camel-core/src/main/java/org/apache/camel/model/dataformat/FlatpackDataFormat.java index ba22173..6765ea5 100644 --- a/camel-core/src/main/java/org/apache/camel/model/dataformat/FlatpackDataFormat.java +++ b/camel-core/src/main/java/org/apache/camel/model/dataformat/FlatpackDataFormat.java @@ -30,7 +30,7 @@ import org.apache.camel.util.CamelContextHelper; import org.apache.camel.util.ObjectHelper; /** - * Flatpack data format + * The Flatpack data format is used for working with flat payloads (such as CSV, delimited, or fixed length formats). */ @Metadata(firstVersion = "2.1.0", label = "dataformat,transformation,csv", title = "Flatpack") @XmlRootElement(name = "flatpack") http://git-wip-us.apache.org/repos/asf/camel/blob/ce33151b/camel-core/src/main/java/org/apache/camel/model/dataformat/GzipDataFormat.java ---------------------------------------------------------------------- diff --git a/camel-core/src/main/java/org/apache/camel/model/dataformat/GzipDataFormat.java b/camel-core/src/main/java/org/apache/camel/model/dataformat/GzipDataFormat.java index 7559a0d..35baeea 100644 --- a/camel-core/src/main/java/org/apache/camel/model/dataformat/GzipDataFormat.java +++ b/camel-core/src/main/java/org/apache/camel/model/dataformat/GzipDataFormat.java @@ -24,7 +24,7 @@ import org.apache.camel.spi.Metadata; import org.apache.camel.spi.RouteContext; /** - * GZip compression data format + * The GZip data format is a message compression and de-compression format (which works with the popular gzip/gunzip tools). * * @version */ http://git-wip-us.apache.org/repos/asf/camel/blob/ce33151b/camel-core/src/main/java/org/apache/camel/model/dataformat/HL7DataFormat.java ---------------------------------------------------------------------- diff --git a/camel-core/src/main/java/org/apache/camel/model/dataformat/HL7DataFormat.java b/camel-core/src/main/java/org/apache/camel/model/dataformat/HL7DataFormat.java index 73c04ff..0a93fe9 100644 --- a/camel-core/src/main/java/org/apache/camel/model/dataformat/HL7DataFormat.java +++ b/camel-core/src/main/java/org/apache/camel/model/dataformat/HL7DataFormat.java @@ -28,7 +28,7 @@ import org.apache.camel.spi.DataFormat; import org.apache.camel.spi.Metadata; /** - * HL7 data format + * The HL7 data format can be used to marshal or unmarshal HL7 (Health Care) model objects. * * @version */ http://git-wip-us.apache.org/repos/asf/camel/blob/ce33151b/camel-core/src/main/java/org/apache/camel/model/dataformat/HessianDataFormat.java ---------------------------------------------------------------------- diff --git a/camel-core/src/main/java/org/apache/camel/model/dataformat/HessianDataFormat.java b/camel-core/src/main/java/org/apache/camel/model/dataformat/HessianDataFormat.java index b076449..7487338 100644 --- a/camel-core/src/main/java/org/apache/camel/model/dataformat/HessianDataFormat.java +++ b/camel-core/src/main/java/org/apache/camel/model/dataformat/HessianDataFormat.java @@ -24,11 +24,12 @@ import org.apache.camel.model.DataFormatDefinition; import org.apache.camel.spi.Metadata; /** - * Hessian data format + * Hessian data format is used for marshalling and unmarshalling messages using Cauchoâs Hessian format. */ @Metadata(firstVersion = "2.17.0", label = "dataformat,transformation", title = "Hessian") @XmlRootElement(name = "hessian") @XmlAccessorType(XmlAccessType.FIELD) +@Deprecated public class HessianDataFormat extends DataFormatDefinition { public HessianDataFormat() { http://git-wip-us.apache.org/repos/asf/camel/blob/ce33151b/camel-core/src/main/java/org/apache/camel/model/dataformat/IcalDataFormat.java ---------------------------------------------------------------------- diff --git a/camel-core/src/main/java/org/apache/camel/model/dataformat/IcalDataFormat.java b/camel-core/src/main/java/org/apache/camel/model/dataformat/IcalDataFormat.java index c924051..d4b5ce5 100644 --- a/camel-core/src/main/java/org/apache/camel/model/dataformat/IcalDataFormat.java +++ b/camel-core/src/main/java/org/apache/camel/model/dataformat/IcalDataFormat.java @@ -27,9 +27,7 @@ import org.apache.camel.spi.DataFormat; import org.apache.camel.spi.Metadata; /** - * iCal data format - * - * @version + * The iCal dataformat is used for working with iCalendar messages. */ @Metadata(firstVersion = "2.12.0", label = "dataformat,transformation", title = "iCal") @XmlRootElement(name = "ical") http://git-wip-us.apache.org/repos/asf/camel/blob/ce33151b/camel-core/src/main/java/org/apache/camel/model/dataformat/JacksonXMLDataFormat.java ---------------------------------------------------------------------- diff --git a/camel-core/src/main/java/org/apache/camel/model/dataformat/JacksonXMLDataFormat.java b/camel-core/src/main/java/org/apache/camel/model/dataformat/JacksonXMLDataFormat.java index a3ae0f1..65d5530 100644 --- a/camel-core/src/main/java/org/apache/camel/model/dataformat/JacksonXMLDataFormat.java +++ b/camel-core/src/main/java/org/apache/camel/model/dataformat/JacksonXMLDataFormat.java @@ -30,7 +30,7 @@ import org.apache.camel.spi.RouteContext; import org.apache.camel.util.ObjectHelper; /** - * Jackson XML data format + * JacksonXML data format is used for unmarshal a XML payload to POJO or to marshal POJO back to XML payload. * * @version */ http://git-wip-us.apache.org/repos/asf/camel/blob/ce33151b/camel-core/src/main/java/org/apache/camel/model/dataformat/JaxbDataFormat.java ---------------------------------------------------------------------- diff --git a/camel-core/src/main/java/org/apache/camel/model/dataformat/JaxbDataFormat.java b/camel-core/src/main/java/org/apache/camel/model/dataformat/JaxbDataFormat.java index 67e79ae..0dcdb3e 100644 --- a/camel-core/src/main/java/org/apache/camel/model/dataformat/JaxbDataFormat.java +++ b/camel-core/src/main/java/org/apache/camel/model/dataformat/JaxbDataFormat.java @@ -31,7 +31,7 @@ import org.apache.camel.util.CamelContextHelper; import org.apache.camel.util.ObjectHelper; /** - * JAXB data format + * JAXB data format uses the JAXB2 XML marshalling standard to unmarshal an XML payload into Java objects or to marshal Java objects into an XML payload. * * @version */ http://git-wip-us.apache.org/repos/asf/camel/blob/ce33151b/camel-core/src/main/java/org/apache/camel/model/dataformat/JibxDataFormat.java ---------------------------------------------------------------------- diff --git a/camel-core/src/main/java/org/apache/camel/model/dataformat/JibxDataFormat.java b/camel-core/src/main/java/org/apache/camel/model/dataformat/JibxDataFormat.java index 9b6634a..997e73c 100644 --- a/camel-core/src/main/java/org/apache/camel/model/dataformat/JibxDataFormat.java +++ b/camel-core/src/main/java/org/apache/camel/model/dataformat/JibxDataFormat.java @@ -30,7 +30,7 @@ import org.apache.camel.spi.RouteContext; import org.apache.camel.util.ObjectHelper; /** - * JiBX data format + * JiBX data format is used for unmarshal a XML payload to POJO or to marshal POJO back to XML payload. */ @Metadata(firstVersion = "2.6.0", label = "dataformat,transformation,xml", title = "JiBX") @XmlRootElement(name = "jibx") http://git-wip-us.apache.org/repos/asf/camel/blob/ce33151b/camel-core/src/main/java/org/apache/camel/model/dataformat/JsonDataFormat.java ---------------------------------------------------------------------- diff --git a/camel-core/src/main/java/org/apache/camel/model/dataformat/JsonDataFormat.java b/camel-core/src/main/java/org/apache/camel/model/dataformat/JsonDataFormat.java index 4b6010e..5fe3e66 100644 --- a/camel-core/src/main/java/org/apache/camel/model/dataformat/JsonDataFormat.java +++ b/camel-core/src/main/java/org/apache/camel/model/dataformat/JsonDataFormat.java @@ -31,7 +31,7 @@ import org.apache.camel.util.CollectionStringBuffer; import org.apache.camel.util.ObjectHelper; /** - * JSon data format + * JSon data format is used for unmarshal a JSon payload to POJO or to marshal POJO back to JSon payload. * * @version */ http://git-wip-us.apache.org/repos/asf/camel/blob/ce33151b/camel-core/src/main/java/org/apache/camel/model/dataformat/LZFDataFormat.java ---------------------------------------------------------------------- diff --git a/camel-core/src/main/java/org/apache/camel/model/dataformat/LZFDataFormat.java b/camel-core/src/main/java/org/apache/camel/model/dataformat/LZFDataFormat.java index 3b6ab06..1cd474f 100644 --- a/camel-core/src/main/java/org/apache/camel/model/dataformat/LZFDataFormat.java +++ b/camel-core/src/main/java/org/apache/camel/model/dataformat/LZFDataFormat.java @@ -27,7 +27,7 @@ import org.apache.camel.spi.DataFormat; import org.apache.camel.spi.Metadata; /** - * LZF compression data format + * The LZF data format is a message compression and de-compression format (uses the LZF deflate algorithm). */ @Metadata(firstVersion = "2.17.0", label = "dataformat,transformation", title = "LZF Deflate Compression") @XmlRootElement(name = "lzf") http://git-wip-us.apache.org/repos/asf/camel/blob/ce33151b/camel-core/src/main/java/org/apache/camel/model/dataformat/MimeMultipartDataFormat.java ---------------------------------------------------------------------- diff --git a/camel-core/src/main/java/org/apache/camel/model/dataformat/MimeMultipartDataFormat.java b/camel-core/src/main/java/org/apache/camel/model/dataformat/MimeMultipartDataFormat.java index 457bf5f..8e4a01b 100644 --- a/camel-core/src/main/java/org/apache/camel/model/dataformat/MimeMultipartDataFormat.java +++ b/camel-core/src/main/java/org/apache/camel/model/dataformat/MimeMultipartDataFormat.java @@ -27,7 +27,8 @@ import org.apache.camel.spi.DataFormat; import org.apache.camel.spi.Metadata; /** - * MIME Multipart data format + * The MIME Multipart data format can marshal a Camel message with attachments into a Camel message + * having a MIME-Multipart message as message body (and no attachments), and vise-versa when unmarshalling. */ @Metadata(firstVersion = "2.17.0", label = "dataformat,transformation", title = "MIME Multipart") @XmlRootElement(name = "mime-multipart") http://git-wip-us.apache.org/repos/asf/camel/blob/ce33151b/camel-core/src/main/java/org/apache/camel/model/dataformat/PGPDataFormat.java ---------------------------------------------------------------------- diff --git a/camel-core/src/main/java/org/apache/camel/model/dataformat/PGPDataFormat.java b/camel-core/src/main/java/org/apache/camel/model/dataformat/PGPDataFormat.java index 8f912c7..bcb1fc3 100644 --- a/camel-core/src/main/java/org/apache/camel/model/dataformat/PGPDataFormat.java +++ b/camel-core/src/main/java/org/apache/camel/model/dataformat/PGPDataFormat.java @@ -27,7 +27,7 @@ import org.apache.camel.spi.DataFormat; import org.apache.camel.spi.Metadata; /** - * PGP data format + * PGP data format is used for encrypting and decrypting of messages using Java Cryptographic Extension and PGP. */ @Metadata(firstVersion = "2.9.0", label = "dataformat,transformation,security", title = "PGP") @XmlRootElement(name = "pgp") http://git-wip-us.apache.org/repos/asf/camel/blob/ce33151b/camel-core/src/main/java/org/apache/camel/model/dataformat/ProtobufDataFormat.java ---------------------------------------------------------------------- diff --git a/camel-core/src/main/java/org/apache/camel/model/dataformat/ProtobufDataFormat.java b/camel-core/src/main/java/org/apache/camel/model/dataformat/ProtobufDataFormat.java index cde7b29..864ebcd 100644 --- a/camel-core/src/main/java/org/apache/camel/model/dataformat/ProtobufDataFormat.java +++ b/camel-core/src/main/java/org/apache/camel/model/dataformat/ProtobufDataFormat.java @@ -28,7 +28,7 @@ import org.apache.camel.spi.DataFormat; import org.apache.camel.spi.Metadata; /** - * Google protobuf data format + * The Protobuf data format is used for serializing between Java objects and the Google Protobuf protocol. * * @version */ http://git-wip-us.apache.org/repos/asf/camel/blob/ce33151b/camel-core/src/main/java/org/apache/camel/model/dataformat/RssDataFormat.java ---------------------------------------------------------------------- diff --git a/camel-core/src/main/java/org/apache/camel/model/dataformat/RssDataFormat.java b/camel-core/src/main/java/org/apache/camel/model/dataformat/RssDataFormat.java index 473ab16..cf9bad5 100644 --- a/camel-core/src/main/java/org/apache/camel/model/dataformat/RssDataFormat.java +++ b/camel-core/src/main/java/org/apache/camel/model/dataformat/RssDataFormat.java @@ -24,7 +24,7 @@ import org.apache.camel.model.DataFormatDefinition; import org.apache.camel.spi.Metadata; /** - * RSS data format + * RSS data format is used for working with RSS sync feed Java Objects and transforming to XML and vice-versa. */ @Metadata(firstVersion = "2.1.0", label = "dataformat,transformation", title = "RSS") @XmlRootElement(name = "rss") http://git-wip-us.apache.org/repos/asf/camel/blob/ce33151b/camel-core/src/main/java/org/apache/camel/model/dataformat/SerializationDataFormat.java ---------------------------------------------------------------------- diff --git a/camel-core/src/main/java/org/apache/camel/model/dataformat/SerializationDataFormat.java b/camel-core/src/main/java/org/apache/camel/model/dataformat/SerializationDataFormat.java index f7f0f61..7d88c37 100644 --- a/camel-core/src/main/java/org/apache/camel/model/dataformat/SerializationDataFormat.java +++ b/camel-core/src/main/java/org/apache/camel/model/dataformat/SerializationDataFormat.java @@ -24,7 +24,8 @@ import org.apache.camel.spi.Metadata; import org.apache.camel.spi.RouteContext; /** - * Java Object Serialization data format + * Serialization is a data format which uses the standard Java Serialization mechanism + * to unmarshal a binary payload into Java objects or to marshal Java objects into a binary blob. * * @version */ http://git-wip-us.apache.org/repos/asf/camel/blob/ce33151b/camel-core/src/main/java/org/apache/camel/model/dataformat/SoapJaxbDataFormat.java ---------------------------------------------------------------------- diff --git a/camel-core/src/main/java/org/apache/camel/model/dataformat/SoapJaxbDataFormat.java b/camel-core/src/main/java/org/apache/camel/model/dataformat/SoapJaxbDataFormat.java index 1107d2d..079b502 100644 --- a/camel-core/src/main/java/org/apache/camel/model/dataformat/SoapJaxbDataFormat.java +++ b/camel-core/src/main/java/org/apache/camel/model/dataformat/SoapJaxbDataFormat.java @@ -28,7 +28,7 @@ import org.apache.camel.spi.DataFormat; import org.apache.camel.spi.Metadata; /** - * SOAP data format + * SOAP is a data format which uses JAXB2 and JAX-WS annotations to marshal and unmarshal SOAP payloads. */ @Metadata(firstVersion = "2.3.0", label = "dataformat,transformation,xml", title = "SOAP") @XmlRootElement(name = "soapjaxb") http://git-wip-us.apache.org/repos/asf/camel/blob/ce33151b/camel-core/src/main/java/org/apache/camel/model/dataformat/StringDataFormat.java ---------------------------------------------------------------------- diff --git a/camel-core/src/main/java/org/apache/camel/model/dataformat/StringDataFormat.java b/camel-core/src/main/java/org/apache/camel/model/dataformat/StringDataFormat.java index 45bde31..da23c67 100644 --- a/camel-core/src/main/java/org/apache/camel/model/dataformat/StringDataFormat.java +++ b/camel-core/src/main/java/org/apache/camel/model/dataformat/StringDataFormat.java @@ -27,7 +27,7 @@ import org.apache.camel.spi.Metadata; import org.apache.camel.spi.RouteContext; /** - * String (text based) data format + * String data format is a textual based format that supports character encoding. * * @version */ http://git-wip-us.apache.org/repos/asf/camel/blob/ce33151b/camel-core/src/main/java/org/apache/camel/model/dataformat/SyslogDataFormat.java ---------------------------------------------------------------------- diff --git a/camel-core/src/main/java/org/apache/camel/model/dataformat/SyslogDataFormat.java b/camel-core/src/main/java/org/apache/camel/model/dataformat/SyslogDataFormat.java index 5fdf974..1df9a64 100644 --- a/camel-core/src/main/java/org/apache/camel/model/dataformat/SyslogDataFormat.java +++ b/camel-core/src/main/java/org/apache/camel/model/dataformat/SyslogDataFormat.java @@ -24,11 +24,11 @@ import org.apache.camel.model.DataFormatDefinition; import org.apache.camel.spi.Metadata; /** - * Syslog data format + * The Syslog dataformat is used for working with RFC3164 and RFC5424 messages (logging and monitoring). * * @version */ -@Metadata(firstVersion = "2.6.0", label = "dataformat,transformation", title = "Syslog") +@Metadata(firstVersion = "2.6.0", label = "dataformat,transformation,monitoring", title = "Syslog") @XmlRootElement(name = "syslog") @XmlAccessorType(XmlAccessType.FIELD) public class SyslogDataFormat extends DataFormatDefinition { http://git-wip-us.apache.org/repos/asf/camel/blob/ce33151b/camel-core/src/main/java/org/apache/camel/model/dataformat/TarFileDataFormat.java ---------------------------------------------------------------------- diff --git a/camel-core/src/main/java/org/apache/camel/model/dataformat/TarFileDataFormat.java b/camel-core/src/main/java/org/apache/camel/model/dataformat/TarFileDataFormat.java index ec17c4b..26153f8 100644 --- a/camel-core/src/main/java/org/apache/camel/model/dataformat/TarFileDataFormat.java +++ b/camel-core/src/main/java/org/apache/camel/model/dataformat/TarFileDataFormat.java @@ -27,7 +27,7 @@ import org.apache.camel.spi.DataFormat; import org.apache.camel.spi.Metadata; /** - * TAR file data format + * The Tar File data format is a message compression and de-compression format of tar files. */ @Metadata(firstVersion = "2.16.0", label = "dataformat,transformation,file", title = "Tar File") @XmlRootElement(name = "tarfile") http://git-wip-us.apache.org/repos/asf/camel/blob/ce33151b/camel-core/src/main/java/org/apache/camel/model/dataformat/ThriftDataFormat.java ---------------------------------------------------------------------- diff --git a/camel-core/src/main/java/org/apache/camel/model/dataformat/ThriftDataFormat.java b/camel-core/src/main/java/org/apache/camel/model/dataformat/ThriftDataFormat.java index 242ca25..1d9ee1b 100644 --- a/camel-core/src/main/java/org/apache/camel/model/dataformat/ThriftDataFormat.java +++ b/camel-core/src/main/java/org/apache/camel/model/dataformat/ThriftDataFormat.java @@ -28,7 +28,7 @@ import org.apache.camel.spi.DataFormat; import org.apache.camel.spi.Metadata; /** - * Apache Thrift data format + * The Thrift data format is used for serialization and deserialization of messages using Apache Thrift binary dataformat. * * @version */ http://git-wip-us.apache.org/repos/asf/camel/blob/ce33151b/camel-core/src/main/java/org/apache/camel/model/dataformat/TidyMarkupDataFormat.java ---------------------------------------------------------------------- diff --git a/camel-core/src/main/java/org/apache/camel/model/dataformat/TidyMarkupDataFormat.java b/camel-core/src/main/java/org/apache/camel/model/dataformat/TidyMarkupDataFormat.java index f5cd15c..b747f5d 100644 --- a/camel-core/src/main/java/org/apache/camel/model/dataformat/TidyMarkupDataFormat.java +++ b/camel-core/src/main/java/org/apache/camel/model/dataformat/TidyMarkupDataFormat.java @@ -32,7 +32,7 @@ import org.apache.camel.spi.RouteContext; import org.apache.camel.util.ObjectHelper; /** - * Tidymark (wellformed HTML) data format + * TidyMarkup data format is used for parsing HTML and return it as pretty well-formed HTML. */ @Metadata(firstVersion = "2.0.0", label = "dataformat,transformation", title = "TidyMarkup") @XmlRootElement(name = "tidyMarkup") http://git-wip-us.apache.org/repos/asf/camel/blob/ce33151b/camel-core/src/main/java/org/apache/camel/model/dataformat/UniVocityCsvDataFormat.java ---------------------------------------------------------------------- diff --git a/camel-core/src/main/java/org/apache/camel/model/dataformat/UniVocityCsvDataFormat.java b/camel-core/src/main/java/org/apache/camel/model/dataformat/UniVocityCsvDataFormat.java index 4d59f43..63311d7 100644 --- a/camel-core/src/main/java/org/apache/camel/model/dataformat/UniVocityCsvDataFormat.java +++ b/camel-core/src/main/java/org/apache/camel/model/dataformat/UniVocityCsvDataFormat.java @@ -26,7 +26,7 @@ import org.apache.camel.spi.DataFormat; import org.apache.camel.spi.Metadata; /** - * UniVocity CSV data format + * The uniVocity CSV data format is used for working with CSV (Comma Separated Values) flat payloads. */ @Metadata(firstVersion = "2.15.0", label = "dataformat,transformation,csv", title = "uniVocity CSV") @XmlRootElement(name = "univocity-csv") http://git-wip-us.apache.org/repos/asf/camel/blob/ce33151b/camel-core/src/main/java/org/apache/camel/model/dataformat/UniVocityFixedWidthDataFormat.java ---------------------------------------------------------------------- diff --git a/camel-core/src/main/java/org/apache/camel/model/dataformat/UniVocityFixedWidthDataFormat.java b/camel-core/src/main/java/org/apache/camel/model/dataformat/UniVocityFixedWidthDataFormat.java index 00675d8..d27d536 100644 --- a/camel-core/src/main/java/org/apache/camel/model/dataformat/UniVocityFixedWidthDataFormat.java +++ b/camel-core/src/main/java/org/apache/camel/model/dataformat/UniVocityFixedWidthDataFormat.java @@ -26,7 +26,7 @@ import org.apache.camel.spi.DataFormat; import org.apache.camel.spi.Metadata; /** - * UniVocity fixed-width data format + * The uniVocity Fixed Length data format is used for working with fixed length flat payloads. */ @Metadata(firstVersion = "2.15.0", label = "dataformat,transformation,csv", title = "uniVocity Fixed Length") @XmlRootElement(name = "univocity-fixed") http://git-wip-us.apache.org/repos/asf/camel/blob/ce33151b/camel-core/src/main/java/org/apache/camel/model/dataformat/UniVocityTsvDataFormat.java ---------------------------------------------------------------------- diff --git a/camel-core/src/main/java/org/apache/camel/model/dataformat/UniVocityTsvDataFormat.java b/camel-core/src/main/java/org/apache/camel/model/dataformat/UniVocityTsvDataFormat.java index 88334a1..b422098 100644 --- a/camel-core/src/main/java/org/apache/camel/model/dataformat/UniVocityTsvDataFormat.java +++ b/camel-core/src/main/java/org/apache/camel/model/dataformat/UniVocityTsvDataFormat.java @@ -26,7 +26,7 @@ import org.apache.camel.spi.DataFormat; import org.apache.camel.spi.Metadata; /** - * UniVocity TSV data format + * The uniVocity TSV data format is used for working with TSV (Tabular Separated Values) flat payloads. */ @Metadata(firstVersion = "2.15.0", label = "dataformat,transformation,csv", title = "uniVocity TSV") @XmlRootElement(name = "univocity-tsv") http://git-wip-us.apache.org/repos/asf/camel/blob/ce33151b/camel-core/src/main/java/org/apache/camel/model/dataformat/XMLBeansDataFormat.java ---------------------------------------------------------------------- diff --git a/camel-core/src/main/java/org/apache/camel/model/dataformat/XMLBeansDataFormat.java b/camel-core/src/main/java/org/apache/camel/model/dataformat/XMLBeansDataFormat.java index b5937d6..caefc03 100644 --- a/camel-core/src/main/java/org/apache/camel/model/dataformat/XMLBeansDataFormat.java +++ b/camel-core/src/main/java/org/apache/camel/model/dataformat/XMLBeansDataFormat.java @@ -25,13 +25,14 @@ import org.apache.camel.model.DataFormatDefinition; import org.apache.camel.spi.Metadata; /** - * XMLBeans data format + * XML Beans data format is used for unmarshal a XML payload to POJO or to marshal POJO back to XML payload. * * @version */ @Metadata(firstVersion = "1.2.0", label = "dataformat,transformation,xml", title = "XML Beans") @XmlRootElement(name = "xmlBeans") @XmlAccessorType(XmlAccessType.FIELD) +@Deprecated public class XMLBeansDataFormat extends DataFormatDefinition { @XmlAttribute private Boolean prettyPrint; http://git-wip-us.apache.org/repos/asf/camel/blob/ce33151b/camel-core/src/main/java/org/apache/camel/model/dataformat/XMLSecurityDataFormat.java ---------------------------------------------------------------------- diff --git a/camel-core/src/main/java/org/apache/camel/model/dataformat/XMLSecurityDataFormat.java b/camel-core/src/main/java/org/apache/camel/model/dataformat/XMLSecurityDataFormat.java index 264540f..acefe2f 100644 --- a/camel-core/src/main/java/org/apache/camel/model/dataformat/XMLSecurityDataFormat.java +++ b/camel-core/src/main/java/org/apache/camel/model/dataformat/XMLSecurityDataFormat.java @@ -32,7 +32,7 @@ import org.apache.camel.spi.NamespaceAware; import org.apache.camel.util.jsse.KeyStoreParameters; /** - * XML-Security data format + * The XML Security data format facilitates encryption and decryption of XML payloads. */ @Metadata(firstVersion = "2.0.0", label = "dataformat,transformation,xml,security", title = "XML Security") @XmlRootElement(name = "secureXML") http://git-wip-us.apache.org/repos/asf/camel/blob/ce33151b/camel-core/src/main/java/org/apache/camel/model/dataformat/XStreamDataFormat.java ---------------------------------------------------------------------- diff --git a/camel-core/src/main/java/org/apache/camel/model/dataformat/XStreamDataFormat.java b/camel-core/src/main/java/org/apache/camel/model/dataformat/XStreamDataFormat.java index 3f382f9..7321fd3 100644 --- a/camel-core/src/main/java/org/apache/camel/model/dataformat/XStreamDataFormat.java +++ b/camel-core/src/main/java/org/apache/camel/model/dataformat/XStreamDataFormat.java @@ -42,7 +42,7 @@ import org.apache.camel.util.CollectionStringBuffer; import org.apache.camel.util.ObjectHelper; /** - * XStream data format + * XSTream data format is used for unmarshal a XML payload to POJO or to marshal POJO back to XML payload. * * @version */ http://git-wip-us.apache.org/repos/asf/camel/blob/ce33151b/camel-core/src/main/java/org/apache/camel/model/dataformat/XmlJsonDataFormat.java ---------------------------------------------------------------------- diff --git a/camel-core/src/main/java/org/apache/camel/model/dataformat/XmlJsonDataFormat.java b/camel-core/src/main/java/org/apache/camel/model/dataformat/XmlJsonDataFormat.java index 858e7cb..fe6da57 100644 --- a/camel-core/src/main/java/org/apache/camel/model/dataformat/XmlJsonDataFormat.java +++ b/camel-core/src/main/java/org/apache/camel/model/dataformat/XmlJsonDataFormat.java @@ -31,7 +31,7 @@ import org.apache.camel.spi.DataFormat; import org.apache.camel.spi.Metadata; /** - * XML-JSon data format + * XML JSon data format can convert from XML to JSON and vice-versa directly, without stepping through intermediate POJOs. * * @version */ http://git-wip-us.apache.org/repos/asf/camel/blob/ce33151b/camel-core/src/main/java/org/apache/camel/model/dataformat/XmlRpcDataFormat.java ---------------------------------------------------------------------- diff --git a/camel-core/src/main/java/org/apache/camel/model/dataformat/XmlRpcDataFormat.java b/camel-core/src/main/java/org/apache/camel/model/dataformat/XmlRpcDataFormat.java index f865f4b..93498a6 100644 --- a/camel-core/src/main/java/org/apache/camel/model/dataformat/XmlRpcDataFormat.java +++ b/camel-core/src/main/java/org/apache/camel/model/dataformat/XmlRpcDataFormat.java @@ -27,7 +27,7 @@ import org.apache.camel.spi.DataFormat; import org.apache.camel.spi.Metadata; /** - * XML-RPC data format + * The XML RPC data format is used for working with the XML RPC protocol. */ @Metadata(firstVersion = "2.11.0", label = "dataformat,transformation,xml", title = "XML RPC") @XmlRootElement(name = "xmlrpc") http://git-wip-us.apache.org/repos/asf/camel/blob/ce33151b/camel-core/src/main/java/org/apache/camel/model/dataformat/YAMLDataFormat.java ---------------------------------------------------------------------- diff --git a/camel-core/src/main/java/org/apache/camel/model/dataformat/YAMLDataFormat.java b/camel-core/src/main/java/org/apache/camel/model/dataformat/YAMLDataFormat.java index 1f76113..d82a420 100644 --- a/camel-core/src/main/java/org/apache/camel/model/dataformat/YAMLDataFormat.java +++ b/camel-core/src/main/java/org/apache/camel/model/dataformat/YAMLDataFormat.java @@ -33,7 +33,7 @@ import org.apache.camel.spi.RouteContext; import org.apache.camel.util.ObjectHelper; /** - * YAML data format + * YAML is a data format to marshal and unmarshal Java objects to and from YAML. * * @version */ http://git-wip-us.apache.org/repos/asf/camel/blob/ce33151b/camel-core/src/main/java/org/apache/camel/model/dataformat/ZipDataFormat.java ---------------------------------------------------------------------- diff --git a/camel-core/src/main/java/org/apache/camel/model/dataformat/ZipDataFormat.java b/camel-core/src/main/java/org/apache/camel/model/dataformat/ZipDataFormat.java index 8248154..bb5e572 100644 --- a/camel-core/src/main/java/org/apache/camel/model/dataformat/ZipDataFormat.java +++ b/camel-core/src/main/java/org/apache/camel/model/dataformat/ZipDataFormat.java @@ -28,7 +28,7 @@ import org.apache.camel.spi.Metadata; import org.apache.camel.spi.RouteContext; /** - * Zip compression data format (not for zip files) + * Zip Deflate Compression data format is a message compression and de-compression format (not zip files). */ @Metadata(firstVersion = "2.12.0", label = "dataformat,transformation", title = "Zip Deflate Compression") @XmlRootElement(name = "zip") http://git-wip-us.apache.org/repos/asf/camel/blob/ce33151b/camel-core/src/main/java/org/apache/camel/model/dataformat/ZipFileDataFormat.java ---------------------------------------------------------------------- diff --git a/camel-core/src/main/java/org/apache/camel/model/dataformat/ZipFileDataFormat.java b/camel-core/src/main/java/org/apache/camel/model/dataformat/ZipFileDataFormat.java index 4d54554..ff2dd60 100644 --- a/camel-core/src/main/java/org/apache/camel/model/dataformat/ZipFileDataFormat.java +++ b/camel-core/src/main/java/org/apache/camel/model/dataformat/ZipFileDataFormat.java @@ -27,7 +27,7 @@ import org.apache.camel.spi.DataFormat; import org.apache.camel.spi.Metadata; /** - * Zip-file data format + * The Zip File data format is a message compression and de-compression format of zip files. */ @Metadata(firstVersion = "2.11.0", label = "dataformat,transformation,file", title = "Zip File") // TODO: use zipfile as name in Camel 3.0 http://git-wip-us.apache.org/repos/asf/camel/blob/ce33151b/components/camel-base64/src/main/docs/base64-dataformat.adoc ---------------------------------------------------------------------- diff --git a/components/camel-base64/src/main/docs/base64-dataformat.adoc b/components/camel-base64/src/main/docs/base64-dataformat.adoc index 0940da2..7603b9d 100644 --- a/components/camel-base64/src/main/docs/base64-dataformat.adoc +++ b/components/camel-base64/src/main/docs/base64-dataformat.adoc @@ -2,10 +2,9 @@ *Available as of Camel version 2.11* - The Base64 link:data-format.html[Data Format] is a data format for -http://en.wikipedia.org/wiki/Base64[base64 encoding and decoding]. +The Base64 data format is used for base64 encoding and decoding. -### Options +=== Options // dataformat options: START The Base64 dataformat supports 4 options which are listed below. @@ -25,7 +24,7 @@ The Base64 dataformat supports 4 options which are listed below. In Spring DSL, you configure the data format using this tag: [source,xml] --------------------------------------------------------------------------------------------------------- +---- <camelContext> <dataFormats> <!-- for a newline character (\n), use the HTML entity notation coupled with the ASCII code. --> @@ -34,65 +33,69 @@ In Spring DSL, you configure the data format using this tag: </dataFormats> ... </camelContext> --------------------------------------------------------------------------------------------------------- +---- Then you can use it later by its reference: [source,xml] ---------------------------------------------- +---- <route> <from uri="direct:startEncode" /> <marshal ref="base64withLineLength64" /> <to uri="mock:result" /> </route> ---------------------------------------------- +---- Most of the time, you won't need to declare the data format if you use the default options. In that case, you can declare the data format inline as shown below. -### Marshal +=== Marshal In this example we marshal the file content to base64 object. [source,java] ---------------------------------------------------------------- -from("file://data.bin").marshal().base64().to("jms://myqueue"); ---------------------------------------------------------------- +---- +from("file://data.bin") + .marshal().base64() + .to("jms://myqueue"); +---- In Spring DSL: [source,xml] ------------------------------ +---- <from uri="file://data.bin"> <marshal> <base64/> </marshal> <to uri="jms://myqueue"/> ------------------------------ +---- -### Unmarshal +=== Unmarshal In this example we unmarshal the payload from the JMS queue to a byte[] object, before its processed by the newOrder processor. [source,java] ----------------------------------------------------------------------- -from("jms://queue/order").unmarshal().base64().processRef("newOrder"); ----------------------------------------------------------------------- +---- +from("jms://queue/order") + .unmarshal().base64() + .process("newOrder"); +---- In Spring DSL: [source,xml] -------------------------------- +---- <from uri="jms://queue/order"> <marshal> <base64/> </marshal> <to uri="bean:newOrder"/> -------------------------------- +---- -### Dependencies +=== Dependencies To use Base64 in your Camel routes you need to add a dependency on *camel-base64* which implements this data format. @@ -100,10 +103,10 @@ To use Base64 in your Camel routes you need to add a dependency on If you use Maven you can just add the following to your pom.xml: [source,xml] ------------------------------------------------------------------------------------- +---- <dependency> <groupId>org.apache.camel</groupId> <artifactId>camel-base64</artifactId> <version>x.x.x</version> <!-- use the same version as your Camel core version --> </dependency> ------------------------------------------------------------------------------------- +---- http://git-wip-us.apache.org/repos/asf/camel/blob/ce33151b/components/camel-ftp/src/main/docs/ftp-component.adoc ---------------------------------------------------------------------- diff --git a/components/camel-ftp/src/main/docs/ftp-component.adoc b/components/camel-ftp/src/main/docs/ftp-component.adoc index 610b704..cc3cd91 100644 --- a/components/camel-ftp/src/main/docs/ftp-component.adoc +++ b/components/camel-ftp/src/main/docs/ftp-component.adoc @@ -97,7 +97,7 @@ with the following path and query parameters: | *directoryName* | The starting directory | | String |=== -==== Query Parameters (102 parameters): +==== Query Parameters (103 parameters): [width="100%",cols="2,5,^1,2",options="header"] |=== @@ -122,6 +122,7 @@ with the following path and query parameters: | *download* (consumer) | Whether the FTP consumer should download the file. If this option is set to false then the message body will be null but the consumer will still trigger a Camel Exchange that has details about the file such as file name file size etc. It's just that the file will not be downloaded. | false | boolean | *exceptionHandler* (consumer) | To let the consumer use a custom ExceptionHandler. Notice if the option bridgeErrorHandler is enabled then this options is not in use. By default the consumer will deal with exceptions that will be logged at WARN or ERROR level and ignored. | | ExceptionHandler | *exchangePattern* (consumer) | Sets the exchange pattern when the consumer creates an exchange. | | ExchangePattern +| *handleDirectoryParser AbsoluteResult* (consumer) | Allows you to set how the consumer will handle subfolders and files in the path if the directory parser results in with absolute paths The reason for this is that some FTP servers may return file names with absolute paths and if so then the FTP component needs to handle this by converting the returned path into a relative path. | false | boolean | *ignoreFileNotFoundOr PermissionError* (consumer) | Whether to ignore when trying to download a file which does not exist or due to permission error. By default when a file does not exists or insufficient permission then an exception is thrown. Setting this option to true allows to ignore that instead. | false | boolean | *inProgressRepository* (consumer) | A pluggable in-progress repository org.apache.camel.spi.IdempotentRepository. The in-progress repository is used to account the current in progress files being consumed. By default a memory based repository is used. | | String> | *localWorkDirectory* (consumer) | When consuming a local work directory can be used to store the remote file content directly in local files to avoid loading the content into memory. This is beneficial if you consume a very big remote file and thus can conserve memory. | | String http://git-wip-us.apache.org/repos/asf/camel/blob/ce33151b/components/camel-ftp/src/main/docs/ftps-component.adoc ---------------------------------------------------------------------- diff --git a/components/camel-ftp/src/main/docs/ftps-component.adoc b/components/camel-ftp/src/main/docs/ftps-component.adoc index adb771d..51ec986 100644 --- a/components/camel-ftp/src/main/docs/ftps-component.adoc +++ b/components/camel-ftp/src/main/docs/ftps-component.adoc @@ -57,7 +57,7 @@ with the following path and query parameters: | *directoryName* | The starting directory | | String |=== -==== Query Parameters (110 parameters): +==== Query Parameters (111 parameters): [width="100%",cols="2,5,^1,2",options="header"] |=== @@ -82,6 +82,7 @@ with the following path and query parameters: | *download* (consumer) | Whether the FTP consumer should download the file. If this option is set to false then the message body will be null but the consumer will still trigger a Camel Exchange that has details about the file such as file name file size etc. It's just that the file will not be downloaded. | false | boolean | *exceptionHandler* (consumer) | To let the consumer use a custom ExceptionHandler. Notice if the option bridgeErrorHandler is enabled then this options is not in use. By default the consumer will deal with exceptions that will be logged at WARN or ERROR level and ignored. | | ExceptionHandler | *exchangePattern* (consumer) | Sets the exchange pattern when the consumer creates an exchange. | | ExchangePattern +| *handleDirectoryParser AbsoluteResult* (consumer) | Allows you to set how the consumer will handle subfolders and files in the path if the directory parser results in with absolute paths The reason for this is that some FTP servers may return file names with absolute paths and if so then the FTP component needs to handle this by converting the returned path into a relative path. | false | boolean | *ignoreFileNotFoundOr PermissionError* (consumer) | Whether to ignore when trying to download a file which does not exist or due to permission error. By default when a file does not exists or insufficient permission then an exception is thrown. Setting this option to true allows to ignore that instead. | false | boolean | *inProgressRepository* (consumer) | A pluggable in-progress repository org.apache.camel.spi.IdempotentRepository. The in-progress repository is used to account the current in progress files being consumed. By default a memory based repository is used. | | String> | *localWorkDirectory* (consumer) | When consuming a local work directory can be used to store the remote file content directly in local files to avoid loading the content into memory. This is beneficial if you consume a very big remote file and thus can conserve memory. | | String http://git-wip-us.apache.org/repos/asf/camel/blob/ce33151b/components/camel-hessian/src/main/docs/hessian-dataformat.adoc ---------------------------------------------------------------------- diff --git a/components/camel-hessian/src/main/docs/hessian-dataformat.adoc b/components/camel-hessian/src/main/docs/hessian-dataformat.adoc index 916085d..60910bf 100644 --- a/components/camel-hessian/src/main/docs/hessian-dataformat.adoc +++ b/components/camel-hessian/src/main/docs/hessian-dataformat.adoc @@ -1,4 +1,4 @@ -== Hessian DataFormat +== Hessian DataFormat (deprecated) *Available as of Camel version 2.17* @@ -48,4 +48,4 @@ The Hessian dataformat supports 1 options which are listed below. <marshal ref="hessian"/> </route> </camelContext> --------------------------------------------------------------------------------- +-------------------------------------------------------------------------------- \ No newline at end of file http://git-wip-us.apache.org/repos/asf/camel/blob/ce33151b/components/camel-xmlbeans/src/main/docs/xmlBeans-dataformat.adoc ---------------------------------------------------------------------- diff --git a/components/camel-xmlbeans/src/main/docs/xmlBeans-dataformat.adoc b/components/camel-xmlbeans/src/main/docs/xmlBeans-dataformat.adoc index 4ad408e..6c53469 100644 --- a/components/camel-xmlbeans/src/main/docs/xmlBeans-dataformat.adoc +++ b/components/camel-xmlbeans/src/main/docs/xmlBeans-dataformat.adoc @@ -1,4 +1,4 @@ -== XML Beans DataFormat +== XML Beans DataFormat (deprecated) *Available as of Camel version 1.2* @@ -46,4 +46,4 @@ link:download.html[the download page for the latest versions]). <version>x.x.x</version> <!-- use the same version as your Camel core version --> </dependency> ----------------------------------------------------------- +---------------------------------------------------------- \ No newline at end of file http://git-wip-us.apache.org/repos/asf/camel/blob/ce33151b/components/camel-zipfile/src/main/docs/zipfile-dataformat.adoc ---------------------------------------------------------------------- diff --git a/components/camel-zipfile/src/main/docs/zipfile-dataformat.adoc b/components/camel-zipfile/src/main/docs/zipfile-dataformat.adoc index d40512f..34282d1 100644 --- a/components/camel-zipfile/src/main/docs/zipfile-dataformat.adoc +++ b/components/camel-zipfile/src/main/docs/zipfile-dataformat.adoc @@ -6,15 +6,9 @@ The Zip File link:data-format.html[Data Format] is a message compression and de-compression format. Messages can be marshalled (compressed) to Zip files containing a single entry, and Zip files containing a single entry can be unmarshalled (decompressed) to the original file contents. -This data format supports ZIP64, as long as -https://blogs.oracle.com/xuemingshen/entry/zip64_support_for_4g_zipfile[Java -7 or later is being used]. - -Since Camel 2.12.3 there is also a aggregation strategy that can -aggregate multiple messages into a single Zip file. - -### ZipFile Options +This data format supports ZIP64, as long as Java 7 or later is being used]. +=== ZipFile Options // dataformat options: START The Zip File dataformat supports 3 options which are listed below. @@ -30,18 +24,18 @@ The Zip File dataformat supports 3 options which are listed below. |=== // dataformat options: END - - -### Marshal +=== Marshal In this example we marshal a regular text/XML payload to a compressed payload using Zip file compression, and send it to an ActiveMQ queue called MY_QUEUE. [source,java] ------------------------------------------------------------------------ -from("direct:start").marshal().zipFile().to("activemq:queue:MY_QUEUE"); ------------------------------------------------------------------------ +---- +from("direct:start") + .marshal().zipFile() + .to("activemq:queue:MY_QUEUE"); +---- The name of the Zip entry inside the created Zip file is based on the incoming `CamelFileName` message header, which is the standard message @@ -53,9 +47,11 @@ suffix. So for example, if the following route finds a file named "test.txt.zip" containing a single Zip entry named "test.txt": [source,java] ------------------------------------------------------------------------------------------------ -from("file:input/directory?antInclude=*/.txt").marshal().zipFile().to("file:output/directory"); ------------------------------------------------------------------------------------------------ +---- +from("file:input/directory?antInclude=*/.txt") + .marshal().zipFile() + .to("file:output/directory"); +---- If there is no incoming `CamelFileName` message header (for example, if the link:file2.html[file component] is not the consumer), then the @@ -66,71 +62,71 @@ this behavior, then you can set the value of the `CamelFileName` header explicitly in your route: [source,java] ---------------------------------------------------------------------------------------------------------------------------- -from("direct:start").setHeader(Exchange.FILE_NAME, constant("report.txt")).marshal().zipFile().to("file:output/directory"); ---------------------------------------------------------------------------------------------------------------------------- +---- +from("direct:start") + .setHeader(Exchange.FILE_NAME, constant("report.txt")) + .marshal().zipFile() + .to("file:output/directory"); +---- This route would result in a Zip file named "report.txt.zip" in the output directory, containing a single Zip entry named "report.txt". -### Unmarshal +=== Unmarshal In this example we unmarshal a Zip file payload from an ActiveMQ queue called MY_QUEUE to its original format, and forward it for processing to the `UnZippedMessageProcessor`. [source,java] ------------------------------------------------------------------------------------------------ -from("activemq:queue:MY_QUEUE").unmarshal().zipFile().process(new UnZippedMessageProcessor()); ------------------------------------------------------------------------------------------------ +---- +from("activemq:queue:MY_QUEUE") + .unmarshal().zipFile() + .process(new UnZippedMessageProcessor()); +---- If the zip file has more then one entry, the usingIterator option of ZipFileDataFormat to be true, and you can use splitter to do the further work. [source,java] ----------------------------------------------------------------------------------------------------- - ZipFileDataFormat zipFile = new ZipFileDataFormat(); - zipFile.setUsingIterator(true); - from("file:src/test/resources/org/apache/camel/dataformat/zipfile/?consumer.delay=1000&noop=true") +---- +ZipFileDataFormat zipFile = new ZipFileDataFormat(); +zipFile.setUsingIterator(true); + +from("file:src/test/resources/org/apache/camel/dataformat/zipfile/?consumer.delay=1000&noop=true") .unmarshal(zipFile) - .split(body(Iterator.class)) - .streaming() - .process(new UnZippedMessageProcessor()) + .split(body(Iterator.class)).streaming() + .process(new UnZippedMessageProcessor()) .end(); ----------------------------------------------------------------------------------------------------- +---- Or you can use the ZipSplitter as an expression for splitter directly like this [source,java] ----------------------------------------------------------------------------------------------------- - from("file:src/test/resources/org/apache/camel/dataformat/zipfile?consumer.delay=1000&noop=true") - .split(new ZipSplitter()) - .streaming() +---- +from("file:src/test/resources/org/apache/camel/dataformat/zipfile?consumer.delay=1000&noop=true") + .split(new ZipSplitter()).streaming() .process(new UnZippedMessageProcessor()) - .end(); ----------------------------------------------------------------------------------------------------- - -### Aggregate + .end(); +---- -TIP:*Available since Camel 2.12.3* +=== Aggregate -INFO:Please note that this aggregation strategy requires eager completion -check to work properly. +[NOTE] +Please 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 Zip file that is stored in the output directory. [source,java] -------------------------------------------------- - from("file:input/directory?antInclude=*/.txt") - .aggregate(new ZipAggregationStrategy()) - .constant(true) - .completionFromBatchConsumer() - .eagerCheckCompletion() - .to("file:output/directory"); -------------------------------------------------- +---- +from("file:input/directory?antInclude=*/.txt") + .aggregate(constant(true), new ZipAggregationStrategy()) + .completionFromBatchConsumer().eagerCheckCompletion() + .to("file:output/directory"); +---- The outgoing `CamelFileName` message header is created using java.io.File.createTempFile, with the ".zip" suffix. If you want to @@ -138,17 +134,15 @@ override this behavior, then you can set the value of the `CamelFileName` header explicitly in your route: [source,java] ------------------------------------------------------------- - from("file:input/directory?antInclude=*/.txt") - .aggregate(new ZipAggregationStrategy()) - .constant(true) - .completionFromBatchConsumer() - .eagerCheckCompletion() - .setHeader(Exchange.FILE_NAME, constant("reports.zip")) - .to("file:output/directory"); ------------------------------------------------------------- - -### Dependencies +---- +from("file:input/directory?antInclude=*/.txt") + .aggregate(constant(true), new ZipAggregationStrategy()) + .completionFromBatchConsumer().eagerCheckCompletion() + .setHeader(Exchange.FILE_NAME, constant("reports.zip")) + .to("file:output/directory"); +---- + +=== Dependencies To use Zip files in your camel routes you need to add a dependency on *camel-zipfile* which implements this data format. @@ -158,11 +152,11 @@ substituting the version number for the latest & greatest release (see link:download.html[the download page for the latest versions]). [source,xml] ----------------------------------------------------------- +---- <dependency> <groupId>org.apache.camel</groupId> <artifactId>camel-zipfile</artifactId> <version>x.x.x</version> <!-- use the same version as your Camel core version --> </dependency> ----------------------------------------------------------- +---- http://git-wip-us.apache.org/repos/asf/camel/blob/ce33151b/components/readme.adoc ---------------------------------------------------------------------- diff --git a/components/readme.adoc b/components/readme.adoc index e68459e..5815e8a 100644 --- a/components/readme.adoc +++ b/components/readme.adoc @@ -856,7 +856,7 @@ Data Formats ^^^^^^^^^^^^ // dataformats: START -Number of Data Formats: 48 in 39 JAR artifacts (0 deprecated) +Number of Data Formats: 48 in 39 JAR artifacts (2 deprecated) [width="100%",cols="4,1,5",options="header"] |=== @@ -888,9 +888,9 @@ Number of Data Formats: 48 in 39 JAR artifacts (0 deprecated) | link:camel-flatpack/src/main/docs/flatpack-dataformat.adoc[Flatpack] (camel-flatpack) | 2.1 | Camel FlatPack support -| link:../camel-core/src/main/docs/gzip-dataformat.adoc[GZip] (camel-core) | 2.0 | GZip compression data format +| link:../camel-core/src/main/docs/gzip-dataformat.adoc[GZip] (camel-core) | 2.0 | The GZip data format is a message compression and de-compression format (which works with the popular gzip/gunzip tools). -| link:camel-hessian/src/main/docs/hessian-dataformat.adoc[Hessian] (camel-hessian) | 2.17 | Hessian serialization support +| link:camel-hessian/src/main/docs/hessian-dataformat.adoc[Hessian] (camel-hessian) | 2.17 | *deprecated* Hessian serialization support | link:camel-hl7/src/main/docs/hl7-dataformat.adoc[HL7] (camel-hl7) | 2.0 | Camel HL7 support @@ -898,7 +898,7 @@ Number of Data Formats: 48 in 39 JAR artifacts (0 deprecated) | link:camel-jacksonxml/src/main/docs/jacksonxml-dataformat.adoc[JacksonXML] (camel-jacksonxml) | 2.16 | Camel Jackson XML support -| link:../camel-core/src/main/docs/serialization-dataformat.adoc[Java Object Serialization] (camel-core) | 2.12 | Java Object Serialization data format +| link:../camel-core/src/main/docs/serialization-dataformat.adoc[Java Object Serialization] (camel-core) | 2.12 | Serialization is a data format which uses the standard Java Serialization mechanism to unmarshal a binary payload into Java objects or to marshal Java objects into a binary blob. | link:camel-jaxb/src/main/docs/jaxb-dataformat.adoc[JAXB] (camel-jaxb) | 1.0 | Camel JAXB support @@ -926,7 +926,7 @@ Number of Data Formats: 48 in 39 JAR artifacts (0 deprecated) | link:camel-soap/src/main/docs/soapjaxb-dataformat.adoc[SOAP] (camel-soap) | 2.3 | Camel SOAP support -| link:../camel-core/src/main/docs/string-dataformat.adoc[String Encoding] (camel-core) | 2.12 | String (text based) data format +| link:../camel-core/src/main/docs/string-dataformat.adoc[String Encoding] (camel-core) | 2.12 | String data format is a textual based format that supports character encoding. | link:camel-syslog/src/main/docs/syslog-dataformat.adoc[Syslog] (camel-syslog) | 2.6 | Camel Syslog support @@ -942,7 +942,7 @@ Number of Data Formats: 48 in 39 JAR artifacts (0 deprecated) | link:camel-univocity-parsers/src/main/docs/univocity-tsv-dataformat.adoc[uniVocity TSV] (camel-univocity-parsers) | 2.15 | Camel UniVocity parsers data format support -| link:camel-xmlbeans/src/main/docs/xmlBeans-dataformat.adoc[XML Beans] (camel-xmlbeans) | 1.2 | Camel XMLBeans support +| link:camel-xmlbeans/src/main/docs/xmlBeans-dataformat.adoc[XML Beans] (camel-xmlbeans) | 1.2 | *deprecated* Camel XMLBeans support | link:camel-xmljson/src/main/docs/xmljson-dataformat.adoc[XML JSon] (camel-xmljson) | 2.10 | Camel XML JSON Data Format @@ -954,7 +954,7 @@ Number of Data Formats: 48 in 39 JAR artifacts (0 deprecated) | link:camel-snakeyaml/src/main/docs/yaml-snakeyaml-dataformat.adoc[YAML SnakeYAML] (camel-snakeyaml) | 2.17 | Camel SnakeYAML support -| link:../camel-core/src/main/docs/zip-dataformat.adoc[Zip Deflate Compression] (camel-core) | 2.12 | Zip compression data format (not for zip files) +| link:../camel-core/src/main/docs/zip-dataformat.adoc[Zip Deflate Compression] (camel-core) | 2.12 | Zip Deflate Compression data format is a message compression and de-compression format (not zip files). | link:camel-zipfile/src/main/docs/zipfile-dataformat.adoc[Zip File] (camel-zipfile) | 2.11 | Camel Zip file support |=== http://git-wip-us.apache.org/repos/asf/camel/blob/ce33151b/platforms/spring-boot/components-starter/camel-core-starter/src/main/java/org/apache/camel/impl/springboot/GzipDataFormatConfiguration.java ---------------------------------------------------------------------- diff --git a/platforms/spring-boot/components-starter/camel-core-starter/src/main/java/org/apache/camel/impl/springboot/GzipDataFormatConfiguration.java b/platforms/spring-boot/components-starter/camel-core-starter/src/main/java/org/apache/camel/impl/springboot/GzipDataFormatConfiguration.java index 66a9aaf..c0af9ea 100644 --- a/platforms/spring-boot/components-starter/camel-core-starter/src/main/java/org/apache/camel/impl/springboot/GzipDataFormatConfiguration.java +++ b/platforms/spring-boot/components-starter/camel-core-starter/src/main/java/org/apache/camel/impl/springboot/GzipDataFormatConfiguration.java @@ -21,7 +21,8 @@ import org.apache.camel.spring.boot.DataFormatConfigurationPropertiesCommon; import org.springframework.boot.context.properties.ConfigurationProperties; /** - * GZip compression data format + * The GZip data format is a message compression and de-compression format + * (which works with the popular gzip/gunzip tools). * * Generated by camel-package-maven-plugin - do not edit this file! */ http://git-wip-us.apache.org/repos/asf/camel/blob/ce33151b/platforms/spring-boot/components-starter/camel-core-starter/src/main/java/org/apache/camel/impl/springboot/SerializationDataFormatConfiguration.java ---------------------------------------------------------------------- diff --git a/platforms/spring-boot/components-starter/camel-core-starter/src/main/java/org/apache/camel/impl/springboot/SerializationDataFormatConfiguration.java b/platforms/spring-boot/components-starter/camel-core-starter/src/main/java/org/apache/camel/impl/springboot/SerializationDataFormatConfiguration.java index 12adce1..8727c13 100644 --- a/platforms/spring-boot/components-starter/camel-core-starter/src/main/java/org/apache/camel/impl/springboot/SerializationDataFormatConfiguration.java +++ b/platforms/spring-boot/components-starter/camel-core-starter/src/main/java/org/apache/camel/impl/springboot/SerializationDataFormatConfiguration.java @@ -21,7 +21,9 @@ import org.apache.camel.spring.boot.DataFormatConfigurationPropertiesCommon; import org.springframework.boot.context.properties.ConfigurationProperties; /** - * Java Object Serialization data format + * Serialization is a data format which uses the standard Java Serialization + * mechanism to unmarshal a binary payload into Java objects or to marshal Java + * objects into a binary blob. * * Generated by camel-package-maven-plugin - do not edit this file! */ http://git-wip-us.apache.org/repos/asf/camel/blob/ce33151b/platforms/spring-boot/components-starter/camel-core-starter/src/main/java/org/apache/camel/impl/springboot/StringDataFormatConfiguration.java ---------------------------------------------------------------------- diff --git a/platforms/spring-boot/components-starter/camel-core-starter/src/main/java/org/apache/camel/impl/springboot/StringDataFormatConfiguration.java b/platforms/spring-boot/components-starter/camel-core-starter/src/main/java/org/apache/camel/impl/springboot/StringDataFormatConfiguration.java index 3bb7379..08eae81 100644 --- a/platforms/spring-boot/components-starter/camel-core-starter/src/main/java/org/apache/camel/impl/springboot/StringDataFormatConfiguration.java +++ b/platforms/spring-boot/components-starter/camel-core-starter/src/main/java/org/apache/camel/impl/springboot/StringDataFormatConfiguration.java @@ -21,7 +21,8 @@ import org.apache.camel.spring.boot.DataFormatConfigurationPropertiesCommon; import org.springframework.boot.context.properties.ConfigurationProperties; /** - * String (text based) data format + * String data format is a textual based format that supports character + * encoding. * * Generated by camel-package-maven-plugin - do not edit this file! */ http://git-wip-us.apache.org/repos/asf/camel/blob/ce33151b/platforms/spring-boot/components-starter/camel-core-starter/src/main/java/org/apache/camel/impl/springboot/ZipDataFormatConfiguration.java ---------------------------------------------------------------------- diff --git a/platforms/spring-boot/components-starter/camel-core-starter/src/main/java/org/apache/camel/impl/springboot/ZipDataFormatConfiguration.java b/platforms/spring-boot/components-starter/camel-core-starter/src/main/java/org/apache/camel/impl/springboot/ZipDataFormatConfiguration.java index 5cdd799..ef768e2 100644 --- a/platforms/spring-boot/components-starter/camel-core-starter/src/main/java/org/apache/camel/impl/springboot/ZipDataFormatConfiguration.java +++ b/platforms/spring-boot/components-starter/camel-core-starter/src/main/java/org/apache/camel/impl/springboot/ZipDataFormatConfiguration.java @@ -21,7 +21,8 @@ import org.apache.camel.spring.boot.DataFormatConfigurationPropertiesCommon; import org.springframework.boot.context.properties.ConfigurationProperties; /** - * Zip compression data format (not for zip files) + * Zip Deflate Compression data format is a message compression and + * de-compression format (not zip files). * * Generated by camel-package-maven-plugin - do not edit this file! */
