camel-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From lburgazz...@apache.org
Subject [1/2] camel git commit: camel-master: add some javadoc
Date Thu, 28 Sep 2017 08:54:00 GMT
Repository: camel
Updated Branches:
  refs/heads/master 894ab4d75 -> 27c02551b


camel-master: add some javadoc


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

Branch: refs/heads/master
Commit: a7a867fce5197800488395c86aef2d730fb2841f
Parents: 894ab4d
Author: lburgazzoli <lburgazzoli@gmail.com>
Authored: Thu Sep 28 10:53:24 2017 +0200
Committer: lburgazzoli <lburgazzoli@gmail.com>
Committed: Thu Sep 28 10:53:42 2017 +0200

----------------------------------------------------------------------
 .../apache/camel/component/master/MasterComponent.java    | 10 ++++++----
 .../org/apache/camel/component/master/MasterConsumer.java |  4 ++++
 .../org/apache/camel/component/master/MasterEndpoint.java |  5 +++++
 .../master/springboot/MasterComponentConfiguration.java   |  3 ++-
 4 files changed, 17 insertions(+), 5 deletions(-)
----------------------------------------------------------------------


http://git-wip-us.apache.org/repos/asf/camel/blob/a7a867fc/components/camel-master/src/main/java/org/apache/camel/component/master/MasterComponent.java
----------------------------------------------------------------------
diff --git a/components/camel-master/src/main/java/org/apache/camel/component/master/MasterComponent.java
b/components/camel-master/src/main/java/org/apache/camel/component/master/MasterComponent.java
index 6d2b3dc..5b8a6f6 100644
--- a/components/camel-master/src/main/java/org/apache/camel/component/master/MasterComponent.java
+++ b/components/camel-master/src/main/java/org/apache/camel/component/master/MasterComponent.java
@@ -29,10 +29,12 @@ import org.apache.camel.util.ObjectHelper;
 import org.apache.camel.util.StringHelper;
 
 /**
- * The master camel component ensures that only a single endpoint in a cluster is
- * active at any point in time with all other JVMs being hot standbys which wait
- * until the master JVM dies before taking over to provide high availability of
- * a single consumer.
+ * The master camel component provides a way to ensures that only a single endpoint
+ * in a cluster is active at any point in time with automatic failover if the
+ * JVM dies or the leadership is lot for any reason.
+ * <p>
+ * This feature is useful if you need to consume from a backend that does not
+ * support concurrent consumption.
  */
 public class MasterComponent extends DefaultComponent {
     @Metadata(label = "advanced")

http://git-wip-us.apache.org/repos/asf/camel/blob/a7a867fc/components/camel-master/src/main/java/org/apache/camel/component/master/MasterConsumer.java
----------------------------------------------------------------------
diff --git a/components/camel-master/src/main/java/org/apache/camel/component/master/MasterConsumer.java
b/components/camel-master/src/main/java/org/apache/camel/component/master/MasterConsumer.java
index 999ac71..c7edd91 100644
--- a/components/camel-master/src/main/java/org/apache/camel/component/master/MasterConsumer.java
+++ b/components/camel-master/src/main/java/org/apache/camel/component/master/MasterConsumer.java
@@ -35,6 +35,10 @@ import org.apache.camel.util.ServiceHelper;
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
 
+/**
+ * A consumer which is only really active when the {@link CamelClusterView} has
+ * the leadership.
+ */
 @ManagedResource(description = "Managed Master Consumer")
 public class MasterConsumer extends DefaultConsumer {
     private static final transient Logger LOGGER = LoggerFactory.getLogger(MasterConsumer.class);

http://git-wip-us.apache.org/repos/asf/camel/blob/a7a867fc/components/camel-master/src/main/java/org/apache/camel/component/master/MasterEndpoint.java
----------------------------------------------------------------------
diff --git a/components/camel-master/src/main/java/org/apache/camel/component/master/MasterEndpoint.java
b/components/camel-master/src/main/java/org/apache/camel/component/master/MasterEndpoint.java
index 10547a5..abeb601 100644
--- a/components/camel-master/src/main/java/org/apache/camel/component/master/MasterEndpoint.java
+++ b/components/camel-master/src/main/java/org/apache/camel/component/master/MasterEndpoint.java
@@ -24,11 +24,16 @@ import org.apache.camel.Producer;
 import org.apache.camel.api.management.ManagedAttribute;
 import org.apache.camel.api.management.ManagedResource;
 import org.apache.camel.ha.CamelClusterService;
+import org.apache.camel.ha.CamelClusterView;
 import org.apache.camel.impl.DefaultEndpoint;
 import org.apache.camel.spi.Metadata;
 import org.apache.camel.spi.UriEndpoint;
 import org.apache.camel.spi.UriPath;
 
+/**
+ * Represents an endpoint which only becomes active when the {@link CamelClusterView}
+ * has the leadership.
+ */
 @ManagedResource(description = "Managed Master Endpoint")
 @UriEndpoint(
     firstVersion = "2.20.0",

http://git-wip-us.apache.org/repos/asf/camel/blob/a7a867fc/platforms/spring-boot/components-starter/camel-master-starter/src/main/java/org/apache/camel/component/master/springboot/MasterComponentConfiguration.java
----------------------------------------------------------------------
diff --git a/platforms/spring-boot/components-starter/camel-master-starter/src/main/java/org/apache/camel/component/master/springboot/MasterComponentConfiguration.java
b/platforms/spring-boot/components-starter/camel-master-starter/src/main/java/org/apache/camel/component/master/springboot/MasterComponentConfiguration.java
index 3a1de95..cce155e 100644
--- a/platforms/spring-boot/components-starter/camel-master-starter/src/main/java/org/apache/camel/component/master/springboot/MasterComponentConfiguration.java
+++ b/platforms/spring-boot/components-starter/camel-master-starter/src/main/java/org/apache/camel/component/master/springboot/MasterComponentConfiguration.java
@@ -24,7 +24,8 @@ import org.springframework.boot.context.properties.ConfigurationProperties;
 import org.springframework.boot.context.properties.NestedConfigurationProperty;
 
 /**
- * Camel Master Support
+ * Represents an endpoint which only becomes active when the CamelClusterView
+ * has the leadership.
  * 
  * Generated by camel-package-maven-plugin - do not edit this file!
  */


Mime
View raw message