org.ldaptive.provider.apache

Class ApacheLdapConnection.AbstractApacheLdapSearch

java.lang.Object

org.ldaptive.provider.apache.ApacheLdapConnection.AbstractApacheLdapSearch

Direct Known Subclasses:

ApacheLdapConnection.ApacheLdapSearchIterator, ApacheLdapConnection.ApacheLdapSearchListener

Enclosing class:

ApacheLdapConnection

protected abstract class ApacheLdapConnection.AbstractApacheLdapSearch
extends Object

Common search functionality for apache ldap iterators and listeners.

Field Summary

Fields

Modifier and Type	Field and Description
protected SearchRequest	request Search request.
protected ApacheLdapUtils	util Utility class.

Constructor Summary

Constructors

Constructor and Description
AbstractApacheLdapSearch(SearchRequest sr) Creates a new abstract apache ldap search.

Method Summary

Modifier and Type	Method and Description
protected org.apache.directory.api.ldap.model.message.AliasDerefMode	getAliasDerefMode(DerefAliases deref) Returns the apache ldap alias deref mode for the supplied deref aliases.
protected org.apache.directory.api.ldap.model.message.SearchRequest	getSearchRequest(SearchRequest sr) Returns an apache ldap search request object configured with the supplied search request.
protected org.apache.directory.api.ldap.model.message.SearchScope	getSearchScope(SearchScope ss) Returns the apache ldap search scope for the supplied search scope.
protected SearchItem	processIntermediateResponse(org.apache.directory.api.ldap.model.message.IntermediateResponse res) Processes the response controls on the supplied response and returns a corresponding search item.
protected SearchItem	processSearchResultEntry(org.apache.directory.api.ldap.model.message.SearchResultEntry entry) Processes the response controls on the supplied entry and returns a corresponding search item.
protected SearchItem	processSearchResultReference(org.apache.directory.api.ldap.model.message.SearchResultReference ref) Processes the response controls on the supplied reference and returns a corresponding search item.
protected org.apache.directory.api.ldap.model.cursor.SearchCursor	search(org.apache.directory.ldap.client.api.LdapNetworkConnection conn, SearchRequest sr) Executes an ldap search.

Methods inherited from class java.lang.Object

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

Field Detail

request

protected final SearchRequest request

Search request.

util

protected final ApacheLdapUtils util

Utility class.

Constructor Detail

AbstractApacheLdapSearch

public AbstractApacheLdapSearch(SearchRequest sr)

Creates a new abstract apache ldap search.

Parameters:

sr - search request

Method Detail

search

protected org.apache.directory.api.ldap.model.cursor.SearchCursor search(org.apache.directory.ldap.client.api.LdapNetworkConnection conn,
                                                                         SearchRequest sr)
                                                                  throws org.apache.directory.api.ldap.model.exception.LdapException

Executes an ldap search.

Parameters:

conn - to search with

sr - to read properties from

Returns:

ldap search results

Throws:

org.apache.directory.api.ldap.model.exception.LdapException - if an error occurs

getSearchRequest

protected org.apache.directory.api.ldap.model.message.SearchRequest getSearchRequest(SearchRequest sr)
                                                                              throws org.apache.directory.api.ldap.model.exception.LdapException

Returns an apache ldap search request object configured with the supplied search request.

Parameters:

sr - search request containing configuration to create apache ldap search request

Returns:

search request

Throws:

org.apache.directory.api.ldap.model.exception.LdapException - if the search request cannot be initialized

getSearchScope

protected org.apache.directory.api.ldap.model.message.SearchScope getSearchScope(SearchScope ss)

Returns the apache ldap search scope for the supplied search scope.

Parameters:

ss - search scope

Returns:

apache ldap search scope

getAliasDerefMode

protected org.apache.directory.api.ldap.model.message.AliasDerefMode getAliasDerefMode(DerefAliases deref)

Returns the apache ldap alias deref mode for the supplied deref aliases.

Parameters:

deref - deref aliases

Returns:

apache ldap alias deref mode

processSearchResultEntry

protected SearchItem processSearchResultEntry(org.apache.directory.api.ldap.model.message.SearchResultEntry entry)

Processes the response controls on the supplied entry and returns a corresponding search item.

Parameters:

entry - to process

Returns:

search item

processSearchResultReference

protected SearchItem processSearchResultReference(org.apache.directory.api.ldap.model.message.SearchResultReference ref)

Processes the response controls on the supplied reference and returns a corresponding search item.

Parameters:

ref - to process

Returns:

search item

processIntermediateResponse

protected SearchItem processIntermediateResponse(org.apache.directory.api.ldap.model.message.IntermediateResponse res)

Processes the response controls on the supplied response and returns a corresponding search item.

Parameters:

res - to process

Returns:

search item