GUACAMOLE-101: Update comments to some of the changes.

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/c5fe3d1d
Tree: 
http://git-wip-us.apache.org/repos/asf/incubator-guacamole-client/tree/c5fe3d1d
Diff: 
http://git-wip-us.apache.org/repos/asf/incubator-guacamole-client/diff/c5fe3d1d

Branch: refs/heads/master
Commit: c5fe3d1df35305b5824fea924571bbbc8032a040
Parents: 2aec452
Author: Nick Couchman <[email protected]>
Authored: Mon Mar 20 22:29:55 2017 -0400
Committer: Nick Couchman <[email protected]>
Committed: Tue Mar 28 07:56:41 2017 -0400

----------------------------------------------------------------------
 .../org/apache/guacamole/auth/ldap/ConfigurationService.java   | 4 ++--
 .../apache/guacamole/auth/ldap/LDAPGuacamoleProperties.java    | 4 ++--
 .../java/org/apache/guacamole/auth/ldap/user/UserService.java  | 6 ++++--
 3 files changed, 8 insertions(+), 6 deletions(-)
----------------------------------------------------------------------


http://git-wip-us.apache.org/repos/asf/incubator-guacamole-client/blob/c5fe3d1d/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 19df483..2131797 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
@@ -295,12 +295,12 @@ public class ConfigurationService {
     /**
      * Returns the search filter that should be used when querying the 
      * LDAP server for Guacamole connections.  If no filter is specified,
-     * null is returned.
+     * the default of objectClass=guacConfigGroup is returned.
      * 
      * @return
      *     The search filter that should be used when querying the 
      *     LDAP server for connections for Guacamole, or 
-     *     null if no filter is specified. 
+     *     objectClass=guacConfigGroup if no filter is specified. 
      *
      * @throws GuacamoleException
      *     If guacamole.properties cannot be parsed.

http://git-wip-us.apache.org/repos/asf/incubator-guacamole-client/blob/c5fe3d1d/extensions/guacamole-auth-ldap/src/main/java/org/apache/guacamole/auth/ldap/LDAPGuacamoleProperties.java
----------------------------------------------------------------------
diff --git 
a/extensions/guacamole-auth-ldap/src/main/java/org/apache/guacamole/auth/ldap/LDAPGuacamoleProperties.java
 
b/extensions/guacamole-auth-ldap/src/main/java/org/apache/guacamole/auth/ldap/LDAPGuacamoleProperties.java
index 691a6fc..5f49a8c 100644
--- 
a/extensions/guacamole-auth-ldap/src/main/java/org/apache/guacamole/auth/ldap/LDAPGuacamoleProperties.java
+++ 
b/extensions/guacamole-auth-ldap/src/main/java/org/apache/guacamole/auth/ldap/LDAPGuacamoleProperties.java
@@ -165,7 +165,7 @@ public class LDAPGuacamoleProperties {
     };
 
     /**
-     * A search filter to apply to the user LDAP query.
+     * A search filter to apply to user LDAP queries.
      */
     public static final StringGuacamoleProperty LDAP_USER_SEARCH_FILTER = new 
StringGuacamoleProperty() {
 
@@ -175,7 +175,7 @@ public class LDAPGuacamoleProperties {
     };
 
     /**
-     * A search filter to apply to the connection LDAP query.
+     * A search filter to apply to connection LDAP queries.
      */
     public static final StringGuacamoleProperty LDAP_CONNECTION_SEARCH_FILTER 
= new StringGuacamoleProperty() {
 

http://git-wip-us.apache.org/repos/asf/incubator-guacamole-client/blob/c5fe3d1d/extensions/guacamole-auth-ldap/src/main/java/org/apache/guacamole/auth/ldap/user/UserService.java
----------------------------------------------------------------------
diff --git 
a/extensions/guacamole-auth-ldap/src/main/java/org/apache/guacamole/auth/ldap/user/UserService.java
 
b/extensions/guacamole-auth-ldap/src/main/java/org/apache/guacamole/auth/ldap/user/UserService.java
index f58b410..94763e6 100644
--- 
a/extensions/guacamole-auth-ldap/src/main/java/org/apache/guacamole/auth/ldap/user/UserService.java
+++ 
b/extensions/guacamole-auth-ldap/src/main/java/org/apache/guacamole/auth/ldap/user/UserService.java
@@ -85,10 +85,12 @@ public class UserService {
 
         try {
 
+            // Build a filter using the configured or default user search 
filter
+            // to find all user objects in the LDAP tree
             StringBuilder userSearchFilter = new StringBuilder();
             userSearchFilter.append("(&");
             userSearchFilter.append(confService.getUserSearchFilter());
-            userSearchFilter.append("(" + 
escapeService.escapeLDAPSearchFilter(usernameAttribute) + "=*)");
+            userSearchFilter.append("(" + 
escapingService.escapeLDAPSearchFilter(usernameAttribute) + "=*)");
             userSearchFilter.append(")");
          
 
@@ -195,7 +197,7 @@ public class UserService {
         List<String> usernameAttributes = confService.getUsernameAttributes();
 
         // Build LDAP query for users having at least one username attribute
-        // with the specified username as its value
+        // and with the configured or default search filter
         StringBuilder ldapQuery = new StringBuilder();
         ldapQuery.append("(&");
         ldapQuery.append(confService.getUserSearchFilter());

Reply via email to