com.communote.server.core.common.ldap

Class CommunoteLdapUserSearch

java.lang.Object

com.communote.server.core.common.ldap.CommunoteLdapUserSearch

All Implemented Interfaces:

org.springframework.security.ldap.search.LdapUserSearch

public class CommunoteLdapUserSearch
extends Object
implements org.springframework.security.ldap.search.LdapUserSearch

Search for a user in LDAP directory.

Author:

Communote GmbH - http://www.communote.com/

Constructor Summary

Constructors

Constructor and Description
CommunoteLdapUserSearch(LdapConfiguration config, LdapUserAttribute communoteAttributeName) Creates a search for retrieving LDAP users.
CommunoteLdapUserSearch(LdapSearchConfiguration userSearchConfig, LdapUserAttributesMapper mapper, org.springframework.ldap.core.support.LdapContextSource context, LdapUserAttribute communoteAttributeName, String userLogin, String userPassword) Creates a search for retrieving LDAP users.

Method Summary

Modifier and Type	Method and Description
LdapUserAttributesMapper	getUserAttributesMapper() Returns the LdapUserAttributesMapper used by the search.
org.springframework.ldap.core.DirContextOperations	searchForUser(String username)
ExternalUserVO	searchForUserTransformed(String username) Same as searchForUser(String) but automatically transforms the LdapUserDetails to the VO by invoking transformResult(DirContextOperations).
ExternalUserVO	transformResult(org.springframework.ldap.core.DirContextOperations details) Transforms the LdapUserDetails into a VO.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

CommunoteLdapUserSearch

public CommunoteLdapUserSearch(LdapConfiguration config,
                               LdapUserAttribute communoteAttributeName)
                        throws LdapAttributeMappingException

Creates a search for retrieving LDAP users.

Parameters:

config - the LDAP configuration

communoteAttributeName - the Communote attribute to be used for the searchForUser(String) method. A search for this attribute should return at most one user.

Throws:

LdapAttributeMappingException - if it's not possible to create an LdapUserAttributesMapper from the LDAP configuration

CommunoteLdapUserSearch

public CommunoteLdapUserSearch(LdapSearchConfiguration userSearchConfig,
                               LdapUserAttributesMapper mapper,
                               org.springframework.ldap.core.support.LdapContextSource context,
                               LdapUserAttribute communoteAttributeName,
                               String userLogin,
                               String userPassword)

Creates a search for retrieving LDAP users.

Parameters:

userSearchConfig - the user search configuration of the LDAP configuration

mapper - the attributes mapper to be used

context - the initialized JNDI context based on the provided LDAP configuration

communoteAttributeName - the Communote attribute to be used for the searchForUser(String) method. A search for this attribute should return at most one user.

userLogin - the login to use for querying the LDAP server. If null the configured managerDn will be used.

userPassword - the password to use with the userLogin when querying the LDAP server

Method Detail

getUserAttributesMapper

public LdapUserAttributesMapper getUserAttributesMapper()

Returns the LdapUserAttributesMapper used by the search.

Returns:

the mapper

searchForUser

public org.springframework.ldap.core.DirContextOperations searchForUser(String username)

Specified by:

searchForUser in interface org.springframework.security.ldap.search.LdapUserSearch

searchForUserTransformed

public ExternalUserVO searchForUserTransformed(String username)
                                        throws LdapAttributeMappingException

Same as searchForUser(String) but automatically transforms the LdapUserDetails to the VO by invoking transformResult(DirContextOperations).

Parameters:

username - the user name to search for. The search must not return more than one value

Returns:

the user

Throws:

LdapAttributeMappingException - if the transformation fails

org.springframework.security.core.userdetails.UsernameNotFoundException - in case no user is found

org.springframework.dao.IncorrectResultSizeDataAccessException - in case more than users are found

transformResult

public ExternalUserVO transformResult(org.springframework.ldap.core.DirContextOperations details)
                               throws LdapAttributeMappingException

Transforms the LdapUserDetails into a VO.

Parameters:

details - the details to transform

Returns:

the transformed VO

Throws:

LdapAttributeMappingException - if the transformation fails