Skip to content

CAMEL-24961: Catalog body types for mail, paho, spring-rabbitmq, pulsar, nats and smpp - #28306

Merged
davsclaus merged 59 commits into
mainfrom
feature/CAMEL-24961-catalog-body-types-messaging-2
Oct 24, 2026
Merged

davsclaus merged 59 commits into
mainfrom
feature/CAMEL-24961-catalog-body-types-messaging-2

Conversation

@davsclaus

@davsclaus davsclaus commented Oct 22, 2026 •

Copy link
Copy Markdown
Contributor

Stacked on #28302. This is the second messaging group of the catalog body types (CAMEL-24961):

  • the mail component (imap, imaps, pop3, pop3s, smtp and smtps);
  • paho, spring-rabbitmq, pulsar and nats;
  • smpp (smpp and smpps).

What the catalog says now

Component Consumer Producer input Producer output
mail a String for text/plain, text/html and text/xml, a stream for another content type, a Multipart for a multipart mail (attachments in the attachments); the jakarta.mail.Message with mapMailMessage=false text, bytes, a stream or a file, read as text, or no body; a MimeMessage is sent as it is unchanged
paho bytes text, bytes, stream or file unchanged
spring-rabbitmq a String for a text content type, bytes otherwise text, bytes, stream or file; no body with allowNullBody unchanged for InOnly; the reply for InOut
pulsar bytes text, bytes, stream or file; other bodies go through Java serialization unchanged
nats bytes; the reply only with exchangePattern=InOut text, bytes, stream or file unchanged for InOnly; the reply as bytes for InOut
smpp the short message as text, or bytes for an 8-bit data coding; no body for data_sm and alerts text, bytes or file, read as text unchanged for InOnly; no body for InOut

The sides of spring-rabbitmq depend on its messageConverter, as those of jms do, so the validator says nothing for them unless the endpoint sets one.

Checked at runtime. Routes run with camel run logged the class of the body after each step:

  • mail against GreenMail embedded through a bean;
  • paho, spring-rabbitmq, pulsar and nats against camel infra run mosquitto, rabbitmq, pulsar and nats;
  • smpp against the jSMPP simulator of the camel-smpp integration test.

What the runs showed:

  • mail:
    • the consumer gives the bodies above for plain, HTML, alternative, mixed, attachment-only, binary, PDF and Latin-1 mails;
    • the producer sends bytes, a stream or a file as their text, a Map as its toString(), no body as an empty text, and a MimeMessage with its own subject.
    • With GreenMail, imap failed on every multipart mail ("Unable to load BODYSTRUCTURE"), so the multipart cases were read with pop3. Both protocols share MailBinding.
  • paho and paho-mqtt5:
    • text, bytes, a stream and a file are sent;
    • a Map, a POJO, a number or no body fail with a NullPointerException.
  • spring-rabbitmq:
    • a text body arrives as a String, anything else as bytes;
    • a Map or a Serializable POJO fails, as it is not serialized;
    • a reply that is a Map fails, and the listener runs the route five times.
  • pulsar: a Map, a List, a Serializable POJO, a number and no body are sent with Java serialization.
  • nats:
    • a Map is sent as its toString();
    • a consumer replies only with exchangePattern=InOut, and the reply arrives as bytes.
  • smpp:
    • a submit_sm leaves the body as it was, with the ids in CamelSmppId;
    • a deliver_sm and a delivery receipt arrive as text;
    • an InOut send leaves no body.

Bugs found and filed, one per component:

  • CAMEL-26013 (Major), mail:
    • one multipart mail with no text part makes every later multipart mail convert to MimeMultipart@... text, as the type converter keeps the fallback;
    • text without a charset in contentType is sent in the JVM charset but labelled without one;
    • a text/csv first part converts to the name of a stream;
    • a producer on imap or pop3 fails each send with "invalid provider";
    • a mail read with mapMailMessage=false cannot be forwarded;
    • setting the body to null in a processor gives back the mail.
  • CAMEL-26014 (Major), smpp:
    • a stream body is sent as an empty short message, and no body fails with a NullPointerException;
    • the 8-bit dataCoding and alphabet endpoint options do not send bytes as they are, only the headers do;
    • an InOut send loses the body and the headers;
    • a misspelled CamelSmppCommand sends an SMS.
  • CAMEL-26015 (Major), spring-rabbitmq:
    • a reply, or a forwarded message, keeps the content type of the consumed message, so bytes arrive as a String;
    • a reply that is a Spring AMQP Message has no correlation id.
  • CAMEL-26016, nats:
    • a reply that does not convert to bytes is dropped silently;
    • a JetStream consumer with exchangePattern=InOut publishes its reply to the ack subject.
  • CAMEL-26017, paho and paho-mqtt5: a body that does not convert to bytes fails with a NullPointerException with no message.
  • CAMEL-26012 (Improvement), pulsar: turn off the Java serialization of bodies that do not convert to bytes, and deprecate it.
  • CAMEL-26018: the CamelMailAlternativeBody header is not in the catalog, so the validator rejects a route that sets it. It is fixed in its own PR.

