You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@camel.apache.org by da...@apache.org on 2016/11/22 08:47:34 UTC

[1/2] camel git commit: Component docs

Repository: camel
Updated Branches:
  refs/heads/master 8ab374b1e -> f30365ece


Component docs


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

Branch: refs/heads/master
Commit: f30365ece5f5c15d2208a4de3516273730bc949e
Parents: 23c7dc4
Author: Claus Ibsen <da...@apache.org>
Authored: Tue Nov 22 09:47:19 2016 +0100
Committer: Claus Ibsen <da...@apache.org>
Committed: Tue Nov 22 09:47:26 2016 +0100

----------------------------------------------------------------------
 .../websocket/springboot/WebsocketComponentConfiguration.java   | 4 ++--
 .../src/main/docs/atmosphere-websocket-component.adoc           | 5 +++--
 .../camel-spring-ldap/src/main/docs/spring-ldap-component.adoc  | 2 +-
 .../spring-boot-dm/camel-spring-boot-dependencies/pom.xml       | 4 ++--
 4 files changed, 8 insertions(+), 7 deletions(-)
----------------------------------------------------------------------


http://git-wip-us.apache.org/repos/asf/camel/blob/f30365ec/components-starter/camel-atmosphere-websocket-starter/src/main/java/org/apache/camel/component/atmosphere/websocket/springboot/WebsocketComponentConfiguration.java
----------------------------------------------------------------------
diff --git a/components-starter/camel-atmosphere-websocket-starter/src/main/java/org/apache/camel/component/atmosphere/websocket/springboot/WebsocketComponentConfiguration.java b/components-starter/camel-atmosphere-websocket-starter/src/main/java/org/apache/camel/component/atmosphere/websocket/springboot/WebsocketComponentConfiguration.java
index 190bb22..c930430 100644
--- a/components-starter/camel-atmosphere-websocket-starter/src/main/java/org/apache/camel/component/atmosphere/websocket/springboot/WebsocketComponentConfiguration.java
+++ b/components-starter/camel-atmosphere-websocket-starter/src/main/java/org/apache/camel/component/atmosphere/websocket/springboot/WebsocketComponentConfiguration.java
@@ -42,8 +42,8 @@ public class WebsocketComponentConfiguration {
     private HttpRegistry httpRegistry;
     /**
      * Whether to automatic bind multipart/form-data as attachments on the Camel
-     * Exchange. This is turn off by default as this may require servet specific
-     * configuration to enable this when using Servlet's.
+     * Exchange. This is turn off by default as this may require servlet
+     * specific configuration to enable this when using Servlet's.
      */
     private Boolean attachmentMultipartBinding;
     /**

http://git-wip-us.apache.org/repos/asf/camel/blob/f30365ec/components/camel-atmosphere-websocket/src/main/docs/atmosphere-websocket-component.adoc
----------------------------------------------------------------------
diff --git a/components/camel-atmosphere-websocket/src/main/docs/atmosphere-websocket-component.adoc b/components/camel-atmosphere-websocket/src/main/docs/atmosphere-websocket-component.adoc
index 46b80f4..860d653 100644
--- a/components/camel-atmosphere-websocket/src/main/docs/atmosphere-websocket-component.adoc
+++ b/components/camel-atmosphere-websocket/src/main/docs/atmosphere-websocket-component.adoc
@@ -48,7 +48,7 @@ The Atmosphere Websocket component supports 7 options which are listed below.
 | Name | Java Type | Description
 | servletName | String | Default name of servlet to use. The default name is CamelServlet.
 | httpRegistry | HttpRegistry | To use a custom org.apache.camel.component.servlet.HttpRegistry.
-| attachmentMultipartBinding | boolean | Whether to automatic bind multipart/form-data as attachments on the Camel Exchange. This is turn off by default as this may require servet specific configuration to enable this when using Servlet's.
+| attachmentMultipartBinding | boolean | Whether to automatic bind multipart/form-data as attachments on the Camel Exchange. This is turn off by default as this may require servlet specific configuration to enable this when using Servlet's.
 | httpBinding | HttpBinding | To use a custom HttpBinding to control the mapping between Camel message and HttpClient.
 | httpConfiguration | HttpConfiguration | To use the shared HttpConfiguration as base configuration.
 | allowJavaSerializedObject | boolean | Whether to allow java serialization when a request uses context-type=application/x-java-serialized-object This is by default turned off. If you enable this then be aware that Java will deserialize the incoming data from the request to Java and that can be a potential security risk.
@@ -61,7 +61,7 @@ The Atmosphere Websocket component supports 7 options which are listed below.
 
 
 // endpoint options: START
-The Atmosphere Websocket component supports 35 endpoint options which are listed below:
+The Atmosphere Websocket component supports 36 endpoint options which are listed below:
 
 {% raw %}
 [width="100%",cols="2,1,1m,1m,5",options="header"]
@@ -84,6 +84,7 @@ The Atmosphere Websocket component supports 35 endpoint options which are listed
 | responseBufferSize | consumer |  | Integer | To use a custom buffer size on the javax.servlet.ServletResponse.
 | servletName | consumer | CamelServlet | String | Name of the servlet to use
 | traceEnabled | consumer | false | boolean | Specifies whether to enable HTTP TRACE for this Servlet consumer. By default TRACE is turned off.
+| attachmentMultipartBinding | consumer (advanced) | false | boolean | Whether to automatic bind multipart/form-data as attachments on the Camel Exchange. This is turn off by default as this may require servlet specific configuration to enable this when using Servlet's.
 | exceptionHandler | consumer (advanced) |  | ExceptionHandler | To let the consumer use a custom ExceptionHandler. Notice if the option bridgeErrorHandler is enabled then this options is not in use. By default the consumer will deal with exceptions that will be logged at WARN/ERROR level and ignored.
 | exchangePattern | consumer (advanced) |  | ExchangePattern | Sets the exchange pattern when the consumer creates an exchange.
 | authMethodPriority | producer |  | String | Authentication method for proxy either as Basic Digest or NTLM.

http://git-wip-us.apache.org/repos/asf/camel/blob/f30365ec/components/camel-spring-ldap/src/main/docs/spring-ldap-component.adoc
----------------------------------------------------------------------
diff --git a/components/camel-spring-ldap/src/main/docs/spring-ldap-component.adoc b/components/camel-spring-ldap/src/main/docs/spring-ldap-component.adoc
index d7a18a2..8c7c200 100644
--- a/components/camel-spring-ldap/src/main/docs/spring-ldap-component.adoc
+++ b/components/camel-spring-ldap/src/main/docs/spring-ldap-component.adoc
@@ -46,7 +46,7 @@ The Spring LDAP component has no options.
 
 
 // endpoint options: START
-The Spring LDAP component supports 7 endpoint options which are listed below:
+The Spring LDAP component supports 4 endpoint options which are listed below:
 
 {% raw %}
 [width="100%",cols="2,1,1m,1m,5",options="header"]

http://git-wip-us.apache.org/repos/asf/camel/blob/f30365ec/platforms/spring-boot/spring-boot-dm/camel-spring-boot-dependencies/pom.xml
----------------------------------------------------------------------
diff --git a/platforms/spring-boot/spring-boot-dm/camel-spring-boot-dependencies/pom.xml b/platforms/spring-boot/spring-boot-dm/camel-spring-boot-dependencies/pom.xml
index d8e840c..b0255af 100644
--- a/platforms/spring-boot/spring-boot-dm/camel-spring-boot-dependencies/pom.xml
+++ b/platforms/spring-boot/spring-boot-dm/camel-spring-boot-dependencies/pom.xml
@@ -2872,12 +2872,12 @@
       <dependency>
         <groupId>org.jruby</groupId>
         <artifactId>jruby</artifactId>
-        <version>1.7.26</version>
+        <version>1.7.18</version>
       </dependency>
       <dependency>
         <groupId>org.jruby</groupId>
         <artifactId>jruby-complete</artifactId>
-        <version>1.7.26</version>
+        <version>1.7.18</version>
       </dependency>
       <dependency>
         <groupId>org.optaplanner</groupId>


[2/2] camel git commit: CAMEL-10491 - Spring-LDAP - Updated component documentation

Posted by da...@apache.org.
CAMEL-10491 - Spring-LDAP - Updated component documentation


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

Branch: refs/heads/master
Commit: 23c7dc4663a4e7d4aa3cdd98c5951237139a36c8
Parents: 8ab374b
Author: Thakker <TH...@ad.vzwcorp.com>
Authored: Mon Nov 21 11:03:01 2016 -0500
Committer: Claus Ibsen <da...@apache.org>
Committed: Tue Nov 22 09:47:26 2016 +0100

----------------------------------------------------------------------
 .../src/main/docs/spring-ldap-component.adoc    | 34 +++++++++++++++++---
 1 file changed, 30 insertions(+), 4 deletions(-)
----------------------------------------------------------------------


http://git-wip-us.apache.org/repos/asf/camel/blob/23c7dc46/components/camel-spring-ldap/src/main/docs/spring-ldap-component.adoc
----------------------------------------------------------------------
diff --git a/components/camel-spring-ldap/src/main/docs/spring-ldap-component.adoc b/components/camel-spring-ldap/src/main/docs/spring-ldap-component.adoc
index 562bb52..d7a18a2 100644
--- a/components/camel-spring-ldap/src/main/docs/spring-ldap-component.adoc
+++ b/components/camel-spring-ldap/src/main/docs/spring-ldap-component.adoc
@@ -46,7 +46,7 @@ The Spring LDAP component has no options.
 
 
 // endpoint options: START
-The Spring LDAP component supports 4 endpoint options which are listed below:
+The Spring LDAP component supports 7 endpoint options which are listed below:
 
 {% raw %}
 [width="100%",cols="2,1,1m,1m,5",options="header"]
@@ -68,12 +68,12 @@ 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
+This map must contain at least an entry with the key *`dn`* (not needed for function_driven operation) 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
+operations. For the `search` and `function_driven` operations, 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].
 
@@ -82,7 +82,7 @@ Search
 ++++++
 
 The message body must have an entry with the key *`filter`*. The value
-must be a String representing a valid LDAP filter, see
+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]]
@@ -101,6 +101,28 @@ Unbind
 No further entries necessary, the node with the specified *`dn`* is
 deleted.
 
+[[SpringLDAP-Authenticate]]
+Authenticate
++++++++++++
+
+The message body must have entries with the keys *`filter`* and  *`password`*. The
+values must be an instance of `String` representing a valid LDAP filter and a user password, respectively.
+
+[[SpringLDAP-ModifyAttributes]]
+Modify Attributes
+++++++++++++++++
+
+The message body must have an entry with the key *`modificationItems`*. The
+value must be an instance of any array of type 
+http://docs.oracle.com/javase/6/docs/api/javax/naming/directory/ModificationItem.html[javax.naming.directory.ModificationItem]
+
+[[SpringLDAP-FunctionDriven]]
+Function-Driven
+++++++++++++++++
+
+The message body must have entries with the keys *`function`* and *`request`*. The *`function`* value must be of type `org.apache.camel.component.springldap.LdapOperationsFunction<Q, S>`. The *`request`* value must be the same type as the `Q` type parameter in the *`function`* and it must encapsulate the parameters expected by the LdapTemplate method being invoked within the *`function`*. The `S` type parameter represents the response type as returned by the LdapTemplate method being invoked.
+This operation allows dynamic invocation of LdapTemplate methods that are not covered by the operations mentioned above.
+
 *Key definitions*
 
 In order to avoid spelling errors, the following constants are defined
@@ -109,4 +131,8 @@ in `org.apache.camel.springldap.SpringLdapProducer`:
 * public static final String DN = "dn"
 * public static final String FILTER = "filter"
 * public static final String ATTRIBUTES = "attributes"
+* public static final String PASSWORD = "password";
+* public static final String MODIFICATION_ITEMS = "modificationItems";
+* public static final String FUNCTION = "function";
+* public static final String REQUEST = "request";