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

GUAC-1001: Document that identifiers and usernames must not be null.

Browse Source
This commit is contained in:
Michael Jumper
2015-01-22 16:25:06 -08:00
parent f8d67b55ce
commit 4940f34483
3 changed files with 18 additions and 5 deletions
Download Patch File Download Diff File Expand all files Collapse all files

9
guacamole-ext/src/main/java/org/glyptodon/guacamole/net/auth/Connection.java
View File

@@ -52,8 +52,13 @@ public interface Connection {
public void setName(String name); public void setName(String name);
/** /**
* Returns the unique identifier assigned to this Connection. * Returns the unique identifier assigned to this Connection. All
* @return The unique identifier assigned to this Connection. * connections must have a deterministic, unique identifier which may not
* be null.
*
* @return
* The unique identifier assigned to this Connection, which may not be
* null.
*/ */
public String getIdentifier(); public String getIdentifier();

9
guacamole-ext/src/main/java/org/glyptodon/guacamole/net/auth/ConnectionGroup.java
View File

@@ -52,8 +52,13 @@ public interface ConnectionGroup {
public void setName(String name); public void setName(String name);
/** /**
* Returns the unique identifier assigned to this ConnectionGroup. * Returns the unique identifier assigned to this ConnectionGroup. All
* @return The unique identifier assigned to this ConnectionGroup. * connection groups must have a deterministic, unique identifier which may
* not be null.
*
* @return
* The unique identifier assigned to this ConnectionGroup, which may
* not be null.
*/ */
public String getIdentifier(); public String getIdentifier();

5
guacamole-ext/src/main/java/org/glyptodon/guacamole/net/auth/User.java
View File

@@ -36,8 +36,11 @@ public interface User {
/** /**
* Returns the name of this user, which must be unique across all users. * Returns the name of this user, which must be unique across all users.
* All users must have a deterministic, unique username which may not be
* null.
* *
* @return The name of this user. * @return
* The unique username of this user, which may not be null.
*/ */
public String getUsername(); public String getUsername();