Docs fixed:

  • nats: the consumer replies only with exchangePattern=InOut, and the producer gets the reply as a byte array.
  • mail:
    • the producer reads the body as text and sends a MimeMessage as it is;
    • a split of the attachments gives their content as the body; the snippet used a constructor removed in 2019.
  • smpp:
    • an 8-bit data coding or alphabet header sends bytes as they are;
    • the component does not detect the encoding;
    • text in ISO-8859-1 is split by 140 bytes only with the 8-bit alphabet;
    • the CamelSmppEncoding header is the charset of the text; the endpoint DSL holds a copy of its description, so SmppEndpointBuilderFactory is regenerated (second commit).

Measured.

Tests

  • TextBodyFlowTest.testTheBodyOfMessaging:
    • reported: a field read after the paho consumer, parsed data sent to pulsar and to smtp, and parsed data as the reply of a nats consumer with exchangePattern=InOut;
    • not reported: a nats consumer without InOut, spring-rabbitmq, and a field read after imap.
  • These pass:
    • the 289 tests of camel-yaml-dsl-validator;
    • the 265 validator and catalog doc tests of camel-jbang-core;
    • the builds of camel-yaml-dsl-maven-plugin and camel-yaml-dsl-deserializers.
  • The answers of camel_catalog_doc stay under 18 000 characters: spring-rabbitmq, the largest, is 17 577.

Claude Code on behalf of davsclaus

🤖 Generated with Claude Code

davsclaus and others added 30 commits October 21, 2026 13:58
…s, and the body it leaves after a step

A @BodyTypes annotation on the endpoint, data format or language class says the
body per side (consumerOut, consumerReply, producerIn, producerOut, marshal,
unmarshal and expression in and out): its carriers (null, text, bytes, stream,
file, value, map, list, pojo, unchanged, any, unknown), the Java type when it is
always the same, the format, the options it depends on, the body for other
option values, and a description. The package plugin writes it as a bodyTypes
section of the catalog JSON and checks that each side fits the kind and that
the options it names exist. A subclass declares its own.

The first slice: file, direct, seda, timer, cron, kamelet, http, https,
rest-openapi, xslt, sql and the json data format (jackson), read from the code
that sets the body and checked against the body types the message history
records when routes run. camel_catalog_doc returns them.

Co-Authored-By: Claude Opus 5.5 (1M context) <noreply@anthropic.com>
Signed-off-by: Claus Ibsen <claus.ibsen@gmail.com>
…tp, jms, kafka, aws2-sqs, the csv, jacksonXml and yaml data formats, and the languages

The second slice of the catalog body types:
- components: platform-http, rest (and the rest-openapi consumer), ftp, ftps,
  sftp, jms, activemq, activemq6, amqp, kafka, aws2-sqs, log, mock, scheduler,
  quartz;
- data formats: csv, jacksonXml, snakeYaml;
- languages: simple, constant, jsonpath, xpath, groovy, jq.

Each value is read from the code that sets the body, and checked against the
body types the message history recorded when the tests of the modules and
reference routes ran (the ftp integration tests included).

camel_catalog_doc gives the body types a line per side, and its answer is cut
at 18000 characters instead of 16000, so the four sides of the jms components
leave the options a limit asks for room.

Co-Authored-By: Claude Opus 5.5 (1M context) <noreply@anthropic.com>
Signed-off-by: Claus Ibsen <claus.ibsen@gmail.com>
paho-mqtt5: the consumer gives the payload as a byte array, the producer sends
what converts to one and leaves the body unchanged.

