GUACAMOLE-102: Clearer comments on the function for the config values for dereferencing aliases.
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/b9271aac Tree: http://git-wip-us.apache.org/repos/asf/incubator-guacamole-client/tree/b9271aac Diff: http://git-wip-us.apache.org/repos/asf/incubator-guacamole-client/diff/b9271aac Branch: refs/heads/master Commit: b9271aac56384352aba2a8b8679eaad80df516e8 Parents: c0a1b69 Author: Nick Couchman <[email protected]> Authored: Sun Mar 19 20:50:30 2017 -0400 Committer: Nick Couchman <[email protected]> Committed: Sun Mar 19 20:50:30 2017 -0400 ---------------------------------------------------------------------- .../apache/guacamole/auth/ldap/ConfigurationService.java | 11 +++++++---- 1 file changed, 7 insertions(+), 4 deletions(-) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/incubator-guacamole-client/blob/b9271aac/extensions/guacamole-auth-ldap/src/main/java/org/apache/guacamole/auth/ldap/ConfigurationService.java ---------------------------------------------------------------------- diff --git a/extensions/guacamole-auth-ldap/src/main/java/org/apache/guacamole/auth/ldap/ConfigurationService.java b/extensions/guacamole-auth-ldap/src/main/java/org/apache/guacamole/auth/ldap/ConfigurationService.java index e546414..b5e5555 100644 --- a/extensions/guacamole-auth-ldap/src/main/java/org/apache/guacamole/auth/ldap/ConfigurationService.java +++ b/extensions/guacamole-auth-ldap/src/main/java/org/apache/guacamole/auth/ldap/ConfigurationService.java @@ -225,12 +225,15 @@ public class ConfigurationService { /** * Returns whether or not LDAP aliases will be dereferenced, - * as configured with guacamole.properties. - * By default they will never be dereferenced. + * as configured with guacamole.properties. The default + * behavior if not explicityly defined is to never + * dereference them. * * @return - * An integer representing the status of of alias - * dereferencing, as configured in guacamole.properties. + * An integer value that maps to the JLDAP constants + * for dereferencing - 0 is DEREF_NEVER, 1 is DEREF_SEARCHING, + * 2 is DEREF_FINDING, and 3 is DEREF_ALWAYS - as configured + * in guacamole.properties. * * @throws GuacamoleException * If guacamole.properties cannot be parsed.
