Data Format component

The dataformat component marshals or unmarshals the message body with a data format (JSON, CSV, Base64, ...) as an endpoint, so it can be used anywhere a URI is accepted.

Scheme: dataformat: · Crate: cameleer-core · Cargo feature: none, always included (build features) · Consumer: no · Producer: yes · Apache Camel: Data Format

When to use it

• Parse JSON from an MQTT sensor or an HTTP call into a map, then read fields with Simple.
• Encode or compress a payload before sending it (base64, gzipDeflater).
• Use a data format where only a URI fits, such as recipientList, toD or enrich.

Inside a route, the marshal and unmarshal steps do the same thing.

URI format

dataformat:name:marshal|unmarshal[?options]

name is a data format bound in the registry under that name, or a built-in one (json, csv, base64, gzipDeflater, ...) created with the endpoint options.

Example

- route:
    id: parse-reading
    from:
      uri: direct:reading
      steps:
        - to: dataformat:json:unmarshal
        - setBody:
            simple: "${body[device]}=${body[temperature]}"

Sending {"device":"t1","temperature":21.5} returns t1=21.5.

Rust DSL

use cameleer_core::prelude::*;

pub fn routes(ctx: &CamelContext) -> Result<()> {
    ctx.add_routes(|b| {
        b.from("direct:reading")
            .route_id("parse-reading")
            .to("dataformat:json:unmarshal")
            .set_body(simple("${body[device]}=${body[temperature]}"));
    })
}

Options

The options are those of the chosen data format, for example prettyPrint=true for json or delimiter=; for csv. See the data format pages in ../dataformats/. When the name refers to a data format bound in the registry, endpoint options are ignored.

Message headers

Whatever the data format reads or sets.

Run it with Docker

docker run --rm -v "$PWD:/routes:ro" pmsudhi/cameleer run /routes/readings.camel.yaml

Common questions

What does unmarshal json give me?

A map (or list) value. Read fields with ${body[name]} in Simple, or with JSONPath.

Why do I get "Operation must be marshal or unmarshal"?

The last part of the URI must be marshal or unmarshal, for example dataformat:base64:marshal.

Related

• language
• Apache Camel Data Format component

Found a problem?

If something on this page doesn't match what Cameleer does, or you hit a bug while building with it, please help fix it, whether you are a person or a coding agent: open an issue that describes what you saw, then fork the repository, fix it, add or update a test, run cargo test --workspace, and open a pull request. CONTRIBUTING.md explains the ground rules.