mongodb: the consumer gives a Document (or null for a change without its full
document with changeStreams); the producer takes a document or a query, and
leaves a body by operation: a Document or null for a find of one, a List for
findAll, findDistinct and aggregate, a Long for count, the result of the driver
for the other writes.

Read from the code that sets the body, and checked against a mosquitto and a
mongodb container started with camel infra.

Co-Authored-By: Claude Opus 5.5 (1M context) <noreply@anthropic.com>
Signed-off-by: Claus Ibsen <claus.ibsen@gmail.com>
…ts an option value without carriers

From the review of PR 28241:

- An iterator is read once and has no size and no index, so tooling that
  reads list as a List accepts ${body.size()} or ${body[0]} on it, which fail
  at runtime. The new iterator carrier names it: sql with outputType=StreamList
  gives an iterator, not a list.
- A @BodyType.When with no carriers (carrier = {}) wrote "carriers": [] into
  the catalog. The build now rejects it, as it does a side without carriers.

Co-Authored-By: Claude Opus 5.5 (1M context) <noreply@anthropic.com>
Signed-off-by: Claus Ibsen <claus.ibsen@gmail.com>
…MEL-24961-catalog-body-types-2

Co-Authored-By: Claude Opus 5.5 (1M context) <noreply@anthropic.com>
Signed-off-by: Claus Ibsen <claus.ibsen@gmail.com>
… camel_catalog_doc says unknown for no carriers

From the review of PR 28242:

- The csv data format with lazyLoad=true gives an iterator, with the iterator
  carrier of PR 28241, not a list.
- camel_catalog_doc says unknown for a body without carriers, instead of
  failing. The build rejects it now, but a catalog read from elsewhere may
  have one.
- Sqs2Endpoint imports org.apache.camel.spi.* already: only the import of the
  nested BodyType.Carrier stays.

Co-Authored-By: Claude Opus 5.5 (1M context) <noreply@anthropic.com>
Signed-off-by: Claus Ibsen <claus.ibsen@gmail.com>
…types of the catalog instead of their own tables

The YAML validator's body walks read what a component or a data format does
with the body from the catalog, instead of from tables in their source:

- the consumer a route starts with (consumerOut): the file as read, text,
  bytes or data, instead of the file consumer only;
- the body after a to: (producerOut): unchanged for log and mock and now for a
  file write, the response of the http producer as bytes or a stream;
- the producers that need text (producerIn), instead of file, ftp, ftps and
  sftp only;
- the body after an unmarshal (unmarshalOut), instead of the json, jacksonXml,
  yaml and csv table and the options that make something else;
- the consumers that reply with text (consumerReply), instead of platform-http;
- the consumers that give no body, instead of timer, quartz, scheduler and cron.

A side holds for a step only when the step decides every option it depends
on: an option the component can also be configured with (the valueDeserializer
of kafka) counts only when the endpoint sets it, and a placeholder value is not
known. The catalog of an older Camel version has no body types, so the
validator's own catalog stands in for it. After a step that fails at runtime
the walk stops, so a file write that keeps the body is reported once.

The rules about HTTP methods, REST bindings and EIPs stay in the validator; the
EIPs get body types with CAMEL-25928.

The same reports as before on 1204 human-written route files (the Camel
repository, the examples, kamelets, camel-k and camel-kit) and on 1209
model-written ones (the r17 benchmark series), and the doc examples of the
validator tests still validate.

Co-Authored-By: Claude Opus 5.5 (1M context) <noreply@anthropic.com>
Signed-off-by: Claus Ibsen <claus.ibsen@gmail.com>
…docling, milvus, qdrant, ai-tool and ibm-watson-language

The AI components declare the body they need and the body they leave, per
operation where the operation decides it. The answer of openai and
langchain4j-chat is text, also when it is asked for JSON, so the YAML
validator now reports a field read on it that has no unmarshal before.

Co-Authored-By: Claude Opus 5.5 (1M context) <noreply@anthropic.com>
Signed-off-by: Claus Ibsen <claus.ibsen@gmail.com>
… endpoint count for its body types

The operation of openai is in the path (openai:embeddings), so the validator
reads the path options with the syntax of the component, as the catalog
parses an endpoint. A path the catalog cannot read, such as a toD with an
expression, says nothing about its options.

Co-Authored-By: Claude Opus 5.5 (1M context) <noreply@anthropic.com>
Signed-off-by: Claus Ibsen <claus.ibsen@gmail.com>
…pe for a value its option cannot have

