Since we're on a major migration process of this website, some component documents here are out of sync right now. In the meantime you may want to look at the early version of the new website
https://camel.apache.org/staging/
We would very much like to receive any feedback on the new site, please join the discussion on the Camel user mailing list.
Endpoint AnnotationsAs of Camel 2.12 you can annotate Endpoint and Consumer classes so that their configuration documentation can be automatically generated by the camel-package-maven-plugin (rather like maven plugin goals get their parameters documented automatically). The documentation is then included into the jar as org/apache/camel/component/scheme/scheme.html where scheme is the component name. Supported annotations
For example here is the TimerEndpoint, notice the use of these annotations and in its base classes. Not only are the annotations useful for automatically generating the documentation; we can use them to refine the validation of the code during configuration and they can be useful for tool providers so they can more easily introspect the configuration options. See the ComponentConfiguration documentation on the tooling aspect. Using the UriEndpointComponent base classIf you use the @UriEndpoint annotation on your Endpoint along with one or more @UriParam / @UriParams annotations on your class (or any base classes of your endpoint) its recommended that your Component class inherit from the UriEndpointComponent base class as that means your Component will automatically generate better metadata for the ComponentConfiguration API. This will allow your component to work better inside tools which make use of the ComponentConfiguration API to generate nice forms and so forth. |
