Package org.springframework.security.ldap.userdetails

Interface UserDetailsContextMapper

All Known Implementing Classes:

InetOrgPersonContextMapper, LdapUserDetailsMapper, PersonContextMapper

public interface UserDetailsContextMapper

Operations to map a UserDetails object to and from a Spring LDAP DirContextOperations implementation. Used by LdapUserDetailsManager when loading and saving/creating user information, and also by the LdapAuthenticationProvider to allow customization of the user data loaded during authentication.

Since:

2.0

Method Summary

Modifier and Type	Method	Description
UserDetails	mapUserFromContext(org.springframework.ldap.core.DirContextOperations ctx, String username, Collection<? extends GrantedAuthority> authorities)	Creates a fully populated UserDetails object for use by the security framework.
void	mapUserToContext(UserDetails user, org.springframework.ldap.core.DirContextAdapter ctx)	Reverse of the above operation.

Method Details

mapUserFromContext

UserDetails mapUserFromContext(org.springframework.ldap.core.DirContextOperations ctx,
 String username,
 Collection<? extends GrantedAuthority> authorities)

Creates a fully populated UserDetails object for use by the security framework.

Parameters:

ctx - the context object which contains the user information.

username - the user's supplied login name.

authorities - the authorities to add to the UserDetails instance

Returns:

the user object.

mapUserToContext

void mapUserToContext(UserDetails user,
 org.springframework.ldap.core.DirContextAdapter ctx)

Reverse of the above operation. Populates a context object from the supplied user object. Called when saving a user, for example.