camel-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From acosent...@apache.org
Subject [camel] 01/02: Added Endpoint completer to adoc
Date Mon, 05 Nov 2018 12:34:46 GMT
This is an automated email from the ASF dual-hosted git repository.

acosentino pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/camel.git

commit c823585bbe592d5f6b76da8096fb410fb9da7ee6
Author: Andrea Cosentino <ancosen@gmail.com>
AuthorDate: Mon Nov 5 13:33:50 2018 +0100

    Added Endpoint completer to adoc
---
 docs/user-manual/en/endpoint-completer.adoc | 27 +++++++++++++++++++++++++++
 1 file changed, 27 insertions(+)

diff --git a/docs/user-manual/en/endpoint-completer.adoc b/docs/user-manual/en/endpoint-completer.adoc
new file mode 100644
index 0000000..45b59bc
--- /dev/null
+++ b/docs/user-manual/en/endpoint-completer.adoc
@@ -0,0 +1,27 @@
+[[EndpointCompleter-EndpointCompleter]]
+=== EndpointCompleter
+
+As of *Camel 2.12*.
+This API is an optional SPI interface for link:component.adoc[Component]
+implementors. It provides a completion hook; rather like bash tab
+completion, or the completion in the
+http://karaf.apache.org/manual/latest/#_using_the_console[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
+https://github.com/apache/camel/blob/master/camel-core/src/main/java/org/apache/camel/component/file/FileComponent.java#L78[implementation
+code in the FileComponent to implement completeEndpointPath()].
+
+Some example implementations include:
+
+* link:file2.adoc[File]
+


Mime
View raw message