A byOption value must be one of the enum of its option, or true or false for
a boolean, ignoring case as tooling compares it with the endpoint: a
misspelled operation such as embedding for embeddings would never hold.

Co-Authored-By: Claude Opus 5.5 (1M context) <noreply@anthropic.com>
Signed-off-by: Claus Ibsen <claus.ibsen@gmail.com>
The attribute holds an array, and the catalog JSON and BodyTypeModel call
the same field carriers. The Javadoc of BodyTypeModel.isUnknown() says that
a side with no carriers is unknown too.

Co-Authored-By: Claude Opus 5.5 (1M context) <noreply@anthropic.com>
Signed-off-by: Claus Ibsen <claus.ibsen@gmail.com>
Co-Authored-By: Claude Opus 5.5 (1M context) <noreply@anthropic.com>
Signed-off-by: Claus Ibsen <claus.ibsen@gmail.com>
…AMEL-24961-catalog-body-types-ai

# Conflicts:
#	tooling/maven/camel-package-maven-plugin/src/main/java/org/apache/camel/maven/packaging/BodyTypesHelper.java
Co-Authored-By: Claude Opus 5.5 (1M context) <noreply@anthropic.com>
Signed-off-by: Claus Ibsen <claus.ibsen@gmail.com>
The body types of aws2-s3, azure-storage-blob, azure-files, dropbox,
google-storage, ibm-cos and minio, read from the code and checked at
runtime against LocalStack S3 (aws2-s3, and ibm-cos and minio through
their S3 API) and Azurite (azure-storage-blob).

The pages of aws2-s3, google-storage and minio said getObject returns an
S3Object, a Blob or a MinioObject: it returns the content of the object.

The validator calls a body the file as read (a GenericFile) only when the
file is its only carrier, not for a blob that is a stream or a file.

Co-Authored-By: Claude Opus 5.5 (1M context) <noreply@anthropic.com>
Signed-off-by: Claus Ibsen <claus.ibsen@gmail.com>
…e data format and language schemas

Co-Authored-By: Claude Opus 5.5 (1M context) <noreply@anthropic.com>
Signed-off-by: Claus Ibsen <claus.ibsen@gmail.com>
…n read as a list, as the carriers do

Co-Authored-By: Claude Opus 5.5 (1M context) <noreply@anthropic.com>
Signed-off-by: Claus Ibsen <claus.ibsen@gmail.com>
The body types of aws2-sns, aws2-kinesis, aws2-kinesis-firehose,
google-pubsub, azure-servicebus, azure-eventhubs and azure-storage-queue,
read from the code and checked at runtime against LocalStack (SNS and
Kinesis), the Pub/Sub emulator and Azurite (queues).

aws2-sqs sends bytes, a stream or a file as text as well, and
sendBatchMessage takes a SendMessageBatchRequest too, which its producer
side now says.

Co-Authored-By: Claude Opus 5.5 (1M context) <noreply@anthropic.com>
Signed-off-by: Claus Ibsen <claus.ibsen@gmail.com>
The body types of bean, class, browse, controlbus, dataformat, dataset,
dataset-test, dynamic-router, dynamic-router-control, event, exec,
knative, language, once, ref, rest-api, saga, stream, stub, validator,
wasm and xslt-saxon, and of the bean, header, exchangeProperty, variable,
ref, file, tokenize and xtokenize languages, read from the code and
checked at runtime with camel run (knative over a local environment
file).

The xpath and jq languages read the source option instead of the body
when it is set, which their expressionIn now says, as tokenize and
xtokenize do.

The component docs of stream, exec, language, once, browse and dataset
said things about the body that the code does not do.

Co-Authored-By: Claude Opus 5.5 (1M context) <noreply@anthropic.com>
Signed-off-by: Claus Ibsen <claus.ibsen@gmail.com>
… and infinispan

The body types of jira, github2, pqc, dns, caffeine-cache,
caffeine-loadcache, infinispan and infinispan-embedded, the most used
components in the route files that had none yet. pqc, dns, caffeine and
infinispan-embedded were checked at runtime with camel run; jira and
github2 were read from the code.

The validator now takes an option a body depends on as unknown also when
another option of the step names a body, such as xslt with output=bytes
and a resultHandlerFactory, as the BodyType javadoc says.

The component docs of jira, github2, dns and infinispan said things about
the body that the code does not do.

