camel-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From acosent...@apache.org
Subject [2/2] camel git commit: Added camel-spring-ldap docs to Gitbook
Date Tue, 07 Jun 2016 13:38:56 GMT
Added camel-spring-ldap docs to Gitbook


Project: http://git-wip-us.apache.org/repos/asf/camel/repo
Commit: http://git-wip-us.apache.org/repos/asf/camel/commit/f0b95266
Tree: http://git-wip-us.apache.org/repos/asf/camel/tree/f0b95266
Diff: http://git-wip-us.apache.org/repos/asf/camel/diff/f0b95266

Branch: refs/heads/master
Commit: f0b952668c5a9819dd0d2f0221613495c043b864
Parents: 104532e
Author: Andrea Cosentino <ancosen@gmail.com>
Authored: Tue Jun 7 15:38:20 2016 +0200
Committer: Andrea Cosentino <ancosen@gmail.com>
Committed: Tue Jun 7 15:38:20 2016 +0200

----------------------------------------------------------------------
 .../src/main/docs/spring-ldap.adoc              | 113 +++++++++++++++++++
 docs/user-manual/en/SUMMARY.md                  |   1 +
 2 files changed, 114 insertions(+)
----------------------------------------------------------------------


http://git-wip-us.apache.org/repos/asf/camel/blob/f0b95266/components/camel-spring-ldap/src/main/docs/spring-ldap.adoc
----------------------------------------------------------------------
diff --git a/components/camel-spring-ldap/src/main/docs/spring-ldap.adoc b/components/camel-spring-ldap/src/main/docs/spring-ldap.adoc
new file mode 100644
index 0000000..a0f144f
--- /dev/null
+++ b/components/camel-spring-ldap/src/main/docs/spring-ldap.adoc
@@ -0,0 +1,113 @@
+[[SpringLDAP-SpringLDAPComponent]]
+Spring LDAP Component
+~~~~~~~~~~~~~~~~~~~~~
+
+*Available since Camel 2.11*
+
+The *spring-ldap:* component provides a Camel wrapper for
+http://www.springsource.org/ldap[Spring LDAP].
+
+Maven users will need to add the following dependency to their `pom.xml`
+for this component:
+
+[source,xml]
+------------------------------------------------------------
+<dependency>
+    <groupId>org.apache.camel</groupId>
+    <artifactId>camel-spring-ldap</artifactId>
+    <version>x.x.x</version>
+    <!-- use the same version as your Camel core version -->
+</dependency>
+------------------------------------------------------------
+
+[[SpringLDAP-URIformat]]
+URI format
+^^^^^^^^^^
+
+[source,java]
+----------------------------------------
+spring-ldap:springLdapTemplate[?options]
+----------------------------------------
+
+Where *springLdapTemplate* is the name of the
+http://static.springsource.org/spring-ldap/site/apidocs/org/springframework/ldap/core/LdapTemplate.html[Spring
+LDAP Template bean]. In this bean, you configure the URL and the
+credentials for your LDAP access.
+
+[[SpringLDAP-Options]]
+Options
+^^^^^^^
+
+
+// component options: START
+The Spring LDAP component has no options.
+// component options: END
+
+
+
+// endpoint options: START
+The Spring LDAP component supports 5 endpoint options which are listed below:
+
+{% raw %}
+[width="100%",cols="2s,1,1m,1m,5",options="header"]
+|=======================================================================
+| Name | Group | Default | Java Type | Description
+| templateName | producer |  | String | *Required* Name of the Spring LDAP Template bean
+| operation | producer |  | LdapOperation | *Required* The LDAP operation to be performed.
+| scope | producer | subtree | String | The scope of the search operation.
+| exchangePattern | advanced | InOnly | ExchangePattern | Sets the default exchange pattern
when creating an exchange
+| synchronous | advanced | false | boolean | Sets whether synchronous processing should be
strictly used or Camel is allowed to use asynchronous processing (if supported).
+|=======================================================================
+{% endraw %}
+// endpoint options: END
+
+
+[[SpringLDAP-Usage]]
+Usage
+^^^^^
+
+The component supports producer endpoint only. An attempt to create a
+consumer endpoint will result in an `UnsupportedOperationException`. +
+ The body of the message must be a map (an instance of `java.util.Map`).
+This map must contain at least an entry with the key *`dn`* that
+specifies the root node for the LDAP operation to be performed. Other
+entries of the map are operation-specific (see below).
+
+The body of the message remains unchanged for the `bind` and `unbind`
+operations. For the `search` operation, the body is set to the result of
+the search, see
+http://static.springsource.org/spring-ldap/site/apidocs/org/springframework/ldap/core/LdapTemplate.html#search%28java.lang.String,%20java.lang.String,%20int,%20org.springframework.ldap.core.AttributesMapper%29[http://static.springsource.org/spring-ldap/site/apidocs/org/springframework/ldap/core/LdapTemplate.html#search%28java.lang.String,%20java.lang.String,%20int,%20org.springframework.ldap.core.AttributesMapper%29].
+
+[[SpringLDAP-Search]]
+Search
+++++++
+
+The message body must have an entry with the key *`filter`*. The value
+must be a String representing a valid LDAP filter, see
+http://en.wikipedia.org/wiki/Lightweight_Directory_Access_Protocol#Search_and_Compare[http://en.wikipedia.org/wiki/Lightweight_Directory_Access_Protocol#Search_and_Compare].
+
+[[SpringLDAP-Bind]]
+Bind
+++++
+
+The message body must have an entry with the key *`attributes`*. The
+value must be an instance of
+http://docs.oracle.com/javase/6/docs/api/javax/naming/directory/Attributes.html[javax.naming.directory.Attributes]
+This entry specifies the LDAP node to be created.
+
+[[SpringLDAP-Unbind]]
+Unbind
+++++++
+
+No further entries necessary, the node with the specified *`dn`* is
+deleted.
+
+*Key definitions*
+
+In order to avoid spelling errors, the following constants are defined
+in `org.apache.camel.springldap.SpringLdapProducer`:
+
+* public static final String DN = "dn"
+* public static final String FILTER = "filter"
+* public static final String ATTRIBUTES = "attributes"
+

http://git-wip-us.apache.org/repos/asf/camel/blob/f0b95266/docs/user-manual/en/SUMMARY.md
----------------------------------------------------------------------
diff --git a/docs/user-manual/en/SUMMARY.md b/docs/user-manual/en/SUMMARY.md
index 78e1546..84796e7 100644
--- a/docs/user-manual/en/SUMMARY.md
+++ b/docs/user-manual/en/SUMMARY.md
@@ -251,6 +251,7 @@
     * [Spring-Event](spring-event.adoc)
     * [Spring-Integration](spring-integration.adoc)
     * [Spring-Javaconfig](spring-java-config.adoc)
+    * [Spring-Ldap](spring-ldap.adoc)
     * [Telegram](telegram.adoc)
     * [Twitter](twitter.adoc)
     * [Websocket](websocket.adoc)


Mime
View raw message