GUACAMOLE-102: Improve commentary around connection weight methods and variables.
Project: http://git-wip-us.apache.org/repos/asf/incubator-guacamole-client/repo Commit: http://git-wip-us.apache.org/repos/asf/incubator-guacamole-client/commit/06e27d30 Tree: http://git-wip-us.apache.org/repos/asf/incubator-guacamole-client/tree/06e27d30 Diff: http://git-wip-us.apache.org/repos/asf/incubator-guacamole-client/diff/06e27d30 Branch: refs/heads/master Commit: 06e27d30ff2823468707309b24a230d9175714d4 Parents: 955d5fb Author: Nick Couchman <[email protected]> Authored: Tue Jun 6 08:39:02 2017 -0400 Committer: Nick Couchman <[email protected]> Committed: Tue Jun 6 08:39:02 2017 -0400 ---------------------------------------------------------------------- .../auth/jdbc/connection/ConnectionModel.java | 15 +++++++++------ .../auth/jdbc/connection/ModeledConnection.java | 10 ++++++---- 2 files changed, 15 insertions(+), 10 deletions(-) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/incubator-guacamole-client/blob/06e27d30/extensions/guacamole-auth-jdbc/modules/guacamole-auth-jdbc-base/src/main/java/org/apache/guacamole/auth/jdbc/connection/ConnectionModel.java ---------------------------------------------------------------------- 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 92ee91d..78cc885 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; http://git-wip-us.apache.org/repos/asf/incubator-guacamole-client/blob/06e27d30/extensions/guacamole-auth-jdbc/modules/guacamole-auth-jdbc-base/src/main/java/org/apache/guacamole/auth/jdbc/connection/ModeledConnection.java ---------------------------------------------------------------------- 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 ad525b8..db8c815 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() {
