public class

FilterBasedLdapUserSearch

extends Object
implements LdapUserSearch
java.lang.Object
   ↳ org.springframework.security.ldap.search.FilterBasedLdapUserSearch

Class Overview

LdapUserSearch implementation which uses an Ldap filter to locate the user.

See Also
  • SearchControls

Summary

Public Constructors
FilterBasedLdapUserSearch(String searchBase, String searchFilter, BaseLdapPathContextSource contextSource)
Public Methods
DirContextOperations searchForUser(String username)
Return the LdapUserDetails containing the user's information
void setDerefLinkFlag(boolean deref)
Sets the corresponding property on the SearchControls instance used in the search.
void setReturningAttributes(String[] attrs)
Specifies the attributes that will be returned as part of the search.
void setSearchSubtree(boolean searchSubtree)
If true then searches the entire subtree as identified by context, if false (the default) then only searches the level identified by the context.
void setSearchTimeLimit(int searchTimeLimit)
The time to wait before the search fails; the default is zero, meaning forever.
String toString()
[Expand]
Inherited Methods
From class java.lang.Object
From interface org.springframework.security.ldap.search.LdapUserSearch

Public Constructors

public FilterBasedLdapUserSearch (String searchBase, String searchFilter, BaseLdapPathContextSource contextSource)

Public Methods

public DirContextOperations searchForUser (String username)

Return the LdapUserDetails containing the user's information

Parameters
username the username to search for.
Returns
  • An LdapUserDetails object containing the details of the located user's directory entry
Throws
UsernameNotFoundException if no matching entry is found.

public void setDerefLinkFlag (boolean deref)

Sets the corresponding property on the SearchControls instance used in the search.

Parameters
deref the derefLinkFlag value as defined in SearchControls..

public void setReturningAttributes (String[] attrs)

Specifies the attributes that will be returned as part of the search.

null indicates that all attributes will be returned. An empty array indicates no attributes are returned.

Parameters
attrs An array of attribute names identifying the attributes that will be returned. Can be null.

public void setSearchSubtree (boolean searchSubtree)

If true then searches the entire subtree as identified by context, if false (the default) then only searches the level identified by the context.

Parameters
searchSubtree true the underlying search controls should be set to SearchControls.SUBTREE_SCOPE rather than SearchControls.ONELEVEL_SCOPE.

public void setSearchTimeLimit (int searchTimeLimit)

The time to wait before the search fails; the default is zero, meaning forever.

Parameters
searchTimeLimit the time limit for the search (in milliseconds).

public String toString ()