GUACAMOLE-289: Clarify behavior of getResource() with respect to authenticated vs. unauthenticated.
Project: http://git-wip-us.apache.org/repos/asf/incubator-guacamole-client/repo Commit: http://git-wip-us.apache.org/repos/asf/incubator-guacamole-client/commit/8142b2d5 Tree: http://git-wip-us.apache.org/repos/asf/incubator-guacamole-client/tree/8142b2d5 Diff: http://git-wip-us.apache.org/repos/asf/incubator-guacamole-client/diff/8142b2d5 Branch: refs/heads/master Commit: 8142b2d5f808aaaf9c3e4ae1f9c5826e47c93218 Parents: aa26141 Author: Michael Jumper <[email protected]> Authored: Sat Apr 29 14:00:10 2017 -0700 Committer: Michael Jumper <[email protected]> Committed: Sat Apr 29 14:00:10 2017 -0700 ---------------------------------------------------------------------- .../net/auth/AuthenticationProvider.java | 20 ++++++++++-------- .../apache/guacamole/net/auth/UserContext.java | 22 +++++++++++--------- 2 files changed, 23 insertions(+), 19 deletions(-) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/incubator-guacamole-client/blob/8142b2d5/guacamole-ext/src/main/java/org/apache/guacamole/net/auth/AuthenticationProvider.java ---------------------------------------------------------------------- diff --git a/guacamole-ext/src/main/java/org/apache/guacamole/net/auth/AuthenticationProvider.java b/guacamole-ext/src/main/java/org/apache/guacamole/net/auth/AuthenticationProvider.java index 401754d..3acc512 100644 --- a/guacamole-ext/src/main/java/org/apache/guacamole/net/auth/AuthenticationProvider.java +++ b/guacamole-ext/src/main/java/org/apache/guacamole/net/auth/AuthenticationProvider.java @@ -41,15 +41,17 @@ public interface AuthenticationProvider { String getIdentifier(); /** - * Returns an arbitrary REST resource. The REST resource returned must be - * properly annotated with JSR-311 annotations, and may serve as the root - * resource for any number of extension-specific REST resources which are - * unrelated to an authenticated user's session. The returned resource is - * ultimately exposed at ".../api/ext/IDENTIFIER/", where IDENTIFIER is the - * identifier of the AuthenticationProvider. - * - * REST resources which ARE related to an authenticated user's session - * should instead be returned from UserContext.getResource(). + * Returns an arbitrary REST resource representing this + * AuthenticationProvider. The REST resource returned must be properly + * annotated with JSR-311 annotations, and may serve as the root resource + * for any number of subresources. The returned resource is ultimately + * exposed at ".../api/ext/IDENTIFIER/", where IDENTIFIER is the identifier + * of this AuthenticationProvider. + * + * REST resources returned by this function will be reachable by all users, + * regardless of whether they have authenticated. REST resources which + * must only be accessible by authenticated users should instead be returned + * from UserContext.getResource(). * * @return * An arbitrary REST resource, annotated with JSR-311 annotations, or http://git-wip-us.apache.org/repos/asf/incubator-guacamole-client/blob/8142b2d5/guacamole-ext/src/main/java/org/apache/guacamole/net/auth/UserContext.java ---------------------------------------------------------------------- diff --git a/guacamole-ext/src/main/java/org/apache/guacamole/net/auth/UserContext.java b/guacamole-ext/src/main/java/org/apache/guacamole/net/auth/UserContext.java index 10fd6bf..5c6f974 100644 --- a/guacamole-ext/src/main/java/org/apache/guacamole/net/auth/UserContext.java +++ b/guacamole-ext/src/main/java/org/apache/guacamole/net/auth/UserContext.java @@ -39,16 +39,18 @@ public interface UserContext { User self(); /** - * Returns an arbitrary REST resource. The REST resource returned must be - * properly annotated with JSR-311 annotations, and may serve as the root - * resource for any number of extension-specific REST resources related to - * an authenticated user's session. The returned resource is ultimately - * exposed at ".../api/session/ext/IDENTIFIER/", where IDENTIFIER is the - * identifier of the AuthenticationProvider associated with this - * UserContext. - * - * REST resources which are NOT related to an authenticated user's session - * should instead be returned from AuthenticationProvider.getResource(). + * Returns an arbitrary REST resource representing this UserContext. The + * REST resource returned must be properly annotated with JSR-311 + * annotations, and may serve as the root resource for any number of + * subresources. The returned resource is ultimately exposed at + * ".../api/session/ext/IDENTIFIER/", where IDENTIFIER is the identifier of + * the AuthenticationProvider associated with this UserContext. + * + * REST resources returned by this function will only be reachable by + * authenticated users with valid authentication tokens. REST resources + * which should be accessible by all users regardless of whether they have + * authenticated should instead be returned from + * AuthenticationProvider.getResource(). * * @return * An arbitrary REST resource, annotated with JSR-311 annotations, or
