You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@synapse.apache.org by ru...@apache.org on 2010/08/22 14:53:27 UTC

svn commit: r987892 - in /synapse/trunk/java/modules/commons/src/main/java/org/apache/synapse/commons: executors/ jmx/ util/

Author: ruwan
Date: Sun Aug 22 12:53:26 2010
New Revision: 987892

URL: http://svn.apache.org/viewvc?rev=987892&view=rev
Log:
fixing some typos and re-formatting

Modified:
    synapse/trunk/java/modules/commons/src/main/java/org/apache/synapse/commons/executors/Importance.java
    synapse/trunk/java/modules/commons/src/main/java/org/apache/synapse/commons/executors/InternalQueue.java
    synapse/trunk/java/modules/commons/src/main/java/org/apache/synapse/commons/executors/PRRNextQueueAlgorithm.java
    synapse/trunk/java/modules/commons/src/main/java/org/apache/synapse/commons/executors/PriorityExecutor.java
    synapse/trunk/java/modules/commons/src/main/java/org/apache/synapse/commons/jmx/JmxInformation.java
    synapse/trunk/java/modules/commons/src/main/java/org/apache/synapse/commons/jmx/JmxInformationFactory.java
    synapse/trunk/java/modules/commons/src/main/java/org/apache/synapse/commons/jmx/MBeanRegistrar.java
    synapse/trunk/java/modules/commons/src/main/java/org/apache/synapse/commons/jmx/ThreadingView.java
    synapse/trunk/java/modules/commons/src/main/java/org/apache/synapse/commons/jmx/ThreadingViewMBean.java
    synapse/trunk/java/modules/commons/src/main/java/org/apache/synapse/commons/util/MiscellaneousUtil.java

Modified: synapse/trunk/java/modules/commons/src/main/java/org/apache/synapse/commons/executors/Importance.java
URL: http://svn.apache.org/viewvc/synapse/trunk/java/modules/commons/src/main/java/org/apache/synapse/commons/executors/Importance.java?rev=987892&r1=987891&r2=987892&view=diff
==============================================================================
--- synapse/trunk/java/modules/commons/src/main/java/org/apache/synapse/commons/executors/Importance.java (original)
+++ synapse/trunk/java/modules/commons/src/main/java/org/apache/synapse/commons/executors/Importance.java Sun Aug 22 12:53:26 2010
@@ -23,6 +23,7 @@ package org.apache.synapse.commons.execu
  * This class determines the priority of a Worker. It can also hold some properties
  * for assisting the queue selecting algorithms.
  */
