diff --git a/extensions/guacamole-auth-mysql/src/main/java/net/sourceforge/guacamole/net/auth/mysql/MySQLConnectionRecord.java b/extensions/guacamole-auth-mysql/src/main/java/net/sourceforge/guacamole/net/auth/mysql/MySQLConnectionRecord.java index ec47b4556..e42de570d 100644 --- a/extensions/guacamole-auth-mysql/src/main/java/net/sourceforge/guacamole/net/auth/mysql/MySQLConnectionRecord.java +++ b/extensions/guacamole-auth-mysql/src/main/java/net/sourceforge/guacamole/net/auth/mysql/MySQLConnectionRecord.java @@ -1,3 +1,6 @@ + +package net.sourceforge.guacamole.net.auth.mysql; + /* ***** BEGIN LICENSE BLOCK ***** * Version: MPL 1.1/GPL 2.0/LGPL 2.1 * @@ -33,7 +36,6 @@ * the terms of any one of the MPL, the GPL or the LGPL. * * ***** END LICENSE BLOCK ***** */ -package net.sourceforge.guacamole.net.auth.mysql; import com.google.inject.Inject; import java.util.Date; @@ -46,6 +48,7 @@ import net.sourceforge.guacamole.net.auth.mysql.model.ConnectionHistory; import net.sourceforge.guacamole.net.auth.mysql.utility.ProviderUtility; /** + * A ConnectionRecord which is based on data stored in MySQL. * * @author James Muehlner */ @@ -56,18 +59,30 @@ public class MySQLConnectionRecord implements ConnectionRecord { */ private ConnectionHistory connectionHistory; + /** + * DAO for accessing users. + */ @Inject UserMapper userDAO; + /** + * DAO for accessing connections. + */ @Inject ConnectionMapper connectionDAO; + /** + * Service for creating and retrieving objects. + */ @Inject ProviderUtility providerUtility; /** - * Initialize this MySQLConnectionRecord with the database record it represents. - * @param connectionHistory + * Initialize this MySQLConnectionRecord with the database record it + * represents. + * + * @param connectionHistory The ConnectionHistory entry from the database + * corresponding to this connection record. */ public void init(ConnectionHistory connectionHistory) { this.connectionHistory = connectionHistory; @@ -95,7 +110,7 @@ public class MySQLConnectionRecord implements ConnectionRecord { @Override public boolean isActive() { - // if the end date hasn't been stored yet, the connection is still open. + // If the end date hasn't been stored yet, the connection is still open. return connectionHistory.getEnd_date() == null; } diff --git a/extensions/guacamole-auth-mysql/src/main/java/net/sourceforge/guacamole/net/auth/mysql/utility/ConfigurationTranslationUtility.java b/extensions/guacamole-auth-mysql/src/main/java/net/sourceforge/guacamole/net/auth/mysql/utility/ConfigurationTranslationUtility.java index 658638268..e0708b720 100644 --- a/extensions/guacamole-auth-mysql/src/main/java/net/sourceforge/guacamole/net/auth/mysql/utility/ConfigurationTranslationUtility.java +++ b/extensions/guacamole-auth-mysql/src/main/java/net/sourceforge/guacamole/net/auth/mysql/utility/ConfigurationTranslationUtility.java @@ -1,3 +1,6 @@ + +package net.sourceforge.guacamole.net.auth.mysql.utility; + /* ***** BEGIN LICENSE BLOCK ***** * Version: MPL 1.1/GPL 2.0/LGPL 2.1 * @@ -33,7 +36,6 @@ * the terms of any one of the MPL, the GPL or the LGPL. * * ***** END LICENSE BLOCK ***** */ -package net.sourceforge.guacamole.net.auth.mysql.utility; import java.util.ArrayList; import java.util.List; @@ -48,39 +50,59 @@ import net.sourceforge.guacamole.protocol.GuacamoleConfiguration; public class ConfigurationTranslationUtility { /** - * Get a GuacamoleConfiguration based on the provided protocol and parameters. - * @param protocol the protocol used (VNC, RDP, etc) - * @param parameters the parameter database records to translate - * @return + * Get a GuacamoleConfiguration based on the provided protocol and + * parameters. + * + * @param protocol The protocol used (VNC, RDP, etc) + * @param parameters The parameter database records to translate + * @return A new GuacamoleConfiguration based on the given protocol and + * parameters. */ - public GuacamoleConfiguration getConfiguration(String protocol, Iterable parameters) { + public GuacamoleConfiguration getConfiguration(String protocol, + Iterable parameters) { + + // Create new configuration, set protocol GuacamoleConfiguration configuration = new GuacamoleConfiguration(); configuration.setProtocol(protocol); - for(ConnectionParameter parameter : parameters) { + // Copy parameters from given parameters + for(ConnectionParameter parameter : parameters) configuration.setParameter(parameter.getParameter_name(), parameter.getParameter_value()); - } return configuration; } /** - * Creates a list of ConnectionParameter database records based on the provided connectionID and GuacamoleConfiguration. - * @param connectionID the ID of the connection that these parameters are for - * @param configuration the configuration to pull the parameter values from - * @return + * Creates a list of ConnectionParameter database records based on the + * provided connectionID and GuacamoleConfiguration. + * + * @param connectionID The ID of the connection that these parameters are + * for. + * @param configuration The configuration to pull the parameter values from. + * @return A list of ConnectionParameter database records. */ - public List getConnectionParameters(int connectionID, GuacamoleConfiguration configuration) { - List connectionParameters = new ArrayList(); + public List getConnectionParameters(int connectionID, + GuacamoleConfiguration configuration) { - for(String parameterName : configuration.getParameterNames()) { - ConnectionParameter connectionParameter = new ConnectionParameter(); + List connectionParameters = + new ArrayList(); + + // Each connection parameter in the given configuration, create + // a corresponding database record + for (String parameterName : configuration.getParameterNames()) { + + // Get value of parameter String parameterValue = configuration.getParameter(parameterName); + + // Create corresponding ConnectionParameter + ConnectionParameter connectionParameter = new ConnectionParameter(); connectionParameter.setConnection_id(connectionID); connectionParameter.setParameter_name(parameterName); connectionParameter.setParameter_value(parameterValue); + // Add parameter to list connectionParameters.add(connectionParameter); + } return connectionParameters;