Component doc

apache · Apr 24, 2015 · 9d9f2b3 · 9d9f2b3
1 parent 429b354
commit 9d9f2b3
Show file tree

Hide file tree

Showing 3 changed files with 34 additions and 40 deletions.
diff --git a/.../camel-jgroups/src/main/java/org/apache/camel/component/jgroups/CamelJGroupsReceiver.java b/.../camel-jgroups/src/main/java/org/apache/camel/component/jgroups/CamelJGroupsReceiver.java
@@ -49,7 +49,7 @@ public CamelJGroupsReceiver(JGroupsEndpoint endpoint, Processor processor) {
 
     @Override
     public void viewAccepted(View view) {
-        if (endpoint.isResolvedEnableViewMessages()) {
+        if (endpoint.isEnableViewMessages()) {
             Exchange exchange = endpoint.createExchange(view);
             try {
                 LOG.debug("Processing view: {}", view);

diff --git a/...ents/camel-jgroups/src/main/java/org/apache/camel/component/jgroups/JGroupsComponent.java b/...ents/camel-jgroups/src/main/java/org/apache/camel/component/jgroups/JGroupsComponent.java
@@ -28,10 +28,8 @@
 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 Channel getChannel() {
         return channel;
     }
 
+    /**
+     * Channel to use
+     */
     public void setChannel(Channel channel) {
         this.channel = channel;
     }
@@ -54,15 +55,22 @@ public String getChannelProperties() {
         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;
     }
 

diff --git a/...nents/camel-jgroups/src/main/java/org/apache/camel/component/jgroups/JGroupsEndpoint.java b/...nents/camel-jgroups/src/main/java/org/apache/camel/component/jgroups/JGroupsEndpoint.java
@@ -39,33 +39,25 @@
 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
+    public JGroupsEndpoint(String endpointUri, Component component, Channel channel, String clusterName, String channelProperties, boolean enableViewMessages) {
-    private Boolean enableViewMessages;
-
-    @UriParam
-    private boolean resolvedEnableViewMessages;
-
-    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 Exchange createExchange() {
     protected void doStart() throws Exception {
         super.doStart();
         resolvedChannel = resolveChannel();
-        resolvedEnableViewMessages = resolveEnableViewMessages();
     }
 
     @Override
@@ -154,17 +145,13 @@ public void disconnect() {
         }
     }
 
-    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 String getClusterName() {
         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 String getChannelProperties() {
         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) {
+    public boolean isEnableViewMessages() {
-        this.resolvedChannel = resolvedChannel;
-    }
-
-    public Boolean getEnableViewMessages() {
         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;
-    }
 }