Co-Authored-By: Claude Opus 5.5 (1M context) <noreply@anthropic.com>
Signed-off-by: Claus Ibsen <claus.ibsen@gmail.com>
@github-actions

Copy link
Copy Markdown
Contributor

🌟 Thank you for your contribution to the Apache Camel project! 🌟
🤖 CI automation will test this PR automatically.

🐫 Apache Camel Committers, please review the following items:

  • First-time contributors require MANUAL approval for the GitHub Actions to run
  • You can use the command /component-test (camel-)component-name1 (camel-)component-name2.. to request a test from the test bot although they are normally detected and executed by CI.
  • You can label PRs using skip-tests and test-dependents to fine-tune the checks executed by this PR.
  • Build and test logs are available in the summary page. Only Apache Camel committers have access to the summary.

⚠️ Be careful when sharing logs. Review their contents before sharing them publicly.

davsclaus and others added 2 commits October 23, 2026 10:47
…atalog-body-types-3

Signed-off-by: Claus Ibsen <claus.ibsen@gmail.com>
The description of the CamelSmppEncoding header changed with the body
types of smpp, and the endpoint DSL holds a copy of it.

Co-Authored-By: Claude Opus 5.5 (1M context) <noreply@anthropic.com>
Signed-off-by: Claus Ibsen <claus.ibsen@gmail.com>

@gnodet-bot gnodet-bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Previous findings are all addressed. LGTM.

The new commit (5139879b) regenerates SmppEndpointBuilderFactory.java to sync the CamelSmppEncoding header description with SmppConstants.java (scope DataSm → ReplaceSm, description rewrite) — a generated artifact update with no new issues. All @BodyTypes annotations match runtime behavior, JSON catalog entries are consistent with the annotations, doc corrections are accurate, and the new testTheBodyOfMessaging test covers the right 4 validator conditions.

This review was generated by an AI agent, Hermès on behalf of @gnodet.

…atalog-body-types-ai

# Conflicts:
#	docs/user-manual/modules/ROOT/pages/camel-jbang-validation.adoc
#	dsl/camel-yaml-dsl/camel-yaml-dsl-validator/src/main/java/org/apache/camel/dsl/yaml/validator/CatalogBodyTypes.java
#	dsl/camel-yaml-dsl/camel-yaml-dsl-validator/src/test/java/org/apache/camel/dsl/yaml/validator/TextBodyFlowTest.java
…atalog-body-types-storage

# Conflicts:
#	dsl/camel-yaml-dsl/camel-yaml-dsl-validator/src/test/java/org/apache/camel/dsl/yaml/validator/TextBodyFlowTest.java
…atalog-body-types-messaging

# Conflicts:
#	dsl/camel-yaml-dsl/camel-yaml-dsl-validator/src/test/java/org/apache/camel/dsl/yaml/validator/TextBodyFlowTest.java
…atalog-body-types-core

# Conflicts:
#	dsl/camel-yaml-dsl/camel-yaml-dsl-validator/src/test/java/org/apache/camel/dsl/yaml/validator/TextBodyFlowTest.java
…atalog-body-types-transformation

# Conflicts:
#	dsl/camel-yaml-dsl/camel-yaml-dsl-validator/src/test/java/org/apache/camel/dsl/yaml/validator/TextBodyFlowTest.java
…atalog-body-types-dataformats-text

# Conflicts:
#	dsl/camel-yaml-dsl/camel-yaml-dsl-validator/src/test/java/org/apache/camel/dsl/yaml/validator/TextBodyFlowTest.java
…' into feature/CAMEL-24961-catalog-body-types-dataformats-binary
…atalog-body-types-dataformats-binary

# Conflicts:
#	dsl/camel-yaml-dsl/camel-yaml-dsl-validator/src/test/java/org/apache/camel/dsl/yaml/validator/TextBodyFlowTest.java
@davsclaus
davsclaus changed the base branch from feature/CAMEL-24961-catalog-body-types-dataformats-binary to main October 24, 2026 07:37
@davsclaus davsclaus added the enhancement New feature or request label Oct 24, 2026
@davsclaus
davsclaus merged commit d71e3ca into main Oct 24, 2026
5 of 7 checks passed
@davsclaus
davsclaus deleted the feature/CAMEL-24961-catalog-body-types-messaging-2 branch October 24, 2026 07:58
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants