Repository: camel
Updated Branches:
  refs/heads/master 2b12e0c1d -> 30d86101b


Component docs


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

Branch: refs/heads/master
Commit: 19522de1a9284b3af17e6b1a53119d741c27f2c1
Parents: 2b12e0c
Author: Claus Ibsen <davscl...@apache.org>
Authored: Thu May 7 10:30:11 2015 +0200
Committer: Claus Ibsen <davscl...@apache.org>
Committed: Thu May 7 10:38:07 2015 +0200

----------------------------------------------------------------------
 .../camel/component/github/GitHubEndpoint.java  | 45 +++++++++++++++++---
 .../guava/eventbus/GuavaEventBusComponent.java  |  8 ++++
 .../guava/eventbus/GuavaEventBusEndpoint.java   | 17 ++++++++
 3 files changed, 63 insertions(+), 7 deletions(-)
----------------------------------------------------------------------


http://git-wip-us.apache.org/repos/asf/camel/blob/19522de1/components/camel-github/src/main/java/org/apache/camel/component/github/GitHubEndpoint.java
----------------------------------------------------------------------
diff --git 
a/components/camel-github/src/main/java/org/apache/camel/component/github/GitHubEndpoint.java
 
b/components/camel-github/src/main/java/org/apache/camel/component/github/GitHubEndpoint.java
index 04f7e77..e2edcf3 100644
--- 
a/components/camel-github/src/main/java/org/apache/camel/component/github/GitHubEndpoint.java
+++ 
b/components/camel-github/src/main/java/org/apache/camel/component/github/GitHubEndpoint.java
@@ -29,6 +29,7 @@ import 
org.apache.camel.component.github.producer.PullRequestCommentProducer;
 import org.apache.camel.component.github.producer.PullRequestFilesProducer;
 import org.apache.camel.component.github.producer.PullRequestStateProducer;
 import org.apache.camel.impl.DefaultEndpoint;
+import org.apache.camel.spi.Metadata;
 import org.apache.camel.spi.UriEndpoint;
 import org.apache.camel.spi.UriParam;
 import org.apache.camel.spi.UriPath;
@@ -58,9 +59,9 @@ import org.apache.camel.util.ObjectHelper;
 @UriEndpoint(scheme = "github", title = "GitHub", syntax = 
"github:type/branchName", label = "api,file")
 public class GitHubEndpoint extends DefaultEndpoint {
 
-    @UriPath
+    @UriPath @Metadata(required = "true")
     private GitHubType type;
-    @UriPath
+    @UriPath(label = "consumer")
     private String branchName;
     @UriParam
     private String username;
@@ -68,15 +69,15 @@ public class GitHubEndpoint extends DefaultEndpoint {
     private String password;
     @UriParam
     private String oauthToken;
-    @UriParam
+    @UriParam @Metadata(required = "true")
     private String repoOwner;
-    @UriParam
+    @UriParam @Metadata(required = "true")
     private String repoName;
-    @UriParam
+    @UriParam(label = "producer", enums = "error,failure,pending,success")
     private String state;
-    @UriParam
+    @UriParam(label = "producer")
     private String targetUrl;
-    @UriParam
+    @UriParam(label = "producer")
     private String encoding;
 
     public GitHubEndpoint(String uri, GitHubComponent component) {
@@ -120,6 +121,9 @@ public class GitHubEndpoint extends DefaultEndpoint {
         return type;
     }
 
+    /**
+     * What git operation to execute
+     */
     public void setType(GitHubType type) {
         this.type = type;
     }
@@ -128,6 +132,9 @@ public class GitHubEndpoint extends DefaultEndpoint {
         return branchName;
     }
 
+    /**
+     * Name of branch
+     */
     public void setBranchName(String branchName) {
         this.branchName = branchName;
     }
@@ -136,6 +143,9 @@ public class GitHubEndpoint extends DefaultEndpoint {
         return username;
     }
 
+    /**
+     * GitHub username, required unless oauthToken is provided
+     */
     public void setUsername(String username) {
         this.username = username;
     }
@@ -144,6 +154,9 @@ public class GitHubEndpoint extends DefaultEndpoint {
         return password;
     }
 
+    /**
+     * GitHub password, required unless oauthToken is provided
+     */
     public void setPassword(String password) {
         this.password = password;
     }
@@ -152,6 +165,9 @@ public class GitHubEndpoint extends DefaultEndpoint {
         return oauthToken;
     }
 
+    /**
+     * GitHub OAuth token, required unless username & password are provided
+     */
     public void setOauthToken(String oauthToken) {
         this.oauthToken = oauthToken;
     }
@@ -164,6 +180,9 @@ public class GitHubEndpoint extends DefaultEndpoint {
         return repoOwner;
     }
 
+    /**
+     * GitHub repository owner (organization)
+     */
     public void setRepoOwner(String repoOwner) {
         this.repoOwner = repoOwner;
     }
@@ -172,6 +191,9 @@ public class GitHubEndpoint extends DefaultEndpoint {
         return repoName;
     }
 
+    /**
+     * GitHub repository name
+     */
     public void setRepoName(String repoName) {
         this.repoName = repoName;
     }
@@ -180,6 +202,9 @@ public class GitHubEndpoint extends DefaultEndpoint {
         return state;
     }
 
+    /**
+     * To set git commit status state
+     */
     public void setState(String state) {
         this.state = state;
     }
@@ -188,6 +213,9 @@ public class GitHubEndpoint extends DefaultEndpoint {
         return targetUrl;
     }
 
+    /**
+     * To set git commit status target url
+     */
     public void setTargetUrl(String targetUrl) {
         this.targetUrl = targetUrl;
     }
@@ -196,6 +224,9 @@ public class GitHubEndpoint extends DefaultEndpoint {
         return encoding;
     }
 
+    /**
+     * To use the given encoding when getting a git commit file
+     */
     public void setEncoding(String encoding) {
         this.encoding = encoding;
     }

http://git-wip-us.apache.org/repos/asf/camel/blob/19522de1/components/camel-guava-eventbus/src/main/java/org/apache/camel/component/guava/eventbus/GuavaEventBusComponent.java
----------------------------------------------------------------------
diff --git 
a/components/camel-guava-eventbus/src/main/java/org/apache/camel/component/guava/eventbus/GuavaEventBusComponent.java
 
b/components/camel-guava-eventbus/src/main/java/org/apache/camel/component/guava/eventbus/GuavaEventBusComponent.java
index 1a08a88..3a41e38 100644
--- 
a/components/camel-guava-eventbus/src/main/java/org/apache/camel/component/guava/eventbus/GuavaEventBusComponent.java
+++ 
b/components/camel-guava-eventbus/src/main/java/org/apache/camel/component/guava/eventbus/GuavaEventBusComponent.java
@@ -48,6 +48,9 @@ public class GuavaEventBusComponent extends 
UriEndpointComponent {
         return eventBus;
     }
 
+    /**
+     * To use the given Guava EventBus instance
+     */
     public void setEventBus(EventBus eventBus) {
         this.eventBus = eventBus;
     }
@@ -56,6 +59,11 @@ public class GuavaEventBusComponent extends 
UriEndpointComponent {
         return listenerInterface;
     }
 
+    /**
+     * The interface with method(s) marked with the @Subscribe annotation.
+     * Dynamic proxy will be created over the interface so it could be 
registered as the EventBus listener.
+     * Particularly useful when creating multi-event listeners and for 
handling DeadEvent properly. This option cannot be used together with 
eventClass option.
+     */
     public void setListenerInterface(Class<?> listenerInterface) {
         this.listenerInterface = listenerInterface;
     }

http://git-wip-us.apache.org/repos/asf/camel/blob/19522de1/components/camel-guava-eventbus/src/main/java/org/apache/camel/component/guava/eventbus/GuavaEventBusEndpoint.java
----------------------------------------------------------------------
diff --git 
a/components/camel-guava-eventbus/src/main/java/org/apache/camel/component/guava/eventbus/GuavaEventBusEndpoint.java
 
b/components/camel-guava-eventbus/src/main/java/org/apache/camel/component/guava/eventbus/GuavaEventBusEndpoint.java
index 3499d70..e7db21d 100644
--- 
a/components/camel-guava-eventbus/src/main/java/org/apache/camel/component/guava/eventbus/GuavaEventBusEndpoint.java
+++ 
b/components/camel-guava-eventbus/src/main/java/org/apache/camel/component/guava/eventbus/GuavaEventBusEndpoint.java
@@ -83,6 +83,9 @@ public class GuavaEventBusEndpoint extends DefaultEndpoint 
implements MultipleCo
         return eventBusRef;
     }
 
+    /**
+     * To lookup the Guava EventBus from the registry with the given name
+     */
     public void setEventBusRef(String eventBusRef) {
         this.eventBusRef = eventBusRef;
     }
@@ -91,6 +94,9 @@ public class GuavaEventBusEndpoint extends DefaultEndpoint 
implements MultipleCo
         return eventBus;
     }
 
+    /**
+     * To use the given Guava EventBus instance
+     */
     public void setEventBus(EventBus eventBus) {
         this.eventBus = eventBus;
     }
@@ -99,6 +105,12 @@ public class GuavaEventBusEndpoint extends DefaultEndpoint 
implements MultipleCo
         return eventClass;
     }
 
+    /**
+     * If used on the consumer side of the route, will filter events received 
from the EventBus to the instances of
+     * the class and superclasses of eventClass. Null value of this option is 
equal to setting it to the java.lang.Object
+     * i.e. the consumer will capture all messages incoming to the event bus. 
This option cannot be used together
+     * with listenerInterface option.
+     */
     public void setEventClass(Class<?> eventClass) {
         this.eventClass = eventClass;
     }
@@ -107,6 +119,11 @@ public class GuavaEventBusEndpoint extends DefaultEndpoint 
implements MultipleCo
         return listenerInterface;
     }
 
+    /**
+     * The interface with method(s) marked with the @Subscribe annotation.
+     * Dynamic proxy will be created over the interface so it could be 
registered as the EventBus listener.
+     * Particularly useful when creating multi-event listeners and for 
handling DeadEvent properly. This option cannot be used together with 
eventClass option.
+     */
     public void setListenerInterface(Class<?> listenerInterface) {
         this.listenerInterface = listenerInterface;
     }

Reply via email to