diff --git a/guacamole/src/main/java/net/sourceforge/guacamole/net/basic/AuthenticatingHttpServlet.java b/guacamole/src/main/java/net/sourceforge/guacamole/net/basic/AuthenticatingHttpServlet.java index eed5eb523..6e95ae9e0 100644 --- a/guacamole/src/main/java/net/sourceforge/guacamole/net/basic/AuthenticatingHttpServlet.java +++ b/guacamole/src/main/java/net/sourceforge/guacamole/net/basic/AuthenticatingHttpServlet.java @@ -58,6 +58,9 @@ import org.slf4j.LoggerFactory; */ public abstract class AuthenticatingHttpServlet extends HttpServlet { + /** + * Logger for this class. + */ private Logger logger = LoggerFactory.getLogger(AuthenticatingHttpServlet.class); /** diff --git a/guacamole/src/main/java/net/sourceforge/guacamole/net/basic/BasicFileAuthenticationProvider.java b/guacamole/src/main/java/net/sourceforge/guacamole/net/basic/BasicFileAuthenticationProvider.java index 8078bf807..b1037826b 100644 --- a/guacamole/src/main/java/net/sourceforge/guacamole/net/basic/BasicFileAuthenticationProvider.java +++ b/guacamole/src/main/java/net/sourceforge/guacamole/net/basic/BasicFileAuthenticationProvider.java @@ -51,6 +51,9 @@ import org.xml.sax.helpers.XMLReaderFactory; */ public class BasicFileAuthenticationProvider extends SimpleAuthenticationProvider { + /** + * Logger for this class. + */ private Logger logger = LoggerFactory.getLogger(BasicFileAuthenticationProvider.class); /** diff --git a/guacamole/src/main/java/net/sourceforge/guacamole/net/basic/BasicGuacamoleTunnelServlet.java b/guacamole/src/main/java/net/sourceforge/guacamole/net/basic/BasicGuacamoleTunnelServlet.java index 65f0d8b86..b22917297 100644 --- a/guacamole/src/main/java/net/sourceforge/guacamole/net/basic/BasicGuacamoleTunnelServlet.java +++ b/guacamole/src/main/java/net/sourceforge/guacamole/net/basic/BasicGuacamoleTunnelServlet.java @@ -51,6 +51,9 @@ import org.slf4j.LoggerFactory; */ public class BasicGuacamoleTunnelServlet extends AuthenticatingHttpServlet { + /** + * Logger for this class. + */ private Logger logger = LoggerFactory.getLogger(BasicGuacamoleTunnelServlet.class); @Override @@ -71,6 +74,7 @@ public class BasicGuacamoleTunnelServlet extends AuthenticatingHttpServlet { * @param listeners A collection of all listeners that should be notified. * @param credentials The credentials associated with the authentication * request that connected the tunnel. + * @param tunnel The tunnel being connected. * @return true if all listeners are allowing the tunnel to connect, * or if there are no listeners, and false if any listener is * canceling the connection. Note that once one listener cancels, @@ -109,6 +113,7 @@ public class BasicGuacamoleTunnelServlet extends AuthenticatingHttpServlet { * @param listeners A collection of all listeners that should be notified. * @param credentials The credentials associated with the authentication * request that closed the tunnel. + * @param tunnel The tunnel being closed. * @return true if all listeners are allowing the tunnel to close, * or if there are no listeners, and false if any listener is * canceling the close. Note that once one listener cancels, diff --git a/guacamole/src/main/java/net/sourceforge/guacamole/net/basic/BasicLogin.java b/guacamole/src/main/java/net/sourceforge/guacamole/net/basic/BasicLogin.java index cb2d1bfc6..cd1d11cc6 100644 --- a/guacamole/src/main/java/net/sourceforge/guacamole/net/basic/BasicLogin.java +++ b/guacamole/src/main/java/net/sourceforge/guacamole/net/basic/BasicLogin.java @@ -33,6 +33,9 @@ import org.slf4j.LoggerFactory; */ public class BasicLogin extends AuthenticatingHttpServlet { + /** + * Logger for this class. + */ private Logger logger = LoggerFactory.getLogger(BasicLogin.class); @Override diff --git a/guacamole/src/main/java/net/sourceforge/guacamole/net/basic/GuacamoleClassLoader.java b/guacamole/src/main/java/net/sourceforge/guacamole/net/basic/GuacamoleClassLoader.java index 06d44b785..24ee22d93 100644 --- a/guacamole/src/main/java/net/sourceforge/guacamole/net/basic/GuacamoleClassLoader.java +++ b/guacamole/src/main/java/net/sourceforge/guacamole/net/basic/GuacamoleClassLoader.java @@ -41,9 +41,20 @@ import net.sourceforge.guacamole.properties.GuacamoleProperties; */ public class GuacamoleClassLoader extends ClassLoader { + /** + * Class loader which will load classes from the classpath specified + * in guacamole.properties. + */ private URLClassLoader classLoader = null; + /** + * Any exception that occurs while the class loader is being instantiated. + */ private static GuacamoleException exception = null; + + /** + * Singleton instance of the GuacamoleClassLoader. + */ private static GuacamoleClassLoader instance = null; static { @@ -70,6 +81,15 @@ public class GuacamoleClassLoader extends ClassLoader { } + /** + * Creates a new GuacamoleClassLoader which reads classes from the given + * directory. + * + * @param libDirectory The directory to load classes from. + * @throws GuacamoleException If the file given is not a director, or if + * an error occurs while constructing the URL + * for the backing classloader. + */ private GuacamoleClassLoader(File libDirectory) throws GuacamoleException { // If no directory provided, just direct requests to parent classloader diff --git a/guacamole/src/main/java/net/sourceforge/guacamole/net/basic/WebSocketSupportLoader.java b/guacamole/src/main/java/net/sourceforge/guacamole/net/basic/WebSocketSupportLoader.java index 07f614e89..7b40534eb 100644 --- a/guacamole/src/main/java/net/sourceforge/guacamole/net/basic/WebSocketSupportLoader.java +++ b/guacamole/src/main/java/net/sourceforge/guacamole/net/basic/WebSocketSupportLoader.java @@ -41,6 +41,9 @@ import org.slf4j.LoggerFactory; */ public class WebSocketSupportLoader implements ServletContextListener { + /** + * Logger for this class. + */ private Logger logger = LoggerFactory.getLogger(WebSocketSupportLoader.class); @Override diff --git a/guacamole/src/main/java/net/sourceforge/guacamole/net/basic/auth/package-info.java b/guacamole/src/main/java/net/sourceforge/guacamole/net/basic/auth/package-info.java new file mode 100644 index 000000000..733b1f50c --- /dev/null +++ b/guacamole/src/main/java/net/sourceforge/guacamole/net/basic/auth/package-info.java @@ -0,0 +1,7 @@ + +/** + * Classes which drive the default, basic authentication of the Guacamole + * web application. + */ +package net.sourceforge.guacamole.net.basic.auth; + diff --git a/guacamole/src/main/java/net/sourceforge/guacamole/net/basic/crud/connections/package-info.java b/guacamole/src/main/java/net/sourceforge/guacamole/net/basic/crud/connections/package-info.java new file mode 100644 index 000000000..c52fecb83 --- /dev/null +++ b/guacamole/src/main/java/net/sourceforge/guacamole/net/basic/crud/connections/package-info.java @@ -0,0 +1,6 @@ + +/** + * Servlets dedicated to CRUD operations related to Connections. + */ +package net.sourceforge.guacamole.net.basic.crud.connections; + diff --git a/guacamole/src/main/java/net/sourceforge/guacamole/net/basic/crud/permissions/package-info.java b/guacamole/src/main/java/net/sourceforge/guacamole/net/basic/crud/permissions/package-info.java new file mode 100644 index 000000000..b4a22cee0 --- /dev/null +++ b/guacamole/src/main/java/net/sourceforge/guacamole/net/basic/crud/permissions/package-info.java @@ -0,0 +1,6 @@ + +/** + * Servlets dedicated to CRUD operations related to Permissions. + */ +package net.sourceforge.guacamole.net.basic.crud.permissions; + diff --git a/guacamole/src/main/java/net/sourceforge/guacamole/net/basic/crud/users/package-info.java b/guacamole/src/main/java/net/sourceforge/guacamole/net/basic/crud/users/package-info.java new file mode 100644 index 000000000..53f11c332 --- /dev/null +++ b/guacamole/src/main/java/net/sourceforge/guacamole/net/basic/crud/users/package-info.java @@ -0,0 +1,6 @@ + +/** + * Servlets dedicated to CRUD operations related to Users. + */ +package net.sourceforge.guacamole.net.basic.crud.users; + diff --git a/guacamole/src/main/java/net/sourceforge/guacamole/net/basic/event/package-info.java b/guacamole/src/main/java/net/sourceforge/guacamole/net/basic/event/package-info.java new file mode 100644 index 000000000..759cdd739 --- /dev/null +++ b/guacamole/src/main/java/net/sourceforge/guacamole/net/basic/event/package-info.java @@ -0,0 +1,6 @@ + +/** + * Classes used by the Guacamole web application to broadcast events. + */ +package net.sourceforge.guacamole.net.basic.event; + diff --git a/guacamole/src/main/java/net/sourceforge/guacamole/net/basic/package-info.java b/guacamole/src/main/java/net/sourceforge/guacamole/net/basic/package-info.java new file mode 100644 index 000000000..b903d3d80 --- /dev/null +++ b/guacamole/src/main/java/net/sourceforge/guacamole/net/basic/package-info.java @@ -0,0 +1,7 @@ + +/** + * Classes specific to the general-purpose web application implemented by + * the Guacamole project using the Guacamole APIs. + */ +package net.sourceforge.guacamole.net.basic; + diff --git a/guacamole/src/main/java/net/sourceforge/guacamole/net/basic/properties/package-info.java b/guacamole/src/main/java/net/sourceforge/guacamole/net/basic/properties/package-info.java new file mode 100644 index 000000000..b349e8ee7 --- /dev/null +++ b/guacamole/src/main/java/net/sourceforge/guacamole/net/basic/properties/package-info.java @@ -0,0 +1,7 @@ + +/** + * Classes related to the properties which the Guacamole web application + * (and stock parts of it) read from guacamole.properties. + */ +package net.sourceforge.guacamole.net.basic.properties; + diff --git a/guacamole/src/main/java/net/sourceforge/guacamole/net/basic/xml/package-info.java b/guacamole/src/main/java/net/sourceforge/guacamole/net/basic/xml/package-info.java new file mode 100644 index 000000000..eebbc6ef4 --- /dev/null +++ b/guacamole/src/main/java/net/sourceforge/guacamole/net/basic/xml/package-info.java @@ -0,0 +1,7 @@ + +/** + * Classes driving the SAX-based XML parser used by the Guacamole web + * application. + */ +package net.sourceforge.guacamole.net.basic.xml; + diff --git a/guacamole/src/main/java/net/sourceforge/guacamole/net/basic/xml/user_mapping/ParamTagHandler.java b/guacamole/src/main/java/net/sourceforge/guacamole/net/basic/xml/user_mapping/ParamTagHandler.java index 5a7ee777f..3a595ac3d 100644 --- a/guacamole/src/main/java/net/sourceforge/guacamole/net/basic/xml/user_mapping/ParamTagHandler.java +++ b/guacamole/src/main/java/net/sourceforge/guacamole/net/basic/xml/user_mapping/ParamTagHandler.java @@ -37,7 +37,7 @@ public class ParamTagHandler implements TagHandler { private GuacamoleConfiguration config; /** - * The name of the parameter + * The name of the parameter. */ private String name; diff --git a/guacamole/src/main/java/net/sourceforge/guacamole/net/basic/xml/user_mapping/package-info.java b/guacamole/src/main/java/net/sourceforge/guacamole/net/basic/xml/user_mapping/package-info.java new file mode 100644 index 000000000..2a7a70949 --- /dev/null +++ b/guacamole/src/main/java/net/sourceforge/guacamole/net/basic/xml/user_mapping/package-info.java @@ -0,0 +1,6 @@ + +/** + * Classes related to parsing the user-mapping.xml file. + */ +package net.sourceforge.guacamole.net.basic.xml.user_mapping; +