CAMEL-9014: Polished

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

Branch: refs/heads/master
Commit: 88ab0c4f9dd64ff876e1d640bad6f2c2c3e45402
Parents: 1fb2b49
Author: Claus Ibsen <[email protected]>
Authored: Sun Jul 26 13:33:53 2015 +0200
Committer: Claus Ibsen <[email protected]>
Committed: Sun Jul 26 13:34:13 2015 +0200

----------------------------------------------------------------------
 .../mbean/ManagedExtendedInformation.java       |  9 +++++
 .../DefaultEndpointUtilizationStatistics.java   | 12 +++----
 .../spi/EndpointUtilizationStatistics.java      | 35 ++++++++++++++++----
 3 files changed, 44 insertions(+), 12 deletions(-)
----------------------------------------------------------------------


http://git-wip-us.apache.org/repos/asf/camel/blob/88ab0c4f/camel-core/src/main/java/org/apache/camel/api/management/mbean/ManagedExtendedInformation.java
----------------------------------------------------------------------
diff --git 
a/camel-core/src/main/java/org/apache/camel/api/management/mbean/ManagedExtendedInformation.java
 
b/camel-core/src/main/java/org/apache/camel/api/management/mbean/ManagedExtendedInformation.java
index 33547bb..3612b1a 100644
--- 
a/camel-core/src/main/java/org/apache/camel/api/management/mbean/ManagedExtendedInformation.java
+++ 
b/camel-core/src/main/java/org/apache/camel/api/management/mbean/ManagedExtendedInformation.java
@@ -18,8 +18,17 @@ package org.apache.camel.api.management.mbean;
 
 import javax.management.openmbean.TabularData;
 
+/**
+ * Additional information gathered if {@link 
org.apache.camel.ManagementStatisticsLevel} is configured to
+ * be {@link org.apache.camel.ManagementStatisticsLevel#Extended}.
+ */
 public interface ManagedExtendedInformation {
 
+    /**
+     * Extended information such as utilization of endpoints.
+     *
+     * @return tabular data with extended information
+     */
     TabularData extendedInformation();
 
 }

http://git-wip-us.apache.org/repos/asf/camel/blob/88ab0c4f/camel-core/src/main/java/org/apache/camel/impl/DefaultEndpointUtilizationStatistics.java
----------------------------------------------------------------------
diff --git 
a/camel-core/src/main/java/org/apache/camel/impl/DefaultEndpointUtilizationStatistics.java
 
b/camel-core/src/main/java/org/apache/camel/impl/DefaultEndpointUtilizationStatistics.java
index 9c87550..9c8b1dc 100644
--- 
a/camel-core/src/main/java/org/apache/camel/impl/DefaultEndpointUtilizationStatistics.java
+++ 
b/camel-core/src/main/java/org/apache/camel/impl/DefaultEndpointUtilizationStatistics.java
@@ -41,20 +41,20 @@ public class DefaultEndpointUtilizationStatistics 
implements EndpointUtilization
     }
 
     @Override
-    public synchronized void onHit(String key) {
-        Long counter = map.get(key);
+    public synchronized void onHit(String uri) {
+        Long counter = map.get(uri);
         if (counter == null) {
             counter = 1L;
-            map.put(key, counter);
+            map.put(uri, counter);
         } else {
             counter++;
-            map.put(key, counter);
+            map.put(uri, counter);
         }
     }
 
     @Override
-    public void remove(String key) {
-        map.remove(key);
+    public void remove(String uri) {
+        map.remove(uri);
     }
 
     @Override

http://git-wip-us.apache.org/repos/asf/camel/blob/88ab0c4f/camel-core/src/main/java/org/apache/camel/spi/EndpointUtilizationStatistics.java
----------------------------------------------------------------------
diff --git 
a/camel-core/src/main/java/org/apache/camel/spi/EndpointUtilizationStatistics.java
 
b/camel-core/src/main/java/org/apache/camel/spi/EndpointUtilizationStatistics.java
index 81b252e..dabcd06 100644
--- 
a/camel-core/src/main/java/org/apache/camel/spi/EndpointUtilizationStatistics.java
+++ 
b/camel-core/src/main/java/org/apache/camel/spi/EndpointUtilizationStatistics.java
@@ -23,18 +23,41 @@ import java.util.Map;
  */
 public interface EndpointUtilizationStatistics {
 
-    // TODO: document me
-
+    /**
+     * Maximum number of elements that we can have information about
+     */
     int maxCapacity();
 
+    /**
+     * Current number of endpoints we have information about
+     */
     int size();
 
-    void onHit(String key);
-
-    void remove(String key);
-
+    /**
+     * Callback when an endpoint is being utilizated by an {@link 
org.apache.camel.Processor} EIP
+     * such as sending a message to a dynamic endpoint.
+     *
+     * @param uri  the endpoint uri
+     */
+    void onHit(String uri);
+
+    /**
+     * To remove an endpoint from tracking information about its utilization
+     *
+     * @param uri  the endpoint uri
+     */
+    void remove(String uri);
+
+    /**
+     * Gets the endpoint utilization statistics.
+     *
+     * @return a map with uri and number of usage of the endpoint.
+     */
     Map<String, Long> getStatistics();
 
+    /**
+     * Clears all information.
+     */
     void clear();
 
 }

Reply via email to