From 4791adaa46c8d9e3a0fc9cfcea38e10abf408913 Mon Sep 17 00:00:00 2001 From: Jared Frees Date: Tue, 12 Jun 2018 16:21:52 -0400 Subject: [PATCH] GUACAMOLE-524: Fixed up code style and comments Also added Override tag in AbstractAuthenticatedUser on getAttributes and setAttributes. --- .../auth/ldap/AuthenticationProviderService.java | 9 ++++----- .../guacamole/auth/ldap/ConfigurationService.java | 3 +-- .../guacamole/auth/ldap/user/AuthenticatedUser.java | 13 ------------- .../net/auth/AbstractAuthenticatedUser.java | 2 ++ .../org/apache/guacamole/token/StandardTokens.java | 1 + 5 files changed, 8 insertions(+), 20 deletions(-) diff --git a/extensions/guacamole-auth-ldap/src/main/java/org/apache/guacamole/auth/ldap/AuthenticationProviderService.java b/extensions/guacamole-auth-ldap/src/main/java/org/apache/guacamole/auth/ldap/AuthenticationProviderService.java index 8e51c37df..fa7ed932d 100644 --- a/extensions/guacamole-auth-ldap/src/main/java/org/apache/guacamole/auth/ldap/AuthenticationProviderService.java +++ b/extensions/guacamole-auth-ldap/src/main/java/org/apache/guacamole/auth/ldap/AuthenticationProviderService.java @@ -197,7 +197,8 @@ public class AuthenticationProviderService { /** * Returns an AuthenticatedUser representing the user authenticated by the - * given credentials. Also adds custom LDAP attributes to credentials object. + * given credentials. Also adds custom LDAP attributes to the + * AuthenticatedUser. * * @param credentials * The credentials to use for authentication. @@ -233,7 +234,7 @@ public class AuthenticationProviderService { AuthenticatedUser authenticatedUser = authenticatedUserProvider.get(); authenticatedUser.init(credentials); - //set attributes + // Set attributes String username = credentials.getUsername(); Map attrs = getLDAPAttributes(ldapConnection, username); authenticatedUser.setAttributes(attrs); @@ -293,9 +294,7 @@ public class AuthenticationProviderService { // Add each attribute into Map for (Object attrObj : attrSet) { LDAPAttribute attr = (LDAPAttribute)attrObj; - String attrName = attr.getName(); - String attrValue = attr.getStringValue(); - attrMap.put(attrName, attrValue); + attrMap.put(attr.getName(), attr.getStringValue()); } } catch (LDAPException e) { 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 4b82e3da2..de7c71ce2 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 @@ -348,8 +348,7 @@ public class ConfigurationService { * Returns names for custom LDAP user attributes. * * @return - * LDAP user attributes as defined in the guacamole.properties file - * as ldap-user-attributes: '' + * Custom LDAP user attributes as configured in guacamole.properties. * * @throws GuacamoleException * If guacamole.properties cannot be parsed. diff --git a/extensions/guacamole-auth-ldap/src/main/java/org/apache/guacamole/auth/ldap/user/AuthenticatedUser.java b/extensions/guacamole-auth-ldap/src/main/java/org/apache/guacamole/auth/ldap/user/AuthenticatedUser.java index fceaf9dbd..5b3115a71 100644 --- a/extensions/guacamole-auth-ldap/src/main/java/org/apache/guacamole/auth/ldap/user/AuthenticatedUser.java +++ b/extensions/guacamole-auth-ldap/src/main/java/org/apache/guacamole/auth/ldap/user/AuthenticatedUser.java @@ -61,24 +61,11 @@ public class AuthenticatedUser extends AbstractAuthenticatedUser { setIdentifier(credentials.getUsername()); } - /** - * Get a map of attributes associated with this AuthenticatedUser. - * - * @return - * The Map of arbitrary attributes associated with this - * AuthenticatedUser object. - */ @Override public Map getAttributes() { return attributes; } - /** - * Sets a map of attributes associated with this AuthenticatedUser. - * - * @param attributes - * A map of attribute key/value pairs to add to this AuthenticatedUser. - */ @Override public void setAttributes(Map attributes) { this.attributes = attributes; diff --git a/guacamole-ext/src/main/java/org/apache/guacamole/net/auth/AbstractAuthenticatedUser.java b/guacamole-ext/src/main/java/org/apache/guacamole/net/auth/AbstractAuthenticatedUser.java index f0691e131..828ad8904 100644 --- a/guacamole-ext/src/main/java/org/apache/guacamole/net/auth/AbstractAuthenticatedUser.java +++ b/guacamole-ext/src/main/java/org/apache/guacamole/net/auth/AbstractAuthenticatedUser.java @@ -42,10 +42,12 @@ public abstract class AbstractAuthenticatedUser extends AbstractIdentifiable // Nothing to invalidate } + @Override public Map getAttributes() { return Collections.emptyMap(); } + @Override public void setAttributes(Map attributes) { //do nothing } diff --git a/guacamole-ext/src/main/java/org/apache/guacamole/token/StandardTokens.java b/guacamole-ext/src/main/java/org/apache/guacamole/token/StandardTokens.java index d61e617f5..1039091e7 100644 --- a/guacamole-ext/src/main/java/org/apache/guacamole/token/StandardTokens.java +++ b/guacamole-ext/src/main/java/org/apache/guacamole/token/StandardTokens.java @@ -25,6 +25,7 @@ import java.util.Map; import java.util.Set; import org.apache.guacamole.net.auth.AuthenticatedUser; import org.apache.guacamole.net.auth.Credentials; + /** * Utility class which provides access to standardized token names, as well as * facilities for generating those tokens from common objects.