You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@camel.apache.org by ni...@apache.org on 2011/12/22 03:38:41 UTC
svn commit: r1222008 - in
/camel/trunk/camel-core/src/main/java/org/apache/camel/api/management: ./
mbean/
Author: ningjiang
Date: Thu Dec 22 02:38:40 2011
New Revision: 1222008
URL: http://svn.apache.org/viewvc?rev=1222008&view=rev
Log:
CAMEL-4808 applied the patch of camel management Javadoc with thanks to Glen
Modified:
camel/trunk/camel-core/src/main/java/org/apache/camel/api/management/PerformanceCounter.java
camel/trunk/camel-core/src/main/java/org/apache/camel/api/management/mbean/ManagedCamelContextMBean.java
camel/trunk/camel-core/src/main/java/org/apache/camel/api/management/mbean/ManagedComponentMBean.java
camel/trunk/camel-core/src/main/java/org/apache/camel/api/management/mbean/ManagedConsumerMBean.java
camel/trunk/camel-core/src/main/java/org/apache/camel/api/management/mbean/ManagedEndpointMBean.java
camel/trunk/camel-core/src/main/java/org/apache/camel/api/management/mbean/ManagedErrorHandlerMBean.java
camel/trunk/camel-core/src/main/java/org/apache/camel/api/management/mbean/ManagedProcessorMBean.java
camel/trunk/camel-core/src/main/java/org/apache/camel/api/management/mbean/ManagedProducerMBean.java
camel/trunk/camel-core/src/main/java/org/apache/camel/api/management/mbean/ManagedRouteMBean.java
camel/trunk/camel-core/src/main/java/org/apache/camel/api/management/mbean/ManagedSendProcessorMBean.java
camel/trunk/camel-core/src/main/java/org/apache/camel/api/management/mbean/ManagedServiceMBean.java
camel/trunk/camel-core/src/main/java/org/apache/camel/api/management/mbean/ManagedThreadPoolMBean.java
camel/trunk/camel-core/src/main/java/org/apache/camel/api/management/mbean/ManagedTracerMBean.java
camel/trunk/camel-core/src/main/java/org/apache/camel/api/management/package.html
Modified: camel/trunk/camel-core/src/main/java/org/apache/camel/api/management/PerformanceCounter.java
URL: http://svn.apache.org/viewvc/camel/trunk/camel-core/src/main/java/org/apache/camel/api/management/PerformanceCounter.java?rev=1222008&r1=1222007&r2=1222008&view=diff
==============================================================================
--- camel/trunk/camel-core/src/main/java/org/apache/camel/api/management/PerformanceCounter.java (original)
+++ camel/trunk/camel-core/src/main/java/org/apache/camel/api/management/PerformanceCounter.java Thu Dec 22 02:38:40 2011
@@ -19,7 +19,7 @@ package org.apache.camel.api.management;
import org.apache.camel.Exchange;
/**
- * A counter that gathers performance metrics when {@link org.apache.camel.Exchange} are routed in Camel.
+ * A counter that gathers performance metrics when an {@link org.apache.camel.Exchange} is routed in Camel.
*
* @version
*/
@@ -29,7 +29,7 @@ public interface PerformanceCounter {
* Executed when an {@link org.apache.camel.Exchange} is complete.
*
* @param exchange the exchange
- * @param time the time it took in millis to complete it
+ * @param time the time it took in millis to complete
*/
void completedExchange(Exchange exchange, long time);
@@ -41,20 +41,20 @@ public interface PerformanceCounter {
void failedExchange(Exchange exchange);
/**
- * Is statistics enabled.
+ * Are statistics enabled?
* <p/>
* They can be enabled and disabled at runtime
*
- * @return whether statistics is enabled or not
+ * @return whether statistics are enabled or not
*/
boolean isStatisticsEnabled();
/**
- * Sets whether statistics is enabled.
+ * Sets whether statistics are enabled.
* <p/>
* They can be enabled and disabled at runtime
*
- * @param statisticsEnabled whether statistics is enabled or not
+ * @param statisticsEnabled whether statistics are enabled or not
*/
void setStatisticsEnabled(boolean statisticsEnabled);
Modified: camel/trunk/camel-core/src/main/java/org/apache/camel/api/management/mbean/ManagedCamelContextMBean.java
URL: http://svn.apache.org/viewvc/camel/trunk/camel-core/src/main/java/org/apache/camel/api/management/mbean/ManagedCamelContextMBean.java?rev=1222008&r1=1222007&r2=1222008&view=diff
==============================================================================
--- camel/trunk/camel-core/src/main/java/org/apache/camel/api/management/mbean/ManagedCamelContextMBean.java (original)
+++ camel/trunk/camel-core/src/main/java/org/apache/camel/api/management/mbean/ManagedCamelContextMBean.java Thu Dec 22 02:38:40 2011
@@ -24,7 +24,7 @@ import org.apache.camel.api.management.M
public interface ManagedCamelContextMBean {
- @ManagedAttribute(description = "Camel id")
+ @ManagedAttribute(description = "Camel ID")
String getCamelId();
@ManagedAttribute(description = "Camel Version")
@@ -118,7 +118,7 @@ public interface ManagedCamelContextMBea
* @return <tt>true</tt> if a new endpoint was created, <tt>false</tt> if the endpoint already existed
* @throws Exception is thrown if error occurred
*/
- @ManagedOperation(description = "Creates the endpoint by the given uri")
+ @ManagedOperation(description = "Creates the endpoint by the given URI")
boolean createEndpoint(String uri) throws Exception;
/**
Modified: camel/trunk/camel-core/src/main/java/org/apache/camel/api/management/mbean/ManagedComponentMBean.java
URL: http://svn.apache.org/viewvc/camel/trunk/camel-core/src/main/java/org/apache/camel/api/management/mbean/ManagedComponentMBean.java?rev=1222008&r1=1222007&r2=1222008&view=diff
==============================================================================
--- camel/trunk/camel-core/src/main/java/org/apache/camel/api/management/mbean/ManagedComponentMBean.java (original)
+++ camel/trunk/camel-core/src/main/java/org/apache/camel/api/management/mbean/ManagedComponentMBean.java Thu Dec 22 02:38:40 2011
@@ -26,7 +26,7 @@ public interface ManagedComponentMBean {
@ManagedAttribute(description = "Component State")
String getState();
- @ManagedAttribute(description = "Camel id")
+ @ManagedAttribute(description = "Camel ID")
String getCamelId();
}
\ No newline at end of file
Modified: camel/trunk/camel-core/src/main/java/org/apache/camel/api/management/mbean/ManagedConsumerMBean.java
URL: http://svn.apache.org/viewvc/camel/trunk/camel-core/src/main/java/org/apache/camel/api/management/mbean/ManagedConsumerMBean.java?rev=1222008&r1=1222007&r2=1222008&view=diff
==============================================================================
--- camel/trunk/camel-core/src/main/java/org/apache/camel/api/management/mbean/ManagedConsumerMBean.java (original)
+++ camel/trunk/camel-core/src/main/java/org/apache/camel/api/management/mbean/ManagedConsumerMBean.java Thu Dec 22 02:38:40 2011
@@ -20,7 +20,7 @@ import org.apache.camel.api.management.M
public interface ManagedConsumerMBean extends ManagedServiceMBean {
- @ManagedAttribute(description = "Endpoint Uri")
+ @ManagedAttribute(description = "Endpoint URI")
String getEndpointUri();
@ManagedAttribute(description = "Current number of inflight Exchanges")
Modified: camel/trunk/camel-core/src/main/java/org/apache/camel/api/management/mbean/ManagedEndpointMBean.java
URL: http://svn.apache.org/viewvc/camel/trunk/camel-core/src/main/java/org/apache/camel/api/management/mbean/ManagedEndpointMBean.java?rev=1222008&r1=1222007&r2=1222008&view=diff
==============================================================================
--- camel/trunk/camel-core/src/main/java/org/apache/camel/api/management/mbean/ManagedEndpointMBean.java (original)
+++ camel/trunk/camel-core/src/main/java/org/apache/camel/api/management/mbean/ManagedEndpointMBean.java Thu Dec 22 02:38:40 2011
@@ -20,10 +20,10 @@ import org.apache.camel.api.management.M
public interface ManagedEndpointMBean {
- @ManagedAttribute(description = "Camel id")
+ @ManagedAttribute(description = "Camel ID")
String getCamelId();
- @ManagedAttribute(description = "Endpoint Uri")
+ @ManagedAttribute(description = "Endpoint URI")
String getEndpointUri();
@ManagedAttribute(description = "Singleton")
Modified: camel/trunk/camel-core/src/main/java/org/apache/camel/api/management/mbean/ManagedErrorHandlerMBean.java
URL: http://svn.apache.org/viewvc/camel/trunk/camel-core/src/main/java/org/apache/camel/api/management/mbean/ManagedErrorHandlerMBean.java?rev=1222008&r1=1222007&r2=1222008&view=diff
==============================================================================
--- camel/trunk/camel-core/src/main/java/org/apache/camel/api/management/mbean/ManagedErrorHandlerMBean.java (original)
+++ camel/trunk/camel-core/src/main/java/org/apache/camel/api/management/mbean/ManagedErrorHandlerMBean.java Thu Dec 22 02:38:40 2011
@@ -20,7 +20,7 @@ import org.apache.camel.api.management.M
public interface ManagedErrorHandlerMBean {
- @ManagedAttribute(description = "Camel id")
+ @ManagedAttribute(description = "Camel ID")
String getCamelId();
@ManagedAttribute(description = "Does the error handler support redelivery")
Modified: camel/trunk/camel-core/src/main/java/org/apache/camel/api/management/mbean/ManagedProcessorMBean.java
URL: http://svn.apache.org/viewvc/camel/trunk/camel-core/src/main/java/org/apache/camel/api/management/mbean/ManagedProcessorMBean.java?rev=1222008&r1=1222007&r2=1222008&view=diff
==============================================================================
--- camel/trunk/camel-core/src/main/java/org/apache/camel/api/management/mbean/ManagedProcessorMBean.java (original)
+++ camel/trunk/camel-core/src/main/java/org/apache/camel/api/management/mbean/ManagedProcessorMBean.java Thu Dec 22 02:38:40 2011
@@ -24,13 +24,13 @@ public interface ManagedProcessorMBean e
@ManagedAttribute(description = "Processor State")
String getState();
- @ManagedAttribute(description = "Camel id")
+ @ManagedAttribute(description = "Camel ID")
String getCamelId();
- @ManagedAttribute(description = "Route id")
+ @ManagedAttribute(description = "Route ID")
String getRouteId();
- @ManagedAttribute(description = "Processor id")
+ @ManagedAttribute(description = "Processor ID")
String getProcessorId();
@ManagedOperation(description = "Start Processor")
Modified: camel/trunk/camel-core/src/main/java/org/apache/camel/api/management/mbean/ManagedProducerMBean.java
URL: http://svn.apache.org/viewvc/camel/trunk/camel-core/src/main/java/org/apache/camel/api/management/mbean/ManagedProducerMBean.java?rev=1222008&r1=1222007&r2=1222008&view=diff
==============================================================================
--- camel/trunk/camel-core/src/main/java/org/apache/camel/api/management/mbean/ManagedProducerMBean.java (original)
+++ camel/trunk/camel-core/src/main/java/org/apache/camel/api/management/mbean/ManagedProducerMBean.java Thu Dec 22 02:38:40 2011
@@ -20,7 +20,7 @@ import org.apache.camel.api.management.M
public interface ManagedProducerMBean extends ManagedServiceMBean {
- @ManagedAttribute(description = "Endpoint Uri")
+ @ManagedAttribute(description = "Endpoint URI")
String getEndpointUri();
@ManagedAttribute(description = "Singleton")
Modified: camel/trunk/camel-core/src/main/java/org/apache/camel/api/management/mbean/ManagedRouteMBean.java
URL: http://svn.apache.org/viewvc/camel/trunk/camel-core/src/main/java/org/apache/camel/api/management/mbean/ManagedRouteMBean.java?rev=1222008&r1=1222007&r2=1222008&view=diff
==============================================================================
--- camel/trunk/camel-core/src/main/java/org/apache/camel/api/management/mbean/ManagedRouteMBean.java (original)
+++ camel/trunk/camel-core/src/main/java/org/apache/camel/api/management/mbean/ManagedRouteMBean.java Thu Dec 22 02:38:40 2011
@@ -21,13 +21,13 @@ import org.apache.camel.api.management.M
public interface ManagedRouteMBean extends ManagedPerformanceCounterMBean {
- @ManagedAttribute(description = "Route id")
+ @ManagedAttribute(description = "Route ID")
String getRouteId();
@ManagedAttribute(description = "Route Description")
String getDescription();
- @ManagedAttribute(description = "Route Endpoint Uri")
+ @ManagedAttribute(description = "Route Endpoint URI")
String getEndpointUri();
@ManagedAttribute(description = "Route State")
@@ -36,7 +36,7 @@ public interface ManagedRouteMBean exten
@ManagedAttribute(description = "Current number of inflight Exchanges")
Integer getInflightExchanges();
- @ManagedAttribute(description = "Camel id")
+ @ManagedAttribute(description = "Camel ID")
String getCamelId();
@ManagedAttribute(description = "Tracing")
Modified: camel/trunk/camel-core/src/main/java/org/apache/camel/api/management/mbean/ManagedSendProcessorMBean.java
URL: http://svn.apache.org/viewvc/camel/trunk/camel-core/src/main/java/org/apache/camel/api/management/mbean/ManagedSendProcessorMBean.java?rev=1222008&r1=1222007&r2=1222008&view=diff
==============================================================================
--- camel/trunk/camel-core/src/main/java/org/apache/camel/api/management/mbean/ManagedSendProcessorMBean.java (original)
+++ camel/trunk/camel-core/src/main/java/org/apache/camel/api/management/mbean/ManagedSendProcessorMBean.java Thu Dec 22 02:38:40 2011
@@ -20,10 +20,10 @@ import org.apache.camel.api.management.M
public interface ManagedSendProcessorMBean extends ManagedProcessorMBean {
- @ManagedAttribute(description = "Destination as Endpoint Uri")
+ @ManagedAttribute(description = "Destination as Endpoint URI")
String getDestination();
- @ManagedAttribute(description = "Destination as Endpoint Uri")
+ @ManagedAttribute(description = "Destination as Endpoint URI")
void setDestination(String uri);
@ManagedAttribute(description = "Message Exchange Pattern")
Modified: camel/trunk/camel-core/src/main/java/org/apache/camel/api/management/mbean/ManagedServiceMBean.java
URL: http://svn.apache.org/viewvc/camel/trunk/camel-core/src/main/java/org/apache/camel/api/management/mbean/ManagedServiceMBean.java?rev=1222008&r1=1222007&r2=1222008&view=diff
==============================================================================
--- camel/trunk/camel-core/src/main/java/org/apache/camel/api/management/mbean/ManagedServiceMBean.java (original)
+++ camel/trunk/camel-core/src/main/java/org/apache/camel/api/management/mbean/ManagedServiceMBean.java Thu Dec 22 02:38:40 2011
@@ -24,10 +24,10 @@ public interface ManagedServiceMBean {
@ManagedAttribute(description = "Service State")
String getState();
- @ManagedAttribute(description = "Camel id")
+ @ManagedAttribute(description = "Camel ID")
String getCamelId();
- @ManagedAttribute(description = "Route id")
+ @ManagedAttribute(description = "Route ID")
String getRouteId();
@ManagedOperation(description = "Start Service")
Modified: camel/trunk/camel-core/src/main/java/org/apache/camel/api/management/mbean/ManagedThreadPoolMBean.java
URL: http://svn.apache.org/viewvc/camel/trunk/camel-core/src/main/java/org/apache/camel/api/management/mbean/ManagedThreadPoolMBean.java?rev=1222008&r1=1222007&r2=1222008&view=diff
==============================================================================
--- camel/trunk/camel-core/src/main/java/org/apache/camel/api/management/mbean/ManagedThreadPoolMBean.java (original)
+++ camel/trunk/camel-core/src/main/java/org/apache/camel/api/management/mbean/ManagedThreadPoolMBean.java Thu Dec 22 02:38:40 2011
@@ -21,16 +21,16 @@ import org.apache.camel.api.management.M
public interface ManagedThreadPoolMBean {
- @ManagedAttribute(description = "Thread Pool id")
+ @ManagedAttribute(description = "Thread Pool ID")
String getId();
- @ManagedAttribute(description = "Id of source for creating Thread Pool")
+ @ManagedAttribute(description = "ID of source for creating Thread Pool")
String getSourceId();
- @ManagedAttribute(description = "Route id for the source, which created the Thread Pool")
+ @ManagedAttribute(description = "Route ID for the source, which created the Thread Pool")
String getRouteId();
- @ManagedAttribute(description = "Id of the thread pool profile which this pool is based upon")
+ @ManagedAttribute(description = "ID of the thread pool profile which this pool is based upon")
String getThreadPoolProfileId();
@ManagedAttribute(description = "Core pool size")
Modified: camel/trunk/camel-core/src/main/java/org/apache/camel/api/management/mbean/ManagedTracerMBean.java
URL: http://svn.apache.org/viewvc/camel/trunk/camel-core/src/main/java/org/apache/camel/api/management/mbean/ManagedTracerMBean.java?rev=1222008&r1=1222007&r2=1222008&view=diff
==============================================================================
--- camel/trunk/camel-core/src/main/java/org/apache/camel/api/management/mbean/ManagedTracerMBean.java (original)
+++ camel/trunk/camel-core/src/main/java/org/apache/camel/api/management/mbean/ManagedTracerMBean.java Thu Dec 22 02:38:40 2011
@@ -26,16 +26,16 @@ public interface ManagedTracerMBean {
@ManagedAttribute(description = "Tracer enabled")
void setEnabled(boolean enabled);
- @ManagedAttribute(description = "Additional destination Uri")
+ @ManagedAttribute(description = "Additional destination URI")
String getDestinationUri();
- @ManagedAttribute(description = "Additional destination Uri")
+ @ManagedAttribute(description = "Additional destination URI")
void setDestinationUri(String uri);
@ManagedAttribute(description = "Logging Name")
String getLogName();
- @ManagedAttribute(description = "Using Jpa")
+ @ManagedAttribute(description = "Using JPA")
boolean getUseJpa();
@ManagedAttribute(description = "Logging Name")
@@ -101,10 +101,10 @@ public interface ManagedTracerMBean {
@ManagedAttribute(description = "Formatter show breadcrumb")
void setFormatterShowBreadCrumb(boolean showBreadCrumb);
- @ManagedAttribute(description = "Formatter show exchange id")
+ @ManagedAttribute(description = "Formatter show exchange ID")
boolean getFormatterShowExchangeId();
- @ManagedAttribute(description = "Formatter show exchange id")
+ @ManagedAttribute(description = "Formatter show exchange ID")
void setFormatterShowExchangeId(boolean showExchangeId);
@ManagedAttribute(description = "Formatter show headers")
@@ -143,10 +143,10 @@ public interface ManagedTracerMBean {
@ManagedAttribute(description = "Formatter show exception")
void setFormatterShowException(boolean showException);
- @ManagedAttribute(description = "Formatter show route id")
+ @ManagedAttribute(description = "Formatter show route ID")
boolean getFormatterShowRouteId();
- @ManagedAttribute(description = "Formatter show route id")
+ @ManagedAttribute(description = "Formatter show route ID")
void setFormatterShowRouteId(boolean showRouteId);
@ManagedAttribute(description = "Formatter breadcrumb length")
@@ -155,10 +155,10 @@ public interface ManagedTracerMBean {
@ManagedAttribute(description = "Formatter breadcrumb length")
void setFormatterBreadCrumbLength(int breadCrumbLength);
- @ManagedAttribute(description = "Formatter show short exchange id")
+ @ManagedAttribute(description = "Formatter show short exchange ID")
boolean getFormatterShowShortExchangeId();
- @ManagedAttribute(description = "Formatter show short exchange id")
+ @ManagedAttribute(description = "Formatter show short exchange ID")
void setFormatterShowShortExchangeId(boolean showShortExchangeId);
@ManagedAttribute(description = "Formatter node length")
@@ -173,10 +173,10 @@ public interface ManagedTracerMBean {
@ManagedAttribute(description = "Formatter max chars")
void setFormatterMaxChars(int maxChars);
- @ManagedAttribute(description = "Should trace events be sent as jmx notifications")
+ @ManagedAttribute(description = "Should trace events be sent as JMX notifications")
boolean isJmxTraceNotifications();
- @ManagedAttribute(description = "Should trace events be sent as jmx notifications")
+ @ManagedAttribute(description = "Should trace events be sent as JMX notifications")
void setJmxTraceNotifications(boolean jmxTraceNotifications);
@ManagedAttribute(description = "Maximum size of a message body for trace notification")
Modified: camel/trunk/camel-core/src/main/java/org/apache/camel/api/management/package.html
URL: http://svn.apache.org/viewvc/camel/trunk/camel-core/src/main/java/org/apache/camel/api/management/package.html?rev=1222008&r1=1222007&r2=1222008&view=diff
==============================================================================
--- camel/trunk/camel-core/src/main/java/org/apache/camel/api/management/package.html (original)
+++ camel/trunk/camel-core/src/main/java/org/apache/camel/api/management/package.html Thu Dec 22 02:38:40 2011
@@ -19,7 +19,8 @@
</head>
<body>
-Service provider interfaces for management. These help making components management aware or to implement own management strategies
+Service provider interfaces for management. These help make components management-aware and
+also allow components to implement their own management strategies.
</body>
</html>