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 2015/04/24 08:00:08 UTC

[1/2] camel git commit: Component doc

Repository: camel
Updated Branches:
  refs/heads/master 157c7366f -> 196c1f5ea


Component doc


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

Branch: refs/heads/master
Commit: df79b5991ec555a4befd4fb031d1bfca95b47aea
Parents: 157c736
Author: Claus Ibsen <da...@apache.org>
Authored: Fri Apr 24 07:53:11 2015 +0200
Committer: Claus Ibsen <da...@apache.org>
Committed: Fri Apr 24 07:53:11 2015 +0200

----------------------------------------------------------------------
 .../component/docker/DockerConfiguration.java   | 46 ++++++++------------
 1 file changed, 19 insertions(+), 27 deletions(-)
----------------------------------------------------------------------


http://git-wip-us.apache.org/repos/asf/camel/blob/df79b599/components/camel-docker/src/main/java/org/apache/camel/component/docker/DockerConfiguration.java
----------------------------------------------------------------------
diff --git a/components/camel-docker/src/main/java/org/apache/camel/component/docker/DockerConfiguration.java b/components/camel-docker/src/main/java/org/apache/camel/component/docker/DockerConfiguration.java
index 4ac97a5..442bc83 100644
--- a/components/camel-docker/src/main/java/org/apache/camel/component/docker/DockerConfiguration.java
+++ b/components/camel-docker/src/main/java/org/apache/camel/component/docker/DockerConfiguration.java
@@ -30,45 +30,32 @@ public class DockerConfiguration implements Cloneable {
 
     @UriPath @Metadata(required = "true")
     private DockerOperation operation;
-
     @UriParam(defaultValue = "localhost") @Metadata(required = "true")
     private String host = "localhost";
-
     @UriParam(defaultValue = "2375") @Metadata(required = "true")
     private Integer port = 2375;
-
     @UriParam
     private String username;
-
     @UriParam
     private String password;
-
     @UriParam
     private String email;
-
     @UriParam(defaultValue = "https://index.docker.io/v1/")
     private String serverAddress = "https://index.docker.io/v1/";
-
     @UriParam
     private Integer requestTimeout;
-
     @UriParam
-    private Boolean secure;
-
+    private boolean secure;
     @UriParam
     private String certPath;
-
     @UriParam(defaultValue = "100")
     private Integer maxTotalConnections = 100;
-
     @UriParam(defaultValue = "100")
     private Integer maxPerRouteConnections = 100;
-    
     @UriParam
-    private Boolean loggingFilterEnabled;
-    
+    private boolean loggingFilter;
     @UriParam
-    private Boolean followRedirectFilterEnabled;
+    private boolean followRedirectFilter;
 
     private Map<String, Object> parameters = new HashMap<String, Object>();
 
@@ -149,14 +136,14 @@ public class DockerConfiguration implements Cloneable {
         this.requestTimeout = requestTimeout;
     }
 
-    public Boolean isSecure() {
+    public boolean isSecure() {
         return secure;
     }
 
     /**
      * Use HTTPS communication
      */
-    public void setSecure(Boolean secure) {
+    public void setSecure(boolean secure) {
         this.secure = secure;
     }
 
@@ -193,20 +180,26 @@ public class DockerConfiguration implements Cloneable {
         this.maxPerRouteConnections = maxPerRouteConnections;
     }
 
-    public Boolean isLoggingFilterEnabled() {
-        return loggingFilterEnabled;
+    public boolean isLoggingFilterEnabled() {
+        return loggingFilter;
     }
 
-    public void setLoggingFilter(Boolean loggingFilterEnabled) {
-        this.loggingFilterEnabled = loggingFilterEnabled;
+    /**
+     * Whether to use logging filter
+     */
+    public void setLoggingFilter(boolean loggingFilterEnabled) {
+        this.loggingFilter = loggingFilterEnabled;
     }
 
-    public Boolean isFollowRedirectFilterEnabled() {
-        return followRedirectFilterEnabled;
+    public boolean isFollowRedirectFilterEnabled() {
+        return followRedirectFilter;
     }
 
-    public void setFollowRedirectFilter(Boolean followRedirectFilterEnabled) {
-        this.followRedirectFilterEnabled = followRedirectFilterEnabled;
+    /**
+     * Whether to follow redirect filter
+     */
+    public void setFollowRedirectFilter(boolean followRedirectFilterEnabled) {
+        this.followRedirectFilter = followRedirectFilterEnabled;
     }
 
     public Map<String, Object> getParameters() {
@@ -239,5 +232,4 @@ public class DockerConfiguration implements Cloneable {
         }
     }
 
-
 }


[2/2] camel git commit: Component doc

Posted by da...@apache.org.
Component doc


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

Branch: refs/heads/master
Commit: 196c1f5ea8c14cc5a36c7f4aed3dacaeb577e733
Parents: df79b59
Author: Claus Ibsen <da...@apache.org>
Authored: Fri Apr 24 08:03:09 2015 +0200
Committer: Claus Ibsen <da...@apache.org>
Committed: Fri Apr 24 08:03:09 2015 +0200

----------------------------------------------------------------------
 .../camel/component/yammer/YammerComponent.java | 12 ++++
 .../component/yammer/YammerConfiguration.java   | 61 +++++++++++++++++---
 2 files changed, 64 insertions(+), 9 deletions(-)
----------------------------------------------------------------------


http://git-wip-us.apache.org/repos/asf/camel/blob/196c1f5e/components/camel-yammer/src/main/java/org/apache/camel/component/yammer/YammerComponent.java
----------------------------------------------------------------------
diff --git a/components/camel-yammer/src/main/java/org/apache/camel/component/yammer/YammerComponent.java b/components/camel-yammer/src/main/java/org/apache/camel/component/yammer/YammerComponent.java
index 2655beb..6d83570 100644
--- a/components/camel-yammer/src/main/java/org/apache/camel/component/yammer/YammerComponent.java
+++ b/components/camel-yammer/src/main/java/org/apache/camel/component/yammer/YammerComponent.java
@@ -57,6 +57,9 @@ public class YammerComponent extends DefaultComponent {
         return consumerKey;
     }
 
+    /**
+     * The consumer key
+     */
     public void setConsumerKey(String consumerKey) {
         this.consumerKey = consumerKey;
     }
@@ -65,6 +68,9 @@ public class YammerComponent extends DefaultComponent {
         return consumerSecret;
     }
 
+    /**
+     * The consumer secret
+     */
     public void setConsumerSecret(String consumerSecret) {
         this.consumerSecret = consumerSecret;
     }
@@ -73,6 +79,9 @@ public class YammerComponent extends DefaultComponent {
         return accessToken;
     }
 
+    /**
+     * The access token
+     */
     public void setAccessToken(String accessToken) {
         this.accessToken = accessToken;
     }
@@ -81,6 +90,9 @@ public class YammerComponent extends DefaultComponent {
         return config;
     }
 
+    /**
+     * To use a shared yammer configuration
+     */
     public void setConfig(YammerConfiguration config) {
         this.config = config;
     }

http://git-wip-us.apache.org/repos/asf/camel/blob/196c1f5e/components/camel-yammer/src/main/java/org/apache/camel/component/yammer/YammerConfiguration.java
----------------------------------------------------------------------
diff --git a/components/camel-yammer/src/main/java/org/apache/camel/component/yammer/YammerConfiguration.java b/components/camel-yammer/src/main/java/org/apache/camel/component/yammer/YammerConfiguration.java
index deee282..9899d05 100644
--- a/components/camel-yammer/src/main/java/org/apache/camel/component/yammer/YammerConfiguration.java
+++ b/components/camel-yammer/src/main/java/org/apache/camel/component/yammer/YammerConfiguration.java
@@ -27,25 +27,25 @@ public class YammerConfiguration {
     @UriPath(name = "function") @Metadata(required = "true")
     private YammerFunctionType functionType;
     private String function;
-    @UriParam
+    @UriParam  @Metadata(required = "true")
     private String consumerKey;
-    @UriParam
+    @UriParam  @Metadata(required = "true")
     private String consumerSecret;
-    @UriParam
+    @UriParam  @Metadata(required = "true")
     private String accessToken;
     @UriParam
     private boolean useJson;
-    @UriParam(defaultValue = "5000")
+    @UriParam(label = "consumer", defaultValue = "5000")
     private long delay = 3000 + 2000; // 3 sec per poll is enforced by yammer; add 2 sec for safety
-    @UriParam(defaultValue = "-1")
+    @UriParam(label = "consumer", defaultValue = "-1")
     private int limit = -1; // default is unlimited
-    @UriParam(defaultValue = "-1")
+    @UriParam(label = "consumer", defaultValue = "-1")
     private int olderThan = -1;
-    @UriParam(defaultValue = "-1")
+    @UriParam(label = "consumer", defaultValue = "-1")
     private int newerThan = -1;
-    @UriParam
+    @UriParam(label = "consumer", enums = "true,extended")
     private String threaded;
-    @UriParam
+    @UriParam(label = "consumer")
     private String userId;
     private ApiRequestor requestor;
 
@@ -53,6 +53,9 @@ public class YammerConfiguration {
         return consumerKey;
     }
 
+    /**
+     * The consumer key
+     */
     public void setConsumerKey(String consumerKey) {
         this.consumerKey = consumerKey;
     }
@@ -61,6 +64,9 @@ public class YammerConfiguration {
         return consumerSecret;
     }
 
+    /**
+     * The consumer secret
+     */
     public void setConsumerSecret(String consumerSecret) {
         this.consumerSecret = consumerSecret;
     }
@@ -69,6 +75,9 @@ public class YammerConfiguration {
         return delay;
     }
 
+    /**
+     * Delay between polling in millis
+     */
     public void setDelay(long delay) {
         this.delay = delay;
     }
@@ -77,6 +86,9 @@ public class YammerConfiguration {
         return accessToken;
     }
 
+    /**
+     * The access token
+     */
     public void setAccessToken(String accessToken) {
         this.accessToken = accessToken;
     }
@@ -85,6 +97,9 @@ public class YammerConfiguration {
         return functionType;
     }
 
+    /**
+     * The function to use
+     */
     public void setFunctionType(YammerFunctionType functionType) {
         this.functionType = functionType;
     }
@@ -93,6 +108,9 @@ public class YammerConfiguration {
         return function;
     }
 
+    /**
+     * The function to use
+     */
     public void setFunction(String function) {
         this.function = function;
     }
@@ -101,6 +119,9 @@ public class YammerConfiguration {
         return useJson;
     }
 
+    /**
+     * Set to true if you want to use raw JSON rather than converting to POJOs.
+     */
     public void setUseJson(boolean useJson) {
         this.useJson = useJson;
     }
@@ -120,6 +141,9 @@ public class YammerConfiguration {
         return limit;
     }
 
+    /**
+     * Return only the specified number of messages. Works for threaded=true and threaded=extended.
+     */
     public void setLimit(int limit) {
         this.limit = limit;
     }
@@ -128,6 +152,11 @@ public class YammerConfiguration {
         return olderThan;
     }
 
+    /**
+     * Returns messages older than the message ID specified as a numeric string.
+     * This is useful for paginating messages. For example, if you're currently viewing 20 messages and the oldest is number 2912,
+     * you could append "?olderThan=2912″ to your request to get the 20 messages prior to those you're seeing.
+     */
     public void setOlderThan(int olderThan) {
         this.olderThan = olderThan;
     }
@@ -136,6 +165,11 @@ public class YammerConfiguration {
         return newerThan;
     }
 
+    /**
+     * Returns messages newer than the message ID specified as a numeric string. This should be used when polling for new messages.
+     * If you're looking at messages, and the most recent message returned is 3516, you can make a request with the parameter "?newerThan=3516″
+     * to ensure that you do not get duplicate copies of messages already on your page.
+     */
     public void setNewerThan(int newerThan) {
         this.newerThan = newerThan;
     }
@@ -144,6 +178,12 @@ public class YammerConfiguration {
         return threaded;
     }
 
+    /**
+     * threaded=true will only return the first message in each thread.
+     * This parameter is intended for apps which display message threads collapsed.
+     * threaded=extended will return the thread starter messages in order of most recently active as well as the
+     * two most recent messages, as they are viewed in the default view on the Yammer web interface.
+     */
     public void setThreaded(String threaded) {
         this.threaded = threaded;
     }
@@ -152,6 +192,9 @@ public class YammerConfiguration {
         return userId;
     }
 
+    /**
+     * The user id
+     */
     public void setUserId(String userId) {
         this.userId = userId;
     }