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 14:10:45 UTC

[4/6] camel git commit: Component doc

Component doc


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

Branch: refs/heads/master
Commit: 9d9f2b3c47c4b138d6d3fc7b210ddd9c788a4c91
Parents: 429b354
Author: Claus Ibsen <da...@apache.org>
Authored: Fri Apr 24 14:00:00 2015 +0200
Committer: Claus Ibsen <da...@apache.org>
Committed: Fri Apr 24 14:00:00 2015 +0200

----------------------------------------------------------------------
 .../component/jgroups/CamelJGroupsReceiver.java |  2 +-
 .../component/jgroups/JGroupsComponent.java     | 18 +++++--
 .../component/jgroups/JGroupsEndpoint.java      | 54 ++++++++------------
 3 files changed, 34 insertions(+), 40 deletions(-)
----------------------------------------------------------------------


http://git-wip-us.apache.org/repos/asf/camel/blob/9d9f2b3c/components/camel-jgroups/src/main/java/org/apache/camel/component/jgroups/CamelJGroupsReceiver.java
----------------------------------------------------------------------
diff --git a/components/camel-jgroups/src/main/java/org/apache/camel/component/jgroups/CamelJGroupsReceiver.java b/components/camel-jgroups/src/main/java/org/apache/camel/component/jgroups/CamelJGroupsReceiver.java
index 1fbbe7a..7233a8a 100644
--- a/components/camel-jgroups/src/main/java/org/apache/camel/component/jgroups/CamelJGroupsReceiver.java
+++ b/components/camel-jgroups/src/main/java/org/apache/camel/component/jgroups/CamelJGroupsReceiver.java
@@ -49,7 +49,7 @@ public class CamelJGroupsReceiver extends ReceiverAdapter {
 
     @Override
     public void viewAccepted(View view) {
-        if (endpoint.isResolvedEnableViewMessages()) {
+        if (endpoint.isEnableViewMessages()) {
             Exchange exchange = endpoint.createExchange(view);
             try {
                 LOG.debug("Processing view: {}", view);

http://git-wip-us.apache.org/repos/asf/camel/blob/9d9f2b3c/components/camel-jgroups/src/main/java/org/apache/camel/component/jgroups/JGroupsComponent.java
----------------------------------------------------------------------
diff --git a/components/camel-jgroups/src/main/java/org/apache/camel/component/jgroups/JGroupsComponent.java b/components/camel-jgroups/src/main/java/org/apache/camel/component/jgroups/JGroupsComponent.java
index b7c906e..9096094 100644
--- a/components/camel-jgroups/src/main/java/org/apache/camel/component/jgroups/JGroupsComponent.java
+++ b/components/camel-jgroups/src/main/java/org/apache/camel/component/jgroups/JGroupsComponent.java
@@ -28,10 +28,8 @@ import org.jgroups.Channel;
 public class JGroupsComponent extends UriEndpointComponent {
 
     private Channel channel;
-
     private String channelProperties;
-
-    private Boolean enableViewMessages;
+    private boolean enableViewMessages;
 
     public JGroupsComponent() {
         super(JGroupsEndpoint.class);
@@ -46,6 +44,9 @@ public class JGroupsComponent extends UriEndpointComponent {
         return channel;
     }
 
+    /**
+     * Channel to use
+     */
     public void setChannel(Channel channel) {
         this.channel = channel;
     }
@@ -54,15 +55,22 @@ public class JGroupsComponent extends UriEndpointComponent {
         return channelProperties;
     }
 
+    /**
+     * Specifies configuration properties of the JChannel used by the endpoint.
+     */
     public void setChannelProperties(String channelProperties) {
         this.channelProperties = channelProperties;
     }
 
-    public Boolean getEnableViewMessages() {
+    public boolean isEnableViewMessages() {
         return enableViewMessages;
     }
 
-    public void setEnableViewMessages(Boolean enableViewMessages) {
+    /**
+     * If set to true, the consumer endpoint will receive org.jgroups.View messages as well (not only org.jgroups.Message instances).
+     * By default only regular messages are consumed by the endpoint.
+     */
+    public void setEnableViewMessages(boolean enableViewMessages) {
         this.enableViewMessages = enableViewMessages;
     }
 

http://git-wip-us.apache.org/repos/asf/camel/blob/9d9f2b3c/components/camel-jgroups/src/main/java/org/apache/camel/component/jgroups/JGroupsEndpoint.java
----------------------------------------------------------------------
diff --git a/components/camel-jgroups/src/main/java/org/apache/camel/component/jgroups/JGroupsEndpoint.java b/components/camel-jgroups/src/main/java/org/apache/camel/component/jgroups/JGroupsEndpoint.java
index d92d09a..ea32da8 100644
--- a/components/camel-jgroups/src/main/java/org/apache/camel/component/jgroups/JGroupsEndpoint.java
+++ b/components/camel-jgroups/src/main/java/org/apache/camel/component/jgroups/JGroupsEndpoint.java
@@ -39,33 +39,25 @@ import org.slf4j.LoggerFactory;
 public class JGroupsEndpoint extends DefaultEndpoint {
 
     public static final String HEADER_JGROUPS_ORIGINAL_MESSAGE = "JGROUPS_ORIGINAL_MESSAGE";
-
     public static final String HEADER_JGROUPS_SRC = "JGROUPS_SRC";
-
     public static final String HEADER_JGROUPS_DEST = "JGROUPS_DEST";
-
     public static final String HEADER_JGROUPS_CHANNEL_ADDRESS = "JGROUPS_CHANNEL_ADDRESS";
 
     private static final Logger LOG = LoggerFactory.getLogger(JGroupsEndpoint.class);
 
-    private Channel channel;
     private AtomicInteger connectCount = new AtomicInteger(0);
 
+    private Channel channel;
     private Channel resolvedChannel;
 
     @UriPath @Metadata(required = "true")
     private String clusterName;
-
     @UriParam
     private String channelProperties;
+    @UriParam(label = "consumer")
+    private boolean enableViewMessages;
 
-    @UriParam
-    private Boolean enableViewMessages;
-
-    @UriParam
-    private boolean resolvedEnableViewMessages;
-
-    public JGroupsEndpoint(String endpointUri, Component component, Channel channel, String clusterName, String channelProperties, Boolean enableViewMessages) {
+    public JGroupsEndpoint(String endpointUri, Component component, Channel channel, String clusterName, String channelProperties, boolean enableViewMessages) {
         super(endpointUri, component);
         this.channel = channel;
         this.clusterName = clusterName;
@@ -114,7 +106,6 @@ public class JGroupsEndpoint extends DefaultEndpoint {
     protected void doStart() throws Exception {
         super.doStart();
         resolvedChannel = resolveChannel();
-        resolvedEnableViewMessages = resolveEnableViewMessages();
     }
 
     @Override
@@ -154,17 +145,13 @@ public class JGroupsEndpoint extends DefaultEndpoint {
         }
     }
 
-    private boolean resolveEnableViewMessages() {
-        if (enableViewMessages != null) {
-            resolvedEnableViewMessages = enableViewMessages;
-        }
-        return resolvedEnableViewMessages;
-    }
-
     public Channel getChannel() {
         return channel;
     }
 
+    /**
+     * The channel to use
+     */
     public void setChannel(Channel channel) {
         this.channel = channel;
     }
@@ -173,6 +160,9 @@ public class JGroupsEndpoint extends DefaultEndpoint {
         return clusterName;
     }
 
+    /**
+     * The name of the JGroups cluster the component should connect to.
+     */
     public void setClusterName(String clusterName) {
         this.clusterName = clusterName;
     }
@@ -181,31 +171,27 @@ public class JGroupsEndpoint extends DefaultEndpoint {
         return channelProperties;
     }
 
+    /**
+     * Specifies configuration properties of the JChannel used by the endpoint.
+     */
     public void setChannelProperties(String channelProperties) {
         this.channelProperties = channelProperties;
     }
 
-    public Channel getResolvedChannel() {
+    Channel getResolvedChannel() {
         return resolvedChannel;
     }
 
-    public void setResolvedChannel(Channel resolvedChannel) {
-        this.resolvedChannel = resolvedChannel;
-    }
-
-    public Boolean getEnableViewMessages() {
+    public boolean isEnableViewMessages() {
         return enableViewMessages;
     }
 
-    public void setEnableViewMessages(Boolean enableViewMessages) {
+    /**
+     * If set to true, the consumer endpoint will receive org.jgroups.View messages as well (not only org.jgroups.Message instances).
+     * By default only regular messages are consumed by the endpoint.
+     */
+    public void setEnableViewMessages(boolean enableViewMessages) {
         this.enableViewMessages = enableViewMessages;
     }
 
-    public boolean isResolvedEnableViewMessages() {
-        return resolvedEnableViewMessages;
-    }
-
-    public void setResolvedEnableViewMessages(boolean resolvedEnableViewMessages) {
-        this.resolvedEnableViewMessages = resolvedEnableViewMessages;
-    }
 }
\ No newline at end of file