SEC-2493: Fix javadoc for DefaultLdapAuthoritiesPopulator

This commit is contained in:
Rob Winch 2015-07-14 13:19:38 -05:00
parent aad4e70374
commit 75f57b96cb

View File

@ -30,7 +30,6 @@ import javax.naming.directory.SearchControls;
import java.util.ArrayList; import java.util.ArrayList;
import java.util.Collection; import java.util.Collection;
import java.util.Collections;
import java.util.HashSet; import java.util.HashSet;
import java.util.List; import java.util.List;
import java.util.Set; import java.util.Set;
@ -46,13 +45,13 @@ import java.util.Set;
* that they should be assigned that role. The following LDIF sample has the groups stored * that they should be assigned that role. The following LDIF sample has the groups stored
* under the DN <tt>ou=groups,dc=springframework,dc=org</tt> and a group called * under the DN <tt>ou=groups,dc=springframework,dc=org</tt> and a group called
* "developers" with "ben" and "luke" as members: * "developers" with "ben" and "luke" as members:
* *
* <pre> * <pre>
* dn: ou=groups,dc=springframework,dc=org * dn: ou=groups,dc=springframework,dc=org
* objectClass: top * objectClass: top
* objectClass: organizationalUnit * objectClass: organizationalUnit
* ou: groups * ou: groups
* *
* dn: cn=developers,ou=groups,dc=springframework,dc=org * dn: cn=developers,ou=groups,dc=springframework,dc=org
* objectClass: groupOfNames * objectClass: groupOfNames
* objectClass: top * objectClass: top
@ -73,20 +72,20 @@ import java.util.Set;
* <p> * <p>
* The configuration below shows how the group search might be performed with the above * The configuration below shows how the group search might be performed with the above
* schema. * schema.
* *
* <pre> * <pre>
* &lt;bean id="ldapAuthoritiesPopulator" * &lt;bean id="ldapAuthoritiesPopulator"
* class="org.springframework.security.authentication.ldap.populator.DefaultLdapAuthoritiesPopulator"> * class="org.springframework.security.ldap.userdetails.DefaultLdapAuthoritiesPopulator">
* &lt;constructor-arg ref="contextSource"/> * &lt;constructor-arg ref="contextSource"/>
* &lt;constructor-arg value="ou=groups"/> * &lt;constructor-arg value="ou=groups"/>
* &lt;property name="groupRoleAttribute" value="ou"/> * &lt;property name="groupRoleAttribute" value="ou"/>
* &lt;!-- the following properties are shown with their default values --> * &lt;!-- the following properties are shown with their default values -->
* &lt;property name="searchSubTree" value="false"/> * &lt;property name="searchSubtree" value="false"/>
* &lt;property name="rolePrefix" value="ROLE_"/> * &lt;property name="rolePrefix" value="ROLE_"/>
* &lt;property name="convertToUpperCase" value="true"/> * &lt;property name="convertToUpperCase" value="true"/>
* &lt;/bean> * &lt;/bean>
* </pre> * </pre>
* *
* A search for roles for user "uid=ben,ou=people,dc=springframework,dc=org" would return * A search for roles for user "uid=ben,ou=people,dc=springframework,dc=org" would return
* the single granted authority "ROLE_DEVELOPER". * the single granted authority "ROLE_DEVELOPER".
* <p> * <p>