CAMEL-23535: camel-api - batches 16-20: enhance class-level Javadoc for REST, tooling, properties, exchange, and root-package types

[ammachado]

Description

Continues CAMEL-23535.

This PR covers batches 16-20: 26 files in core/camel-api received enhanced class-level Javadoc. The changes are documentation-only; no method signatures, annotations, or production code were altered.

Batch 16 — REST SPIs (spi/)
RestConfiguration, RestProducerFactory, RestRegistry, RestBindingJaxbDataFormatFactory, RestApiConsumerFactory

Batch 17 — CLI and model-dumper SPIs (spi/)
CliConnector, CliConnectorFactory, ModelToXMLDumper, ModelToYAMLDumper, ModelToJavaDumper, RouteTopologyDumper

Batch 18 — Properties, language, and resolver SPIs (spi/)
PropertiesComponent, PropertiesFunction, Language, LanguageResolver, DataFormatResolver, RoutesBuilderLoader, HeadersMapFactory

Batch 19 — Exchange processing SPIs (spi/)
LifecycleStrategy, UnitOfWork, UnitOfWorkFactory, InflightRepository

Batch 20 — Root-package utility and exception types (org.apache.camel)
NoSuchBeanException, StaticService, SSLContextParametersAware, NoFactoryAvailableException

Each file received:

• A clear opening sentence naming its role in the Camel system
• An architecture paragraph with {@link} references and explanation of callers/lifecycle
• At least one user-manual <a href> link where a matching page exists
• @see tags for closely related sibling types
• Preserved @since tags

Target

• I checked that the commit is targeting the correct branch (Camel 4 uses the main branch)

Tracking

• If this is a large change, bug fix, or code improvement, I checked there is a JIRA issue filed for the change (usually before you start working on it).

Apache Camel coding standards and style

• I checked that each commit in the pull request has a meaningful subject line and body.
• I have run mvn clean install -DskipTests locally from root folder and I have committed all auto-generated changes.

Claude Code on behalf of Adriano Machado

[github-actions]

🌟 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]

Clean documentation-only PR — enhanced class-level Javadoc across 26 files in core/camel-api with clear architecture context, {@link} references, manual links, and @see tags. No behavioral changes.

Two minor non-blocking observations:

1. UnitOfWorkFactory semantic shift: The old Javadoc says extending DefaultUnitOfWork is "highly recommended"; the new text strengthens this to "must extend" and explains the consequences. More informative, but changes the documented contract strength.

2. HeadersMapFactory dropped @see: The old @see org.apache.camel.impl.engine.DefaultHeadersMapFactory (pointing to the default impl) was replaced with @see Message. Both valid — the old one was useful for implementors.

This review was generated by an AI agent and may contain inaccuracies. Please verify all suggestions before applying.

[github-actions]

🧪 CI tested the following changed modules:

• core/camel-api

ℹ️ Dependent modules were not tested because the total number of affected modules exceeded the threshold (50). Use the test-dependents label to force testing all dependents.

---

⚙️ View full build and test results

[ammachado]

Thank you for the review! Both observations addressed in cdb71dc:

1. UnitOfWorkFactory contract strength: Softened "must extend" back to "is highly recommended to extend" and "will break" to "may break", preserving the advisory (rather than normative) wording of the original while keeping the added explanatory context.

2. HeadersMapFactory dropped @see: Re-added @see org.apache.camel.impl.engine.DefaultHeadersMapFactory alongside @see Message so implementors retain the pointer to the concrete default implementation.

Claude Code on behalf of Adriano Machado