From 90a6d8e371181e8e4e626a2cee5aed9fd0b0b678 Mon Sep 17 00:00:00 2001 From: Michael Jumper Date: Sat, 3 Nov 2018 14:14:04 -0700 Subject: [PATCH] GUACAMOLE-220: Clarify usage of SimpleUser and SimpleUserGroup. --- .../org/apache/guacamole/net/auth/simple/SimpleUser.java | 6 ++++-- .../apache/guacamole/net/auth/simple/SimpleUserGroup.java | 4 +++- 2 files changed, 7 insertions(+), 3 deletions(-) diff --git a/guacamole-ext/src/main/java/org/apache/guacamole/net/auth/simple/SimpleUser.java b/guacamole-ext/src/main/java/org/apache/guacamole/net/auth/simple/SimpleUser.java index 953039243..d85cc9763 100644 --- a/guacamole-ext/src/main/java/org/apache/guacamole/net/auth/simple/SimpleUser.java +++ b/guacamole-ext/src/main/java/org/apache/guacamole/net/auth/simple/SimpleUser.java @@ -36,7 +36,9 @@ import org.apache.guacamole.net.auth.permission.ObjectPermissionSet; import org.apache.guacamole.net.auth.permission.SystemPermissionSet; /** - * An extremely basic User implementation. + * A read-only User implementation which has no permissions. Implementations + * that need to define permissions should extend this class and override the + * associated getters. */ public class SimpleUser extends AbstractUser { @@ -62,7 +64,7 @@ public class SimpleUser extends AbstractUser { } /** - * Creates a new SimpleUser having the given username and no permissions. + * Creates a new SimpleUser having the given username. * * @param username * The username to assign to this SimpleUser. diff --git a/guacamole-ext/src/main/java/org/apache/guacamole/net/auth/simple/SimpleUserGroup.java b/guacamole-ext/src/main/java/org/apache/guacamole/net/auth/simple/SimpleUserGroup.java index 83b7ce91f..77b374149 100644 --- a/guacamole-ext/src/main/java/org/apache/guacamole/net/auth/simple/SimpleUserGroup.java +++ b/guacamole-ext/src/main/java/org/apache/guacamole/net/auth/simple/SimpleUserGroup.java @@ -29,7 +29,9 @@ import org.apache.guacamole.net.auth.permission.ObjectPermissionSet; import org.apache.guacamole.net.auth.permission.SystemPermissionSet; /** - * A read-only UserGroup implementation which has no members. + * A read-only UserGroup implementation which has no members and no + * permissions. Implementations that need to define members or permissions + * should extend this class and override the associated getters. */ public class SimpleUserGroup extends AbstractIdentifiable implements UserGroup {