From 06e27d30ff2823468707309b24a230d9175714d4 Mon Sep 17 00:00:00 2001
From: Nick Couchman <vnick@apache.org>
Date: Tue, 6 Jun 2017 08:39:02 -0400
Subject: [PATCH] GUACAMOLE-102: Improve commentary around connection weight
 methods and variables.

---
 .../auth/jdbc/connection/ConnectionModel.java     | 15 +++++++++------
 .../auth/jdbc/connection/ModeledConnection.java   | 10 ++++++----
 2 files changed, 15 insertions(+), 10 deletions(-)

diff --git a/extensions/guacamole-auth-jdbc/modules/guacamole-auth-jdbc-base/src/main/java/org/apache/guacamole/auth/jdbc/connection/ConnectionModel.java b/extensions/guacamole-auth-jdbc/modules/guacamole-auth-jdbc-base/src/main/java/org/apache/guacamole/auth/jdbc/connection/ConnectionModel.java
index 92ee91d91..78cc885b4 100644
--- a/extensions/guacamole-auth-jdbc/modules/guacamole-auth-jdbc-base/src/main/java/org/apache/guacamole/auth/jdbc/connection/ConnectionModel.java
+++ b/extensions/guacamole-auth-jdbc/modules/guacamole-auth-jdbc-base/src/main/java/org/apache/guacamole/auth/jdbc/connection/ConnectionModel.java
@@ -172,22 +172,25 @@ public class ConnectionModel extends ChildObjectModel {
     }
 
     /**
-     * Sets the connection weight.
+     * Sets the connection weight for load balancing.
      *
      * @param connectionWeight
-     *     The weight of the connection.  null is acceptable, and anything
-     *     less than one will prevent the connection from being used.
+     *     The weight of the connection used in load balancing. 
+     *     The value is not required for the connection (null), and
+     *     values less than 1 will prevent the connection from being
+     *     used.
      */
     public void setConnectionWeight(Integer connectionWeight) {
         this.connectionWeight = connectionWeight;
     }
 
     /**
-     * Returns the connection weight used in calculating the
-     * weighted algorithms.
+     * Returns the connection weight used in applying weighted
+     * load balancing algorithms.
      *
      * @return
-     *     The connection weight as an Integer.
+     *     The connection weight used in applying weighted
+     *     load balancing aglorithms.
      */
     public Integer getConnectionWeight() {
         return connectionWeight;
diff --git a/extensions/guacamole-auth-jdbc/modules/guacamole-auth-jdbc-base/src/main/java/org/apache/guacamole/auth/jdbc/connection/ModeledConnection.java b/extensions/guacamole-auth-jdbc/modules/guacamole-auth-jdbc-base/src/main/java/org/apache/guacamole/auth/jdbc/connection/ModeledConnection.java
index ad525b84e..db8c815cf 100644
--- a/extensions/guacamole-auth-jdbc/modules/guacamole-auth-jdbc-base/src/main/java/org/apache/guacamole/auth/jdbc/connection/ModeledConnection.java
+++ b/extensions/guacamole-auth-jdbc/modules/guacamole-auth-jdbc-base/src/main/java/org/apache/guacamole/auth/jdbc/connection/ModeledConnection.java
@@ -117,7 +117,7 @@ public class ModeledConnection extends ModeledChildDirectoryObject<ConnectionMod
     public static final String MAX_CONNECTIONS_PER_USER_NAME = "max-connections-per-user";
 
     /**
-     * The connection weight for weighted algorithms.
+     * The connection weight attribute used for weighted load balancing algorithms.
      */
     public static final String CONNECTION_WEIGHT = "weight";
 
@@ -412,11 +412,13 @@ public class ModeledConnection extends ModeledChildDirectoryObject<ConnectionMod
     }
 
     /** 
-     * Returns the weight of the connection, or a default
-     * of 1 if the weight is undefined.
+     * Returns the weight of the connection used in applying weighted
+     * load balancing algorithms, or a default of 1 if the 
+     * attribute is undefined.
      *  
      * @return
-     *     The weight of the connection.
+     *     The weight of the connection used in applying weighted
+     *     load balancing algorithms.
      */
     public int getConnectionWeight() {