Cwikius-Spring
/
spring-security
mirror of https://github.com/spring-projects/spring-security.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

SEC-1043: Improved Javadoc for LdapAuthenticationProvider user details mapping methods.

This commit is contained in:
Luke Taylor 2008-12-02 14:32:44 +00:00
parent 9ab69ddcaf
commit f2969392a6
1 changed files with 20 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

22
core/src/main/java/org/springframework/security/providers/ldap/LdapAuthenticationProvider.java
View File

@ -188,11 +188,22 @@ public class LdapAuthenticationProvider implements AuthenticationProvider, Messa
return authoritiesPopulator; return authoritiesPopulator;
} }
/**
* Allows a custom strategy to be used for creating the <tt>UserDetails</tt> which will be stored as the principal
* in the <tt>Authentication</tt> returned by the
* {@link #createSuccessfulAuthentication(UsernamePasswordAuthenticationToken, UserDetails)} method.
*
* @param userDetailsContextMapper the strategy instance. If not set, defaults to a simple
* <tt>LdapUserDetailsMapper</tt>.
*/
public void setUserDetailsContextMapper(UserDetailsContextMapper userDetailsContextMapper) { public void setUserDetailsContextMapper(UserDetailsContextMapper userDetailsContextMapper) {
Assert.notNull(userDetailsContextMapper, "UserDetailsContextMapper must not be null"); Assert.notNull(userDetailsContextMapper, "UserDetailsContextMapper must not be null");
this.userDetailsContextMapper = userDetailsContextMapper; this.userDetailsContextMapper = userDetailsContextMapper;
} }
/**
* Provides access to the injected <tt>UserDetailsContextMapper</tt> strategy for use by subclasses.
*/
protected UserDetailsContextMapper getUserDetailsContextMapper() { protected UserDetailsContextMapper getUserDetailsContextMapper() {
return userDetailsContextMapper; return userDetailsContextMapper;
} }
@ -204,8 +215,8 @@ public class LdapAuthenticationProvider implements AuthenticationProvider, Messa
/** /**
* Determines whether the supplied password will be used as the credentials in the successful authentication * Determines whether the supplied password will be used as the credentials in the successful authentication
* token. If set to false, then the password will be obtained from the UserDetails object * token. If set to false, then the password will be obtained from the UserDetails object
* created by the configured mapper. Often it will not be possible to read the password from the directory, so * created by the configured <tt>UserDetailsContextMapper</tt>.
* defaults to true. * Often it will not be possible to read the password from the directory, so defaults to true.
* *
* @param useAuthenticationRequestCredentials * @param useAuthenticationRequestCredentials
*/ */
@ -264,6 +275,13 @@ public class LdapAuthenticationProvider implements AuthenticationProvider, Messa
return getAuthoritiesPopulator().getGrantedAuthorities(userData, username); return getAuthoritiesPopulator().getGrantedAuthorities(userData, username);
} }
/**
* Creates the final <tt>Authentication</tt> object which will be returned from the <tt>authenticate</tt> method.
*
* @param authentication the original authentication request token
* @param user the <tt>UserDetails</tt> instance returned by the configured <tt>UserDetailsContextMapper</tt>.
* @return the Authentication object for the fully authenticated user.
*/
protected Authentication createSuccessfulAuthentication(UsernamePasswordAuthenticationToken authentication, protected Authentication createSuccessfulAuthentication(UsernamePasswordAuthenticationToken authentication,
UserDetails user) { UserDetails user) {
Object password = useAuthenticationRequestCredentials ? authentication.getCredentials() : user.getPassword(); Object password = useAuthenticationRequestCredentials ? authentication.getCredentials() : user.getPassword();