org.ldaptive.auth

Class AbstractSearchDnResolver

java.lang.Object

org.ldaptive.auth.AbstractSearchOperationFactory

org.ldaptive.auth.AbstractSearchDnResolver

All Implemented Interfaces:

DnResolver

Direct Known Subclasses:

PooledSearchDnResolver, SearchDnResolver

public abstract class AbstractSearchDnResolver
extends AbstractSearchOperationFactory
implements DnResolver

Base implementation for search dn resolvers.

Field Summary

Fields

Modifier and Type	Field and Description
private boolean	allowMultipleDns Whether to throw an exception if multiple DNs are found.
private String	baseDn DN to search.
private DerefAliases	derefAliases How to handle aliases.
private ReferralHandler	referralHandler Referral handler.
private boolean	subtreeSearch Whether to use a subtree search when resolving DNs.
private String	userFilter Filter for searching for the user.
private Object[]	userFilterParameters Filter parameters for searching for the user.

Fields inherited from class org.ldaptive.auth.AbstractSearchOperationFactory

logger

Constructor Summary

Constructors

Constructor and Description
AbstractSearchDnResolver()

Method Summary

Modifier and Type	Method and Description
protected SearchFilter	createSearchFilter(User user) Returns a search filter using userFilter and userFilterParameters.
protected SearchRequest	createSearchRequest(SearchFilter filter) Returns a search request for searching for a single entry in an LDAP, returning no attributes.
boolean	getAllowMultipleDns() Returns whether DN resolution should fail if multiple DNs are found.
String	getBaseDn() Returns the base DN.
protected abstract Connection	getConnection() Retrieve a connection that is ready for use.
DerefAliases	getDerefAliases() Returns how to dereference aliases.
ReferralHandler	getReferralHandler() Returns the referral handler.
boolean	getSubtreeSearch() Returns whether subtree searching will be used.
String	getUserFilter() Returns the filter used to search for the user.
Object[]	getUserFilterParameters() Returns the filter parameters used to search for the user.
protected SearchResult	performLdapSearch(SearchFilter filter) Executes the ldap search operation with the supplied filter.
String	resolve(User user) Attempts to find the DN for the supplied user.
protected String	resolveDn(LdapEntry entry) Returns the DN for the supplied ldap entry.
void	setAllowMultipleDns(boolean b) Sets whether DN resolution should fail if multiple DNs are found.
void	setBaseDn(String dn) Sets the base DN.
void	setDerefAliases(DerefAliases da) Sets how to dereference aliases.
void	setReferralHandler(ReferralHandler handler) Sets the referral handler.
void	setSubtreeSearch(boolean b) Sets whether subtree searching will be used.
void	setUserFilter(String filter) Sets the filter used to search for the user.
void	setUserFilterParameters(Object[] filterParams) Sets the filter parameters used to search for the user.

Methods inherited from class org.ldaptive.auth.AbstractSearchOperationFactory

createSearchOperation, getSearchCache, getSearchExceptionHandler, getSearchResponseHandlers, setSearchCache, setSearchExceptionHandler, setSearchResponseHandlers

Methods inherited from class java.lang.Object

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

Field Detail

baseDn

private String baseDn

DN to search.

userFilter

private String userFilter

Filter for searching for the user.

userFilterParameters

private Object[] userFilterParameters

Filter parameters for searching for the user.

allowMultipleDns

private boolean allowMultipleDns

Whether to throw an exception if multiple DNs are found.

subtreeSearch

private boolean subtreeSearch

Whether to use a subtree search when resolving DNs.

derefAliases

private DerefAliases derefAliases

How to handle aliases.

referralHandler

private ReferralHandler referralHandler

Referral handler.

Constructor Detail

AbstractSearchDnResolver

public AbstractSearchDnResolver()

Method Detail

getBaseDn

public String getBaseDn()

Returns the base DN.

Returns:

base DN

setBaseDn

public void setBaseDn(String dn)

Sets the base DN.

Parameters:

dn - base DN

getUserFilter

public String getUserFilter()

Returns the filter used to search for the user.

Returns:

filter for searching

setUserFilter

public void setUserFilter(String filter)

Sets the filter used to search for the user.

Parameters:

filter - for searching

getUserFilterParameters

public Object[] getUserFilterParameters()

Returns the filter parameters used to search for the user.

Returns:

filter parameters

setUserFilterParameters

public void setUserFilterParameters(Object[] filterParams)

Sets the filter parameters used to search for the user.

Parameters:

filterParams - filter parameters

getAllowMultipleDns

public boolean getAllowMultipleDns()

Returns whether DN resolution should fail if multiple DNs are found.

Returns:

whether an exception will be thrown if multiple DNs are found

setAllowMultipleDns

public void setAllowMultipleDns(boolean b)

Sets whether DN resolution should fail if multiple DNs are found. If false an exception will be thrown if resolve(User) finds more than one DN matching it's filter. Otherwise the first DN found is returned.

Parameters:

b - whether multiple DNs are allowed

getSubtreeSearch

public boolean getSubtreeSearch()

Returns whether subtree searching will be used.

Returns:

whether the DN will be searched for over the entire base

setSubtreeSearch

public void setSubtreeSearch(boolean b)

Sets whether subtree searching will be used. If true, the DN used for authenticating will be searched for over the entire getBaseDn(). Otherwise the DN will be searched for in the getBaseDn() context.

Parameters:

b - whether the DN will be searched for over the entire base

getDerefAliases

public DerefAliases getDerefAliases()

Returns how to dereference aliases.

Returns:

how to dereference aliases

setDerefAliases

public void setDerefAliases(DerefAliases da)

Sets how to dereference aliases.

Parameters:

da - how to dereference aliases

getReferralHandler

public ReferralHandler getReferralHandler()

Returns the referral handler.

Returns:

referral handler

setReferralHandler

public void setReferralHandler(ReferralHandler handler)

Sets the referral handler.

Parameters:

handler - referral handler

resolve

public String resolve(User user)
               throws LdapException

Attempts to find the DN for the supplied user. createSearchFilter(User) ()} is used to create the search filter. If more than one entry matches the search, the result is controlled by setAllowMultipleDns(boolean).

Specified by:

resolve in interface DnResolver

Parameters:

user - to find DN for

Returns:

user DN

Throws:

LdapException - if the entry resolution fails

resolveDn

protected String resolveDn(LdapEntry entry)

Returns the DN for the supplied ldap entry.

Parameters:

entry - to retrieve the DN from

Returns:

dn

createSearchFilter

protected SearchFilter createSearchFilter(User user)

Returns a search filter using userFilter and userFilterParameters. The user parameter is injected as a named parameter of 'user'.

Parameters:

user - to resolve DN

Returns:

search filter

createSearchRequest

protected SearchRequest createSearchRequest(SearchFilter filter)

Returns a search request for searching for a single entry in an LDAP, returning no attributes.

Parameters:

filter - to execute

Returns:

search request

performLdapSearch

protected SearchResult performLdapSearch(SearchFilter filter)
                                  throws LdapException

Executes the ldap search operation with the supplied filter.

Parameters:

filter - to execute

Returns:

ldap search result

Throws:

LdapException - if an error occurs

getConnection

protected abstract Connection getConnection()
                                     throws LdapException

Retrieve a connection that is ready for use.

Returns:

connection

Throws:

LdapException - if an error occurs opening the connection