From 4940f34483d796aaeedc3f7317d69a877c059ada Mon Sep 17 00:00:00 2001
From: Michael Jumper <mike.jumper@guac-dev.org>
Date: Thu, 22 Jan 2015 16:25:06 -0800
Subject: [PATCH] GUAC-1001: Document that identifiers and usernames must not
 be null.

---
 .../org/glyptodon/guacamole/net/auth/Connection.java     | 9 +++++++--
 .../glyptodon/guacamole/net/auth/ConnectionGroup.java    | 9 +++++++--
 .../main/java/org/glyptodon/guacamole/net/auth/User.java | 5 ++++-
 3 files changed, 18 insertions(+), 5 deletions(-)

diff --git a/guacamole-ext/src/main/java/org/glyptodon/guacamole/net/auth/Connection.java b/guacamole-ext/src/main/java/org/glyptodon/guacamole/net/auth/Connection.java
index 6bf36bec6..cfd6447f2 100644
--- a/guacamole-ext/src/main/java/org/glyptodon/guacamole/net/auth/Connection.java
+++ b/guacamole-ext/src/main/java/org/glyptodon/guacamole/net/auth/Connection.java
@@ -52,8 +52,13 @@ public interface Connection {
     public void setName(String name);
 
     /**
-     * Returns the unique identifier assigned to this Connection.
-     * @return The unique identifier assigned to this Connection.
+     * Returns the unique identifier assigned to this Connection. All
+     * 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();
 
diff --git a/guacamole-ext/src/main/java/org/glyptodon/guacamole/net/auth/ConnectionGroup.java b/guacamole-ext/src/main/java/org/glyptodon/guacamole/net/auth/ConnectionGroup.java
index b5da32b68..6b5f84712 100644
--- a/guacamole-ext/src/main/java/org/glyptodon/guacamole/net/auth/ConnectionGroup.java
+++ b/guacamole-ext/src/main/java/org/glyptodon/guacamole/net/auth/ConnectionGroup.java
@@ -52,8 +52,13 @@ public interface ConnectionGroup {
     public void setName(String name);
 
     /**
-     * Returns the unique identifier assigned to this ConnectionGroup.
-     * @return The unique identifier assigned to this ConnectionGroup.
+     * Returns the unique identifier assigned to this ConnectionGroup. All
+     * 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();
 
diff --git a/guacamole-ext/src/main/java/org/glyptodon/guacamole/net/auth/User.java b/guacamole-ext/src/main/java/org/glyptodon/guacamole/net/auth/User.java
index c04e5df63..8409844c1 100644
--- a/guacamole-ext/src/main/java/org/glyptodon/guacamole/net/auth/User.java
+++ b/guacamole-ext/src/main/java/org/glyptodon/guacamole/net/auth/User.java
@@ -36,8 +36,11 @@ public interface User {
 
     /**
      * 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();