From 8b172a98fc77241664be16e7f40ab4add510c73a Mon Sep 17 00:00:00 2001 From: Virtually Nick Date: Sat, 10 Aug 2019 22:14:56 -0400 Subject: [PATCH] GUACAMOLE-234: Fix style, debug messages, and logger output. --- .../auth/ldap/LDAPConnectionService.java | 4 ++-- .../guacamole/auth/ldap/ObjectQueryService.java | 13 +++++++++---- .../auth/ldap/connection/ConnectionService.java | 15 +++++++++++---- .../auth/ldap/group/UserGroupService.java | 4 +++- 4 files changed, 25 insertions(+), 11 deletions(-) diff --git a/extensions/guacamole-auth-ldap/src/main/java/org/apache/guacamole/auth/ldap/LDAPConnectionService.java b/extensions/guacamole-auth-ldap/src/main/java/org/apache/guacamole/auth/ldap/LDAPConnectionService.java index c24901b9b..ecde74c52 100644 --- a/extensions/guacamole-auth-ldap/src/main/java/org/apache/guacamole/auth/ldap/LDAPConnectionService.java +++ b/extensions/guacamole-auth-ldap/src/main/java/org/apache/guacamole/auth/ldap/LDAPConnectionService.java @@ -197,8 +197,8 @@ public class LDAPConnectionService { * If an error occurs parsing out the LdapUrl object or the * maximum number of referral hops is reached. */ - public LdapNetworkConnection referralConnection(LdapUrl referralUrl, - LdapConnectionConfig ldapConfig, int hop) + public LdapNetworkConnection getReferralConnection(LdapUrl referralUrl, + LdapConnectionConfig ldapConfig, int hop) throws GuacamoleException { if (hop >= confService.getMaxReferralHops()) diff --git a/extensions/guacamole-auth-ldap/src/main/java/org/apache/guacamole/auth/ldap/ObjectQueryService.java b/extensions/guacamole-auth-ldap/src/main/java/org/apache/guacamole/auth/ldap/ObjectQueryService.java index ff107ced9..f9d7956a2 100644 --- a/extensions/guacamole-auth-ldap/src/main/java/org/apache/guacamole/auth/ldap/ObjectQueryService.java +++ b/extensions/guacamole-auth-ldap/src/main/java/org/apache/guacamole/auth/ldap/ObjectQueryService.java @@ -171,7 +171,8 @@ public class ObjectQueryService { * The LDAP query to execute. * * @param searchHop - * The level of depth for this search, used for tracking referrals. + * The current level of referral depth for this search, used for + * limiting the maximum depth to which referrals can go. * * @return * A list of all results accessible to the user currently bound under @@ -209,9 +210,13 @@ public class ObjectQueryService { Referral referral = results.getReferral(); for (String url : referral.getLdapUrls()) { - LdapNetworkConnection referralConnection = ldapService.referralConnection( - new LdapUrl(url), ldapConnectionConfig, searchHop++); - entries.addAll(search(referralConnection, baseDN, query, searchHop)); + LdapNetworkConnection referralConnection = + ldapService.getReferralConnection( + new LdapUrl(url), + ldapConnectionConfig, searchHop++ + ); + entries.addAll(search(referralConnection, baseDN, query, + searchHop)); } } diff --git a/extensions/guacamole-auth-ldap/src/main/java/org/apache/guacamole/auth/ldap/connection/ConnectionService.java b/extensions/guacamole-auth-ldap/src/main/java/org/apache/guacamole/auth/ldap/connection/ConnectionService.java index 70bd80cf9..6b2d840a1 100644 --- a/extensions/guacamole-auth-ldap/src/main/java/org/apache/guacamole/auth/ldap/connection/ConnectionService.java +++ b/extensions/guacamole-auth-ldap/src/main/java/org/apache/guacamole/auth/ldap/connection/ConnectionService.java @@ -115,7 +115,7 @@ public class ConnectionService { // getConnections() will only be called after a connection has been // authenticated (via non-anonymous bind), thus userDN cannot // possibly be null - assert (userDN != null); + assert(userDN != null); // Get the search filter for finding connections accessible by the // current user @@ -145,7 +145,9 @@ public class ConnectionService { cnName = cn.getString(); } catch (LdapInvalidAttributeValueException e) { - logger.error("Invalid value for CN attribute.", e.getMessage()); + logger.error("Invalid value for CN attribute: {}", + e.getMessage()); + logger.debug("LDAP exception while getting CN attribute.", e); return null; } @@ -164,7 +166,9 @@ public class ConnectionService { config.setProtocol(protocol.getString()); } catch (LdapInvalidAttributeValueException e) { - logger.error("Invalid value of the protocol entry.", e.getMessage()); + logger.error("Invalid value of the protocol entry: {}", + e.getMessage()); + logger.debug("LDAP exception when getting protocol value.", e); return null; } @@ -179,7 +183,10 @@ public class ConnectionService { parameter = parameterAttribute.getString(); } catch (LdapInvalidAttributeValueException e) { - logger.warn("Parameter value not valid for {}", cnName, e); + logger.warn("Parameter value not valid for {}: {}", + cnName, e.getMessage()); + logger.debug("LDAP exception when getting parameter value.", + e); return null; } parameterAttribute.remove(parameter); diff --git a/extensions/guacamole-auth-ldap/src/main/java/org/apache/guacamole/auth/ldap/group/UserGroupService.java b/extensions/guacamole-auth-ldap/src/main/java/org/apache/guacamole/auth/ldap/group/UserGroupService.java index 5eb375cb4..0628006dd 100644 --- a/extensions/guacamole-auth-ldap/src/main/java/org/apache/guacamole/auth/ldap/group/UserGroupService.java +++ b/extensions/guacamole-auth-ldap/src/main/java/org/apache/guacamole/auth/ldap/group/UserGroupService.java @@ -228,7 +228,9 @@ public class UserGroupService { + "and will be ignored.", entry.getDn().toString()); } catch (LdapInvalidAttributeValueException e) { - logger.debug("User group missing identifier.", e.getMessage()); + logger.error("User group missing identifier: {}", + e.getMessage()); + logger.debug("LDAP exception while getting group identifier.", e); } });