From 38629f159a068594fc5c8e8e0a7c1094e8823bb2 Mon Sep 17 00:00:00 2001
From: Luke Taylor <luke.taylor@springsource.com>
Date: Fri, 13 Jan 2006 21:13:53 +0000
Subject: [PATCH] Added default role option to authorities populator.

---
 .../DefaultLdapAuthoritiesPopulator.java      | 23 +++++++++++++++++--
 .../DefaultLdapAuthoritiesPopulatorTests.java |  9 ++++++++
 2 files changed, 30 insertions(+), 2 deletions(-)

diff --git a/core/src/main/java/org/acegisecurity/providers/ldap/populator/DefaultLdapAuthoritiesPopulator.java b/core/src/main/java/org/acegisecurity/providers/ldap/populator/DefaultLdapAuthoritiesPopulator.java
index 2faf81b271..242418d121 100644
--- a/core/src/main/java/org/acegisecurity/providers/ldap/populator/DefaultLdapAuthoritiesPopulator.java
+++ b/core/src/main/java/org/acegisecurity/providers/ldap/populator/DefaultLdapAuthoritiesPopulator.java
@@ -135,6 +135,9 @@ public class DefaultLdapAuthoritiesPopulator implements LdapAuthoritiesPopulator
 
     private boolean convertToUpperCase = true;
 
+    /** A default role which will be assigned to all authenticated users if set */
+    private GrantedAuthority defaultRole = null;
+
     /** An initial context factory is only required if searching for groups is required. */
     private InitialDirContextFactory initialDirContextFactory = null;
 
@@ -143,7 +146,8 @@ public class DefaultLdapAuthoritiesPopulator implements LdapAuthoritiesPopulator
     /**
      * Constructor for non-group search scenarios. Typically in this case
      * the <tt>userRoleAttributes</tt> property will be set to obtain roles directly
-     * from the user's directory entry attributes.
+     * from the user's directory entry attributes. The <tt>defaultRole</tt> property
+     * may also be set and will be assigned to all users.
      */
     public DefaultLdapAuthoritiesPopulator() {
     }
@@ -182,6 +186,10 @@ public class DefaultLdapAuthoritiesPopulator implements LdapAuthoritiesPopulator
             roles.addAll(groupRoles);
         }
 
+        if(defaultRole != null) {
+            roles.add(defaultRole);
+        }
+
         return (GrantedAuthority[])roles.toArray(new GrantedAuthority[roles.size()]);
     }
 
@@ -202,7 +210,8 @@ public class DefaultLdapAuthoritiesPopulator implements LdapAuthoritiesPopulator
      *
      * @param userDn the user's distinguished name.
      * @param userAttributes
-     * @return the set of roles obtained from a group membership search.
+     * @return the set of roles obtained from a group membership search, or null if
+     *         <tt>groupSearchBase</tt> has been set.
      */
     protected Set getGroupMembershipRoles(String userDn, Attributes userAttributes) {
         Set userRoles = new HashSet();
@@ -313,4 +322,14 @@ public class DefaultLdapAuthoritiesPopulator implements LdapAuthoritiesPopulator
     public void setConvertToUpperCase(boolean convertToUpperCase) {
         this.convertToUpperCase = convertToUpperCase;
     }
+
+    /**
+     * The default role which will be assigned to all users.
+     *
+     * @param defaultRole the role name, including any desired prefix.
+     */
+    public void setDefaultRole(String defaultRole) {
+        Assert.notNull(defaultRole, "The defaultRole property cannot be set to null");
+        this.defaultRole = new GrantedAuthorityImpl(defaultRole);
+    }
 }
diff --git a/core/src/test/java/org/acegisecurity/providers/ldap/populator/DefaultLdapAuthoritiesPopulatorTests.java b/core/src/test/java/org/acegisecurity/providers/ldap/populator/DefaultLdapAuthoritiesPopulatorTests.java
index f0f97206a0..0b914ce64f 100644
--- a/core/src/test/java/org/acegisecurity/providers/ldap/populator/DefaultLdapAuthoritiesPopulatorTests.java
+++ b/core/src/test/java/org/acegisecurity/providers/ldap/populator/DefaultLdapAuthoritiesPopulatorTests.java
@@ -43,6 +43,15 @@ public class DefaultLdapAuthoritiesPopulatorTests extends AbstractLdapServerTest
         assertEquals("User should have three roles", 3, authorities.length);
     }
 
+    public void testDefaultRoleIsAssignedWhenSet() {
+        DefaultLdapAuthoritiesPopulator populator = new DefaultLdapAuthoritiesPopulator();
+        populator.setDefaultRole("ROLE_USER");
+
+        GrantedAuthority[] authorities = populator.getGrantedAuthorities("Ignored", "Ignored", new BasicAttributes());
+        assertEquals(1, authorities.length);
+        assertEquals("ROLE_USER", authorities[0].getAuthority());
+    }
+
     public void testGroupSearch() throws Exception {
         DefaultLdapAuthoritiesPopulator populator = new DefaultLdapAuthoritiesPopulator(dirCtxFactory, "ou=groups");
         populator.setRolePrefix("ROLE_");