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 asciidoc in the repository:


As of Camel 2.12 the EndpointCompleter API is an optional SPI interface for Component implementors. It provides a completion hook; rather like bash tab completion, or the completion in the Karaf shell when typing commands.

Nice behaving components should implement EndpointCompleter and its completion method. The method is given a ComponentConfiguration object which wraps up all the various configuration values (and can be used to create a new Endpoint instance if required - or inject values into an exemplar internal instance).

The completeEndpointPath() method then returns a list of Strings of the matching values available.

For example here's the implementation code in the FileComponent to implement completeEndpointPath().

Some example implementations include:

© 2004-2015 The Apache Software Foundation.
Apache Camel, Camel, Apache, the Apache feather logo, and the Apache Camel project logo are trademarks of The Apache Software Foundation. All other marks mentioned may be trademarks or registered trademarks of their respective owners.
Graphic Design By Hiram