CAMEL-23535: camel-api - batches 13-15: enhance class-level Javadoc for management, threading, and observability SPIs#24060
Open
ammachado wants to merge 3 commits into
Open
CAMEL-23535: camel-api - batches 13-15: enhance class-level Javadoc for management, threading, and observability SPIs#24060ammachado wants to merge 3 commits into
ammachado wants to merge 3 commits into
Conversation
…nagement SPIs Adds comprehensive class-level Javadoc to the 8 JMX management SPI types in org.apache.camel.spi: ManagementAgent, ManagementStrategy, ManagementStrategyFactory, ManagementNameStrategy, ManagementObjectStrategy, ManagementObjectNameStrategy, ManagementMBeanAssembler, and ManagementInterceptStrategy. Each type now documents its role in the two-level management design (strategy = high-level coordinator, agent = low-level JMX bridge), its relationship to sibling SPIs, and links to the JMX user manual page. Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
…reading and scheduling SPIs Adds comprehensive class-level Javadoc to 6 threading/scheduling SPI types: ExecutorServiceManager, ThreadPoolProfile, ThreadPoolFactory, BackOffTimerFactory, ScheduledPollConsumerScheduler, and ReactiveExecutor. Each type now documents its role in Camel's threading model, the layering between the high-level manager and the low-level factory, and links to the Threading Model user manual page. Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
…servability SPIs Adds comprehensive class-level Javadoc to 5 observability SPI types: EventNotifier, EventFactory, Tracer, CamelLogger, and CamelMDCService. Documents the producer/consumer split between EventFactory (mints event objects) and EventNotifier (observes and reacts), the Tracer's before/after node interception model and standby mode, CamelLogger's level+marker configuration purpose, and CamelMDCService's role in propagating MDC across async exchange continuations. Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
Contributor
|
🌟 Thank you for your contribution to the Apache Camel project! 🌟 🐫 Apache Camel Committers, please review the following items:
|
orpiske
approved these changes
Jun 16, 2026
orpiske
left a comment
Contributor
There was a problem hiding this comment.
Very good and important work that will benefit multiple projects in the ecosystem.
Thanks for this!
Contributor
|
🧪 CI tested the following changed modules:
|
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Description
Continues the systematic Javadoc improvement of
core/camel-apistarted in CAMEL-23535.This PR adds comprehensive class-level Javadoc to 19 SPI types across three logical batches:
Batch 13 — JMX Management SPIs
ManagementAgent,ManagementStrategy,ManagementStrategyFactory,ManagementNameStrategy,ManagementObjectStrategy,ManagementObjectNameStrategy,ManagementMBeanAssembler,ManagementInterceptStrategyDocuments the two-level management design (strategy = high-level coordinator, agent = low-level JMX bridge),
the ObjectName construction pipeline, and the instrumentation wrapping used for EIP statistics collection.
Batch 14 — Threading and Scheduling SPIs
ExecutorServiceManager,ThreadPoolProfile,ThreadPoolFactory,BackOffTimerFactory,ScheduledPollConsumerScheduler,ReactiveExecutorDocuments the layering between the high-level manager (Camel concepts: profiles, naming, lifecycle)
and the low-level factory (pure JDK types, designed for JEE WorkManager substitution), plus the
reactive executor's async dispatch model.
Batch 15 — Observability SPIs
EventNotifier,EventFactory,Tracer,CamelLogger,CamelMDCServiceDocuments the producer/consumer split between
EventFactory(mints event objects) andEventNotifier(reacts to them), the
Tracerbefore/after node interception model and standby mode, andCamelMDCService's role in propagating MDC context across async continuation threads.All types now include at least one link to the relevant Camel user manual page and
@seecross-referencesto related sibling types. No method signatures, annotations, or non-Javadoc code were changed.
Target
mainbranch)Tracking
Apache Camel coding standards and style
mvn clean install -DskipTestslocally from root folder and I have committed all auto-generated changes.Claude Code on behalf of Adriano Machado