safebox/guacamole-client
4
0
Fork 0
mirror of https://github.com/gyurix1968/guacamole-client.git synced 2025-09-06 13:17:41 +00:00
Code Issues Packages Projects Releases Wiki Activity

Add missing JavaDoc.

Browse Source
This commit is contained in:
Michael Jumper
2013-02-20 23:40:59 -08:00
parent 1be13d9767
commit 3116ada14a
16 changed files with 96 additions and 1 deletions
Download Patch File Download Diff File Expand all files Collapse all files

3
guacamole/src/main/java/net/sourceforge/guacamole/net/basic/AuthenticatingHttpServlet.java
View File

@@ -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);
/**

3
guacamole/src/main/java/net/sourceforge/guacamole/net/basic/BasicFileAuthenticationProvider.java
View File

@@ -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);
/**

5
guacamole/src/main/java/net/sourceforge/guacamole/net/basic/BasicGuacamoleTunnelServlet.java
View File

@@ -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,

3
guacamole/src/main/java/net/sourceforge/guacamole/net/basic/BasicLogin.java
View File

@@ -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

20
guacamole/src/main/java/net/sourceforge/guacamole/net/basic/GuacamoleClassLoader.java
View File

@@ -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

3
guacamole/src/main/java/net/sourceforge/guacamole/net/basic/WebSocketSupportLoader.java
View File

@@ -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

7
guacamole/src/main/java/net/sourceforge/guacamole/net/basic/auth/package-info.java Normal file
View File

@@ -0,0 +1,7 @@
/**
* Classes which drive the default, basic authentication of the Guacamole
* web application.
*/
package net.sourceforge.guacamole.net.basic.auth;

6
guacamole/src/main/java/net/sourceforge/guacamole/net/basic/crud/connections/package-info.java Normal file
View File

@@ -0,0 +1,6 @@
/**
* Servlets dedicated to CRUD operations related to Connections.
*/
package net.sourceforge.guacamole.net.basic.crud.connections;

6
guacamole/src/main/java/net/sourceforge/guacamole/net/basic/crud/permissions/package-info.java Normal file
View File

@@ -0,0 +1,6 @@
/**
* Servlets dedicated to CRUD operations related to Permissions.
*/
package net.sourceforge.guacamole.net.basic.crud.permissions;

6
guacamole/src/main/java/net/sourceforge/guacamole/net/basic/crud/users/package-info.java Normal file
View File

@@ -0,0 +1,6 @@
/**
* Servlets dedicated to CRUD operations related to Users.
*/
package net.sourceforge.guacamole.net.basic.crud.users;

6
guacamole/src/main/java/net/sourceforge/guacamole/net/basic/event/package-info.java Normal file
View File

@@ -0,0 +1,6 @@
/**
* Classes used by the Guacamole web application to broadcast events.
*/
package net.sourceforge.guacamole.net.basic.event;

7
guacamole/src/main/java/net/sourceforge/guacamole/net/basic/package-info.java Normal file
View File

@@ -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;

7
guacamole/src/main/java/net/sourceforge/guacamole/net/basic/properties/package-info.java Normal file
View File

@@ -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;

7
guacamole/src/main/java/net/sourceforge/guacamole/net/basic/xml/package-info.java Normal file
View File

@@ -0,0 +1,7 @@
/**
* Classes driving the SAX-based XML parser used by the Guacamole web
* application.
*/
package net.sourceforge.guacamole.net.basic.xml;

2
guacamole/src/main/java/net/sourceforge/guacamole/net/basic/xml/user_mapping/ParamTagHandler.java
View File

@@ -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;

6
guacamole/src/main/java/net/sourceforge/guacamole/net/basic/xml/user_mapping/package-info.java Normal file
View File

@@ -0,0 +1,6 @@
/**
* Classes related to parsing the user-mapping.xml file.
*/
package net.sourceforge.guacamole.net.basic.xml.user_mapping;