+@SuppressWarnings({"UnusedDeclaration"})
 public interface Importance {
     /**
      * Get the priority

Modified: synapse/trunk/java/modules/commons/src/main/java/org/apache/synapse/commons/executors/InternalQueue.java
URL: http://svn.apache.org/viewvc/synapse/trunk/java/modules/commons/src/main/java/org/apache/synapse/commons/executors/InternalQueue.java?rev=987892&r1=987891&r2=987892&view=diff
==============================================================================
--- synapse/trunk/java/modules/commons/src/main/java/org/apache/synapse/commons/executors/InternalQueue.java (original)
+++ synapse/trunk/java/modules/commons/src/main/java/org/apache/synapse/commons/executors/InternalQueue.java Sun Aug 22 12:53:26 2010
@@ -27,6 +27,7 @@ import java.util.concurrent.locks.Condit
  * Interface implemented by the internal queues.
  * @param <E>
  */
+@SuppressWarnings({"UnusedDeclaration"})
 public interface InternalQueue<E> extends Queue<E> {
     /**
      * Get the Priority of the queue

Modified: synapse/trunk/java/modules/commons/src/main/java/org/apache/synapse/commons/executors/PRRNextQueueAlgorithm.java
URL: http://svn.apache.org/viewvc/synapse/trunk/java/modules/commons/src/main/java/org/apache/synapse/commons/executors/PRRNextQueueAlgorithm.java?rev=987892&r1=987891&r2=987892&view=diff
==============================================================================
--- synapse/trunk/java/modules/commons/src/main/java/org/apache/synapse/commons/executors/PRRNextQueueAlgorithm.java (original)
+++ synapse/trunk/java/modules/commons/src/main/java/org/apache/synapse/commons/executors/PRRNextQueueAlgorithm.java Sun Aug 22 12:53:26 2010
@@ -40,7 +40,7 @@ public class PRRNextQueueAlgorithm<E> im
     /** Reference to the actual queue */
     private List<InternalQueue<E>> queues;
 
-    /** Number of queues, we keep this to avoid the overhead of calculatin this again and again */
+    /** Number of queues, we keep this to avoid the overhead of calculation this again and again */
     private int size = 0;
 
     /** Current queue we are operating on */

Modified: synapse/trunk/java/modules/commons/src/main/java/org/apache/synapse/commons/executors/PriorityExecutor.java
URL: http://svn.apache.org/viewvc/synapse/trunk/java/modules/commons/src/main/java/org/apache/synapse/commons/executors/PriorityExecutor.java?rev=987892&r1=987891&r2=987892&view=diff
==============================================================================
--- synapse/trunk/java/modules/commons/src/main/java/org/apache/synapse/commons/executors/PriorityExecutor.java (original)
+++ synapse/trunk/java/modules/commons/src/main/java/org/apache/synapse/commons/executors/PriorityExecutor.java Sun Aug 22 12:53:26 2010
@@ -57,7 +57,7 @@ public class PriorityExecutor {
      * it will be captured and logged to prevent the threads from dying. 
      *
      * @param task task to be executed
-     * @param priority priority of the tast
+     * @param priority priority of the task
      */
     public void execute(final Runnable task, int priority) {
         // create a dummy worker to execute the task
@@ -239,7 +239,7 @@ public class PriorityExecutor {
     }
 
     /**
-     * Private class for executing the tasks submited. This class is used for
+     * Private class for executing the tasks submitted. This class is used for
      * prevent the threads from dying in case of unhandled exceptions. Also
      * this class implements the Importance for carrying the priority.     
      */

Modified: synapse/trunk/java/modules/commons/src/main/java/org/apache/synapse/commons/jmx/JmxInformation.java
URL: http://svn.apache.org/viewvc/synapse/trunk/java/modules/commons/src/main/java/org/apache/synapse/commons/jmx/JmxInformation.java?rev=987892&r1=987891&r2=987892&view=diff
==============================================================================
--- synapse/trunk/java/modules/commons/src/main/java/org/apache/synapse/commons/jmx/JmxInformation.java (original)
+++ synapse/trunk/java/modules/commons/src/main/java/org/apache/synapse/commons/jmx/JmxInformation.java Sun Aug 22 12:53:26 2010
@@ -117,8 +117,6 @@ public class JmxInformation {
     
     /**
      * Builds the JMX URL depending on the existence of RMI port.
-     *
-     * @return  the JMX URL to connect the server to
      */
     public void updateJMXUrl() {
         StringBuilder sb = new StringBuilder();

Modified: synapse/trunk/java/modules/commons/src/main/java/org/apache/synapse/commons/jmx/JmxInformationFactory.java
URL: http://svn.apache.org/viewvc/synapse/trunk/java/modules/commons/src/main/java/org/apache/synapse/commons/jmx/JmxInformationFactory.java?rev=987892&r1=987891&r2=987892&view=diff
==============================================================================
--- synapse/trunk/java/modules/commons/src/main/java/org/apache/synapse/commons/jmx/JmxInformationFactory.java (original)
+++ synapse/trunk/java/modules/commons/src/main/java/org/apache/synapse/commons/jmx/JmxInformationFactory.java Sun Aug 22 12:53:26 2010
@@ -22,7 +22,6 @@ package org.apache.synapse.commons.jmx;
 import org.apache.commons.logging.Log;
 import org.apache.commons.logging.LogFactory;
 import org.apache.synapse.commons.util.MiscellaneousUtil;
-import org.apache.synapse.commons.SynapseCommonsException;
 import org.apache.synapse.securevault.secret.SecretInformation;
 import org.apache.synapse.securevault.secret.SecretInformationFactory;
 
@@ -46,6 +45,7 @@ public class JmxInformationFactory {
      * Factory method to create a JmxInformation instance based on given properties
      *
      * @param properties Properties to create and configure DataSource
+     * @param defaultHostName the default host name tobe used in case of a the host name is not set
      * @return DataSourceInformation instance
      */
     public static JmxInformation createJmxInformation(Properties properties, String defaultHostName) {
@@ -160,6 +160,7 @@ public class JmxInformationFactory {
      * not present by looking for a management property specified in a file specified via<code>
      * com.sun.management.config.file</code> system property.
      *
+     * @param managementProperties properties tobe looked up if the system property is not set
      * @param   name  the name of the property to look up
      *
      * @return  the config property value or null if the property is not configured
@@ -172,13 +173,4 @@ public class JmxInformationFactory {
         return result;
     }
 
-    /**
-     * Helper methods for handle errors.
-     *
-     * @param msg The error message
-     */
-    private static void handleException(String msg) {
-        log.error(msg);
-        throw new SynapseCommonsException(msg);
-    }
 }

Modified: synapse/trunk/java/modules/commons/src/main/java/org/apache/synapse/commons/jmx/MBeanRegistrar.java
URL: http://svn.apache.org/viewvc/synapse/trunk/java/modules/commons/src/main/java/org/apache/synapse/commons/jmx/MBeanRegistrar.java?rev=987892&r1=987891&r2=987892&view=diff
==============================================================================
--- synapse/trunk/java/modules/commons/src/main/java/org/apache/synapse/commons/jmx/MBeanRegistrar.java (original)
+++ synapse/trunk/java/modules/commons/src/main/java/org/apache/synapse/commons/jmx/MBeanRegistrar.java Sun Aug 22 12:53:26 2010
@@ -40,19 +40,19 @@ public class MBeanRegistrar {
     private MBeanRegistrar() {
     }
 
-    public void registerMBean(Object mbeanInstance, String category, String id) {
-        assertNull(mbeanInstance, "Mbean instance is null");
-        assertNull(category, "Mbean instance category is null");
-        assertNull(id, "Mbean instance name is null");
+    public void registerMBean(Object mBeanInstance, String category, String id) {
+        assertNull(mBeanInstance, "MBean instance is null");
+        assertNull(category, "MBean instance category is null");
+        assertNull(id, "MBean instance name is null");
         try {
             MBeanServer mbs = ManagementFactory.getPlatformMBeanServer();
             ObjectName name = new ObjectName(getObjectName(category, id));
             Set set = mbs.queryNames(name, null);
             if (set != null && set.isEmpty()) {
-                mbs.registerMBean(mbeanInstance, name);
+                mbs.registerMBean(mBeanInstance, name);
             } else {
                 mbs.unregisterMBean(name);
-                mbs.registerMBean(mbeanInstance, name);
+                mbs.registerMBean(mBeanInstance, name);
             }
         } catch (Exception e) {
             log.warn("Error registering a MBean with name ' " + id +

Modified: synapse/trunk/java/modules/commons/src/main/java/org/apache/synapse/commons/jmx/ThreadingView.java
URL: http://svn.apache.org/viewvc/synapse/trunk/java/modules/commons/src/main/java/org/apache/synapse/commons/jmx/ThreadingView.java?rev=987892&r1=987891&r2=987892&view=diff
==============================================================================
--- synapse/trunk/java/modules/commons/src/main/java/org/apache/synapse/commons/jmx/ThreadingView.java (original)
+++ synapse/trunk/java/modules/commons/src/main/java/org/apache/synapse/commons/jmx/ThreadingView.java Sun Aug 22 12:53:26 2010
@@ -33,11 +33,11 @@ import java.lang.management.ThreadInfo;
 /**
  * ThreadingView can be used to monitor a named thread group over JMX. Data
  * gathered by this monitor can be classified as short term data and long term data.
- * Short term data is the statitics related to last 15 minutes of execution and they
+ * Short term data is the statistics related to last 15 minutes of execution and they
  * get updated every 2 seconds. Long term data is related to last 24 hours of execution
  * and they get updated every 5 minutes. This monitor can also be configured to log a
  * summary of the thread states periodically. If needed a margin can be set for the blocked
- * thread percentage, upon exeeding which a system alert will be logged as a warning. By
+ * thread percentage, upon exceeding which a system alert will be logged as a warning. By
  * default both periodic logs and alerts are turned off.
  */
 public class ThreadingView implements ThreadingViewMBean {
@@ -99,7 +99,7 @@ public class ThreadingView implements Th
 
     public void destroy() {
         if (log.isDebugEnabled()) {
-            log.debug("Unregistering the Synapse threading view for the thread group: " +
+            log.debug("Un-registering the Synapse threading view for the thread group: " +
                     threadNamePrefix);
         }
         MBeanRegistrar.getInstance().unRegisterMBean(SYNAPSE_THREADING_VIEW, threadNamePrefix);
@@ -223,8 +223,8 @@ public class ThreadingView implements Th
             return true;
         } else if (state.equals(Thread.State.WAITING) ||
                 state.equals(Thread.State.TIMED_WAITING)) {
-            StackTraceElement[] stacktrace = threadInfo.getStackTrace();
-            if (stacktrace.length > 0 && !"park".equals(stacktrace[0].getMethodName())) {
+            StackTraceElement[] stackTrace = threadInfo.getStackTrace();
+            if (stackTrace.length > 0 && !"park".equals(stackTrace[0].getMethodName())) {
                 return true;
             }
         }
@@ -233,7 +233,7 @@ public class ThreadingView implements Th
     }
 
     /**
-     * Get a sumarry of all threads running in the JVM.
+     * Get a summary of all threads running in the JVM.
      *
      * @return an array of ThreadInfo objects
      */
@@ -245,7 +245,7 @@ public class ThreadingView implements Th
     }
 
     /**
-     * Calculates and returns the average bloked worker percentage during last 'n' munites
+     * Calculates and returns the average blocked worker percentage during last 'n' minutes
      * of execution
      *
      * @param n Number of minutes in the execution history
@@ -257,11 +257,11 @@ public class ThreadingView implements Th
         Double[] array = shortTermDataQueue.toArray(new Double[shortTermDataQueue.size()]);
 
         if (samples > array.length) {
-            // If we don't have anough samples in the queue, try to approximate
+            // If we don't have enough samples in the queue, try to approximate
             // the value using all the available samples
             samples = array.length;
-            for (int i = 0; i < array.length; i++) {
-                sum += array[i];
+            for (Double anArray : array) {
+                sum += anArray;
             }
         } else {
             for (int i = 0; i < samples; i++) {
@@ -276,7 +276,7 @@ public class ThreadingView implements Th
     }
 
     /**
-     * Calculates and returns the average bloked worker percentage during last 'n' hours
+     * Calculates and returns the average blocked worker percentage during last 'n' hours
      * of execution
      *
      * @param n Number of hours in the execution history
@@ -289,8 +289,8 @@ public class ThreadingView implements Th
 
         if (samples > array.length) {
             samples = array.length;
-            for (int i = 0; i < array.length; i++) {
-                sum += array[i];
+            for (Double anArray : array) {
+                sum += anArray;
             }
         } else {
             for (int i = 0; i < samples; i++) {

Modified: synapse/trunk/java/modules/commons/src/main/java/org/apache/synapse/commons/jmx/ThreadingViewMBean.java
URL: http://svn.apache.org/viewvc/synapse/trunk/java/modules/commons/src/main/java/org/apache/synapse/commons/jmx/ThreadingViewMBean.java?rev=987892&r1=987891&r2=987892&view=diff
==============================================================================
--- synapse/trunk/java/modules/commons/src/main/java/org/apache/synapse/commons/jmx/ThreadingViewMBean.java (original)
+++ synapse/trunk/java/modules/commons/src/main/java/org/apache/synapse/commons/jmx/ThreadingViewMBean.java Sun Aug 22 12:53:26 2010
@@ -21,6 +21,7 @@ package org.apache.synapse.commons.jmx;
 
 import java.util.Date;
 
+@SuppressWarnings({"UnusedDeclaration"})
 public interface ThreadingViewMBean {
 
     public int getTotalWorkerCount();

Modified: synapse/trunk/java/modules/commons/src/main/java/org/apache/synapse/commons/util/MiscellaneousUtil.java
URL: http://svn.apache.org/viewvc/synapse/trunk/java/modules/commons/src/main/java/org/apache/synapse/commons/util/MiscellaneousUtil.java?rev=987892&r1=987891&r2=987892&view=diff
==============================================================================
--- synapse/trunk/java/modules/commons/src/main/java/org/apache/synapse/commons/util/MiscellaneousUtil.java (original)
+++ synapse/trunk/java/modules/commons/src/main/java/org/apache/synapse/commons/util/MiscellaneousUtil.java Sun Aug 22 12:53:26 2010
@@ -183,6 +183,7 @@ public class MiscellaneousUtil {
         return result;
     }
 
+    @SuppressWarnings({"UnusedDeclaration"})
     public static byte[] asBytes(InputStream in) {
 
         ByteArrayOutputStream out = new ByteArrayOutputStream();
@@ -192,8 +193,8 @@ public class MiscellaneousUtil {
             while ((len = in.read(buffer)) >= 0)
                 out.write(buffer, 0, len);
         } catch (IOException e) {
-            throw new SynapseCommonsException("Error during converting a inputstream " +
-                    "into a bytearray ", e, log);
+            throw new SynapseCommonsException("Error during converting a input stream " +
+                    "into a byte array ", e, log);
         } finally {
             if (in != null) {
                 try {